{ "openapi": "3.0.1", "info": { "title": "Zillow Data", "description": "Zillow Data API provides real-time access to Zillow property listings, detailed home info, price history, tax records, high-resolution images, and transportation scores. Perfect for real estate apps, property analysis, market research, and investment dashboards.", "version": "0.0", "x-build-id": "8e5mgmhZsk6ISfW5a" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coder_zoro~zillow-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coder_zoro-zillow-data", "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/coder_zoro~zillow-data/runs": { "post": { "operationId": "runs-sync-coder_zoro-zillow-data", "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/coder_zoro~zillow-data/run-sync": { "post": { "operationId": "run-sync-coder_zoro-zillow-data", "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", "required": [ "data_type" ], "properties": { "data_type": { "title": "Data Type", "enum": [ "propertyDetail", "propertyImages", "priceAndtaxHistory", "transportScore", "propertyList", "searchByUrl", "find_details", "find_search", "find_ActiveListings", "find_RentalListings", "find_SoldListings", "find_reviews" ], "type": "string", "description": "Which endpoint to call. Determines which input field below is used." }, "zpid_list": { "title": "ZPID(s)", "type": "array", "description": "Property ZPIDs, one per line. Used by: propertyDetail, propertyImages, priceAndtaxHistory, transportScore.", "items": { "type": "string" } }, "property_url_list": { "title": "Property URL(s)", "type": "array", "description": "Full Zillow homedetails URLs (…/NNNNNN_zpid/), one per line. Alternative to ZPID for: propertyDetail, propertyImages, priceAndtaxHistory.", "items": { "type": "string" } }, "address_list": { "title": "Address(es)", "type": "array", "description": "Street addresses, one per line. Used by: propertyDetail (resolved to a ZPID via search).", "items": { "type": "string" } }, "url_list": { "title": "Search Page URL(s)", "type": "array", "description": "Zillow search-results / region URLs, one per line. Used by: propertyList, searchByUrl.", "items": { "type": "string" } }, "zuid_list": { "title": "Agent ZUID(s)", "type": "array", "description": "Agent encoded ZUIDs, one per line. Used by: find_ActiveListings, find_RentalListings, find_SoldListings, find_reviews.", "items": { "type": "string" } }, "username_list": { "title": "Agent Username(s)", "type": "array", "description": "Zillow profile usernames (…/profile/USERNAME), one per line. Used by: find_details.", "items": { "type": "string" } }, "name_list": { "title": "Agent Name(s)", "type": "array", "description": "Agent names to search for, one per line. Used by: find_search.", "items": { "type": "string" } }, "location": { "title": "Location (agent search)", "type": "string", "description": "Optional location slug for find_search, e.g. 'los-angeles-ca'." }, "page_number": { "title": "Page Number", "minimum": 1, "type": "integer", "description": "Page for paginated agent endpoints (find_* listings/reviews/search).", "default": 1 }, "countOfPrice": { "title": "Count of Price Entries", "minimum": 1, "type": "integer", "description": "Number of price-history records to keep (priceAndtaxHistory).", "default": 10 }, "countOfTax": { "title": "Count of Tax Entries", "minimum": 1, "type": "integer", "description": "Number of tax-history records to keep (priceAndtaxHistory).", "default": 10 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many requests to run in parallel against the API.", "default": 5 } } }, "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 } } } } } } } } } }