{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper: Homes for Sale, Rent and Sold", "description": "Scrape Zillow homes for sale, for rent and recently sold by place, ZIP code, map area or search link, no login, past the 984 home cap. Each home gives price, Zestimate, rent Zestimate, beds, baths and days on Zillow; details add price history, tax history and schools. CSV, Excel, API; pay per home.", "version": "0.1", "x-build-id": "7L00JwCm7gAxQZS99" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_craft~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_craft-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/automation_craft~zillow-scraper/runs": { "post": { "operationId": "runs-sync-automation_craft-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/automation_craft~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-automation_craft-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", "properties": { "locations": { "title": "Places (city, ZIP, county, neighbourhood, state)", "type": "array", "description": "Places as Zillow names them, one per line, for example \"Austin, TX\", \"78704\", \"Travis County, TX\", \"Mueller, Austin, TX\", \"Brooklyn, NY\" or \"Texas\". A place is searched only when exactly one Zillow place matches the text; otherwise a free row lists the matching places to pick from.", "items": { "type": "string" } }, "searchUrls": { "title": "Zillow search links", "type": "array", "description": "Links copied from a Zillow search page, for example https://www.zillow.com/austin-tx/ or a link with your filters, map area and sort. The link keeps its own listing status, filters and drawn area; a filter you also set below replaces only that filter of the link.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Five digit US ZIP codes, one per line, each searched on its own (for example 78704).", "items": { "type": "string" } }, "mapAreas": { "title": "Map areas", "type": "array", "description": "Areas on the map, one per line: a circle as \"latitude,longitude,radius in miles\" (for example \"30.27,-97.74,3\") or a box as \"south,west,north,east\". Homes outside the circle are left out free.", "items": { "type": "string" } }, "homes": { "title": "Homes (links, zpids or street addresses)", "type": "array", "description": "Zillow home links (https://www.zillow.com/homedetails/.../12345678_zpid/), zpids (12345678), full street addresses (\"1704 Shelbourne Dr, Austin, TX 78752\"), apartment building links (/b/... or /apartments/...) or new construction community links (/community/.../12345678_zpid/: one row per plan and move in ready home). An address is delivered only when exactly one Zillow home matches it and the record carries the same house number and street; a miss is a free row. Search filters do not apply to these homes.", "items": { "type": "string" } }, "datasetId": { "title": "Homes from an earlier run (dataset id)", "type": "string", "description": "The id of an Apify dataset whose rows carry a \"zpid\" or a Zillow home link (for example an earlier run of this Actor). Every home in it is looked up like the homes above. At most 200,000 rows." }, "communityHomeTypes": { "title": "New construction communities: home kinds", "uniqueItems": true, "type": "array", "description": "For new construction community links in \"Homes\" only: the kinds of homes delivered. Empty means all.", "items": { "type": "string", "enum": [ "plan", "moveInReady", "lot" ], "enumTitles": [ "Floor plans", "Move in ready homes", "Lots" ] } }, "listingStatus": { "title": "Listing status", "enum": [ "forSale", "forRent", "sold", "all" ], "type": "string", "description": "The listing status of every place, ZIP code and map area search. Search links keep their own. Default: for sale." }, "saleTypes": { "title": "For sale: listing types", "uniqueItems": true, "type": "array", "description": "Only these for sale listing types (Zillow shows all of them by default). For example only \"byOwner\" for homes for sale by owner, or only \"newConstruction\".", "items": { "type": "string", "enum": [ "byAgent", "byOwner", "newConstruction", "foreclosure", "auction", "comingSoon" ], "enumTitles": [ "By agent", "By owner (FSBO)", "New construction", "Foreclosures", "Auctions", "Coming soon" ] } }, "includePending": { "title": "For sale: include pending and under contract", "type": "boolean", "description": "Also deliver homes that are pending or under contract." }, "includeAcceptingBackupOffers": { "title": "For sale: include homes accepting backup offers", "type": "boolean", "description": "Also deliver homes under contract that accept backup offers." }, "includeForeclosed": { "title": "For sale: include foreclosed (bank owned)", "type": "boolean", "description": "Also deliver foreclosed, bank owned homes not on the market." }, "distressedOnly": { "title": "For sale: distressed only", "type": "boolean", "description": "Only foreclosures, auctions and foreclosed (bank owned) homes. Cannot be combined with \"For sale: listing types\". Zillow shows pre foreclosures only to signed in users, so they are not included." }, "soldWithin": { "title": "Recently sold: sold within", "enum": [ "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "For recently sold searches: homes sold within this time." }, "minPrice": { "title": "Minimum price (USD; monthly rent for rentals)", "type": "integer", "description": "The lowest price, in US dollars. For rentals the monthly rent." }, "maxPrice": { "title": "Maximum price (USD; monthly rent for rentals)", "type": "integer", "description": "The highest price, in US dollars. For rentals the monthly rent." }, "minBeds": { "title": "Minimum bedrooms", "type": "integer", "description": "At least this many bedrooms (0 for studios and up)." }, "maxBeds": { "title": "Maximum bedrooms", "type": "integer", "description": "At most this many bedrooms." }, "minBaths": { "title": "Minimum bathrooms", "type": "number", "description": "At least this many bathrooms (1, 1.5, 2, 3 or 4)." }, "maxBaths": { "title": "Maximum bathrooms", "type": "number", "description": "At most this many bathrooms. Checked on each row; homes without a bathroom count are left out free." }, "homeTypes": { "title": "Home types", "uniqueItems": true, "type": "array", "description": "Only these home types (all by default).", "items": { "type": "string", "enum": [ "house", "townhouse", "condo", "multiFamily", "apartment", "manufactured", "lotLand" ], "enumTitles": [ "Houses", "Townhomes", "Condos", "Multi family", "Apartments", "Manufactured", "Lots and land" ] } }, "minSqft": { "title": "Minimum living area (sqft)", "type": "integer", "description": "At least this living area in square feet." }, "maxSqft": { "title": "Maximum living area (sqft)", "type": "integer", "description": "At most this living area in square feet." }, "minLotSize": { "title": "Minimum lot size (sqft)", "type": "integer", "description": "At least this lot size in square feet (one acre is 43,560)." }, "maxLotSize": { "title": "Maximum lot size (sqft)", "type": "integer", "description": "At most this lot size in square feet." }, "minYearBuilt": { "title": "Built in or after", "type": "integer", "description": "Only homes built in this year or later." }, "maxYearBuilt": { "title": "Built in or before", "type": "integer", "description": "Only homes built in this year or earlier." }, "maxDaysOnZillow": { "title": "Listed within (days on Zillow)", "enum": [ "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "For sale and rental searches: only homes listed on Zillow within this time." }, "minDaysOnZillow": { "title": "At least this many days on Zillow", "type": "integer", "description": "Only homes on Zillow for at least this many days (stale listings). Checked on each row; homes without a days on Zillow figure are left out free." }, "keywords": { "title": "Keywords", "type": "string", "description": "Words Zillow looks for in the listing, for example \"pool\" or \"guest house\"." }, "maxHoa": { "title": "Maximum HOA fee (USD a month)", "type": "integer", "description": "At most this monthly HOA fee." }, "includeHomesWithNoHoaData": { "title": "Keep homes without HOA data", "type": "boolean", "description": "With a maximum HOA fee set: keep homes whose HOA fee is not known (Zillow keeps them by default)." }, "minParkingSpots": { "title": "Minimum parking spots", "type": "integer", "description": "At least this many parking spots." }, "mustHaveGarage": { "title": "Must have a garage", "type": "boolean", "description": "Only homes with a garage." }, "mustHavePool": { "title": "Must have a pool", "type": "boolean", "description": "Only homes with a pool." }, "mustHaveAirConditioning": { "title": "Must have air conditioning", "type": "boolean", "description": "Only homes with air conditioning." }, "waterfrontOnly": { "title": "Waterfront only", "type": "boolean", "description": "Only waterfront homes." }, "singleStoryOnly": { "title": "Single story only", "type": "boolean", "description": "Only single story homes." }, "basement": { "title": "Basement", "enum": [ "finished", "unfinished" ], "type": "string", "description": "Only homes with a finished, or an unfinished, basement." }, "views": { "title": "Views", "uniqueItems": true, "type": "array", "description": "Only homes with these views.", "items": { "type": "string", "enum": [ "city", "mountain", "park", "water" ], "enumTitles": [ "City", "Mountain", "Park", "Water" ] } }, "seniorCommunity": { "title": "55+ communities", "enum": [ "include", "exclude", "only" ], "type": "string", "description": "Include, leave out or only show homes in 55+ communities (included by default)." }, "has3DTour": { "title": "Must have a 3D tour", "type": "boolean", "description": "Only homes with a 3D tour." }, "openHouseOnly": { "title": "Open houses only", "type": "boolean", "description": "Only homes with an open house." }, "priceReducedOnly": { "title": "Price cuts only", "type": "boolean", "description": "Only homes whose price was reduced." }, "showcaseOnly": { "title": "Zillow Showcase only", "type": "boolean", "description": "Only Zillow Showcase listings." }, "withPhotosOnly": { "title": "With photos only", "type": "boolean", "description": "Only homes with photos." }, "minSchoolRating": { "title": "Minimum school rating (1 to 10, needs Home details)", "type": "integer", "description": "Only homes with at least one nearby school rated this or higher (GreatSchools rating from the home's Zillow record). Needs the Home details add-on; a home whose schools are all lower is left out, and its Home details are not charged." }, "includeUnratedSchools": { "title": "Keep homes whose schools are unrated", "type": "boolean", "description": "With a minimum school rating: also keep homes whose nearby schools carry no rating at all." }, "maxPriceToZestimatePercent": { "title": "Maximum price as a percent of the Zestimate", "type": "number", "description": "Deals: only homes whose price is at most this percent of their Zestimate (for example 95). Checked on each row; homes without a Zestimate are left out free." }, "minGrossRentYieldPercent": { "title": "Minimum gross rent yield (percent)", "type": "number", "description": "Investors: only homes whose rent Zestimate times 12, divided by the price, is at least this percent. Checked on each row; homes without a rent Zestimate are left out free." }, "nonOwnerOccupiedOnly": { "title": "Absentee owners only", "type": "boolean", "description": "Investors: only homes Zillow marks as not owner occupied. Checked on each row; homes without the mark are left out free." }, "sort": { "title": "Sort", "enum": [ "relevance", "newest", "priceLowToHigh", "priceHighToLow", "bedrooms", "bathrooms", "squareFeet", "lotSize" ], "type": "string", "description": "The order Zillow lists the homes in. With \"maxItemsPerSearch\" it decides which homes come first." }, "petsAllowed": { "title": "Pets allowed", "type": "boolean", "description": "Only rentals that allow pets." }, "largeDogsAllowed": { "title": "Large dogs allowed", "type": "boolean", "description": "Only rentals that allow large dogs." }, "smallDogsAllowed": { "title": "Small dogs allowed", "type": "boolean", "description": "Only rentals that allow small dogs." }, "catsAllowed": { "title": "Cats allowed", "type": "boolean", "description": "Only rentals that allow cats." }, "noPets": { "title": "No pets", "type": "boolean", "description": "Only rentals that allow no pets." }, "inUnitLaundry": { "title": "In unit laundry", "type": "boolean", "description": "Only rentals with laundry in the unit." }, "furnished": { "title": "Furnished", "type": "boolean", "description": "Only furnished rentals." }, "onSiteParking": { "title": "On site parking", "type": "boolean", "description": "Only rentals with parking." }, "elevator": { "title": "Elevator", "type": "boolean", "description": "Only rentals with an elevator." }, "highSpeedInternet": { "title": "High speed internet", "type": "boolean", "description": "Only rentals with high speed internet." }, "outdoorSpace": { "title": "Outdoor space", "type": "boolean", "description": "Only rentals with outdoor space." }, "utilitiesIncluded": { "title": "Utilities included", "type": "boolean", "description": "Only rentals with utilities included." }, "hardwoodFloors": { "title": "Hardwood floors", "type": "boolean", "description": "Only rentals with hardwood floors." }, "disabledAccess": { "title": "Disabled access", "type": "boolean", "description": "Only rentals with disabled access." }, "incomeRestricted": { "title": "Income restricted", "type": "boolean", "description": "Only income restricted rentals." }, "acceptsZillowApplications": { "title": "Accepts Zillow applications", "type": "boolean", "description": "Only rentals that accept applications on Zillow." }, "shortTermLease": { "title": "Short term lease", "type": "boolean", "description": "Only rentals with a short term lease." }, "controlledAccess": { "title": "Controlled access", "type": "boolean", "description": "Only rentals with controlled access." }, "dishwasher": { "title": "Dishwasher", "type": "boolean", "description": "Only rentals with a dishwasher." }, "fitnessCenter": { "title": "Fitness center", "type": "boolean", "description": "Only rentals with a fitness center." }, "rentByOwner": { "title": "For rent by owner", "type": "boolean", "description": "Only rentals listed by their owner." }, "instantTour": { "title": "Instant tour", "type": "boolean", "description": "Only rentals with an instant tour (a tour booked through Zillow)." }, "apartmentCommunity": { "title": "Apartment communities only", "type": "boolean", "description": "Only apartment community buildings." }, "rentalType": { "title": "Entire place or room", "enum": [ "entirePlace", "roomForRent", "any" ], "type": "string", "description": "Entire places (Zillow's default), rooms for rent, or both." }, "moveInDate": { "title": "Move in date", "type": "string", "description": "Only rentals available by this date (YYYY-MM-DD)." }, "maxItems": { "title": "Maximum homes (whole run)", "type": "integer", "description": "The run stops after delivering this many homes. Leave empty for no cap." }, "maxItemsPerSearch": { "title": "Maximum homes per search", "type": "integer", "description": "Each search, place, ZIP code or map area stops after this many homes, in the sort order chosen." }, "maxPagesPerSearch": { "title": "Maximum pages per search", "type": "integer", "description": "Read at most this many result pages of 41 homes per search (1 to 24). With this set, searches are not split by price." }, "splitPastCap": { "title": "Read past Zillow's per search cap", "type": "boolean", "description": "Zillow shows at most 984 homes of one search. On (default), a bigger search is split by price into bands that each fit, so every home is read; off, each search stops at 984 homes." }, "includeDetails": { "title": "Home details (paid add-on)", "type": "boolean", "description": "Read each home's full Zillow record: price history, tax history, schools, facts and features, HOA, description, MLS id, brokerage, open houses, nearby homes and every photo. Billed as one Home details event per home whose record was read." }, "includeInsights": { "title": "Home insights (paid add-on)", "type": "boolean", "description": "Read each home's Walk Score, Transit Score and Bike Score, its Zestimate history and rent Zestimate history (monthly, 10 years) and the comparable homes behind its Zestimate. Billed as one Home insights event per home with at least one of them read." }, "includePersonalData": { "title": "Include personal data", "type": "boolean", "description": "Off by default. On, the Home details add-on also delivers the listing agent, co agent and buyer's agent (name, phone, e-mail, licence), the person a listing names as its contact (a landlord or an owner selling by owner) and the agents named on price history events; and for a home its owner sells or lets (by owner), its street, exact map position, parcel id and the links naming its street or position, for that home and for by owner homes nested in other rows (off, the town, state and ZIP code stay; a rental let by its owner is recognised through \"For rent by owner\" or Home details). You are responsible for using personal data lawfully (GDPR, CCPA and similar laws). Brokerage names and phones are always delivered." }, "expandBuildingUnits": { "title": "One row per apartment unit", "type": "boolean", "description": "For apartment buildings on rental searches: one Home row per unit type the building lists (beds and price), instead of one row for the building with a units list. Each unit row is a Home." }, "outputFormat": { "title": "Output format", "enum": [ "nested", "flat" ], "type": "string", "description": "Nested JSON (default) or flat rows whose nested fields become columns such as \"address.city\"." }, "includeRawData": { "title": "Include Zillow's raw data", "type": "boolean", "description": "Add Zillow's own search row to each row as \"raw\". Zillow's record (and a building's or a community's raw data) is added only with \"Include personal data\" on, because it names the agents and contacts." }, "maxConcurrency": { "title": "Parallel connections", "type": "integer", "description": "How many Zillow connections the run uses at once (1 to 4, default 3). Each connection keeps a polite pace." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Default: Apify Proxy datacenter, screened for addresses Zillow refuses. Apify residential is used for search pages only. Or your own proxy links, used for every request." } } }, "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 } } } } } } } } } }