How to Use Resort Search Filters and Sorting

The resort property search endpoint accepts optional filters and sort parameters in the request body. These let you narrow results by price range, star ratings, amenities, accessibility features, and more, as well as control the order in which results are returned.

Endpoint

POST {{apihost}}/resorts/api/v2/properties/{xeniregion_code}?currency=USD

Full Request Body with Filters and Sorting

{
  "stay_period": {
    "start": "2026-04-01",
    "end": "2026-04-07"
  },
  "lat": 19.8968,
  "lon": -155.5828,
  "filters": {
    "ratings": [
      3,
      4
    ],
    "min_price": 100,
    "max_price": 500,
    "all_inclusive": [
      "O",
      "M"
    ],
    "num_bedrooms": [
      "2",
      "3"
    ],
    "max_guests": [
      "4",
      "6"
    ],
    "accessibilities": [
      "elevator"
    ],
    "amenities": [
      "pool",
      "spa",
      "fitness"
    ],
    "kitchen_type": [
      "full",
      "partial"
    ],
    "activities": [
      "golf"
    ],
    "regions": [
      {
        "type": "city",
        "name": "Kailua-Kona"
      }
    ]
  },
  "sort": [
    {
      "key": "price",
      "order": "asc"
    }
  ]
}

Filter Reference

ratings

Filter by star rating. Accepts an array of integers from 1 to 4.

"ratings": [3, 4]

minprice / maxprice

Filter by nightly base rate. Both values are numeric and represent the currency specified in the query parameter.

"min_price": 100,
"max_price": 500

all_inclusive

Filter by all-inclusive status. Accepts an array of string codes.

"all_inclusive": ["O", "M"]

num_bedrooms

Filter by number of bedrooms. Accepts an array of strings.

"num_bedrooms": ["2", "3"]

max_guests

Filter by maximum guest capacity. Accepts an array of strings.

"max_guests": ["4", "6"]

accessibilities

Filter by accessibility features. Accepts an array of strings.

"accessibilities": ["elevator", "deaf"]

amenities

Filter by on-site amenities. Accepts an array of strings.

"amenities": ["pool", "spa", "restaurant"]

kitchen_type

Filter by kitchen facilities in the room. Accepts an array of strings.

"kitchen_type": ["full", "partial"]

activities

Filter by available activities at or near the resort. Accepts an array of strings.

"activities": ["golf"]

regions

Filter results to specific sub-regions within the searched area. Each entry requires a type and name.

"regions": [
  { "type": "city", "name": "Kailua-Kona" },
  { "type": "city", "name": "Waikoloa" }
]

Sorting

The sort parameter accepts an array of sort objects. Each object specifies a key and order.

Sort by Price (Low to High)

"sort": [{ "key": "price", "order": "asc" }]

Sort by Ratings (High to Low)

"sort": [{ "key": "ratings", "order": "desc" }]

Multi-Level Sorting

You can combine multiple sort criteria. The API applies them in order, using subsequent keys to break ties.

"sort": [
  { "key": "ratings", "order": "desc" },
  { "key": "price", "order": "asc" }
]

This returns results sorted by highest rating first, with ties broken by lowest price.

Best Practices

• Start broad, then narrow — Begin with minimal filters and add constraints based on user input. Over-filtering can return zero results.
• Combine filters logically — Filters are applied with AND logic. A property must match all specified filter criteria to appear in results.
• Use regions for large areas — When searching a state or country, use the regions filter to narrow results to specific cities without performing a new autocomplete search.
• Default sort — If no sort parameter is provided, results are returned in the API's default order (typically by relevance or availability).