v1

latestOpenAPI 3.1.0Apache 2.02026-07-1336147941.0 KB
submarket_data

Fetch Average Length of Stay Metrics for a Submarket.

This endpoint provides 12 to 20 months of historical monthly average length of stay data for a Submarket.

  • Supports some Listing Filters to calculate average length of stay for certain types of STR Listings within the Submarket.
post/submarket/{submarketId}/metrics/avg_length_of_stay

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.

Example request

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

Response

Successful Submarket Average Length of Stay Metrics Response

Example response

{
  "payload": {
    "metrics": [
      {
        "date": "2022-11",
        "days_avg": 3.68
      }
    ],
    "monthly_pct_change": -9.14,
    "yearly_pct_change": -1.54
  },
  "status": {
    "type": "success",
    "response_id": "API-S-XXX",
    "message": "A successful request was made."
  }
}