{ "openapi": "3.0.1", "info": { "title": "Zillow Agent & Team Leads Scraper โ€” Contact & Sales Data", "description": "Scrape US real estate agent & team leads from zillow.com โ€” name, phone, email, rating, review count, sales history, and active listings per agent, with incremental tracking across runs.", "version": "0.1", "x-build-id": "mvDgGzyxvGRnml19m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~zillow-agent-leads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-zillow-agent-leads-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/blackfalcondata~zillow-agent-leads-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-zillow-agent-leads-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/blackfalcondata~zillow-agent-leads-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-zillow-agent-leads-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": { "agentLocations": { "title": "๐Ÿ“ Agent Locations", "type": "array", "description": "One or more locations to search for real estate agents: \"City, ST\" (e.g. \"Austin, TX\") or a ZIP code. Each is searched independently. Leave empty if you only use Start URLs.", "items": { "type": "string" } }, "startUrls": { "title": "๐Ÿ”— Start URLs", "type": "array", "description": "Paste zillow.com agent profile URLs directly, or an agent-directory URL for a city. Profile URLs are fetched directly; directory URLs are scanned for all agents listed.", "items": { "type": "string" } }, "maxResults": { "title": "๐Ÿ’ฏ Max Results", "minimum": 0, "type": "integer", "description": "Maximum number of agents to return (0 = full coverage for the given location(s)).", "default": 50 }, "minRating": { "title": "โญ Min Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only include agents whose average rating is at least this value (0-5). Agents with no rating yet are excluded when this is set." }, "minSales": { "title": "๐Ÿ’ฐ Min Total Sales", "minimum": 0, "type": "integer", "description": "Only include agents with at least this many total sales, as reported on their own Zillow profile." }, "minReviews": { "title": "๐Ÿ“ Min Review Count", "minimum": 0, "type": "integer", "description": "Only include agents with at least this many reviews on their profile." }, "excludeEmptyFields": { "title": "๐Ÿงน Exclude Empty Fields", "type": "boolean", "description": "Drop null / empty-string / empty-array fields from each record.", "default": false }, "compact": { "title": "๐Ÿ“ฆ Compact Output", "type": "boolean", "description": "Output only core lead fields โ€” name, business, phone, email, rating, reviews, sales, and profile URL (for AI-agent / MCP workflows).", "default": false }, "incrementalMode": { "title": "โ™ป๏ธ Incremental Mode", "type": "boolean", "description": "Track new/changed/expired agents across runs. Requires a State Key.", "default": false }, "stateKey": { "title": "๐Ÿ”‘ State Key", "type": "string", "description": "Stable identifier for this tracking universe (e.g. \"austin-tx-agents\")." }, "emitUnchanged": { "title": "โ™ป๏ธ Emit Unchanged Records", "type": "boolean", "description": "When incremental, also emit agents that have not changed since the last run.", "default": false }, "emitExpired": { "title": "โšฐ๏ธ Emit Expired Records", "type": "boolean", "description": "When incremental, also emit agents no longer found in the tracked location (e.g. profile removed or deactivated). These markers are always included so change tracking stays complete โ€” they are not subject to Max Results.", "default": false }, "telegramToken": { "title": "๐Ÿ”‘ Telegram Bot Token", "type": "string", "description": "Telegram bot token (from @BotFather). Required for Telegram notifications." }, "telegramChatId": { "title": "๐Ÿ’ฌ Telegram Chat ID", "type": "string", "description": "Telegram chat or channel ID where alerts are sent." }, "discordWebhookUrl": { "title": "๐ŸŽฎ Discord Webhook URL", "type": "string", "description": "Discord incoming webhook URL." }, "slackWebhookUrl": { "title": "๐Ÿ’ผ Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL." }, "whatsappPhoneNumberId": { "title": "๐Ÿ“ฑ WhatsApp Phone Number ID", "type": "string", "description": "WhatsApp Business phone number ID from Meta Business Manager." }, "whatsappAccessToken": { "title": "๐Ÿ” WhatsApp Access Token", "type": "string", "description": "Meta Cloud API access token with whatsapp_business_messaging scope." }, "whatsappTo": { "title": "๐Ÿ“จ WhatsApp Recipient", "type": "string", "description": "Recipient phone number in E.164 format (e.g. +14155551234)." }, "webhookUrl": { "title": "๐Ÿช Generic Webhook URL", "type": "string", "description": "Universal escape hatch for n8n / Make / Zapier / custom HTTP backends. Receives a JSON POST per run." }, "webhookHeaders": { "title": "๐Ÿช Webhook Headers (optional)", "type": "object", "description": "Additional HTTP headers sent with the generic webhook POST." }, "notificationLimit": { "title": "๐Ÿ“Š Max Agents Per Notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of agents included in each notification message (1โ€“20).", "default": 5 }, "notifyOnlyChanges": { "title": "๐Ÿ”„ Notify Only New/Updated", "type": "boolean", "description": "When Incremental Mode is on, only notify for NEW and UPDATED agents.", "default": false }, "appConnector": { "title": "๐Ÿ“ค Send results to a connected app", "type": "string", "description": "Optional. Pick a connected app under Settings โ†’ API & Integrations to receive your results (including contact details where available). A run-summary is written to the connected app; support is best-effort as Apify expands its connector catalog." }, "mcpIssueTeam": { "title": "๐Ÿท๏ธ Issue tracker team", "type": "string", "description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one." } } }, "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 } } } } } } } } } }