{ "openapi": "3.0.1", "info": { "title": "๐Ÿก Zillow ZIP Code Search Scraper", "description": "๐Ÿš€ Scrape Zillow listings by ZIP code at scale. Pull homes ๐Ÿ  for sale, rent, or sold with price ๐Ÿ’ฐ, beds ๐Ÿ›๏ธ, baths ๐Ÿ›, photos ๐Ÿ“ธ, Zestimateยฎ & more. Smart proxy fallback (no proxy โ†’ datacenter โ†’ residential) keeps results flowing even on tough days.", "version": "0.1", "x-build-id": "3IX0YjhgO5DyyNGBU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapebase~zillow-zip-code-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapebase-zillow-zip-code-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/scrapebase~zillow-zip-code-search-scraper/runs": { "post": { "operationId": "runs-sync-scrapebase-zillow-zip-code-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/scrapebase~zillow-zip-code-search-scraper/run-sync": { "post": { "operationId": "run-sync-scrapebase-zillow-zip-code-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", "required": [ "zipCodes" ], "properties": { "zipCodes": { "title": "๐Ÿ“ฎ ZIP Codes", "minItems": 1, "uniqueItems": true, "type": "array", "description": "๐Ÿ—บ๏ธ List of US ZIP codes to search. One Zillow search runs per ZIP code. Bulk input supported โ€” paste as many as you need.", "items": { "type": "string" } }, "maxItems": { "title": "๐Ÿ”ข Max Listings per ZIP", "minimum": 0, "type": "integer", "description": "๐Ÿ“Š Maximum listings to collect per ZIP code. Use 0 for unlimited (Zillow caps each search around 800).", "default": 10 }, "priceMax": { "title": "๐Ÿ’ฐ Max Price (USD)", "minimum": 0, "maximum": 2147483646, "type": "integer", "description": "๐Ÿ’ต Maximum sale price โ€” or maximum monthly rent if 'For Rent' is enabled. Leave 0 for no cap.", "default": 0 }, "priceMin": { "title": "๐Ÿ’ธ Min Price (USD)", "minimum": 0, "maximum": 2147483646, "type": "integer", "description": "๐ŸŽฏ Minimum sale price (or minimum monthly rent if 'For Rent' is on). Leave 0 to skip.", "default": 0 }, "daysOnZillow": { "title": "๐Ÿ“… Days on Zillow", "enum": [ "", "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "โฑ๏ธ Filter listings by how long they have been on Zillow.", "default": "" }, "forSaleByAgent": { "title": "๐Ÿ“ˆ For Sale by Agent", "type": "boolean", "description": "๐Ÿข Include homes listed by a real-estate agent / broker (MLS).", "default": true }, "forSaleByOwner": { "title": "๐Ÿท๏ธ For Sale by Owner (FSBO)", "type": "boolean", "description": "๐Ÿ‘ค Include homes listed directly by the owner (no agent).", "default": false }, "forRent": { "title": "๐Ÿ˜๏ธ For Rent", "type": "boolean", "description": "๐Ÿ”‘ Include rental listings instead of (or alongside) for-sale homes. When enabled, the price cap becomes the maximum monthly rent.", "default": false }, "sold": { "title": "๐Ÿ’ผ Recently Sold", "type": "boolean", "description": "๐Ÿ“œ Search recently SOLD homes instead of active listings.", "default": false }, "proxyConfiguration": { "title": "๐ŸŒ Apify Proxy (optional)", "type": "object", "description": "๐Ÿ‘† Turn on only if you want to run through Apify Proxy from the start. Leave off for automatic fallback (direct โ†’ datacenter โ†’ residential)." } } }, "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 } } } } } } } } } }