Hi there! 👋
Disclaimer: this library is not associated with airbnb.com and should only be used for non-profit and educational reasons.
This is a pre 1.0 library. Please request endpoints and functionality as repo issues. Collaborators wanted!
- All functions return promises
- Batch functions are limited to 50 operations at a time
- You will need to supply a token for every logged in function call
- Error reporting and data validation is spotty at this stage!
npm install airbnbapijs
var airbnb = require('airbnbapijs')
or es6...
import airbnb from 'airbnbapijs'
- Authorization
- Users
- Calendars
- Listings
- Threads
- Reservations
- Posting
- Configuration
Test a token
airbnb.testAuth('faketoken3sDdfvtF9if5398j0v5nui')
// returns boolRequest a new token
airbnb.newAccessToken({username:'foo@bar.com', password:'hunter2'})
// returns {token: 'faketoken3sDdfvtF9if5398j0v5nui'} or {error: {error obj}}Request a new token (v2 endpoint). Similar to the above function but returns a user info summary with much more information.
airbnb.login({username:'foo@bar.com', password:'hunter2'})
// returns a user info object (includes token) or {error: {error obj}}TODO: support other login methods
Get a user's public facing information
airbnb.getGuestInfo(2348485493)
// returns public info about user (JSON)Obtain user data for the logged in account
airbnb.getOwnUserInfo(token)
// returns private info about user (JSON)Public availability and price data on a listing. count is the duration in months.
airbnb.getPublicListingCalendar({
id: 109834757,
month: 1,
year: 2018,
count: 1
})
// returns array of calendar days, with availability and pricePrivate calendar data regarding your listings. Reservations, cancellations, prices, blocked days.
airbnb.getCalendar({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
id: 109834757,
startDate: '2018-01-01',
endDate: '2018-02-28',
})
// returns array of calendar days with extended info, for your listingsSet a price for a day.
airbnb.setPriceForDay({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
id: 109834757,
date: '2018-01-01',
price: 1203,
})
// returns a result of the operationSet availability for a day.
airbnb.setAvailabilityForDay({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
id: 109834757,
date: '2018-01-01',
availability: 'available', // or 'blocked'?
})
// returns a result of the operationAirbnb's mighty search bar in JSON form. More options coming soon.
airbnb.listingSearch({
location: 'New York, United States',
offset: 0,
limit: 20,
language: 'en-US',
currency: 'USD'
})
// returns an array of listingsGets public facing data on any listing.
airbnb.getListingInfo({id: 109834757})
// returns public info for any listing (JSON)Gets private data on one of your listings.
airbnb.getListingInfoHost({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
id: 109834757
})
// returns extended listing info for your listing (JSON)Returns a conversation with a guest or host. This is a legacy endpoint which is somewhat limited in the content (only basic messages are reported in the 'posts' array)
airbnb.getThread({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
id: 909878797
})
// returns a single thread in the legacy format (JSON)A simple list of thread ID's, ordered by latest update. The offset is how many to skip, and the limit is how many to report.
airbnb.getThreads({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
offset: 0,
limit: 20
})
// returns an array of thread IDS (only the ids, ordered by latest update) (JSON)This is the best way to pull thread data. Returns an array of full thread data, ordered by latest update. The offset is how many to skip, and the limit is how many to report.
airbnb.getThreadsFull({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
offset: 0,
limit: 10
})
// returns an array of threads in the new format, ordered by latest update (JSON)A batch version of the above. You can grab a collection of threads referenced by thread ID.
airbnb.getThreadsBatch({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
ids: [23049848, 203495875, 398328244]
})
// returns an array of threads in the new format (JSON)Reservation data for one reservation.
airbnb.getReservation({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
id: 909878797
})
// returns a single reservation in the mobile app format (JSON)Returns a list of reservations in the same format as above, ordered by latest update
airbnb.getReservations({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
offset: 0,
limit: 10
})
// returns an array of reservations in the mobile app format, ordered by latest update (JSON)Batch call for grabbing a list of reservations by ID.
airbnb.getReservationsBatch({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
ids: [98769876, 98769543, 98756745]
})
// returns an array of reservations in the new format (JSON)Send a message to a thread.
airbnb.sendMessage({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
id: 2039448789,
message: 'Hi there!'
})
// returns confirmationSend a pre-approval to a guest.
airbnb.sendPreApproval({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
thread_id: 2039448789,
listing_id: 340598483,
message: ''
})
// returns confirmationSend a review to a guest after they have checked out. (id is the thread id)
airbnb.sendReview({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
id: 2039448789,
comments: 'They were great guests!',
private_feedback: 'Thank you for staying!',
cleanliness: 5,
communication: 5,
respect_house_rules: 5,
recommend: true
})
// returns confirmationSend a special offer to a guest.
airbnb.sendSpecialOffer({
token: 'faketoken3sDdfvtF9if5398j0v5nui',
check_in: "2018-10-13T00:00:00+00:00",
guests: 1,
listing_id: 9876676,
nights: 1,
price: 100000,
thread_id: 98766767,
currency: 'USD'
})
// returns confirmationUse an api key different from the standard one
airbnb.setApiKey('01123581321345589144233377610987')Set the default currency (the default is JPY, sorry USA)
airbnb.setCurrency('USD')set the user agent string for the requests
airbnb.setUserAgent('Mosaic/0.9')