{ "openapi": "3.0.1", "info": { "title": "Zillow Property Listings Scraper", "description": "Scrape public Zillow sale, rent, and sold property search results with prices, addresses, beds, baths, brokers, images, and map coordinates.", "version": "0.1", "x-build-id": "oC5RJ9gkwLMNHL4dm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~zillow-property-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-zillow-property-listings-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/fetch_cat~zillow-property-listings-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-zillow-property-listings-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/fetch_cat~zillow-property-listings-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-zillow-property-listings-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": { "startUrls": { "title": "Zillow search URLs", "type": "array", "description": "One or more Zillow search-result URLs. Filtered URLs containing searchQueryState can use the structured search-state route and preserve their map and filter settings.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "locations": { "title": "Locations", "type": "array", "description": "City, ZIP code, neighborhood, or area names. The Actor converts each value to a Zillow search URL using listingType.", "items": { "type": "string" } }, "resumeSearchUrls": { "title": "Resume search URLs", "type": "array", "description": "Optional URLs copied from RUN_CHECKPOINT.resumeSearchUrls after a bounded deadline stop. When supplied, these replace fresh start URLs and locations.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingType": { "title": "Listing type for locations", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "Used for generated location searches. A pasted search URL keeps the mode and filters encoded in that URL.", "default": "for_sale" }, "extractionMethod": { "title": "Extraction method", "enum": [ "AUTO", "PAGINATION", "SEARCH_STATE" ], "type": "string", "description": "AUTO uses Zillow's structured search-state response for URLs with searchQueryState and HTML pagination otherwise. PAGINATION always reads search pages. SEARCH_STATE requires filtered URLs with searchQueryState.", "default": "AUTO" }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum unique listings saved across every search source. Range: 1-10,000.", "default": 20 }, "maxPages": { "title": "Maximum pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum result pages requested for each search source. Zillow commonly caps ordinary pagination near 20 pages.", "default": 1 }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Keep listings whose numeric price is at least this value. Listings without a numeric price are excluded when this filter is active." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Keep listings whose numeric price is no more than this value. Must be at least minPrice." }, "minBeds": { "title": "Minimum bedrooms", "minimum": 0, "type": "number", "description": "Keep listings with at least this many bedrooms." }, "minBaths": { "title": "Minimum bathrooms", "minimum": 0, "type": "number", "description": "Keep listings with at least this many bathrooms." }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Existing runs use a US residential Apify Proxy session by default because Zillow frequently blocks datacenter traffic. Omit groups for that default, provide an empty group list for standard Apify datacenter routing, provide other authorized groups, or disable proxy use.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }