{ "openapi": "3.0.1", "info": { "title": "Zillow Explorer", "description": "💫 Scrape Zillow.com Homes", "version": "0.9", "x-build-id": "xQd3E9dLJk7runsK4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jupri~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jupri-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/jupri~zillow-scraper/runs": { "post": { "operationId": "runs-sync-jupri-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/jupri~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-jupri-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": { "query": { "title": "✨ Query", "type": "string", "description": "💡 Acceptable Values :
  • search-url (example: https://www.zillow.com/new-york-ny/?searchQueryState=PARAMETERS [please copy and paste complete URL]
  • Semantic search will autofill appropriate parameters.

    • examples :
    \"Homes with +2 bedrooms and 1-3 bathrooms under $500K in Alaska\"" }, "prompt": { "title": "✨ Prompt", "type": "string", "description": "DEPRECATED" }, "example": { "title": "💡 Examples", "enum": [ "Homes with 3 beds in Alaska under 500K", "3327 Wentworth St, Anchorage, AK 99508", "@29777156", "https://www.zillow.com/homedetails/339-E-140th-St-Bronx-NY-10454/29777156_zpid/", "building:1008258738", "building:5Yv4qx", "https://www.zillow.com/apartments/dallas-tx/cedar-at-the-branch/CkBQbf/", "https://www.zillow.com/ak/sold/?searchQueryState=%7B%22isMapVisible%22%3Atrue%2C%22mapBounds%22%3A%7B%22north%22%3A79.74929748420723%2C%22south%22%3A24.60382683760046%2C%22east%22%3A-127.08884375%2C%22west%22%3A-179.999%7D%2C%22filterState%22%3A%7B%22sort%22%3A%7B%22value%22%3A%22globalrelevanceex%22%7D%2C%22fsba%22%3A%7B%22value%22%3Afalse%7D%2C%22fsbo%22%3A%7B%22value%22%3Afalse%7D%2C%22nc%22%3A%7B%22value%22%3Afalse%7D%2C%22cmsn%22%3A%7B%22value%22%3Afalse%7D%2C%22auc%22%3A%7B%22value%22%3Afalse%7D%2C%22fore%22%3A%7B%22value%22%3Afalse%7D%2C%22rs%22%3A%7B%22value%22%3Atrue%7D%2C%22baths%22%3A%7B%22min%22%3A2%7D%2C%22beds%22%3A%7B%22min%22%3A3%7D%7D%2C%22isListVisible%22%3Atrue%2C%22listPriceActive%22%3Atrue%2C%22category%22%3A%22cat1%22%2C%22usersSearchTerm%22%3A%22alaska%22%2C%22regionSelection%22%3A%5B%7B%22regionId%22%3A3%2C%22regionType%22%3A2%7D%5D%2C%22mapZoom%22%3A4%7D" ], "type": "string", "description": "💡 QUERY input examples" }, "location": { "title": "🧭 Location", "type": "array", "description": "💡 Acceptable Values :
  • LOCATION City, ZIP-Code, State, etc. (multi-region limited to max 20 locations allowed by Zillow)
  • ADDRESS more than 20 address is allowed.
  • @ZPID (example: @123456789)
    • ", "items": { "type": "string" } }, "search_type": { "title": "🔎 Search Type", "enum": [ "sale", "rent", "sold" ], "type": "string", "description": "" }, "limit": { "title": "Limit", "type": "integer", "description": "💡 Limit number of results" }, "sort": { "title": "Sorting", "enum": [ "relevance", "change", "newest", "price_high", "price_low", "beds", "baths", "living_area", "lot_area", "year_built", "featured" ], "type": "string", "description": "💡 Sorting key" }, "category": { "title": "Listing Type", "enum": [ "all", "agent", "other" ], "type": "string", "description": "" }, "keywords": { "title": "Keywords", "type": "string", "description": "example: MLS#, fireplace, horses" }, "min_days": { "title": "Min. Days on Zillow", "type": "integer", "description": "" }, "max_days": { "title": "Max. Days on Zillow / Sold in Last (days)", "type": "integer", "description": "" }, "types": { "title": "Home Types", "type": "array", "description": "", "items": { "type": "string", "enum": [ "singleFamily", "apartment", "multiFamily", "land", "townhome", "condo", "manufactured" ], "enumTitles": [ "Houses", "Apartments", "Multi-family", "Land/Lots", "Townhomes", "Condos/Co-ops", "Manufactured" ] } }, "min_built": { "title": "Year Built", "type": "integer", "description": "" }, "max_built": { "title": "", "type": "integer", "description": "" }, "status": { "title": "Listing Type", "type": "array", "description": "", "items": { "type": "string", "enum": [ "fsba", "fsbo", "newConstruction", "auction", "foreclosure", "foreclosed", "preforeclosure", "comingSoon", "acceptingBackupOffers", "pending", "no_seniorCommunity" ], "enumTitles": [ "Agent Listed", "Owner Posted", "New Construction", "Auctions", "Foreclosure", "Foreclosed", "Pre-Foreclosure", "Coming Soon", "Accepting Backup Offers", "Pending & Under Contract", "Hide 55+ communities" ] } }, "min_beds": { "title": "Bedrooms", "enum": [ "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "" }, "min_baths": { "title": "Bathrooms", "enum": [ "0", "1", "1.5", "2", "3", "4" ], "type": "string", "description": "" }, "min_parking": { "title": "Parking Spots", "enum": [ "0", "1", "2", "3", "4" ], "type": "string", "description": "" }, "basement": { "title": "Basement", "type": "array", "description": "", "items": { "type": "string", "enum": [ "finished", "unfinished", "partial", "none" ], "enumTitles": [ "Finished", "Unfinished", "Partial", "No-Basement" ] } }, "amenities:singleStory": { "title": "Single-story Home", "type": "boolean", "description": "" }, "amenities:garage": { "title": "Has Garage", "type": "boolean", "description": "" }, "amenities:haveAirConditioning": { "title": "Must have A/C", "type": "boolean", "description": "" }, "amenities:havePool": { "title": "Must have Pool", "type": "boolean", "description": "" }, "amenities:onWaterfront": { "title": "Waterfront", "type": "boolean", "description": "" }, "amenities:openHouses": { "title": "Open Houses", "type": "boolean", "description": "" }, "amenities:approvedVirtualTour": { "title": "3D Tours", "type": "boolean", "description": "" }, "amenities:showCase": { "title": "Showcase", "type": "boolean", "description": "💡 Showcase is an Al-powered premium listing experience only available on Zillow. Showcase listings feature HD photos, grouped by room, that are designed to give you a deeper understanding of this home virtually before you ever step inside." }, "views": { "title": "Views", "type": "array", "description": "", "items": { "type": "string", "enum": [ "mountain", "city", "water", "park", "territorial" ], "enumTitles": [ "Mountain", "City", "Water", "Park", "Territorial" ] } }, "min_area": { "title": "Living Area (sqft)", "type": "integer", "description": "" }, "max_area": { "title": "", "type": "integer", "description": "" }, "min_lot": { "title": "Lot Size (sqft)", "type": "integer", "description": "" }, "max_lot": { "title": "", "type": "integer", "description": "" }, "rentalspace": { "title": "Rental Space", "enum": [ "place", "room", "all" ], "type": "string", "description": "" }, "rentaldate": { "title": "Move-in Date", "type": "string", "description": "Available on or before this date (YYYY-MM-DD)" }, "hide_no_date": { "title": "Hide listings with no date provided", "type": "boolean", "description": "" }, "amenities:cats": { "title": "Allows Cats", "type": "boolean", "description": "" }, "amenities:smallDogs": { "title": "Allows Small Dogs", "type": "boolean", "description": "" }, "amenities:largeDogs": { "title": "Allows Big Dogs", "type": "boolean", "description": "" }, "amenities:noPetsAllowed": { "title": "No Pets", "type": "boolean", "description": "" }, "amenities:parkingAvailable": { "title": "On-Site Parking", "type": "boolean", "description": "" }, "amenities:laundryAvailable": { "title": "In-Unit Laundry", "type": "boolean", "description": "" }, "amenities:incomeRestricted": { "title": "Income Restricted", "type": "boolean", "description": "" }, "amenities:areApplicationsAccepted": { "title": "Accept Zillow Application", "type": "boolean", "description": "" }, "amenities:hasHardwoodFloor": { "title": "Hardwood Floors", "type": "boolean", "description": "" }, "amenities:hasDisabledAccess": { "title": "Disabled Access", "type": "boolean", "description": "" }, "amenities:areUtilitiesIncluded": { "title": "Utilities Included", "type": "boolean", "description": "" }, "amenities:shortTermLease": { "title": "Short-Term List Available", "type": "boolean", "description": "" }, "amenities:furnished": { "title": "Furnished", "type": "boolean", "description": "" }, "amenities:outdoorSpace": { "title": "Outdoor Space", "type": "boolean", "description": "" }, "amenities:controlledAccess": { "title": "Controlled Access", "type": "boolean", "description": "" }, "amenities:highSpeedInternetAvailable": { "title": "High Speed Internet", "type": "boolean", "description": "" }, "amenities:elevatorAccess": { "title": "Elevator", "type": "boolean", "description": "" }, "amenities:isFeaturedListing": { "title": "Appartment Community", "type": "boolean", "description": "" }, "price_mode": { "title": "Price Mode", "enum": [ "list", "month" ], "type": "string", "description": "" }, "min_price": { "title": "Price", "type": "integer", "description": "" }, "max_price": { "title": "", "type": "integer", "description": "" }, "down_payment": { "title": "Down Payment", "type": "integer", "description": "Monthly payment only" }, "filters:priceReduction": { "title": "Price Drop", "type": "boolean", "description": "" }, "max_hoa": { "title": "Max. HOA Fee", "type": "integer", "description": "Per Month" }, "no_hoa": { "title": "No HOA Fee", "type": "boolean", "description": "Overides max_hoa" }, "show_no_hoa": { "title": "Show no HOA homes", "type": "boolean", "description": "Includes homes with no HOA data" }, "map_viewer": { "title": "Enable", "type": "boolean", "description": "" }, "scanonly": { "title": "Enable", "type": "boolean", "description": "💡 Scan Only function allow you to search up to 50_000 property, but only with basic info and no Additional Info (\"includes\" parameters will be ignored)" }, "noboundary": { "title": "Remove Boundary", "type": "boolean", "description": "💡 Enabling this will includes properties outside specified regions (location)." }, "includes:description": { "title": "Description", "type": "boolean", "description": "" }, "includes:homeInsights": { "title": "Home Insights", "type": "boolean", "description": "" }, "includes:resoFacts": { "title": "Features & Facts", "type": "boolean", "description": "" }, "includes:foreClosure": { "title": "Foreclosure Info", "type": "boolean", "description": "" }, "includes:attributionInfo": { "title": "Attribution Info", "type": "boolean", "description": "" }, "includes:priceHistory": { "title": "Price History", "type": "boolean", "description": "" }, "includes:taxHistory": { "title": "Tax History", "type": "boolean", "description": "" }, "includes:schools": { "title": "Nearby Schools", "type": "boolean", "description": "" }, "includes:tourEligibility": { "title": "Tour Eligibility", "type": "boolean", "description": "" }, "includes:localProtections": { "title": "Local Protections", "type": "boolean", "description": "" }, "includes:walkScores": { "title": "Walkscores", "type": "boolean", "description": "" }, "includes:photos": { "title": "Photos & Media", "enum": [ "", "1", "2", "3", "4", "5", "6", "7" ], "type": "string", "description": "💡 Images quality/resolution." }, "includes:valueHistory": { "title": "Value History", "enum": [ "LOCAL_HOME_VALUES", "LISTING_PRICE", "LOCAL_RENTAL_RATES", "ZESTIMATE_PERCENT_CHANGE", "TAX_ASSESSMENT", "TAX_PAID" ], "type": "string", "description": "💡 Value / Zestimates History" }, "includes:valuePeriod": { "title": "", "enum": [ "ONE_YEAR", "FIVE_YEARS", "TEN_YEARS" ], "type": "string", "description": "" }, "dev_proxy_config": { "title": "🌐 PROXY NETWORKING", "type": "object", "description": "💡 Supported protocol:

    HTTP(S), SOCKS5
    {http|socks5}://{user:pass}@{hostname|ip-address}:port

    Example: socks5://example.com:9000" }, "dev_custom_headers": { "title": "📜 HTTP HEADERS", "type": "array", "description": "💡 Additional HTTP Headers", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_custom_cookies": { "title": "🍰 HTTP COOKIES", "type": "array", "description": "💡 Additional HTTP Cookies", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_transform_fields": { "title": "♻️ CUSTOM FIELD", "type": "array", "description": "💡 Transform the resulting output. Select only needed fields.

    For nested object use DOT. For example: 
    address.streetAddress

    For nested array use NUMBER (index of array element starting from index=0). For example: 
    images.0.url
    ", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_dataset_name": { "title": "📁 CUSTOM STORAGE", "type": "string", "description": "💡 Save results into custom named Dataset, use mask to customize dataset name

    {ACTOR} = actor name
    {DATE} = date (YYYYMMDD)
    {TIME} = time (HHMMSS)

    This masks can be used to autogenerate Dataset Name.

    example: data-{DATE}
    Depending on today date the dataset name will be: data-20230603

    default: data-{ACTOR}-{DATE}-{TIME}    " }, "dev_dataset_clear": { "title": "Clear Storage", "type": "boolean", "description": "Clear Dataset before insert/update." }, "dev_no_strip": { "title": "Disable data cleansing", "type": "boolean", "description": "💡 Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)" } } }, "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 } } } } } } } } } }