{
"openapi": "3.0.1",
"info": {
"title": "Zillow Scraper - ZIP & City Search, Pay per Listing",
"description": "Extract Zillow rentals, for-sale and sold listings by ZIP code or city. Export property details, photos, prices and available agent contacts. Filter by price, home type and listing status. Pay per exported listing and completed location search.",
"version": "0.0",
"x-build-id": "nlyItluVFZn1B7HfW"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/clearpath~zillow-zip-code-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-clearpath-zillow-zip-code-search-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/clearpath~zillow-zip-code-search-scraper/runs": {
"post": {
"operationId": "runs-sync-clearpath-zillow-zip-code-search-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/clearpath~zillow-zip-code-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-clearpath-zillow-zip-code-search-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",
"required": [
"locations",
"propertyType"
],
"properties": {
"locations": {
"title": "Zip Codes or Locations",
"minItems": 1,
"type": "array",
"description": "Accepted: ZIP codes ('77494', '90210'), city + state ('New York NY', 'Los Angeles CA'), counties ('Travis County, TX'), or neighborhoods. Street addresses are NOT supported — Zillow's search API only resolves region-level locations. If you have an address, use its ZIP code instead.",
"items": {
"type": "string"
}
},
"propertyType": {
"title": "Property Type",
"enum": [
"forRent",
"forSale",
"sold"
],
"type": "string",
"description": "Type of property listings to search. Use these exact values: forRent, forSale, or sold.",
"default": "forRent"
},
"homeTypes": {
"title": "Home Types",
"uniqueItems": true,
"type": "array",
"description": "Filter by property types. Use these exact values: singleFamily, condo, apartment, townhome, multiFamily, manufactured, land. Rentals support only the first four. Leave empty for 'Any'.",
"items": {
"type": "string",
"enum": [
"singleFamily",
"multiFamily",
"townhome",
"condo",
"apartment",
"manufactured",
"land"
],
"enumTitles": [
"Houses",
"Multi-family",
"Townhomes",
"Condos/Co-ops",
"Apartments",
"Manufactured",
"Lots/Land"
]
}
},
"listingTypes": {
"title": "Listing Types (For Sale only)",
"uniqueItems": true,
"type": "array",
"description": "Choose which listing types to include (applies to For Sale searches). Leave empty to include all standard listing types. Ignored for Rentals and Sold.",
"items": {
"type": "string",
"enum": [
"fsba",
"fsbo",
"newConstruction",
"comingSoon",
"auction",
"foreclosure",
"foreclosed",
"preforeclosure"
],
"enumTitles": [
"Agent Listed",
"Owner Posted (FSBO)",
"New Construction",
"Coming Soon",
"Auction",
"Foreclosure",
"Foreclosed",
"Pre-foreclosure"
]
}
},
"showOnlyPriceReductions": {
"title": "Show Only Price Reductions",
"type": "boolean",
"description": "Only show listings with price drops (For Sale only). Ignored for rentals.",
"default": false
},
"includePendingAndUnderContract": {
"title": "Include Pending & Under Contract",
"type": "boolean",
"description": "Include listings that are pending or under contract. By default, Zillow excludes these.",
"default": false
},
"includeAcceptingBackupOffers": {
"title": "Include Accepting Backup Offers",
"type": "boolean",
"description": "Include listings accepting backup offers. By default, Zillow excludes these.",
"default": false
},
"minLivingAreaSqft": {
"title": "Minimum Living Area (sqft)",
"minimum": 0,
"type": "integer",
"description": "Minimum living area in square feet"
},
"maxLivingAreaSqft": {
"title": "Maximum Living Area (sqft)",
"minimum": 0,
"type": "integer",
"description": "Maximum living area in square feet"
},
"minBedrooms": {
"title": "Minimum Bedrooms",
"minimum": 0,
"type": "integer",
"description": "Minimum number of bedrooms"
},
"maxBedrooms": {
"title": "Maximum Bedrooms",
"minimum": 0,
"type": "integer",
"description": "Maximum number of bedrooms"
},
"includeRoomForRent": {
"title": "Include Rooms for Rent (Rentals only)",
"type": "boolean",
"description": "Include room-for-rent listings in rental searches. When off, only entire places are included.",
"default": false
},
"minPrice": {
"title": "Minimum Price",
"minimum": 0,
"type": "integer",
"description": "Minimum price (monthly rent for rentals, total price for sales/sold)"
},
"maxPrice": {
"title": "Maximum Price",
"minimum": 0,
"type": "integer",
"description": "Maximum price (monthly rent for rentals, total price for sales/sold)"
},
"daysOnZillow": {
"title": "Days on Zillow",
"enum": [
"1_day",
"1_week",
"2_weeks",
"1_month",
"3_months",
"6_months",
"12_months",
"24_months",
"36_months"
],
"type": "string",
"description": "Filter by how long listings have been on Zillow (optional)"
},
"sortBy": {
"title": "Sort By",
"enum": [
"rentalPriorityScore",
"recentlyChanged",
"newest",
"price_high",
"price_low",
"bedrooms",
"bathrooms"
],
"type": "string",
"description": "How to sort the results. Note: 'Recommended (Priority Score)' is only available for rental searches."
},
"maxResultsPerLocation": {
"title": "Max Results Per Location",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "Maximum number of results to scrape per location",
"default": 1000
}
}
},
"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
}
}
}
}
}
}
}
}
}
}