Skip to main content
GET
/
v1
/
zillow
/
autocomplete
Location Suggestions
curl --request GET \
  --url https://scrapebadger.com/v1/zillow/autocomplete \
  --header 'x-api-key: <api-key>'
{
  "query": "<string>",
  "results": [
    {
      "display": "<string>",
      "region_id": 123,
      "region_type": "<string>",
      "latitude": 123,
      "longitude": 123,
      "zpid": "<string>",
      "metro_id": 123
    }
  ]
}

​
Query Parameters

​
query
string
required
Partial location to autocomplete — a city, ZIP, address, or neighborhood (e.g. austi, 9021, travis heights).

​
Response

​
query
string
The query prefix that was autocompleted.
​
results
array
Array of suggestion objects.

​
Example Response

{
  "query": "austi",
  "results": [
    {
      "display": "Austin, TX",
      "region_id": 10221,
      "region_type": "city",
      "latitude": 30.2672,
      "longitude": -97.7431,
      "zpid": null,
      "metro_id": 394355
    }
  ]
}
Each autocomplete request costs 2 credits. Failed requests are not charged.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
query
string
required

Partial location — city, ZIP, address, or neighborhood.

Response

200 - application/json

Suggestions

​
query
string
​
results
object[]