{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper: Homes for Sale, Rentals & Sold (US)", "description": "Scrape Zillow listings by city, ZIP, neighborhood or search URL: for sale, for rent and recently sold, with price, Zestimate, beds, baths, size, photos and agent. Optional property details: description, facts, year built, HOA, taxes. No result cap: big searches are split by map area.", "version": "0.1", "x-build-id": "tnffkJl7R3WgB8xdX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nextgensda~zillow-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nextgensda-zillow-listings", "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/nextgensda~zillow-listings/runs": { "post": { "operationId": "runs-sync-nextgensda-zillow-listings", "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/nextgensda~zillow-listings/run-sync": { "post": { "operationId": "run-sync-nextgensda-zillow-listings", "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 as you'd type them in Zillow's search box: a city (\"Austin, TX\"), a ZIP code (\"90046\"), a neighborhood (\"Hollywood Hills, Los Angeles, CA\") or a county. The status, sort and filters below apply to these.", "items": { "type": "string" } }, "searchUrls": { "title": "Zillow search URLs", "type": "array", "description": "Zillow search pages, copied from your browser after setting the map and filters (https://www.zillow.com/los-angeles-ca/rentals/?searchQueryState=...). Each URL keeps its own map area, status and filters. A property URL here is scraped as a property.", "items": { "type": "string" } }, "properties": { "title": "Properties", "type": "array", "description": "Property pages (https://www.zillow.com/homedetails/.../19954164_zpid/) or zpids (19954164), always with their details.", "items": { "type": "string" } }, "status": { "title": "Listing status", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "Homes for sale, rentals, or homes sold in the last months. Sold prices are blank in non-disclosure states (Texas, Utah and others).", "default": "for_sale" }, "sort": { "title": "Sort", "enum": [ "relevance", "newest", "price_asc", "price_desc" ], "type": "string", "description": "Order of the results. Searches over 820 results are split by map area, and the order then holds within each area.", "default": "relevance" }, "priceMin": { "title": "Minimum price ($)", "minimum": 0, "type": "integer", "description": "Listing price, or monthly rent for rentals." }, "priceMax": { "title": "Maximum price ($)", "minimum": 0, "type": "integer", "description": "Listing price, or monthly rent for rentals." }, "bedsMin": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "At least this many bedrooms." }, "bathsMin": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "At least this many bathrooms." }, "sqftMin": { "title": "Minimum size (sq ft)", "minimum": 0, "type": "integer", "description": "Living area in square feet, at least." }, "sqftMax": { "title": "Maximum size (sq ft)", "minimum": 0, "type": "integer", "description": "Living area in square feet, at most." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Only these home types (empty: all).", "items": { "type": "string", "enum": [ "house", "townhouse", "multi_family", "condo", "apartment", "lot", "manufactured" ], "enumTitles": [ "Houses", "Townhomes", "Multi-family", "Condos / co-ops", "Apartments", "Lots / land", "Manufactured" ] } }, "includeDetails": { "title": "Include property details", "type": "boolean", "description": "Add each listing's property page: description, year built, facts and features, HOA fee, tax rate, agent and MLS, every photo in full size. Fetches each property separately (slower; charged per listing). Apartment buildings have no property page.", "default": false }, "browserFallback": { "title": "Browser fallback", "type": "boolean", "description": "If Zillow's bot protection (PerimeterX) blocks the run, open Zillow in a real Chrome on a new IP to earn its cookies, then carry on. Needs at least 1 GB of memory (set it in the run options). Off: a block just moves the run to a new IP.", "default": false }, "maxItemsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Per location or search URL.", "default": 200 }, "maxItems": { "title": "Max listings in total", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The run stops after this many listings.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "US residential proxies (the default) are recommended. Custom proxy URLs can be http:// or socks5:// (socks5://user:pass@host:port).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }