Autocomplete Cities, ZIP Codes, Neighborhoods, Counties & Street Addresses
GET/v1/locations/autocomplete2 Credits / Call($0.08–$0.20 / 1K calls)· Updated 2026-11-15
Direct Answer · PropTech Engineering Summary
GET /v1/locations/autocomplete resolves partial user keystrokes (?query=78701, ?query=Austin, ?query=Beverly Hills) into structured geographic boundaries with area_type (postal_code, city, neighborhood, county, address), canonical id tokens (city:tx_austin, postal_code:78701), state codes, and centroid lat/lng in ~30ms warm / <500ms live for 2 Credits per call.
Honest Trade-Offs & Scope Boundaries
- →Designed to power typeahead search boxes and normalize ambiguous user prompts before dispatching /v1/properties/search or /v1/redfin/search.
- →Zero credits charged if a nonsensical query string returns 0 boundary suggestions.
Resolve user search input (78701, Austin, Beverly Hills) into structured real estate boundaries with canonical id (postal_code:78701 or city:tx_austin), coordinates, and area type. Cost: 2 Credits per call.
Parameters
querystringrequiredPartial or complete ZIP code, city, neighborhood, school district, or address.
Example:
Austinlimitinteger (1 to 20)Maximum location suggestions to return (1-20, default 10).
Example Request (cURL / Python / JavaScript)
curl "https://api.realtydataapi.com/v1/locations/autocomplete?query=Austin" \
-H "x-api-key: rl_live_your_api_key"import requests
res = requests.get(
"https://api.realtydataapi.com/v1/locations/autocomplete?query=Austin",
headers={"x-api-key": "rl_live_your_api_key"},
timeout=30,
)
print(res.json())const res = await fetch("https://api.realtydataapi.com/v1/locations/autocomplete?query=Austin", {
headers: { "x-api-key": "rl_live_your_api_key" },
});
const data = await res.json();
console.log(data);Live Response Preview
{
"code": 0,
"provider": "https://realtydataapi.com",
"status": "ok",
"data": {
"query": "Austin",
"count": 2,
"suggestions": [
{
"id": "city:tx_austin",
"area_type": "city",
"label": "Austin, TX",
"city": "Austin",
"state_code": "TX",
"country": "USA",
"latitude": 30.2672,
"longitude": -97.7431
},
{
"id": "postal_code:78701",
"area_type": "postal_code",
"label": "78701, Austin, TX",
"city": "Austin",
"state_code": "TX",
"postal_code": "78701",
"country": "USA",
"latitude": 30.2711,
"longitude": -97.7437
}
]
},
"meta": {
"request_id": "req_rl_auto_aus",
"endpoint": "/v1/locations/autocomplete",
"credits_charged": 2,
"cached": true,
"took_ms": 19
}
}Response Fields
Structured location suggestions with canonical search IDs.
| Field | Type | Sample / Notes |
|---|---|---|
code | integer | Example: 0 |
provider | string | Example: https://realtydataapi.com |
status | string | Example: ok |
data | object | |
query | string | Example: Austin |
count | integer | Example: 5 |
suggestions | array of object | |
id | string | Example: city:tx_austin |
area_type | string | Example: city |
label | string | Example: Austin, TX |
city | string | Example: Austin |
state_code | string | Example: TX |
postal_code | string | Example: 78701 |
latitude | number | Example: 30.2672 |
longitude | number | Example: -97.7431 |
meta | ResponseMeta | |
request_id | string | Example: req_rl_78701_9a2f |
endpoint | string | Example: /v1/properties/search |
credits_charged | integer | Example: 40 |
cached | boolean | Example: true |
took_ms | integer | Example: 28 |
Status Codes
- 200
- Structured location suggestions with canonical search IDs.