{ "openapi": "3.0.1", "info": { "title": "Zillow Listings Scraper: Zestimates & Price Cuts, No Login", "description": "Scrape Zillow listings for sale, for rent and sold by city, ZIP, search URL or address. Get price, Zestimate, rent estimate and full property details, and track price cuts and status changes.", "version": "0.1", "x-build-id": "JN0anVhzTzp70ZsDh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cliqtomedia~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cliqtomedia-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/cliqtomedia~zillow-scraper/runs": { "post": { "operationId": "runs-sync-cliqtomedia-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/cliqtomedia~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-cliqtomedia-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": { "mode": { "title": "Task", "enum": [ "search", "details", "monitor" ], "type": "string", "description": "Search or monitor cities and URLs. Details mode reads only property URLs, IDs, and addresses; it ignores search inputs. For full search results, use Search with Include full property details. See Pricing for event prices. Empty, unchanged, and failed checks are billed. Plan discounts apply.", "default": "search" }, "locations": { "title": "Cities or ZIP codes", "type": "array", "description": "Enter US cities with a state, or five-digit ZIP codes. For example: Austin, TX or 78701.", "items": { "type": "string" } }, "searchUrls": { "title": "Zillow search URLs", "type": "array", "description": "Paste Zillow search URLs from your browser. Map bounds and search filters are kept unless you set a matching filter below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "propertyUrls": { "title": "Property URLs", "type": "array", "description": "Zillow property pages to read. Numeric property URLs use the property-check price. Building and address pages also use the search-page price.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "zpids": { "title": "Zillow property IDs", "type": "array", "description": "Enter numeric Zillow property IDs. Each ID lookup uses the property-check price, including not-found results.", "items": { "type": "string" } }, "addresses": { "title": "Street addresses", "type": "array", "description": "Enter a full US street address, city, and state for each property.", "items": { "type": "string" } }, "status": { "title": "Listing status", "enum": [ "fromUrl", "forSale", "forRent", "sold", "all" ], "type": "string", "description": "Use the filters in a pasted URL, or choose a status to replace them. City searches use homes for sale by default.", "default": "fromUrl" }, "maxItems": { "title": "Maximum properties", "minimum": 0, "type": "integer", "description": "Stop after this many unique properties have been read across all inputs. Use 0 to read all available results. OnlyChanges also counts unchanged properties toward this limit.", "default": 100 }, "includeDetails": { "title": "Include full property details", "type": "boolean", "description": "Read each property page for description, price and tax history, schools, and home features. Available fields vary by property. Each property lookup uses the property-check price; the detailed row is included. Empty and failed checks are billed too.", "default": false }, "outputFormat": { "title": "Output format", "enum": [ "flat", "nested" ], "type": "string", "description": "Flat output stores lists and objects as JSON text in cells. Nested output keeps lists and objects.", "default": "flat" }, "onlyChanges": { "title": "Save only changed listings", "type": "boolean", "description": "Compare with the saved snapshot and save only new listings, price changes, and status changes. The first run saves every observed listing. Page and property checks are billed even when no rows change.", "default": false }, "stateName": { "title": "Monitor storage name", "type": "string", "description": "Named storage for monitoring between runs. Use lowercase letters, numbers, and dashes; start with zillow-scraper and keep the name at most 63 characters. Use a separate name for each independent monitor. Avoid overlapping runs with the same name.", "default": "zillow-scraper-monitor" }, "splitMap": { "title": "Split large map searches", "type": "boolean", "description": "Split map areas when Zillow limits the result window and your requested limit needs more listings. Large searches take more time and requests.", "default": true }, "proxyMode": { "title": "Search page connection route", "enum": [ "auto", "datacenter", "residential", "unblocker" ], "type": "string", "description": "Automatic tries datacenter, US residential, then Apify Unblocker for search pages. Property ID lookups use US residential. A fixed page route can fail; attempted checks are billed.", "default": "auto" }, "maxRequests": { "title": "Maximum source requests", "minimum": 1, "type": "integer", "description": "Optional limit on requests sent to Zillow, including retries and redirects. Results already saved are kept when this limit is reached." }, "sort": { "title": "Sort listings", "enum": [ "relevance", "newest", "priceLow", "priceHigh", "beds", "sqft", "lot", "zestimate" ], "type": "string", "description": "Set a Zillow sort order. If omitted, the sort in your URL is kept." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Keep these home types. Leave empty to keep the Zillow search defaults.", "items": { "type": "string", "enum": [ "SINGLE_FAMILY", "TOWNHOUSE", "CONDO", "MULTI_FAMILY", "MANUFACTURED", "APARTMENT", "LOT" ], "enumTitles": [ "House", "Townhouse", "Condo", "Multi-family", "Manufactured", "Apartment", "Lot or land" ] } }, "keywords": { "title": "Listing keywords", "type": "string", "description": "Send these words to Zillow to search listing text." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Lowest listing price in US dollars." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Highest listing price in US dollars." }, "minBeds": { "title": "Minimum bedrooms", "minimum": 0, "type": "number", "description": "Minimum number of bedrooms." }, "maxBeds": { "title": "Maximum bedrooms", "minimum": 0, "type": "number", "description": "Maximum number of bedrooms." }, "minBaths": { "title": "Minimum bathrooms", "minimum": 0, "type": "number", "description": "Minimum number of bathrooms, including half baths." }, "minSqft": { "title": "Minimum living area", "minimum": 0, "type": "number", "description": "Minimum living area in square feet." }, "maxSqft": { "title": "Maximum living area", "minimum": 0, "type": "number", "description": "Maximum living area in square feet." }, "minYearBuilt": { "title": "Built in or after", "minimum": 0, "type": "number", "description": "Earliest year the home was built." }, "maxYearBuilt": { "title": "Built in or before", "minimum": 0, "type": "number", "description": "Latest year the home was built." }, "maxHoa": { "title": "Maximum HOA fee", "minimum": 0, "type": "number", "description": "Maximum monthly HOA fee in US dollars." }, "minLotSize": { "title": "Minimum lot area", "minimum": 0, "type": "number", "description": "Minimum lot area in square feet." }, "maxLotSize": { "title": "Maximum lot area", "minimum": 0, "type": "number", "description": "Maximum lot area in square feet." }, "daysOnZillow": { "title": "Listed within days", "enum": [ "1", "7", "14", "30", "90", "182", "365", "730", "1095" ], "type": "string", "description": "Ask Zillow for listings added within this number of days." }, "soldInLastDays": { "title": "Sold within days", "enum": [ "1", "7", "14", "30", "90", "182", "365", "730", "1095" ], "type": "string", "description": "In the sold mode, ask Zillow for sales within this number of days." }, "hasPool": { "title": "Pool", "type": "boolean", "description": "Filter for a pool. Leave unset to keep the search defaults." }, "hasGarage": { "title": "Garage", "type": "boolean", "description": "Filter for a garage. Leave unset to keep the search defaults." }, "hasAirConditioning": { "title": "Air conditioning", "type": "boolean", "description": "Filter for air conditioning. Leave unset to keep the search defaults." }, "singleStory": { "title": "Single story", "type": "boolean", "description": "Filter for single-story homes. Leave unset to keep the search defaults." }, "newConstruction": { "title": "New construction", "type": "boolean", "description": "Include new construction listings. Leave unset to keep the search defaults." }, "foreclosure": { "title": "Foreclosures", "type": "boolean", "description": "Include foreclosure listings. Leave unset to keep the search defaults." }, "includePending": { "title": "Pending listings", "type": "boolean", "description": "Include pending or under-contract listings. Leave unset to keep the search defaults." }, "forSaleByOwner": { "title": "For sale by owner", "type": "boolean", "description": "Include listings offered by owners. Leave unset to keep the search defaults." }, "forSaleByAgent": { "title": "For sale by agent", "type": "boolean", "description": "Include listings offered by agents. Agent contact data is excluded from output. Leave unset to keep the search defaults." }, "has3DModel": { "title": "3D tour", "type": "boolean", "description": "Filter for a 3D home tour. Leave unset to keep the search defaults." }, "hasVideo": { "title": "Video", "type": "boolean", "description": "Keep listings with a video, using the public listing flag. This is checked after pages are read and may need more requests." }, "waterfront": { "title": "Waterfront", "type": "boolean", "description": "Filter for waterfront homes. Leave unset to keep the search defaults." }, "comingSoon": { "title": "Coming soon", "type": "boolean", "description": "Include coming-soon listings. Leave unset to keep the search defaults." }, "extractBuildingUnits": { "title": "Building output", "enum": [ "disabled", "available" ], "type": "string", "description": "For building URLs, return the building summary or the available apartments listed on that page. Each apartment lookup uses the property-check price. Reading a building page uses the search-page price.", "default": "disabled" }, "latitude": { "title": "Latitude", "type": "number", "description": "Center latitude for a map search. Supply longitude too." }, "longitude": { "title": "Longitude", "type": "number", "description": "Center longitude for a map search. Supply latitude too." }, "radiusMiles": { "title": "Radius in miles", "type": "number", "description": "Distance from the coordinates. Defaults to 5 miles." }, "petsAllowed": { "title": "Pets allowed", "type": "boolean", "description": "Apply the pets allowed Zillow filter. Leave unset to keep the search defaults." }, "largeDogsAllowed": { "title": "Large dogs allowed", "type": "boolean", "description": "Apply the large dogs allowed Zillow filter. Leave unset to keep the search defaults." }, "smallDogsAllowed": { "title": "Small dogs allowed", "type": "boolean", "description": "Apply the small dogs allowed Zillow filter. Leave unset to keep the search defaults." }, "catsAllowed": { "title": "Cats allowed", "type": "boolean", "description": "Apply the cats allowed Zillow filter. Leave unset to keep the search defaults." }, "noPets": { "title": "No pets", "type": "boolean", "description": "Apply the no pets Zillow filter. Leave unset to keep the search defaults." }, "rentalParking": { "title": "Rental parking available", "type": "boolean", "description": "Apply the rental parking available Zillow filter. Leave unset to keep the search defaults." }, "inUnitLaundry": { "title": "In-unit laundry", "type": "boolean", "description": "Apply the in-unit laundry Zillow filter. Leave unset to keep the search defaults." }, "furnished": { "title": "Furnished rentals", "type": "boolean", "description": "Apply the furnished rentals Zillow filter. Leave unset to keep the search defaults." }, "acceptsApplications": { "title": "Rentals accepting applications", "type": "boolean", "description": "Apply the rentals accepting applications Zillow filter. Leave unset to keep the search defaults." }, "incomeRestricted": { "title": "Income-restricted rentals", "type": "boolean", "description": "Apply the income-restricted rentals Zillow filter. Leave unset to keep the search defaults." }, "openHousesOnly": { "title": "Open houses only", "type": "boolean", "description": "Apply the open houses only Zillow filter. Leave unset to keep the search defaults." }, "hasBasement": { "title": "Basement", "type": "boolean", "description": "Apply the basement Zillow filter. Leave unset to keep the search defaults." }, "cityView": { "title": "City view", "type": "boolean", "description": "Apply the city view Zillow filter. Leave unset to keep the search defaults." }, "mountainView": { "title": "Mountain view", "type": "boolean", "description": "Apply the mountain view Zillow filter. Leave unset to keep the search defaults." }, "parkView": { "title": "Park view", "type": "boolean", "description": "Apply the park view Zillow filter. Leave unset to keep the search defaults." }, "waterView": { "title": "Water view", "type": "boolean", "description": "Apply the water view Zillow filter. Leave unset to keep the search defaults." }, "minParkingSpots": { "title": "Minimum parking spaces", "minimum": 0, "type": "number", "description": "Apply the minimum parking spaces filter in Zillow." }, "minSchoolRating": { "title": "Minimum school rating", "minimum": 0, "type": "number", "description": "Apply the minimum school rating filter in Zillow." }, "includeWalkScore": { "title": "Include walk, transit, and bike scores", "type": "boolean", "description": "Also read property details and public mobility scores when Zillow provides them. This takes an extra request per property.", "default": false }, "includeNearbyHomes": { "title": "Include nearby comparable homes", "type": "boolean", "description": "Also read property details and nearby comparable homes from Zillow valuation data. This takes an extra request per property.", "default": false }, "includeInvestorMetrics": { "title": "Add investor metrics (calculation)", "type": "boolean", "description": "Adds monthly cash flow, cap rate, cash-on-cash return, rent-to-price (the 1% rule), after-repair value (ARV) and the 70% rule offer to each row that has a price and a rent estimate. Calculated by this Actor from the row figures and the assumptions below, not by Zillow; an estimate, not financial advice. No extra charge. ARV uses nearby homes when Include nearby comparable homes is on, otherwise the Zestimate.", "default": false }, "investorDownPaymentPct": { "title": "Down payment, %", "minimum": 0, "maximum": 100, "type": "number", "description": "Share of the purchase price paid in cash, for example 25. 0 or empty uses 20." }, "investorInterestRatePct": { "title": "Mortgage rate, % a year", "minimum": 0, "maximum": 30, "type": "number", "description": "Fixed loan rate, for example 6.5. 0 or empty uses the 30-year fixed rate Zillow shows for the home, or 7 when it shows none." }, "investorLoanTermYears": { "title": "Loan term, years", "minimum": 0, "maximum": 50, "type": "integer", "description": "Loan length in years, for example 30. 0 or empty uses 30." }, "investorPropertyTaxRatePct": { "title": "Property tax, % of price a year", "minimum": 0, "maximum": 10, "type": "number", "description": "For example 1.2. 0 or empty uses the tax rate Zillow shows, then the listing annual tax, then 1.1." }, "investorInsuranceAnnual": { "title": "Insurance, $ a year", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "For example 1800. 0 or empty uses 0.35% of the price." }, "investorOperatingExpensePct": { "title": "Operating expenses, % of rent", "minimum": 0, "maximum": 100, "type": "integer", "description": "Vacancy, repairs, management and reserves as a share of monthly rent, for example 30. 0 or empty uses 30." }, "investorRepairCost": { "title": "Repair budget, $", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Repairs you expect to pay for, for example 20000. It is added to the cash you put in and subtracted from the 70% rule offer. 0 or empty means none." }, "investorMaoPct": { "title": "Offer rule, % of ARV", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum offer as a share of the after-repair value, for example 70. 0 or empty uses 70." }, "datasetId": { "title": "Dataset ID with earlier results", "type": "string", "description": "Optional. The ID of a Dataset from an earlier run of this Actor that you own, for example Dg1x2y3z4a5b6c7d8. The Actor reads the zpid, property URL or address of each row and runs a property check for it, as in Get property details mode. Search inputs are ignored. Property IDs, URLs and addresses you fill in above are checked too. At most 10000 rows are read, and Maximum results limits the checks. Each property check uses the property-check price. Errors: INVALID_DATASET_ID, DATASET_NOT_FOUND, DATASET_HAS_NO_PROPERTIES (nothing is charged)." }, "deliveryConnector": { "title": "Send results to (optional)", "type": "string", "description": "Your Slack, Notion or other MCP connector. After the run the Actor posts a short summary there. Connect services once in Apify Console → MCP connectors." }, "deliveryTarget": { "title": "Notion page or channel (optional)", "type": "string", "description": "Where to post the summary: a Notion page link (each run is added on top of that page) or a Slack channel ID. Leave empty to let the connector decide." } } }, "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 } } } } } } } } } }