{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper: Listings, Zestimate, Agents & Deal Analysis", "description": "Scrape Zillow for-sale, sold, and rental listings by city, ZIP, URL, or ZPID. Get prices, Zestimate, agent contacts, photos, and property history, plus built-in deal analysis: cap rate, cash flow, seller equity, and pre-foreclosure signals. Advanced filters and listing change monitoring included.", "version": "0.3", "x-build-id": "sXvGiCAQmgDRkUUDP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/trakk~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-trakk-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/trakk~zillow-scraper/runs": { "post": { "operationId": "runs-sync-trakk-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/trakk~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-trakk-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": "๐ŸŽฏ What do you want to collect?", "enum": [ "SEARCH", "SEARCH_DETAILS", "DEALS", "DETAIL" ], "type": "string", "description": "Choose Search for quick listing cards, Search + details for complete property records, Deals for investment analysis, or Detail for properties you already know.", "default": "SEARCH" }, "propertyStatus": { "title": "๐Ÿท๏ธ Listing status", "enum": [ "ANY", "FOR_SALE", "SOLD", "FOR_RENT" ], "type": "string", "description": "Choose the Zillow market you want to search. In Detail mode this is only recorded as the expected status; a successfully fetched property is never discarded because of it.", "default": "FOR_SALE" }, "searchQueries": { "title": "๐Ÿ“ Locations or Zillow search URLs", "type": "array", "description": "Used by Search, Search + details, and Deals. Add a city, ZIP code, neighborhood, Zillow region slug, or full Zillow search URL. Each row starts a separate search.", "default": [ "Sonoma, CA" ], "items": { "type": "string" } }, "startUrls": { "title": "๐Ÿ”— Zillow property URLs", "type": "array", "description": "Used only in Detail mode. Add one or more Zillow property pages. You can combine URLs with ZPIDs and an input dataset below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "zpids": { "title": "๐Ÿ”ข Zillow property IDs (ZPIDs)", "type": "array", "description": "Optional 5โ€“10 digit Zillow property IDs, for example 15800416. Each valid ID is resolved to its property page automatically.", "default": [], "items": { "type": "string" } }, "datasetId": { "title": "๐Ÿ“ฆ Input dataset from a previous run", "type": "string", "description": "Optional dataset produced by a previous Search run. Items should contain zpid, detailUrl, hdpUrl, or url." }, "maxPagesPerSearch": { "title": "๐Ÿ“„ Search depth per location", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum Zillow result pages collected for each location. API key: maxPagesPerSearch; maxPages is unsupported and produces a warning. The run summary reports page/source caps separately from saved-result limits.", "default": 1 }, "maxResults": { "title": "๐ŸŽ Maximum saved results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Global limit after duplicate removal, filtering, and sorting. This is the maximum number of paid rows saved to Results.", "default": 50 }, "maxDetailUrls": { "title": "โœจ Maximum full-detail properties", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Caps unique properties whose full details may be requested, including failed attempts and filter enrichment. Use 0 for the automatic safety cap. It normally equals maxResults; large unfiltered Search + details runs may use up to 10% bounded recovery headroom. The effective cap is reported in OUTPUT.", "default": 0 }, "propertyType": { "title": "๐Ÿก Property type", "enum": [ "ANY", "HOUSE", "CONDO", "TOWNHOUSE", "MULTI_FAMILY", "MANUFACTURED", "LOT_LAND", "APARTMENT" ], "type": "string", "description": "Keep only one Zillow property category, or leave Any selected.", "default": "ANY" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Keep properties priced at or above this amount." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Keep properties priced at or below this amount." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "number", "description": "Minimum number of bedrooms." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "type": "number", "description": "Maximum number of bedrooms." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "type": "number", "description": "Minimum number of bathrooms. Decimal values such as 1.5 are supported." }, "maxBathrooms": { "title": "Maximum bathrooms", "minimum": 0, "type": "number", "description": "Maximum number of bathrooms." }, "advancedFilters": { "title": "๐Ÿ”Ž More property filters", "type": "object", "description": "Open this only when you need size, lot, build year, HOA, listing age, photo, open-house, or price-cut filters.", "properties": { "minLivingArea": { "title": "Minimum living area", "type": "number", "description": "Keep properties with at least this much interior space.", "minimum": 0, "unit": "sq ft" }, "maxLivingArea": { "title": "Maximum living area", "type": "number", "description": "Keep properties with no more than this much interior space.", "minimum": 0, "unit": "sq ft" }, "minLotSize": { "title": "Minimum lot size", "type": "number", "description": "Minimum lot area in square feet.", "minimum": 0, "unit": "sq ft" }, "maxLotSize": { "title": "Maximum lot size", "type": "number", "description": "Maximum lot area in square feet.", "minimum": 0, "unit": "sq ft" }, "minYearBuilt": { "title": "Oldest build year", "type": "integer", "description": "Earliest construction year to keep.", "minimum": 1700, "maximum": 2100 }, "maxYearBuilt": { "title": "Newest build year", "type": "integer", "description": "Latest construction year to keep.", "minimum": 1700, "maximum": 2100 }, "hoaStatus": { "title": "HOA preference", "type": "string", "description": "Include all properties, only properties with HOA fees, or only properties with no reported fee.", "editor": "select", "default": "ANY", "enum": [ "ANY", "WITH_HOA", "NO_HOA" ], "enumTitles": [ "Any HOA status", "Only with an HOA fee", "Only with no reported HOA fee" ] }, "minHoaFee": { "title": "Minimum monthly HOA fee", "type": "number", "description": "Minimum reported monthly HOA fee.", "minimum": 0, "unit": "USD / month" }, "maxHoaFee": { "title": "Maximum monthly HOA fee", "type": "number", "description": "Maximum reported monthly HOA fee.", "minimum": 0, "unit": "USD / month" }, "minDaysOnZillow": { "title": "Minimum days on Zillow", "type": "integer", "description": "Minimum number of days the listing has been visible.", "minimum": 0, "unit": "days" }, "maxDaysOnZillow": { "title": "Maximum days on Zillow", "type": "integer", "description": "Maximum number of days the listing has been visible.", "minimum": 0, "unit": "days" }, "onlyWithPhotos": { "title": "Require listing photos", "type": "boolean", "description": "Exclude listings with no published image or photo collection.", "default": false }, "onlyOpenHouses": { "title": "Require an open house", "type": "boolean", "description": "Keep only listings that advertise an open house.", "default": false }, "onlyPriceReductions": { "title": "Require a price reduction", "type": "boolean", "description": "Keep only listings with a detected price cut.", "default": false } } }, "minLivingArea": { "title": "Minimum living area", "minimum": 0, "type": "number", "description": "Minimum interior living area in square feet." }, "maxLivingArea": { "title": "Maximum living area", "minimum": 0, "type": "number", "description": "Maximum interior living area in square feet." }, "minLotSize": { "title": "Minimum lot size", "minimum": 0, "type": "number", "description": "Minimum lot size in square feet." }, "maxLotSize": { "title": "Maximum lot size", "minimum": 0, "type": "number", "description": "Maximum lot size in square feet." }, "minYearBuilt": { "title": "Oldest build year", "minimum": 1700, "maximum": 2100, "type": "integer", "description": "Oldest construction year to keep. Missing years are enriched from property details when this filter is active." }, "maxYearBuilt": { "title": "Newest build year", "minimum": 1700, "maximum": 2100, "type": "integer", "description": "Newest construction year to keep." }, "hoaStatus": { "title": "๐Ÿ˜๏ธ HOA preference", "type": "string", "description": "Include every property, only properties with a positive monthly HOA fee, or properties with no reported HOA fee.", "default": "ANY" }, "minHoaFee": { "title": "Minimum monthly HOA fee", "minimum": 0, "type": "number", "description": "Minimum reported monthly HOA fee. Properties with missing HOA values are excluded while this range is active." }, "maxHoaFee": { "title": "Maximum monthly HOA fee", "minimum": 0, "type": "number", "description": "Maximum reported monthly HOA fee." }, "minDaysOnZillow": { "title": "Minimum days on Zillow", "minimum": 0, "type": "integer", "description": "Keep listings visible on Zillow for at least this many days." }, "maxDaysOnZillow": { "title": "Maximum days on Zillow", "minimum": 0, "type": "integer", "description": "Keep listings visible on Zillow for no more than this many days." }, "onlyWithPhotos": { "title": "๐Ÿ“ธ Require listing photos", "type": "boolean", "description": "Exclude properties without a listing image or photo collection.", "default": false }, "onlyOpenHouses": { "title": "๐Ÿšช Require an open house", "type": "boolean", "description": "Keep only listings currently advertising an open house.", "default": false }, "onlyPriceReductions": { "title": "๐Ÿ“‰ Require a price reduction", "type": "boolean", "description": "Keep only listings with a detected price cut.", "default": false }, "analyzeDeals": { "title": "๐Ÿ“Š Analyze deals", "type": "boolean", "description": "Add an analysis block to every property: rental yield, cap rate, monthly cash flow, seller equity and distress signals such as pre-foreclosure or an absentee owner. Computed from data already on the listing page, so it costs no extra requests. Needs full property data โ€” use Deals, Search + details or Detail mode, not the fast Search mode. Always on in Deals mode.", "default": false }, "dealSettings": { "title": "๐Ÿงฎ Assumptions & deal filters", "type": "object", "description": "Optional underwriting assumptions and filters for distressed, absentee-owner, below-Zestimate, cash-flow, and motivated-seller opportunities.", "properties": { "downPaymentPct": { "title": "Down payment %", "type": "integer", "description": "Share of the purchase price paid up front.", "default": 25, "minimum": 0, "maximum": 100, "unit": "%" }, "interestRatePct": { "title": "Mortgage interest rate %", "type": "string", "description": "Optional rate override; leave empty to use the available source rate or the analysis fallback.", "editor": "textfield" }, "loanTermYears": { "title": "Loan term", "type": "integer", "description": "Mortgage length used by the payment calculation.", "default": 30, "minimum": 1, "maximum": 50, "unit": "years" }, "vacancyPct": { "title": "Vacancy allowance %", "type": "integer", "description": "Share of annual rent reserved for vacant periods.", "default": 5, "minimum": 0, "maximum": 50, "unit": "%" }, "maintenancePct": { "title": "Maintenance allowance %", "type": "integer", "description": "Share of annual rent reserved for repairs and management.", "default": 5, "minimum": 0, "maximum": 50, "unit": "%" }, "insuranceRatePct": { "title": "Insurance rate %", "type": "string", "description": "Optional annual insurance estimate as a percentage of price.", "editor": "textfield" }, "closingCostPct": { "title": "Closing costs %", "type": "integer", "description": "Transaction costs included in cash-invested calculations.", "default": 3, "minimum": 0, "maximum": 20, "unit": "%" }, "onlyDistressed": { "title": "Only distressed properties", "type": "boolean", "description": "Keep pre-foreclosure, auction, or bank-owned properties only.", "default": false }, "onlyNonOwnerOccupied": { "title": "Only absentee owners", "type": "boolean", "description": "Keep properties marked as non-owner-occupied only.", "default": false }, "onlyPriceReducedDeals": { "title": "Only properties with a price cut", "type": "boolean", "description": "Keep analyzed properties with a detected price reduction only.", "default": false }, "onlyComingSoon": { "title": "Only coming-soon listings", "type": "boolean", "description": "Keep properties marked as coming soon only.", "default": false }, "maxPriceVsZestimatePct": { "title": "Maximum price versus Zestimate %", "type": "string", "description": "For example, -10 keeps properties priced at least 10% below Zestimate.", "editor": "textfield" }, "minCapRatePct": { "title": "Minimum cap rate %", "type": "string", "description": "Minimum calculated cap rate required for a property to pass.", "editor": "textfield" }, "minMonthlyCashFlowUsd": { "title": "Minimum monthly cash flow ($)", "type": "string", "description": "Minimum calculated monthly cash flow required to pass.", "editor": "textfield" }, "minMotivatedSellerScore": { "title": "Minimum motivated-seller score", "type": "string", "description": "Minimum seller-motivation score from 0 to 100.", "editor": "textfield" } } }, "downPaymentPct": { "title": "Down payment %", "minimum": 0, "maximum": 100, "type": "integer", "description": "Share of the purchase price paid up front. Drives the loan amount, the monthly payment and cash-on-cash return.", "default": 25 }, "interestRatePct": { "title": "Mortgage interest rate %", "type": "string", "description": "Leave empty to use the live 30-year fixed rate Zillow publishes on the listing page. Set a value to override it with your own quote." }, "loanTermYears": { "title": "Loan term (years)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Length of the mortgage used for the payment calculation.", "default": 30 }, "vacancyPct": { "title": "Vacancy allowance %", "minimum": 0, "maximum": 50, "type": "integer", "description": "Share of annual rent lost to empty months.", "default": 5 }, "maintenancePct": { "title": "Maintenance allowance %", "minimum": 0, "maximum": 50, "type": "integer", "description": "Share of annual rent set aside for repairs and management.", "default": 5 }, "insuranceRatePct": { "title": "Insurance rate %", "type": "string", "description": "Annual insurance cost as a percentage of the purchase price. The 0.35% default is a common US rule of thumb." }, "closingCostPct": { "title": "Closing costs %", "minimum": 0, "maximum": 20, "type": "integer", "description": "One-off transaction costs added to the cash invested when computing cash-on-cash return.", "default": 3 }, "onlyDistressed": { "title": "๐Ÿฆ Only distressed properties", "type": "boolean", "description": "Keep only pre-foreclosure, auction or bank-owned properties.", "default": false }, "onlyNonOwnerOccupied": { "title": "๐Ÿš๏ธ Only absentee owners", "type": "boolean", "description": "Keep only properties where Zillow marks the owner as not living there โ€” statistically the most negotiable sellers.", "default": false }, "onlyPriceReducedDeals": { "title": "๐Ÿ“‰ Only properties with a price cut", "type": "boolean", "description": "Keep only properties whose asking price has been reduced.", "default": false }, "onlyComingSoon": { "title": "โฐ Only coming-soon listings", "type": "boolean", "description": "Keep only properties announced but not yet on the market, so you can reach the seller before the crowd.", "default": false }, "maxPriceVsZestimatePct": { "title": "Maximum price versus Zestimate %", "type": "string", "description": "Keep only properties priced at or below this gap to their Zestimate. Enter -15 for at least 15% below the estimate. Properties without a Zestimate are excluded." }, "minCapRatePct": { "title": "Minimum cap rate %", "type": "string", "description": "Keep only properties whose net operating income divided by price reaches this level. Properties without a rent estimate are excluded." }, "minMonthlyCashFlowUsd": { "title": "Minimum monthly cash flow ($)", "type": "string", "description": "Keep only properties whose rent covers the mortgage and running costs by at least this much each month." }, "minMotivatedSellerScore": { "title": "Minimum motivated-seller score", "type": "string", "description": "Keep only properties scoring at least this much on the 0-100 seller-motivation scale built from distress flags, price cuts, days on market and the gap to the Zestimate." }, "sortBy": { "title": "โ†•๏ธ Sort saved results by", "enum": [ "RELEVANCE", "PRICE_ASC", "PRICE_DESC", "BEDROOMS_DESC", "BATHROOMS_DESC", "LIVING_AREA_DESC", "LOT_SIZE_DESC", "YEAR_BUILT_DESC", "NEWEST", "PRICE_REDUCTION_DESC" ], "type": "string", "description": "Custom sorting examines candidates from all loaded pages within the detail limit, then applies maxResults. Search + details and Deal Finder use full property values and may fetch more properties than they save. Relevance stops once enough matching rows are saved. Sorting does not cover unloaded Zillow pages.", "default": "RELEVANCE" }, "maxConcurrency": { "title": "โšก Parallel requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "Number of requests processed at the same time. The default balances speed and reliability.", "default": 5 }, "maxRetries": { "title": "๐Ÿ” General retry attempts", "minimum": 0, "maximum": 15, "type": "integer", "description": "Retry budget for a temporary source error. Production runs safely cap legacy higher values.", "default": 1 }, "maxProxyRetries": { "title": "๐ŸŒ Connection retry attempts", "minimum": 1, "maximum": 15, "type": "integer", "description": "Separate bounded retry budget for temporary connection failures.", "default": 2 }, "maxCaptchaRetries": { "title": "๐Ÿ›ก๏ธ Access retry attempts", "minimum": 1, "maximum": 15, "type": "integer", "description": "Separate bounded retry budget when Zillow temporarily interrupts access.", "default": 2 }, "proxy": { "title": "๐ŸŒŽ Connection settings", "type": "object", "description": "US residential access is preconfigured and recommended because Zillow data is region-sensitive. The default is ready to use.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "rawOutput": { "title": "๐Ÿงพ Include raw source payload", "type": "boolean", "description": "Add the original source payload under _raw in Detail and Search + details outputs. Most users should leave this disabled.", "default": false } } }, "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 } } } } } } } } } }