How to Filter Vacation Rental Results
The Vacation Rentals API supports multiple filter options to help narrow search results. Filters are passed in the filters object and the vacation_rentals array within the search request body.
Filter Options
Star Ratings
Filter properties by star rating. Pass an array of integers.
{
"filters": {
"ratings": [
4,
5
]
}
}| Parameter | Type | Description |
|---|---|---|
ratings | array of numbers | Star ratings to include (e.g., [3, 4, 5]) |
Amenities
Filter by available amenities. Pass an array of amenity name strings.
{
"filters": {
"amenities": [
"pool",
"wifi",
"kitchen",
"parking"
]
}
}| Parameter | Type | Description |
|---|---|---|
amenities | array of strings | Amenity names to require |
amenities=true as a query parameter in the search request. The response will include amenity data for each property.
Property Name
Search for properties matching a name or keyword.
{
"filters": {
"name": "Lakeside"
}
}| Parameter | Type | Description |
|---|---|---|
name | string | Full or partial property name to match |
Price Range
Set minimum and/or maximum nightly price bounds. Prices are in the currency specified in the query string.
{
"filters": {
"min_price": 100,
"max_price": 400
}
}| Parameter | Type | Description |
|---|---|---|
minprice | number | Minimum price per night |
maxprice | number | Maximum price per night |
Distance
Limit results to properties within a specific distance from the search coordinates.
{
"filters": {
"distance": 10
}
}| Parameter | Type | Description |
|---|---|---|
distance | number | Maximum distance in kilometers from the search lat/long |
Rental Type Filter
Use the vacation_rentals body parameter (outside of filters) to limit results to specific property types:
{
"vacation_rentals": [
"Cottage",
"Apartment",
"Condo"
]
}Supported values: "Condo", "Apartment", "Cottage", "Houseboat", "Mobile Home", "Aparthotel", "Condominium Resort".
Combining All Filters
All filter options can be combined in a single request. Only properties that match every specified filter are returned.
{
"checkin_date": "2026-06-01",
"checkout_date": "2026-06-08",
"occupancy": [
{
"adults": 4,
"childs": 2,
"childages": [
6,
10
]
}
],
"lat": 39.0968,
"long": -120.0324,
"countryofresidence": "US",
"placeid": "placeabc123",
"vacation_rentals": [
"Cottage",
"Condo"
],
"radius": 30,
"sort": [
{
"key": "price",
"order": "asc"
}
],
"filters": {
"ratings": [
4,
5
],
"amenities": [
"pool",
"wifi",
"kitchen"
],
"min_price": 150,
"max_price": 600,
"distance": 20
},
"is_async": false
}Sorting
Control the order of search results with the sort array:
{
"sort": [
{
"key": "price",
"order": "asc"
}
]
}| Field | Type | Description |
|---|---|---|
sort[].key | string | The field to sort by (e.g., "price") |
sort[].order | string | "asc" for ascending, "desc" for descending |
Pagination
Use query parameters to page through results:
POST /hotels/api/v2/properties/vacation-rentals?currency=USD&page=1&limit=25&amenities=true
| Parameter | Type | Description |
|---|---|---|
page | number | Page number (starts at 1) |
limit | number | Results per page (max 50) |
- Start with
page=1. - Check
data.totalin the response to determine the total number of results. - Increment
pageuntil all results have been retrieved.
Tips for Effective Filtering
- Start broad, then narrow — Begin with fewer filters and add more to refine results.
- Use rental type filters for specific accommodation needs — travelers looking for a cottage experience will not want apartment results.
- Combine price and distance to find affordable options close to the desired location.
- Set amenities=true in the query string to receive amenity data in the response, which can inform further filtering.
Next Steps
Learn how async search mode works for vacation rentals and how to handle progressive result loading.