{ "openapi": "3.0.1", "info": { "title": "Zillow Property Scraper — Agent Emails Phones & Zestimate", "description": "Scrape Zillow listings with agent contacts, price history, Zestimate, and 70+ fields. Lead-ready agent phones/emails.", "version": "2.8", "x-build-id": "3G4hWKSG3RW0N7qjb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/intelscrape~real-estate-listing-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-intelscrape-real-estate-listing-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/intelscrape~real-estate-listing-scraper/runs": { "post": { "operationId": "runs-sync-intelscrape-real-estate-listing-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/intelscrape~real-estate-listing-scraper/run-sync": { "post": { "operationId": "run-sync-intelscrape-real-estate-listing-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": { "demoMode": { "title": "Demo mode", "type": "boolean", "description": "Push fictional sample listings with agent email/phone (format preview). No live Zillow crawl.", "default": false }, "location": { "title": "Location", "type": "string", "description": "City/area or ZIP for Zillow search, e.g. Austin, TX or 90210", "default": "Austin, TX" }, "locations": { "title": "Locations (first only)", "type": "array", "description": "Optional list; only the first location is used when zipCodes/startUrls are empty.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes (bulk)", "type": "array", "description": "Optional US ZIP list — each ZIP searched separately (capped). Overrides location when set.", "items": { "type": "string" }, "default": [] }, "startUrls": { "title": "Zillow URLs", "type": "array", "description": "Optional Zillow search or listing URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchUrl": { "title": "Zillow search URL (optional)", "type": "string", "description": "Full https://www.zillow.com/... search URL." }, "listingType": { "title": "Listing status filter", "enum": [ "for_sale", "for_rent", "recently_sold" ], "type": "string", "description": "For sale, for rent, or recently sold.", "default": "for_sale" }, "minPrice": { "title": "Min price", "type": "number", "description": "Optional minimum list price" }, "maxPrice": { "title": "Max price", "type": "number", "description": "Optional maximum list price" }, "minBeds": { "title": "Min beds", "minimum": 0, "maximum": 10, "type": "integer", "description": "Min beds" }, "enrichAgentContacts": { "title": "Enrich agent contacts from detail pages", "type": "boolean", "description": "Visit listing detail pages to pull agentName/agentEmail/agentPhone and price history when present.", "default": true }, "maxDetailEnrich": { "title": "Max detail enrichments", "minimum": 0, "maximum": 50, "type": "integer", "description": "Cap on detail-page enrichments per run (PPE + proxy cost control).", "default": 10 }, "calculateROI": { "title": "Calculate ROI metrics (additive)", "type": "boolean", "description": "Adds gross yield, cap rate, price-to-rent, investment grade (uses rentZestimate when present).", "default": true }, "maxResults": { "title": "Max listings", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum listings to push (PPE billed per dataset item).", "default": 25 }, "includeListingsAnalytics": { "title": "Include listings analytics summary", "type": "boolean", "description": "When true (default ON), push one free real-estate-listing-batch-summary row with city/agent/price-band breakdowns and SoftCTA. No extra PPE charge.", "default": true } } }, "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 } } } } } } } } } }