{ "openapi": "3.0.1", "info": { "title": "Zillow Search By Address Scraper", "description": "Scrape Zillow property listings by address with automatic pagination, multiple listing statuses (For Sale, For Rent, Sold), and comprehensive filtering options for real estate market analysis", "version": "0.0", "x-build-id": "kKCo6u2SQe4NmgJbK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/powerai~zillow-search-byaddress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-powerai-zillow-search-byaddress-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/powerai~zillow-search-byaddress-scraper/runs": { "post": { "operationId": "runs-sync-powerai-zillow-search-byaddress-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/powerai~zillow-search-byaddress-scraper/run-sync": { "post": { "operationId": "run-sync-powerai-zillow-search-byaddress-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": [ "location", "listingStatus", "sortOrder" ], "properties": { "location": { "title": "Location", "type": "string", "description": "The address or location to search for", "default": "New York, NY" }, "maxItems": { "title": "Maximum Items", "minimum": 200, "maximum": 1000, "type": "integer", "description": "Maximum number of properties to scrape", "default": 200 }, "listingStatus": { "title": "Listing Status", "enum": [ "For_Sale", "For_Rent", "Sold" ], "type": "string", "description": "Status of listings", "default": "For_Sale" }, "sortOrder": { "title": "Sort Order", "enum": [ "Homes_for_you", "Rental_Priority_Score", "Newest" ], "type": "string", "description": "Sort order for results", "default": "Newest" }, "listPriceRange": { "title": "Price Range", "type": "string", "description": "Price range filter (e.g., '100000-500000')" }, "bed_min": { "title": "Minimum Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms" }, "bed_max": { "title": "Maximum Bedrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms" }, "bathrooms": { "title": "Bathrooms", "enum": [ "Any", "OnePlus", "OneHalfPlus", "TwoPlus", "ThreePlus", "FourPlus" ], "type": "string", "description": "Bathroom requirements" }, "homeType": { "title": "Home Type", "type": "string", "description": "Type of home" }, "space": { "title": "Space", "type": "string", "description": "Space requirements" }, "maxHOA": { "title": "Maximum HOA", "type": "string", "description": "Maximum HOA fee" }, "incIncompleteHOA": { "title": "Include Incomplete HOA", "type": "boolean", "description": "Include properties with incomplete HOA information" }, "listingType": { "title": "Listing Type", "enum": [ "By_Agent", "By_Owner_and_Other" ], "type": "string", "description": "Type of listing" }, "propertyStatus": { "title": "Property Status", "type": "string", "description": "Status of the property" }, "tours": { "title": "Tours", "type": "string", "description": "Tour availability" }, "parkingSpots": { "title": "Parking Spots", "enum": [ "Any", "OnePlus", "TwoPlus", "ThreePlus", "FourPlus" ], "type": "string", "description": "Number of parking spots" }, "haveGarage": { "title": "Have Garage", "type": "boolean", "description": "Property has a garage" }, "move_in_date": { "title": "Move-in Date", "type": "string", "description": "Desired move-in date" }, "hideNoDateListings": { "title": "Hide No Date Listings", "type": "boolean", "description": "Hide listings without dates" }, "squareFeetRange": { "title": "Square Feet Range", "type": "string", "description": "Range of square footage" }, "lotSizeRange": { "title": "Lot Size Range", "type": "string", "description": "Range of lot size" }, "yearBuiltRange": { "title": "Year Built Range", "type": "string", "description": "Range of year built" }, "mustHaveBasement": { "title": "Must Have Basement", "enum": [ "Yes", "No" ], "type": "string", "description": "Basement requirement" }, "singleStoryOnly": { "title": "Single Story Only", "type": "boolean", "description": "Only show single story properties" }, "hide55plusComm": { "title": "Hide 55+ Communities", "type": "boolean", "description": "Hide 55+ communities" }, "pets": { "title": "Pets", "type": "string", "description": "Pet policy" }, "otherAmenities": { "title": "Other Amenities", "type": "string", "description": "Additional amenities" }, "view": { "title": "View", "type": "string", "description": "Property view" }, "daysOnZillow": { "title": "Days on Zillow", "type": "string", "description": "Days listed on Zillow" }, "soldInLast": { "title": "Sold in Last", "type": "string", "description": "Recently sold properties" }, "keywords": { "title": "Keywords", "type": "string", "description": "Search keywords" } } }, "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 } } } } } } } } } }