{ "openapi": "3.0.1", "info": { "title": "🏡 Zillow Detail Scraper", "description": "Extract detailed property data from Zillow listings, including price, address, photos, bedrooms, bathrooms, square footage, Zestimate, property features, agent details, and more. Perfect for real estate research, lead generation, market analysis, and data collection.", "version": "0.2", "x-build-id": "GPPzstKni9TlPMmPe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~zillow-detail-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-zillow-detail-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/scrapier~zillow-detail-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-zillow-detail-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/scrapier~zillow-detail-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-zillow-detail-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": { "startUrls": { "title": "🔗 Zillow Detail URLs", "type": "array", "description": "Zillow detail URLs — homes (`/homedetails/.../12345_zpid/`), apartments (`/apartments/...`), buildings (`/b/...`) or communities (`/community/...`). Bulk input supported — add as many as you like.", "items": { "type": "string" } }, "addresses": { "title": "📍 Addresses", "type": "array", "description": "Free-form street addresses to scrape, e.g. `123 Main St, City, State`. Each one is resolved to its Zillow detail page automatically.", "items": { "type": "string" } }, "propertyStatus": { "title": "🏷️ Listing status (for Start URLs)", "enum": [ "FOR_SALE", "RECENTLY_SOLD", "FOR_RENT" ], "type": "string", "description": "Zillow fetches for-sale, sold and for-rent listings differently. Pick the status of your URLs to speed things up. If it's wrong, the Actor still figures out the right one — it just costs an extra request.", "default": "RECENTLY_SOLD" }, "extractBuildingUnits": { "title": "🏢 Extract individual units from building pages", "enum": [ "disabled", "all", "for_sale", "recently_sold", "for_rent", "off_market" ], "type": "string", "description": "For building / apartment URLs (e.g. `/b/...`), also emit each individual unit as its own record instead of just the building summary.", "default": "disabled" }, "searchResultsDatasetId": { "title": "🗃️ Dataset with search-scraper results", "type": "string", "description": "Optional. Pick a dataset produced by a Zillow search/ZIP scraper — the Actor reads its `detailUrl` / `hdpUrl` / `url` rows and scrapes full details for each." }, "proxyConfiguration": { "title": "🛡️ Proxy", "type": "object", "description": "Optional Apify Proxy configuration used as the mid-tier (datacenter) network. Residential is applied automatically as the final fallback." } } }, "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 } } }, "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 } } } } } } } } } }