How to Search for Available Resorts
Once you have a region code from the autocomplete endpoint, you can search for available resort properties. The property search endpoint returns a list of resorts matching your criteria, including pricing, ratings, images, and location details.
Endpoint
POST {{apihost}}/resorts/api/v2/properties/{xeniregioncode}?currency={currencycode}
Required Headers
| Header | Value | Required |
|---|---|---|
Content-Type | application/json | Yes |
x-api-key | Your API key | Yes |
x-correlation-id | Unique correlation identifier | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
xeniregioncode | string | Yes | The Base64-encoded region code from the autocomplete endpoint |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
currency | string | No | Three-letter ISO 4217 currency code (e.g., USD, EUR, GBP). Defaults to USD. |
Request Body
JSON
{
"stay_period": {
"start": "2026-04-01",
"end": "2026-04-07"
},
"lat": 19.8968,
"lon": -155.5828
}Request Body Fields
| Field | Type | Required | Description |
|---|---|---|---|
stayperiod.start | string | Yes | Check-in date in YYYY-MM-DD format |
stayperiod.end | string | Yes | Check-out date in YYYY-MM-DD format |
lat | number | Yes | Latitude of the destination (from autocomplete) |
lon | number | Yes | Longitude of the destination (from autocomplete) |
filters | object | No | Optional filters to narrow results. See How to Use Resort Search Filters and Sorting. |
sort | array | No | Optional sorting criteria. See How to Use Resort Search Filters and Sorting. |
Example Request
JSON
POST {{api_host}}/resorts/api/v2/properties/aGF3YWlp?currency=USD
{
"stay_period": {
"start": "2026-04-01",
"end": "2026-04-07"
},
"lat": 19.8968,
"lon": -155.5828
}
Example Response
JSON
{
"status": 200,
"data": [
{
"id": "RST-98765",
"name": "Oceanfront Paradise Resort & Spa",
"base_rate": 245,
"taxesandfees": 38.5,
"total_rate": 1710,
"currency": "USD",
"address": {
"line_1": "100 Beachfront Drive",
"city": "Kailua-Kona",
"state": "HI",
"country": "US",
"postal_code": "96740"
},
"coordinates": {
"lat": 19.64,
"lon": -155.9969
},
"ratings": {
"star_rating": 4,
"user_rating": 8.7
},
"image": "https://images.example.com/resort-main.jpg",
"start_date": "2026-04-01",
"end_date": "2026-04-07",
"recommendation_id": "rec-abc123",
"published_price": 1850
}
]
}Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Unique property identifier. Use this for detail, availability, and booking calls. |
name | string | Display name of the resort property |
baserate | number | Nightly base rate before taxes and fees |
taxesandfees | number | Total taxes and fees for the stay |
totalrate | number | Total cost for the entire stay including taxes and fees |
currency | string | Currency code for all rate fields |
address | object | Property address details |
coordinates | object | Latitude and longitude of the property |
ratings.starrating | number | Star rating of the property (1-5) |
ratings.userrating | number | Average guest rating |
image | string | URL of the primary property image |
startdate | string | Check-in date |
enddate | string | Check-out date |
recommendationid | string | Recommendation identifier. Required for availability and booking calls. |
publishedprice | number | The original published rack rate before any discounts |
Important Notes
- Save the
recommendation_id— This value is required when checking room availability, confirming pricing, and creating bookings. It ties subsequent API calls back to this specific search result. - Save the property
id— You will need this identifier for property detail lookups, availability checks, and booking requests. - Rates are per-stay — The
totalraterepresents the full cost for the entire stay period, not a nightly rate. Thebaserateis the nightly rate. - Published price vs. total rate — The
publishedpriceis the original rack rate. Thetotalrateis the actual price your customer pays, which may reflect negotiated or discounted pricing.