{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper - Real Estate Listings, Agents & Zestimate", "description": "Scrape Zillow listings, agent contacts, prices, Zestimate, photos, price & tax history at scale. Two modes: DETAIL (per URL or ZPID) and SEARCH (paginated by city, ZIP, neighborhood). HTTP-only with Chrome TLS impersonation + US residential proxies. No Zillow API needed. Export JSON, CSV, Excel.", "version": "0.1", "x-build-id": "sO9KdmA7dLiza4ycO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quiet_bark~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quiet_bark-zillow-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/quiet_bark~zillow-scraper/runs": { "post": { "operationId": "runs-sync-quiet_bark-zillow-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/quiet_bark~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-quiet_bark-zillow-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "Mode", "enum": [ "DETAIL", "SEARCH" ], "type": "string", "description": "DETAIL: deep-scrape individual listing pages. SEARCH: paginate through a Zillow search and emit each listing summary.", "default": "DETAIL" }, "startUrls": { "title": "Start URLs (DETAIL mode)", "type": "array", "description": "List of Zillow property URLs (homedetails / hdp pages). Used only in DETAIL mode.", "default": [ { "url": "https://www.zillow.com/homedetails/17199-Park-Ave-Sonoma-CA-95476/15800416_zpid/" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "zpids": { "title": "ZPIDs (DETAIL mode)", "type": "array", "description": "Optional list of raw ZPIDs to scrape. Each ZPID is resolved to https://www.zillow.com/homedetails/{zpid}_zpid/. Used only in DETAIL mode.", "default": [], "items": { "type": "string" } }, "datasetId": { "title": "Input Dataset ID (DETAIL mode)", "type": "string", "description": "Optional Apify dataset ID (e.g. from a previous SEARCH run or a Zillow Search Scraper). Items are expected to expose a `zpid`, `detailUrl`, `hdpUrl` or `url` field." }, "searchQueries": { "title": "Search queries (SEARCH mode)", "type": "array", "description": "List of search inputs. Each item can be a free-text query (\"Sonoma, CA\", \"Beverly Hills, CA\", \"90210\"), a Zillow region slug (\"sonoma-ca\"), or a full Zillow search URL (\"https://www.zillow.com/sonoma-ca/\"). Used only in SEARCH mode.", "default": [], "items": { "type": "string" } }, "maxPagesPerSearch": { "title": "Max pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "Hard cap on pagination depth per search query. Zillow exposes up to 20 pages × 41 results = 820 listings per region URL. Used only in SEARCH mode.", "default": 20 }, "propertyStatus": { "title": "Expected property status", "enum": [ "ANY", "FOR_SALE", "SOLD", "FOR_RENT" ], "type": "string", "description": "DETAIL mode: informational filter. SEARCH mode: chooses the search slug suffix (FOR_SALE → /, SOLD → /sold/, FOR_RENT → /rentals/).", "default": "ANY" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many requests to fetch in parallel.", "default": 5 }, "maxRetries": { "title": "Max retries per URL", "minimum": 0, "maximum": 15, "type": "integer", "description": "Retries on 403/429/5xx and bot-block pages (in addition to dedicated proxy/captcha retry budgets).", "default": 5 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. US residential proxies are the default and strongly recommended — Zillow only serves data to US visitors and aggressively blocks datacenter traffic.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "rawOutput": { "title": "Include raw GraphQL cache (DETAIL mode)", "type": "boolean", "description": "If enabled, each DETAIL item also contains the original `gdpClientCache` payload under `_raw`.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }