Skip to content
Scrappa Get API key
LandSearch API 1 credit/request

LandSearch Location API Documentation

GET https://scrappa.co/api/landsearch/location

LandSearch Location API returns one state, county, city or postal code by slug with its center point, bounding box and parent places. Failed requests are not billed.

LandSearch Location API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/landsearch/location
Auth header
x-api-key
Cost
1 credit/request
slug = example
Response preview
200 OK
{
    "data": {
        "id": 233252,
        "name": "Austin",
        "slug": "austin-tx",
        "type": "locality",
        "label": null,
        "bounds": {
            "east": -97.52759,
            "west": -97.93835,
            "north": 30.51686,
            "south": 30.07558
        },
        "center": {
...

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.

slug string Required

Location slug from the autocomplete route, for example austin-tx.

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": {
        "id": 233252,
        "name": "Austin",
        "slug": "austin-tx",
        "type": "locality",
        "label": null,
        "bounds": {
            "east": -97.52759,
            "west": -97.93835,
            "north": 30.51686,
            "south": 30.07558
        },
        "center": {
            "latitude": 30.267153,
            "longitude": -97.743057
        },
        "division": "Zip Code",
        "ancestors": [
            {
                "id": 1082,
                "name": "Travis",
                "slug": "travis-county-tx",
                "type": "subterritory",
                "label": "County"
            },
            {
                "id": 3,
                "name": "Texas Blacklands",
                "slug": "texas-blacklands-tx",
                "type": "region",
                "label": null
            },
            {
                "id": 44,
                "name": "Texas",
                "slug": "texas",
                "type": "territory",
                "label": null
            },
            {
                "id": 1,
                "name": "United States",
                "slug": "united-states",
                "type": "country",
                "label": null
            }
        ],
        "population": null,
        "state_code": "TX"
    },
    "meta": {
        "billable": true,
        "endpoint_family": "location"
    },
    "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": {
        "page": [
            "The page field must be at least 1."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

The location slug is unknown. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "location"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested item was not found."
    },
    "success": false
}
503

Upstream Unavailable

LandSearch could not be reached. Retry shortly. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "location"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "LandSearch 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.