{ "openapi": "3.0.1", "info": { "title": "Zillow Upcoming Open House Finder by City or ZIP", "description": "Find upcoming Zillow open houses by city, ZIP, or search URL, with showing start and end times plus property price, beds/baths, square footage and location.", "version": "2.0", "x-build-id": "9UNU0GfG6ARoCoY2R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nimbryxo-studio~zillow-upcoming-open-house-finder-by-city-or-zip/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nimbryxo-studio-zillow-upcoming-open-house-finder-by-city-or-zip", "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/nimbryxo-studio~zillow-upcoming-open-house-finder-by-city-or-zip/runs": { "post": { "operationId": "runs-sync-nimbryxo-studio-zillow-upcoming-open-house-finder-by-city-or-zip", "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/nimbryxo-studio~zillow-upcoming-open-house-finder-by-city-or-zip/run-sync": { "post": { "operationId": "run-sync-nimbryxo-studio-zillow-upcoming-open-house-finder-by-city-or-zip", "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": { "locations": { "title": "Locations", "type": "array", "description": "US locations to search, one per line: a city (\"Austin, TX\"), ZIP code (\"78704\"), or neighborhood (\"Hyde Park, Austin, TX\"). Boroughs (\"Brooklyn, NY\") and counties (\"Travis County, TX\") also resolve. Each location is resolved through Zillow's autocomplete.", "items": { "type": "string" } }, "startUrls": { "title": "Zillow search URLs", "type": "array", "description": "Zillow search or open-house URLs to scrape instead of, or in addition to, locations. Legacy open-house paths are converted to the filtered 1_open path and the open-house filter is applied automatically.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "minPrice": { "title": "Minimum price ($)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Lower bound on the listing price. Leave blank for no minimum." }, "maxPrice": { "title": "Maximum price ($)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Upper bound on the listing price. Leave blank for no maximum." }, "bedsMin": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "number", "description": "Only include properties with at least this many bedrooms. Leave blank for no minimum." }, "bedsMax": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 10, "type": "number", "description": "Only include properties with at most this many bedrooms. Leave blank for no maximum." }, "bathsMin": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 10, "type": "number", "description": "Only include properties with at least this many bathrooms (decimals allowed, e.g. 1.5). Leave blank for no minimum." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Limit results to specific property types. Leave empty for all types.", "items": { "type": "string", "enum": [ "singleFamily", "condo", "townhouse", "multiFamily", "apartment", "manufactured", "lotLand" ], "enumTitles": [ "Houses", "Condos", "Townhouses", "Multi-family", "Apartments", "Manufactured homes", "Lots / land" ] } }, "dateFilter": { "title": "Open-house date", "enum": [ "any", "today", "this_weekend", "next_weekend", "next_7_days", "next_30_days", "custom" ], "type": "string", "description": "Show only showings in this window. Choose Custom range to use the date fields below. Zillow has no verified server-side date filter, so this is applied to the exact showing dates after collection.", "default": "any" }, "dateFrom": { "title": "Custom range: from (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Include only showings on or after this date. Used when the date filter is Custom range (or when no preset is selected)." }, "dateTo": { "title": "Custom range: to (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Include only showings on or before this date. Used when the date filter is Custom range (or when no preset is selected)." }, "includeDetails": { "title": "Include full property details", "type": "boolean", "description": "Open each listing's detail page for agent/broker, photos, description, year built, lot, HOA, and MLS. Adds one request per listing; rows still return with search-page fields when a detail page fails.", "default": true }, "includeAgentContact": { "title": "Include agent contact details", "type": "boolean", "description": "Include the listing agent and broker phone numbers and any published agent email found on the detail page. Off by default.", "default": false }, "maxItems": { "title": "Max showings", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of open-house showing rows to return across all locations and URLs (1-500). Each row is one showing.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration (optional)", "type": "object", "description": "Optional Apify Proxy overrides. Leave empty and the actor picks the working route automatically: direct first, then Apify Proxy AUTO, then a paid unblocker/residential group only after Zillow returns a real 403/PerimeterX block." }, "timeZone": { "title": "Time zone", "enum": [ "America/New_York", "America/Chicago", "America/Denver", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "Pacific/Honolulu" ], "type": "string", "description": "US time zone used to interpret today/this weekend and to floor open-house dates.", "default": "America/New_York" } } }, "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 } } } } } } } } } }