{ "openapi": "3.0.1", "info": { "title": "Zillow Suite Scraper - For Sale, For Rent & Sold Comps", "description": "Scrape public Zillow homes for sale, rentals, apartment buildings, and sold comparables. Get prices, beds, baths, area, Zestimates, taxes, days on market, photos, coordinates, and listing URLs. Optional details add agents, MLS IDs, history, schools, and property facts.", "version": "1.0", "x-build-id": "UOgVAmtRtawafFnq4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thirdwatch~zillow-suite-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thirdwatch-zillow-suite-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/thirdwatch~zillow-suite-scraper/runs": { "post": { "operationId": "runs-sync-thirdwatch-zillow-suite-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/thirdwatch~zillow-suite-scraper/run-sync": { "post": { "operationId": "run-sync-thirdwatch-zillow-suite-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": [ "queries" ], "properties": { "queries": { "title": "Locations or Zillow URLs", "type": "array", "description": "One entry per search. Accepts a ZIP code (90210), a city and state (Austin, TX), a neighbourhood (Williamsburg, Brooklyn, NY), a county (Travis County, TX), a full Zillow search URL, or a single /homedetails/ property URL (which is scraped as one detailed row).", "default": [ "Austin, TX" ], "items": { "type": "string" } }, "searchMode": { "title": "Search mode", "enum": [ "forSale", "forRent", "sold" ], "type": "string", "description": "forSale returns active for-sale listings, forRent returns rentals and apartment buildings, sold returns recently sold comparables.", "default": "forSale" }, "maxResults": { "title": "Max results per location", "minimum": 1, "maximum": 2000, "type": "integer", "description": "How many listings to return for each entry in `queries`. For broad areas, use multiple ZIP codes or neighbourhoods to improve coverage.", "default": 10 }, "includeDetails": { "title": "Fetch full property details", "type": "boolean", "description": "Add year built, description, listing agent and phone, MLS ID, HOA fee, tax and price history, schools, property facts, and the full photo set. This option is slower than listing-only mode.", "default": false }, "maxDetailPages": { "title": "Max detail pages per location", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Caps how many listings get the extra property-page visit when `includeDetails` is on. Leave empty to enrich every listing." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "priceAsc", "priceDesc", "livingArea", "lotSize" ], "type": "string", "description": "Ordering applied by Zillow before pagination.", "default": "relevance" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Minimum sale price, or minimum monthly rent when `searchMode` is forRent." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Maximum sale price, or maximum monthly rent when `searchMode` is forRent." }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms for matching listings." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bathrooms for matching listings." }, "homeTypes": { "title": "Property types", "type": "array", "description": "Leave empty for every property type. Each option maps to a Zillow property-type filter.", "items": { "type": "string", "enum": [ "houses", "townhomes", "condos", "apartments", "multiFamily", "lotsLand", "manufactured" ], "enumTitles": [ "Houses", "Townhomes", "Condos / co-ops", "Apartments", "Multi-family", "Lots / land", "Manufactured" ] }, "default": [] }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Zillow only serves listing data to US residential IPs. Keep the default unless you are supplying your own US proxies.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }