{ "openapi": "3.0.1", "info": { "title": "Zillow Agents", "description": "The Zillow Agent Scraper helps you extract comprehensive agent data including sales stats, reviews, ratings, contact details, licenses, service areas, and more – all in one place", "version": "0.0", "x-build-id": "GnsZrWuH5hnQI348q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraptivo~zillow-agents/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraptivo-zillow-agents", "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/scraptivo~zillow-agents/runs": { "post": { "operationId": "runs-sync-scraptivo-zillow-agents", "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/scraptivo~zillow-agents/run-sync": { "post": { "operationId": "run-sync-scraptivo-zillow-agents", "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", "required": [ "search_keywords" ], "properties": { "search_keywords": { "title": "City, Neighborhood, or ZIP codes", "type": "array", "description": "City, Neighborhood, or ZIP code" }, "max_agents": { "title": "Maximum Agents to Scrape", "type": "integer", "description": "Maximum number of agents to scrape", "default": 100 }, "detailed_profiles": { "title": "Detailed Profiles", "type": "boolean", "description": "Fetch detailed profile information for each agent", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxy groups or use your custom proxies", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "buying": { "title": "Is Buying", "type": "boolean", "description": "Is the Agent Buying", "default": false }, "selling": { "title": "Is Selling", "type": "boolean", "description": "Is the Agent Selling", "default": false }, "top_agent": { "title": "Is Top Agent", "type": "boolean", "description": "Top Agent", "default": false }, "min_price": { "title": "Minimum Price", "type": "integer", "description": "Minimum price filter" }, "max_price": { "title": "Maximum Price", "type": "integer", "description": "Maximum price filter" }, "first_time_home_buyers": { "title": "First Time Home Buyers", "type": "boolean", "description": "Specializing in helping first-time home buyers navigate the purchasing process.", "default": false }, "investment_properties": { "title": "Investment Properties", "type": "boolean", "description": "Specializing in investment properties and rental income opportunities.", "default": false }, "rentals": { "title": "Rentals", "type": "boolean", "description": "Expertise in rental properties and landlord-tenant relationships.", "default": false }, "military_veterans": { "title": "Military Veterans", "type": "boolean", "description": "Specialized services for military personnel and veterans, including VA loans.", "default": false }, "luxury_homes": { "title": "Luxury Homes", "type": "boolean", "description": "Experience with high-end and luxury real estate transactions.", "default": false }, "new_construction": { "title": "New Construction", "type": "boolean", "description": "Expertise in newly built homes and construction processes.", "default": false }, "property_management": { "title": "Property Management", "type": "boolean", "description": "Services related to managing rental properties and tenant relations.", "default": false }, "senior_communities": { "title": "Senior Communities", "type": "boolean", "description": "Specializing in senior living communities and age-restricted housing.", "default": false }, "relocation": { "title": "Relocation", "type": "boolean", "description": "Assistance with corporate relocations and long-distance moves.", "default": false }, "foreclosure": { "title": "Foreclosure", "type": "boolean", "description": "Experience with foreclosed properties and distressed sales.", "default": false }, "lot_land": { "title": "Lot/Land", "type": "boolean", "description": "Expertise in vacant land and lot sales for development or building.", "default": false }, "vacation_short_term_rentals": { "title": "Vacation/Short Term Rentals", "type": "boolean", "description": "Specializing in vacation homes and short-term rental properties.", "default": false }, "arabic": { "title": "Arabic", "type": "boolean", "description": "Agents who speak Arabic and can assist Arabic-speaking clients.", "default": false }, "bengali": { "title": "Bengali", "type": "boolean", "description": "Agents who speak Bengali and can assist Bengali-speaking clients.", "default": false }, "cantonese": { "title": "Cantonese", "type": "boolean", "description": "Agents who speak Cantonese and can assist Cantonese-speaking clients.", "default": false }, "farsi": { "title": "Farsi", "type": "boolean", "description": "Agents who speak Farsi (Persian) and can assist Farsi-speaking clients.", "default": false }, "french": { "title": "French", "type": "boolean", "description": "Agents who speak French and can assist French-speaking clients.", "default": false }, "german": { "title": "German", "type": "boolean", "description": "Agents who speak German and can assist German-speaking clients.", "default": false }, "greek": { "title": "Greek", "type": "boolean", "description": "Agents who speak Greek and can assist Greek-speaking clients.", "default": false }, "hebrew": { "title": "Hebrew", "type": "boolean", "description": "Agents who speak Hebrew and can assist Hebrew-speaking clients.", "default": false }, "hindi": { "title": "Hindi", "type": "boolean", "description": "Agents who speak Hindi and can assist Hindi-speaking clients.", "default": false }, "hungarian": { "title": "Hungarian", "type": "boolean", "description": "Agents who speak Hungarian and can assist Hungarian-speaking clients.", "default": false }, "italian": { "title": "Italian", "type": "boolean", "description": "Agents who speak Italian and can assist Italian-speaking clients.", "default": false }, "japanese": { "title": "Japanese", "type": "boolean", "description": "Agents who speak Japanese and can assist Japanese-speaking clients.", "default": false }, "korean": { "title": "Korean", "type": "boolean", "description": "Agents who speak Korean and can assist Korean-speaking clients.", "default": false }, "mandarin": { "title": "Mandarin", "type": "boolean", "description": "Agents who speak Mandarin Chinese and can assist Mandarin-speaking clients.", "default": false }, "polish": { "title": "Polish", "type": "boolean", "description": "Agents who speak Polish and can assist Polish-speaking clients.", "default": false }, "portuguese": { "title": "Portuguese", "type": "boolean", "description": "Agents who speak Portuguese and can assist Portuguese-speaking clients.", "default": false }, "russian": { "title": "Russian", "type": "boolean", "description": "Agents who speak Russian and can assist Russian-speaking clients.", "default": false }, "spanish": { "title": "Spanish", "type": "boolean", "description": "Agents who speak Spanish and can assist Spanish-speaking clients.", "default": false }, "tagalog": { "title": "Tagalog (Filipino)", "type": "boolean", "description": "Agents who speak Tagalog (Filipino) and can assist Tagalog-speaking clients.", "default": false }, "thai": { "title": "Thai", "type": "boolean", "description": "Agents who speak Thai and can assist Thai-speaking clients.", "default": false }, "turkish": { "title": "Turkish", "type": "boolean", "description": "Agents who speak Turkish and can assist Turkish-speaking clients.", "default": false }, "vietnamese": { "title": "Vietnamese", "type": "boolean", "description": "Agents who speak Vietnamese and can assist Vietnamese-speaking clients.", "default": 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 } } } } } } } } } }