HomeToGo Filters API Documentation List what you can filter by in one HomeToGo destination: the destination path, the sub-locations such as districts with their ids, the property types, the amenities, the sale types, the rating steps and the price range per night. Use the values with the search endpoint. HomeToGo does not return reliable counts per value, so none are listed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
2 optional filters available.
string
Optional
HomeToGo destination id from the suggest endpoint. Example: 5460aead9281b for Paris. Send this or destination.
1234567890
string
Optional
Destination name as in the HomeToGo address, e.g. paris, munich or new-york. Send this or location_id.
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"sorts": [
"recommended",
"best_value",
"price_asc",
"price_desc",
"rating"
],
"types": [
{
"label": "Condo",
"value": "condo"
},
{
"label": "Apartment",
"value": "holiday_apartment"
},
{
"label": "House",
"value": "holiday_house"
}
],
"ratings": [
{
"label": "3+",
"value": 3
},
{
"label": "3.5+",
"value": 3.5
},
{
"label": "4+",
"value": 4
},
{
"label": "4.5+",
"value": 4.5
},
{
"label": "5+",
"value": 5
}
],
"amenities": [
{
"label": "WiFi",
"value": "internet"
},
{
"label": "Kitchen",
"value": "kitchen"
},
{
"label": "Washing machine",
"value": "washing_machine_available"
}
],
"sale_types": [
{
"label": "Instant booking",
"value": "always_instantly_bookable"
},
{
"label": "On request",
"value": "always_on_request"
}
],
"breadcrumbs": [
{
"id": "5460aeb1b0bf2",
"name": "France"
},
{
"id": "5460aeceb0673",
"name": "\u00cele-de-France"
},
{
"id": "5460aead9281b",
"name": "Paris"
}
],
"location_id": "5460aead9281b",
"sublocations": [
{
"id": "560309fb16bc0",
"name": "Le Marais"
},
{
"id": "5996205d997be",
"name": "Faubourg Saint-Germain"
},
{
"id": "5c8f814d18129",
"name": "Upper Marais"
}
],
"price_per_night": {
"max": 1000,
"min": 9,
"currency": "EUR"
}
},
"meta": {
"billable": true,
"endpoint_family": "rental_filters"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A required query parameter is missing or invalid. This response is not billable.
{
"errors": {
"location_id": [
"The location id field is required."
]
},
"message": "The request validation failed"
}Resource Not Found
The destination is unknown. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "rental_filters"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested HomeToGo resource was not found."
},
"success": false
}Service Unavailable
HomeToGo could not be reached or blocked the request. Retry later. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "rental_filters"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "The HomeToGo API is temporarily unavailable. Please retry."
},
"success": false
}Unexpected Answer
HomeToGo answered with a shape this API does not know. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "rental_filters"
},
"error": {
"code": "PARSE_ERROR",
"message": "HomeToGo returned an unexpected answer. Please retry later."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.