GET/v1/zips/autocomplete
Typeahead suggestions by zip prefix or city name.
[ OPTIONS ]
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | At least 2 characters. Digits match zip prefixes, text matches city names. |
limit | integer | No | Max suggestions (default 10, max 25). |
[ EXAMPLE REQUEST ]
curl "https://atlasblock.dev/api/v1/zips/autocomplete?query=282"[ 200 OK ]
{
"status": "success",
"data": {
"query": "282",
"count": 3,
"matches": [
{
"zip": "28202",
"city": "Charlotte",
"state": "NC",
"county": "Mecklenburg County"
}
]
}
}[ TRY IT ]Open playground →
GET/v1/zips/autocomplete?query=282
[ QUERY ]
[ CURL ]
curl "https://atlasblock.dev/api/v1/zips/autocomplete?query=282" \ -H "Authorization: Bearer $ATLASBLOCK_API_KEY"
[ EVERY REQUEST ]
Send an Authorization: Bearer key against the base URL https://atlasblock.dev/api. Every call counts toward your plan quota. See the overview for authentication, rate limits, and status codes.