{ "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.2", "x-build-id": "62FyhBvAbZzXjSYH9" }, "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": "๐Ÿ  Properties (address, ZPID or Zillow link)", "type": "array", "description": "Homes to get full details for: a street address (\"1704 Shelbourne Dr, Austin, TX 78752\"), a Zillow property id (ZPID, e.g. 29412761) or a Zillow home link (โ€ฆ/homedetails/โ€ฆ_zpid/). One per line. You pay per property found; addresses Zillow doesn't have are listed in the run's OUTPUT and never charged.", "items": { "type": "string" } }, "locations": { "title": "๐Ÿ“ Locations to search", "type": "array", "description": "Places to search: 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" } }, "listingType": { "title": "๐Ÿท๏ธ Listing type", "enum": [ "forSale", "forRent", "sold" ], "type": "string", "description": "What to search for in each location. Ignored for Zillow search links (they carry their own).", "default": "forSale" }, "maxResults": { "title": "๐Ÿ”ข Max results per location", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Most properties to return per location. You pay per property. Up to 820 come in Zillow's \"Newest\" order; above that the Actor reads the whole area box by box (past Zillow's 820 limit), sorts it newest first and returns the newest.", "default": 1000 }, "includeDetails": { "title": "๐Ÿงพ Include full details for search results", "type": "boolean", "description": "Also read each search result's details: price and tax history, schools, HOA fee, year built, description, the listing agent and broker with their phones, tours and floor plans, full-size photos (each when Zillow shows it). Costs more than a plain search result (see Pricing). Properties you look up always come with details.", "default": false }, "daysOnZillow": { "title": "๐Ÿ“… Listed (or sold) within", "enum": [ "any", "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "Only listings newer than this; for \"Recently sold\", only homes sold within this time.", "default": "any" }, "minPrice": { "title": "Min price (USD)", "minimum": 0, "type": "integer", "description": "For rentals: monthly rent." }, "maxPrice": { "title": "Max price (USD)", "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": "Only these home types. 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" ] } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy datacenter IPs by default; requests Zillow blocks there are 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 } } } } } } } } } }