---
title: "Autocomplete Zillow locations"
method: GET
path: "/zillow/autocomplete"
tags: ["Zillow"]
---

# Autocomplete Zillow locations

`GET /zillow/autocomplete`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/zillow/autocomplete`
- Auth: API key in header `x-api-key`

Returns Zillow autocomplete candidates, including region ids and types. Zillow autocomplete does not currently return map bounds.

## Query parameters

- `query` string, required
- `limit` integer
- `status` 'for_sale' | 'sale' | 'for-sale' | 'for_rent' | 'rent' | 'for-rent' | 'sold'

## Headers

- `x-api-key` string, required

## Response `200`

OK

- ZillowAutocompleteResponse
  - `query` string: Query that was run.
  - `request_id` string: Identifier Zillow gave to this autocomplete request.
  - `results` ZillowAutocompleteItem[]: Location suggestions, in the order Zillow returned them.
    - `city` string: City name of the suggested place.
    - `county` string: County name of the suggested place.
    - `id` string: Identifier of the suggestion, as Zillow returns it.
    - `latitude` number: Latitude of the suggested location, in decimal degrees.
    - `longitude` number: Longitude of the suggested location, in decimal degrees.
    - `near_me` boolean: Whether the suggestion is Zillow's near-me search option.
    - `plid` string: Place identifier of the suggestion, as Zillow returns it.
    - `region_display_ids` string[]: Display ids of the regions listed in `region_ids`, as Zillow returns them.
    - `region_id` integer: Zillow region id of the suggestion. Pass it as `region_id` to the search endpoint.
    - `region_ids` integer[]: Zillow region ids covered by a suggestion that spans several regions.
    - `region_type` integer: Zillow region type code that goes with `region_id`. Pass it as `region_type` to the search endpoint.
    - `region_types` integer[]: Zillow region type codes that match the region ids in `region_ids`.
    - `school_district_ids` integer[]: Zillow ids of the school districts the suggestion refers to.
    - `school_ids` integer[]: Zillow ids of the schools the suggestion refers to.
    - `state` string: State abbreviation of the suggested place, such as `CA`.
    - `sub_type` string: Kind of place the suggestion is, such as `city`.
    - `view_latitude_delta` number: Latitude span of the map view Zillow suggests for this result.

## Other responses

- `400`: Bad Request
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)