Skip to content
Scrappa Get API key
Homes.com API 1 credit/request

Homes.com Agent Autocomplete API Documentation

GET https://scrappa.co/api/homes-com/agent-autocomplete

Homes.com Agent Autocomplete API finds agents by name. Each result has the name, agency and city, the profile URL, a photo and the agent_id for the agent route. An empty list is a valid answer and is billed.

Homes.com Agent Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/homes-com/agent-autocomplete
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "Ivan Mills",
        "results": [
            {
                "url": "https://www.homes.com/real-estate-agents/ivan-mills/he96qg2/",
                "name": "Ivan Mills",
                "agent_id": "he96qg2",
                "photo_url": "https://imagescdn.homes.com/i2/y2wcZ6qdeAi-RPUkpMY4nKei8KhN8FfamxTTuA9hJMM/117/image.jpg?p=1",
                "description": "Mobile Bye Bye, Austin, TX"
            }
        ]
    },
    "meta": {
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

1 optional filter available.

query string Required

Agent name, 2 to 100 characters. Example: Ivan Mills.

Example value coffee shops
limit integer Optional

Number of results, 1 to 25. Default 10.

Example value 10

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "query": "Ivan Mills",
        "results": [
            {
                "url": "https://www.homes.com/real-estate-agents/ivan-mills/he96qg2/",
                "name": "Ivan Mills",
                "agent_id": "he96qg2",
                "photo_url": "https://imagescdn.homes.com/i2/y2wcZ6qdeAi-RPUkpMY4nKei8KhN8FfamxTTuA9hJMM/117/image.jpg?p=1",
                "description": "Mobile Bye Bye, Austin, TX"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agent_autocomplete"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required parameter or a range is invalid, or the page is beyond the first 700 results. This response is not billable.

{
    "errors": {
        "query": [
            "The query field is required."
        ]
    },
    "message": "The request validation failed"
}
503

Upstream Unavailable

Homes.com could not be reached or returned data that does not match the request. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "agent_autocomplete"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Homes.com could not be reached. Please retry shortly."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.