{ "openapi": "3.0.1", "info": { "title": "Zillow ZIP, Sold & Rental Scraper - Every Listing + Zestimate", "description": "Scrape every Zillow listing in a ZIP code, city or neighborhood: for sale, recently sold or for rent. Prices, sold dates, Zestimate, rent Zestimate, beds, baths, sqft, plus price-per-sqft and rent yield. No login.", "version": "0.1", "x-build-id": "ZqUwC4ZrlC8YRfjFH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/headply~zillow-zip-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-headply-zillow-zip-search", "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/headply~zillow-zip-search/runs": { "post": { "operationId": "runs-sync-headply-zillow-zip-search", "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/headply~zillow-zip-search/run-sync": { "post": { "operationId": "run-sync-headply-zillow-zip-search", "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": { "zipCodes": { "title": "ZIP codes", "type": "array", "description": "US ZIP codes to search, one per line, e.g. 78704. Each ZIP is searched for every listing status you pick below. Defaults to 78704 (Austin, TX) if you leave both ZIP codes and locations empty.", "items": { "type": "string" } }, "locations": { "title": "Cities or neighborhoods (optional)", "type": "array", "description": "Places as you would type them on Zillow, e.g. Austin, TX or Hyde Park, Chicago, IL. Searched the same way as ZIP codes.", "items": { "type": "string" } }, "listingStatus": { "title": "Listing status", "type": "array", "description": "Which listings to return. Pick several to get them in one run; every row carries its status.", "items": { "type": "string", "enum": [ "forSale", "sold", "forRent" ], "enumTitles": [ "For sale", "Recently sold", "For rent" ] }, "default": [ "forSale" ] }, "soldWithin": { "title": "Sold within", "enum": [ "any", "7", "30", "90", "6m", "12m", "24m", "36m" ], "type": "string", "description": "Recently sold only: how far back to look.", "default": "any" }, "maxResultsPerSearch": { "title": "Max listings per ZIP and status", "minimum": 0, "type": "integer", "description": "Stop each ZIP + status after this many listings. Set 0 to get every listing Zillow has: large areas are split into price bands automatically, so you are not capped at Zillow's 820-result page limit.", "default": 100 }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lowest price in USD (monthly rent for rentals)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Highest price in USD (monthly rent for rentals)." }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Only homes with at least this many bedrooms." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Only homes with at least this many bathrooms." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "house", "townhouse", "condo", "multiFamily", "apartment", "manufactured", "land" ], "enumTitles": [ "Houses", "Townhomes", "Condos/co-ops", "Multi-family", "Apartments", "Manufactured", "Lots/land" ] } }, "onlyNewSinceLastRun": { "title": "Only new or changed since last run (monitoring)", "type": "boolean", "description": "For schedules. Returns and bills only listings that are new or changed price since an earlier run with the same monitor name.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Label for this schedule's memory. Use one name per schedule; change it to start fresh.", "default": "default" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Searches processed in parallel.", "default": 4 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Leave as is. Zillow serves search results reliably to US residential addresses.", "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 } } } } } } } } } }