Stays Parameters

Hotels is now Stays

Hotels is now called Stays. The API and existing integrations are unchanged. You may still see hotel or hotels in endpoint paths, fields, enum values, and other API parameters.

Page Type	Description	Landing Page
home-view	Stays Home	Link
day-view	Stays Day View	Link
hotel-details	Hotel Details	Link

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

Stays Home View Schema

/hotels/home-view

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

Stays Home View Properties

Property	Type	Required
checkin	string	Optional
checkout	string	Optional
adults	integer	Optional
rooms	integer	Optional
skyscanner_node_code	string	Optional
market	string	Optional
locale	string	Optional
currency	string	Optional

checkin

Required	Type	Format
Optional	string	YYYY-MM-DD

checkout

Required	Type	Format
Optional	string	YYYY-MM-DD

adults

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

Required	Type	Format
Optional	integer	e.g. 2

rooms

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

Required	Type	Format
Optional	integer	e.g. 1

skyscanner_node_code

The code of the destination. Supported code types:

• Country codes - 2-letter country codes (e.g. UK, ES, PT)
• Airport codes - 3-letter IATA codes (e.g. EDI, JFK, LHR)

IATA codes are often used internationally and recognised by multiple airlines and airports. Search IATA Codes.

Required	Type	Format
Optional	string	e.g. UK, BCN, EDI

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.

Required	Type	Format
Optional	string	e.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.

Required	Type	Format
Optional	string	e.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.

Required	Type	Format
Optional	string	e.g. GBP, EUR, USD

Stays Day View Schema

/hotels/day-view

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

Stays Day View Properties

Property	Type	Required
entity_id	string	Required
checkin	string	Optional
checkout	string	Optional
adults	integer	Optional
rooms	integer	Optional
sort	string	Optional
market	string	Optional
locale	string	Optional
currency	string	Optional
stars	integer[]	Optional
chains	integer[]	Optional
propertyTypes	string[]	Optional

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.

Required	Type
Required	string

checkin

Required	Type	Format
Optional	string	YYYY-MM-DD

checkout

Required	Type	Format
Optional	string	YYYY-MM-DD

adults

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

Required	Type	Format
Optional	integer	e.g. 2

rooms

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

Required	Type	Format
Optional	integer	e.g. 1

sort

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

Required	Type
Optional	enum

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

ENUM values	Explanation
price	Sorts by price in ascending order
-price	Sorts by price in descending order
distance	Sorts by distance from the city centre in ascending order
-hotel_rating	Sorts by hotel rating in descending order
stars	Sorts by hotel stars in ascending order
-stars	Sorts 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.

Required	Type	Format
Optional	string	e.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.

Required	Type	Format
Optional	string	e.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.

Required	Type	Format
Optional	string	e.g. GBP, EUR, USD

stars

List of hotel star ratings to filter results by.

When specified, only hotels matching one of the provided star ratings will be returned.

Accepted values are integers between 0 and 5.

Note: 0 represents properties with no star rating (unrated).

Multiple values can be supplied by repeating the parameter.

Required	Type	Format
Optional	integer[]	e.g. ?stars=3&stars=4

Examples:

• ?stars=4 → 4-star hotels
• ?stars=3&stars=4 → 3-star or 4-star hotels
• ?stars=0 → unrated properties
• ?stars=0&stars=4 → unrated or 4-star properties

chains

List of hotel chain entity IDs to filter results by.

When specified, only hotels belonging to one of the provided chains will be returned.

Chain entity IDs can be found in the chainGroup.chainId field within each hotel's content object in Stays Live Prices and Stays Content API responses. There is no dedicated endpoint for retrieving chain IDs.

Multiple values can be supplied by repeating the parameter.

Required	Type	Format
Optional	integer[]	e.g. ?chains=90718711&chains=90718621

propertyTypes

List of property types to filter results by.

When specified, only properties matching one of the provided types will be returned.

Supported values:

• Apartment
• GuestHouse
• HolidayRentals
• Hotel
• Hostel
• Resort
• UniqueStays

Multiple values can be supplied by repeating the parameter.

Required	Type	Format
Optional	string[]	e.g. ?propertyTypes=Hotel&propertyTypes=Apartment

Hotel Details Schema

/hotels/hotel-details

A schema definition for the hotel details microsite supported parameters.

Hotel Details Properties

Property	Type	Required
hotelId	string	Required
checkin	string	Optional
checkout	string	Optional
adults	integer	Optional
rooms	integer	Optional
market	string	Optional
locale	string	Optional
currency	string	Optional

hotelId

The Skyscanner entity ID of the specific hotel.

For more information on entity IDs, have a look at the Entity IDs section.

Required	Type	Format
Required	string	e.g. 133231627

checkin

Required	Type	Format
Optional	string	YYYY-MM-DD

checkout

Required	Type	Format
Optional	string	YYYY-MM-DD

adults

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

Required	Type	Format
Optional	integer	e.g. 2

rooms

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

Required	Type	Format
Optional	integer	e.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.

Required	Type	Format
Optional	string	e.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.

Required	Type	Format
Optional	string	e.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.

Required	Type	Format
Optional	string	e.g. GBP, EUR, USD