HomeToGo Nearby Places API Documentation List the places near one HomeToGo offer, such as public transport stops, attractions and airports. Each place has the name, the category, the distance as HomeToGo shows it and the coordinates.
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
Offer id from the search endpoint, 16 or 32 characters.
1234567890
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"places": [
{
"geo": {
"latitude": 48.85745,
"longitude": 2.36811
},
"name": "Chemin Vert",
"category": "subways",
"distance": "300m",
"category_label": "Public transport"
},
{
"geo": {
"latitude": 48.85538,
"longitude": 2.36035
},
"name": "Saint-Paul",
"category": "subways",
"distance": "500m",
"category_label": "Public transport"
},
{
"geo": {
"latitude": 48.8611,
"longitude": 2.36723
},
"name": "Saint-S\u00e9bastien - Froissart",
"category": "subways",
"distance": "500m",
"category_label": "Public transport"
}
],
"offer_id": "4870abd5bb2c9e3c"
},
"meta": {
"billable": true,
"endpoint_family": "rental_nearby"
},
"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": {
"offer_id": [
"The offer id field is required."
]
},
"message": "The request validation failed"
}Resource Not Found
The offer id is unknown. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "rental_nearby"
},
"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_nearby"
},
"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_nearby"
},
"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.