{ "openapi": "3.0.1", "info": { "title": "Zillow Property Details Scraper: Address & ZPID Lookup", "description": "Zillow property details scraper and address lookup: paste addresses, ZPIDs, home or building links, or a search run's dataset. One row per home: price, Zestimate, beds, baths, sq ft, price and tax history, schools, agent and broker, photos, plus Zillow's nearby and comparable homes. No login.", "version": "0.1", "x-build-id": "eEZosDg7jFjhTRqUT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deepmine~zillow-property-details-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deepmine-zillow-property-details-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-property-details-scraper/runs": { "post": { "operationId": "runs-sync-deepmine-zillow-property-details-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-property-details-scraper/run-sync": { "post": { "operationId": "run-sync-deepmine-zillow-property-details-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 look up, one per line: a street address (\"1704 Shelbourne Dr, Austin, TX 78752\"), a ZPID (29412761), a Zillow home link, or a building link (…/b/… or …/apartments/…). Addresses Zillow doesn't have are listed in OUTPUT and never charged.", "items": { "type": "string", "pattern": "\\S" } }, "maxProperties": { "title": "💯 Max properties", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Most homes the run returns (building units included). You pay per home returned. Empty = every home you list.", "default": 100 }, "extractBuildingUnits": { "title": "🏢 Building links: units", "enum": [ "disabled", "all", "for_sale", "recently_sold", "for_rent", "off_market" ], "type": "string", "description": "For a building or apartment-community link: the building as one row (units, rents, amenities), or one row per unit with full details, of the kind chosen here.", "default": "disabled" }, "searchResultsDatasetId": { "title": "Dataset of a Zillow search run", "type": "string", "description": "Look up every home in another run's dataset, e.g. a Zillow search or Zillow Scraper run: rows with a zpid, link or address column. Added after the homes above." }, "includeNearbyHomes": { "title": "Include nearby homes", "type": "boolean", "description": "Adds nearbyHomes (Zillow's own \"Nearby homes\" of the page, usually 8) and comparableHomes (the sales its Zestimate compares with). Included in the price.", "default": true }, "includeSourceFacts": { "title": "Include Zillow's records", "type": "boolean", "description": "Adds resoFacts (Zillow's full facts record, ~80 facts on a listed home), attributionInfo (every agent and office), the price history, tax history, school and photo records (per-event price per sq ft and agents, GreatSchools links, every photo size), the Zestimate's range, Zillow's highlights, listing flags, ad targeting facts, nearby cities and ZIP codes, and with nearby homes on isZillowOwned, foreclosureTypes and Zillow's Street View picture, keystoneHomeStatus, specialOffers, and for building links floorPlans and buildingAttributes. Included in the price.", "default": true }, "includeZestimateHistory": { "title": "Include Zestimate history", "type": "boolean", "description": "Adds zestimateHistory: the home's Zestimate month by month over the last 10 years. One more request per home, so runs take a little longer. Included in the price.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave as is: Apify Proxy datacenter IPs, with requests Zillow blocks there retried on US residential IPs automatically. Choose RESIDENTIAL to use residential IPs for everything.", "default": { "useApifyProxy": true } }, "propertyStatus": { "title": "Status of linked homes (API)", "type": "string", "description": "Accepted for compatibility (FOR_SALE, RECENTLY_SOLD or FOR_RENT) and not needed: every home's status is read from Zillow." } } }, "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 } } } } } } } } } }