{ "openapi": "3.0.1", "info": { "title": "Zillow Property Scraper", "description": "(Cheap rate) Just input location, bedrooms, price range & property type to scrape bulk Zillow listings. Outputs complete property data: prices, floor plans, amenities, photos, videos, Walk Score & more. โค๏ธZillow Property Scraperโค๏ธ.", "version": "0.0", "x-build-id": "3Cw6sugAIkVYLBOpr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codenest~zillow-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codenest-zillow-property-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/codenest~zillow-property-scraper/runs": { "post": { "operationId": "runs-sync-codenest-zillow-property-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/codenest~zillow-property-scraper/run-sync": { "post": { "operationId": "run-sync-codenest-zillow-property-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": { "location": { "title": "๐Ÿ“ Location (City / State / ZIP)", "type": "string", "description": "Enter city, state, or ZIP code in plain text. Examples: 'New York', 'Los Angeles CA', 'Chicago Illinois', '90210'. This will be included in the Google search query to find the matching Zillow URL automatically.", "default": "" }, "propertyType": { "title": "๐Ÿ  Property Type", "enum": [ "", "apartment", "house", "condo", "townhouse", "multi-family", "land", "mobile" ], "type": "string", "description": "Type of property to search for. The selected value is added to the Google search query automatically.", "default": "" }, "listingType": { "title": "๐Ÿ”– Listing Type", "enum": [ "", "rent", "buy", "sold" ], "type": "string", "description": "Whether to search for rentals or properties for sale. Added to the Google search query automatically.", "default": "" }, "bedrooms": { "title": "๐Ÿ› Number of Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Filter by number of bedrooms. Set to 0 for no bedroom filter. Example: 2 adds '2 bedrooms' to the Google search query.", "default": 0 }, "minPrice": { "title": "๐Ÿ’ฐ Minimum Price ($)", "minimum": 0, "type": "integer", "description": "Minimum price in USD. Set to 0 for no minimum. When set, adds price context to the Google search query.", "default": 0 }, "maxPrice": { "title": "๐Ÿ’ฐ Maximum Price ($)", "minimum": 0, "type": "integer", "description": "Maximum price in USD. Set to 0 for no maximum. When set, adds price context to the Google search query. Example: 3000 = under $3,000.", "default": 0 }, "extraKeywords": { "title": "๐Ÿ”Ž Extra Keywords (Optional)", "type": "array", "description": "Any additional search terms to include in the Google query. For example: 'open house', 'pool', 'garage', 'pet friendly'. Each entry is a separate keyword.", "items": { "type": "string" }, "default": [] }, "urls": { "title": "๐Ÿ”— Direct Zillow URLs (Optional)", "type": "array", "description": "Optionally enter direct Zillow property or search/category URLs to scrape. If filled, these are scraped in addition to any keyword-based search results. Leave empty when using the keyword fields above.", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Maximum Scraped Items Limit (Per URL)", "minimum": 1, "type": "integer", "description": "Maximum properties to scrape per search URL (e.g. 10, 50, 100). Default is 50.", "default": 50 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of Zillow pages to scrape in parallel. Lower values are safer against blocks. Default is 3.", "default": 3 }, "minDelayMs": { "title": "Minimum Delay (ms)", "minimum": 200, "type": "integer", "description": "Minimum random delay in milliseconds between requests. Default is 1000ms.", "default": 1000 }, "maxDelayMs": { "title": "Maximum Delay (ms)", "minimum": 500, "type": "integer", "description": "Maximum random delay in milliseconds between requests. Default is 3000ms.", "default": 3000 } } }, "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 } } } } } } } } } }