{ "openapi": "3.0.1", "info": { "title": "Zillow Search Scraper", "description": "Scrape Zillow listings by city, ZIP, county or neighborhood: for sale, rent, sold, foreclosures. Flat rows with price, beds, Zestimate, price drops and days on Zillow. Pulls thousands per run.", "version": "0.0", "x-build-id": "eC4flOw4DVbL7ZRis" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~zillow-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-zillow-search-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/axlymxp~zillow-search-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-zillow-search-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/axlymxp~zillow-search-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-zillow-search-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": { "query": { "title": "Search Location", "type": "string", "description": "City, ZIP code, county, neighborhood or state ('Austin, TX', '78701', 'Travis County, TX'), a full street address ('7609 E Indian Bend Rd, Scottsdale, AZ 85250') or a Zillow link. An address returns that one listing, whether it is for sale, for rent or recently sold. Use 'Several locations' below for more than one." }, "queries": { "title": "Several locations or addresses (optional)", "type": "array", "description": "More places, street addresses or Zillow links for the same run. Results are de-duplicated across entries.", "items": { "type": "string" } }, "startUrls": { "title": "Zillow links (optional)", "type": "array", "description": "Zillow search links (copy the address bar after you set filters on zillow.com) or listing links (/homedetails/...). Price, beds, baths, HOA, home type, sort and status from a search link are applied to that link; the whole place is searched, not just the visible map. Hand-drawn map areas are not supported.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "homeStatuses": { "title": "Home Status", "enum": [ "forSale", "fsba", "fsbo", "forRent", "recentlySold", "newConstruction", "foreclosure", "foreclosed", "preforeclosure", "auction", "comingSoon" ], "type": "string", "description": "Which listings to return. 'For sale' = agent-listed (fsba) plus for-sale-by-owner (fsbo). Also: new construction, for rent, recently sold, foreclosure, pre-foreclosure, auction, coming soon.", "default": "forSale" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Minimum price in USD" }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Maximum price in USD" }, "minBedrooms": { "title": "Minimum Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms" }, "maxBedrooms": { "title": "Maximum Bedrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms" }, "minBathrooms": { "title": "Minimum Bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms" }, "maxHoaFees": { "title": "Maximum HOA Fees", "minimum": 0, "type": "integer", "description": "Maximum monthly HOA fee in USD. Leave empty to include homes with any HOA fee (before this version the actor silently kept only homes with no HOA fee)." }, "includeNoHoaData": { "title": "Include No HOA Data", "type": "boolean", "description": "Only used together with 'Max HOA fees': also keep homes that have no HOA data.", "default": true }, "homeTypes": { "title": "Home Types", "type": "array", "description": "Property types. Options: singleFamily, multiFamily, condo, manufactured, land, townhome, apartment", "items": { "type": "string" } }, "sortOrder": { "title": "Sort Order", "enum": [ "recentlyChanged", "relevance", "priceLowToHigh", "priceHighToLow", "daysOn", "beds", "baths", "lotArea", "livingArea" ], "type": "string", "description": "How to sort within the search. Price sorts also decide the order of the price bands used to pass the 975-row limit.", "default": "recentlyChanged" }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of listings to return in total (up to 100,000). One Zillow query reaches at most 975 listings; for more, the actor splits the search into price bands automatically.", "default": 500 }, "outputFormat": { "title": "Output format", "enum": [ "flat", "raw" ], "type": "string", "description": "'Flat' gives one typed row per listing (address, price, beds, baths, Zestimate, days on Zillow, price drops, broker and more). 'Raw' returns Zillow's original nested record, as earlier versions did.", "default": "flat" }, "includePhotos": { "title": "Include photo list", "type": "boolean", "description": "Add up to 20 photo URLs per listing (flat rows only). One main photo is always included.", "default": false }, "maxDaysOnZillow": { "title": "Listed within (days)", "minimum": 0, "type": "integer", "description": "Only listings that have been on Zillow for at most this many days. Handy for fresh-listing feeds." }, "priceDropsOnly": { "title": "Price drops only", "type": "boolean", "description": "Only listings whose latest price change was a reduction.", "default": false }, "onlyNewSinceLastRun": { "title": "Only listings not returned before", "type": "boolean", "description": "Monitoring: skip listings an earlier run of this same search already returned. Schedule the actor to get a feed of new listings.", "default": false } } }, "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 } } } } } } } } } }