Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-1336147941.0 KB
listing_data

Explore Listings Within a Given Radius

This endpoint will return a list of comparable listings within a radius of a given address or location.

Use Listing Filters to specify details for listings you want to search for.

This request will return details about the 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/comps/area

Request body

OR

Example request

{
  "address": "1321 15th St. Denver, CO 80202",
  "radius": 1500,
  "pagination": {
    "page_size": 25,
    "offset": 0
  },
  "filters": [
    {
      "type": "gte",
      "field": "accommodates",
      "value": 4
    }
  ],
  "currency": "usd"
}

Response

Successfully retrieved Listings within a given Area.

Example response

{
  "payload": {
    "page_info": {
      "total_count": 100,
      "page_size": 25,
      "offset": 25
    },
    "listings": [
      {
        "property_id": "abnb_12345678",
        "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",
        "market_id": "airdna-163",
        "market_name": "Denver",
        "country_name": "United States",
        "city_name": "Denver",
        "state_name": "Colorado",
        "msa_name": "Denver-Aurora-Lakewood, CO Metro Area",
        "location": {
          "lat": 39.748847,
          "lng": -104.99891
        },
        "exact_location": true,
        "title": "Large Home in Denver",
        "bedrooms": 9,
        "bathrooms": 9.5,
        "accommodates": 16,
        "rating": 4.5,
        "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
        },
        "instant_book": true,
        "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
        },
        "property_manager_name": "Super Awesome Property Manager",
        "professionally_managed": true,
        "reviews": 50,
        "revenue_ltm": 693015,
        "revenue_potential_ltm": 715250,
        "occupancy_rate_ltm": 97.14,
        "average_daily_rate_ltm": 1974.4,
        "days_available_ltm": 350,
        "days_blocked_ltm": 15,
        "days_reserved_ltm": 340,
        "num_reservations_ltm": 174,
        "cleaning_fee": 125,
        "created_date": "2023-08-10",
        "last_calendar_update": "2024-04-30",
        "last_scraped_date": "2024-03-15",
        "license": "CITQ 092834",
        "minimum_stay": 2,
        "response_rate": 98,
        "response_time": 12.5,
        "currency": "usd",
        "distance": 1234.5
      }
    ]
  },
  "status": {
    "type": "success",
    "response_id": "API-S-XXX",
    "message": "A successful request was made."
  }
}