{ "openapi": "3.0.1", "info": { "title": "Zillow Search Scraper - Listings by City or ZIP", "description": "Get Zillow listings for any city, ZIP code, county or neighborhood: for sale, for rent or recently sold. Each row has price, Zestimate, rent estimate, beds, baths, sqft, lot, address, map coordinates and broker. Big cities come back in full. Export to CSV, JSON or Excel.", "version": "0.3", "x-build-id": "8RvdD2o6Jk2mK0JFg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/studioxl~zillow-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-studioxl-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/studioxl~zillow-search-scraper/runs": { "post": { "operationId": "runs-sync-studioxl-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/studioxl~zillow-search-scraper/run-sync": { "post": { "operationId": "run-sync-studioxl-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", "properties": { "locations": { "title": "Locations", "type": "array", "description": "Cities, ZIP codes, counties or neighborhoods, for example \"Austin, TX\", \"78731\" or \"Brooklyn, NY\". Places Zillow doesn't recognize are listed in the log and skipped.", "items": { "type": "string" } }, "searchUrls": { "title": "Or Zillow search URLs", "type": "array", "description": "Paste the address bar from a search you set up on zillow.com, filters included. It runs exactly as given, so it stops at 820 results.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingType": { "title": "Listing type", "enum": [ "forSale", "forRent", "sold" ], "type": "string", "description": "Homes for sale, for rent, or sold recently.", "default": "forSale" }, "maxItems": { "title": "Maximum results", "minimum": 0, "type": "integer", "description": "Your spend cap. The run stops once this many listings are delivered. 100 listings cost about $0.15. Set 0 for no cap.", "default": 100 }, "maxItemsPerLocation": { "title": "Maximum per location", "minimum": 0, "type": "integer", "description": "Caps each location on its own, so one big city can't use up the whole run. Set 0 for no per-location cap.", "default": 0 }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Sale price for sale and sold searches, monthly rent for rentals. For example 400000." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Sale price for sale and sold searches, monthly rent for rentals. For example 900000." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Leave empty for every type. On rentals, Zillow treats apartments and condos as one type, so picking either gets both.", "items": { "type": "string", "enum": [ "house", "townhome", "condo", "apartment", "multiFamily", "land", "manufactured" ], "enumTitles": [ "Houses", "Townhomes", "Condos and co-ops", "Apartments", "Multi-family", "Lots and land", "Manufactured" ] } }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Fewest bedrooms, for example 3." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Most bedrooms, for example 5." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Fewest bathrooms, for example 2." }, "minLivingArea": { "title": "Minimum living area", "minimum": 0, "type": "integer", "description": "Smallest interior size in sq ft, for example 1500." }, "maxLivingArea": { "title": "Maximum living area", "minimum": 0, "type": "integer", "description": "Largest interior size in sq ft, for example 3000." }, "minLotSize": { "title": "Minimum lot size", "minimum": 0, "type": "integer", "description": "Smallest lot in sq ft. One acre is 43,560 sq ft." }, "maxLotSize": { "title": "Maximum lot size", "minimum": 0, "type": "integer", "description": "Largest lot in sq ft. One acre is 43,560 sq ft." }, "minYearBuilt": { "title": "Built after", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Earliest year built, for example 2000." }, "maxYearBuilt": { "title": "Built before", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Latest year built, for example 2020." }, "daysOnZillow": { "title": "Listed within", "enum": [ "", "1", "7", "14", "30", "90" ], "type": "string", "description": "Only listings that went up within this window. On sold searches it's the sold-within window. Pick Last 24 hours for a daily new-listings feed.", "default": "" }, "listingSubTypes": { "title": "Listing types (for sale only)", "type": "array", "description": "Leave empty for Zillow's usual mix: agent and owner listings, new construction, foreclosures, auctions and coming soon, but not pending. Pick one or more to get only those. Pending adds homes that are pending or under contract.", "items": { "type": "string", "enum": [ "byAgent", "byOwner", "newConstruction", "foreclosure", "auction", "comingSoon", "pending" ], "enumTitles": [ "Listed by an agent", "For sale by owner (FSBO)", "New construction", "Foreclosures and bank-owned", "Auctions", "Coming soon", "Pending and under contract" ] } }, "hasPool": { "title": "Has a pool", "type": "boolean", "description": "Only listings with a pool.", "default": false }, "isWaterfront": { "title": "Waterfront", "type": "boolean", "description": "Only listings on the water.", "default": false }, "singleStoryOnly": { "title": "Single story only", "type": "boolean", "description": "Only single-story homes.", "default": false }, "hasGarage": { "title": "Has a garage", "type": "boolean", "description": "Only listings with a garage.", "default": false }, "hasAirConditioning": { "title": "Has air conditioning", "type": "boolean", "description": "Only listings with air conditioning.", "default": false }, "hasBasement": { "title": "Has a basement", "type": "boolean", "description": "Only listings with a basement.", "default": false }, "mustHaveOpenHouse": { "title": "Has an open house", "type": "boolean", "description": "Only listings with an open house scheduled.", "default": false }, "mustHave3dTour": { "title": "Has a 3D tour", "type": "boolean", "description": "Only listings with a 3D tour.", "default": false }, "sortBy": { "title": "Sort results by", "enum": [ "", "days", "priced", "pricea", "lot", "size", "beds" ], "type": "string", "description": "Which listings come first. Only matters when your cap is lower than the number of matches.", "default": "" }, "splitLargeAreas": { "title": "Cover large areas in full", "type": "boolean", "description": "On: big areas come back in full. Austin, TX has over 5,000 homes for sale and you get all of them. Off: stop at 820 results per location and spend less.", "default": true }, "respectRobotsTxt": { "title": "Strict mode", "type": "boolean", "description": "Leave off. When on, no search runs and the run ends with a message saying why.", "default": false }, "maxConcurrency": { "title": "Parallel workers", "minimum": 1, "maximum": 15, "type": "integer", "description": "Leave at 10. Higher values don't make runs faster.", "default": 10 }, "maxRequestsPerMinute": { "title": "Pace per minute", "minimum": 10, "maximum": 600, "type": "integer", "description": "Leave at 300. Higher values don't make runs faster.", "default": 300 }, "proxyConfiguration": { "title": "Connection settings", "type": "object", "description": "Leave as is. Changing this usually returns no results.", "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 }, "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 } } } } } } } } } }