{ "openapi": "3.0.1", "info": { "title": "Zillow Property Details Scraper", "description": "Scrape public Zillow property detail pages for price, status, facts, history, schools, photos, agent/broker data, and diagnostics.", "version": "0.1", "x-build-id": "eZYq2ffcdUcnvpFuT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~zillow-property-details-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-zillow-property-details-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-details-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-zillow-property-details-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-details-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-zillow-property-details-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": { "propertyUrls": { "title": "Zillow property URLs", "maxItems": 1000, "type": "array", "description": "Public HTTP(S) Zillow /homedetails/ URLs to enrich. Provide URLs, ZPIDs, or a source dataset. Unsupported entries are skipped with a warning when valid inputs remain.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "zpids": { "title": "ZPIDs", "maxItems": 1000, "type": "array", "description": "Zillow property IDs. Use this when you already have ZPIDs from another workflow.", "items": { "type": "string", "pattern": "^[0-9]+$" } }, "searchResultsDatasetId": { "title": "Search results dataset ID", "pattern": "^[A-Za-z0-9_-]{5,80}$", "type": "string", "description": "Optional dataset ID from Zillow Property Listings Scraper or another Zillow search actor. Rows should contain url, detailUrl, hdpUrl, canonicalUrl, or zpid." }, "maxItems": { "title": "Maximum properties", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of unique properties to process.", "default": 10 }, "includePhotos": { "title": "Include photos", "type": "boolean", "description": "Include photo URL arrays when Zillow exposes them in the page payload.", "default": true }, "includeHistory": { "title": "Include price and tax history", "type": "boolean", "description": "Include priceHistory and taxHistory arrays when available.", "default": true }, "connectionMode": { "title": "Connection", "enum": [ "direct", "automatic" ], "type": "string", "description": "Automatic preserves the existing US residential proxy-first strategy and existing bounded source fallbacks. Managed proxy usage can incur costs even without successful records. Direct makes all requests without a proxy and never falls back to paid proxies, but Zillow may block it. Explicit legacy proxyConfiguration always takes precedence over this selector, including form defaults.", "default": "automatic" }, "maxRetries": { "title": "Maximum retries per source", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retry temporary blocks, rate limits, and server errors before moving to the next structured source.", "default": 2 }, "requestTimeoutSecs": { "title": "Request timeout in seconds", "minimum": 5, "maximum": 60, "type": "integer", "description": "Maximum time for an individual source request. The Actor also reserves time to save partial output and pending work.", "default": 30 }, "proxyConfiguration": { "title": "Legacy or custom proxy settings", "type": "object", "description": "Optional override for saved/API configurations or customer proxy pools. Explicit settings take precedence over Connection. Managed groups and country are preserved. useApifyProxy:false with no proxyUrls means Direct with no paid fallback. proxyUrls selects only that customer pool, without managed fallback. Do not combine customer URLs with managed settings. Omit this override for the normal Connection choice." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }