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

Realtor.com Location Autocomplete API Documentation

GET https://scrappa.co/api/realtor-com/autocomplete

Realtor.com Location Autocomplete API Find US locations by a search text. Each result has an area type (city, postal_code, neighborhood or address), a label, city, state, centroid and a slug_id. Use the slug_id as location in the search endpoint. An address result also carries a property_id that opens the listing, schools and agent endpoints.

Realtor.com Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/realtor-com/autocomplete
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "austin",
        "results": [
            {
                "city": "Austin",
                "line": null,
                "label": "Austin, TX",
                "mpr_id": null,
                "slug_id": "Austin_TX",
                "centroid": {
                    "lat": 30.2986219,
                    "lon": -97.7541339
                },
...

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.

2 optional filters available.

query string Required

Search text, 2 to 100 characters. Example: austin.

Example value coffee shops
limit integer Optional

Rows to return, 1 to 10. Default 5.

Example value 10
area_types string Optional

Comma separated list of address, city, neighborhood, postal_code.

Example value example

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": "austin",
        "results": [
            {
                "city": "Austin",
                "line": null,
                "label": "Austin, TX",
                "mpr_id": null,
                "slug_id": "Austin_TX",
                "centroid": {
                    "lat": 30.2986219,
                    "lon": -97.7541339
                },
                "area_type": "city",
                "state_code": "TX",
                "postal_code": null,
                "property_id": null
            },
            {
                "city": "Austin",
                "line": null,
                "label": "Austin, MN",
                "mpr_id": null,
                "slug_id": "Austin_MN",
                "centroid": {
                    "lat": 43.6720977,
                    "lon": -92.9778634
                },
                "area_type": "city",
                "state_code": "MN",
                "postal_code": null,
                "property_id": null
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

Errors

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

422

Validation Error

A required parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "query": [
            "The value is not valid."
        ]
    },
    "message": "The request validation failed"
}
503

Temporarily Unavailable

Realtor.com did not answer after several attempts. This response is not billable. Retry after a short pause.

{
    "meta": {
        "attempts": 3,
        "billable": false,
        "retryable": true
    },
    "error": {
        "message": "Realtor.com data is temporarily unavailable. Please retry.",
        "failure_type": "upstream_blocked"
    },
    "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.