The Hotel object

A hotel is one property you can book for the dates you searched. bestOption is the cheapest seller on the before-tax price. id is stable for the life of the search token, and it is also the id reviews accept after the token expires.

Attributes

idstringRequired

Hotel id. Pass it as resultId to /hotels/details, and as hotelId to /hotels/reviews.

namestring

Property name.

descriptionstring

Short description when the property publishes one.

propertyTypeobject

What kind of stay this is.

codestring

Type code, for example hotel.

namestring

Display name, for example Hotel.

starsnumber

Star rating. 0 means the property is unrated, not zero stars.

usesStarRatingboolean

True when stars is a star class rather than an unrated property.

ratingobject

Guest score.

scorenumber

Guest score on a 0–10 scale.

labelstring

Short label for the score, for example Very good.

reviewCountinteger

How many reviews the score is based on.

locationobject

Where the property is.

citystring

City.

neighborhoodstring

Neighbourhood when the property publishes one.

distancestring

Distance from the reference point, already formatted.

distanceFromstring

What the distance is measured from, for example the city centre.

latnumber

Latitude.

lngnumber

Longitude.

phonestring

Phone number when the property publishes one.

imagestring

Representative image URL.

imageCountinteger

How many images details can return.

amenitiesarray of strings

Amenity names. The ids you can filter on are in availableFilters.amenities.

badgesarray of objects

Highlights on the property. Each has type and label.

highlightstring

A short callout when the property has one.

bestOptionobject

The cheapest seller on the before-tax stay price. Details lists every seller.

providerstring

Seller with the lowest before-tax stay price.

priceobject

Stay price before taxes. This is the price a price sort uses.

amountnumber

Numeric amount in the country’s native currency.

currencystring

ISO 4217 code of that country’s native currency.

formattedstring

Same amount, already formatted for display.

totalPriceobject

Stay price with taxes included.

amountnumber

Numeric amount in the country’s native currency.

currencystring

ISO 4217 code of that country’s native currency.

formattedstring

Same amount, already formatted for display.

rateTypestring

Rate label from the seller, for example memberOnly.

freebiesarray of strings

Included extras, such as free cancellation, when the seller lists them.

taxEstimatedboolean

True when the tax portion is an estimate.

instantBookingboolean

True when the seller can confirm the stay immediately.

privateDealboolean

True when the rate is a private or member deal.

optionCountinteger

How many sellers offered this property.

usualPriceobject

A recent higher price for the same stay, when one is published.

amountnumber

Numeric amount in the country’s native currency.

currencystring

ISO 4217 code of that country’s native currency.

formattedstring

Same amount, already formatted for display.

viewRankinteger

Position of this hotel in the current sort, starting at 0.