Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-1336147941.0 KB
submarket_data

Fetch Future Daily Pricing for a Submarket.

This endpoint provides 1 to 12 months of future daily pricing data for a Submarket.

  • Supports some Listing Filters to calculate future pricing data for certain types of STR Listings within the Submarket.
  • Supports requests to calculate custom percentiles for future daily pricing within the Submarket.
post/submarket/{submarketId}/future_pricing

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.

currency'afn' | 'all' | 'dzd' | 'usd' | 'eur' | 'aoa' | 'xcd' | 'ars' | 'amd' | 'awg' | 'aud' | 'azn' | 'bsd' | 'bhd' | 'bdt' | 'bbd' | 'byn' | 'bzd' | 'xof' | 'bmd' | 'btn' | 'inr' | 'bob' | 'bov' | 'bam' | 'bwp' | 'nok' | 'brl' | 'bnd' | 'bgn' | 'bif' | 'cve' | 'khr' | 'xaf' | 'cad' | 'kyd' | 'clf' | 'clp' | 'cny' | 'cop' | 'cou' | 'kmf' | 'cdf' | 'nzd' | 'crc' | 'hrk' | 'cuc' | 'cup' | 'ang' | 'czk' | 'dkk' | 'djf' | 'dop' | 'egp' | 'svc' | 'ern' | 'etb' | 'fkp' | 'fjd' | 'xpf' | 'gmd' | 'gel' | 'ghs' | 'gip' | 'gtq' | 'gbp' | 'gnf' | 'gyd' | 'htg' | 'hnl' | 'hkd' | 'huf' | 'isk' | 'idr' | 'xdr' | 'irr' | 'iqd' | 'ils' | 'jmd' | 'jpy' | 'jod' | 'kzt' | 'kes' | 'kpw' | 'krw' | 'kwd' | 'kgs' | 'lak' | 'lbp' | 'lsl' | 'zar' | 'lrd' | 'lyd' | 'chf' | 'mop' | 'mga' | 'mwk' | 'myr' | 'mvr' | 'mru' | 'mur' | 'xua' | 'mxn' | 'mxv' | 'mdl' | 'mnt' | 'mad' | 'mzn' | 'mmk' | 'nad' | 'npr' | 'nio' | 'ngn' | 'omr' | 'pkr' | 'pab' | 'pgk' | 'pyg' | 'pen' | 'php' | 'pln' | 'qar' | 'mkd' | 'ron' | 'rub' | 'rwf' | 'shp' | 'wst' | 'stn' | 'sar' | 'rsd' | 'scr' | 'sle' | 'sgd' | 'xsu' | 'sbd' | 'sos' | 'ssp' | 'lkr' | 'sdg' | 'srd' | 'szl' | 'sek' | 'che' | 'chw' | 'syp' | 'twd' | 'tjs' | 'tzs' | 'thb' | 'top' | 'ttd' | 'tnd' | 'try' | 'tmt' | 'ugx' | 'uah' | 'aed' | 'usn' | 'uyi' | 'uyu' | 'uzs' | 'vuv' | 'vef' | 'ved' | 'vnd' | 'yer' | 'zmw' | 'zwl'

ISO 4217 Currency Codes.

Example request

{
  "num_months": 6,
  "filters": [
    {
      "type": "gte",
      "field": "accommodates",
      "value": 4
    }
  ],
  "currency": "usd"
}

Response

Successful Submarket Future Rates Response

Example response

{
  "payload": {
    "metrics": [
      {
        "date": "2024-05-01",
        "available_count": 49810,
        "booked_count": 41755,
        "mean_available_rate": 183.94,
        "mean_booked_rate": 193.44,
        "median_booked_rate": 147.37,
        "median_available_rate": 138.16,
        "occupancy": 45.6,
        "future_rate_percentiles": [
          200,
          454,
          898
        ]
      }
    ]
  },
  "status": {
    "type": "success",
    "response_id": "API-S-XXX",
    "message": "A successful request was made."
  }
}