{ "openapi": "3.0.1", "info": { "title": "Zillow Agent Data Scraper (Agent Listings, Reviews & Details)", "description": "Scrape complete Zillow agent data effortlessly. Get agent details, active/rental/sold listings, reviews, and search results with one API call. Ideal for real estate analytics, lead generation, and agent performance tracking.", "version": "0.0", "x-build-id": "vjSgpeYHKqCkfTDxh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coder_zoro~zillow-agent-data-scraper-agent-listings-reviews-details/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coder_zoro-zillow-agent-data-scraper-agent-listings-reviews-details", "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/coder_zoro~zillow-agent-data-scraper-agent-listings-reviews-details/runs": { "post": { "operationId": "runs-sync-coder_zoro-zillow-agent-data-scraper-agent-listings-reviews-details", "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/coder_zoro~zillow-agent-data-scraper-agent-listings-reviews-details/run-sync": { "post": { "operationId": "run-sync-coder_zoro-zillow-agent-data-scraper-agent-listings-reviews-details", "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": [ "data_type" ], "properties": { "data_type": { "title": "Data Type", "enum": [ "find_ActiveListings", "find_RentalListings", "find_SoldListings", "find_reviews", "find_details", "find_profile_keys", "find_search" ], "type": "string", "description": "What to fetch. Agent Search needs Agent Name. Agent Details and Profile Data Keys need Username. Listings and Reviews need ZUID (add Username too as a fallback if the listings API returns 404).", "default": "find_search" }, "zuid": { "title": "Zillow User ID (ZUID)", "type": "string", "description": "Encoded Zillow user id, for example X1-ZUxxxxxxxxxxxx_xxxxx. Required for Active, Rental and Sold Listings and Reviews." }, "username": { "title": "Agent Username", "type": "string", "description": "The part after zillow.com/profile/ in the agent's profile URL, for example jane-smith. Required for Agent Details and Profile Data Keys. Optional for listings and reviews: used as a fallback if the API returns 404." }, "name": { "title": "Agent Name", "type": "string", "description": "Agent name to look up. Required for Agent Search.", "default": "Smith" }, "location": { "title": "Location (optional, for Agent Search)", "type": "string", "description": "City and state, for example 'New York, NY' or 'chicago-il'. It is converted to Zillow's slug format (new-york-ny).", "default": "chicago-il" }, "page_number": { "title": "Page Number", "minimum": 1, "type": "integer", "description": "Results page to fetch.", "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 }, "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 } } } } } } } } } }