Zillow Autocomplete Actor

Overview

This Apify actor provides a minimal API to fetch location suggestions from Zillow's autocomplete service. Send a free-form search string (like an address, city, or ZIP code) and get back structured location data including coordinates and Zillow property IDs (zpid). It's designed to be a building block for real estate data workflows.

Key Features

• Location Normalization: Converts user-entered text into canonical Zillow locations with metadata.
• Coordinates & IDs: Returns latitude, longitude, and regionId/zpid where available, useful for seeding map-based or detailed property queries.
• Flexible Input: Accepts ZIP codes, city/state combinations, neighborhoods, or full addresses.
• Sync API: Provides a simple, synchronous POST endpoint for immediate results.
• Error Handling: Returns clear error objects for missing inputs, no results, or upstream failures.

Note: This actor is for getting location suggestions only. It does not scrape full property details, handle pagination, or provide historical data.

How to Use

The actor is called via a single POST endpoint. You must include your Apify API token for authentication.

Endpoint:

POST https://api.apify.com/v2/acts/re-ai~zillow-autocomplete/run-sync-get-dataset-items?token=YOUR_APIFY_TOKEN

Request Body (JSON):

{
  "query": "Your search string here"
}

Quick Example (curl)

curl -X POST \
  "https://api.apify.com/v2/acts/re-ai~zillow-autocomplete/run-sync-get-dataset-items?token=$APIFY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "1600 Pennsylvania Ave NW, Washington, DC"}'

Input/Output

Input:
* query (string, required): The free-form location search string.

Output:
The response is always a JSON array.

• Success: Contains up to five suggestion objects from Zillow.
  jsonc [ { "resultType": "region|address|property", "display": "Human readable label", "metaData": { "lat": 00.000000, "lng": -00.000000, "addressType": "zip|city|neighborhood|address", "regionId": 123456 // Zillow's ID for the location } // ... additional Zillow-specific fields may be present } ]
• No Results: [{ "error": "No suggestions", "status": 404 }]
• Bad Request: [{ "error": "Missing required field: 'query'", "status": 400 }]
• Upstream Error: [{ "error": "<message>", "status": 500 }]

Behavior & Notes

• The actor returns the first five suggestions from Zillow's autocomplete.
• Use the metaData.lat and metaData.lng as a centroid for map or grid-based queries.
• More specific queries (e.g., a full address) typically yield more precise results.
• The actor relies on Zillow's live endpoint. Availability, data shape, and rate limits are subject to change.
• Only the query parameter is accepted. Custom timeouts or headers are not currently configurable.