{ "openapi": "3.0.1", "info": { "title": "Hotpads Scraper", "description": "Scrape rental listings from HotPads.com. Extract price, beds, baths, address, photos, amenities, pet policy, nearby schools and more. Supports apartments, houses, condos and rooms across any US city. Fast mode or full detail mode.", "version": "0.0", "x-build-id": "jHdBEq95VdtLWWwpk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tangerine_loom~Hotpads-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tangerine_loom-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/tangerine_loom~Hotpads-Scraper/runs": { "post": { "operationId": "runs-sync-tangerine_loom-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/tangerine_loom~Hotpads-Scraper/run-sync": { "post": { "operationId": "run-sync-tangerine_loom-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": { "locations": { "title": "Locations", "type": "array", "description": "Cities, neighborhoods or ZIP codes to search, one per line — e.g. \"Austin, TX\", \"Brooklyn, NY\" or \"10001\". The filters below apply to these searches. A location HotPads does not recognise is reported in the log by name.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "HotPads search or listing URLs, used exactly as given — copy them from your browser after applying filters on hotpads.com. Listing URLs (ending in /pad) are scraped directly. Use this or Locations, or both.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum number of listings to save across the whole run. Use this to control costs. Set to 0 for unlimited.", "default": 0 }, "includeDetails": { "title": "Scrape Detail Pages", "type": "boolean", "description": "Off by default (fast mode): listings are taken straight from the search pages — roughly 10x faster and far cheaper. Enable it to visit every listing's detail page for the full description, per-unit breakdown, fees, lease terms and pet policies.", "default": false }, "propertyType": { "title": "Property type", "enum": [ "all", "apartments", "houses", "condos", "townhomes", "rooms" ], "type": "string", "description": "\"All rentals\" covers every type HotPads lists. Note that HotPads' \"Apartments\" means apartment buildings only — single apartments in houses, condos and duplexes are filed under those types, so in cities like New York \"All rentals\" returns many times more listings.", "default": "all" }, "minPrice": { "title": "Min rent ($/month)", "minimum": 0, "type": "integer", "description": "Lowest monthly rent to include." }, "maxPrice": { "title": "Max rent ($/month)", "minimum": 0, "type": "integer", "description": "Highest monthly rent to include." }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "maximum": 8, "type": "integer", "description": "0 means studios are included." }, "maxBeds": { "title": "Max bedrooms", "minimum": 0, "maximum": 8, "type": "integer", "description": "Leave empty for no upper limit." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "maximum": 8, "type": "integer", "description": "Minimum number of bathrooms." }, "pets": { "title": "Pets allowed", "enum": [ "any", "cats", "dogs", "both" ], "type": "string", "description": "Only include listings that allow these pets.", "default": "any" }, "postedWithin": { "title": "Posted within", "enum": [ "any", "hour", "day", "week", "month" ], "type": "string", "description": "Only listings published recently — useful for scheduled runs that track new listings.", "default": "any" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "lowPrice", "highPrice" ], "type": "string", "description": "Order of results. Matters when Max Items stops the run early — \"Newest\" with a small Max Items gives you the latest listings.", "default": "relevance" }, "maxPages": { "title": "Max Search Pages", "minimum": 1, "maximum": 99, "type": "integer", "description": "Result pages to follow per search (40 listings each). HotPads shows at most 99 pages — about 3,960 listings — for any single search. Leave at 99 to collect everything; lower it to limit the run.", "default": 99 }, "splitLargeSearches": { "title": "Split large searches", "type": "boolean", "description": "When a search holds more listings than HotPads' 99-page limit can show (common in big cities with \"All rentals\"), split it into rent ranges automatically so every listing is reached. Only applies when Max Search Pages is 99. Duplicates across ranges are removed.", "default": true }, "blockImages": { "title": "Block Images (cheaper runs)", "type": "boolean", "description": "Skips downloading listing photos to reduce residential proxy bandwidth. Photo URLs are still extracted, because they come from the page data rather than the downloaded files. This does not speed runs up — measured slightly slower — so enable it only when bandwidth is what you are optimizing.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "HotPads blocks datacenter IPs, so the default Apify Residential proxies (US) are what makes it work. Datacenter or no-proxy settings are switched to Residential automatically (the log says so). You can supply your own proxy URLs instead.", "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 } } } } } } } } } }