A wrapper for airbnb.com API


Licenses
WTFPL/libpng-2.0
Install
pip install airbnb==2.3.0

Documentation

airbnb-python

Airbnb Python API

Disclaimer

This is a unofficial python API wrapper for airbnb.com

Using this software might contradict airbnb.com terms of service

Requirements

  • requests

Usage:

pip install airbnb

Initialize API

import airbnb
api = airbnb.Api()

Now, you'd be able to access most of the API endpoints (which don't require authentication).

Use random client identification

import airbnb
api = airbnb.Api(randomize=True)

This will allow you to randomize device UDID, advertisement UUID and user agent.

Initialize API with your airbnb.com username and password:

You need to login to access certain endpoints requiring authentication:

api = airbnb.Api(login, password)

Once you logged in, please reuse your access token, to avoid getting your account locked

api = airbnb.Api(access_token=`<ACCESS_TOKEN_OBTAINED_ON_LOGIN>`)

Get your user profile

(requires auth)

api.get_profile()

Get listing availability

api.get_calendar(listing_id)

Optional parameters:

  • starting_month: first month of the calendar (can't be in the past)
  • starting_year: first year of the calendar (can't be in the past)
  • calendar_months: how many months ahead you want to get the calendar for

Example:

api.get_calendar(975964, starting_month=9, starting_year=2017, calendar_months=1)

Get listing reviews

api.get_reviews(listing_id)

Optional parameters:

  • offset: paging offset
  • limit: number of results per page

Example:

api.get_reviews(975964, offset=20, limit=20)

Get a list of available homes in a <City> with a query or at a given location

api.get_homes(`<City>`)
api.get_homes(gps_lat=`Latitude`, gps_lng=`Longitude`)

Optional parameters:

  • offset: paging offset
  • items_per_grid: amount of listings to fetch for a given offset
  • checkin: checkin date (e.g. 2019-04-20)
  • checkout: checkout date (e.g. 2019-04-20)

Example:

Get first 8 listings for Lisbon, Portugal

api.get_homes("Lisbon, Portugal")

Example:

Get first listings at a given location (by GPS coordinates)

api.get_homes(gps_lat=55.6123352, gps_lng=37.7117917)

Note: at the moment items_per_grid limit appears to be 306 listings

🌿 VerificationError (420)

This exception occurs when you send too many login requests (i.e. call Api() with your credentials). Once you are logged in with your credentials you can just use your access token (Api(access_token="<TOKEN>")) As a workaround, try to login manually though the website or mobile app and complete Airbnb's verification process. You can also try to use a VPN or a proxy.

Testing

The package has some doctests to test authentication process, to run the tests first export the following env variables:

export AIRBNB_LOGIN=`<YOUR_LOGIN>`
export AIRBNB_PASSWORD=`<YOUR_PASSWORD>`
export AIRBNB_ACCESS_TOKEN=`<ACCESS_TOKEN_OBTAINED_ON_LOGIN>`

Then, setup Python environment as follows:

pipenv shell
pipenv install --dev

Finally, run the doctests using nose:

nosetests --with-doctest

Build Status