{ "openapi": "3.0.1", "info": { "title": "Zillow Property Listings Scraper", "description": "Zillow scraper: export listings from any Zillow search or listing URL. Get price, address, beds, baths, size, photos, Zestimate, and optionally agent phone, MLS number and price history. No login.", "version": "0.0", "x-build-id": "NcViPa9aYeX3TmceE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/keklik~zillow-property-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-keklik-zillow-property-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/keklik~zillow-property-listings-scraper/runs": { "post": { "operationId": "runs-sync-keklik-zillow-property-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/keklik~zillow-property-listings-scraper/run-sync": { "post": { "operationId": "run-sync-keklik-zillow-property-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Zillow URLs", "type": "array", "description": "Zillow search URLs or links to single listings, one per line. To get a search URL, search zillow.com for a city, ZIP code or neighborhood, set any filters you want, and copy the URL from the address bar. A single-listing link (zillow.com/homedetails/...) always returns the full property details.", "items": { "type": "string" } }, "propertyDetails": { "title": "Property details", "type": "boolean", "description": "Also open each listing to collect the description, agent and broker phone, MLS number, year built, price per square foot, parking, HOA fee, tax rate, mortgage rates, virtual tour and price history. Runs take longer with this on, and each listing with details is charged as an add-on (see Pricing). Single-listing links always include these details.", "default": false }, "maxResultsPerUrl": { "title": "Max results per URL", "minimum": 1, "type": "integer", "description": "Stop after this many listings for each URL. Zillow shows at most about 980 listings for one search, whatever total it displays. To collect more, split your search by ZIP code or price range and add each one as its own URL.", "default": 1000 }, "status": { "title": "Listing status", "enum": [ "Same as URL", "Sold", "For rent" ], "type": "string", "description": "Which market to search. \"Same as URL\" keeps the market of your URL. Sold or For rent switches every search URL to that market.", "default": "Same as URL" }, "priceMin": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Only homes at or above this price, in USD. For rentals, this is the monthly rent. Leave empty to keep the minimum price of your URL." }, "priceMax": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Only homes at or below this price, in USD. For rentals, this is the monthly rent. Leave empty to keep the maximum price of your URL." }, "beds": { "title": "Bedrooms", "enum": [ "Any", "1+", "2+", "3+", "4+", "5+" ], "type": "string", "description": "Minimum number of bedrooms. \"Any\" keeps the bedrooms filter of your URL.", "default": "Any" }, "baths": { "title": "Bathrooms", "enum": [ "Any", "1+", "1.5+", "2+", "3+", "4+" ], "type": "string", "description": "Minimum number of bathrooms. \"Any\" keeps the bathrooms filter of your URL.", "default": "Any" }, "homeType": { "title": "Home type", "enum": [ "Any", "Houses", "Townhomes", "Multi-family", "Condos/Co-ops", "Apartments", "Manufactured", "Lots/Land" ], "type": "string", "description": "Only one type of property. \"Any\" keeps the home types of your URL. Apartment complexes that Zillow shows as one card per building are not exported; individual units are.", "default": "Any" }, "daysOnSite": { "title": "Listed or sold within", "enum": [ "Any", "1 day", "7 days", "14 days", "30 days", "90 days", "6 months", "12 months", "24 months", "36 months" ], "type": "string", "description": "Only homes listed on Zillow within this period. With Sold, only homes sold within this period. \"Any\" keeps the value of your URL.", "default": "Any" } } }, "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 } } } } } } } } } }