{ "openapi": "3.0.1", "info": { "title": "Airbnb Rooms URL Scraper β€” Host Portfolio & Co-Host Listings", "description": "This actor extracts clean, structured Airbnb room URLs from search results, maps, filters, or specific locations. It automates URL collection for research, pricing analysis, lead generation, and large-scale Airbnb data projects with reliable output.", "version": "0.1", "x-build-id": "ayF38IWT0O86gqScD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~Airbnb-Rooms-URLs-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-Airbnb-Rooms-URLs-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/scraper-engine~Airbnb-Rooms-URLs-Scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-Airbnb-Rooms-URLs-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/scraper-engine~Airbnb-Rooms-URLs-Scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-Airbnb-Rooms-URLs-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": [ "startUrls" ], "properties": { "startUrls": { "title": "🏘️ Room URLs or host profile URLs", "type": "array", "description": "Three input shapes, mixable in one run:\nβ€’ room URL β€” https://www.airbnb.com/rooms/25166525 β†’ the listing, its host and the host's whole roster\nβ€’ host profile URL β€” https://www.airbnb.com/users/show/213799039 β†’ the portfolio and its co-hosts, no listing scrape\nβ€’ a search phrase β€” Miami Beach β†’ up to 20 rooms resolved from Airbnb search, each expanded to its host", "default": [ "https://www.airbnb.com/rooms/25166525", "https://www.airbnb.com/rooms/53309811", "https://www.airbnb.com/users/show/213799039" ], "items": { "type": "string" } }, "includeHostListings": { "title": "🏠 List the host's other properties", "type": "boolean", "description": "Opens the host's public profile and returns the rest of their roster in `hostListings[]` β€” id, title, room type, property type, bedrooms/beds/baths, rating, review count and thumbnail per property. One extra request per distinct host (cached across the run). Default: on.", "default": true }, "maxHostListings": { "title": "πŸ”’ Roster rows per host", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many portfolio rows to keep per profile. Airbnb itself never returns more than 10 properties on a public profile, however many the host runs β€” so 10 is the ceiling. The true size is always in `hostListingsCount`, and `hostListingsRosterCapped` tells you when the roster is a sample. Default: 10.", "default": 10 }, "includeCoHostListings": { "title": "πŸ‘₯ Do the same for every co-host", "type": "boolean", "description": "On managed properties the co-host is usually the real operator β€” this is where a 6-door named host turns out to be fronted by a 200-door management company. Adds `coHostPortfolios[]` and `coHostListingsTotal`. Costs one extra profile request per distinct co-host. Airbnb names co-hosts on a listing, never on a profile, so a host profile URL is answered by scanning that host's roster properties for co-hosts (one small request per roster property). Default: on.", "default": true }, "minHostListings": { "title": "πŸ“Š Skip hosts running fewer properties than this", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Applied to the live `hostListingsCount` (Airbnb's own total, not the capped roster). 2 strips out one-off hosts. 10 keeps only serious operators. 0 keeps every listing. Filtered rows are not written and not charged. Default: 0.", "default": 0 }, "mapPortfolioCities": { "title": "πŸ—ΊοΈ Resolve each portfolio property to a city", "type": "boolean", "description": "Airbnb's roster rows carry no location, so market spread needs one extra lookup per property (a small ~22 KB call, not the full room page). Turning this on adds `city` to every `hostListings[]` row plus `cityBreakdown` and `distinctCities` in the summary. Costs up to `maxHostListings` extra requests per host. Default: off.", "default": false }, "enrichHostProfiles": { "title": "πŸͺͺ Attach the legacy host profile card", "type": "boolean", "description": "Attaches the base actor's `host.profile` / `coHosts[].profile` cards (about, location, verifications, superhost flag, time as host). Costs no extra request when the portfolio lookups above are already on. Same switch as `enrichUserProfiles` β€” turning on either one enables it. Default: off.", "default": false }, "enrichUserProfiles": { "title": "πŸ‘€ Enrich user profiles (legacy key)", "type": "boolean", "description": "Original base-actor name for the switch above. Kept fully working for saved base inputs and API callers: turning on either `enrichHostProfiles` or `enrichUserProfiles` attaches the profile cards.", "default": false }, "checkIn": { "title": "πŸ“… Check-in date", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "YYYY-MM-DD. Sent to Airbnb as `check_in` on every room URL. Example: 2026-09-15." }, "checkOut": { "title": "πŸ›ŽοΈ Check-out date", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "YYYY-MM-DD. Sent to Airbnb as `check_out` on every room URL. Example: 2026-09-18." }, "adults": { "title": "πŸ§‘ Adults", "minimum": 1, "type": "integer", "description": "Guest count sent with each room request. Example: 2." }, "children": { "title": "πŸ§’ Children", "minimum": 0, "type": "integer", "description": "Children (ages 2–12) sent with each room request." }, "infants": { "title": "πŸ‘Ά Infants", "minimum": 0, "type": "integer", "description": "Infants (under 2) sent with each room request." }, "pets": { "title": "🐾 Pets", "minimum": 0, "type": "integer", "description": "Pets sent with each room request." }, "locale": { "title": "🌍 Result language / locale", "enum": [ "en-US", "az-AZ", "id-ID", "bs-BA", "ca-ES", "cs-CZ", "sr-ME", "da-DK", "de-DE", "de-AT", "de-CH", "de-LU", "et-EE", "en-AU", "en-CA", "en-GB", "en-GY", "en-IN", "en-IE", "en-NZ", "en-SG", "en-AE", "es-AR", "es-BZ", "es-BO", "es-CL", "es-CO", "es-CR", "es-EC", "es-SV", "es-ES", "es-US", "es-GT", "es-HN", "es-419", "es-MX", "es-NI", "es-PA", "es-PY", "es-PE", "es-VE", "fr-BE", "fr-CA", "fr-FR", "fr-CH", "fr-LU", "ga-IE", "hr-HR", "xh-ZA", "zu-ZA", "is-IS", "it-IT", "it-CH", "sw-XX", "lv-LV", "lt-LT", "hu-HU", "mt-MT", "ms-MY", "nl-BE", "nl-NL", "no-NO", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "sq-AL", "sk-SK", "sl-SI", "sr-RS", "fi-FI", "sv-SE", "tl-PH", "vi-VN", "tr-TR", "el-GR", "bg-BG", "mk-MK", "ru-RU", "uk-UA", "ka-GE", "hy-AM", "he-IL", "ar-XX", "hi-IN", "th-TH", "ko-KR", "ja-JP", "zh-US", "zh-TW-US", "zh-CN", "zh-HK", "zh-TW" ], "type": "string", "description": "Titles, property types, amenity names and location subtitles come back in this language. Default: English (United States).", "default": "en-US" }, "currency": { "title": "πŸ’± Currency", "enum": [ "USD", "CZK", "AUD", "BRL", "BGN", "CAD", "CLP", "CNY", "COP", "CRC", "HRK", "DKK", "EGP", "AED", "EUR", "GHS", "HKD", "HUF", "INR", "IDR", "ILS", "JPY", "KZT", "KES", "MYR", "MXN", "MAD", "TWD", "NZD", "NOK", "PEN", "PHP", "PLN", "GBP", "QAR", "RON", "SAR", "SGD", "ZAR", "KRW", "SEK", "CHF", "THB", "TRY", "UGX", "UAH", "UYU", "VND" ], "type": "string", "description": "Currency requested from Airbnb for any price-bearing field. Default: USD.", "default": "USD" }, "proxyConfiguration": { "title": "πŸ›‘οΈ Proxy configuration", "type": "object", "description": "Pick Apify Proxy (residential recommended for large runs) or supply your own proxy URLs. Leave `useApifyProxy` false to start with no proxy and let the automatic ladder decide.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }