{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper - Search Listings", "description": "Scrape Zillow listings by location. Search For Sale, For Rent, or Sold properties with price, beds/baths, photos, agent or owner info, and more. Fast API-based Zillow scraper, no browser needed, with built-in proxies and full filter support.", "version": "0.1", "x-build-id": "A1GlhXt7gYQ2djIzK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mof1re~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mof1re-zillow-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/mof1re~zillow-scraper/runs": { "post": { "operationId": "runs-sync-mof1re-zillow-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/mof1re~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-mof1re-zillow-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": [ "searchType", "locations" ], "properties": { "searchType": { "title": "🔍 Search type", "enum": [ "FOR_SALE", "FOR_RENT", "SOLD" ], "type": "string", "description": "What kind of listings to search for.", "default": "FOR_SALE" }, "locations": { "title": "📍 Locations (Smart Detect)", "type": "array", "description": "ZIP code, city + state e.g. \"90210\", \"Chicago, IL\", or \"Newark, DE\". Add multiple to scrape several locations in one run.", "items": { "type": "string" } }, "maxResults": { "title": "🔢 Max results", "minimum": 1, "type": "integer", "description": "Maximum number of listings to collect. Leave empty to collect all available results.", "default": 150 }, "sortBy": { "title": "↕️ Sort by", "enum": [ "newest", "recentlyChanged", "priceHighToLow", "priceLowToHigh", "bedsMostFirst", "bathsMostFirst", "livingAreaLargestFirst", "yearBuiltOldestFirst" ], "type": "string", "description": "How to sort the results. Leave empty to use Zillow's default relevance sorting for the selected search type." }, "keywords": { "title": "🔑 Keywords", "type": "string", "description": "Optional free-text keyword to filter listings (e.g. \"pool\", \"renovated\")." }, "minPrice": { "title": "💲 Min price / min monthly rent", "minimum": 0, "type": "integer", "description": "Minimum price in USD (Sale/Sold) or minimum monthly rent (For Rent)." }, "maxPrice": { "title": "💲 Max price / max monthly rent", "minimum": 0, "type": "integer", "description": "Maximum price in USD (Sale/Sold) or maximum monthly rent (For Rent)." }, "minBedrooms": { "title": "🛏️ Min bedrooms", "minimum": 1, "maximum": 5, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBedrooms": { "title": "🛏️ Max bedrooms", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum number of bedrooms." }, "minBathrooms": { "title": "🛁 Min bathrooms", "minimum": 1, "maximum": 5, "type": "number", "description": "Minimum number of bathrooms." }, "maxBathrooms": { "title": "🛁 Max bathrooms", "minimum": 1, "maximum": 5, "type": "number", "description": "Maximum number of bathrooms." }, "minLivingAreaSqft": { "title": "📐 Min living area (sqft)", "minimum": 0, "type": "integer", "description": "Minimum interior living area in square feet." }, "maxLivingAreaSqft": { "title": "📐 Max living area (sqft)", "minimum": 0, "type": "integer", "description": "Maximum interior living area in square feet." }, "minLotSizeSqft": { "title": "🌳 Min lot size (sqft)", "minimum": 0, "type": "integer", "description": "Minimum lot size in square feet. 21780 sqft ≈ 1/2 acre." }, "maxLotSizeSqft": { "title": "🌳 Max lot size (sqft)", "minimum": 0, "type": "integer", "description": "Maximum lot size in square feet. 21780 sqft ≈ 1/2 acre." }, "minYearBuilt": { "title": "🏗️ Min year built", "type": "integer", "description": "Minimum construction year." }, "maxYearBuilt": { "title": "🏗️ Max year built", "type": "integer", "description": "Maximum construction year." }, "homeTypes": { "title": "🏠 Home types (limited options for For Rent)", "type": "array", "description": "Property types to include. For 'For Rent' searches, only Houses (singleFamily), Townhomes, and Condos are supported — other values are silently dropped.", "items": { "type": "string", "enum": [ "singleFamily", "condo", "multiFamily", "manufactured", "land", "townhome" ], "enumTitles": [ "Houses", "Condos", "Multi-family", "Manufactured", "Land", "Townhomes" ] } }, "basementStatuses": { "title": "🧱 Basement (FOR_SALE, SOLD Only)", "type": "array", "description": "Basement status.", "items": { "type": "string", "enum": [ "finished", "unfinished", "partial" ], "enumTitles": [ "Finished", "Unfinished", "Partial" ] } }, "daysOnZillow": { "title": "🕒 Days on Zillow", "enum": [ "1_day", "1_week", "2_weeks", "1_month", "3_months", "6_months", "1_year", "2_years", "3_years" ], "type": "string", "description": "Only show listings posted within this time window." }, "minParkingSpots": { "title": "🚗 Min parking spots", "minimum": 1, "maximum": 5, "type": "integer", "description": "Minimum number of parking spots." }, "otherAmenitiesFilters": { "title": "✨ Amenities (not for Sold)", "type": "array", "description": "General amenities. Only applies to 'For Sale' and 'For Rent' searches.", "items": { "type": "string", "enum": [ "havePool", "onWaterfront", "haveAirConditioning" ], "enumTitles": [ "Pool", "Waterfront", "Air conditioning" ] } }, "rentalAmenitiesFilters": { "title": "🏢 Rental amenities (For Rent only)", "type": "array", "description": "Rental-specific amenities. Only applies to 'For Rent' searches.", "items": { "type": "string", "enum": [ "laundryAvailable", "parkingAvailable" ], "enumTitles": [ "In-unit laundry", "Parking available" ] } }, "allowedPets": { "title": "🐾 Pets allowed (For Rent only)", "type": "array", "description": "Only show rentals that allow these pets. Only applies to 'For Rent' searches, and is ignored if 'No pets allowed' below is checked.", "items": { "type": "string", "enum": [ "largeDogs", "smallDogs", "cats" ], "enumTitles": [ "Large dogs", "Small dogs", "Cats" ] } }, "noPetsAllowed": { "title": "🚫 No pets allowed (For Rent only)", "type": "boolean", "description": "Only show rentals that don't allow pets. Only applies to 'For Rent' searches. When checked, 'Pets allowed' above is ignored.", "default": false }, "forRentByOwner": { "title": "🧑‍💼 For rent by owner (For Rent only)", "type": "boolean", "description": "Only show rentals listed directly by the owner. Only applies to 'For Rent' searches.", "default": false }, "showOnlyFilter": { "title": "✅ Must have", "type": "array", "description": "Only show listings with these features. Not all values apply to every search type — Zillow will ignore ones that don't apply.", "items": { "type": "string", "enum": [ "priceReduction", "singleStory", "garage", "elevatorAccess", "furnished", "hasHardwoodFloor", "hasDishwasher", "hasFitnessCenter", "areUtilitiesIncluded", "highSpeedInternetAvailable", "outdoorSpace" ], "enumTitles": [ "Price reduction (For Sale only)", "Single story", "Garage", "Elevator access", "Furnished", "Hardwood floor", "Dishwasher", "Fitness center", "Utilities included", "High-speed internet", "Outdoor space" ] } }, "viewTypesFilter": { "title": "🌄 Views", "type": "array", "description": "Only show listings with these views.", "items": { "type": "string", "enum": [ "mountain", "city", "water", "park" ], "enumTitles": [ "Mountain", "City", "Water", "Park" ] } } } }, "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 } } } } } } } } } }