{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper — Property Listings & Agent Leads", "description": "Scrape Zillow listings with 40+ fields: address, price, Zestimate, price history, agent contact info, school ratings, walk score and more. Search by location or paste listing URLs.", "version": "1.10", "x-build-id": "mV1d4WaeKpLHQBfNB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~zillow-all-in-one-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-zillow-all-in-one-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/khadinakbar~zillow-all-in-one-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-zillow-all-in-one-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/khadinakbar~zillow-all-in-one-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-zillow-all-in-one-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": { "searchQuery": { "title": "Search Query", "type": "string", "description": "Use this field when the user provides a location, neighborhood, city, or keyword like '3BR homes in Austin TX' or 'condos near downtown Denver'. Do NOT use this when the user has specific Zillow listing URLs — use startUrls instead. Do NOT use when the user has Zillow property IDs (ZPIDs) — use zpids instead." }, "startUrls": { "title": "Direct Zillow URLs", "type": "array", "description": "Use this field when the user provides specific Zillow property listing URLs (e.g., https://www.zillow.com/homedetails/...). Each URL is fully scraped for all 50+ fields. Do NOT use this for search queries — use searchQuery instead.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "zpids": { "title": "Zillow Property IDs (ZPIDs)", "type": "array", "description": "Use this field when the user provides Zillow property IDs (numeric, e.g. ['12345678', '87654321']). The actor builds the detail URL from each ZPID automatically. Great for CRM enrichment workflows.", "default": [], "items": { "type": "string" } }, "zipCodes": { "title": "ZIP Codes", "type": "array", "description": "Use this field when the user wants all listings in specific ZIP codes (e.g., ['78701', '78702', '78703']). Bulk market analysis by geography. Each ZIP code is swept for all active listings.", "default": [], "items": { "type": "string" } }, "listingType": { "title": "Listing Type", "enum": [ "FOR_SALE", "FOR_RENT", "RECENTLY_SOLD" ], "type": "string", "description": "Filter listings by sale status. FOR_SALE = active listings on market. FOR_RENT = rental listings. RECENTLY_SOLD = homes sold in the last 90 days (great for comps and market analysis).", "default": "FOR_SALE" }, "propertyTypes": { "title": "Property Types (optional filter)", "type": "array", "description": "Filter by property type. Leave empty for all types. Enter one or more values per line: SINGLE_FAMILY, CONDO, TOWNHOUSE, MULTI_FAMILY, LAND, APARTMENT, MANUFACTURED.", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Min Price ($)", "minimum": 0, "type": "integer", "description": "Minimum listing price in USD. Leave empty for no minimum." }, "maxPrice": { "title": "Max Price ($)", "minimum": 0, "type": "integer", "description": "Maximum listing price in USD. Leave empty for no maximum." }, "minBeds": { "title": "Min Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms. Leave empty for no minimum." }, "minBaths": { "title": "Min Bathrooms", "pattern": "^\\d+(\\.\\d)?$", "type": "string", "description": "Minimum number of bathrooms. Leave empty for no minimum." }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of property listings to scrape. Each listing = 1 charge event at $0.004. Set to 10 for a quick test. Set to 500+ for bulk market analysis.", "default": 50 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy settings. With the default setting the Actor reads Zillow pages over US residential proxy and, for pages that stay blocked, once through Apify's unblocking proxy (both billed as Apify platform usage). A custom proxy group or proxy URL list you set here is tried first.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }