{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper - Property Listings, Prices & Leads", "description": "Scrape Zillow homes for sale, for rent & recently sold by city, ZIP or URL: price, Zestimate, beds/baths, sqft, lot, photos, price & tax history, schools and listing-agent contacts (name, phone, email). Lead scoring + monitor mode. No API key, no browser.", "version": "0.1", "x-build-id": "ZAKGha7iIZNaKhk31" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapesage~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~zillow-scraper/runs": { "post": { "operationId": "runs-sync-scrapesage-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/scrapesage~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-scrapesage-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", "properties": { "locations": { "title": "Locations (city, ZIP or neighborhood)", "type": "array", "description": "Places to search. Use `City, ST` (e.g. `Austin, TX`), `City, State name`, a neighborhood, or a 5-digit ZIP. Each location is combined with the chosen Listing type.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "5-digit ZIP codes to search (alternative to Locations).", "items": { "type": "string" } }, "searchUrls": { "title": "Zillow search URLs", "type": "array", "description": "Paste Zillow search/results page URLs (e.g. https://www.zillow.com/austin-tx/houses/). A pasted URL's own filters (searchQueryState) are respected.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "propertyUrls": { "title": "Property URLs (homedetails)", "type": "array", "description": "Paste individual Zillow property URLs (…/homedetails/…_zpid/) to scrape full property details directly. These are always enriched with price/tax history, schools and listing-agent contacts.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "startUrls": { "title": "Start URLs (auto-detect)", "type": "array", "description": "Any mix of Zillow search or property URLs — the actor auto-detects each.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingType": { "title": "Listing type", "enum": [ "forSale", "forRent", "sold" ], "type": "string", "description": "Which listings to return for location/ZIP searches.", "default": "forSale" }, "forSaleByOwnerOnly": { "title": "For sale by owner (FSBO) only", "type": "boolean", "description": "When Listing type is For sale, return only FSBO listings (great for wholesaler / investor seller leads).", "default": false }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Minimum price (sale) or monthly rent." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Maximum price (sale) or monthly rent." }, "minBeds": { "title": "Min beds", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBeds": { "title": "Max beds", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum number of bedrooms." }, "minBaths": { "title": "Min baths", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bathrooms." }, "minSqft": { "title": "Min living area (sqft)", "minimum": 0, "type": "integer", "description": "Minimum living area in square feet." }, "maxSqft": { "title": "Max living area (sqft)", "minimum": 0, "type": "integer", "description": "Maximum living area in square feet." }, "minYearBuilt": { "title": "Min year built", "minimum": 1800, "type": "integer", "description": "Earliest year the home was built." }, "maxYearBuilt": { "title": "Max year built", "minimum": 1800, "type": "integer", "description": "Latest year the home was built." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Restrict to specific home types. Allowed values: houses, condos, townhomes, multi-family, apartments, manufactured, lots-land. Leave empty for all.", "default": [], "items": { "type": "string" } }, "daysOnZillow": { "title": "Days on Zillow", "enum": [ "", "1", "7", "14", "30", "90" ], "type": "string", "description": "Only listings published within this window.", "default": "" }, "sort": { "title": "Sort by", "enum": [ "relevant", "newest", "price_asc", "price_desc", "beds", "lot_size" ], "type": "string", "description": "Ordering for location/ZIP/search-URL results.", "default": "relevant" }, "includePropertyDetails": { "title": "Include full property details", "type": "boolean", "description": "Visit each property page for the full dataset: description, year built, lot size, HOA, parcel/county, price history, tax history, schools, interior facts AND the listing agent + broker contacts (name, phone, email, license, MLS). One extra request per listing; charged as a 'Property details' add-on only when it succeeds.", "default": false }, "extractAgentLeads": { "title": "Extract agent leads", "type": "boolean", "description": "Also output one deduplicated agent-lead record per listing agent (name, phone, email, license, brokerage, MLS). Requires Include full property details. Charged as a separate 'Agent lead' record.", "default": false }, "maxPhotosPerListing": { "title": "Max photos per listing", "minimum": 0, "maximum": 50, "type": "integer", "description": "Cap the number of photo URLs stored per property (0 = none).", "default": 10 }, "maxResults": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Maximum number of property records to return across the whole run.", "default": 100 }, "maxResultsPerSearch": { "title": "Max results per location/search", "minimum": 0, "type": "integer", "description": "Cap results per individual location/ZIP/search URL (0 = no per-search cap). Zillow caps a single search at ~500–800 results; split by price band or ZIP to exceed that.", "default": 0 }, "maxRunSeconds": { "title": "Soft time budget (seconds)", "minimum": 30, "maximum": 21600, "type": "integer", "description": "The run stops gracefully after this many seconds so scheduled/automated runs never hit the platform timeout. Default 240s keeps health-check runs under 5 minutes; raise it (e.g. 1800) for big pulls and set a matching run timeout.", "default": 240 }, "detailConcurrency": { "title": "Detail concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel property-detail requests when Include full property details is on. Lower values are gentler on Zillow's anti-bot and improve per-page success.", "default": 3 }, "deduplicateResults": { "title": "Deduplicate results", "type": "boolean", "description": "Skip duplicate properties (by zpid) within a run.", "default": true }, "monitorMode": { "title": "Monitor mode (only new / changed listings)", "type": "boolean", "description": "Remember listings across runs and emit only NEW listings or ones whose price/status CHANGED (tagged monitorStatus = new|changed). Works independently of Apify Schedules — schedule this actor and each run returns only what's new. Great for new-listing & price-drop alerts.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that remembers seen listings between runs. Use distinct names to track different markets separately. Lowercase letters, digits and hyphens only.", "default": "zillow-scraper-monitor" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Zillow blocks datacenter IPs (PerimeterX). Keep the default Apify Residential proxy for reliable results.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "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 } } } } } } } } } }