{ "openapi": "3.0.1", "info": { "title": "Affordable Zillow Details Scraper (Pay-Per-Result)", "description": "Zillow property details scraper that extracts pricing, features, tax records, and neighborhood data from any listing using URLs, ZPIDs, or addresses, so real estate teams can build datasets without manual lookups.", "version": "0.0", "x-build-id": "s4JRCe9a5mqP3BLj6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kawsar~Affordable-Zillow-Details-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kawsar-Affordable-Zillow-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/kawsar~Affordable-Zillow-Details-Scraper/runs": { "post": { "operationId": "runs-sync-kawsar-Affordable-Zillow-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/kawsar~Affordable-Zillow-Details-Scraper/run-sync": { "post": { "operationId": "run-sync-kawsar-Affordable-Zillow-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": { "property_url": { "title": "Property URLs", "type": "array", "description": "Enter full Zillow property page URLs. Each URL gets parsed automatically to extract the Zillow Property ID (ZPID). Supports standard listing pages, For Sale By Owner pages, and pre-foreclosure URLs. You can paste URLs directly from your browser address bar. Example format: https://www.zillow.com/homedetails/[address]/[zpid]_zpid/", "items": { "type": "string" } }, "zpid": { "title": "Zillow Property IDs (ZPID)", "type": "array", "description": "Enter Zillow Property IDs as numbers. Every property on Zillow has a unique numeric ZPID. You can find it in the URL of any Zillow listing page (the number before _zpid). This is the fastest lookup method since it skips URL parsing and address resolution. Supports bulk input for processing hundreds of properties at once.", "items": { "type": "string" } }, "address": { "title": "Property Addresses", "type": "array", "description": "Enter property addresses in standard US format: Street Address, City, State ZIP. The actor searches Zillow for each address and returns matching property details. Works with most US residential properties including single-family homes, condos, townhouses, and multi-family dwellings. Partial addresses may return multiple matches. For best results, include the full street address with ZIP code.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum properties to process", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Limit the total number of properties the actor will process in a single run. This helps you control costs and avoid accidentally processing a larger batch than intended. Set to 0 or leave empty for no limit (processes all provided inputs).", "default": 100 }, "timeoutSecs": { "title": "Overall timeout (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Maximum total time the actor will run before stopping. If the timeout is reached, results collected so far are still saved to the dataset. Increase this for large batches with hundreds of properties.", "default": 300 }, "requestTimeoutSecs": { "title": "Per-request timeout (seconds)", "minimum": 10, "maximum": 120, "type": "integer", "description": "Maximum time allowed for each individual property lookup. If a single request takes longer than this, the actor skips that property and moves to the next one. Increase if you experience frequent timeouts on slower connections.", "default": 30 } } }, "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 } } } } } } } } } }