{ "openapi": "3.0.1", "info": { "title": "Zillow Real-Time Property & Agent Data Scraper", "description": "Scrape Zillow in real time: search any location, get full property details, prices, beds/baths, year built, taxes, schools, and agent contacts — clean, normalized phone numbers and agent IDs. Results stream to your dataset as JSON with webhooks and proxy rotation built in.", "version": "0.0", "x-build-id": "tLINoiOlUcuEDbMA3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~Zillow-Real-Time-Data-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-Zillow-Real-Time-Data-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/b2b_leads~Zillow-Real-Time-Data-Scraper/runs": { "post": { "operationId": "runs-sync-b2b_leads-Zillow-Real-Time-Data-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/b2b_leads~Zillow-Real-Time-Data-Scraper/run-sync": { "post": { "operationId": "run-sync-b2b_leads-Zillow-Real-Time-Data-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": { "enableSearch": { "title": "Search", "type": "boolean", "description": "Find properties across one or more locations (city, state, or ZIP). Enabled by default.", "default": true }, "searchLocations": { "title": "Locations", "type": "array", "description": "Locations to collect properties from, e.g. \"Austin, TX\", \"Beverly Hills, CA\", \"90210\". One row per location.", "default": [], "items": { "type": "string" } }, "searchStatus": { "title": "Listing status", "enum": [ "for_sale", "for_rent", "sold", "pending", "all" ], "type": "string", "description": "Which listings to collect for each location.", "default": "for_sale" }, "searchMaxResults": { "title": "Max results per location", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many properties to collect for each location. Potential total = this value × number of locations, bounded by Max total items below.", "default": 20 }, "searchMinPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only keep properties priced at or above this value. Leave empty for no minimum." }, "searchMaxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only keep properties priced at or below this value. Leave empty for no maximum." }, "searchMinBeds": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Only keep properties with at least this many bedrooms. Leave empty for no minimum." }, "searchMaxBeds": { "title": "Maximum bedrooms", "minimum": 0, "type": "integer", "description": "Only keep properties with at most this many bedrooms. Leave empty for no maximum." }, "searchMinBaths": { "title": "Minimum bathrooms", "minimum": 0, "type": "integer", "description": "Only keep properties with at least this many bathrooms. Leave empty for no minimum." }, "enablePropertyDetails": { "title": "Full property details", "type": "boolean", "description": "Enrich every property with full details: description, taxes, HOA, schools, days on market, features, history, and listing agent. Adds a little extra time per business. On by default.", "default": true }, "enableLeadDetails": { "title": "Enable lead details", "type": "boolean", "description": "Add lead contact details to each property — agent name, phone, email, website, and social profiles when available. Every property is still exported even when no lead details are found (nothing is dropped). Adds a little extra time per business. On by default.", "default": true }, "propertyUrls": { "title": "Property URLs (optional)", "type": "array", "description": "Collect full details for specific property listing URLs. Can be combined with a location search, used on its own, or left empty.", "default": [], "items": { "type": "string" } }, "enableAgentDetails": { "title": "Agent profiles", "type": "boolean", "description": "Collect full agent/realtor profiles from the profile URLs below: contact info, brokerage, license, service areas, social profiles, and recent activity.", "default": false }, "agentUrls": { "title": "Agent profile URLs", "type": "array", "description": "Agent/realtor profile URLs to collect (only used when Agent profiles is enabled).", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max total items", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Global cap on total rows exported in this run, across all features. NOTE: On the Apify free plan this is capped to a small sample (2 results) per run — upgrade to a paid Apify plan to get full, unlimited data. See the README for current free-tier limits.", "default": 10000 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. Every record is always saved to the run's dataset — this webhook is an ADDITIONAL real-time push. When set, each new record is also delivered to this URL (CRM, Slack incoming webhook, Zapier, Make, Google Sheets).", "default": "" }, "webhookFormat": { "title": "Webhook format", "enum": [ "json", "slack" ], "type": "string", "description": "json = full record object; slack = Slack-friendly message payload.", "default": "json" }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "Apify residential proxy (US) is enabled by default for reliable collection. Change here only if you need a different country or custom proxy URLs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }