{ "openapi": "3.0.1", "info": { "title": "Zillow.com Real Estate & Agents API", "description": "Scrape real-time property listings, agent data, and market stats from Zillow.com. Supports search by location, coordinates, address, property details, similar homes, market stats, and agent profiles.", "version": "0.1", "x-build-id": "oeoteCe31KcpGQXMA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ashrafess3~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ashrafess3-zillow-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/ashrafess3~zillow-scraper/runs": { "post": { "operationId": "runs-sync-ashrafess3-zillow-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/ashrafess3~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-ashrafess3-zillow-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": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "search-by-location", "search-by-coordinates", "search-by-address", "property-details", "similar-homes", "market-stats", "agent-search", "agent-details", "agent-reviews", "agent-properties", "autocomplete" ], "type": "string", "description": "The scraping task to perform.", "default": "search-by-location" }, "location": { "title": "Location", "type": "string", "description": "Location string for search tasks (e.g. 'Austin-TX', 'Los Angeles CA', '90210')." }, "address": { "title": "Address", "type": "string", "description": "Full street address for search-by-address task." }, "zpid": { "title": "ZPID", "type": "integer", "description": "Zillow Property ID for detail tasks." }, "lat": { "title": "Latitude", "type": "number", "description": "Latitude for search-by-coordinates task." }, "lng": { "title": "Longitude", "type": "number", "description": "Longitude for search-by-coordinates task." }, "listType": { "title": "Listing Type", "enum": [ "for-sale", "for-rent", "sold" ], "type": "string", "description": "Filter by listing type.", "default": "for-sale" }, "page": { "title": "Page", "minimum": 1, "maximum": 20, "type": "integer", "description": "Page number for paginated results (max 20).", "default": 1 }, "sort": { "title": "Sort", "enum": [ "relevant", "newest", "price_low", "price_high", "sqft", "lot", "beds", "baths" ], "type": "string", "description": "Sort order for search results.", "default": "relevant" }, "count": { "title": "Count", "minimum": 1, "maximum": 50, "type": "integer", "description": "Number of similar homes to return.", "default": 8 }, "history": { "title": "Include History", "type": "boolean", "description": "Include historical data for market stats.", "default": false }, "agentname": { "title": "Agent Name", "type": "string", "description": "Agent screen name for agent tasks." }, "agentUrl": { "title": "Agent URL", "type": "string", "description": "Full agent profile URL (alternative to agentname)." }, "propertyType": { "title": "Property Type", "enum": [ "for-sale", "for-rent", "sold" ], "type": "string", "description": "Property type filter for agent-properties task.", "default": "for-sale" }, "query": { "title": "Query", "type": "string", "description": "Search query for autocomplete task." }, "proxyConfig": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is used by default. Switch to your own proxy or disable proxying in advanced settings.", "default": { "useApifyProxy": true, "apifyProxyGroups": [] } }, "proxyUrls": { "title": "Custom Proxy URLs (advanced)", "type": "array", "description": "Override Apify proxy with your own. One URL per line. Format: http://user:pass@host:port", "default": [], "items": { "type": "string" } }, "requestDelayMin": { "title": "Min Delay (seconds)", "type": "number", "description": "Minimum random delay between requests in seconds.", "default": 1 }, "requestDelayMax": { "title": "Max Delay (seconds)", "type": "number", "description": "Maximum random delay between requests in seconds.", "default": 3 }, "maxRetries": { "title": "Max Retries", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum number of retries per request.", "default": 5 } } }, "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 } } } } } } } } } }