Dot Property Autocomplete API Documentation

GET https://scrappa.co/api/dotproperty/v1/autocomplete

Dot Property Autocomplete API returns matching provinces, districts, sub-districts, stations, neighbourhoods and projects as JSON. Each match carries a location slug to use as the Search location, or a project_id to use as the Search project filter. A text without matches returns empty lists and is a successful response.

Run this endpoint

Dot Property Autocomplete API Documentation 1 credit/request

Get API key Open Playground

Request preview

GET

https://scrappa.co/api/dotproperty/v1/autocomplete

Auth header: x-api-key
Cost: 1 credit/request

query = coffee shops

Response preview

200 OK

{
    "data": {
        "query": "sukh",
        "projects": [],
        "locations": [
            {
                "name": "Sukhothai",
                "type": "Province",
                "address": null,
                "location": "sukhothai",
                "sub_name": null,
                "project_id": null,
                "project_slug": null
            },
...

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

query


                                        string

Required

Search text, 2 to 60 characters. Example: sukhumvit.

Example value


                                        coffee shops

listing_category


                                        string

Optional

Category of the listing, for example condos-for-sale (default) or houses-for-rent. Example: condos-for-sale.

Example value


                                        example

Response Schema

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

Open in Playground

Example response fields

Scan these fields before integrating.

data meta success

JSON Response

200 OK

{
    "data": {
        "query": "sukh",
        "projects": [],
        "locations": [
            {
                "name": "Sukhothai",
                "type": "Province",
                "address": null,
                "location": "sukhothai",
                "sub_name": null,
                "project_id": null,
                "project_slug": null
            },
            {
                "name": "Sukhirin, Narathiwat",
                "type": "District",
                "address": null,
                "location": "narathiwat/sukhirin",
                "sub_name": null,
                "project_id": null,
                "project_slug": null
            }
        ],
        "suggestions": [],
        "points_of_interest": [
            {
                "name": "MRT Sukhumvit",
                "type": "MRT Station",
                "address": null,
                "location": "mrt/sukhumvit",
                "sub_name": null,
                "project_id": null,
                "project_slug": null
            },
            {
                "name": "Sukhumvit",
                "type": "Neighborhood",
                "address": null,
                "location": "sukhumvit",
                "sub_name": null,
                "project_id": null,
                "project_slug": null
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

Errors

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

422

Validation Error

The query is missing or too short. This response is not billable.

{
    "errors": {
        "page": [
            "The page field must not be greater than 333."
        ]
    },
    "message": "The request validation failed"
}

503

Upstream Unavailable

Dot Property 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": "autocomplete"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Dot Property 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.