{ "openapi": "3.0.1", "info": { "title": "๐Ÿ  Zillow Agents Finder", "description": "Extract real estate agents and mortgage lenders from Zillow at scale โ€” by URL, screen name, or location-based directory search.", "version": "0.1", "x-build-id": "lQpP7cXAuHrbZTPqm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraperx~zillow-agents-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraperx-zillow-agents-finder", "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/scraperx~zillow-agents-finder/runs": { "post": { "operationId": "runs-sync-scraperx-zillow-agents-finder", "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/scraperx~zillow-agents-finder/run-sync": { "post": { "operationId": "run-sync-scraperx-zillow-agents-finder", "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": { "urls": { "title": "๐Ÿ”— URLs / Screen Names / Agent Names (bulk)", "uniqueItems": true, "type": "array", "description": "Bulk input โ€” each item can be:\nโ€ข Full profile URL โ€” `https://www.zillow.com/profile/REMAX EDGE`\nโ€ข Profile sub-tab URL โ€” `https://www.zillow.com/profile//sales|rentals|sold|reviews`\nโ€ข Screen name with `@` prefix โ€” `@REMAX EDGE` (optionally `@REMAX EDGE/reviews`)\nโ€ข Agent or lender name (free text) โ€” runs a directory search\n\nLeave empty to run a pure location-based crawl.", "items": { "type": "string" } }, "operation": { "title": "๐Ÿ“‹ Operation", "enum": [ "agents", "lenders" ], "type": "string", "description": "Which Zillow directory to target.", "default": "agents" }, "location": { "title": "๐Ÿ“ Location", "type": "string", "description": "City / state used as the geo seed for every directory search (e.g. `New York`, `Los Angeles, CA`). Required unless every URL entry is a direct profile URL or `@screenName`.", "default": "New York" }, "limit": { "title": "๐Ÿ”ข Max Records", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Maximum number of profiles returned across all queries. Set `0` for unlimited.", "default": 20 }, "agent_detail_info": { "title": "๐Ÿงพ Full Agent Detail", "type": "boolean", "description": "When โœ… โ€” return the full agent profile (sales stats, licenses, service areas, address, phones, email, โ€ฆ). When โŒ โ€” return the compact card shape (id, name, screenName, url, avatar, business, location, phone, rating, reviews.count).", "default": false }, "specialty": { "title": "๐ŸŽฏ Specialty Filter", "enum": [ "", "first-time-home-buyers", "foreclosure", "investment-properties", "lot-or-land", "luxury-homes", "military-or-veterans", "new-construction", "property-management", "relocation", "rentals", "senior-communities", "vacation-short-term-rentals" ], "type": "string", "description": "Single specialty filter for the agents directory. Accepts a numeric code or a Zillow slug.", "default": "" }, "language": { "title": "๐Ÿ—ฃ๏ธ Language Filter", "enum": [ "", "english", "arabic", "bengali", "cantonese", "farsi", "french", "german", "greek", "hebrew", "hindi", "hungarian", "italian", "japanese", "korean", "mandarin", "polish", "portuguese", "russian", "spanish", "filipino", "thai", "turkish", "vietnamese" ], "type": "string", "description": "Single language filter (display name).", "default": "" }, "is_top_agent": { "title": "โญ Top Agents only", "type": "boolean", "description": "Filter to Zillow-flagged top agents (agents only).", "default": false }, "is_buying": { "title": "๐Ÿ›’ Specializes in buying", "type": "boolean", "description": "Filter to agents who focus on buyers (agents only).", "default": false }, "is_selling": { "title": "๐Ÿ’ธ Specializes in selling", "type": "boolean", "description": "Filter to agents who focus on sellers (agents only).", "default": false }, "sort_lenders": { "title": "๐Ÿ“Š Lender Sort Order", "enum": [ "relevance", "location", "rating" ], "type": "string", "description": "Sort order for the lender directory (lenders only).", "default": "relevance" }, "lender_fields": { "title": "๐Ÿงฎ Lender Field Allowlist", "uniqueItems": true, "type": "array", "description": "Pick which fields to keep on each lender record. Leave empty to return every field. Values map to keys on Zillow's lender profile (`displayUser`) payload.", "items": { "type": "string", "enum": [ "aboutMe", "address", "cellPhone", "companyName", "confirmedReviews", "contactLenderFormDisclaimer", "employerMemberFDIC", "employerScreenName", "equalHousingLogo", "faxPhone", "hideCellPhone", "individualName", "languagesSpoken", "memberFDIC", "nmlsType", "officePhone", "rating", "recentReviews", "stateLicenses", "stateSponsorships", "title", "totalReviews" ] } }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "By default the actor sends requests **without a proxy**. If Zillow blocks the request, the actor automatically falls back to **Apify datacenter** โ†’ **Apify residential** (with 3 retries on residential). Override here to force a specific group.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }