{ "openapi": "3.0.1", "info": { "title": "Zillow Search Scraper", "description": "Extract Zillow search data at scale with customizable filters for location, pricing, and home features. Gather listings, estimates, images, and agent details in clean structured format. Ideal for real estate analytics, automation pipelines, and investment research workflows.", "version": "0.4", "x-build-id": "e1L0PGHqT4RKeVD6n" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~zillow-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-zillow-search-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/scrapier~zillow-search-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-zillow-search-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/scrapier~zillow-search-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-zillow-search-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": { "searchUrls": { "title": "šŸ”Ž Search URLs or Keywords", "type": "array", "description": "šŸ“ Add Zillow search URLs (best) or location keywords.\\n\\nāœ… Supports bulk input.\\nāœ… Full Zillow URLs with `searchQueryState` are highly recommended for best accuracy.\\n\\nšŸ’” Examples: `dallas-tx`, `new-york-ny`.", "items": { "type": "string" } }, "extractionMethod": { "title": "āš™ļø Items Extraction Method", "enum": [ "PAGINATION_WITH_DYNAMIC_ZOOM_INCREASE", "PAGINATION_WITHOUT_ZOOMING_IN", "MAP_MARKERS" ], "type": "string", "description": "šŸ§  Choose how listings are extracted.\\n\\nšŸ” Dynamic zoom splits map areas into smaller zones to collect more results (best for large datasets).\\nšŸ“„ Pagination without zooming uses HTML pages (helpful when API is blocked).\\nšŸ“Œ Map markers is simpler but capped at around 500 listings per search URL.", "default": "PAGINATION_WITH_DYNAMIC_ZOOM_INCREASE" }, "maxItems": { "title": "šŸŽÆ Maximum Items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "šŸ“ˆ Set the maximum number of property listings to scrape per run (1-10000).\\n\\nāš” Lower = faster run, higher = deeper data.", "default": 10 }, "sortOrder": { "title": "šŸ”€ Sort Order", "enum": [ "globalrelevanceex", "days", "priced_low", "priced_high", "sqft", "lot", "beds", "baths" ], "type": "string", "description": "ā†•ļø Override the result sort order for every search URL that uses the API-based extraction methods.\\n\\nšŸ•³ļø Leave blank to keep each URL's own `searchQueryState` sort as-is.\\n\\nšŸ’” Example: `priced_low` sorts cheapest-first regardless of what the source URL specified." }, "delay": { "title": "ā±ļø Delay Between Requests (seconds)", "minimum": 0, "maximum": 60, "type": "integer", "description": "šŸ¢ Pause this many seconds between page/API requests to reduce the chance of being rate-limited or blocked.\\n\\nāš” Lower = faster run, higher = safer for large scrapes.", "default": 2 }, "proxyConfiguration": { "title": "šŸ›”ļø Proxy Configuration", "type": "object", "description": "šŸŒ Control proxy behavior for reliability.\\n\\nšŸŸ¢ Default: no proxy\\nšŸ” Auto-fallback if blocked: Datacenter ā†’ Residential (with 3 retries)\\n\\nāœ… Recommended for larger runs or stricter regions." } } }, "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 } } } } } } } } } }