{ "openapi": "3.0.1", "info": { "title": "Zillow ZIP Code Scraper", "description": "Scrape Zillow by ZIP code: for sale, rent, sold. 55 filters, map tiling, price history. $0.80/1K results — the lowest price on Apify, cheaper than any alternative.", "version": "0.0", "x-build-id": "8fikiK8kYU0lX72OP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unfenced-group~zillow-zip-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unfenced-group-zillow-zip-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/unfenced-group~zillow-zip-scraper/runs": { "post": { "operationId": "runs-sync-unfenced-group-zillow-zip-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/unfenced-group~zillow-zip-scraper/run-sync": { "post": { "operationId": "run-sync-unfenced-group-zillow-zip-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": [ "zipCodes" ], "properties": { "sortBy": { "title": "Sort by", "enum": [ "days", "relevance", "recentlyChanged", "priceHigh", "priceLow", "bedrooms", "bathrooms", "sqft", "lotSize", "yearBuilt" ], "type": "string", "description": "Sort order for results.", "default": "days" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Minimum listing price in USD (sale/sold). For rent, use Rent Min.", "default": 0 }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Maximum listing price in USD (sale/sold).", "default": 0 }, "daysOld": { "title": "Max listing age (days)", "minimum": 0, "type": "integer", "description": "Only return listings published within the last N days. Leave empty for no recency filter." }, "fetchDetails": { "title": "Fetch detail pages", "type": "boolean", "description": "Fetch each listing's detail page for richer data: price history, tax history, school ratings, walk/transit/bike scores, and full photo gallery. Slower and uses more proxy bandwidth.", "default": false }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Maximum total listings to collect across all ZIP codes. 0 = no limit.", "default": 0 }, "startUrls": { "title": "Start URLs (overrides filters)", "type": "array", "description": "Optional list of search-results page URLs. When provided, all filter fields above are ignored.", "items": { "type": "object" }, "default": [] }, "zipCodes": { "title": "ZIP Codes", "type": "array", "description": "List of US ZIP codes to search. One or more, e.g. [\"90210\", \"10001\"].", "items": { "type": "string" } }, "operationType": { "title": "Operation type", "enum": [ "sale", "rent", "sold" ], "type": "string", "description": "Type of listing to search: sale (for sale), rent (for rent), or sold (recently sold).", "default": "sale" }, "rentMin": { "title": "Rent: minimum ($/mo)", "minimum": 0, "type": "integer", "description": "Minimum monthly rent (for rent only).", "default": 0 }, "rentMax": { "title": "Rent: maximum ($/mo)", "minimum": 0, "type": "integer", "description": "Maximum monthly rent (for rent only).", "default": 0 }, "bedsMin": { "title": "Bedrooms: minimum", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms.", "default": 0 }, "bedsMax": { "title": "Bedrooms: maximum", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms (0 = any).", "default": 0 }, "bathsMin": { "title": "Bathrooms: minimum", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms.", "default": 0 }, "sqftMin": { "title": "Square feet: minimum", "minimum": 0, "type": "integer", "description": "Minimum living area in square feet.", "default": 0 }, "sqftMax": { "title": "Square feet: maximum", "minimum": 0, "type": "integer", "description": "Maximum living area in square feet.", "default": 0 }, "yearBuiltMin": { "title": "Year built: minimum", "minimum": 0, "type": "integer", "description": "Earliest year of construction.", "default": 0 }, "yearBuiltMax": { "title": "Year built: maximum", "minimum": 0, "type": "integer", "description": "Latest year of construction.", "default": 0 }, "daysOnZillow": { "title": "Days on Zillow", "enum": [ "", "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "Only include listings active (or sold) within this many days.", "default": "" }, "maxHoa": { "title": "Max HOA fee ($/mo)", "minimum": 0, "type": "integer", "description": "Maximum monthly HOA fee (0 = any).", "default": 0 }, "homeTypes": { "title": "Home types (empty = all)", "type": "array", "description": "Filter by property type. Leave empty to include all types.", "items": { "type": "string", "enum": [ "houses", "townhomes", "condos", "multifamily", "land", "apartments", "manufactured" ], "enumTitles": [ "Houses", "Townhomes", "Condos/Co-ops", "Multi-family", "Lots/Land", "Apartments", "Manufactured" ] } }, "keywords": { "title": "Keywords", "type": "string", "description": "Optional keyword filter, e.g. 'pool, ocean view' (max 99 characters).", "default": "" }, "includeNewConstruction": { "title": "Include new construction", "type": "boolean", "description": "Include new construction listings in results.", "default": true }, "includeForeclosures": { "title": "Include foreclosures", "type": "boolean", "description": "Include bank-owned and foreclosure listings.", "default": true }, "includeComingSoon": { "title": "Include coming soon", "type": "boolean", "description": "Include listings marked as Coming Soon.", "default": true }, "includeFSBO": { "title": "Include For Sale By Owner", "type": "boolean", "description": "Include For Sale By Owner listings.", "default": true }, "includeFSBA": { "title": "Include agent-listed", "type": "boolean", "description": "Include agent-listed properties.", "default": true }, "mustHavePool": { "title": "Must have pool", "type": "boolean", "description": "Only include properties with a pool.", "default": false }, "mustHaveGarage": { "title": "Must have garage", "type": "boolean", "description": "Only include properties with a garage.", "default": false }, "mustHaveAC": { "title": "Must have A/C", "type": "boolean", "description": "Only include properties with air conditioning.", "default": false }, "waterfront": { "title": "Waterfront only", "type": "boolean", "description": "Only include waterfront properties.", "default": false }, "openHouseOnly": { "title": "Open house only", "type": "boolean", "description": "Only include listings with an open house scheduled.", "default": false }, "has3DTour": { "title": "Must have 3D tour", "type": "boolean", "description": "Only include listings with a 3D virtual tour.", "default": false }, "priceReduced": { "title": "Price-reduced only", "type": "boolean", "description": "Only include listings with a recent price reduction.", "default": false }, "petsAllowed": { "title": "Pets allowed (rent only)", "type": "boolean", "description": "Only include pet-friendly rentals (rent only).", "default": false }, "inUnitLaundry": { "title": "In-unit laundry (rent only)", "type": "boolean", "description": "Only include rentals with in-unit laundry (rent only).", "default": false }, "onSiteParking": { "title": "On-site parking (rent only)", "type": "boolean", "description": "Only include rentals with on-site parking (rent only).", "default": false }, "furnished": { "title": "Furnished (rent only)", "type": "boolean", "description": "Only include furnished rentals (rent only).", "default": false }, "utilitiesIncluded": { "title": "Utilities included (rent only)", "type": "boolean", "description": "Only include rentals with utilities included (rent only).", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Residential proxy is required — leave default unless you have a custom setup." } } }, "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 } } } } } } } } } }