API Reference

By sending a request to this endpoint, you can retrieve calendar information for multiple listings. This endpoint will return daily details on price, inventory, and restrictions for each listing.

Body Params
date
required

The start date for records. The date format is YYYY-MM-DD, and must be within 1 years from now.

date
required

The end date for the calendar. The date format is YYYY-MM-DD, and must be within 3 years from now.

listings
array of objects
required

A list of listing object. The listing object contains the listing id and channel type.

listings*
Response

Response body
object
string
required

Unique identifier for the request.

integer
required

Numeric error code representing the status of the response. A value of 200 indicates success.
See the Error Codes section for more information.

string
required

Message detailing the status of the response.

data
object
required
listings
array of objects
required

A list of listing objects. Each listing object contains the listing id, channel type, and calendar.

listings*
object
string
required

The type of the channel. See Supported Channels for more information.

airbnb booking.com agoda expedia vrbo trip.com booking_site tujia_intl hostex_direct tujia xiaozhu meituan_bnb meituan_hotel muniao fliggy zhukeyun tiktok xiaohongshu ctrip houfy

string
required

The unique identifier for different channels.
For example, the listing id for Airbnb is the Airbnb listing id, and the listing id for Booking.com is the Booking.com room id - rateplan id.

calendar
array of objects
required

A list of calendar objects. Each calendar object contains the date, price, and inventory for that date.

calendar*
object
date
required

The date of the calendar

number
required

The price for the date

integer
required

The inventory for the date

restrictions
object

Restrictions for the date. Please notice that the range of fields for restrictions may vary across different channels. The fields listed below may not apply to all channels.

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json