{ "openapi": "3.0.1", "info": { "title": "Zillow Listings Scraper", "version": "1.0", "x-build-id": "f67ImzN8vwNUb2sZf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/velvety_bedbug~zillow-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-velvety_bedbug-zillow-listings-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/velvety_bedbug~zillow-listings-scraper/runs": { "post": { "operationId": "runs-sync-velvety_bedbug-zillow-listings-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/velvety_bedbug~zillow-listings-scraper/run-sync": { "post": { "operationId": "run-sync-velvety_bedbug-zillow-listings-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": { "searchQuery": { "title": "Location", "type": "string", "description": "City, ZIP, neighborhood or county — e.g. 'Austin, TX', '78704', 'Brooklyn, NY'.", "default": "Austin, TX" }, "listingType": { "title": "Listing type", "enum": [ "forSale", "forRent", "sold" ], "type": "string", "description": "Which market to search.", "default": "forSale" }, "sortBy": { "title": "Sort by", "enum": [ "days", "priceLowToHigh", "priceHighToLow", "newest", "beds", "baths", "sqft", "lotSize", "relevance" ], "type": "string", "description": "Result ordering.", "default": "days" }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 820, "type": "integer", "description": "Zillow caps a search at roughly 800 results; narrow the filters to reach deeper inventory.", "default": 10 }, "minPrice": { "title": "Min price", "type": "integer", "description": "Minimum price (monthly rent when listing type is For rent)." }, "maxPrice": { "title": "Max price", "type": "integer", "description": "Maximum price (monthly rent when listing type is For rent)." }, "minBeds": { "title": "Min beds", "type": "integer", "description": "0 includes studios." }, "maxBeds": { "title": "Max beds", "type": "integer", "description": "Upper bound on bedrooms." }, "minBaths": { "title": "Min baths", "type": "number", "description": "Minimum bathrooms; halves allowed (1.5)." }, "maxBaths": { "title": "Max baths", "type": "number", "description": "Maximum bathrooms." }, "minSqft": { "title": "Min sqft", "type": "integer", "description": "Minimum living area in square feet." }, "maxSqft": { "title": "Max sqft", "type": "integer", "description": "Maximum living area in square feet." }, "minLotSize": { "title": "Min lot (sqft)", "type": "integer", "description": "Minimum lot size in square feet (1 acre = 43,560)." }, "maxLotSize": { "title": "Max lot (sqft)", "type": "integer", "description": "Maximum lot size in square feet." }, "minYearBuilt": { "title": "Built after", "type": "integer", "description": "Earliest year built." }, "maxYearBuilt": { "title": "Built before", "type": "integer", "description": "Latest year built." }, "maxHoa": { "title": "Max HOA / month", "type": "integer", "description": "Maximum monthly HOA dues. Use 0 for 'no HOA only'." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Property types to include. Empty means all.", "items": { "type": "string", "enum": [ "house", "townhouse", "condo", "multiFamily", "apartment", "lotLand", "manufactured" ], "enumTitles": [ "Houses", "Townhomes", "Condos/co-ops", "Multi-family", "Apartments", "Lots/Land", "Manufactured" ] }, "default": [] }, "saleStatus": { "title": "Sale listing status", "type": "array", "description": "For-sale only. Empty means Zillow's default (agent + owner + new construction).", "items": { "type": "string", "enum": [ "byAgent", "byOwner", "newConstruction", "foreclosure", "auction", "comingSoon", "pending", "acceptingBackupOffers" ], "enumTitles": [ "By agent", "By owner (FSBO)", "New construction", "Foreclosures", "Auctions", "Coming soon", "Pending", "Accepting backup offers" ] }, "default": [] }, "soldInLastDays": { "title": "Sold in last (days)", "enum": [ "", "7", "30", "90", "180", "365", "1095" ], "type": "string", "description": "Recently-sold searches only.", "default": "" }, "daysOnZillow": { "title": "Days on Zillow", "enum": [ "", "1", "7", "14", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "How recently the listing appeared.", "default": "" }, "features": { "title": "Must have", "type": "array", "description": "Amenity filters.", "items": { "type": "string", "enum": [ "pool", "airConditioning", "waterfront", "basement", "garage", "singleStory", "cityView", "waterView", "parkView", "mountainView", "threeDTour", "openHouse" ], "enumTitles": [ "Pool", "Air conditioning", "Waterfront", "Basement", "Garage", "Single story", "City view", "Water view", "Park view", "Mountain view", "3D tour", "Open house" ] }, "default": [] }, "rentalFeatures": { "title": "Rental filters", "type": "array", "description": "For-rent only.", "items": { "type": "string", "enum": [ "allowsLargeDogs", "allowsSmallDogs", "allowsCats", "inUnitLaundry", "onSiteParking", "acceptsApplications", "incomeRestricted", "entirePlace", "roomForRent" ], "enumTitles": [ "Large dogs OK", "Small dogs OK", "Cats OK", "In-unit laundry", "On-site parking", "Accepts online applications", "Income restricted", "Entire place", "Room for rent" ] }, "default": [] }, "keywords": { "title": "Keywords", "type": "string", "description": "Free-text keyword filter, e.g. 'casita', 'no hoa', 'workshop'." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Zillow blocks datacenter IPs. Residential proxy is required and is the default.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }