API Reference

You can query properties by making a request to this endpoint.

Query Params
integer
required
Defaults to 0

The starting point from which to begin returning results.

integer
required
Defaults to 20

The maximum number of results to return. The maximum value is 100.

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
properties
array of objects
required

List of the properties

properties*
object
int64
required

Unique identifier for the property

string
required

Title of the property

channels
array of objects
required

List of channels associated with the property

channels*
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.

string

address of the property

string

longitude of the property

string

latitude of the property

integer
required

Total number of properties.

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