southern-cross-ai / Inside-Airbnb-Australia

Airbnb's Residential Dataset (Australia)
https://insideairbnb.com
MIT License
1 stars 0 forks source link
airbnb australia dataset

Inside Airbnb Australia

Overview

Keywords: Australia; Airbnb; Comment and Review

Inside Airbnb is a mission driven project that provides data and advocacy about Airbnb's impact on residential communities, aims to work towards a vision where communities are empowered with data and information to understand, decide and control the role of renting residential homes to tourists.

Data Source

The original data is downloaded from Inside Airbnb and licensed under CC BY 4.0. Please refer to Data Policies - Inside Airbnb for more details.

This repo only stores listings.csv[.gz] and reviews.csv[.gz] data from Australia. For data of other other locations, please visit Get the data.

Data Structure

The dataset under InsideAirbnbAustralia contains detailed listings and reviews data from the following 11 locations in Australia:

Each location has a separate directory with its name, e.g., melbourne and sunshine-coast.

Inside each location's directory, there are 2 subdirectories gz and csv, where csv contains the unzipped CSV files from their corresponding GZ files in gz.

Naming convention:

Notice that the [date] is used to build URLs to retrieve and download the data, doesn't necessarily represent the date of the data.

For more information about the data, please refer to Get the data - Inside Airbnb.

(Last updated on 18 August 2024)

Download

We suggest you to walk through utils/download.ipynb notebook to explore how we build URLs to request and download the data.

You can also use utils/download.py to download the data directly in your terminal.

$ python utils/download.py --help  

usage: download.py [-h] [-s START_DATE] [-e END_DATE] -l LOCATIONS [LOCATIONS ...] [-r SAVE_ROOT]

Download Inside Airbnb data from Australia.

options:
  -h, --help            Show all help messages.
  -s START_DATE, --start_date START_DATE
                        Define the start date of the time range (YYY-MM-DD).
                        Default date is set to the date when Airbnb launched in Australia.
  -e END_DATE, --end_date END_DATE
                        Define the end date of the time range (YYYY-MM-DD).
                        Default date is set to the current date, i.e., today.
  -l LOCATIONS [LOCATIONS ...], --locations LOCATIONS [LOCATIONS ...]
                        Define the locations you want to download.
                        The possible locations are:
                        - 'sa/barossa-valley'
                        - 'vic/barwon-south-west-vic'
                        - 'qld/brisbane'
                        - 'vic/melbourne'
                        - 'nsw/mid-north-coast'
                        - 'vic/mornington-peninsula'
                        - 'nsw/northern-rivers'
                        - 'qld/sunshine-coast'
                        - 'nsw/sydney'
                        - 'tas/tasmania'
                        - 'wa/western-australia'
                        Use 'all' to download from all locations.
  -r SAVE_ROOT, --save_root SAVE_ROOT
                        The root path you want to save your data to.
                        Default root path is 'Inside-Airbnb-Australia'.

License

This repository is licensed under MIT.