{ "openapi": "3.0.1", "info": { "title": "Zillow API: Property Details, Search & Sold Homes", "description": "Zillow scraper and API: property data by address, ZPID or link, plus for sale, for rent and recently sold searches by city, ZIP or Zillow link, past the 820-result limit. Price, Zestimate, beds, baths, sq ft, price and tax history, schools, HOA. No login.", "version": "0.4", "x-build-id": "64rFJ7xMEQcvkGZhv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deepmine~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deepmine-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/deepmine~zillow-scraper/runs": { "post": { "operationId": "runs-sync-deepmine-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/deepmine~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-deepmine-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": { "properties": { "title": "๐Ÿ  Homes to look up (address, ZPID or link)", "type": "array", "description": "One per line: a street address (\"1704 Shelbourne Dr, Austin, TX 78752\"), a Zillow property ID (ZPID, e.g. 29412761) or a Zillow home link. Always with full details. You pay per home found; addresses Zillow doesn't have are listed in the run's OUTPUT and never charged.", "items": { "type": "string", "pattern": "\\S" } }, "locations": { "title": "๐Ÿ“ Locations to search", "type": "array", "description": "A city with its state (\"Austin, TX\"), a ZIP code, a county, a neighborhood, or a Zillow search link copied from your browser (its filters and map area are used as they are). One per line.", "items": { "type": "string", "pattern": "\\S" } }, "listingType": { "title": "๐Ÿท๏ธ Listing type", "enum": [ "forSale", "forRent", "sold" ], "type": "string", "description": "Ignored for Zillow search links (they carry their own).", "default": "forSale" }, "daysOnZillow": { "title": "๐Ÿ“… Listed (or sold) within", "enum": [ "any", "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "For Recently sold: homes sold within this time.", "default": "any" }, "maxResults": { "title": "๐Ÿ”ข Max homes per location", "minimum": 1, "maximum": 100000, "type": "integer", "description": "You pay per home. Past Zillow's 820-result limit the Actor reads the area box by box and returns the newest.", "default": 1000 }, "includeDetails": { "title": "๐Ÿงพ Full details for search results ($)", "type": "boolean", "description": "Also read each home's page: price and tax history, schools, HOA fee, year built, description, listing agent and broker with phones, tours, floor plans, full-size photos (each when Zillow shows it). Costs more per home (see Pricing).", "default": false }, "minPrice": { "title": "๐Ÿ’ต Min price", "minimum": 0, "type": "integer", "description": "For rentals: monthly rent." }, "maxPrice": { "title": "๐Ÿ’ต Max price", "minimum": 0, "type": "integer", "description": "For rentals: monthly rent." }, "minBeds": { "title": "๐Ÿ›๏ธ Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "At least this many bedrooms." }, "minBaths": { "title": "๐Ÿ› Min bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "At least this many bathrooms." }, "homeTypes": { "title": "๐Ÿ˜๏ธ Home types", "type": "array", "description": "Empty = all.", "items": { "type": "string", "enum": [ "house", "townhouse", "condo", "apartment", "multiFamily", "manufactured", "land" ], "enumTitles": [ "Houses", "Townhouses", "Condos / co-ops", "Apartments", "Multi-family", "Manufactured", "Lots / land" ] } }, "includeNearbyHomes": { "title": "๐Ÿ˜๏ธ Nearby and comparable homes", "type": "boolean", "description": "On every home read with full details (lookups, and search results with full details on): adds nearbyHomes (Zillow's \"Nearby homes\" for the page, usually 8) and comparableHomes (the sales its Zestimate compares with). One more request per home, at the full-details price.", "default": false }, "includeSourceFacts": { "title": "๐Ÿ—‚๏ธ Zillow's source records", "type": "boolean", "description": "On every home read with full details: adds resoFacts (Zillow's full facts record, about 80 facts on a listed home), attributionInfo (every agent and office), the price, tax, school and photo records, the Zestimate's range, Zillow's highlights and listing flags, and with nearby homes on isZillowOwned, foreclosure types and a Street View picture. At the full-details price.", "default": false }, "includeZestimateHistory": { "title": "๐Ÿ“‰ Zestimate history", "type": "boolean", "description": "On every home read with full details: adds zestimateHistory, the home's Zestimate month by month over the last 10 years. One more request per home, at the full-details price.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave as is: datacenter IPs, with requests Zillow blocks retried on US residential IPs automatically. Choose RESIDENTIAL to use residential IPs for everything.", "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 } } } } } } } } } }