Params

NameTypeRequirenessDefault valueDescription
listingUidstringrequirednoneUrl parameter

Description

Get information about the specific direct booking listing.

This endpoint requires the following scope: direct-bookings

Response sample

{
  "data": {
    "listing_uid": "GT0QUEMUFT28YBID_airgms_GT0QUEMAKFD400FS",
    "listing_name": "AP-EKB-1",
    "listing_status": "listed",
    "listing_thumbnail_url": "https://a0.muscache.com/im/pictures/prohost-api/Hosting-51326957/original/7b8438a2-0cd8-49b9-8731-748c1736403f.jpeg?aki_policy=x_medium",
    "timezone_id": "Asia/Yekaterinburg",
    "platform_type": "airgms",
    "property_uid": "5804533058085162365",
    "property_name": "AP-EKB-1",
    "property_address": "2 Soyuznaya Ulitsa, Yekaterinburg, Sverdlovskaya oblast' 620144, Russia",
    "property_status": "active",
    "host_uid": "GT0QUEMAKFD400FS_airgms",
    "host_name": "Alex",
    "lat": "56.8076886",
    "lng": "60.6068949",
    "listing_data": {
      "amenityCategories": [
        "ac",
        "dryer",
        "essentials",
        "hair-dryer",
        "hangers",
        "heating",
        "hot_water",
        "iron",
        "kitchen",
        "washer"
      ],
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
      "rulesOfStay": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
      "prepaymentType": "percent",
      "paymentCancellationPolicy": "",
      "guestMaxCount": 4,
      "checkInTime": "13:00",
      "checkOutTime": "11:00",
      "isChildrenSuitable": true,
      "isInfantsSuitable": true,
      "currency": "USD",
      "cleaningFee": 0,
      "guestNumberWithoutFees": 4,
      "pricePerExtraPerson": 0,
      "daysAvailability": 365,
      "photos": [
        {
          "url": "https://www.site.com/1.jpg?size=x_large",
          "preview_url": "https://www.site.com/1.jpg?size=x_medium",
          "sort_order": 1,
          "mime_type": "image/jpeg"
        },
        {
          "url": "https://www.site.com/2.jpg?size=x_large",
          "preview_url": "https://www.site.com/2.jpg?size=x_medium",
          "sort_order": 2,
          "mime_type": "image/jpeg"
        },
        {
          "url": "https://www.site.com/3.jpg?size=x_large",
          "preview_url": "https://www.site.com/3.jpg?size=x_medium",
          "sort_order": 3,
          "mime_type": "image/jpeg"
        }
      ],
      "prepaymentValue": 50,
      "guestSupportEmail": "test@example.com",
      "guestSupportPhone": "+79010003300",
      "additionalFee": 0,
      "taxes": [
        {
          "taxType": "pass_through_tourism_assessment_fee",
          "amountType": "percent_per_reservation",
          "amount": 10
        }
      ],
      "petsAllowed": true,
      "petsFee": 75
    }
  }
}

Response body schema

NameTypeDescription
listing_uidstringUID of the listing
listing_namestringName of the listing
listing_statusstringOne of available listing statuses (unlisted/listed)
listing_thumbnail_urlstring/null
timezone_idstringIANA timezone name
platform_typestringOne of available platform types (see the corresponding filters section)
property_uidstringProperty UID
property_namestringName of the property
property_addressstringAddress of the property
property_statusstringOne of available property statuses (disabled/active)
host_uidstringHost UID
host_namestringName of the host
latstringLatitude, numeric string
lngstringLongitude, numeric string
listing_dataObjectListingData object

ListingData schema

NameTypeDescription
amenityCategoriesstring[]A list of amenities available at the listing
descriptionstringDescription of the listing
rulesOfStaystringRules of stay, free format
daysAvailabilityintAvailability window, how far in advance guests can book
currencystringCurrency code, 3 symbols
guestMaxCountintMaximum number of guests
guestNumberWithoutFeesintNumber of guests permitted without any additional fees
pricePerExtraPersonintA fee that will be applied for each additional guest, for each night of the reservation. Does not apply to infants
prepaymentTypestringpercent (of the total reservation price) or fixed (in property currency)
prepaymentValueintValue of prepayment
paymentCancellationPolicystringPayment cancellation policy description in a free format
checkInTimestringCheckin time in HH:MM format or empty string if not set
checkOutTimestringCheckout time in HH:MM format or empty string if not set
isChildrenSuitablebooleanIs suitable for children (2-12 years)
isInfantsSuitablebooleanIs suitable for infants (under 2 years)
cleaningFeeintCleaning fee in property currency, per booking
additionalFeeintAdditional fee in property currency, per booking
guestSupportEmailstringGuest support email
guestSupportPhonestringGuest support phone number in E.164 format (numeric besides + sign)
photosObject[]array of Photo objects
taxesObject[]array of Tax objects
petsAllowedbooleanPets are allowed
petsFeeintPets fee value
listingRoomsObject[]Listing rooms details
bedsintNumber of total beds

Photo object schema

NameTypeDescription
urlstringURL of the photo
preview_urlstringPreview URL of the photo
sort_orderintPhoto order
mime_typestringMedia type name

Tax object schema

NameTypeDescription
taxTypestringOne of tax types
amountTypestringOne of types of charge
amountintTax value

Tax types

ValueName
pass_through_hotel_taxHotel tax
pass_through_lodging_taxLodging tax
pass_through_room_taxRoom tax
pass_through_tourist_taxTourist tax
pass_through_transient_occupancy_taxTransient occupancy tax
pass_through_sales_taxSales tax
pass_through_vat_gstVAT/GST
pass_through_tourism_assessment_feeTourism Assessment/Fee

Types of charge

ValueName
percent_per_reservationPercentage per booking
flat_per_guestFixed per guest
flat_per_nightFixed per night
flat_per_guest_per_nightFixed per guest per night

Amenities

ValueNameDescription
Common
essentialsEssentialsTowels, bed sheets, soap, and toilet paper.
kitchenKitchenSpace where guests can cook their own meals.
acACAir conditioning.
heatingHeatingCentral heating or a heater in the listing.
hair_dryerHair-Dryer 
hangersHangers 
ironIron 
washerWasherIn the building, free or for a fee.
dryerDryerIn the building, free or for a fee.
hot_waterHot Water 
tvTV 
cableCable TV 
fireplaceIndoor Fireplace 
private_entrancePrivate EntranceSeparate street or building entrance.
lock_on_bedroom_doorLock on Bedroom DoorPrivate room can be locked for safety and privacy.
shampooShampoo 
bed_linensBed Linens 
extra_pillows_and_blanketsExtra Pillows and Blankets 
wireless_internetWireless InternetContinuous access in the listing.
ethernet_connectionEthernet Connection 
pocket_wifiPocket Wi-Fi 
laptop_friendly_workspaceLaptop Friendly WorkspaceA table or desk with space for a laptop.
Kitchen
microwaveMicrowave 
coffee_makerCoffee maker 
refrigeratorRefrigerator 
dishwasherDishwasher 
dishes_and_silverwareDishes and Silverware 
cooking_basicsCooking BasicsPots and pans, oil, salt and pepper.
ovenOven 
stoveStove 
Facility
free_parkingFree Parking on Premises 
street_parkingFree Street Parking 
paid_parkingPaid Parking Off Premises 
paid_parking_on_premisesPaid Parking On Premises 
ev_chargerEV Charger 
gymGymFree, in the building or nearby.
poolPoolPrivate or Shared.
jacuzziHot Tub 
single_level_homeSingle Level HomeNo stairs in home.
Outdoor
bbq_areaBBQ Grill 
patio_or_belconyPatio or Balcony 
garden_or_backyardGarden or Backyard 
Special
breakfastBreakfastBreakfast is provided.
beach_essentialsBeach EssentialsBeach towels, umbrella, beach blanket.
Logistics
luggage_dropoff_allowedLuggage Dropoff AllowedWhen guests have early arrival or late departure.
long_term_stays_allowedLong Term Stays AllowedAllow stay for 28 days or more.
cleaning_before_checkoutCleaning Before Checkout 
Home safety
fire_extinguisherFire Extinguisher 
carbon_monoxide_detectorCarbon Monoxide Detector 
smoke_detectorSmoke Detector 
first_aid_kitFirst Aid Kit 
Location
beachfrontBeachfront 
lake_accessLake Access 
ski_in_ski_outSki In / Ski Out 
waterfrontWaterfront 
Family
baby_bathBaby Bath 
baby_monitorBaby Monitor 
babysitter_recommendationsBabysitter Recommendations 
bathtubBathtub 
changing_tableChanging Table 
childrens_books_and_toysChildren’s Books and Toys 
childrens_dinnerwareChildren’s Dinnerware 
cribCrib 
fireplace_guardsFireplace Guards 
game_consoleGame Console 
high_chairHigh Chair 
outlet_coversOutlet Covers 
pack_n_play_travel_cribPack’n’Play / Travel Crib 
room_darkening_shadesRoom-Darkening Shades 
stair_gatesStair Gates 
table_corner_guardsTable Corner Guards 
window_guardsWindow Guards 
Accessibility inside home
wide_hallway_clearanceWide Hallway ClearanceThe hallways on the ground floor are at least 36 inches wide.
Accessibility getting home
home_step_free_accessStep-Free AccessThere are no steps to get into the home, and the entryway is level.
elevatorElevatorThere is a step-free path that leads to your elevator. The elevator door is at least 32 inches wide.
path_to_entrance_lit_at_nightWell-Lit Path to EntranceLight can help guests move around unexpected barriers.
home_wide_doorwayWide DoorwayThe entrance doorway is at least 32 inches wide.
flat_smooth_pathway_to_front_doorFlat Path to Front DoorThe pathway to the front door is at least 32 inches wide and flat, with little or no slope.
disabled_parking_spotDisabled Parking SpotThere is city-approved disabled parking spot or a parking space at least 8 feet wide.
Accessibility bedroom
bedroom_step_free_accessStep-Free AccessThere are no steps to get into the bedroom, and the entryway is level.
wide_clearance_to_bedWide Clearance to BedThere are at least 32 inches of space between the bed and the closest wall or furniture.
bedroom_wide_doorwayWide DoorwayThe bedroom door is at least 32 inches wide.
accessible_height_bedAccessible-Height BedThe bed’s height ranges from 19-23 inches from the floor to the top of the mattress.
electric_profiling_bedElectric Profiling BedThe bed has a legrest, knee-break and headrest that can be adjusted electronically.
Accessibility bathroom
bathroom_step_free_accessStep-Free AccessThere are no steps to get into the bathroom, and the entryway is level.
grab_rails_in_showerFixed Grab Bars for Shower 
grab_rails_in_toiletFixed Grab Bars for Toilet 
accessible_height_toiletAccessible-Height ToiletThe toilet seat is no higher than 17-19 inches from the floor.
rollin_showerRolling ShowerThere is no threshold or step between the shower and bathroom floor.
shower_chairShower ChairThere is a chair that allows a guest to be seated in the shower. These can be wall-mounted, freestanding or wheeled.
bathroom_wide_doorwayWide DoorwayThe bathroom door is at least 32 inches wide.
tub_with_shower_benchBathtub with Shower Chair 
wide_clearance_to_shower_and_toiletWide Clearance to Shower, ToiletFrom the bathroom entry, the toilet and shower each have at least 32 inches of clearance to access them.
handheld_shower_headHandheld Shower Head 
Accessibility common areas
common_space_step_free_accessStep-Free AccessThere are no steps to get into the common area, and its entry is level.
common_space_wide_doorwayWide EntrywayThe entryway to the common area is at least 32 inches wide.
Accessibility equipment
mobile_hoistMobile HoistThe home has a mobile device that can lift someone in and out of a wheelchair.
pool_hoistPool with Pool HoistThe home has a pool with a device that can lift someone in and out of it.
ceiling_hoistCeiling HoistThe home has a device fixed to the ceiling that can lift someone in and out of a wheelchair.