{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper: Search & Details, Zestimate, Price History", "description": "Zillow search and property details for locations, ZIP codes or URLs, $2.10 per 1,000 ($3.20 with details). For sale, rent or sold by city, ZIP or URL; maxcopell Zillow input works. Zestimate, days on market, price and tax history, schools. Splits big areas past the 820-home cap; no agent data.", "version": "0.1", "x-build-id": "hGumpglbc1DlBwjG1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arcadium~zillow-properties/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arcadium-zillow-properties", "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/arcadium~zillow-properties/runs": { "post": { "operationId": "runs-sync-arcadium-zillow-properties", "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/arcadium~zillow-properties/run-sync": { "post": { "operationId": "run-sync-arcadium-zillow-properties", "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", "type": "array", "description": "Places to search, as you would type them on Zillow: for example a city (\"Austin, TX\"), ZIP code (\"78704\"), county (\"Travis County, TX\"), neighborhood or state. Each location is searched on its own with the filters below; every row keeps the location and its position in the results. Also accepted as `zipCodes`, `search`, `searchTerms`, `queries` or `addresses` (maxcopell actors).", "items": { "type": "string" } }, "searchUrls": { "title": "Zillow search URLs", "type": "array", "description": "Search result URLs copied from zillow.com, e.g. https://www.zillow.com/austin-tx/ or a URL with your own filters and map area (searchQueryState). The URL's filters are kept; filters set below are applied on top.", "items": { "type": "string" } }, "propertyUrls": { "title": "Property URLs or zpids", "type": "array", "description": "Property pages (https://www.zillow.com/homedetails/.../70345655_zpid/) or bare Zillow property ids (zpid, e.g. 70345655). Each gives one row with full details (facts, price and tax history, schools).", "items": { "type": "string" } }, "listingType": { "title": "Listing type", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "Which homes to search: for_sale (Zillow's default), for_rent or sold (recently sold). Empty keeps the type of a search URL. Also accepted as `status`, `propertyStatus` (RECENTLY_SOLD...) or maxcopell's `forRent` / `sold` switches." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "price_low", "price_high", "beds", "baths", "size", "lot_size" ], "type": "string", "description": "Order of the results. Empty keeps Zillow's default (relevance) or the sort of a search URL." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Lowest price in USD, e.g. 300000. For rentals this is the monthly rent, e.g. 2000." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Highest price in USD, e.g. 900000. For rentals this is the monthly rent." }, "minBeds": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Only homes with at least this many bedrooms, e.g. 3." }, "minBaths": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Only homes with at least this many bathrooms, e.g. 2." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Only these home types. Empty means all. Values: house, townhouse, condo, apartment, multi_family, manufactured, lot_land.", "items": { "type": "string", "enum": [ "house", "townhouse", "condo", "apartment", "multi_family", "manufactured", "lot_land" ], "enumTitles": [ "House", "Townhouse", "Condo", "Apartment", "Multi-family", "Manufactured", "Lot / land" ] } }, "daysOnZillow": { "title": "Days on Zillow", "enum": [ "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "Only homes listed on Zillow within this period, e.g. 7 for new listings this week. For sold searches it is the time since the sale. Empty means any. maxcopell/zillow-zip-search's `daysOnZillow` uses the same values." }, "maxResultsPerSearch": { "title": "Max properties per search", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Properties per location or search URL, e.g. 200 (the default). Zillow lists at most 820 homes per query; larger areas are split into map sections automatically, so whole metros can be read. Also accepted as `resultsLimit` or `maxResults`." }, "includeDetails": { "title": "Include property details", "type": "boolean", "description": "Also read each search result's detail page: description, year built, facts (heating, cooling, parking, appliances, HOA...), price history, tax history, schools. Detail rows are charged as 'property-details' instead of 'property'. Off by default." }, "maxItems": { "title": "Max rows in total", "minimum": 1, "type": "integer", "description": "Optional cap on charged rows for the whole run, e.g. 1000. Empty means no cap beyond the per-search limit." }, "includeErrorRows": { "title": "Include error rows", "type": "boolean", "description": "Add a free row with rowType 'error', a code (invalid_input, not_found, blocked, unavailable) and a message for every input that could not be read.", "default": true }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries per request after a temporary error, each on a new IP (default 4).", "default": 4 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Leave empty: the actor uses US residential proxies, which Zillow needs. Set your own proxies only if you know they pass Zillow's bot check." } } }, "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 } } } } } } } } } }