{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper API: For Sale, Sold, Rentals & Zestimate", "description": "Zillow scraper and Zillow search scraper. Scrape Zillow homes for sale, Zillow rentals and Zillow sold homes by city, ZIP code or search link, with FSBO, foreclosure and auction filters, plus details with Zestimate, tax value and photos by link, zpid or address. Zillow listings API; Zillow MCP.", "version": "0.1", "x-build-id": "jvCcsDjfEwq1SYyIo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sauliusautomatesit~zillow-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sauliusautomatesit-zillow-scraper-api", "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/sauliusautomatesit~zillow-scraper-api/runs": { "post": { "operationId": "runs-sync-sauliusautomatesit-zillow-scraper-api", "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/sauliusautomatesit~zillow-scraper-api/run-sync": { "post": { "operationId": "run-sync-sauliusautomatesit-zillow-scraper-api", "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": "Places to search", "type": "array", "description": "One place per line, as you would type it on Zillow: a city (`Austin, TX`), a ZIP code (`78704`), a neighborhood, a county or a state. Each gives up to `maxResultsPerSearch` homes with the status below.", "items": { "type": "string" } }, "status": { "title": "Homes that are", "enum": [ "forSale", "forRent", "sold" ], "type": "string", "description": "For `Places to search`: `forSale` (default), `forRent` or `sold` (recently sold). Search links keep their own filters.", "default": "forSale" }, "searchUrls": { "title": "Zillow search links", "type": "array", "description": "Searches set up on zillow.com with any filters (price, beds, home type, map area, keywords): copy the link from the address bar, one per line, for example `https://www.zillow.com/austin-tx/` or `https://www.zillow.com/homes/for_rent/`.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max homes per search", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Zillow shows at most about 820 homes per search; above that the map is split into smaller areas automatically, up to all the homes Zillow has.", "default": 100 }, "includeDetails": { "title": "Full details for search results", "type": "boolean", "description": "Opens each home found by a search for the full property row (description, Zestimate range, rent Zestimate, facts, agent, more photos). Charged as a property instead of a listing. Apartment buildings stay listings.", "default": false }, "includeHistory": { "title": "Price history, tax history and schools", "type": "boolean", "description": "Adds each home's full price history (listed, price cuts, pending, sold, with dates and sources), tax history (tax paid and assessed value by year), assigned schools with GreatSchools ratings, up to 10 nearby homes, the parcel id and county FIPS code. One extra request per home on our side, no extra charge: each home is charged as a property. Search results are opened for full details too (charged as a property instead of a listing). If Zillow refuses the extra request the row is still delivered, with `historyError` set.", "default": false }, "maxUnitsPerBuilding": { "title": "Max units per building", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Spend guard for large buildings. 0 = all units.", "default": 0 }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Optional search filter, in dollars. For rentals this is the monthly rent. Applies to places and search links." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Optional, in dollars. For rentals this is the monthly rent." }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional." }, "maxBeds": { "title": "Max bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional." }, "minSqft": { "title": "Min living area (sq ft)", "minimum": 0, "type": "integer", "description": "Optional." }, "maxSqft": { "title": "Max living area (sq ft)", "minimum": 0, "type": "integer", "description": "Optional." }, "minYearBuilt": { "title": "Built in or after", "minimum": 1700, "maximum": 2100, "type": "integer", "description": "Optional year." }, "maxYearBuilt": { "title": "Built in or before", "minimum": 1700, "maximum": 2100, "type": "integer", "description": "Optional year." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Optional. Only these home types; empty means all.", "items": { "type": "string", "enum": [ "house", "townhouse", "condo", "multiFamily", "apartment", "manufactured", "land" ], "enumTitles": [ "Houses", "Townhomes", "Condos", "Multi-family", "Apartments", "Manufactured", "Lots and land" ] } }, "maxDaysOnZillow": { "title": "Listed (or sold) within", "enum": [ "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "Optional. For sold searches this is how recently the home sold." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "priceLow", "priceHigh", "beds", "baths", "size" ], "type": "string", "description": "Optional. Zillow's order for search results; matters when Max homes per search is below the total." }, "listingTypes": { "title": "Listing types", "type": "array", "description": "Optional, for homes for sale. Only these listing types; empty means Zillow's default (all for-sale types). `foreclosed` (bank owned, off market) and `preForeclosure` are off-market homes Zillow shows only when asked. Rows then carry `listingSubTypes` (for example `FSBO`, `foreclosure`, `bankOwned`, `forAuction`).", "items": { "type": "string", "enum": [ "agent", "owner", "newConstruction", "comingSoon", "auction", "foreclosure", "foreclosed", "preForeclosure" ], "enumTitles": [ "By agent", "By owner (FSBO)", "New construction", "Coming soon", "Auctions", "Foreclosures (for sale)", "Foreclosed (off market)", "Pre-foreclosure (off market)" ] } }, "includePending": { "title": "Include pending and under contract", "type": "boolean", "description": "Optional. Adds pending and under-contract homes to for-sale searches, as Zillow's own toggle does." }, "keywords": { "title": "Keywords", "type": "string", "description": "Optional. Zillow's keyword filter on listing text, for example `pool`, `fixer upper` or `ADU`. At most 99 characters." }, "maxHoa": { "title": "Max HOA fee per month", "minimum": 0, "type": "integer", "description": "Optional. As on zillow.com, homes without HOA data are kept." }, "minLotSqft": { "title": "Min lot size (sq ft)", "minimum": 0, "type": "integer", "description": "Optional. One acre is 43,560 sq ft." }, "maxLotSqft": { "title": "Max lot size (sq ft)", "minimum": 0, "type": "integer", "description": "Optional." }, "minParkingSpots": { "title": "Min parking spots", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional." }, "mustHave": { "title": "Must have", "type": "array", "description": "Optional. Only homes with all of these.", "items": { "type": "string", "enum": [ "garage", "pool", "waterfront", "singleStory", "airConditioning", "basement", "cityView", "openHouse" ], "enumTitles": [ "Garage", "Pool", "Waterfront", "Single story", "Air conditioning", "Basement", "City view", "Open house scheduled" ] } }, "properties": { "title": "Properties", "type": "array", "description": "Homes to look up, one per line: a Zillow link (`https://www.zillow.com/homedetails/2114-Bigelow-Ave-N-Seattle-WA-98109/48749425_zpid/`), a zpid (`48749425`) or a street address (`2114 Bigelow Ave N, Seattle, WA 98109`). Each gives one property row with Zestimate.", "items": { "type": "string" } }, "maxPhotos": { "title": "Max photos per home", "minimum": 0, "maximum": 200, "type": "integer", "description": "Photo links per row, largest size. 0 for none.", "default": 10 }, "concurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "Requests to Zillow at once. The default suits most runs.", "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 }, "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 } } } } } } } } } }