Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-1336147941.0 KB
submarket_data

Explore Submarkets within a Market.

If you're looking to explore & compare top Submarkets, you can do so either by general Submarket characteristics, or even compare them based on specific types of Listings!

Each Submarket includes the following summary metrics (Last 12 months):

  • Market Score
  • Occupancy
  • Revenue
  • RevPAR

Here are some examples of the many things you can do:

  • Sort Submarkets by highest Market Score, Occupancy, Revenue, Average Daily Rate or Review Count.
  • Find Submarkets that have a high Seasonality score (a higher score means the Submarket is more stable throughout the year).
  • Find Submarkets that have a high Regulation score (a higher score means it's less regulated/strict).
  • Find Submarkets that have a high Rental Demand score (a higher score means the booking demand is higher).
  • Use our Listing Filters to compare Submarket performance for certain types of STR Listings.
post/market/{marketId}/submarkets

Path parameters

marketIdstring required

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

Example:airdna-163

Request body

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.

sort_order'market_score' | 'revenue' | 'occupancy' | 'adr' | 'review_count'

The attribute by which the retrieved results will be sorted.

  • Sorted in descending order (Highest to Lowest).
include_geomsboolean

Set this to true if you want to include the approximate geometric boundaries for the returned data.

Example request

{
  "pagination": {
    "page_size": 25,
    "offset": 0
  },
  "bounding_box": {
    "ne": {
      "lat": 40.23006276087403,
      "lng": -104.4991649290008
    },
    "sw": {
      "lat": 39.321066395153956,
      "lng": -105.42090990822489
    }
  },
  "filters": [
    {
      "type": "gte",
      "field": "accommodates",
      "value": 4
    }
  ],
  "currency": "usd"
}

Response

Successfully retrieved Submarkets within a Country.