{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper Pro", "description": "Scrape Zillow property listings and deep details by ZIP code or URL. Returns address, price, beds, baths, sqft, Zestimate, price history, tax records, school ratings, and agent info. Anti-bot resilient via residential proxies and fingerprint spoofing. Supports for_sale, for_rent, and recently_sold.", "version": "3.1", "x-build-id": "HmTITRmhE1si9QiRz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ws_tony~zillow-scraper-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ws_tony-zillow-scraper-pro", "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/ws_tony~zillow-scraper-pro/runs": { "post": { "operationId": "runs-sync-ws_tony-zillow-scraper-pro", "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/ws_tony~zillow-scraper-pro/run-sync": { "post": { "operationId": "run-sync-ws_tony-zillow-scraper-pro", "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": { "zipCodes": { "title": "ZIP Codes", "type": "array", "description": "ZIP codes to search. Add one per line — e.g. 10001, 90210, 78701.", "items": { "type": "string" } }, "startUrls": { "title": "City / Neighborhood / Custom URL (optional)", "type": "array", "description": "City names (\"Austin, TX\"), neighborhood names, or any Zillow search URL. Use this if you want to search beyond ZIP codes or paste a filtered Zillow URL from your browser.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingType": { "title": "Listing Type", "enum": [ "for_sale", "for_rent", "recently_sold" ], "type": "string", "description": "What kind of listings to pull.", "default": "for_sale" }, "includeSingleFamily": { "title": "Single Family", "type": "boolean", "description": "Include single-family homes.", "default": true }, "includeCondo": { "title": "Condo", "type": "boolean", "description": "Include condos and co-ops.", "default": true }, "includeTownhouse": { "title": "Townhouse", "type": "boolean", "description": "Include townhouses.", "default": true }, "includeMultiFamily": { "title": "Multi-Family", "type": "boolean", "description": "Include duplexes, triplexes, and other multi-family properties.", "default": true }, "includeApartment": { "title": "Apartment", "type": "boolean", "description": "Include apartment units.", "default": true }, "includeManufactured": { "title": "Manufactured / Mobile Home", "type": "boolean", "description": "Include manufactured and mobile homes.", "default": false }, "includeLand": { "title": "Land / Lot", "type": "boolean", "description": "Include vacant land and lots.", "default": false }, "dataDepth": { "title": "Data Depth", "enum": [ "summary", "detail", "auto" ], "type": "string", "description": "Summary: fast and cheap — returns ~20 fields from the search page only. Detail: visits each listing page for 45+ fields including price history, tax records, schools, and agent info (costs ~5× more per property). Auto: tries detail, falls back to summary if Zillow blocks the detail page.", "default": "detail" }, "maxResults": { "title": "Max Properties", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of properties to collect across all ZIP codes and locations.", "default": 100 }, "minPrice": { "title": "Min Price ($)", "minimum": 0, "type": "integer", "description": "Only include listings at or above this price." }, "maxPrice": { "title": "Max Price ($)", "minimum": 0, "type": "integer", "description": "Only include listings at or below this price." }, "minBeds": { "title": "Min Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBeds": { "title": "Max Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum number of bedrooms." }, "minBaths": { "title": "Min Bathrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Minimum number of bathrooms (decimals allowed for half-baths)." }, "maxDaysOnMarket": { "title": "Max Days on Market", "minimum": 1, "type": "integer", "description": "Only include listings that have been on Zillow for this many days or fewer. Useful for finding recently listed properties." }, "proxyConfig": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxies are required — Zillow blocks datacenter IPs at the edge." } } }, "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 } } } } } } } } } }