{
"openapi": "3.0.1",
"info": {
"title": "ZILLOW | Bypass Limit of 500 | Search |Agent | with Email",
"description": "Unleash the full power of Zillow data - no limits, no restrictions. Comprehensive scraping for any search URL, delivering complete property insights at scale.",
"version": "0.0",
"x-build-id": "uIba76SRmSctHlMd0"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/memo23~zillow-cheerio-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-memo23-zillow-cheerio-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/memo23~zillow-cheerio-scraper/runs": {
"post": {
"operationId": "runs-sync-memo23-zillow-cheerio-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/memo23~zillow-cheerio-scraper/run-sync": {
"post": {
"operationId": "run-sync-memo23-zillow-cheerio-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": {
"startUrls": {
"title": "Start URLs",
"type": "array",
"description": "URLs to start with.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"addresses": {
"title": "Addresses to search",
"type": "array",
"description": "Addresses to scrape - should be in format 123 Main St, City, State",
"items": {
"type": "string"
}
},
"storeName": {
"title": "Name your storage for listings (deduplication and long-term retention) akka Monitoring Mode",
"pattern": "^[a-z0-9]+(-[a-z0-9]+)*$",
"type": "string",
"description": "Assign a custom name to the Key-Value Store where your scraped listings will be saved. This ensures:\n 1. **Data Deduplication**: Prevents duplicate entries in the storage. \n 2. **Persistent Storage**: Enables long-term retention of listings, beyond default storage limits.\n 3. **Project Management**: Separate datasets by using unique names for different projects or analyses.\n 4. **Data Reuse**: Easily reference and reuse stored data without overwriting.\n (If left blank, the default storage will be used with standard retention limits.)"
},
"includePropertyDetails": {
"title": "Include Property Details",
"type": "boolean",
"description": "Include property details in the output.",
"default": false
},
"includeAgentDetails": {
"title": "Include additional agent details",
"type": "boolean",
"description": "Include additional agent details (full profile) in the output. Only relevant when includePropertyDetails is true. Note: Zillow protects agent profile pages aggressively, so enabling this can produce 403s for some agents and slow the run down. Basic agent info (brokerName) is already included from the search results without this flag.",
"default": false
},
"includeSaleDetails": {
"title": "Include additional sale details",
"type": "boolean",
"description": "Include additional sale details in the output.",
"default": false
},
"flatOutput": {
"title": "Flattened output",
"type": "boolean",
"description": "When enabled, each dataset row is a simple flat object (no nested `details` GraphQL blob) containing just the most commonly requested columns: Address, Price, Listing Date, Days on Zillow, Year Built, Status, Beds, Baths, Sq Ft, Agent/Broker name + phone + email, Description, New Roof flag, Permit History, Zoning, etc. Leaves output much smaller and easier to import into spreadsheets. When disabled, the full detailed GraphQL response is attached under `details` for each row.",
"default": false
},
"includeNearbyHomes": {
"title": "Include nearby / similar homes blob",
"type": "boolean",
"description": "When enabled, keeps Zillow's `Collections` / `nearbyHomes` / `relatedHomes` / `homeRecommendations` payloads (full listings for ~10–20 nearby properties) on each row. When disabled (default), these are stripped — saves ~25% of dataset bytes / residential-proxy data transfer with no loss of per-row property data. The `submitFlow` form template is always stripped.",
"default": false
},
"moreResults": {
"title": "Scrape beyond 500 results limit (for searches with more than 500 results)",
"type": "boolean",
"description": "Zillow limits search results to 500 properties per query. Enable this option if your search has more than 500 results. The scraper will automatically split the search area to exhaust all possible listings. Note: This process may take longer and consume more resources.",
"default": false
},
"maxItems": {
"title": "Max Items",
"type": "integer",
"description": "Maximum number of items to scrape.",
"default": 100
},
"maxConcurrency": {
"title": "Max Concurrency",
"type": "integer",
"description": "Maximum number of pages that can be processed at the same time.",
"default": 200
},
"minConcurrency": {
"title": "Min Concurrency",
"type": "integer",
"description": "Minimum number of pages that will be processed at the same time.",
"default": 1
},
"maxRequestRetries": {
"title": "Max Request Retries",
"type": "integer",
"description": "Number of times the crawler will retry a failed request before giving up.",
"default": 200
},
"proxy": {
"title": "Proxy configuration",
"type": "object",
"description": "Specifies proxy servers that will be used by the scraper in order to hide its origin.
For details, see Proxy configuration in README.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}