{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper: US Listings, Price Drops & ZIP Market Stats", "description": "Export Zillow sale/rental listings by city or ZIP, track price changes and summarize collected listings by ZIP. Limits and access determine coverage; summaries are sample-based and REMOVED is not proof of a sale.", "version": "0.1", "x-build-id": "Kdh5wUfKcPdUpDv5I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datasmithlab~zillow-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datasmithlab-zillow-property-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/datasmithlab~zillow-property-scraper/runs": { "post": { "operationId": "runs-sync-datasmithlab-zillow-property-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/datasmithlab~zillow-property-scraper/run-sync": { "post": { "operationId": "run-sync-datasmithlab-zillow-property-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": { "locations": { "title": "Cities, counties or ZIP codes", "type": "array", "description": "One per line: 'Austin, TX', 'Travis County, TX' or a 5-digit ZIP code ('78701'). Cities and counties above Zillow's 820-result limit are split into their ZIP codes automatically.", "items": { "type": "string" } }, "startUrls": { "title": "Zillow search URLs", "type": "array", "description": "Or paste Zillow city, county or ZIP search pages (e.g. https://www.zillow.com/austin-tx/rentals/). Map and filter settings in the URL are not used; set filters below. Pasted URLs are not split by ZIP.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "mode": { "title": "For sale or for rent", "enum": [ "forSale", "forRent" ], "type": "string", "description": "Applies to the locations above. Pasted URLs keep their own (…/rentals/ = for rent).", "default": "forSale" }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Stop after this many listing rows (you pay per row). Market summary rows are not counted.", "default": 200 }, "minPrice": { "title": "Min price ($)", "minimum": 0, "type": "integer", "description": "For rent: monthly rent. Filters are applied by the scraper; listings that don't match are not charged." }, "maxPrice": { "title": "Max price ($)", "minimum": 0, "type": "integer", "description": "Leave empty for no limit." }, "minBeds": { "title": "Min beds", "minimum": 0, "type": "integer", "description": "Leave empty for any. Apartment buildings (rentals) have no single bed count and are left out when this is set." }, "maxBeds": { "title": "Max beds", "minimum": 0, "type": "integer", "description": "Leave empty for any." }, "minBaths": { "title": "Min baths", "minimum": 0, "type": "integer", "description": "Leave empty for any." }, "minSqft": { "title": "Min living area (sqft)", "minimum": 0, "type": "integer", "description": "Leave empty for any." }, "maxSqft": { "title": "Max living area (sqft)", "minimum": 0, "type": "integer", "description": "Leave empty for any." }, "maxDaysOnZillow": { "title": "Max days on Zillow", "minimum": 0, "type": "integer", "description": "Only listings this new (e.g. 7 = listed in the last week)." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Leave empty for all.", "items": { "type": "string", "enum": [ "SINGLE_FAMILY", "CONDO", "TOWNHOUSE", "MULTI_FAMILY", "APARTMENT", "APARTMENT_BUILDING", "LOT", "MANUFACTURED" ], "enumTitles": [ "Houses", "Condos", "Townhomes", "Multi-family", "Apartments (single unit)", "Apartment buildings (rentals)", "Lots / land", "Manufactured" ] } }, "onlyNewOrChanged": { "title": "Only new or changed listings", "type": "boolean", "description": "For scheduled runs: each run returns only listings that are NEW, had a PRICE_DROP or PRICE_UP since the last run with the same settings, and (when every search was read completely) REMOVED listings. The first run returns everything as NEW.", "default": false }, "marketSummary": { "title": "ZIP market summary", "type": "boolean", "description": "Add one row per ZIP code: listings, median and quartile price, median $/sqft, median days on Zillow, new in the last 7 days, share and median size of price cuts, price vs Zestimate and (for sale) gross rent yield. Uses every matching listing, also unchanged ones in monitoring mode.", "default": false }, "splitByZip": { "title": "Split big cities and counties by ZIP", "type": "boolean", "description": "Zillow shows at most 820 listings per search. When a city or county has more, it is searched ZIP by ZIP. Turn off to read only the first 820.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Requests go out without a proxy first. Only if Zillow blocks them is this proxy used.", "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 }, "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 } } } } } } } } } }