{ "openapi": "3.0.1", "info": { "title": "Hotpads.com Property Scraper", "description": "Scrape Hotpads.com (Zillow Group) rental listings. Get full listing details by id or URL, search apartments, houses, condos and rooms for rent by location, by coordinates + radius, or by a Hotpads URL with filters, and resolve locations via autocomplete.", "version": "1.0", "x-build-id": "3rfbhkhjUYBGc5Mca" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/one-api~hotpads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-one-api-hotpads-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/one-api~hotpads-scraper/runs": { "post": { "operationId": "runs-sync-one-api-hotpads-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/one-api~hotpads-scraper/run-sync": { "post": { "operationId": "run-sync-one-api-hotpads-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": { "property_inputs": { "title": "Listing id or hotpads.com URL (one per line)", "type": "array", "description": "Auto-detects each entry and calls the right endpoint:\n• A Hotpads listing id (e.g. `4y217cc1nzpm3`) → `/details/byid`\n• A `https://hotpads.com/...` listing URL → `/details/byurl`\n\nEach row = one full rental record (price, beds, baths, sqft, units & floorplans, amenities, pet policy, schools, photos, contact company + phone, lease terms, costs).", "items": { "type": "string" } }, "search_inputs": { "title": "Location or hotpads.com search URL (one per line)", "type": "array", "description": "Auto-detects each entry and routes to the right `/search/*` endpoint:\n• A hotpads.com results URL, e.g. `https://hotpads.com/new-york-ny/apartments-for-rent` → `/search/byurl`\n• Anything else (city, neighborhood or ZIP, e.g. `New York, NY`, `Brooklyn`, `78758`) → `/search/bylocation`\n\nThe filters below apply to every search. Each hit returns one row per rental listing.", "items": { "type": "string" } }, "coordinate_inputs": { "title": "Coordinates: lat,lon or lat,lon,radiusMiles (one per line)", "type": "array", "description": "Radius search around a point via `/search/bycoordinates`. One point per line as `latitude,longitude` or `latitude,longitude,radiusMiles` (radius in miles, default 1.5). Example: `40.7128,-74.006,1` searches 1 mile around lower Manhattan. The filters below also apply. One row per listing.", "items": { "type": "string" } }, "propertyType": { "title": "Property type", "enum": [ "", "apartment", "house", "condo", "townhome", "room", "multifamily" ], "type": "string", "description": "Type of rental to search for. Leave as Any for all types. Applies to every Search and Coordinates query.", "default": "" }, "priceRange": { "title": "Monthly rent range ($)", "type": "string", "description": "Format: `min:1000,max:3000` — or just `min:1000` / `max:3000`. Filters the monthly rent.", "default": "" }, "bedsRange": { "title": "Bedrooms", "type": "string", "description": "Number of bedrooms, e.g. `min:1` or `min:1,max:3`. Use `min:0` to include studios.", "default": "" }, "bathsRange": { "title": "Bathrooms", "type": "string", "description": "Number of bathrooms, e.g. `min:1` or `min:1,max:2`.", "default": "" }, "petsAllowed": { "title": "Pets allowed", "enum": [ "", "dog", "cat", "dog,cat" ], "type": "string", "description": "Filter for listings that allow pets.", "default": "" }, "sortOrder": { "title": "Sort order", "enum": [ "Newest", "Price_Low_to_High", "Price_High_to_Low", "Distance" ], "type": "string", "description": "Result ordering for `/search/bylocation`, `/search/bycoordinates` and `/search/byurl`.", "default": "Newest" }, "pages": { "title": "Pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many result pages to fetch for each location / coordinate / URL search.", "default": 1 }, "resultCount": { "title": "Results per page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Listings per page for every search (1–100).", "default": 30 }, "autocomplete_inputs": { "title": "Location text to resolve (one per line)", "type": "array", "description": "Resolve a city / neighborhood / ZIP to the Hotpads area record used by Search, via `/autocomplete`. Each suggestion = one row (id, type, name, city, state).", "items": { "type": "string" } } } }, "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 } } } } } } } } } }