Skip to main content

Hotels Parameters

Page TypeDescriptionLanding Page
home-viewHotels HomeLink
day-viewHotels Day ViewLink
hotel-detailsHotel DetailsLink

For more details on the supported verticals and page types, please visit Verticals and Page Types.

Hotels Home View Schema

/hotels/home-view

A schema definition for the hotels home-view microsite supported parameters.

Hotels Home View Properties

PropertyTypeRequired
checkinstringOptional
checkoutstringOptional
adultsintegerOptional
roomsintegerOptional
skyscanner_node_codestringOptional
marketstringOptional
localestringOptional
currencystringOptional

checkin

RequiredTypeFormat
OptionalstringYYYY-MM-DD

checkout

RequiredTypeFormat
OptionalstringYYYY-MM-DD

adults

Number of adults. The number of adults should be greater than or equal to the number of rooms.

RequiredTypeFormat
Optionalintegere.g. 2

rooms

Number of rooms. The number of rooms should be less than or equal to the number of adults.

RequiredTypeFormat
Optionalintegere.g. 1

skyscanner_node_code

The IATA code of the destination. IATA codes are available for airlines, airports and cities. They are often used internationally and recognised by multiple airlines and airports. Search IATA Codes

RequiredTypeFormat
Optionalstringe.g. EDI, BCN, LIS

market

The preferred market for searching results.

When unspecified, we use detection logic to determine the market, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.

RequiredTypeFormat
Optionalstringe.g. UK, US, FR

locale

The preferred locale for the desired page.

When unspecified, we use detection logic to determine the locale, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.

RequiredTypeFormat
Optionalstringe.g. es-ES, en-GB, fr-FR

currency

The preferred currency for the desired page.

When unspecified, we use detection logic to determine the currency, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.

RequiredTypeFormat
Optionalstringe.g. GBP, EUR, USD

Hotels Day View Schema

/hotels/day-view

A schema definition for the hotels day-view microsite supported parameters.

Hotels Day View Properties

PropertyTypeRequired
entity_idstringRequired
checkinstringOptional
checkoutstringOptional
adultsintegerOptional
roomsintegerOptional
sortstringOptional
marketstringOptional
localestringOptional
currencystringOptional

entity_id

The ID of the geo location for which the search will be performed.

For more information on the entity_id supported values, have a look at the IATA codes and Entity IDs page.

RequiredType
Requiredstring

checkin

RequiredTypeFormat
OptionalstringYYYY-MM-DD

checkout

RequiredTypeFormat
OptionalstringYYYY-MM-DD

adults

Number of adults. The number of adults should be greater than or equal to the number of rooms.

RequiredTypeFormat
Optionalintegere.g. 2

rooms

Number of rooms. The number of rooms should be less than or equal to the number of adults.

RequiredTypeFormat
Optionalintegere.g. 1

sort

Defines the order in which search results appear. If not specified, results will be sorted by best.
Learn more

RequiredType
Optionalenum

The value of this property must be equal to one of the following values:

ENUM valuesExplanation
priceSorts by price in ascending order
-priceSorts by price in descending order
distanceSorts by distance from the city centre in ascending order
-hotel_ratingSorts by hotel rating in descending order
starsSorts by hotel stars in ascending order
-starsSorts by hotel stars in descending order

market

The preferred market for searching results.

When unspecified, we use detection logic to determine the market, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.

RequiredTypeFormat
Optionalstringe.g. UK, US, FR

locale

The preferred locale for the desired page.

When unspecified, we use detection logic to determine the locale, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.

RequiredTypeFormat
Optionalstringe.g. es-ES, en-GB, fr-FR

currency

The preferred currency for the desired page.

When unspecified, we use detection logic to determine the currency, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.

RequiredTypeFormat
Optionalstringe.g. GBP, EUR, USD

Hotel Details Schema

/hotels/hotel-details

A schema definition for the hotel details microsite supported parameters.

Hotel Details Properties

PropertyTypeRequired
hotelIdstringRequired
checkinstringOptional
checkoutstringOptional
adultsintegerOptional
roomsintegerOptional
marketstringOptional
localestringOptional
currencystringOptional

hotelId

The entity ID of the hotel.

For more information on the hotelId supported values, have a look at the IATA codes and Entity IDs page.

RequiredType
Requiredstring

checkin

RequiredTypeFormat
OptionalstringYYYY-MM-DD

checkout

RequiredTypeFormat
OptionalstringYYYY-MM-DD

adults

Number of adults. The number of adults should be greater than or equal to the number of rooms.

RequiredTypeFormat
Optionalintegere.g. 2

rooms

Number of rooms. The number of rooms should be less than or equal to the number of adults.

RequiredTypeFormat
Optionalintegere.g. 1

market

The preferred market for searching results.

When unspecified, we use detection logic to determine the market, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.

RequiredTypeFormat
Optionalstringe.g. UK, US, FR

locale

The preferred locale for the desired page.

When unspecified, we use detection logic to determine the locale, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.

RequiredTypeFormat
Optionalstringe.g. es-ES, en-GB, fr-FR

currency

The preferred currency for the desired page.

When unspecified, we use detection logic to determine the currency, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.

RequiredTypeFormat
Optionalstringe.g. GBP, EUR, USD