GET availabilities

get

https://api.bookingexperts.com/v3/availabilities

Returns availability & prices for up to 24 months in the future. The maximum search window per request is 120 days, but a custom start date range can be defined to fetch availability that is further in the future. When searching for single rentable type or package availability, the default search window is extended to 24 months. The maximum length of stay (LOS) that can be searched for is 30 days. The results can be filtered and sorted in various ways, see the documented parameters. Note that at least one channel must be associated with your app and you must have the availability|read scope to be able to use this endpoint.

Query Params

fields[availability]

string

Fieldset. Specify a comma separated list of attributes to return

include

string

Includes list. Specify a comma separated list of resources to include.

channel_ids

string

Specify a comma separated list of channel IDs to be used for searching availability. By default, all accessible channels associated to your app will be used. Overriding this may be useful when you have access to multiple channels of the same administration.

include_rentable_type_counts

boolean

When true, the amount of results per global segment will be added to the metadata. DEPRECATED: use include_semantic_segment_counts instead.

include_semantic_segment_counts

boolean

When true, the amount of results per global segment will be added to the metadata.

include_amenity_counts

boolean

When true, the amount of results per amenity will be added to the metadata

referrer

string

Referrer name

filter[start_date]

string

Filter on start date. Expects a date range. Note: date ranges have an exclusive end date.

filter[overlaps_date]

string

Filter availabilities that (partially) overlap these dates.

filter[includes_date]

string

Filter availabilities that contain the specified date range.

filter[arrangement]

string

Filter on availabilities that exactly match the supplied date range.

filter[los]

string

Filter on length of stay.

filter[wday]

integer

Filter on a particular week day. 0 = sunday.

filter[administration_ids]

string

Filter on administrations. Specify a comma separated list.

filter[rentable_type_ids]

string

Filter on types. Specify a comma separated list.

filter[-rentable_type_ids]

string

Exclude types. Specify a comma separated list.

filter[category_ids]

string

Filter on types. Specify a comma separated list. DEPRECATED: use filter[rentable_type_ids] instead.

filter[-category_ids]

string

Exclude types. Specify a comma separated list. DEPRECATED: use filter[-rentable_type_ids] instead.

filter[region_ids]

string

Filter on regions. Specify a comma separated list.

filter[-region_ids]

string

Exclude regions. Specify a comma separated list.

filter[rentable_segment_ids]

string

Filter on rentable segments. Specify a comma separated list.

filter[-rentable_segment_ids]

string

Exclude rentable segments. Specify a comma separated list.

filter[amenity_ids]

string

Filter on amenities. Specify a comma separated list.

filter[package_id]

string

Filter on package ID.

filter[discount_campaign_id]

string

Filter on discount campaign ID.

filter[inventory_object_id]

string

Filter on inventory object ID.

filter[promotion_token]

string

Filter on owner promotion token.

filter[country_codes]

string

Filter on country codes. Specify a comma separated list of ISO 3166-1 alpha-2 country codes. For example: NL,EN,DE.

filter[-country_codes]

string

Exclude country codes. Specify a comma separated list of ISO 3166-1 alpha-2 country codes.

filter[rentable_types]

string

Filter on global segments. DEPRECATED: use filter[semantic_segments] instead. Specify a comma separated list. Available global segments: house, pitch, room, berth, apartment, other, year_site, b_and_b, bungalow, cabin, campervan_pitch, caravan_pitch, chalet, cottage, glamping_tent, hotel_room, houseboat, mobile_home, tent_pitch, tiny_house, treehouse, villa.

filter[-rentable_types]

string

Exclude global segments. DEPRECATED: use filter[-semantic_segments] instead. Specify a comma separated list. Available global segments: house, pitch, room, berth, apartment, other, year_site, b_and_b, bungalow, cabin, campervan_pitch, caravan_pitch, chalet, cottage, glamping_tent, hotel_room, houseboat, mobile_home, tent_pitch, tiny_house, treehouse, villa.

filter[semantic_segments]

string

Filter on global segments. Specify a comma separated list. Available global segments: house, pitch, room, berth, apartment, other, year_site, b_and_b, bungalow, cabin, campervan_pitch, caravan_pitch, chalet, cottage, glamping_tent, hotel_room, houseboat, mobile_home, tent_pitch, tiny_house, treehouse, villa.

filter[-semantic_segments]

string

Exclude global segments. Specify a comma separated list. Available global segments: house, pitch, room, berth, apartment, other, year_site, b_and_b, bungalow, cabin, campervan_pitch, caravan_pitch, chalet, cottage, glamping_tent, hotel_room, houseboat, mobile_home, tent_pitch, tiny_house, treehouse, villa.

filter[guest_group][seniors]

integer

Filter on number of seniors.

filter[guest_group][adults]

integer

Filter on number of adults.

filter[guest_group][adolescents]

integer

Filter on number of adolescents.

filter[guest_group][children]

integer

Filter on number of children.

filter[guest_group][babies]

integer

Filter on number of babies.

filter[guest_group][pets]

integer

Filter on number of pets.

filter[price]

string

Filter on a price range

filter[currency]

string

Filter on a specific ISO 4217 currency code. By default the prices are returned in the administration's native currency. Results can differ per currency.

filter[number_of_bedrooms]

integer

Filter on type number of bedrooms

filter[number_of_beds]

integer

Filter on type number of beds

filter[number_of_showers]

integer

Filter on type number of showers

filter[number_of_toilets]

integer

Filter on type number of toilets

filter[number_of_bathrooms]

integer

Filter on type number of bathrooms

filter[number_of_parking_spots]

integer

Filter on type number of parking spots

filter[number_of_child_beds]

integer

Filter on type number of child beds

filter[number_of_child_chairs]

integer

Filter on type number of child chairs

sorters

string

Specify a comma separated list of sorters to apply. There are 10 possible sorters:

los Order by length of stay
los_distance Order by the distance of a particular length of stay
start_date Order by start dates
start_date_distance Order by the distance of a particular start date
arrangement_distance Order by the distance of a particular arrangement
max_guests Order by maximum guests of the type
highlighted Order by availabilities that have a type that is highlighted
all_in_amount Order by price
amenity_ids_match_score Order by whether the amenities match
avg_score Order by average review score of the type

Configuration for each applied sorter (for example descending order) must be passed separately, see the options below.

sorter[los][desc]

boolean

Boolean specifying the sort direction for the los sorter. When unspecified, ascending order is implied.

sorter[los_distance][desc]

boolean

Boolean specifying the sort direction for the los_distance sorter. When unspecified, ascending order is implied.

sorter[los_distance][los]

integer

Length of stay for the los_distance sorter

sorter[start_date][desc]

boolean

Boolean specifying the sort direction for the start_date sorter. When unspecified, ascending order is implied.

sorter[start_date_distance][desc]

boolean

Boolean specifying the sort direction for the start_date_distance sorter. When unspecified, ascending order is implied.

sorter[start_date_distance][start_date]

string

Start date for the start_date_distance sorter

sorter[arrangement_distance][desc]

boolean

Boolean specifying the sort direction for the arrangement_distance sorter. When unspecified, ascending order is implied.

sorter[arrangement_distance][arrangement]

string

Arrangement for the arrangement_distance sorter

sorter[max_guests][desc]

boolean

Boolean specifying the sort direction for the max_guests sorter. When unspecified, ascending order is implied.

sorter[highlighted][desc]

boolean

Boolean specifying the sort direction for the highlighted sorter. When unspecified, ascending order is implied.

sorter[all_in_amount][desc]

boolean

Boolean specifying the sort direction for the all_in_amount sorter. When unspecified, ascending order is implied.

sorter[amenity_ids_match_score][desc]

boolean

Boolean specifying the sort direction for the amenity_ids_match_score sorter. When unspecified, ascending order is implied.

sorter[amenity_ids_match_score][amenity_ids]

string

Amenity IDs for the amenity_ids_match_score sorter

sorter[avg_score][desc]

boolean

Boolean specifying the sort direction for the avg_score sorter. When unspecified, ascending order is implied.

limit

string

Specify a limiter here. There are 6 different limiters:

availabilities Return limit availabilities
start_dates Limit to the limit best arrival dates
los Limit to the limit best Length of stay (LOS) values
categories Limit to the limit best types. DEPRECATED: use rentable_types instead.
rentable_types Limit to the limit best types
administrations Limit to the limit best administrations

Configuration for the chosen limiter (for example the number of availabilities to return) must be passed separately, see the options below.

limiter[availabilities][limit]

integer

Return limit availabilities

limiter[start_dates][limit]

integer

Limit to the limit best arrival dates

limiter[start_dates][availabilities]

integer

Number of availabilities to return

limiter[los][limit]

integer

Limit to the limit best Length of stay (LOS) values

limiter[los][availabilities]

integer

Number of availabilities to return

limiter[categories][limit]

integer

Limit to the limit best types. DEPRECATED: use rentable_types instead.

limiter[categories][offset]

integer

Result offset for the categories limiter, useful for pagination

limiter[categories][availabilities]

integer

Number of availabilities to return

limiter[rentable_types][limit]

integer

Limit to the limit best types

limiter[rentable_types][offset]

integer

Result offset for the rentable_types limiter, useful for pagination

limiter[rentable_types][availabilities]

integer

Number of availabilities to return

limiter[administrations][limit]

integer

Limit to the limit best administrations

limiter[administrations][categories]

integer

Limit to the limit best types. DEPRECATED: use limiter[administrations][rentable_types] instead.

limiter[administrations][rentable_types]

integer

Limit to the limit best types

limiter[administrations][availabilities]

integer

Number of availabilities to return

Headers

Accept-Language

string

Supported languages. A comma separated list with one or more of the following locales: cs, da, de, de-AT, de-CH, en, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr. Default: 'en'.

Responses

200AvailabilityCollectionResponse

429Error

defaultError