Params

Name Type Requireness Default value Description
listingUid string required none Url 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
        }
      ]
    }
  }
}

Response body schema

Name Type Description
listing_uid string UID of the listing
listing_name string Name of the listing
listing_status string One of available listing statuses (unlisted/listed)
listing_thumbnail_url string/null
timezone_id string IANA timezone name
platform_type string One of available platform types (see the corresponding filters section)
property_uid string Property UID
property_name string Name of the property
property_address string Address of the property
property_status string One of available property statuses (disabled/active)
host_uid string Host UID
host_name string Name of the host
lat string Latitude, numeric string
lng string Longitude, numeric string
listing_data Object ListingData object

ListingData schema

Name Type Description
amenityCategories string[] A list of amenities available at the listing
description string Description of the listing
rulesOfStay string Rules of stay, free format
daysAvailability int Availability window, how far in advance guests can book
currency string Currency code, 3 symbols
guestMaxCount int Maximum number of guests
guestNumberWithoutFees int Number of guests permitted without any additional fees
pricePerExtraPerson int A fee that will be applied for each additional guest, for each night of the reservation. Does not apply to infants
prepaymentType string percent (of the total reservation price) or fixed (in property currency)
prepaymentValue int Value of prepayment
paymentCancellationPolicy string Payment cancellation policy description in a free format
checkInTime string Checkin time in HH:MM format or empty string if not set
checkOutTime string Checkout time in HH:MM format or empty string if not set
isChildrenSuitable boolean Is suitable for children (2-12 years)
isInfantsSuitable boolean Is suitable for infants (under 2 years)
cleaningFee int Cleaning fee in property currency, per booking
additionalFee int Additional fee in property currency, per booking
guestSupportEmail string Guest support email
guestSupportPhone string Guest support phone number in E.164 format (numeric besides + sign)
photos Object[] array of Photo objects
taxes Object[] array of Tax objects

Photo object schema

Name Type Description
url string URL of the photo
preview_url string Preview URL of the photo
sort_order int Photo order
mime_type string Media type name

Tax object schema

Name Type Description
taxType string One of tax types
amountType string One of types of charge
amount int Tax value

Tax types

Value Name
pass_through_hotel_tax Hotel tax
pass_through_lodging_tax Lodging tax
pass_through_room_tax Room tax
pass_through_tourist_tax Tourist tax
pass_through_transient_occupancy_tax Transient occupancy tax
pass_through_sales_tax Sales tax
pass_through_vat_gst VAT/GST
pass_through_tourism_assessment_fee Tourism Assessment/Fee

Types of charge

Value Name
percent_per_reservation Percentage per booking
flat_per_guest Fixed per guest
flat_per_night Fixed per night
flat_per_guest_per_night Fixed per guest per night

Amenities

Value Name Description
Common
essentials Essentials Towels, bed sheets, soap, and toilet paper.
kitchen Kitchen Space where guests can cook their own meals.
ac AC Air conditioning.
heating Heating Central heating or a heater in the listing.
hair-dryer Hair-Dryer  
hangers Hangers  
iron Iron  
washer Washer In the building, free or for a fee.
dryer Dryer In the building, free or for a fee.
hot_water Hot Water  
tv TV  
cable Cable TV  
fireplace Indoor Fireplace  
private-entrance Private Entrance Separate street or building entrance.
private-living-room Private Living Room  
lock_on_bedroom_door Lock on Bedroom Door Private room can be locked for safety and privacy.
shampoo Shampoo  
bed_linens Bed Linens  
extra_pillows_and_blankets Extra Pillows and Blankets  
wireless_internet Wireless Internet Continuous access in the listing.
ethernet_connection Ethernet Connection  
pocket_wifi Pocket Wi-Fi  
laptop-friendly Laptop Friendly Workspace A table or desk with space for a laptop.
Kitchen
microwave Microwave  
coffee_maker Coffee maker  
refrigerator Refrigerator  
dishwasher Dishwasher  
dishes_and_silverware Dishes and Silverware  
cooking_basics Cooking Basics Pots and pans, oil, salt and pepper.
oven Oven  
stove Stove  
Facility
free_parking Free Parking on Premises  
street_parking Free Street Parking  
paid_parking Paid Parking Off Premises  
paid_parking_on_premises Paid Parking On Premises  
ev_charger EV Charger  
gym Gym Free, in the building or nearby.
pool Pool Private or Shared.
jacuzzi Hot Tub  
single_level_home Single Level Home No stairs in home.
Outdoor
bbq_area BBQ Grill  
patio_or_belcony Patio or Balcony  
garden_or_backyard Garden or Backyard  
Special
breakfast Breakfast Breakfast is provided.
beach_essentials Beach Essentials Beach towels, umbrella, beach blanket.
Logistics
luggage_dropoff_allowed Luggage Dropoff Allowed When guests have early arrival or late departure.
long_term_stays_allowed Long Term Stays Allowed Allow stay for 28 days or more.
cleaning_before_checkout Cleaning Before Checkout  
Home safety
fire_extinguisher Fire Extinguisher  
carbon_monoxide_detector Carbon Monoxide Detector  
smoke_detector Smoke Detector  
first_aid_kit First Aid Kit  
Location
beachfront Beachfront  
lake_access Lake Access  
ski_in_ski_out Ski In / Ski Out  
waterfront Waterfront  
Family
baby_bath Baby Bath  
baby_monitor Baby Monitor  
babysitter_recommendations Babysitter Recommendations  
bathtub Bathtub  
changing_table Changing Table  
childrens_books_and_toys Children’s Books and Toys  
childrens_dinnerware Children’s Dinnerware  
crib Crib  
fireplace_guards Fireplace Guards  
game_console Game Console  
high_chair High Chair  
outlet_covers Outlet Covers  
pack_n_play_travel_crib Pack’n’Play / Travel Crib  
room_darkening_shades Room-Darkening Shades  
stair_gates Stair Gates  
table_corner_guards Table Corner Guards  
window_guards Window Guards  
Accessibility inside home
wide_hallway_clearance Wide Hallway Clearance The hallways on the ground floor are at least 36 inches wide.
Accessibility getting home
home_step_free_access Step-Free Access There are no steps to get into the home, and the entryway is level.
elevator Elevator There is a step-free path that leads to your elevator. The elevator door is at least 32 inches wide.
path_to_entrance_lit_at_night Well-Lit Path to Entrance Light can help guests move around unexpected barriers.
home_wide_doorway Wide Doorway The entrance doorway is at least 32 inches wide.
flat_smooth_pathway_to_front_door Flat Path to Front Door The pathway to the front door is at least 32 inches wide and flat, with little or no slope.
disabled_parking_spot Disabled Parking Spot There is city-approved disabled parking spot or a parking space at least 8 feet wide.
Accessibility bedroom
bedroom_step_free_access Step-Free Access There are no steps to get into the bedroom, and the entryway is level.
wide_clearance_to_bed Wide Clearance to Bed There are at least 32 inches of space between the bed and the closest wall or furniture.
bedroom_wide_doorway Wide Doorway The bedroom door is at least 32 inches wide.
accessible_height_bed Accessible-Height Bed The bed’s height ranges from 19-23 inches from the floor to the top of the mattress.
electric_profiling_bed Electric Profiling Bed The bed has a legrest, knee-break and headrest that can be adjusted electronically.
Accessibility bathroom
bathroom_step_free_access Step-Free Access There are no steps to get into the bathroom, and the entryway is level.
grab_rails_in_shower Fixed Grab Bars for Shower  
grab_rails_in_toilet Fixed Grab Bars for Toilet  
accessible_height_toilet Accessible-Height Toilet The toilet seat is no higher than 17-19 inches from the floor.
rollin_shower Rolling Shower There is no threshold or step between the shower and bathroom floor.
shower_chair Shower Chair There is a chair that allows a guest to be seated in the shower. These can be wall-mounted, freestanding or wheeled.
bathroom_wide_doorway Wide Doorway The bathroom door is at least 32 inches wide.
tub_with_shower_bench Bathtub with Shower Chair  
wide_clearance_to_shower_and_toilet Wide Clearance to Shower, Toilet From the bathroom entry, the toilet and shower each have at least 32 inches of clearance to access them.
handheld_shower_head Handheld Shower Head  
Accessibility common areas
common_space_step_free_access Step-Free Access There are no steps to get into the common area, and its entry is level.
common_space_wide_doorway Wide Entryway The entryway to the common area is at least 32 inches wide.
Accessibility equipment
mobile_hoist Mobile Hoist The home has a mobile device that can lift someone in and out of a wheelchair.
pool_hoist Pool with Pool Hoist The home has a pool with a device that can lift someone in and out of it.
ceiling_hoist Ceiling Hoist The home has a device fixed to the ceiling that can lift someone in and out of a wheelchair.