{ "openapi": "3.0.1", "info": { "title": "Zillow Search Scraper", "description": "Search Zillow homes for sale, for rent or recently sold by city, ZIP code or map point. Get price, beds, baths, living area, Zestimate, rent Zestimate, photos and broker for up to 1,000 listings per location, with many locations in one run.", "version": "1.0", "x-build-id": "R5XU4N3uCwJ6zA0Gm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thescrappa~zillow-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thescrappa-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/thescrappa~zillow-search-scraper/runs": { "post": { "operationId": "runs-sync-thescrappa-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/thescrappa~zillow-search-scraper/run-sync": { "post": { "operationId": "run-sync-thescrappa-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": [ "locations" ], "properties": { "locations": { "title": "Locations", "minItems": 1, "maxItems": 100, "type": "array", "description": "US places to search, one per entry: a city with state (\"Austin TX\"), a ZIP code (\"78704\"), a county or a neighborhood. You can also enter a point as latitude,longitude (\"47.674,-122.1215\") to search around it.", "items": { "type": "string", "minLength": 1, "maxLength": 120 } }, "listingType": { "title": "Listing type", "enum": [ "forSale", "forRent", "sold" ], "type": "string", "description": "Which homes to search.", "default": "forSale" }, "maxItems": { "title": "Maximum listings per location", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Most listings to save for each location. Zillow shows at most 1,000 listings per search, so split large areas into ZIP codes to get more.", "default": 100 }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Lowest price in USD. For rentals this is the monthly rent." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Highest price in USD. For rentals this is the monthly rent." }, "minBeds": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Fewest bedrooms." }, "maxBeds": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Most bedrooms." }, "minBaths": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Fewest bathrooms, for example 1.5." }, "maxBaths": { "title": "Maximum bathrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Most bathrooms." }, "homeTypes": { "title": "Home types", "uniqueItems": true, "type": "array", "description": "Keep only these home types. Leave empty for all types.", "items": { "type": "string", "enum": [ "singleFamily", "condo", "townhome", "multiFamily", "manufactured", "lot", "apartment" ], "enumTitles": [ "Houses", "Condos", "Townhomes", "Multi-family", "Manufactured", "Lots and land", "Apartments" ] } }, "minLivingArea": { "title": "Minimum living area (sq ft)", "minimum": 0, "type": "integer", "description": "Smallest living area in square feet." }, "minLotSize": { "title": "Minimum lot size (sq ft)", "minimum": 0, "type": "integer", "description": "Smallest lot in square feet. One acre is 43,560 sq ft." }, "minYearBuilt": { "title": "Built in or after", "minimum": 0, "maximum": 2100, "type": "integer", "description": "Earliest year the home was built." }, "keywords": { "title": "Keywords", "maxLength": 100, "type": "string", "description": "Words that must appear in the listing, for example \"pool\" or \"waterfront\"." }, "sortBy": { "title": "Sort by", "enum": [ "default", "newest", "priceLow", "priceHigh", "largest", "bedrooms" ], "type": "string", "description": "Order of the results. With a limit, the order decides which listings you get.", "default": "default" }, "radiusMiles": { "title": "Radius for points (miles)", "minimum": 0.1, "maximum": 100, "type": "number", "description": "Search radius around latitude,longitude entries. Place names use their own Zillow boundary.", "default": 5 }, "includePhotos": { "title": "Include photo list", "type": "boolean", "description": "Add the full list of high resolution photo URLs to each listing. The main photo is always included.", "default": true } } }, "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 } } } } } } } } } }