LandWatch Autocomplete API Documentation

GET https://scrappa.co/api/landwatch/autocomplete

LandWatch Autocomplete API finds states, counties, cities and postal codes by name. Each suggestion has a kind and the state, county, city or postal_code values to send to the search route. An unknown query returns an empty items list and is still a successful response.

Run this endpoint

LandWatch Autocomplete API Documentation 1 credit/request

Get API key Open Playground

Request preview

GET

https://scrappa.co/api/landwatch/autocomplete

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

q = coffee shops

Response preview

200 OK

{
    "data": {
        "items": [
            {
                "id": 1235,
                "city": "Austin",
                "kind": "city",
                "label": "Austin, TX",
                "state": "TX"
            },
            {
                "id": 1240,
                "city": "Austin",
                "kind": "city",
...

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.

q


                                        string

Required

Place name or postal code prefix, 2 to 100 characters. Example: aust.

Example value


                                        coffee shops

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": {
        "items": [
            {
                "id": 1235,
                "city": "Austin",
                "kind": "city",
                "label": "Austin, TX",
                "state": "TX"
            },
            {
                "id": 1240,
                "city": "Austin",
                "kind": "city",
                "label": "Austin, AR",
                "state": "AR"
            },
            {
                "id": 1231,
                "city": "Austell",
                "kind": "city",
                "label": "Austell, GA",
                "state": "GA"
            }
        ],
        "query": "aust"
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

Errors

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

422

Validation Error

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

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

503

Upstream Unavailable

LandWatch could not be reached, or it answered with 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": "LandWatch 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.