v1

latestOpenAPI 3.1.0Apache 2.02026-07-1336147941.0 KB

listing_data

Fetch Comps for a Listing.

This endpoint allows you to search for a listing and returns a list of comparable listings.

This request will return details for the comparable listings such as:

Number of bedrooms and bathrooms
Overall Rating
Review Count
Metrics such as ADR, Revenue, and Occupancy
Amenities

Supports Currency Conversion for non-USD currencies.

By default, all currency data is in USD.

post/listing/{listingId}/comps

Path parameters

listingIdstring required

AirDNA ID for the Listing. This can often be found as property_id. The ID is prefixed with the channel the Listing belongs to:

abnb_ for Airbnb
vrbo_ for Vrbo
bkng_ for Booking.com

Smart Rates endpoints currently only model Airbnb Listings; requests with vrbo_* or bkng_* IDs are rejected with a "Smart Rates does not yet model Booking.com / Vrbo listings." envelope.

Example:abnb_XXXXXXXX

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.

Example request

{
  "pagination": {
    "page_size": 25,
    "offset": 0
  },
  "currency": "usd"
}

Response

Successful Listing Comps Response

Example response

{
  "payload": {
    "page_info": {
      "total_count": 100,
      "page_size": 25,
      "offset": 25
    },
    "comps": [
      {
        "property_id": "abnb_xxxxxx",
        "details": {
          "title": "Large Home in Denver",
          "market_name": "Denver",
          "accommodates": 16,
          "bedrooms": 9,
          "bathrooms": 9.5,
          "reviews": 50,
          "rating": 4.5,
          "images": [
            "//sample.jpeg"
          ],
          "instant_book": true,
          "minimum_stay": 2,
          "created_date": "2023-08-10",
          "license": "CITQ 092834",
          "cleaning_fee": 125
        },
        "location": {
          "lat": 39.748847,
          "lng": -104.99891
        },
        "exact_location": true,
        "location_area": {
          "country_name": "United States",
          "city_name": "Denver",
          "state_name": "Colorado",
          "msa_name": "Denver-Aurora-Lakewood, CO Metro Area"
        },
        "metrics": {
          "occupancy": 97.14,
          "adr": 2623.66,
          "revenue": 632301,
          "revenue_potential": 678864,
          "days_available": 350,
          "days_blocked": 15,
          "days_reserved": 340,
          "num_reservations": 174,
          "response_rate": 98,
          "response_time": 12.5,
          "last_calendar_update": "2024-04-30",
          "last_scraped_date": "2024-03-15"
        },
        "ratings": {
          "overall_rating": 4.5,
          "airbnb_accuracy_rating": 3,
          "airbnb_cleanliness_rating": 4.2,
          "airbnb_checkin_rating": 5,
          "airbnb_communication_rating": 2.7,
          "airbnb_location_rating": 3.9,
          "airbnb_value_rating": 4.8
        },
        "platforms": {
          "airbnb_host_id": "5678910",
          "airbnb_property_id": "12345678",
          "airbnb_property_url": "https://www.airbnb.com/rooms/12345678",
          "vrbo_property_id": "34567890ha",
          "vrbo_property_url": "https://www.vrbo.com/34567890ha",
          "booking_property_id": "1234567",
          "booking_property_url": "https://www.booking.com/hotel/us/example.html"
        },
        "amenities": {
          "has_aircon": true,
          "has_cable_tv": true,
          "has_dryer": true,
          "has_family_friendly": true,
          "has_heating": true,
          "has_hottub": true,
          "has_internet": true,
          "has_kitchen": true,
          "has_parking": true,
          "has_pets_allowed": true,
          "has_suitable_for_events": true,
          "has_tv": true,
          "has_washer": true,
          "has_wireless_internet": true
        },
        "country": {
          "country_id": 1,
          "country_name": "United States"
        },
        "market": {
          "id": "airdna-163",
          "name": "Denver",
          "market_type": "mountains_lakes",
          "market_score": 68.639
        },
        "professionally_managed": true,
        "property_manager": {
          "property_manager_name": "Super Awesome Property Manager",
          "property_count": 454,
          "review_count": 23912
        },
        "currency": "usd"
      }
    ],
    "currency": "usd"
  },
  "status": {
    "type": "success",
    "response_id": "API-S-XXX",
    "message": "A successful request was made."
  }
}