v1

latestOpenAPI 3.1.0Apache 2.02026-07-1336147941.0 KB
market_data

Fetch Booking Lead Time Metrics for a Market.

This endpoint provides 12 to 20 months of historical monthly booking lead time data for a Market.

  • Supports some Listing Filters to calculate booking lead time for certain types of STR Listings within the Market.
post/market/{marketId}/metrics/booking_lead_time

Path parameters

marketIdstring required

AirDNA ID for the Market. This can often be found as market_id.

Example:airdna-163

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 Market Booking Lead Time Metrics Response

Example response

{
  "payload": {
    "metrics": [
      {
        "date": "2022-11",
        "reservation_counts": [
          {
            "lead_time_day_range": [
              0,
              6
            ],
            "num_reservations": 2218
          }
        ]
      }
    ],
    "monthly_pct_change": 2.41,
    "yearly_pct_change": 1.03
  },
  "status": {
    "type": "success",
    "response_id": "API-S-XXX",
    "message": "A successful request was made."
  }
}