{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper: Listings, Agents, Zestimate & Filters", "description": "Scrape Zillow for-sale, sold, and rental listings by city, ZIP, URL, ZPID, or dataset. Get prices, Zestimate, agent contacts, photos, property details, and history. Use fast search, full-detail enrichment, advanced filters, and listing change monitoring.", "version": "0.1", "x-build-id": "HptJvtZYgrybLxg0c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/trakk~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-trakk-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/trakk~zillow-scraper/runs": { "post": { "operationId": "runs-sync-trakk-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/trakk~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-trakk-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": { "mode": { "title": "๐ŸŽฏ What do you want to collect?", "enum": [ "SEARCH", "SEARCH_DETAILS", "DETAIL", "MONITOR" ], "type": "string", "description": "Choose Search for quick listing cards, Search + details for complete property records, Detail for known properties, or Monitor to detect listing changes.", "default": "SEARCH" }, "propertyStatus": { "title": "๐Ÿท๏ธ Listing status", "enum": [ "ANY", "FOR_SALE", "SOLD", "FOR_RENT" ], "type": "string", "description": "Choose the Zillow market you want to search. In Detail mode this is only recorded as the expected status; a successfully fetched property is never discarded because of it.", "default": "FOR_SALE" }, "searchQueries": { "title": "๐Ÿ“ Locations or Zillow search URLs", "type": "array", "description": "Used by Search, Search + details, and Monitor. Add a city, ZIP code, neighborhood, Zillow region slug, or full Zillow search URL. Each row starts a separate search.", "default": [ "Sonoma, CA" ], "items": { "type": "string" } }, "startUrls": { "title": "๐Ÿ”— Zillow property URLs", "type": "array", "description": "Used only in Detail mode. Add one or more Zillow property pages. You can combine URLs with ZPIDs and an input dataset below.", "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": "Optional raw Zillow property IDs, for example 15800416. Each ID is resolved to its property page automatically.", "default": [], "items": { "type": "string" } }, "datasetId": { "title": "๐Ÿ“ฆ Input dataset from a previous run", "type": "string", "description": "Optional dataset produced by a previous Search run. Items should contain zpid, detailUrl, hdpUrl, or url." }, "maxPagesPerSearch": { "title": "๐Ÿ“„ Pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum Zillow result pages collected for each location or search URL.", "default": 1 }, "maxResults": { "title": "๐ŸŽ Maximum saved results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Global limit after duplicate removal, filtering, and sorting. This is the maximum number of paid rows saved to Results.", "default": 50 }, "maxDetailUrls": { "title": "โœจ Maximum full-detail properties", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Detail: caps properties from all direct inputs. Search + details: caps complete property records after Maximum saved results. Use 0 for no additional cap.", "default": 0 }, "propertyType": { "title": "๐Ÿก Property type", "enum": [ "ANY", "HOUSE", "CONDO", "TOWNHOUSE", "MULTI_FAMILY", "MANUFACTURED", "LOT_LAND", "APARTMENT" ], "type": "string", "description": "Keep only one Zillow property category, or leave Any selected.", "default": "ANY" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Keep properties priced at or above this amount." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Keep properties priced at or below this amount." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "number", "description": "Minimum number of bedrooms." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "type": "number", "description": "Maximum number of bedrooms." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "type": "number", "description": "Minimum number of bathrooms. Decimal values such as 1.5 are supported." }, "maxBathrooms": { "title": "Maximum bathrooms", "minimum": 0, "type": "number", "description": "Maximum number of bathrooms." }, "minLivingArea": { "title": "Minimum living area", "minimum": 0, "type": "number", "description": "Minimum interior living area in square feet." }, "maxLivingArea": { "title": "Maximum living area", "minimum": 0, "type": "number", "description": "Maximum interior living area in square feet." }, "minLotSize": { "title": "Minimum lot size", "minimum": 0, "type": "number", "description": "Minimum lot size in square feet." }, "maxLotSize": { "title": "Maximum lot size", "minimum": 0, "type": "number", "description": "Maximum lot size in square feet." }, "minYearBuilt": { "title": "Oldest build year", "minimum": 1700, "maximum": 2100, "type": "integer", "description": "Oldest construction year to keep. Missing years are enriched from property details when this filter is active." }, "maxYearBuilt": { "title": "Newest build year", "minimum": 1700, "maximum": 2100, "type": "integer", "description": "Newest construction year to keep." }, "hoaStatus": { "title": "๐Ÿ˜๏ธ HOA preference", "enum": [ "ANY", "WITH_HOA", "NO_HOA" ], "type": "string", "description": "Include every property, only properties with a positive monthly HOA fee, or properties with no reported HOA fee.", "default": "ANY" }, "minHoaFee": { "title": "Minimum monthly HOA fee", "minimum": 0, "type": "number", "description": "Minimum reported monthly HOA fee. Properties with missing HOA values are excluded while this range is active." }, "maxHoaFee": { "title": "Maximum monthly HOA fee", "minimum": 0, "type": "number", "description": "Maximum reported monthly HOA fee." }, "minDaysOnZillow": { "title": "Minimum days on Zillow", "minimum": 0, "type": "integer", "description": "Keep listings visible on Zillow for at least this many days." }, "maxDaysOnZillow": { "title": "Maximum days on Zillow", "minimum": 0, "type": "integer", "description": "Keep listings visible on Zillow for no more than this many days." }, "onlyWithPhotos": { "title": "๐Ÿ“ธ Require listing photos", "type": "boolean", "description": "Exclude properties without a listing image or photo collection.", "default": false }, "onlyOpenHouses": { "title": "๐Ÿšช Require an open house", "type": "boolean", "description": "Keep only listings currently advertising an open house.", "default": false }, "onlyPriceReductions": { "title": "๐Ÿ“‰ Require a price reduction", "type": "boolean", "description": "Keep only listings with a detected price cut.", "default": false }, "sortBy": { "title": "โ†•๏ธ Sort saved results by", "enum": [ "RELEVANCE", "PRICE_ASC", "PRICE_DESC", "BEDROOMS_DESC", "BATHROOMS_DESC", "LIVING_AREA_DESC", "LOT_SIZE_DESC", "YEAR_BUILT_DESC", "NEWEST", "PRICE_REDUCTION_DESC" ], "type": "string", "description": "Results are deduplicated and filtered first, then the entire result set is sorted before the maximum result limit is applied.", "default": "RELEVANCE" }, "monitorKey": { "title": "๐Ÿ”‘ Monitor name", "type": "string", "description": "A stable name for this monitor, for example austin-family-homes. Leave empty to derive it automatically from the search and filters.", "default": "" }, "resetMonitor": { "title": "โ™ป๏ธ Replace the saved snapshot", "type": "boolean", "description": "Start a fresh baseline for this monitor. This run stores the current properties and returns no change rows.", "default": false }, "maxConcurrency": { "title": "โšก Parallel requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "Number of requests processed at the same time. The default balances speed and reliability.", "default": 5 }, "maxRetries": { "title": "๐Ÿ” General retry attempts", "minimum": 0, "maximum": 15, "type": "integer", "description": "Retry budget for temporary source errors and incomplete responses.", "default": 5 }, "maxProxyRetries": { "title": "๐ŸŒ Connection retry attempts", "minimum": 1, "maximum": 15, "type": "integer", "description": "Separate retry budget for temporary connection failures.", "default": 5 }, "maxCaptchaRetries": { "title": "๐Ÿ›ก๏ธ Access retry attempts", "minimum": 1, "maximum": 15, "type": "integer", "description": "Separate retry budget when Zillow temporarily interrupts access.", "default": 5 }, "proxy": { "title": "๐ŸŒŽ Connection settings", "type": "object", "description": "US residential access is preconfigured and recommended because Zillow data is region-sensitive. The default is ready to use.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "rawOutput": { "title": "๐Ÿงพ Include raw source payload", "type": "boolean", "description": "Add the original gdpClientCache payload under _raw in Detail and Search + details outputs. Most users should leave this disabled.", "default": false } } }, "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 } } } } } } } } } }