{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper ($0.9 per 1000 results)", "description": "Zillow data extractor / API alternative. Scrape US listings at scale (buy, rent, sold) with rich fields and images. Use granular filters, sort, proxies. Export JSON/CSV to drive real-estate analytics, comps, market trends, and investor/agent leads.", "version": "0.0", "x-build-id": "ANR2lV04KWQi4wBkS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/igolaizola~zillow-scraper-ppe/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-igolaizola-zillow-scraper-ppe", "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/igolaizola~zillow-scraper-ppe/runs": { "post": { "operationId": "runs-sync-igolaizola-zillow-scraper-ppe", "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/igolaizola~zillow-scraper-ppe/run-sync": { "post": { "operationId": "run-sync-igolaizola-zillow-scraper-ppe", "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": [ "maxItems" ], "properties": { "maxItems": { "title": "Max Items", "minimum": 1, "type": "integer", "description": "Maximum number of properties to scrape", "default": 1000 }, "location": { "title": "Location", "type": "string", "description": "Location to search for properties. Ignored when Locations is provided." }, "locations": { "title": "Locations", "type": "array", "description": "Locations to search for properties. When provided, the actor searches each location in order instead of using Location.", "items": { "type": "string" } }, "locationType": { "title": "Location Type (leave empty to auto-detect)", "enum": [ "", "state", "county", "city", "neighborhood", "borough", "school", "flex_region", "address", "zipcode" ], "type": "string", "description": "Type of location: state, county, city, neighborhood, borough, school, flex_region, address or zipcode. Leave empty to auto-detect.", "default": "" }, "operation": { "title": "Operation", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Type of operation: buy, rent or sold", "default": "buy" }, "sortBy": { "title": "Sort by", "enum": [ "newest", "relevance", "recentlyChanged", "highPrice", "lowPrice", "bedrooms", "bathrooms", "sqft", "lotSize", "yearBuilt" ], "type": "string", "description": "Sorting method for results", "default": "newest" }, "minPrice": { "title": "Min Price (price per week for rent)", "minimum": 0, "type": "integer", "description": "Minimum price of the property (0 for any)", "default": 0 }, "maxPrice": { "title": "Max Price (price per week for rent)", "minimum": 0, "type": "integer", "description": "Maximum price of the property (0 for any)", "default": 0 }, "minBeds": { "title": "Min bedrooms", "type": "integer", "description": "Minimum number of bedrooms (-1 for studio, 0 for any)", "default": 0 }, "maxBeds": { "title": "Max bedrooms", "type": "integer", "description": "Maximum number of bedrooms (-1 for studio, 0 for any)", "default": 0 }, "minBaths": { "title": "Min bathrooms", "type": "integer", "description": "Minimum number of bathrooms", "default": 0 }, "homeTypes": { "title": "Home Types (leave empty for any)", "type": "array", "description": "Home types to search for", "items": { "type": "string", "enum": [ "houses", "townhomes", "multifamily", "condos", "land", "apartments", "manufactured" ], "enumTitles": [ "Houses", "Townhomes", "Multi-family (only for buy/sold)", "Condos/co-ops", "Lots/Land (only for buy/sold)", "Apartments", "Manufactured (only for buy/sold)" ] } }, "minSize": { "title": "Min Size", "enum": [ "", "500", "750", "1000", "1250", "1500", "1750", "2000", "2250", "2500", "2750", "3000", "3500", "4000", "5000", "7500" ], "type": "string", "description": "Minimum size", "default": "" }, "maxSize": { "title": "Max Size", "enum": [ "", "500", "750", "1000", "1250", "1500", "1750", "2000", "2250", "2500", "2750", "3000", "3500", "4000", "5000", "7500" ], "type": "string", "description": "Maximum size", "default": "" }, "minLotSize": { "title": "Min Lot Size", "enum": [ "", "1000-sqft", "2000-sqft", "3000-sqft", "4000-sqft", "5000-sqft", "7500-sqft", "1/4-acre", "1/2-acre", "1-acre", "2-acre", "5-acre", "10-acre", "25-acre", "50-acre", "100-acre" ], "type": "string", "description": "Minimum lot size", "default": "" }, "maxLotSize": { "title": "Max Lot Size", "enum": [ "", "1000-sqft", "2000-sqft", "3000-sqft", "4000-sqft", "5000-sqft", "7500-sqft", "1/4-acre", "1/2-acre", "1-acre", "2-acre", "5-acre", "10-acre", "25-acre", "50-acre", "100-acre" ], "type": "string", "description": "Maximum lot size", "default": "" }, "minYearBuilt": { "title": "Min Year Built", "minimum": 1900, "type": "integer", "description": "Filter by minimum year built" }, "maxYearBuilt": { "title": "Max Year Built", "minimum": 1900, "type": "integer", "description": "Filter by maximum year built" }, "airConditioning": { "title": "Air Conditioning", "type": "boolean", "description": "Filter by properties with air conditioning", "default": false }, "pool": { "title": "Pool", "type": "boolean", "description": "Filter by properties with a pool", "default": false }, "waterfront": { "title": "Waterfront", "type": "boolean", "description": "Filter by waterfront properties", "default": false }, "singleStory": { "title": "Single Story", "type": "boolean", "description": "Filter by single story properties", "default": false }, "basement": { "title": "Basement", "type": "boolean", "description": "Filter by properties with a basement", "default": false }, "views": { "title": "Views (leave empty for any)", "type": "array", "description": "Filter by views", "items": { "type": "string", "enum": [ "city", "mountain", "park", "water" ], "enumTitles": [ "City", "Mountain", "Park", "Water" ] } }, "3dTour": { "title": "3D Tour", "type": "boolean", "description": "To find listings that have a virtual touring experience, search with the 3D Tour filter.", "default": false }, "timeOnZillow": { "title": "Time on Zillow", "enum": [ "", "1d", "1w", "2w", "1m", "3m", "6m", "1y", "2y", "3y" ], "type": "string", "description": "Filter by time on Zillow", "default": "" }, "keywords": { "title": "Keywords (max 99 characters)", "type": "string", "description": "Keywords to search for (maximum length is 99 characters)" }, "maxHoaFees": { "title": "Max HOA Fees", "enum": [ "", "0", "100", "200", "300", "400", "500", "600", "700", "800", "900", "1000", "1500", "2000" ], "type": "string", "description": "Homeowners Association (HOA) fees are monthly or annual charges that cover the costs of maintaining and improving shared spaces.", "default": "" }, "parkingSpots": { "title": "Min Parking Spots (only for buy/sold operation)", "enum": [ "", "1", "2", "3", "4" ], "type": "string", "description": "Filter by minimum number of parking spots", "default": "" }, "garage": { "title": "Garage (only for buy/sold operation)", "type": "boolean", "description": "Filter by properties with a garage", "default": false }, "basementTypes": { "title": "Basement Types (basement must be enabled, leave empty for any) (only for buy/sold operation)", "type": "array", "description": "Filter by basement types", "items": { "type": "string", "enum": [ "finished", "unfinished" ], "enumTitles": [ "Finished", "Unfinished" ] } }, "agentListed": { "title": "Agent Listed (only for buy operation)", "type": "boolean", "description": "If enabled, agent listed properties will be returned", "default": true }, "ownerPosted": { "title": "Owner Posted (only for buy operation)", "type": "boolean", "description": "If enabled, owner posted properties will be returned", "default": true }, "newConstruction": { "title": "New Construction (only for buy operation)", "type": "boolean", "description": "If enabled, new construction properties will be returned", "default": true }, "foreclosure": { "title": "Foreclosure (only for buy operation)", "type": "boolean", "description": "These properties are currently listed for sale. They are owned by a bank or a lender who took ownership through foreclosure proceedings. These are also known as bank-owned or real estate owned (REO).", "default": true }, "auction": { "title": "Auction (only for buy operation)", "type": "boolean", "description": "If enabled, auction properties will be returned", "default": true }, "foreclosed": { "title": "Foreclosed (only for buy operation)", "type": "boolean", "description": "These properties are owned by a bank or a lender who took ownership through foreclosure proceedings. They may soon be listed for sale.", "default": false }, "preForeclosure": { "title": "Pre-foreclosure (only for buy operation)", "type": "boolean", "description": "The lender initiated the foreclosure proceedings on these properties because the owner(s) were in default on their loan obligations. Pre-foreclosures also include properties for which a foreclosure auction is scheduled.", "default": false }, "comingSoon": { "title": "Coming Soon (only for buy operation)", "type": "boolean", "description": "Coming Soon listings are homes that will soon be on the market. The listing agent for these homes has added a Coming Soon note to alert buyers in advance.", "default": true }, "priceDrop": { "title": "Price Drop (only for buy operation)", "type": "boolean", "description": "If enabled, properties with a recent price drop will be returned", "default": false }, "acceptingBackupOffers": { "title": "Accepting Backup Offers (only for buy operation)", "type": "boolean", "description": "The seller has accepted an initial offer, but is still showing the home and taking backup offers from interested buyers.", "default": false }, "pendingUnderContract": { "title": "Pending/Under Contract (only for buy operation)", "type": "boolean", "description": "Sellers of these homes have accepted a buyers' offer, however, the home has not closed.", "default": false }, "showcase": { "title": "Showcase (only for buy operation)", "type": "boolean", "description": "Experience homes before you ever step inside, with Zillow Showcase. These premium listings feature HD photos organized by room and 3D virtual tours.", "default": false }, "openHouse": { "title": "Open House (only for buy operation)", "type": "boolean", "description": "If enabled, properties with open house will be returned", "default": false }, "space": { "title": "Space (only for rent operation)", "enum": [ "", "entirePlace", "roomForRent" ], "type": "string", "description": "Filter by type of rental space" }, "moveInDate": { "title": "Move in date (rent operation only)", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Choose a move-in date to view listings available on or before that date" }, "hideNoMoveInDate": { "title": "Hide no move-in date (rent operation only)", "type": "boolean", "description": "If enabled, properties without a move-in date will be hidden", "default": false }, "pets": { "title": "Pets (rent operation only)", "type": "array", "description": "Filter by pet policy", "items": { "type": "string", "enum": [ "largeDogs", "smallDogs", "cats", "notAllowed" ], "enumTitles": [ "Large dogs allowed", "Small dogs allowed", "Cats allowed", "No pets allowed" ] }, "default": [] }, "inUnitLaundry": { "title": "In-unit laundry (rent operation only)", "type": "boolean", "description": "If enabled, only properties with in-unit laundry will be returned", "default": false }, "onSiteParking": { "title": "On-site parking (rent operation only)", "type": "boolean", "description": "If enabled, only properties with on-site parking will be returned", "default": false }, "elevator": { "title": "Elevator (rent operation only)", "type": "boolean", "description": "If enabled, only properties with an elevator will be returned", "default": false }, "highSpeedInternet": { "title": "High-speed internet (rent operation only)", "type": "boolean", "description": "If enabled, only properties with high-speed internet will be returned", "default": false }, "furnished": { "title": "Furnished (rent operation only)", "type": "boolean", "description": "Only include furnished properties (rent operation only)", "default": false }, "outdoorSpace": { "title": "Outdoor space (rent operation only)", "type": "boolean", "description": "If enabled, only properties with outdoor space will be returned", "default": false }, "utilitiesIncluded": { "title": "Utilities included (rent operation only)", "type": "boolean", "description": "If enabled, only properties with utilities included will be returned", "default": false }, "hardwoodFloors": { "title": "Hardwood floors (rent operation only)", "type": "boolean", "description": "If enabled, only properties with hardwood floors will be returned", "default": false }, "disabilityAccess": { "title": "Disability access (rent operation only)", "type": "boolean", "description": "Find rentals that the housing provider has identified as accessible for people with disabilities.", "default": false }, "incomeRestricted": { "title": "Income restricted (rent operation only)", "type": "boolean", "description": "Find rentals with income restrictions. These homes have income caps that determine eligibility.", "default": false }, "apartmentCommunity": { "title": "Apartment community (rent operation only)", "type": "boolean", "description": "Apartment Communities are larger properties that typically have extra amenities and at least 50 units.", "default": false }, "acceptsZillowApplications": { "title": "Accepts Zillow applications (rent operation only)", "type": "boolean", "description": "If enabled, only properties that accept applications through Zillow will be returned", "default": false }, "tourScheduling": { "title": "Tour scheduling (rent operation only)", "type": "boolean", "description": "If enabled, only properties that allow tour scheduling through Zillow will be returned", "default": false }, "shortTermLease": { "title": "Short-term lease (rent operation only)", "type": "boolean", "description": "If enabled, only properties that offer short-term leases will be returned", "default": false }, "maxSoldDate": { "title": "Max Sold Date (sold operation only)", "enum": [ "", "1d", "1w", "2w", "1m", "3m", "6m", "1y", "2y", "3y" ], "type": "string", "description": "Filter by maximum sold date", "default": "" } } }, "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 } } } } } } } } } }