HomeToGo Destination Suggest API Documentation Turn a place name into the HomeToGo destination id that the search, filters and price histogram endpoints take. The name is matched against the public destination pages, so use the English place name as in the HomeToGo address, for example paris, munich or new-york. The response holds the destination id, its name and the page link. An unknown name answers a not billable 404 and never falls back to another destination.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
string
Required
Destination name, 2 to 100 characters. Example: paris.
coffee shops
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"url": "https://www.hometogo.com/paris/",
"name": "Paris",
"slug": "paris",
"query": "paris",
"location_id": "5460aead9281b"
},
"meta": {
"billable": true,
"endpoint_family": "destination_suggest"
},
"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": {
"query": [
"The query field is required."
]
},
"message": "The request validation failed"
}Resource Not Found
No destination page exists for this name. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "destination_suggest"
},
"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": "destination_suggest"
},
"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": "destination_suggest"
},
"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.