{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper API: Property, Search & Zestimate", "description": "Zillow scraper API: get Zillow property data by URL, zpid, search URL or location, and export search results to JSON, CSV or Excel. Price, Zestimate, rent Zestimate, beds, baths, sqft, lot, year built, price history, photos, MLS and broker. For sale, rent and sold.", "version": "0.1", "x-build-id": "hEwXRCtrmT3JawoyL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/morgan-studio~zillow-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-morgan-studio-zillow-property-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/morgan-studio~zillow-property-scraper/runs": { "post": { "operationId": "runs-sync-morgan-studio-zillow-property-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/morgan-studio~zillow-property-scraper/run-sync": { "post": { "operationId": "run-sync-morgan-studio-zillow-property-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": { "propertyUrls": { "title": "Property URLs or zpids", "type": "array", "description": "One property per line: a Zillow property URL (https://www.zillow.com/homedetails/.../12345678_zpid/) or the bare zpid number. Each returns a full property record. Duplicates are skipped.", "items": { "type": "string" } }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Zillow search result URLs, one per line, copied from your browser with any filters you set there (price, beds, home type, for rent, sold). Pages are followed until Max results per search.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Places to search, one per line: a city and state (Phoenix, AZ), a ZIP code (85032), a county or a neighborhood as Zillow names it. Uses the Listing type below.", "items": { "type": "string" } }, "listingType": { "title": "Listing type (for Locations)", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "Which listings a Location searches: homes for sale, rentals, or recently sold. Search URLs keep their own filters.", "default": "for_sale" }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many listings to take from each search URL or location (1 to 1000). Zillow shows about 41 listings per page and at most about 20 pages per search; narrow the search (ZIP, price band) to go deeper.", "default": 100 }, "fetchDetails": { "title": "Fetch full property details for search results", "type": "boolean", "description": "Off: each search result is a listing card (price, address, beds, baths, sqft, Zestimate, days on Zillow), charged as a search result. On: the actor opens every result's property page and returns the full property record instead, charged as a property.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Property pages fetched in parallel (1 to 10). The default is gentle and reliable.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Pages are fetched directly first. If Zillow answers with a bot check, the actor retries through Apify Proxy on fresh sessions. Keep Apify Proxy on for reliable runs.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }