{ "openapi": "3.0.1", "info": { "title": "Zillow Property Details Scraper API: ZPID, URL & Address", "description": "Zillow detail scraper and Zillow property details API: Zestimate and range, rent Zestimate, tax value, price, last sale, facts, agent, broker and photos for any Zillow link, zpid or street address, in bulk. Zillow lookup by address or Zillow URL; no login; Zillow MCP. $2 per 1,000 homes.", "version": "0.1", "x-build-id": "lUZtZt784RyUBdXr6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sauliusautomatesit~zillow-property-details-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sauliusautomatesit-zillow-property-details-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-property-details-api/runs": { "post": { "operationId": "runs-sync-sauliusautomatesit-zillow-property-details-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-property-details-api/run-sync": { "post": { "operationId": "run-sync-sauliusautomatesit-zillow-property-details-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": { "startUrls": { "title": "Zillow home links", "type": "array", "description": "Zillow property pages, one per line, for example `https://www.zillow.com/homedetails/2114-Bigelow-Ave-N-Seattle-WA-98109/48749425_zpid/`. A Zillow search link works too: every home it finds comes back with full details (up to `Max homes per search link`). An apartment building link (`/apartments/austin-tx/the-goodwin-apartments/CkQ7wm/` or `/b/...`) gives one row per unit with its rent, beds, baths and size (up to `Max units per building`).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "addresses": { "title": "Street addresses", "type": "array", "description": "US street addresses, one per line, as you would type them in Zillow's search box: `18 Zelma Dr, Greenville, SC 29617`. Addresses copied from Google Maps, a CRM or county records work as they are (\", USA\", ZIP+4, `#3L`, `Apt 3L`, `Unit 3L`). Each is matched to its Zillow home; the row says which address Zillow matched and whether house number and unit are an exact match.", "items": { "type": "string" } }, "zpids": { "title": "Zpids", "type": "array", "description": "Zillow property ids, one per line, for example `48749425` (the number before `_zpid` in a Zillow link).", "items": { "type": "string" } }, "searchResultsDatasetId": { "title": "Homes from a dataset", "type": "string", "description": "A dataset from an earlier run in your account whose rows carry `zpid` or `url`, for example the output of a Zillow search scraper. Every home in it is looked up in full." }, "maxDatasetItems": { "title": "Max homes from the dataset", "minimum": 1, "maximum": 100000, "type": "integer", "description": "At most this many rows are read from the dataset above.", "default": 10000 }, "maxResultsPerSearch": { "title": "Max homes per search link", "minimum": 1, "maximum": 20000, "type": "integer", "description": "For Zillow search links in `Zillow home links`: how many of the homes found are looked up in full.", "default": 100 }, "maxUnitsPerBuilding": { "title": "Max units per building", "minimum": 0, "maximum": 10000, "type": "integer", "description": "For apartment building links in `Zillow home links`: at most this many units per building, each charged as one home. 0 for every unit the building lists.", "default": 0 }, "includeHistory": { "title": "Price history, tax history and schools", "type": "boolean", "description": "On by default: each home also gets its 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. No extra charge. Turn off for slightly faster runs. If Zillow refuses the extra request the row is still delivered, with `historyError` set.", "default": true }, "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 } } } } } } } } } }