### Example Listing Response

Source: https://www.airroi.com/api/documentation/index

An example JSON response for a single listing, including information about the listing, host, location, property details, booking settings, pricing, ratings, and performance metrics.

```json
{
  "listing_info": {
    "listing_id": 43036533,
    "listing_name": "Beachfront Villa with Private Pool",
    "listing_type": "Entire villa",
    "room_type": "entire_home",
    "cover_photo_url": "https://a0.muscache.com/im/pictures/miso/Hosting-43036533/original/cover.jpeg",
    "photos_count": 45
  },
  "host_info": {
    "host_id": 156789234,
    "host_name": "Alexandra",
    "cohost_ids": [ ],
    "cohost_names": [ ],
    "superhost": true,
    "professional_management": false
  },
  "location_info": {
    "country_code": "US",
    "country": "United States",
    "region": "California",
    "locality": "Malibu",
    "district": "Malibu Beach",
    "latitude": 34.0259,
    "longitude": -118.7798
  },
  "property_details": {
    "guests": 8,
    "bedrooms": 4,
    "beds": 5,
    "baths": 3.5,
    "registration": true,
    "amenities": [
      "wifi",
      "kitchen",
      "free_parking_on_premises",
      "pool",
      "hot_tub",
      "beach_access",
      "bbq_grill",
      "outdoor_shower",
      "fire_pit",
      "dedicated_workspace"
    ]
  },
  "booking_settings": {
    "instant_book": false,
    "min_nights": 3,
    "cancellation_policy": "strict"
  },
  "pricing_info": {
    "currency": "usd",
    "cleaning_fee": 350,
    "extra_guest_fee": 75
  },
  "ratings": {
    "num_reviews": 89,
    "rating_overall": 4.96,
    "rating_accuracy": 4.98,
    "rating_checkin": 4.97,
    "rating_cleanliness": 4.95,
    "rating_communication": 4.98,
    "rating_location": 5,
    "rating_value": 4.92
  },
  "performance_metrics": {
    "ttm_revenue": 285000,
    "ttm_avg_rate": 1250,
    "ttm_occupancy": 0.625,
    "ttm_adjusted_occupancy": 0.61,
    "ttm_revpar": 781.25,
    "ttm_adjusted_revpar": 762.5,
    "ttm_total_days": 365,
    "ttm_available_days": 350,
    "ttm_blocked_days": 15,
    "ttm_days_reserved": 219,
    "l90d_revenue": 95000,
    "l90d_avg_rate": 1500,
    "l90d_occupancy": 0.7,
    "l90d_adjusted_occupancy": 0.68,
    "l90d_revpar": 1050,
    "l90d_adjusted_revpar": 1020,
    "l90d_total_days": 90,
    "l90d_available_days": 88,
    "l90d_blocked_days": 2,
    "l90d_days_reserved": 62
  }
}
```

--------------------------------

### Example JSON Response for Entries

Source: https://www.airroi.com/api/documentation/index

This JSON structure shows an example of the 'entries' array, typically returned when querying for market data. Each entry contains details about a specific listing or market segment, including its full name, country, region, locality, and active listings count.

```json
{
  "entries": [
    {
      "full_name": "Paris, Ile-de-France, France",
      "country": "France",
      "region": "Ile-de-France",
      "locality": "Paris",
      "district": null,
      "native_currency": "native",
      "active_listings_count": 35000
    },
    {
      "full_name": "18th Arrondissement, Paris, Ile-de-France, France",
      "country": "France",
      "region": "Ile-de-France",
      "locality": "Paris",
      "district": "18th Arrondissement",
      "native_currency": "native",
      "active_listings_count": 2500
    }
  ]

}
```

--------------------------------

### Example Sort Object for AirRoi API

Source: https://www.airroi.com/api/documentation/index

Provides an example of a sort object for the AirRoi API. This object defines the order in which results should be returned, allowing for multi-field sorting. The example shows sorting by 'ttm_revenue' in descending order, then by 'rating_overall' descending, and finally by 'cleaning_fee' in ascending order.

```json
{
  "ttm_revenue": "desc",
  "rating_overall": "desc",
  "cleaning_fee": "asc"
}
```

--------------------------------

### API Key Authentication Example (cURL)

Source: https://www.airroi.com/api/documentation/index

Demonstrates how to authenticate API requests using an API key. The API key should be included in the 'X-API-KEY' header. This is essential for accessing protected resources.

```bash
curl -X GET \
  -H "X-API-KEY: your-airroi-api-key" \
  https://api.airroi.com/listings?id=1234567890

```

--------------------------------

### API Sorting Example (JSON)

Source: https://www.airroi.com/api/documentation/index

This example demonstrates how to structure a JSON request body to sort API results. It specifies multiple sorting criteria with different directions (descending for ttm_revenue, rating_overall, and num_reviews).

```json
{
  "sort": {
    "ttm_revenue": "desc",
    "rating_overall": "desc",
    "num_reviews": "desc"
  }
}
```

--------------------------------

### Get Future Rates (cURL)

Source: https://www.airroi.com/api/documentation/index

Example of how to retrieve future nightly rates and availability for a specific Airbnb listing using cURL. This request includes the listing ID and desired currency, and requires an API key for authentication.

```bash
curl -X GET "https://api.airroi.com/listings/future/rates?id=43036533&currency=native" \
  -H "x-api-key: your-airroi-api-key"
```

--------------------------------

### Search Markets by Name (cURL)

Source: https://www.airroi.com/api/documentation/index

Example of how to search for markets by name using cURL. This endpoint allows for partial matching and is useful for building autocomplete features. It requires an API key for authentication.

```shell
curl -X GET "https://api.airroi.com/markets/search?query=Paris" \
  -H "x-api-key: your-airroi-api-key"
```

--------------------------------

### Advanced Filtering and Sorting Example (JSON)

Source: https://www.airroi.com/api/documentation/index

Provides a comprehensive JSON payload for filtering and sorting search results. It includes various filter operators like 'eq', 'range', 'all', 'any', 'none', and sorting criteria for financial performance and ratings. This example showcases how to retrieve specific, high-performing properties.

```json
{
  "filter": {
    "room_type": {"eq": "entire_home"},
    "bedrooms": {"range": [2, 5]},
    "baths": {"gte": 2},
    "guests": {"range": [4, 10]},
    "amenities": {"all": ["wifi", "kitchen", "air_conditioning"]},
    "amenities": {"any": ["pool", "hot_tub", "beach_access", "waterfront"]},
    "amenities": {"none": ["pets_allowed", "smoking_allowed"]},
    "superhost": {"eq": true},
    "instant_book": {"eq": true},
    "min_nights": {"lte": 3},
    "rating_overall": {"gte": 4.8},
    "num_reviews": {"gte": 50},
    "ttm_revenue": {"range": [75000, 250000]},
    "ttm_occupancy": {"gte": 0.7},
    "ttm_avg_rate": {"range": [200, 800]},
    "l90d_occupancy": {"gt": 0.65},
    "cleaning_fee": {"lte": 200}
  },
  "sort": {
    "ttm_revenue": "desc",
    "rating_overall": "desc",
    "ttm_occupancy": "desc",
    "ttm_avg_rate": "asc",
    "num_reviews": "desc"
  },
  "pagination": {
    "page_size": 10,
    "offset": 0
  },
  "currency": "native"
}

```

--------------------------------

### Get Market Summary

Source: https://www.airroi.com/api/documentation/index

Get a comprehensive vacation rental market overview with key performance indicators for any Airbnb market worldwide. This endpoint provides essential market summary statistics including occupancy rates, average daily rates (ADR), and revenue metrics for short-term rental market analysis.

```APIDOC
## GET /markets/summary

### Description
Get a comprehensive vacation rental market overview with key performance indicators for any Airbnb market worldwide. This endpoint provides essential market summary statistics including occupancy rates, average daily rates (ADR), and revenue metrics for short-term rental market analysis.

### Method
GET

### Endpoint
https://api.airroi.com/markets/summary

### Parameters
#### Query Parameters
- **market_id** (string) - Required - The base64-encoded market ID obtained from the /markets/lookup endpoint.

### Request Example
```curl
curl -X GET "https://api.airroi.com/markets/summary?market_id=W1JvY2tlbmhhbW0sIE5ldyBZb3JrLCBOWSwgVVNBFg" \
  -H "x-api-key: your-airroi-api-key"
```

### Response
#### Success Response (200)
- **market_id** (string) - The base64-encoded market ID.
- **full_name** (string) - The full name of the market.
- **occupancy_rate** (number) - The average occupancy rate for the market.
- **average_daily_rate** (number) - The average daily rate (ADR) for the market.
- **revenue** (number) - The total revenue for the market.

#### Response Example
```json
{
  "market_id": "W1JvY2tlbmhhbW0sIE5ldyBZb3JrLCBOWSwgVVNBFg",
  "full_name": "Rockenhamm, New York, NY, USA",
  "occupancy_rate": 0.75,
  "average_daily_rate": 150.00,
  "revenue": 11250.00
}
```

#### Error Responses
- **400**: Bad Request - The request was unacceptable, often due to missing a required parameter or invalid parameter values.
- **403**: Forbidden - API key is missing, invalid, or has insufficient permissions.
- **404**: Not Found - The requested resource could not be found.
```

--------------------------------

### AirRoi API Market Metrics Request Payload Example (JSON)

Source: https://www.airroi.com/api/documentation/index

This JSON payload demonstrates how to request market metrics, specifying market details, filters for room type, bedrooms, and amenities, the number of months for historical data, and the desired currency.

```json
{
  "market": {
    "country": "United States",
    "region": "Hawaii",
    "locality": "Maui"
  },
  "filter": {
    "room_type": {
      "eq": "entire_home"
    },
    "bedrooms": {
      "range": [
        1,
        3
      ]
    },
    "amenities": {
      "any": [
        "ocean_view",
        "beach_access",
        "pool"
      ]
    }
  },
  "num_months": 12,
  "currency": "native"
}
```

--------------------------------

### GET /listings/metrics/all

Source: https://www.airroi.com/api/documentation/index

Access comprehensive historical performance data and time-series analytics for any Airbnb listing. This endpoint delivers up to 60 months of detailed performance history including occupancy rates, average daily rates (ADR), revenue, and booking patterns.

```APIDOC
## GET /listings/metrics/all

### Description
Access comprehensive historical performance data and time-series analytics for any Airbnb listing. This endpoint delivers up to 60 months of detailed performance history including occupancy rates, average daily rates (ADR), revenue, and booking patterns. Essential for understanding seasonal trends, year-over-year growth, and long-term property performance in the short-term rental market.

### Method
GET

### Endpoint
https://api.airroi.com/listings/metrics/all

### Parameters
#### Query Parameters
- **id** (integer) - Required - The ID of the listing to retrieve metrics for.
- **currency** (string) - Optional - Default: "native" Enum: "usd" "native" Currency for financial data conversion. Allowed currency values are 'usd' (US Dollars) or 'native' (local currency). For example, 'native' automatically uses EUR in France, JPY in Japan, or BRL in Brazil etc.
- **num_months** (integer) - Optional - Default: 12 Enum: [1 .. 60] The number of months of data to return.

### Request Example
```curl
curl -X GET "https://api.airroi.com/listings/metrics/all?id=43036533&currency=native&num_months=12" \
  -H "x-api-key: your-airroi-api-key"
```

### Response
#### Success Response (200)
- **pagination** (object) - Pagination details.
  - **total_count** (integer) - Total number of results.
  - **page_size** (integer) - Number of results per page.
  - **offset** (integer) - Offset for pagination.
- **results** (array) - Array of listing metrics.
  - **listing_info** (object) - Information about the listing.
    - **listing_id** (integer) - Unique identifier for the listing.
    - **listing_name** (string) - Name of the listing.
    - **listing_type** (string) - Type of listing (e.g., 'Entire rental unit').
    - **room_type** (string) - Type of room (e.g., 'entire_home').
    - **cover_photo_url** (string) - URL of the cover photo.
    - **photos_count** (integer) - Number of photos for the listing.
  - **host_info** (object) - Information about the host.
    - **host_id** (integer) - Unique identifier for the host.
    - **host_name** (string) - Name of the host.
    - **cohost_ids** (array) - Array of co-host IDs.
    - **cohost_names** (array) - Array of co-host names.
    - **superhost** (boolean) - Indicates if the host is a superhost.
    - **professional_management** (boolean) - Indicates if the host uses professional management.
  - **location_info** (object) - Location details of the listing.
    - **country_code** (string) - ISO country code.
    - **country** (string) - Country name.
    - **region** (string) - Region or state.
    - **locality** (string) - City or locality.
    - **district** (string) - District or neighborhood.
    - **latitude** (number) - Latitude coordinate.
    - **longitude** (number) - Longitude coordinate.
  - **property_details** (object) - Details about the property.
    - **guests** (integer) - Maximum number of guests allowed.
    - **bedrooms** (integer) - Number of bedrooms.
    - **beds** (integer) - Number of beds.
    - **baths** (number) - Number of bathrooms.
    - **registration** (boolean) - Indicates if the property has registration.
    - **registration_details** (string) - Details about the registration.
    - **amenities** (array) - List of amenities available.
  - **booking_settings** (object) - Booking configuration.
    - **instant_book** (boolean) - Indicates if instant booking is enabled.
    - **min_nights** (integer) - Minimum number of nights required for booking.
    - **cancellation_policy** (string) - Cancellation policy type.
  - **pricing_info** (object) - Pricing details.
    - **currency** (string) - Currency code (e.g., 'usd').
    - **cleaning_fee** (integer) - Cleaning fee amount.
    - **extra_guest_fee** (integer) - Fee for extra guests.
  - **ratings** (object) - Overall ratings and specific category ratings.
    - **num_reviews** (integer) - Total number of reviews.
    - **rating_overall** (number) - Overall rating score.
    - **rating_accuracy** (number) - Rating for accuracy.
    - **rating_checkin** (number) - Rating for check-in experience.
    - **rating_cleanliness** (number) - Rating for cleanliness.
    - **rating_communication** (number) - Rating for communication.
    - **rating_location** (number) - Rating for location.
    - **rating_value** (number) - Rating for value.
  - **performance_metrics** (object) - Time-series performance metrics.
    - **ttm_revenue** (number) - Trailing twelve months revenue.
    - **ttm_avg_rate** (number) - Trailing twelve months average daily rate.
    - **ttm_occupancy** (number) - Trailing twelve months occupancy rate.
    - **ttm_adjusted_occupancy** (number) - Trailing twelve months adjusted occupancy rate.
    - **ttm_revpar** (number) - Trailing twelve months revenue per available room.
    - **ttm_adjusted_revpar** (number) - Trailing twelve months adjusted revenue per available room.
    - **ttm_total_days** (integer) - Trailing twelve months total days.
    - **ttm_available_days** (integer) - Trailing twelve months available days.
    - **ttm_blocked_days** (integer) - Trailing twelve months blocked days.
    - **ttm_days_reserved** (integer) - Trailing twelve months days reserved.
    - **l90d_revenue** (number) - Last 90 days revenue.
    - **l90d_avg_rate** (number) - Last 90 days average daily rate.
    - **l90d_occupancy** (number) - Last 90 days occupancy rate.
    - **l90d_adjusted_occupancy** (number) - Last 90 days adjusted occupancy rate.
    - **l90d_revpar** (number) - Last 90 days revenue per available room.
    - **l90d_adjusted_revpar** (number) - Last 90 days adjusted revenue per available room.
    - **l90d_total_days** (integer) - Last 90 days total days.
    - **l90d_available_days** (integer) - Last 90 days available days.
    - **l90d_blocked_days** (integer) - Last 90 days blocked days.
    - **l90d_days_reserved** (integer) - Last 90 days days reserved.

#### Response Example
```json
{
  "pagination": {
    "total_count": 1,
    "page_size": 10,
    "offset": 0
  },
  "results": [
    {
      "listing_info": {
        "listing_id": 43036533,
        "listing_name": "Luxury Downtown Loft with Skyline Views",
        "listing_type": "Entire rental unit",
        "room_type": "entire_home",
        "cover_photo_url": "https://a0.muscache.com/im/pictures/miso/Hosting-43036533/original/image.jpeg",
        "photos_count": 32
      },
      "host_info": {
        "host_id": 287465123,
        "host_name": "Maria",
        "cohost_ids": [
          12345678,
          87654321
        ],
        "cohost_names": [
          "John",
          "Sarah"
        ],
        "superhost": true,
        "professional_management": false
      },
      "location_info": {
        "country_code": "US",
        "country": "United States",
        "region": "California",
        "locality": "Los Angeles",
        "district": "Downtown",
        "latitude": 34.052235,
        "longitude": -118.243683
      },
      "property_details": {
        "guests": 6,
        "bedrooms": 2,
        "beds": 3,
        "baths": 2,
        "registration": true,
        "registration_details": "string",
        "amenities": [
          "wifi",
          "kitchen",
          "air_conditioning",
          "washer",
          "dryer",
          "pool",
          "gym"
        ]
      },
      "booking_settings": {
        "instant_book": true,
        "min_nights": 2,
        "cancellation_policy": "moderate"
      },
      "pricing_info": {
        "currency": "usd",
        "cleaning_fee": 125,
        "extra_guest_fee": 35
      },
      "ratings": {
        "num_reviews": 247,
        "rating_overall": 4.92,
        "rating_accuracy": 4.95,
        "rating_checkin": 4.93,
        "rating_cleanliness": 4.91,
        "rating_communication": 4.94,
        "rating_location": 4.96,
        "rating_value": 4.88
      },
      "performance_metrics": {
        "ttm_revenue": 85650.5,
        "ttm_avg_rate": 285.75,
        "ttm_occupancy": 0.82,
        "ttm_adjusted_occupancy": 0.8,
        "ttm_revpar": 234.32,
        "ttm_adjusted_revpar": 228.6,
        "ttm_total_days": 365,
        "ttm_available_days": 340,
        "ttm_blocked_days": 25,
        "ttm_days_reserved": 279,
        "l90d_revenue": 24500,
        "l90d_avg_rate": 295,
        "l90d_occupancy": 0.85,
        "l90d_adjusted_occupancy": 0.83,
        "l90d_revpar": 250.75,
        "l90d_adjusted_revpar": 244.85,
        "l90d_total_days": 90,
        "l90d_available_days": 87,
        "l90d_blocked_days": 3,
        "l90d_days_reserved": 74
      }
    }
  ]
}
```

#### Error Responses
- **400 Bad Request**: The request was unacceptable, often due to missing a required parameter or invalid parameter values. The response body will contain more details on the specific error.
- **403 Forbidden**: API key is missing, invalid, or has insufficient permissions. Ensure a valid API key is included in the 'x-api-key' header.
- **404 Not Found**: The requested resource could not be found. This could be an invalid listing ID, market ID, or an incorrect API path.
```

--------------------------------

### Active Listings Response Example (JSON)

Source: https://www.airroi.com/api/documentation/index

This JSON response shows the successful retrieval of active listing counts for a given market. It includes the market details and a list of results, where each result contains a date and the corresponding count of active listings for that date.

```json
{
  "market": {
    "country": "United States",
    "region": "Texas",
    "locality": "Austin"
  },
  "results": [
    {
      "date": "2024-01-01",
      "count": 5678
    },
    {
      "date": "2024-02-01",
      "count": 5823
    },
    {
      "date": "2024-03-01",
      "count": 5945
    },
    {
      "date": "2024-04-01",
      "count": 6102
    },
    {
      "date": "2024-05-01",
      "count": 6287
    }
  ]
}
```

--------------------------------

### Search Market Listings Request Sample (JSON)

Source: https://www.airroi.com/api/documentation/index

This JSON payload demonstrates how to search for market listings. It includes parameters for market, filters (room type, bedrooms, revenue, amenities), sorting, pagination, and currency.

```json
{
  "market": {
    "country": "United States",
    "region": "Florida",
    "locality": "Miami Beach"
  },
  "filter": {
    "room_type": {
      "eq": "entire_home"
    },
    "bedrooms": {
      "gte": 4
    },
    "ttm_revenue": {
      "gt": 150000
    },
    "amenities": {
      "all": [
        "pool",
        "beach_access",
        "air_conditioning"
      ]
    }
  },
  "sort": {
    "ttm_revenue": "desc"
  },
  "pagination": {
    "page_size": 10,
    "offset": 0
  },
  "currency": "native"
}
```

--------------------------------

### Get Market Revenue Data Description

Source: https://www.airroi.com/api/documentation/index

This section describes the 'Get Market Revenue' endpoint, which provides access to comprehensive vacation rental revenue analytics. It details the purpose of the endpoint in showing total market earnings and income trends, its value for market sizing and investment planning, and the type of historical data returned.

```markdown
## Get Market Revenue 
Access comprehensive vacation rental revenue analytics showing total market earnings and income trends for any Airbnb market. This endpoint provides aggregated revenue data demonstrating the overall market size and earning potential for short-term rentals. Valuable for market sizing, investment planning, and understanding the economic impact of vacation rentals in specific locations.
Returns historical revenue time-series data with seasonal patterns and growth trends to support market analysis and investment decisions in the short-term rental industry.
```

--------------------------------

### GET Request to AirRoi API Calculator Estimate (cURL)

Source: https://www.airroi.com/api/documentation/index

This cURL command demonstrates how to make a GET request to the AirRoi API's calculator endpoint using latitude and longitude coordinates. It includes required parameters like bedrooms, baths, and guests, as well as an optional currency parameter. The 'x-api-key' header is essential for authentication.

```curl
curl -X GET "https://api.airroi.com/calculator/estimate?lat=34.052235&lng=-118.243683&bedrooms=2&baths=2.0&guests=4&currency=native" \
  -H "x-api-key: your-airroi-api-key"
```

--------------------------------

### AirBnB API JSON Response Sample

Source: https://www.airroi.com/api/documentation/index

This is a sample JSON response from the AirBnB API, typically returned with a 200 OK status. It includes pagination details, a list of rental properties, and comprehensive information for each listing such as listing details, host information, location, property specifics, booking settings, pricing, ratings, and performance metrics. This structure is useful for understanding the data available for each rental property.

```json
{
  "pagination": {
    "total_count": 0,
    "page_size": 0,
    "offset": 0
  },
  "results": [
    {
      "listing_info": {
        "listing_id": 43036533,
        "listing_name": "Luxury Downtown Loft with Skyline Views",
        "listing_type": "Entire rental unit",
        "room_type": "entire_home",
        "cover_photo_url": "https://a0.muscache.com/im/pictures/miso/Hosting-43036533/original/image.jpeg",
        "photos_count": 32
      },
      "host_info": {
        "host_id": 287465123,
        "host_name": "Maria",
        "cohost_ids": [
          12345678,
          87654321
        ],
        "cohost_names": [
          "John",
          "Sarah"
        ],
        "superhost": true,
        "professional_management": false
      },
      "location_info": {
        "country_code": "US",
        "country": "United States",
        "region": "California",
        "locality": "Los Angeles",
        "district": "Downtown",
        "latitude": 34.052235,
        "longitude": -118.243683
      },
      "property_details": {
        "guests": 6,
        "bedrooms": 2,
        "beds": 3,
        "baths": 2,
        "registration": true,
        "registration_details": "string",
        "amenities": [
          "wifi",
          "kitchen",
          "air_conditioning",
          "washer",
          "dryer",
          "pool",
          "gym"
        ]
      },
      "booking_settings": {
        "instant_book": true,
        "min_nights": 2,
        "cancellation_policy": "moderate"
      },
      "pricing_info": {
        "currency": "usd",
        "cleaning_fee": 125,
        "extra_guest_fee": 35
      },
      "ratings": {
        "num_reviews": 247,
        "rating_overall": 4.92,
        "rating_accuracy": 4.95,
        "rating_checkin": 4.93,
        "rating_cleanliness": 4.91,
        "rating_communication": 4.94,
        "rating_location": 4.96,
        "rating_value": 4.88
      },
      "performance_metrics": {
        "ttm_revenue": 85650.5,
        "ttm_avg_rate": 285.75,
        "ttm_occupancy": 0.82,
        "ttm_adjusted_occupancy": 0.8,
        "ttm_revpar": 234.32,
        "ttm_adjusted_revpar": 228.6,
        "ttm_total_days": 365,
        "ttm_available_days": 340,
        "ttm_blocked_days": 25,
        "ttm_days_reserved": 279,
        "l90d_revenue": 24500,
        "l90d_avg_rate": 295,
        "l90d_occupancy": 0.85,
        "l90d_adjusted_occupancy": 0.83,
        "l90d_revpar": 250.75,
        "l90d_adjusted_revpar": 244.85,
        "l90d_total_days": 90,
        "l90d_available_days": 87,
        "l90d_blocked_days": 3,
        "l90d_days_reserved": 74
      }
    }
  ]
}
```

--------------------------------

### GET /websites/airroi_api

Source: https://www.airroi.com/api/documentation/index

Retrieves detailed performance metrics and comparable listing data for a specific AirBnB location.

```APIDOC
## GET /websites/airroi_api

### Description
This endpoint retrieves comprehensive performance metrics and comparable listing data for a given AirBnB location. It includes aggregated revenue, occupancy rates, average daily rates, and detailed information about similar listings in the area.

### Method
GET

### Endpoint
/websites/airroi_api

### Parameters
#### Query Parameters
* **(No query parameters documented)**

#### Request Body
* **(No request body documented)**

### Request Example
(No request example provided)

### Response
#### Success Response (200)
- **location** (object) - Geographic coordinates of the listing.
  - **latitude** (number) - Latitude of the location.
  - **longitude** (number) - Longitude of the location.
- **revenue** (number) - Total revenue for the listing.
- **average_daily_rate** (number) - Average daily rate for the listing.
- **occupancy** (number) - Occupancy rate for the listing.
- **percentiles** (object) - Performance percentile data.
  - **revenue** (object) - Revenue percentiles.
    - **avg** (number) - Average revenue.
    - **p25** (number) - 25th percentile revenue.
    - **p50** (number) - 50th percentile revenue.
    - **p75** (number) - 75th percentile revenue.
    - **p90** (number) - 90th percentile revenue.
  - **average_daily_rate** (object) - Average daily rate percentiles.
    - **avg** (number) - Average of average daily rates.
    - **p25** (number) - 25th percentile of average daily rates.
    - **p50** (number) - 50th percentile of average daily rates.
    - **p75** (number) - 75th percentile of average daily rates.
    - **p90** (number) - 90th percentile of average daily rates.
  - **occupancy** (object) - Occupancy rate percentiles.
    - **avg** (number) - Average occupancy rate.
    - **p25** (number) - 25th percentile occupancy rate.
    - **p50** (number) - 50th percentile occupancy rate.
    - **p75** (number) - 75th percentile occupancy rate.
    - **p90** (number) - 90th percentile occupancy rate.
- **currency** (string) - Currency used for financial data.
- **monthly_revenue_distributions** (array) - Monthly distribution of revenue.
- **comparable_listings** (array) - An array of objects, each representing a comparable listing.
  - **listing_info** (object) - Basic information about the listing.
    - **listing_id** (integer) - Unique identifier for the listing.
    - **listing_name** (string) - Name of the listing.
    - **listing_type** (string) - Type of listing (e.g., 'Entire home').
    - **room_type** (string) - Room type (e.g., 'entire_home').
    - **cover_photo_url** (string) - URL of the listing's cover photo.
    - **photos_count** (integer) - Number of photos for the listing.
  - **host_info** (object) - Information about the host.
    - **host_id** (integer) - Unique identifier for the host.
    - **host_name** (string) - Name of the host.
    - **cohost_ids** (array) - Array of co-host IDs.
    - **cohost_names** (array) - Array of co-host names.
    - **superhost** (boolean) - Indicates if the host is a superhost.
    - **professional_management** (boolean) - Indicates if the listing is professionally managed.
  - **location_info** (object) - Location details of the listing.
    - **country_code** (string) - ISO country code.
    - **country** (string) - Country name.
    - **region** (string) - Region or state.
    - **locality** (string) - City or town.
    - **district** (string) - Neighborhood or district.
    - **latitude** (number) - Latitude of the listing.
    - **longitude** (number) - Longitude of the listing.
  - **property_details** (object) - Details about the property.
    - **guests** (integer) - Maximum number of guests allowed.
    - **bedrooms** (integer) - Number of bedrooms.
    - **beds** (integer) - Number of beds.
    - **baths** (number) - Number of bathrooms.
    - **registration** (boolean) - Indicates if the property has a registration number.
    - **amenities** (array) - List of amenities offered.
  - **booking_settings** (object) - Booking related settings.
    - **instant_book** (boolean) - Whether instant booking is enabled.
    - **min_nights** (integer) - Minimum number of nights required for booking.
    - **cancellation_policy** (string) - Cancellation policy type.
  - **pricing_info** (object) - Pricing details.
    - **currency** (string) - Currency for pricing.
    - **cleaning_fee** (number) - Cleaning fee amount.
    - **extra_guest_fee** (number) - Fee for extra guests.
  - **ratings** (object) - Rating information.
    - **num_reviews** (integer) - Total number of reviews.
    - **rating_overall** (number) - Overall rating.
    - **rating_accuracy** (number) - Rating for accuracy.
    - **rating_checkin** (number) - Rating for check-in experience.
    - **rating_cleanliness** (number) - Rating for cleanliness.
    - **rating_communication** (number) - Rating for communication.
    - **rating_location** (number) - Rating for location.
    - **rating_value** (number) - Rating for value.
  - **performance_metrics** (object) - Performance metrics over different time periods.
    - **ttm_revenue** (number) - Trailing twelve months revenue.
    - **ttm_avg_rate** (number) - Trailing twelve months average daily rate.
    - **ttm_occupancy** (number) - Trailing twelve months occupancy rate.
    - **ttm_adjusted_occupancy** (number) - Trailing twelve months adjusted occupancy rate.
    - **ttm_revpar** (number) - Trailing twelve months revenue per available room.
    - **ttm_adjusted_revpar** (number) - Trailing twelve months adjusted revenue per available room.
    - **ttm_total_days** (integer) - Trailing twelve months total days.
    - **ttm_available_days** (integer) - Trailing twelve months available days.
    - **ttm_blocked_days** (integer) - Trailing twelve months blocked days.
    - **ttm_days_reserved** (integer) - Trailing twelve months days reserved.
    - **l90d_revenue** (number) - Last 90 days revenue.
    - **l90d_avg_rate** (number) - Last 90 days average daily rate.
    - **l90d_occupancy** (number) - Last 90 days occupancy rate.
    - **l90d_adjusted_occupancy** (number) - Last 90 days adjusted occupancy rate.
    - **l90d_revpar** (number) - Last 90 days revenue per available room.
    - **l90d_adjusted_revpar** (number) - Last 90 days adjusted revenue per available room.
    - **l90d_total_days** (integer) - Last 90 days total days.
    - **l90d_available_days** (integer) - Last 90 days available days.
    - **l90d_blocked_days** (integer) - Last 90 days blocked days.
    - **l90d_days_reserved** (integer) - Last 90 days days reserved.

#### Response Example
```json
{
  "location": {
    "latitude": 34.052235,
    "longitude": -118.243683
  },
  "revenue": 50000,
  "average_daily_rate": 200,
  "occupancy": 0.68,
  "percentiles": {
    "revenue": {
      "avg": 50000,
      "p25": 40000,
      "p50": 48000,
      "p75": 55000,
      "p90": 62000
    },
    "average_daily_rate": {
      "avg": 200,
      "p25": 170,
      "p50": 195,
      "p75": 220,
      "p90": 250
    },
    "occupancy": {
      "avg": 0.68,
      "p25": 0.55,
      "p50": 0.65,
      "p75": 0.75,
      "p90": 0.82
    }
  },
  "currency": "USD",
  "monthly_revenue_distributions": [
    0.05, 0.05, 0.07, 0.08, 0.09, 0.11, 0.13, 0.12, 0.1, 0.08, 0.06, 0.06
  ],
  "comparable_listings": [
    {
      "listing_info": {
        "listing_id": 43036533,
        "listing_name": "Beachfront Villa with Private Pool",
        "listing_type": "Entire villa",
        "room_type": "entire_home",
        "cover_photo_url": "https://a0.muscache.com/im/pictures/miso/Hosting-43036533/original/cover.jpeg",
        "photos_count": 45
      },
      "host_info": {
        "host_id": 156789234,
        "host_name": "Alexandra",
        "cohost_ids": [
          12345678,
          87654321
        ],
        "cohost_names": [
          "John",
          "Sarah"
        ],
        "superhost": true,
        "professional_management": false
      },
      "location_info": {
        "country_code": "US",
        "country": "United States",
        "region": "California",
        "locality": "Malibu",
        "district": "Malibu Beach",
        "latitude": 34.0259,
        "longitude": -118.7798
      },
      "property_details": {
        "guests": 8,
        "bedrooms": 4,
        "beds": 5,
        "baths": 3.5,
        "registration": true,
        "amenities": [
          "wifi",
          "kitchen",
          "free_parking_on_premises",
          "pool",
          "hot_tub",
          "beach_access",
          "bbq_grill",
          "outdoor_shower",
          "fire_pit",
          "dedicated_workspace"
        ]
      },
      "booking_settings": {
        "instant_book": false,
        "min_nights": 3,
        "cancellation_policy": "strict"
      },
      "pricing_info": {
        "currency": "usd",
        "cleaning_fee": 350,
        "extra_guest_fee": 75
      },
      "ratings": {
        "num_reviews": 89,
        "rating_overall": 4.96,
        "rating_accuracy": 4.98,
        "rating_checkin": 4.97,
        "rating_cleanliness": 4.95,
        "rating_communication": 4.98,
        "rating_location": 5,
        "rating_value": 4.92
      },
      "performance_metrics": {
        "ttm_revenue": 285000,
        "ttm_avg_rate": 1250,
        "ttm_occupancy": 0.625,
        "ttm_adjusted_occupancy": 0.61,
        "ttm_revpar": 781.25,
        "ttm_adjusted_revpar": 762.5,
        "ttm_total_days": 365,
        "ttm_available_days": 350,
        "ttm_blocked_days": 15,
        "ttm_days_reserved": 219,
        "l90d_revenue": 95000,
        "l90d_avg_rate": 1500,
        "l90d_occupancy": 0.7,
        "l90d_adjusted_occupancy": 0.68,
        "l90d_revpar": 1050,
        "l90d_adjusted_revpar": 1020,
        "l90d_total_days": 90,
        "l90d_available_days": 88,
        "l90d_blocked_days": 2,
        "l90d_days_reserved": 62
      }
    }
  ]
}
```
#### Error Responses
- **400 Bad Request**: The request was malformed or invalid.
- **403 Forbidden**: The authenticated user does not have permission to access this resource.
```