{ "openapi": "3.0.1", "info": { "title": "Zillow Real Estate Scraper", "description": "Our free Zillow scraper lets you extract data about properties for sale and rent on Zillow using the Zillow API, but with no daily call limits. Scrape millions of listings and download your data as HTML, JSON, CSV, Excel, XML, and RSS feed.", "version": "0.1", "x-build-id": "AnZUz9O7fA2dlJ2Ur" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/petr_cermak~zillow-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-petr_cermak-zillow-api-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/petr_cermak~zillow-api-scraper/runs": { "post": { "operationId": "runs-sync-petr_cermak-zillow-api-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/petr_cermak~zillow-api-scraper/run-sync": { "post": { "operationId": "run-sync-petr_cermak-zillow-api-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": { "search": { "title": "Search", "type": "string", "description": "Query to search on Zillow.com" }, "type": { "title": "Type", "enum": [ "all", "sale", "fsbo", "rent", "sold" ], "type": "string", "description": "Property for sale/rent", "default": "all" }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Limit of home detail pages to be scraped", "default": 200 }, "simple": { "title": "Simple results", "type": "boolean", "description": "Return only a subset of possible result attributes.", "default": true }, "startUrls": { "title": "Start URLs", "type": "array", "description": "List of URLs that will be crawled.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "zpids": { "title": "Zillow home IDs", "type": "array", "description": "List of ZPIDs that will be scraped." }, "zipcodes": { "title": "US Zipcodes", "type": "array", "description": "List of zipcodes that will be scraped. Notice that this can take a lot of time to complete!" }, "maxLevel": { "title": "Max zoom level", "minimum": 0, "type": "integer", "description": "Maximum map splitting level. The bigger number is set, the longer the scrape will take", "default": 1 }, "minDate": { "title": "Minimum date", "pattern": "^(\\d{4}-\\d{2}-\\d{2}|(\\d+)\\s?(month|week|day|year|hour|minute)s?|(to|yester)day)$", "type": "string", "description": "Oldest date allowed in results. Can use literal dates, such as YYYY-MM-DD or relative ones, like 3 hours, 1 month, 2 days, today or yesterday" }, "maxDate": { "title": "Maximum date", "pattern": "^(\\d{4}-\\d{2}-\\d{2}|(\\d+)\\s?(month|week|day|year|hour|minute)s?|(to|yester)day)$", "type": "string", "description": "Newest date allowed in results. Can use literal dates, such as YYYY-MM-DD or relative ones, like 3 hours, 1 month, 2 days, today or yesterday" }, "includeRelaxedResults": { "title": "Include more results", "type": "boolean", "description": "Setting this option might give results close but outside to the original city / county / state.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The best option is usually Automatic proxy. But you can also use your own proxies or no proxy", "default": { "useApifyProxy": true } }, "maxRetries": { "title": "Max retries", "type": "integer", "description": "How many retries until the scraper should give up", "default": 6 }, "handlePageTimeoutSecs": { "title": "Timeout seconds", "type": "integer", "description": "Configure the handlePageTimeoutSecs setting", "default": 3600 }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Enable debug log", "default": false }, "extendOutputFunction": { "title": "Extend output function", "type": "string", "description": "Extend the output item to contain more fields. The raw data is present in the 'data' variable." }, "extendScraperFunction": { "title": "Extend Scraper Function", "type": "string", "description": "Advanced function that allows you to extend the default scraper functionality, allowing you to manually perform actions on the page", "default": "" }, "customData": { "title": "Custom data", "type": "object", "description": "Any data that you want to have available inside the Extend Output/Scraper Function", "default": {} }, "rawOutput": { "title": "Raw output", "type": "boolean", "description": "Output the results without any filtering or formatting. It's recommended to leave this option unchecked.", "default": false } } }, "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 } } } } } } } } } }