{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper", "description": "Extract Zillow property data for production real-estate workflows: prices, Zestimates, beds/baths, sqft, tax records, agent info, photos, schools, and price history. Export JSON, CSV, or Excel.", "version": "0.1", "x-build-id": "gZRAMYDfVs46eX2a8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-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/automation-lab~zillow-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-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/automation-lab~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-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", "properties": { "searchUrls": { "title": "Zillow Search URLs", "type": "array", "description": "Zillow search URLs to scrape. Copy any search URL from Zillow (e.g., https://www.zillow.com/san-francisco-ca/).", "items": { "type": "string" } }, "propertyUrls": { "title": "Property URLs", "type": "array", "description": "Direct Zillow property page URLs (e.g., https://www.zillow.com/homedetails/...).", "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Text search queries — city names, ZIP codes, or addresses (e.g., 'San Francisco, CA' or '94102').", "items": { "type": "string" } }, "listingType": { "title": "Listing Type", "enum": [ "for_sale", "for_rent", "sold", "all" ], "type": "string", "description": "Type of listings to search for.", "default": "for_sale" }, "minPrice": { "title": "Min Price ($)", "minimum": 0, "type": "integer", "description": "Minimum listing price in USD." }, "maxPrice": { "title": "Max Price ($)", "minimum": 0, "type": "integer", "description": "Maximum listing price in USD." }, "minBeds": { "title": "Min Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms." }, "minBaths": { "title": "Min Bathrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bathrooms." }, "propertyType": { "title": "Property Type", "enum": [ "all", "house", "condo", "townhouse", "apartment", "land", "multi_family", "manufactured" ], "type": "string", "description": "Filter by property type.", "default": "all" }, "maxListings": { "title": "Max Listings", "minimum": 0, "type": "integer", "description": "Maximum number of listings to scrape. Set 0 for unlimited.", "default": 100 }, "includeDetails": { "title": "Enrich search results with property details", "type": "boolean", "description": "For each unique search result, fetch its property page and merge richer fields such as year built, Zestimates, tax data, price history, schools, agent details, and additional photos. This is opt-in because it increases runtime and residential proxy usage. If enrichment fails, the base search row is still returned and the URL is recorded in failed_urls.", "default": false }, "maxRequestRetries": { "title": "Max Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of retry attempts for failed requests in the Playwright browser phase. Higher values improve success rate against Zillow's anti-bot protection at the cost of more proxy usage. The HTTP-first phase uses a bounded set of fresh proxy identities before the browser starts.", "default": 1 } } }, "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 } } } } } } } } } }