{ "openapi": "3.0.1", "info": { "title": "Zillow Search Scraper", "description": "Go beyond a single Zillow result window with automatic pagination and search subdivision. Collect deduplicated listings by ZIP, location, URL, or map bounds, with your own result limit and coverage metadata.", "version": "1.0", "x-build-id": "M0OWnjSm92pXU9k8q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alol~zillow-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alol-zillow-search", "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/alol~zillow-search/runs": { "post": { "operationId": "runs-sync-alol-zillow-search", "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/alol~zillow-search/run-sync": { "post": { "operationId": "run-sync-alol-zillow-search", "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": { "externalId": { "title": "External ID", "maxLength": 256, "type": "string", "description": "Optional caller-owned run ID copied to every output row." }, "correlationId": { "title": "Correlation ID", "maxLength": 256, "type": "string", "description": "Optional trace/workflow ID copied to every output row." }, "zipCodes": { "title": "ZIP codes", "maxItems": 100, "type": "array", "description": "One or more US ZIP codes to search.", "items": { "type": "string", "pattern": "^\\d{5}$" } }, "locationQueries": { "title": "Location queries", "maxItems": 100, "type": "array", "description": "Free-text locations, e.g. 'Austin, TX' or 'Travis County, TX'. Resolved via Zillow autocomplete.", "items": { "type": "string", "maxLength": 256 } }, "searchUrls": { "title": "Zillow search URLs", "maxItems": 100, "type": "array", "description": "Paste ready-made Zillow search-result URLs. Their filters are honored as-is.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "mapBounds": { "title": "Map bounds", "required": [ "north", "south", "east", "west" ], "type": "object", "description": "Bounding box { north, south, east, west } in decimal degrees. Adds a target alongside any ZIP, location-query, or URL targets.", "properties": { "north": { "title": "North latitude", "type": "number", "description": "Northern edge in decimal degrees; must be greater than south.", "minimum": -90, "maximum": 90 }, "south": { "title": "South latitude", "type": "number", "description": "Southern edge in decimal degrees; must be less than north.", "minimum": -90, "maximum": 90 }, "east": { "title": "East longitude", "type": "number", "description": "Eastern edge in decimal degrees; must be greater than west.", "minimum": -180, "maximum": 180 }, "west": { "title": "West longitude", "type": "number", "description": "Western edge in decimal degrees; must be less than east.", "minimum": -180, "maximum": 180 } }, "additionalProperties": false }, "center": { "title": "Search center", "required": [ "latitude", "longitude" ], "type": "object", "description": "Center of a circular Search / Map Results target. Supply radiusMiles; do not combine with other targets.", "properties": { "latitude": { "title": "Latitude", "description": "Center latitude in decimal degrees, from -85 to 85.", "type": "number", "minimum": -85, "maximum": 85 }, "longitude": { "title": "Longitude", "description": "Center longitude in decimal degrees, from -180 to 180.", "type": "number", "minimum": -180, "maximum": 180 } }, "additionalProperties": false }, "radiusMiles": { "title": "Radius (miles)", "minimum": 0.1, "maximum": 100, "type": "number", "description": "Exact radius, including fractional values such as 2.5. Requires center. Missing coordinates are excluded." }, "soldDateFrom": { "title": "Sold on or after", "type": "string", "description": "Inclusive YYYY-MM-DD sale date. Requires only the sold listing type; excludes unknown dates. Cannot combine with searchUrls or daysOnZillowMax." }, "soldDateTo": { "title": "Sold on or before", "type": "string", "description": "Inclusive YYYY-MM-DD sale date. Requires only the sold listing type; excludes unknown dates." }, "listingTypes": { "title": "Listing types", "maxItems": 5, "type": "array", "description": "Which listing categories to include.", "items": { "type": "string", "enum": [ "forSale", "forRent", "sold", "fsbo", "foreclosure" ], "enumTitles": [ "For sale", "For rent", "Recently sold", "For sale by owner", "Foreclosure / pre-foreclosure" ] }, "default": [ "forSale" ] }, "priceMin": { "title": "Min price ($)", "minimum": 0, "type": "number", "description": "Lowest listing price to include, in USD." }, "priceMax": { "title": "Max price ($)", "minimum": 0, "type": "number", "description": "Highest listing price to include, in USD." }, "bedsMin": { "title": "Min beds", "minimum": 0, "type": "number", "description": "Minimum number of bedrooms." }, "bathsMin": { "title": "Min baths", "minimum": 0, "type": "number", "description": "Minimum number of bathrooms." }, "sqftMin": { "title": "Min living area (sq ft)", "minimum": 0, "type": "number", "description": "Minimum living area in square feet." }, "sqftMax": { "title": "Max living area (sq ft)", "minimum": 0, "type": "number", "description": "Maximum living area in square feet." }, "homeTypes": { "title": "Home types", "maxItems": 7, "type": "array", "description": "Restrict to specific property types. Empty = all.", "items": { "type": "string", "enum": [ "house", "condo", "townhome", "multiFamily", "land", "apartment", "manufactured" ], "enumTitles": [ "House", "Condo", "Townhome", "Multi-family", "Lot / land", "Apartment", "Manufactured" ] }, "default": [] }, "daysOnZillowMax": { "title": "Max days on Zillow", "minimum": 1, "maximum": 365, "type": "number", "description": "Only listings from Zillow's supported age window. Allowed values: 1, 7, 14, 30, 90, 180, or 365 days." }, "keywords": { "title": "Keywords", "maxItems": 50, "type": "array", "description": "Free-text keyword filter, e.g. 'pool', 'waterfront'.", "items": { "type": "string", "maxLength": 128 } }, "updatedSince": { "title": "Updated since", "type": "string", "description": "Search only. Return listings whose Zillow lastModifiedAt is at or after this ISO-8601 timestamp." }, "updatedSinceUnknownPolicy": { "title": "Listings without an update timestamp", "enum": [ "include", "exclude" ], "type": "string", "description": "Search only. Zillow does not expose lastModifiedAt for every card. Include preserves recall; exclude gives a strict incremental feed.", "default": "include" }, "maxResults": { "title": "Max results", "minimum": 20, "type": "integer", "description": "Maximum emitted rows across all targets. Paid runs require at least 20 requested results.", "default": 20 }, "maxTotalChargeUsd": { "title": "Maximum total charge (USD)", "minimum": 0, "maximum": 100000, "type": "number", "description": "Hard limit for pay-per-event charges in this run. The Actor stops writing paid results before the limit is exceeded." }, "maxUpstreamAttempts": { "title": "Maximum upstream attempts", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Optional run-level ceiling for Zillow, Apify Proxy, and Scraping Browser attempts. The operator deployment limit can only reduce this value." }, "maxUpstreamCostUsd": { "title": "Maximum upstream cost (USD)", "minimum": 0.000001, "maximum": 100000, "type": "number", "description": "Optional best-effort ceiling for all measured upstream proxy and Scraping Browser costs, including search tiers and the detail Apify fallback. The final request may cause a small overshoot." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum parallel requests.", "default": 10 } } }, "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 } } } } } } } } } }