Skip to main content

Quick start guide

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.

Introduction​

The Stays Live Prices API is used to search for and return stay offers for any time window from the current day until one year from the current day. The API takes a location entity ID, check-in and check-out dates, and basic traveller information, and returns a list of stay offers that will be bookable by travellers.

Sample requests and responses​

/create​

curl --request POST 'https://partners.api.skyscanner.net/apiservices/v1/hotels/live/search/create' \
--header 'x-api-key: your-api-key' \
--header 'Content-Type: application/json' \
--data '{
  "query": {
    "market": "UK",
    "locale": "en-GB",
    "currency": "GBP",
    "entityId": "27544008",
    "checkinDate": {
      "year": 2025,
      "month": 9,
      "day": 15
    },
    "checkoutDate": {
      "year": 2025,
      "month": 9,
      "day": 20
    },
    "adults": 2,
    "childrenAges": [5, 8],
    "rooms": 1,
    "excludedAgentsIds": ["agent1"]
  },
  "initialPageSize": 25
}'

/poll​

In the response from the /create endpoint, retrieve the sessionToken and paste it in the /poll URI replacing the SESSION_TOKEN placeholder as below:

curl --location --request POST 'https://partners.api.skyscanner.net/apiservices/v1/hotels/live/search/poll/SESSION_TOKEN' \
--header 'x-api-key: your-api-key' \
--header 'Content-Type: application/json' \
--data '{
  "sessionToken": "VGhpcyBpcyBhIHNlc3Npb24gdG9rZW4gbm90IG1lYW50IHRvIGJlIGh1bWFuIHJlYWRhYmxlIGFuZCBpdCBzdG9yZXMgbWV0YWRhdGEgdXNlZCBieSBvdXIgaW50ZXJuYWwgc3lzdGVtcyB0byBwcm9wZXJseSBoYW5kbGUgdGhlIHJlcXVlc3Q=",
  "sort": {
    "type": "SORT_ORDER_TYPE_PRICE",
    "order": "SORT_ORDER_DIRECTION_ASCENDING"
  },
  "pagination": {
    "limit": 20,
    "offset": 0
  },
  "filters": [
    {
      "starsFilter": {
        "values": ["STARS_FOUR_STAR", "STARS_FIVE_STAR"]
      }
    },
    {
      "priceRangeFilter": {
        "minValue": 100.0,
        "maxValue": 300.0
      }
    },
    {
      "mealPlanFilter": {
        "values": ["MEAL_PLAN_TYPE_BREAKFAST_INCLUDED", "MEAL_PLAN_TYPE_ALL_INCLUSIVE"]
      }
    },
    {
      "cancellationTypeFilter": {
        "values": ["CANCELLATION_POLICY_TYPE_FREE_CANCELLATION"]
      }
    }
  ]
}'

API documentation​

For more information please see Stays Live Prices API documentation