{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper", "description": "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, or XML. Export scraped data, run the scraper via API, schedule and monitor runs, or integrate with other tools.", "version": "0.0", "x-build-id": "5mHhqdaVFaYzyXgM0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eunit~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eunit-zillow-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/eunit~zillow-scraper/runs": { "post": { "operationId": "runs-sync-eunit-zillow-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/eunit~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-eunit-zillow-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", "required": [ "proxyConfiguration" ], "properties": { "search_value": { "title": "Search Query (Optional)", "type": "string", "description": "Enter a city, state, or ZIP code to focus the search (e.g., 'Austin, TX'). Note: Geographic coordinates (lat/long) will override this if provided." }, "search_parameters_section": { "title": "Search Parameters", "type": "object", "description": "Define min/max beds, baths, and price ranges.", "properties": { "min_price": { "title": "Minimum Price ($)", "description": "Minimum Price ($)", "type": "integer", "minimum": 0, "unit": "USD", "editor": "number" }, "max_price": { "title": "Maximum Price ($)", "description": "Maximum Price ($)", "type": "integer", "minimum": 0, "unit": "USD", "editor": "number" }, "min_beds": { "title": "Minimum Bedrooms", "description": "Minimum Bedrooms", "type": "integer", "minimum": 0, "editor": "number" }, "max_beds": { "title": "Maximum Bedrooms", "description": "Maximum Bedrooms", "type": "integer", "minimum": 0, "editor": "number" }, "min_bathrooms": { "title": "Minimum Bathrooms", "description": "Minimum Bathrooms", "type": "number", "minimum": 0, "editor": "number" }, "max_bathrooms": { "title": "Maximum Bathrooms", "description": "Maximum Bathrooms", "type": "number", "minimum": 0, "editor": "number" }, "is_entire_place": { "title": "Entire Place (Apartment/House)", "description": "Entire Place (Apartment/House)", "type": "boolean" }, "is_room": { "title": "Private Rooms (Roommate listings)", "description": "Private Rooms (Roommate listings)", "type": "boolean" }, "pagination": { "title": "Pagination Page Number", "type": "integer", "description": "Use 1 for initial map data fetch. Higher values generally only affect the list view on Zillow.", "editor": "number" } } }, "geographic_section": { "title": "Geographic Boundary", "required": [ "ne_lat", "ne_long", "sw_lat", "sw_long" ], "type": "object", "description": "Define the map area to scrape using North-East (NE) and South-West (SW) coordinates.", "properties": { "ne_lat": { "description": "North East Latitude", "title": "North East Latitude", "type": "number" }, "ne_long": { "title": "North East Longitude", "description": "North East Longitude", "type": "number" }, "sw_lat": { "title": "South West Latitude", "description": "South West Latitude", "type": "number" }, "sw_long": { "title": "South West Longitude", "description": "South West Longitude", "type": "number" }, "zoom_value": { "title": "Zoom Level", "type": "integer", "description": "Map zoom level (typically between 1 and 20).", "editor": "number" } } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your crawler." } } }, "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 } } } } } } } } } }