{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper: Home Prices, Sale History, Rentals", "description": "Scrape Zillow listings by city or URL. Returns price, beds, baths, sqft, Zestimate, rent Zestimate, days on market, agent. For-sale, for-rent, sold. Filter by price, beds, sqft, type. JSON. Pay per item.", "version": "0.1", "x-build-id": "XlyxVH0gUYL8NQXfs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapemint~zillow-home-price-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapemint-zillow-home-price-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/scrapemint~zillow-home-price-scraper/runs": { "post": { "operationId": "runs-sync-scrapemint-zillow-home-price-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/scrapemint~zillow-home-price-scraper/run-sync": { "post": { "operationId": "run-sync-scrapemint-zillow-home-price-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": { "searchUrls": { "title": "Zillow search URLs", "type": "array", "description": "Full Zillow search URLs. Example: https://www.zillow.com/homes/Austin-TX_rb/ for Austin for-sale, or a filtered map search pasted from zillow.com.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "City and state like \"Austin, TX\" or zip codes. Used when searchUrls is blank.", "default": [], "items": { "type": "string" } }, "listingType": { "title": "Listing type", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "for_sale, for_rent, or sold. Default for_sale.", "default": "for_sale" }, "minPrice": { "title": "Min price ($)", "minimum": 0, "type": "number", "description": "Drop listings priced below this.", "default": 0 }, "maxPrice": { "title": "Max price ($)", "minimum": 0, "type": "number", "description": "Drop listings priced above this.", "default": 0 }, "minBeds": { "title": "Min beds", "minimum": 0, "maximum": 10, "type": "integer", "description": "Drop listings with fewer beds.", "default": 0 }, "maxBeds": { "title": "Max beds", "minimum": 0, "maximum": 20, "type": "integer", "description": "Drop listings with more beds.", "default": 0 }, "minSqft": { "title": "Min square feet", "minimum": 0, "type": "integer", "description": "Drop listings smaller than this.", "default": 0 }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Keep only matching types: house, condo, townhouse, apartment, manufactured, multifamily, lot, other. Empty keeps all.", "default": [], "items": { "type": "string" } }, "maxPages": { "title": "Max pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "Zillow returns up to 40 listings per page. 5 pages = 200 listings. Cap to control cost.", "default": 3 }, "maxItemsPerSource": { "title": "Max items per source", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Per search cap on rows pushed.", "default": 100 }, "maxItemsTotal": { "title": "Max items per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on rows per run. Controls total cost.", "default": 300 }, "dedupe": { "title": "Deduplicate across runs", "type": "boolean", "description": "Skip zpids pushed on previous runs. Turn off to track price changes over time.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy. Residential strongly recommended. Zillow blocks datacenter IPs aggressively.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }