{ "openapi": "3.0.1", "info": { "title": "Zillow Search Scraper", "description": "Zillow shows only a few hundred homes per search. Get every listing from any search link, city or ZIP: for sale, for rent and sold, with price, Zestimate, beds, baths, photos, broker and agent details. Duplicates removed. No login or cookies.", "version": "1.0", "x-build-id": "fKr1B3CRupE6Ownzy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawl_craft~zillow-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawl_craft-zillow-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/crawl_craft~zillow-search-scraper/runs": { "post": { "operationId": "runs-sync-crawl_craft-zillow-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/crawl_craft~zillow-search-scraper/run-sync": { "post": { "operationId": "run-sync-crawl_craft-zillow-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": [ "urls" ], "properties": { "urls": { "title": "πŸ™οΈ Search URLs or places", "type": "array", "description": "One per line. Paste any Zillow search link (with or without the map in the link), or type a place such as Austin, TX, 78701, Brooklyn NY or Travis County, TX. Bulk input is supported.", "items": { "type": "string" } }, "extractionMethod": { "title": "πŸ—ΊοΈ Extraction method", "enum": [ "PAGINATION_WITH_ZOOM_IN", "PAGINATION", "MAP_MARKERS" ], "type": "string", "description": "Pagination with zoom-in returns every listing of a search, even past the number of results Zillow shows on its pages. Pagination alone stops at Zillow's page limit. Map markers is the fastest and returns up to about 500 per search.", "default": "PAGINATION_WITH_ZOOM_IN" }, "resultsLimit": { "title": "πŸ“Š Results per search", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Maximum listings to save from each search. 0 means every listing. With 5 searches and 100 here you get up to 500 listings.", "default": 10 }, "listingStatus": { "title": "🏷️ Listing status", "enum": [ "url", "for_sale", "for_rent", "sold" ], "type": "string", "description": "Homes for sale, for rent or recently sold. Keep as in the link uses the status of each Zillow link; plain places are searched for sale.", "default": "url" }, "homeTypes": { "title": "🏘️ Home types", "type": "array", "description": "Only these home types. Leave empty for all types.", "items": { "type": "string", "enum": [ "house", "condo", "townhouse", "multi_family", "apartment", "manufactured", "land" ], "enumTitles": [ "Houses", "Condos", "Townhomes", "Multi-family", "Apartments", "Manufactured", "Lots / land" ] } }, "minPrice": { "title": "πŸ’΅ Minimum price", "minimum": 0, "type": "integer", "description": "Lowest price in USD. For rentals this is the monthly rent. 0 means no minimum.", "default": 0 }, "maxPrice": { "title": "πŸ’° Maximum price", "minimum": 0, "type": "integer", "description": "Highest price in USD. For rentals this is the monthly rent. 0 means no maximum.", "default": 0 }, "minBeds": { "title": "πŸ›οΈ Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Only homes with at least this many bedrooms. 0 means any.", "default": 0 }, "daysOnZillow": { "title": "πŸ“† Days on Zillow", "enum": [ "any", "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "Only listings added within this period. The month options apply to recently sold homes.", "default": "any" }, "sort": { "title": "πŸ”ƒ Sort order", "enum": [ "default", "newest", "price_low", "price_high", "beds", "bathrooms", "size", "lot_size", "zestimate_high", "zestimate_low", "relevance" ], "type": "string", "description": "Order in which Zillow returns the listings. Keep as in the link uses the sort of each link (Zillow's default for plain places).", "default": "default" }, "includeDetails": { "title": "πŸ“ Property details", "type": "boolean", "description": "Open every listing for its description, agent name and phone, MLS, HOA fee, tax rate, year built, parking, county, neighborhood, page views and high-resolution photos. Price history is available for rental listings only, and recently sold homes usually have no description. Slower: one extra page per listing.", "default": false }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "Choose how the Actor connects. The default works for most runs.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }