Returns matches for a search text: cities, neighborhoods, ZIP codes, addresses, and buildings, each with a label and the slug to pass to search. Set exclude_buildings to skip building matches. Set site to padmapper to use the PadMapper index.
Run this endpoint
Endpoint
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.
string
Required
Free text: city, neighborhood, ZIP, address, or building name.
san fran
boolean
Optional
Leave building matches out.
true
string
Optional
zumper (default) or padmapper. Allowed: zumper, padmapper.
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
success
{
"data": {
"status": "success",
"matches": [
{
"box": [],
"lat": 37.779238,
"lng": -122.419359,
"url": "san-francisco-ca",
"city": "San Francisco",
"name": "San Francisco",
"state": "CA",
"country": "USA",
"record_id": 396900358,
"record_type": "city"
}
]
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
The requested listing, building, or page was not found. This response is not billable.
Validation Error
A required public parameter is missing or invalid. This response is not billable.
Service Unavailable
The service could not obtain a complete result. This response is not billable.
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.