Calendar

Fetch calendar nights for multiple properties.

Each days entry is one night (date through the following morning), not a calendar day cell. On a turnover day, is_departure and booking_id refer to different bookings. Any status other than available means the night cannot be sold; a night marked available may still be unbookable when rules disallow the stay. rules.is_gap_required is a booking rule. gap_type reflects gap analysis based on rules and adjacent bookings. rules values are the rules in effect for the night; per-night overrides are on GET /v2/spotrates. booking_id is a reference only; use GET /v2/bookings for booking detail. Historical dates are supported; rate and rules may be absent on older nights. Nights with no calendar data are omitted, including nights past the property's booking window and nights before recorded history. A 200 with fewer days than the requested range is expected. When no nights exist for the range, days is omitted. Nightly rate amounts exclude fees and taxes; use GET /v2/quotes for full stay pricing. There is no since or delta filter. This data can lag a short time behind live changes. Confirm a night is actually free with the Quote or Booking endpoints before taking a reservation.

get/v2/calendar

Query parameters

fromstring date-time nullable required

Required. Start of the date range (property-local calendar date, inclusive). The range may not exceed 90 days.

tostring date-time nullable required

Required. End of the date range (property-local calendar date, inclusive). The range may not exceed 90 days.

property_idsinteger[] nullable

Property IDs to include. Unknown IDs are omitted from results.

activeboolean nullable

When true (default), only active properties. When false, only inactive properties.

Response

A pageable list of properties, each with nightly rates, rules, and availability.

limitinteger

The maximum number of records per page.

next_page_urlstring

URL to fetch the next page of records. A null value indicates that there are no more pages in the collection.

offsetinteger

The current offset from the start of the collection.

countinteger

The total number of records in the collection.

Changes

Changed in 1 of the 10 revisions of this API.1