DEdespegar
HotelAvailability

Availability

Search for available hotels based on input criteria.

get/hotels-api/availability

Request

  • Base URL
    https://api-dev.despegar.com/v3
  • URL
    https://api-dev.despegar.com/v3/hotels-api/availability
  • Auth
    API key in header x-apikey

Query parameters

country_codestring required

The country code of the traveler's point of sale, in ISO 3166-1 alpha-2 format. This should represent the country where the shopping transaction is taking place. If not provided, defaults to the country code associated with the API credential's POS.

checkin_datestring date required

Refers to the hotel check-in date and must be in the format YYYY-MM-DD.

checkout_datestring date required

Refers to the hotel check-out date and must be in the format YYYY-MM-DD.

currencystring required

Refers to the currency, which must be filled with three alphabetical digits. (E.g. "USD", "ARS")

hotelsstring required

List of hotel IDs, separated by commas (max. 100).

distributionstring required

Passenger distribution. Each room’s passengers should be written as number_of_adults-children_ages. Children-age goes up to 17 years old. Rooms should be separated by “!”. E.g.: Means room 1 with 2 adults and room 2 with 2 adults and a 10-year-old child.

language'EN' | 'ES' | 'PT'

Refers to the language, which must be filled with two alphabetical digits.

ttlinteger

Maximum time allowed for the connection. Minimum = 3000 ms, Maximum = 6200 ms.

refundable_onlyboolean

If set to ‘true’, only refundable hotel rates will be quoted.

limitinteger

Maximum number of results to return per page.

Response

Availability response

Example response

{
  "paging": {
    "limit": 30,
    "total": 1
  },
  "sorting": {
    "criteria": "order_by",
    "values": [
      {
        "value": "subtotal_price_ascending"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.