latestOpenAPI 3.1.02026-08-10390815.4 KB

e5f3dccae7ca

Accommodations

Search accommodation

This endpoint returns, by default, the cheapest available product for each accommodation that matches the specified search criteria. <br/><br/>When you apply location filters using parameters such as country or region id, the results are sorted by Booking.com popularity (top_picks) instead of price.<br/>In this case, accommodations are ranked in descending order of popularity, meaning higher-ranked listings will appear earlier in the response.

post/accommodations/search

Headers

X-Affiliate-Idinteger required

Include here your Affiliate identifier number

Request body

24_hour_receptionboolean

Filter the result based if the front desk reception is available 24/7. When specified true, the result will filter the products where front desk is available 24/7.

accommodation_facilitiesinteger[]
accommodation_typesinteger[]
accommodationsinteger[]
airportstring

A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/airports" target="_blank">common/locations/airports</a>.

brandsinteger[]
cancellation_type'free_cancellation' | 'non_refundable'

Filters the result for the cancellation type specified. Possible values are free_cancellation & non_refundable. If cancellation_type is free_cancellation, the result will contain all the products with free_cancellation.

checkinstring date required

The checkin date. Must be within 500 days in the future and in the format yyyy-mm-dd.

checkoutstring date required

The checkout date. Must be later than {checkin}. Must be between 1 and 90 days after {checkin}. Must be within 500 days in the future and in the format yyyy-mm-dd.

cityinteger

A signed integer number that uniquely identifies a city. The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/cities" target="_blank">common/locations/cities</a>.

countrystring

A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/countries" target="_blank">common/locations/countries</a>.

currencystring

A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonpayments/common/payments/currencies" target="_blank">common/payments/currencies</a>.

districtinteger

A signed integer number that uniquely identifies a district. Typically, districts define known areas within a city. The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/districts" target="_blank">common/locations/districts</a>.

dormitories'include' | 'exclude' | 'only'

This parameter specifies if the results should include dormitory beds or rooms. The default behaviour will include the dormitory beds or rooms with other results. When this flag is set to 'only', the response will only include dormitory beds or rooms. When this flag is set to 'exclude', the response will exclude dormitory beds or rooms. When this flag is set to 'include', the response will include dormitory beds or rooms with other results.

extrasstring[]

Input parameter to request for additional information about the products.

landmarkinteger

A signed integer number that uniquely identifies a relevant geographical landmark, like a monument or a natural attraction. The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/landmarks" target="_blank">common/locations/landmarks</a>.

meal_plan'all_inclusive' | 'breakfast_included' | 'full_board' | 'half_board'

Filter the result based on the selected meal plan. Example: When specified breakfast_included, it will show the product with free breakfast.

pagestring

Pagination token used to retrieve the next page of results. Obtained from next_page.

regioninteger

A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/regions" target="_blank">common/locations/regions</a>.

room_facilitiesinteger[]
rowsinteger

The maximum number of results to return.

travel_proudboolean

Filter the result based on if the property is LGBTQ+ friendly. When specified true, the result will filter and return only the accommodations that are Proud Certified.

Example request

{
  "airport": "AMS",
  "country": "nl",
  "currency": "EUR"
}

Response

Successful response.

request_idstring

Uniquely identifies the request. Please provide this identifier when contacting support.

next_pagestring nullable

Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter page).

Example response

{
  "data": [
    {
      "currency": "EUR"
    }
  ]
}