# Airbnb Explorer (`jupri/airbnb`) Actor 💫 All-in-One Airbnb.com Scraper - **URL**: https://apify.com/jupri/airbnb.md - **Developed by:** [cat](https://apify.com/jupri) (community) - **Categories:** Travel - **Features:** Full permissions - **Stats:** 850 total users, 0 monthly users, 100.0% runs succeeded, 20 bookmarks - **User rating**: 1.00 out of 5 stars ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage ## What's an Apify Actor? An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md. ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run. For examples already wired to this Actor's own input schema, see the [API](#api) section below. Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`). # README ## Welcome to Airbnb.com Scraper ![dont be sad readme is here](https://raw.githubusercontent.com/JupriGH/resources/main/cats/catframe.png) ### About Airbnb.com **Airbnb, Inc.** ([/ˌɛərˌbiːɛnˈbiː/](https://en.wikipedia.org/wiki/Help:IPA/English "Help:IPA/English") [*AIR-BEE-en-BEE*](https://en.wikipedia.org/wiki/Help:Pronunciation_respelling_key "Help:Pronunciation respelling key")) is an American company that operates an [online marketplace](https://en.wikipedia.org/wiki/Online_marketplace "Online marketplace") for lodging, primarily [homestays](https://en.wikipedia.org/wiki/Homestay "Homestay") for vacation rentals, and tourism activities. Based in San Francisco, California, the platform is accessible via website and [mobile app](https://en.wikipedia.org/wiki/Mobile_app "Mobile app"). Airbnb does not own any of the listed properties; instead, it profits by receiving [commission](https://en.wikipedia.org/wiki/Commission_\(remuneration\) "Commission (remuneration)") from each booking. The company was founded in 2008 by Brian Chesky, Nathan Blecharczyk, and Joe Gebbia. Airbnb is a shortened version of its original name, AirBedandBreakfast.com. ### About This Actor ![enter image description here](https://r.bing.com/rp/Xt-zKwSTuQ0RnKzKlPIAsQ7TLko.png) Scrape data about properties around the world. Check for availability on specific dates. Get detailed information such as amenities, description, ratings, reviews and more. Search for properties using comprehensive list of filters. > **Notes** > *The AirBnB website limiting result to 15 pages x 20 item_per_page = 300. The Actor will get as many records as possible beyond the limit, but not much.* ### Tutorial #### Example #1: Basic Usage Searching and limiting number of results. ```yaml { "location": "Antarctica", "limit": 100 } ``` ```yaml { "location": "953482945276817965 751307134149677284" } # hotels IDs ``` |Parameter | Type | Description| |--|--|--| |`location`| ***string*** |City, country or continent you wish to go, or Hotel-ID| |`limit`| ***integer*** |Number of results to fetch| #### Example #2: Trip Length ***Chose one of 3 types of Trip :*** | Mode | Options (`trip_length`) | Other Parameters | |-|-|-| | **📅 Exact Date** | `"date" "date-1" "date-2" "date-3" "date-7" ` | `check_in`, `check_out` | **🌕 Monthly** | `"monthly"` | `montly_start`, `montly_length` | **⌛ Flexible** | `"weekend"` `"one_week"` `"one_month"` | Optional: `trip_month` ```yaml ## mode: Exact date { "location" : "India", # to India "trip_length" : "date", # on exact date "check_in" : "2024-06-23", # on 23 June "check_out" : "2024-06-28", # until 28 June "limit" : 10 } ``` ```yaml ## mode: Mothly { "location" : "Bali", # to Bali "trip_length" : "monthly", # monthly "monthly_start" : "2024-07-01", # from June "monthly_length" : 2, # for 2 months "limit" : 10 } ``` ```yaml ## mode: Flexible { "location" : "United States", # to United States "trip_length" : "one_week", # for 1 week "trip_month" : [1, 4, 5], # in January or April or March. "limit" : 10 } ``` ***Check IN / OUT*** | Parameter | Type | Format | Description| |-|-|-|-| |`check_in`| ***string*** | `YYYY-MM-DD` | Check-in date | |`check_out`| ***string*** | `YYYY-MM-DD` | Check-out date | # Changelog This Actor's version history is a separate document: https://apify.com/jupri/airbnb/changelog.md # Actor input Schema ## `location` (type: `array`): 💡 🧭 LOCATION, 🔗 URL or ❓ COMMAND ## `example` (type: `string`): 💡 Examples: Select one or more examples, then hit START!

Clear the LOCATION input before running an example.

OR, enter your own queries in the LOCATION input.

## `search_mode` (type: `string`): No description ## `limit` (type: `integer`): 💡 Number of results (per-query) ## `locale` (type: `string`): 💡 Output Language ## `currency` (type: `string`): 💡 Output Currency ## `map_viewer` (type: `boolean`): No description ## `includes.description` (type: `boolean`): 💡 Long description ## `includes.pricing` (type: `boolean`): 💡 More detailed & accurate pricing ## `includes.amenities` (type: `boolean`): 💡 Grouped amenities ## `includes.highlights` (type: `boolean`): 💡 Hotel Highlights ## `includes.rating` (type: `boolean`): 💡 Ratings details ## `includes.sleeps` (type: `boolean`): 💡 Sleeping arangements ## `includes.location` (type: `boolean`): 💡 Surrounding area ## `includes.images` (type: `boolean`): 💡 Complete gallery ## `includes.host` (type: `boolean`): 💡 Meet your host ## `includes.calendar` (type: `integer`): 💡 Availability Calendar (1-12 Months, starting from current Month) ## `includes.reviews` (type: `integer`): 💡 Number of reviews to fetch (max=50). To filter, use REVIEWS filters below. ## `reviews_search` (type: `string`): 💡 Search within reviews ## `reviews_sort` (type: `string`): 💡 Reviews sorting ## `superhost` (type: `boolean`): 💡 Stay with recognized Hosts ## `airbnb_plus` (type: `boolean`): 💡 A selection of places to stay verified for quality and design ## `airbnb_luxe` (type: `boolean`): 💡 Handpicked luxury homes with personally arranged services ## `guest_fav` (type: `boolean`): 💡 The most loved homes on Airbnb, according to guests ## `work_trip` (type: `boolean`): 💡 People traveling for work have rated these places highly ## `reviews_count` (type: `integer`): 💡 Minimum numbers of visible reviews ## `host_id` (type: `string`): No description ## `host_languages` (type: `array`): No description ## `experience_types` (type: `array`): No description ## `experience_traveler` (type: `array`): No description ## `experience_duration_min` (type: `integer`): No description ## `experience_duration_max` (type: `integer`): No description ## `experience_time` (type: `array`): No description ## `experience_languages` (type: `array`): No description ## `trip_length` (type: `string`): No description ## `check_in` (type: `string`): 💡 Exact date (YYYY-MM-DD) \[check_in] ## `check_out` (type: `string`): 💡 Exact date (YYYY-MM-DD) \[check_out] ## `monthly_start` (type: `string`): 💡 Start date (YYYY-MM-DD) \[monthly_start] ## `monthly_length` (type: `integer`): 💡 How many months ? \[monthly_length] ## `trip_month` (type: `array`): 💡 Optional months INPUT for FLEXIBLE Trip. \[trip_month] ## `adults` (type: `integer`): 💡 Ages 13 year above ## `children` (type: `integer`): 💡 Ages 2-12 year ## `infants` (type: `integer`): 💡 Under 2 year ## `pets` (type: `integer`): No description ## `min_price` (type: `integer`): No description ## `max_price` (type: `integer`): No description ## `discounted` (type: `boolean`): 💡 Discounted Stays ## `instant_book` (type: `boolean`): 💡 Listings you can book without waiting for Host approval ## `amenities.self_checkin` (type: `boolean`): 💡 Easy access to the property once you arrive ## `free_cancel` (type: `boolean`): 💡 Only show stays that offer free cancellation ## `category` (type: `string`): No description ## `types` (type: `array`): No description ## `room_types` (type: `array`): No description ## `species` (type: `array`): No description ## `bedrooms` (type: `integer`): 💡 Minimum Bedrooms ## `beds` (type: `integer`): 💡 Minimum Beds ## `bathrooms` (type: `integer`): 💡 Minimum Bathrooms ## `home_essential` (type: `array`): No description ## `home_amenities` (type: `array`): No description ## `tags` (type: `array`): No description ## `home_safety` (type: `array`): No description ## `home_access` (type: `array`): No description ## `bedroom_amenities` (type: `array`): No description ## `bathroom_amenities` (type: `array`): No description ## `equipment_amenities` (type: `array`): No description ## `home_features` (type: `array`): No description ## `no_experiment` (type: `boolean`): No description ## `dev_proxy_config` (type: `object`): 💡 Supported protocol:

HTTP(S), SOCKS5
{http|socks5}://{user:pass}@{hostname|ip-address}:port

Example: socks5://example.com:9000 ## `dev_custom_headers` (type: `array`): 💡 Additional HTTP Headers ## `dev_custom_cookies` (type: `array`): 💡 Additional HTTP Cookies ## `dev_transform_fields` (type: `array`): 💡 Transform the resulting output. Select only needed fields.

For nested object use DOT. For example: 
address.streetAddress

For nested array use NUMBER (index of array element starting from index=0). For example: 
images.0.url
## `dev_dataset_name` (type: `string`): 💡 Save results into custom named Dataset, use mask to customize dataset name

{ACTOR} = actor name
{DATE} = date (YYYYMMDD)
{TIME} = time (HHMMSS)

This masks can be used to autogenerate Dataset Name.

example: data-{DATE}
Depending on today date the dataset name will be: data-20230603

default: data-{ACTOR}-{DATE}-{TIME} ## `dev_dataset_clear` (type: `boolean`): Clear Dataset before insert/update. ## `dev_no_strip` (type: `boolean`): 💡 Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING) ## `dev_fileupload` (type: `string`): 💡 Upload your file and copy & paste the URL somewhere. ## Actor input object example ```json { "location": [ "Bali" ], "limit": 5 } ``` # Actor output Schema ## `overview` (type: `string`): No description ## `extras` (type: `string`): No description ## `results` (type: `string`): No description ## `mapViewer` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "location": [ "Bali" ], "limit": 5 }; // Run the Actor and wait for it to finish const run = await client.actor("jupri/airbnb").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "location": ["Bali"], "limit": 5, } # Run the Actor and wait for it to finish run = client.actor("jupri/airbnb").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}") for item in client.dataset(run.default_dataset_id).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "location": [ "Bali" ], "limit": 5 }' | apify call jupri/airbnb --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "type": "http", "url": "https://mcp.apify.com/?tools=fetch-actor-details,jupri/airbnb" } } } ``` The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer ` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations). ## OpenAPI specification Download the OpenAPI definition: https://api.apify.com/v2/actors/viXne7lpALg8viFdh/builds/3YSE0NqPOQxk3pmEN/openapi.json