{ "openapi": "3.0.1", "info": { "title": "Zillow property listings scraper", "description": "💰 $1.00 per 1000 results ❗Collect Zillow property listings for sale, for rent, or sold with beds, baths, price, and map-area filters. Get one structured dataset record per listing for lead generation, market research, and real-estate analysis.", "version": "0.0", "x-build-id": "hjQer7pmkjjyTmgqg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data_dino~zillow-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data_dino-zillow-listings-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/data_dino~zillow-listings-scraper/runs": { "post": { "operationId": "runs-sync-data_dino-zillow-listings-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/data_dino~zillow-listings-scraper/run-sync": { "post": { "operationId": "run-sync-data_dino-zillow-listings-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": [ "mode" ], "properties": { "mode": { "title": "Listing mode", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "Which Zillow listing group to collect.", "default": "for_sale" }, "searchValue": { "title": "Search location", "type": "string", "description": "City, neighborhood, ZIP, or address search term. Leave empty for a pure map-area search using the bounds below.", "default": "" }, "minBeds": { "title": "Minimum beds", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms.", "default": 1 }, "maxBeds": { "title": "Maximum beds", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms.", "default": 1 }, "maxBathrooms": { "title": "Maximum bathrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bathrooms." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Minimum listing price in USD." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Maximum listing price in USD." }, "isEntirePlace": { "title": "Entire-place rentals only", "type": "boolean", "description": "For for_rent mode: filter for entire-place rentals only.", "default": false }, "isRoom": { "title": "Room rentals only", "type": "boolean", "description": "For for_rent mode: filter for room rentals only.", "default": false }, "neLat": { "title": "North-east latitude bound", "type": "number", "description": "North-east latitude bound of the map-area search.", "default": 38.602951833355434 }, "neLong": { "title": "North-east longitude bound", "type": "number", "description": "North-east longitude bound of the map-area search.", "default": -87.22283859375 }, "swLat": { "title": "South-west latitude bound", "type": "number", "description": "South-west latitude bound of the map-area search.", "default": 23.42674607019482 }, "swLong": { "title": "South-west longitude bound", "type": "number", "description": "South-west longitude bound of the map-area search.", "default": -112.93084640625 }, "zoom": { "title": "Map zoom", "minimum": 1, "maximum": 20, "type": "integer", "description": "Map zoom value used by the Zillow search request. Lower values cover a wider area; Zillow caps map results at 500.", "default": 5 }, "pagination": { "title": "Pagination page", "minimum": 1, "type": "integer", "description": "Which pagination page to request. Map results are limited by Zillow, so prefer adjusting the map area over pagination.", "default": 1 }, "maxResults": { "title": "Maximum records", "minimum": 1, "type": "integer", "description": "Maximum number of listing records to push to the dataset. When empty, every listing returned by Zillow is pushed." }, "proxy": { "title": "HTTP(S) proxy", "type": "string", "description": "Optional proxy URL such as http://user:pass@host:port. When empty, the scraper uses its configured default proxy.", "default": "" } } }, "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 } } } } } } } } } }