{ "openapi": "3.0.1", "info": { "title": "Zillow Property Data Scraper", "description": "Scrape Zillow listings into structured data: price, beds/baths, Zestimate, rent estimate, days on Zillow, photos, agent & MLS info + 50 more fields. Paste any search URL, or just pick a location and set filters like on Zillow. Fast API-based scraping. Free trial.", "version": "1.2", "x-build-id": "4FKKl7bgm2De7qr15" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/delicious_zebu~zillow-property-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-delicious_zebu-zillow-property-data-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/delicious_zebu~zillow-property-data-scraper/runs": { "post": { "operationId": "runs-sync-delicious_zebu-zillow-property-data-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/delicious_zebu~zillow-property-data-scraper/run-sync": { "post": { "operationId": "run-sync-delicious_zebu-zillow-property-data-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": { "searchLinks": { "title": "Zillow Search Links", "type": "array", "description": "One or more Zillow search result URLs (e.g., https://www.zillow.com/homes/Miami,-FL_rb/). Any listing page works, including filtered searches with searchQueryState.", "items": { "type": "string" } }, "forSaleLocations": { "title": "Locations", "type": "array", "description": "Address, neighborhood, city, or ZIP — same as Zillow's search box (e.g. \"Miami, FL\", \"90210\").", "items": { "type": "string" } }, "forSaleListingTypes": { "title": "Listing type", "type": "array", "description": "Zillow's \"Listing type\" checkboxes. \"Foreclosed\" and \"Pre-foreclosures\" are hidden under \"Show more\" on Zillow and off by default.", "items": { "type": "string", "enum": [ "Owner posted", "Agent listed", "New construction", "Foreclosures", "Auctions", "Foreclosed", "Pre-foreclosures" ], "enumTitles": [ "Owner posted", "Agent listed", "New construction", "Foreclosures", "Auctions", "Foreclosed", "Pre-foreclosures" ] }, "default": [ "Owner posted", "Agent listed", "New construction", "Foreclosures", "Auctions" ] }, "forSalePriceMin": { "title": "Price: Min", "minimum": 0, "type": "integer", "description": "Minimum price in USD." }, "forSalePriceMax": { "title": "Price: Max", "minimum": 0, "type": "integer", "description": "Maximum price in USD." }, "forSaleBedroomsMin": { "title": "Bedrooms", "enum": [ "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Minimum bedrooms, same as Zillow's \"Beds & baths\" filter.", "default": "0" }, "forSaleBathroomsMin": { "title": "Bathrooms", "enum": [ "0", "1", "1.5", "2", "3", "4" ], "type": "string", "description": "Minimum bathrooms, same as Zillow's \"Beds & baths\" filter.", "default": "0" }, "forSaleHomeTypes": { "title": "Home Type", "type": "array", "description": "Same as Zillow's \"Property type\" filter. All types included by default — untick the ones you don't want.", "items": { "type": "string", "enum": [ "Houses", "Townhomes", "Multi-family", "Condos/Co-ops", "Lots/Land", "Apartments", "Manufactured" ], "enumTitles": [ "Houses", "Townhomes", "Multi-family", "Condos/Co-ops", "Lots/Land", "Apartments", "Manufactured" ] }, "default": [ "Houses", "Townhomes", "Multi-family", "Condos/Co-ops", "Lots/Land", "Apartments", "Manufactured" ] }, "forSaleMaxHoa": { "title": "Max HOA", "enum": [ "any", "0", "50", "100", "200", "300", "400", "500", "600", "700", "800", "900", "1000", "1500", "2000" ], "type": "string", "description": "Maximum monthly HOA fee, same options as Zillow.", "default": "any" }, "forSaleParkingSpotsMin": { "title": "Parking spots", "enum": [ "0", "1", "2", "3", "4" ], "type": "string", "description": "Minimum parking spots.", "default": "0" }, "forSaleMustHaveGarage": { "title": "Must have garage", "type": "boolean", "description": "Only listings with a garage.", "default": false }, "forSaleSquareFeetMin": { "title": "Square feet: Min", "minimum": 0, "type": "integer", "description": "Minimum living area (sqft)." }, "forSaleSquareFeetMax": { "title": "Square feet: Max", "minimum": 0, "type": "integer", "description": "Maximum living area (sqft)." }, "forSaleLotSizeMin": { "title": "Lot size: Min (sqft)", "minimum": 0, "type": "integer", "description": "Minimum lot size in sqft (1 acre = 43,560)." }, "forSaleLotSizeMax": { "title": "Lot size: Max (sqft)", "minimum": 0, "type": "integer", "description": "Maximum lot size in sqft." }, "forSaleYearBuiltMin": { "title": "Year built: Min", "minimum": 0, "type": "integer", "description": "Earliest construction year." }, "forSaleYearBuiltMax": { "title": "Year built: Max", "minimum": 0, "type": "integer", "description": "Latest construction year." }, "forSaleDaysOnZillow": { "title": "Days on Zillow", "enum": [ "any", "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "Only listings posted within this window — great for monitoring new listings.", "default": "any" }, "forSaleMustHaveOpenHouse": { "title": "Must have open house", "type": "boolean", "description": "Only listings with a scheduled open house (Zillow's Tours filter).", "default": false }, "forSaleMustHave3DTour": { "title": "Must have 3D Tour", "type": "boolean", "description": "Only listings with a 3D tour (Zillow's Tours filter).", "default": false }, "forSaleMustHavePriceReduction": { "title": "Must have price reduction", "type": "boolean", "description": "Only listings with a recent price cut — pairs with the price_reduction output field.", "default": false }, "forSaleKeywords": { "title": "Keywords", "type": "string", "description": "MLS #, yard, etc. — matches words in the listing description." }, "forSaleSortBy": { "title": "Sort", "enum": [ "globalrelevanceex", "days", "priced", "pricea", "beds", "baths", "size", "lot" ], "type": "string", "description": "Result order, same options as Zillow's Sort dropdown on the Buy page.", "default": "globalrelevanceex" }, "forRentLocations": { "title": "Locations", "type": "array", "description": "Address, neighborhood, city, or ZIP — same as Zillow's search box.", "items": { "type": "string" } }, "forRentHomeType": { "title": "Home type", "enum": [ "any", "Houses", "Apartments/Condos", "Townhomes" ], "type": "string", "description": "Same as the Home type tiles in Zillow's rental \"Property type\" panel.", "default": "any" }, "forRentSpace": { "title": "Space", "enum": [ "entirePlace", "roomForRent", "any" ], "type": "string", "description": "Same as the Space tiles on Zillow: whole homes, single rooms, or both.", "default": "entirePlace" }, "forRentPriceMin": { "title": "Price: Min (monthly rent)", "minimum": 0, "type": "integer", "description": "Minimum monthly rent in USD." }, "forRentPriceMax": { "title": "Price: Max (monthly rent)", "minimum": 0, "type": "integer", "description": "Maximum monthly rent in USD." }, "forRentBedroomsMin": { "title": "Bedrooms", "enum": [ "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Minimum bedrooms.", "default": "0" }, "forRentBathroomsMin": { "title": "Bathrooms", "enum": [ "0", "1", "1.5", "2", "3", "4" ], "type": "string", "description": "Minimum bathrooms.", "default": "0" }, "forRentPets": { "title": "Pets", "type": "array", "description": "Same as the Pets options in Zillow's rental filters.", "items": { "type": "string", "enum": [ "Allows small dogs", "Allows large dogs", "Allows cats", "No pets allowed" ], "enumTitles": [ "Allows small dogs", "Allows large dogs", "Allows cats", "No pets allowed" ] } }, "forRentAmenities": { "title": "Amenities", "type": "array", "description": "Popular rental amenities, same wording as Zillow.", "items": { "type": "string", "enum": [ "In-unit laundry", "Must have A/C", "On-site parking", "Furnished", "Utilities included", "Dishwasher" ], "enumTitles": [ "In-unit laundry", "Must have A/C", "On-site parking", "Furnished", "Utilities included", "Dishwasher" ] } }, "forRentMoveInDate": { "title": "Move-in Date", "type": "string", "description": "Only rentals available by this date." }, "forRentSquareFeetMin": { "title": "Square feet: Min", "minimum": 0, "type": "integer", "description": "Minimum living area (sqft)." }, "forRentSquareFeetMax": { "title": "Square feet: Max", "minimum": 0, "type": "integer", "description": "Maximum living area (sqft)." }, "forRentYearBuiltMin": { "title": "Year built: Min", "minimum": 0, "type": "integer", "description": "Earliest construction year." }, "forRentYearBuiltMax": { "title": "Year built: Max", "minimum": 0, "type": "integer", "description": "Latest construction year." }, "forRentDaysOnZillow": { "title": "Days on Zillow", "enum": [ "any", "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "Only rentals posted within this window.", "default": "any" }, "forRentMustHave3DTour": { "title": "Must have 3D Tour", "type": "boolean", "description": "Only rentals with a 3D tour.", "default": false }, "forRentMustHaveGarage": { "title": "Must have garage", "type": "boolean", "description": "Only rentals with a garage.", "default": false }, "forRentMustHavePriceReduction": { "title": "Must have price reduction", "type": "boolean", "description": "Only rentals with a recent rent cut.", "default": false }, "forRentKeywords": { "title": "Keywords", "type": "string", "description": "Matches words in the listing description (e.g. \"pool\")." }, "forRentSortBy": { "title": "Sort", "enum": [ "priorityscore", "days", "paymentd", "paymenta", "beds", "baths", "size", "lot" ], "type": "string", "description": "Result order, same options as Zillow's Sort dropdown on the Rent page.", "default": "priorityscore" }, "soldLocations": { "title": "Locations", "type": "array", "description": "Address, neighborhood, city, or ZIP — same as Zillow's search box.", "items": { "type": "string" } }, "soldInLast": { "title": "Sold in last", "enum": [ "any", "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "Only homes sold within this window.", "default": "any" }, "soldPriceMin": { "title": "Price: Min", "minimum": 0, "type": "integer", "description": "Minimum sold price in USD." }, "soldPriceMax": { "title": "Price: Max", "minimum": 0, "type": "integer", "description": "Maximum sold price in USD." }, "soldBedroomsMin": { "title": "Bedrooms", "enum": [ "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Minimum bedrooms.", "default": "0" }, "soldBathroomsMin": { "title": "Bathrooms", "enum": [ "0", "1", "1.5", "2", "3", "4" ], "type": "string", "description": "Minimum bathrooms.", "default": "0" }, "soldHomeTypes": { "title": "Home Type", "type": "array", "description": "Same as Zillow's \"Property type\" filter. All types included by default.", "items": { "type": "string", "enum": [ "Houses", "Townhomes", "Multi-family", "Condos/Co-ops", "Lots/Land", "Apartments", "Manufactured" ], "enumTitles": [ "Houses", "Townhomes", "Multi-family", "Condos/Co-ops", "Lots/Land", "Apartments", "Manufactured" ] }, "default": [ "Houses", "Townhomes", "Multi-family", "Condos/Co-ops", "Lots/Land", "Apartments", "Manufactured" ] }, "soldMaxHoa": { "title": "Max HOA", "enum": [ "any", "0", "50", "100", "200", "300", "400", "500", "600", "700", "800", "900", "1000", "1500", "2000" ], "type": "string", "description": "Maximum monthly HOA fee.", "default": "any" }, "soldParkingSpotsMin": { "title": "Parking spots", "enum": [ "0", "1", "2", "3", "4" ], "type": "string", "description": "Minimum parking spots.", "default": "0" }, "soldMustHaveGarage": { "title": "Must have garage", "type": "boolean", "description": "Only homes with a garage.", "default": false }, "soldSquareFeetMin": { "title": "Square feet: Min", "minimum": 0, "type": "integer", "description": "Minimum living area (sqft)." }, "soldSquareFeetMax": { "title": "Square feet: Max", "minimum": 0, "type": "integer", "description": "Maximum living area (sqft)." }, "soldLotSizeMin": { "title": "Lot size: Min (sqft)", "minimum": 0, "type": "integer", "description": "Minimum lot size in sqft." }, "soldLotSizeMax": { "title": "Lot size: Max (sqft)", "minimum": 0, "type": "integer", "description": "Maximum lot size in sqft." }, "soldYearBuiltMin": { "title": "Year built: Min", "minimum": 0, "type": "integer", "description": "Earliest construction year." }, "soldYearBuiltMax": { "title": "Year built: Max", "minimum": 0, "type": "integer", "description": "Latest construction year." }, "soldMustHave3DTour": { "title": "Must have 3D Tour", "type": "boolean", "description": "Only homes with a 3D tour.", "default": false }, "soldMustHavePriceReduction": { "title": "Must have price reduction", "type": "boolean", "description": "Only homes that had a price cut before selling.", "default": false }, "soldKeywords": { "title": "Keywords", "type": "string", "description": "Matches words in the listing description." }, "soldSortBy": { "title": "Sort", "enum": [ "globalrelevanceex", "days", "priced", "pricea", "beds", "baths", "size", "lot" ], "type": "string", "description": "Result order, same options as Zillow's Sort dropdown.", "default": "globalrelevanceex" }, "maxItems": { "title": "Max listings per search URL / location", "minimum": 1, "type": "integer", "description": "Collect at most this many listings from each search URL or location (per option). Leave empty to collect everything — Zillow serves at most ~20 pages (~800 listings) per search." }, "followZillowLocationSuggestions": { "title": "Follow Zillow's location match", "type": "boolean", "description": "If Zillow matches your search term to a slightly different place (e.g. \"new york\" → the state of NY), collect it anyway — the same results as searching on zillow.com. Turn off to skip such locations instead.", "default": true } } }, "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 } } } } } } } } } }