{ "openapi": "3.0.1", "info": { "title": "Zillow Contact API - Send Rental & Sale Inquiries", "description": "Send one inquiry about an active Zillow rental or for-sale listing per run. Receive acceptance status, property details and available owner or agent information. Pay per message accepted by Zillow. Acceptance does not guarantee a reply.", "version": "0.0", "x-build-id": "fiJXUp2IIyb4g6LPd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearpath~zillow-contact-message-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearpath-zillow-contact-message-api", "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/clearpath~zillow-contact-message-api/runs": { "post": { "operationId": "runs-sync-clearpath-zillow-contact-message-api", "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/clearpath~zillow-contact-message-api/run-sync": { "post": { "operationId": "run-sync-clearpath-zillow-contact-message-api", "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": [ "name", "contactEmail", "phoneNumber" ], "properties": { "email": { "title": "Zillow Account Email (Optional)", "type": "string", "description": "Optional Zillow account email. Supply its password too. Sessions are saved separately for each customer and Zillow account for up to 24 hours. Omit authentication only for listings that allow it." }, "password": { "title": "Password", "type": "string", "description": "Zillow account password, required when supplying an account email. Keep this field private." }, "cookies": { "title": "Zillow Cookies (Optional)", "type": "string", "description": "Alternative to account email and password. Accepts a browser cookie string, a JSON object, or a browser extension JSON array. Supply current, complete Zillow cookies." }, "zpid": { "title": "ZPID (Zillow Property ID)", "minimum": 10000000, "maximum": 9999999999, "type": "integer", "description": "8-10 digit Zillow Property ID. Either ZPID or Property URL is required. You can find the ZPID in the property URL (e.g., https://www.zillow.com/homedetails/458222521_zpid/)" }, "propertyUrl": { "title": "Property URL", "pattern": "^https?://(www\\.)?zillow\\.com/.*$", "type": "string", "description": "Full Zillow property URL. Either ZPID or Property URL is required. Supports both direct URLs (with _zpid/) and speaking URLs (like /homedetails/address/)" }, "name": { "title": "Your Full Name", "minLength": 2, "type": "string", "description": "Your full name as it should appear in the contact inquiry (e.g., John Smith, Sarah Johnson, etc.)" }, "contactEmail": { "title": "Your Email Address", "type": "string", "description": "Your email address where the seller/agent can respond to your inquiry" }, "phoneNumber": { "title": "Your Phone Number (US/Canada)", "pattern": "^\\+1[0-9]{10}$", "minLength": 12, "maxLength": 12, "type": "string", "description": "Your US or Canada phone number in international format: +1XXXXXXXXXX (exactly 12 characters). Examples: +12125551234 (New York), +14165551234 (Toronto), +13105551234 (Los Angeles)" }, "message": { "title": "Your Message", "type": "string", "description": "Your message to the property seller/agent. Use {name} placeholder to automatically insert your name (e.g., 'Hi, I'm {name} and I'm interested...'). A professional default message is provided if omitted." } } }, "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 } } } } } } } } } }