demand-api-v2-compatible

List all bookable rooms at a property

Changed on

This endpoint is where you find a list of all bookable or available rooms at a property. A room can have multiple blocks, as a block is a combination of the meal, cancellation policy, occupancy and other things. You can find detailed information about one hotel per search (detail_level) which will return most of the information needed to replicate the booking.com property page.

If you want to search multiple hotels, you can, but you get less detail. For searching multiple hotels, it is recommended to use hotelAvailability.

get/demand-api-v2-compatible/blockAvailability

Request

Query parameters

hotel_idsinteger[] required

Hotel ID(s) to check availability for.

checkinstring date required

The arrival date.

checkoutstring date required

The departure date. Must be later than {checkin}.

guest_ccstring required

Guest country code. Used to accurately display the best prices and price details for people from that country.

currencystring

Returns the prices in this currency, in addition to the hotel currency.

extrasstring[]

The extra items for this request. See the documentation for more details about each extra.

block_idsstring[]

Return only availability hits with these particular block IDs

guest_ipstring

Guest IP address for determining guest country and showing the best price for that user and obeying laws regarding the display of taxes and fees.

guest_qtyinteger[]

Number of guests for which blocks will be found. The total number of guests is used for calculating city tax charges. It is specified as an array of guest numbers.

NOTE: either this or room1 needs to be provided.

room1string[]

Guests per room, as a comma-separated list: A for each adult and the age (0-17) for each child (e.g. A,A,5 = two adults and a 5-year-old). For multi-room searches, repeat the parameter per room as room1, room2, ... up to room30.

NOTE: either this or guest_qty needs to be provided.

language'ar' | 'bg' | 'ca' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en-gb' | 'en-us' | 'es' | 'es-ar' | 'es-mx' | 'et' | 'fi' | 'fr' | 'he' | 'hi' | 'hr' | 'hu' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'ko' | 'lt' | 'lv' | 'ms' | 'nl' | 'no' | 'pl' | 'pt-br' | 'pt-pt' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'sr' | 'sv' | 'th' | 'tl' | 'tr' | 'uk' | 'vi' | 'zh' | 'zh-cn' | 'zh-tw'

Specify the language for: block_id, policies, room texts and hotel descriptions.

Note: not all text is translated in all languages. Please check the "Possible Values" section of the documentation for the accepted language codes.

user_platform'DESKTOP' | 'MOBILE'

The user's platform.

limit_incremental_pricesinteger

Limit the number of incremental prices returned per block. Added for meta partners that only need the first one.

allow_pastboolean

Allow yesterday's checkin date when combined with is24hr.

is24hrboolean

Only show hotels with 24-hour front desk. Combined with allow_past, allows yesterday's checkin.

geniusinteger

Genius level (1, 2, or 3) for accessing Genius rates. Defaults to 0 (no genius). Level 1: 10% discount. Level 2: 15% discount + perks (free breakfast, room upgrades). Level 3: 20% discount.

{
  "block_ids": [
    "5555555_55555555_5_5_5,6666666_66666666_6_6_6"
  ]
}

Headers

Accept'application/json, application/xml'

Response

OK

Changes

    • breaking

      removed the enum value ANDROID from the property user_platform of the query request parameter blockInput

    • breaking

      removed the enum value IOS from the property user_platform of the query request parameter blockInput

    • breaking

      removed the enum value TABLET from the property user_platform of the query request parameter blockInput

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/xml)

    • info

      added the enum value PPT to the property extras/items/ of the query request parameter blockInput

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/xml)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/xml)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/xml)

    • info

      removed the optional write-only property result/items/isFlashDeal from the response with the status (media type: application/json)

    • info

      removed the optional write-only property result/items/isFlashDeal from the response with the status (media type: application/xml)