{ "openapi": "3.0.1", "info": { "title": "Zillow Real Estate Intelligence Pro", "description": "Enterprise-grade Zillow property extraction with investment analysis, market intelligence, and business insights. Extract property data, investment metrics, and market analysis without API keys.", "version": "0.0", "x-build-id": "HTCOcFBVHTWwSaZMh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/red.cars~zillow-real-estate-intelligence-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-red.cars-zillow-real-estate-intelligence-pro", "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/red.cars~zillow-real-estate-intelligence-pro/runs": { "post": { "operationId": "runs-sync-red.cars-zillow-real-estate-intelligence-pro", "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/red.cars~zillow-real-estate-intelligence-pro/run-sync": { "post": { "operationId": "run-sync-red.cars-zillow-real-estate-intelligence-pro", "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": [ "mode" ], "properties": { "mode": { "title": "Intelligence Mode", "enum": [ "investment_research", "market_analysis", "portfolio_management", "due_diligence", "market_entry" ], "type": "string", "description": "Choose what type of real estate intelligence to extract", "default": "investment_research" }, "propertyUrls": { "title": "Zillow Property URLs", "minItems": 1, "maxItems": 100, "type": "array", "description": "List of Zillow property URLs to analyze. Supports /homedetails/ URLs with ZPID. For best results, use direct property URLs.", "items": { "type": "string", "pattern": "^https?://.*zillow\\.com/" } }, "searchTerms": { "title": "Location Search Terms", "maxItems": 50, "type": "array", "description": "List of locations to search (e.g., 'San Francisco, CA', 'Manhattan, NY', '90210'). Used when specific property URLs are not provided.", "items": { "type": "string" }, "default": [ "San Francisco, CA" ] }, "location": { "title": "Target Location", "type": "string", "description": "Primary location for market entry analysis (used in market_entry mode)", "default": "Austin, TX" }, "maxResults": { "title": "Max Properties", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of properties to analyze", "default": 100 }, "includeMarketAnalysis": { "title": "Include Market Analysis", "type": "boolean", "description": "Extract comparable properties, market trends, and neighborhood analysis", "default": true }, "includeInvestmentMetrics": { "title": "Include Investment Metrics", "type": "boolean", "description": "Calculate ROI, cap rate, cash flow, and investment grading (A-F)", "default": true }, "includeComparables": { "title": "Include Comparable Properties", "type": "boolean", "description": "Extract nearby comparable properties for market analysis", "default": false }, "includePriceHistory": { "title": "Include Price History", "type": "boolean", "description": "Extract property price history, listing history, and tax records", "default": true }, "extractionDepth": { "title": "Data Extraction Depth", "enum": [ "basic", "standard", "comprehensive" ], "type": "string", "description": "How comprehensive the data extraction should be", "default": "standard" }, "businessIntelligence": { "title": "Business Intelligence Reports", "type": "boolean", "description": "Generate executive-level business intelligence summaries and recommendations", "default": true }, "discoverSimilar": { "title": "Discover Similar Properties", "type": "boolean", "description": "Automatically find and analyze similar properties in the area", "default": false }, "complianceMode": { "title": "Compliance Mode", "enum": [ "standard", "strict" ], "type": "string", "description": "Data extraction compliance level for enterprise use", "default": "standard" }, "priceRange": { "title": "Price Range Filter", "type": "object", "description": "Filter properties by price range", "properties": { "min": { "title": "Minimum Price", "type": "integer", "description": "Minimum property price in USD", "minimum": 0, "editor": "number" }, "max": { "title": "Maximum Price", "type": "integer", "description": "Maximum property price in USD", "minimum": 0, "editor": "number" } } }, "propertyTypes": { "title": "Property Types", "type": "array", "description": "Filter by specific property types", "items": { "type": "string" }, "default": [ "Single Family", "Condo" ] }, "investmentCriteria": { "title": "Investment Criteria", "type": "object", "description": "Investment filtering criteria", "properties": { "minCapRate": { "title": "Minimum Cap Rate (%)", "type": "number", "description": "Minimum acceptable cap rate percentage", "minimum": 0, "maximum": 50, "editor": "number" }, "maxRiskScore": { "title": "Maximum Risk Score", "type": "integer", "description": "Maximum acceptable risk score (1-10 scale)", "minimum": 1, "maximum": 10, "default": 8, "editor": "number" }, "minInvestmentGrade": { "title": "Minimum Investment Grade", "type": "string", "description": "Minimum acceptable investment grade", "enum": [ "A", "B", "C", "D", "F" ], "default": "C", "editor": "select" } } }, "proxyType": { "title": "Proxy Reliability Level", "enum": [ "DATACENTER", "RESIDENTIAL" ], "type": "string", "description": "Choose your preferred balance of cost vs reliability. Standard (Datacenter) is faster; Premium (Residential) is most reliable for high-security targets.", "default": "RESIDENTIAL" }, "debugMode": { "title": "Debug Mode (Self-Test)", "type": "boolean", "description": "Enable minimal extraction for health checks and testing. Guarantees success within 300s.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Configure proxy settings for reliable enterprise scraping", "properties": {} } } }, "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 } } } } } } } } } }