How does the Object and Description table and JSON Output of airbnb comp set API created by AirDNA function?

AirDNA's airbnb comp set API allows users to retrieve data on comparable listings for a given property on the Airbnb platform. One of the ways this data is returned is through an object table, which organizes the information into a structured format, with rows and columns. The other way is by JSON Output, which is a lightweight data-interchange format that is easy for humans to read and write and easy for machines to parse and generate. In this article, I will be focusing specifically on the object table and JSON output provided by AirDNA's airbnb comp set API and how it can be effectively utilized to extract valuable insights on comparable listings.

Object and Description

1. address: This object represents the street address of the property, including the street name, city, and postal code.

2. lat: This object represents the latitude coordinate of the property's location, which can be used to mark the property's position on a map.

3. lng: This object represents the longitude coordinate of the property's location, which can be used to mark the property's position on a map.

4. radius: This object represents the search radius (in meters) around a point (address or lat/long pair) within which properties will be included in the search results. This parameter is required for point-radius searches.

5. city_id: This object is optional. All returned properties will be contained within the city boundary. This parameter allows to filter the properties based on the city ID, so all the returned properties will be located in the desired city.

6. region_id : This object is optional. All returned properties will be contained within the region boundary. This parameter allows to filter the properties based on the region ID, so all the returned properties will be located in the desired region.

7. order: This object allows you to specify the order of the returned properties, based on a specific criteria such as proximity, revenue, reviews, or average daily rate (adr). The default is "revenue". If "proximity" is selected, it will only return the closest results first when searching with an address or lat/long pair

8. desc: This object is a boolean value that determines whether the search results are returned in descending order. The default is true, but setting it to false allows you to return the closest results first when ordering by proximity.

9. bedrooms: This object specifies the number of bedrooms in the property.

10. accommodates: This object specifies the number of people the property can accommodate.

11. room_types: This object allows you to filter properties based on the room type (entire home, private room, shared room).

12. show_amenities: This object is a boolean value that specifies whether or not to include property amenities in the search results. Defaults to False.

13. show_images: This object is a boolean value that specifies whether or not to include image urls for the associated property listings in the search results. Defaults to False

14. show_location: This object is a boolean value that specifies whether or not to include locational information for properties in the search results. Defaults to False

15. access_token: This object is required for access to the API, in this table it is being represented by a placeholder {{CLIENT_TOKEN}}.

16. adr_min: This object allow to filter property results based on a minimum average daily rate.

17. adr_max: This object allow to filter property results based on a maximum average daily rate.

18. currency: This object allow to specify 'usd' or 'native' to return results in either USD or the local currency of the location respectively.

19. limit: This object allows to specify a limit of returned properties, with a max value of 25.

The table I provided lists all the objects that can be used as parameters in the AirDNA's airbnb comp set API, along with a brief description of their function. The information in the table is extremely useful because it allows developers to understand the different options available for filtering and ordering the properties returned by the API. For example, developers can use the radius object to specify a search radius around a point, the bedrooms and accommodates objects to filter properties based on the number of bedrooms and accommodates, and the order object to specify the sorting order of the results. Additionally, developers can choose to include or exclude certain information in the returned data using the show_amenities, show_images, and show_location objects. Overall, the table provides a clear and comprehensive overview of the parameters that can be used to customize the data returned by the API, making it an invaluable resource for developers working with the AirDNA's airbnb comp set API.

Explaining the JSON output

The provided JSON output represents a sample of data returned by the AirDNA's airbnb comp set API. It has two main objects "area_info" and "properties". The "area_info" object contains information about the location of the properties, specifically the "geom" which has further nested objects. "geom" object itself has three nested objects: "code", "id" and "name". These three nested objects contains details about city, state and country in the form of code, id and name respectively.

The "properties" object is an array of objects, each representing a single property. The data for each property includes its amenities, pricing, location and other details such as accommodation count, bathrooms, bedrooms, cancellation policy, check-in and check-out time, cleaning fee, last calendar update and etc. Each property object also includes a URL for the listing on Airbnb, location details, and information about the host. Other details includes occupancy rate, number of reservations, revenue, reviews and other details. The data provided in the "properties" array can be used to compare properties with each other, extract insights, trends, and make data-driven decisions.

{
"area_info": {
"geom": {
"code": {
"city": "denver",
"country": "us",
"state": "colorado"
},
"id": {
"city": 59380,
"country": 1,
"state": 7
},
"name": {
"city": "Denver",
"country": "United States",
"state": "Colorado"
}
}
},
"properties": [
{
"accommodates": 14,
"adr": 1336.69,
"airbnb_host_id": 23724674,
"airbnb_property_id": 4576625,
"bathrooms": 4.5,
"bedrooms": 5,
"business_ready": false,
"cancellation": "strict",
"check_in": "Anytime after 4PM",
"check_out": "11AM",
"cleaning_fee": 200,
"days_a_ltm": 138,
"days_b_ltm": 24,
"days_r_ltm": 203,
"extra_person_charge": 50,
"img_count": 26,
"img_cover": "https://a0.muscache.com/im/pictures/86dfda4c-fa8a-4ee9-94a2-434894c4e9f1.jpg?aki_policy=x_large",
"instant_book": true,
"last_calendar_update": "2018-02-16",
"latitude": 39.7610167973274,
"listed_dt": "2014-10-24",
"listing_url": "https://www.airbnb.com/rooms/4576625",
"location": {
"city": "Denver",
"country": "United States",
"msa": "Denver-Aurora-Lakewood, CO Metro Area",
"neighborhood": [
"Highland"
],
"state": "Colorado",
"zipcode": "80211"
},
"longitude": -105.008507384098,
"minimum_stay": 2,
"num_res_ltm": 64,
"occ": 0.595308,
"price_monthly": 17000,
"price_nightly": 725,
"price_weekly": 5600,
"property_type": "Entire house",
"rating_overall": 9.9,
"response_rate": 100,
"response_time": 229,
"revenue": 271348,
"reviews": 124,
"room_type": "Entire home/apt",
"scraped_dt": "2018-02-25",
"security_deposit": 1000,
"superhost": true,
"title": "Huge Home in the Heart of Lohi! Groups Welcome!"
},

In summary

In conclusion, the AirDNA's airbnb comp set API is a powerful tool that allows developers to retrieve data on comparable listings on the Airbnb platform. The API can return the data in both object table and JSON format, providing a structured and easily readable format respectively. The object table provides a clear and comprehensive overview of the parameters that can be used to customize the data returned by the API. The JSON output, on the other hand, provides a detailed data on different properties with all the necessary information such as location, pricing, amenities, occupancy and reviews. Developers can use these parameters and data to extract valuable insights and make data-driven decisions. The information provided in this conversation should help developers effectively utilize the AirDNA's airbnb comp set API to retrieve and make use of the data provided.

Endnote

AirDNA's airbnb comp set API is a proprietary product that requires access credentials in order to be used. One way to access the API is through a third-party data marketplace Worldindata. Worldindata is a platform that provides access to a wide variety of datasets and APIs, including AirDNA's airbnb comp set API. By subscribing to Worldindata, developers can gain access to AirDNA's airbnb comp set API and use it to retrieve data on comparable listings on the Airbnb platform. Developers can use this data to extract valuable insights and make data-driven decisions.