In debt look at the JSON output and object table of future airbnb rates and supply API of AirDNA
In this article, I will clarify the object table and JSON output specifically of the AirDNA future airbnb rates and supply API. The object table and JSON output contain important information about the future rates and supply of Airbnb listings, and understanding these structures can be useful for developers who are working with this data. I will explain the contents and formatting of both the object table and the JSON output, and provide examples to illustrate their use.
API Table
Objects | Description |
access_token | {{CLIENT_TOKEN}} |
city_id | Optional: Use 'city_id' or 'region_id' |
region_id | Optional: Use 'city_id' or 'region_id' |
number_of_months | Optional: Default = 1 |
room_types | Required: (entire_place, private_room, shared_room) |
bedrooms | number of bedrooms, required |
accommodates | number of accommodates, optional |
currency | Optional: Specify 'usd' or 'native' to return results in either USD or the local currency |
start_year | Optional: Defaults to current year. Must fall within 6 months of current year looking forward |
start_month | Optional: Defaults to current month. Must fall within 6 months of current month looking forward |
access_token: This object is a string that contains a client token, which is required for accessing the API.
city_id: This object is an optional integer that represents the ID of a city. It can be used in place of the region_id object to specify the location for which data is being requested.
region_id: This object is an optional integer that represents the ID of a region. It can be used in place of the city_id object to specify the location for which data is being requested.
number_of_months: This object is an optional integer that specifies the number of months for which data should be returned. The default value is 1.
room_types: This object is a required string that specifies the type of room for which data should be returned. Possible values are "entire_place", "private_room", and "shared_room".
bedrooms: This object is a required integer that specifies the number of bedrooms for the listings being requested.
accommodates: This object is an optional integer that specifies the number of people that a listing can accommodate.
currency: This object is an optional string that specifies the currency in which data should be returned. Possible values are "usd" and "native", with "usd" representing US dollars and "native" representing the local currency.
start_year: This object is an optional integer that specifies the year for which data should be returned. The default value is the current year. The year must fall within 6 months of the current year looking forward.
start_month: This object is an optional integer that specifies the month for which data should be returned. The default value is the current month. The month must fall within 6 months of the current month looking forward.
The information in the table is useful because it outlines the various objects that can be included in a request to the AirDNA future airbnb rates and supply API. These objects allow developers to specify the specific data they want to retrieve and how they want it formatted. For example, the city_id or region_id objects can be used to specify the location for which data is being requested, while the room_types object allows developers to specify the type of listings they want to retrieve data for. Additionally, the currency object allows developers to specify the currency in which they want the data to be returned, which can be useful for developers working with clients in different countries. Overall, the information in the table helps developers understand the various options available for customizing their requests to the API and retrieving the specific data they need.
JSON output
This JSON output contains information about Airbnb listings in a specific location, including average daily rate (ADR) and the number of available properties for each day in a specified time period. The data is organized by calendar month, with each month containing an array of days. Each day has an "adr" object, which contains the average daily rate for that day and a "percentiles" object with the 25th, 50th, 75th, and 90th percentiles of ADR. The day also has an "available_properties" object, which is an integer representing the number of available properties for that day, and a "date" object, which is a string representing the date in the format "YYYY-MM-DD". The "area_info" object contains information about the location, including the city, state, and country, as well as their respective IDs and names.
{
"area_info": {
"geom": {
"code": {
"city": "nice",
"country": "fr",
"state": "provence-alpes-cote-d-azur"
},
"id": {
"city": 35427,
"country": 3,
"state": 429
},
"name": {
"city": "Nice",
"country": "France",
"state": "Provence-Alpes-Côte d'Azur"
}
}
},
"data": {
"adr": {
"calendar_months": [
{
"days": [
{
"adr": {
"avg": 153.39159001314061,
"percentiles": {
"25": 102,
"50": 128,
"75": 178,
"90": 232
}
},
"available_properties": 761,
"date": "2018-02-23"
},
{
"adr": {
"avg": 153.41923551171394,
"percentiles": {
"25": 102,
"50": 128,
"75": 178,
"90": 230
}
},
"available_properties": 811,
"date": "2018-02-24"
},
{
"adr": {
"avg": 149.40571428571428,
"percentiles": {
"25": 102,
"50": 127,
"75": 171,
"90": 230
}
},
"available_properties": 875,
"date": "2018-02-25"
},
{
"adr": {
"avg": 147.5543822597677,
"percentiles": {
"25": 102,
"50": 127,
"75": 166.5,
"90": 230
}
},
"available_properties": 947,
"date": "2018-02-28"
}
],
"month": 2,
"year": 2018
},
{
"days": [
{
"adr": {
"avg": 148.88362512873326,
"percentiles": {
"25": 102,
"50": 127,
"75": 170.5,
"90": 230
}
},
"available_properties": 971,
"date": "2018-03-01"
},
{
"adr": {
"avg": 151.9768177028451,
"percentiles": {
"25": 102,
"50": 127,
"75": 173,
"90": 230
}
},
"available_properties": 949,
"date": "2018-03-02"
},
{
"adr": {
"avg": 152.2586387434555,
"percentiles": {
"25": 103,
"50": 127,
"75": 173.5,
"90": 230
}
},
"available_properties": 955,
"date": "2018-03-03"
},
{
"adr": {
"avg": 147.52199413489737,
"percentiles": {
"25": 102,
"50": 127,
"75": 166,
"90": 229
}
},
"available_properties": 1023,
"date": "2018-03-04"
},
{
"adr": {
"avg": 145.7339015151515,
"percentiles": {
"25": 102,
"50": 127,
"75": 165,
"90": 228.5
}
},
"available_properties": 1056,
"date": "2018-03-05"
},
{
"adr": {
"avg": 144.66574074074074,
"percentiles": {
"25": 102,
"50": 127,
"75": 165,
"90": 228
}
},
"available_properties": 1080,
"date": "2018-03-06"
},
{
"adr": {
"avg": 144.3229357798165,
"percentiles": {
"25": 102,
"50": 127,
"75": 165,
"90": 227.1
}
},
"available_properties": 1090,
"date": "2018-03-07"
},
{
"adr": {
"avg": 144.50230414746545,
"percentiles": {
"25": 102,
"50": 127,
"75": 165,
"90": 227.6
}
},
"available_properties": 1085,
"date": "2018-03-08"
},
{
"adr": {
"avg": 145.91160220994476,
"percentiles": {
"25": 102,
"50": 127,
"75": 165,
"90": 228
}
},
"available_properties": 1086,
"date": "2018-03-09"
},
{
"adr": {
"avg": 145.51459854014598,
"percentiles": {
"25": 102,
"50": 127,
"75": 165,
"90": 228
}
},
"available_properties": 1096,
"date": "2018-03-10"
},
{
"adr": {
"avg": 142.8272484416741,
"percentiles": {
"25": 102,
"50": 126,
"75": 160,
"90": 221.4
}
},
"available_properties": 1123,
"date": "2018-03-14"
},
{
"adr": {
"avg": 144.00551977920884,
"percentiles": {
"25": 102,
"50": 127,
"75": 162,
"90": 223.4
}
},
"available_properties": 1087,
"date": "2018-03-15"
},
{
"adr": {
"avg": 147.2554605887939,
"percentiles": {
"25": 102,
"50": 127,
"75": 166,
"90": 228
}
},
"available_properties": 1053,
"date": "2018-03-16"
},
{
"adr": {
"avg": 146.8847969782814,
"percentiles": {
"25": 102,
"50": 127,
"75": 165.5,
"90": 228
}
},
"available_properties": 1059,
"date": "2018-03-17"
},
{
"adr": {
"avg": 144.19174311926605,
"percentiles": {
"25": 102,
"50": 127,
"75": 164,
"90": 226.1
}
},
"available_properties": 1090,
"date": "2018-03-18"
},
{
"adr": {
"avg": 143.68383017163504,
"percentiles": {
"25": 102,
"50": 127,
"75": 163,
"90": 225.4
}
},
"available_properties": 1107,
"date": "2018-03-19"
},
{
"adr": {
"avg": 143.7158371040724,
"percentiles": {
"25": 102,
"50": 127,
"75": 162,
"90": 224.6
}
},
"available_properties": 1105,
"date": "2018-03-20"
},
{
"adr": {
"avg": 143.93586269196027,
"percentiles": {
"25": 102,
"50": 127,
"75": 163,
"90": 227.4
}
},
"available_properties": 1107,
"date": "2018-03-21"
},
"available_properties": 1086,
"date": "2018-03-22"
}
],
"month": 3,
"year": 2018
}
]
}
},
"date_range": {
"end_date": "2018-03-22",
"start_date": "2018-02-23"
},
"request_info": {
"accommodates": [],
"bedrooms": [
2
],
"city_id": 35427,
"concise": [],
"currency": "usd",
"number_of_months": 2,
"percentiles": [],
"property_types": [],
"req_type": "geom",
"room_types": [
"entire_place"
],
"start_month": 2,
"start_year": 2018
}
}
Finishing
In this conversation, we have discussed the object table and JSON output of the AirDNA future airbnb rates and supply API. We have clarified the contents and formatting of both the object table and JSON output, and provided examples to illustrate their use. We have also discussed the usefulness of the information in the object table and JSON output for developers working with this data. Overall, this information can help developers understand the options available for customizing their requests to the API and retrieving the specific data they need.
Source
To request access to the API through Worldindata, you will need to create an account and submit a request through their platform. This will typically involve providing information about your intended use of the data and agreeing to the terms of service. Once your request has been reviewed and approved, you will be granted access to the API and will be able to start using it to retrieve data. It's important to note that access to the API may be granted on a limited basis, and you may be required to pay a fee to use it. Additionally, you will need to adhere to the terms of service and any other usage restrictions that may apply.