{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper - Listings, Prices, Details & Reviews", "description": "Scrape Airbnb stays without a browser: search any place or paste a search URL, filter by dates, guests, price, room type, bedrooms and amenities, go beyond the 270-result cap with map tiling. Optional full details (host, rating breakdown, rules, cancellation, photos) and reviews. Pay per result.", "version": "1.0", "x-build-id": "hhQY0iwyT5W5umN9m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/randy-tools~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-randy-tools-airbnb-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/randy-tools~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-randy-tools-airbnb-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/randy-tools~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-randy-tools-airbnb-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": "Places to search, written the way you would type them on airbnb.com, e.g. \"Paris, France\", \"Lisbon, Portugal\", \"Brooklyn, NY\". Each location is a separate search that uses the filters below.", "items": { "type": "string" } }, "startUrls": { "title": "Airbnb URLs", "type": "array", "description": "Search result URLs copied from airbnb.com (their dates, guests and filters are kept) and/or single listing URLs (/rooms/...). Filters below are added to search URLs. Listing URLs always return full details.", "items": { "type": "string" } }, "listingIds": { "title": "Listing IDs", "type": "array", "description": "Airbnb listing IDs, e.g. 51797569 (the number after /rooms/ in a listing URL). Each one returns full details.", "items": { "type": "string" } }, "maxItemsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stop each search after this many listings. Airbnb shows at most 270 stays (15 pages) per search; turn on deep search to go beyond that.", "default": 100 }, "maxItems": { "title": "Max listings in total", "minimum": 0, "type": "integer", "description": "Stop the whole run after this many listings across all searches and listing URLs. 0 means no limit.", "default": 0 }, "checkIn": { "title": "Check-in date", "type": "string", "description": "YYYY-MM-DD. With dates, prices are the total for the stay and only available stays are returned. Without dates Airbnb shows the nightly price for a typical stay." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "YYYY-MM-DD, after the check-in date. If empty, the stay lasts the number of nights below." }, "nights": { "title": "Nights", "minimum": 1, "maximum": 90, "type": "integer", "description": "Length of stay when only a check-in date is given.", "default": 3 }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adults. Airbnb hides stays that cannot host this many guests.", "default": 1 }, "children": { "title": "Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Children aged 2 to 12.", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Infants under 2.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of pets. Only stays that allow pets are returned when this is above 0.", "default": 0 }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "AUD", "CAD", "NZD", "CHF", "JPY", "SEK", "NOK", "DKK", "PLN", "CZK", "HUF", "BRL", "MXN", "ARS", "CLP", "COP", "ZAR", "AED", "SGD", "HKD", "THB", "INR", "KRW", "TRY", "ILS", "CNY", "IDR", "MYR", "PHP", "VND" ], "type": "string", "description": "Currency of all prices.", "default": "USD" }, "locale": { "title": "Language", "enum": [ "en", "fr", "de", "es", "it", "pt", "nl", "sv", "da", "pl", "ru", "ja", "ko", "zh", "tr" ], "type": "string", "description": "Language of titles, descriptions, amenities and reviews as Airbnb translates them.", "default": "en" }, "minPrice": { "title": "Min price per night", "minimum": 0, "type": "integer", "description": "Lowest nightly price in the selected currency. 0 means no minimum." }, "maxPrice": { "title": "Max price per night", "minimum": 0, "type": "integer", "description": "Highest nightly price in the selected currency. 0 means no maximum." }, "roomTypes": { "title": "Room types", "type": "array", "description": "Only these kinds of stay. Leave empty for all.", "items": { "type": "string", "enum": [ "entire_home", "private_room", "hotel_room", "shared_room" ], "enumTitles": [ "Entire home", "Private room", "Hotel room", "Shared room" ] } }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 16, "type": "integer", "description": "At least this many bedrooms." }, "minBeds": { "title": "Min beds", "minimum": 0, "maximum": 16, "type": "integer", "description": "At least this many beds." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "maximum": 8, "type": "integer", "description": "At least this many bathrooms." }, "amenities": { "title": "Amenities", "type": "array", "description": "Stays must have every selected amenity.", "items": { "type": "string", "enum": [ "wifi", "air_conditioning", "pool", "kitchen", "free_parking", "gym", "breakfast", "hot_tub", "indoor_fireplace", "heating", "washer", "dryer", "smoke_alarm", "carbon_monoxide_alarm", "tv", "hair_dryer", "iron", "dedicated_workspace", "self_check_in", "bbq_grill", "ev_charger", "crib", "king_bed", "smoking_allowed" ], "enumTitles": [ "Wifi", "Air conditioning", "Pool", "Kitchen", "Free parking", "Gym", "Breakfast", "Hot tub", "Indoor fireplace", "Heating", "Washer", "Dryer", "Smoke alarm", "Carbon monoxide alarm", "TV", "Hair dryer", "Iron", "Dedicated workspace", "Self check-in", "BBQ grill", "EV charger", "Crib", "King bed", "Smoking allowed" ] } }, "superhostOnly": { "title": "Superhosts only", "type": "boolean", "description": "Only stays hosted by a Superhost.", "default": false }, "guestFavoriteOnly": { "title": "Guest favorites only", "type": "boolean", "description": "Only stays with the Guest favorite badge.", "default": false }, "instantBookOnly": { "title": "Instant Book only", "type": "boolean", "description": "Only stays you can book without waiting for host approval.", "default": false }, "freeCancellationOnly": { "title": "Free cancellation only", "type": "boolean", "description": "Only stays with a flexible cancellation policy.", "default": false }, "deepSearch": { "title": "Deep search (map tiling)", "type": "boolean", "description": "Airbnb stops at 270 stays per search. When a search fills all 15 pages, split its map area into four tiles and search each one, recursively, to reach every stay. Uses more requests; combine it with a large 'Max listings per search'.", "default": false }, "maxSplitDepth": { "title": "Max tiling depth", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many times a crowded map area may be split into quarters. 4 gives up to 256 tiles per search.", "default": 4 }, "includeDetails": { "title": "Include listing details", "type": "boolean", "description": "Open every listing for the full description, amenities, house rules, rating breakdown, host, coordinates, all photos and cancellation policy; with dates also the total price per cancellation option. Two to three extra requests per listing.", "default": false }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Add public guest reviews (first name, rating, date, text, host reply) as separate records after each listing.", "default": false }, "maxReviewsPerListing": { "title": "Max reviews per listing", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Reviews are fetched 24 at a time.", "default": 50 }, "reviewsSort": { "title": "Reviews order", "enum": [ "most_recent", "best_quality" ], "type": "string", "description": "Newest first, or the order Airbnb shows by default (best quality first).", "default": "most_recent" }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Listing pages fetched in parallel when details are on.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy rotates the exit IP. The default datacenter proxy is included in the price; choose residential if Airbnb blocks a run.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }