Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-1336147941.0 KB
submarket_data

Fetch Occupancy Metrics for a Submarket.

This endpoint provides 12 to 60 months of historical monthly occupancy data for a Submarket.

  • Each month shows the following metrics:

    • The month.
    • The average occupancy rate of Listings in that month.
    • The number of unique active Listings that were not booked in that month.
    • The number of booked Listings in that month.
    • The number of days available in that month.
    • The number of days booked in that month.

  • Supports some Listing Filters to calculate historical occupancy for certain types of STR Listings within the Submarket.

  • Supports requests to calculate custom percentiles for occupancy rates within the Submarket.

post/submarket/{submarketId}/metrics/occupancy

Path parameters

submarketIdstring required

AirDNA ID for the Submarket. This can often be found as submarket_id.

Example:airdna-2331

Request body

num_monthsinteger required

The number of months to request metrics for.

percentilesnumber[]

An optional array of percentiles to request data for. Each percentile must be in decimal form (i.e. 0.25 for 25th percentile) and between 0 and 1.

Example request

{
  "num_months": 12,
  "filters": [
    {
      "type": "gte",
      "field": "accommodates",
      "value": 4
    }
  ]
}

Response

Successful Submarket Occupancy Metrics Response.

Example response

{
  "payload": {
    "metrics": [
      {
        "date": "2022-11",
        "occupancy_rate": 58.15,
        "available_listings": 2893,
        "booked_listings": 4827,
        "days_available": 12832,
        "days_booked": 83926,
        "occupancy_rate_percentiles": [
          20,
          45,
          89
        ]
      }
    ],
    "monthly_pct_change": -9.14,
    "yearly_pct_change": -1.54
  },
  "status": {
    "type": "success",
    "response_id": "API-S-XXX",
    "message": "A successful request was made."
  }
}