HomeToGo Offer Detail API Documentation Read one HomeToGo offer by its offer id: title, type, bedrooms, bathrooms, guest capacity, size, rating, location levels, coordinates, all pictures, amenities, rooms with beds, house rules, check-in and check-out times, description, the provider and the number of providers. With dates, the response carries the price for the stay with the fees, or the availability when the stay cannot be booked. The reference_price object is the provider price from the offer page. It is not tied to your dates, so use price for the stay. Without dates there is no stay price.
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.
5 optional filters available.
string
Required
Offer id from the search endpoint, 16 or 32 characters.
1234567890
string
Optional
Check-in date, YYYY-MM-DD, today or later. Example: 2027-03-14.
example
string
Optional
Check-out date, YYYY-MM-DD, after check-in, at most 30 nights. Example: 2027-03-18.
example
integer
Optional
Number of adults, 1 to 16. Defaults to 2.
10
integer
Optional
Number of children, 0 to 10. Children count as guests. Defaults to 0.
10
string
Optional
Price currency: EUR, USD, GBP, CHF, SEK, DKK, NOK, PLN, CZK, CAD or AUD. Defaults to EUR.
USD
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"offer": {
"geo": {
"latitude": 48.8577805,
"longitude": 2.364656
},
"url": "https://www.hometogo.com/rental/4870abd5bb2c9e3c",
"size": "54 m\u00b2",
"type": "Apartment",
"rooms": [
{
"beds": [
"1 large double bed"
],
"type": "Bedroom"
},
{
"beds": [
"1 couch"
],
"type": "Living room"
}
],
"rules": {
"policies": [
{
"label": "No pets",
"allowed": false
}
]
},
"title": "54 m\u00b2 Apartment",
"images": [
{
"alt": "Holiday apartment | Perfect for remote work - 0",
"large": "https://cdn.hometogo.net/large/v1/39b/436/29a822bbd73fce9dd93773ffc7.jpg",
"small": "https://cdn.hometogo.net/small/v1/39b/436/29a822bbd73fce9dd93773ffc7.jpg",
"medium": "https://cdn.hometogo.net/medium/v1/39b/436/29a822bbd73fce9dd93773ffc7.jpg"
},
{
"alt": "Holiday apartment | Perfect for remote work - 1",
"large": "https://cdn.hometogo.net/large/v1/af4/cf2/512b164525247a00ecea7c6ffc.jpg",
"small": "https://cdn.hometogo.net/small/v1/af4/cf2/512b164525247a00ecea7c6ffc.jpg",
"medium": "https://cdn.hometogo.net/medium/v1/af4/cf2/512b164525247a00ecea7c6ffc.jpg"
}
],
"rating": {
"label": "Excellent",
"stars": 4.7,
"review_count": 153
},
"nice_id": "HV7XYDU",
"bedrooms": 1,
"check_in": "04:00pm",
"location": {
"area": "Les Archives",
"city": "Paris",
"region": "\u00cele-de-France",
"country": "France",
"district": "3rd arrondissement"
},
"offer_id": "4870abd5bb2c9e3c",
"provider": "HomeToGo",
"amenities": [
{
"code": "dishwasher",
"label": "Dishwasher"
},
{
"code": "washing_machine_available",
"label": "Washing machine"
},
{
"code": "tv",
"label": "TV"
},
{
"code": "air_conditioning",
"label": "Air conditioning"
},
{
"code": "internet",
"label": "WiFi"
}
],
"bathrooms": 1,
"check_out": "10:00am",
"max_guests": 4,
"description": "Sublime apartment, renovated, bright, elegant, modern and tastefully decorated. Ideally located, in the famous \"Marais\" 11 minutes from L'HOTEL DE VILLE, and a few steps from the famous Place des Vosges.\n\nChic and lively district thanks to its numerous pedestrian streets which give access to restaur",
"info_groups": [
{
"items": [
"1 bedroom",
"4 guests max.",
"Apartment",
"54 m\u00b2"
],
"title": "Quick facts"
},
{
"items": [
"Dishwasher",
"Washing machine",
"TV",
"Air conditioning"
],
"title": "Key amenities"
}
],
"property_id": "69964f39a707c3bc",
"availability": "unavailable",
"provider_count": 1,
"instant_booking": true,
"reference_price": {
"note": "Reference price of the provider. It is not tied to the requested dates; use price for the quoted stay.",
"total": 1848,
"nights": 7,
"arrival": "2027-01-08",
"currency": "EUR",
"per_night": 264
}
}
},
"meta": {
"billable": true,
"endpoint_family": "rental_offer"
},
"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_offer"
},
"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_offer"
},
"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_offer"
},
"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.