# HomeToGo Offer Detail API Documentation

<p><strong>HomeToGo Offer Detail API Documentation</strong> 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.</p>

- **Documentation:** [https://scrappa.co/docs/hometogo-api/hometogo_offer](https://scrappa.co/docs/hometogo-api/hometogo_offer)
- **API group:** HomeToGo API
- **Endpoint:** `GET https://scrappa.co/api/hometogo/offer`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `offer_id` | string | Yes | Offer id from the search endpoint, 16 or 32 characters. |
| `check_in` | string | No | Check-in date, YYYY-MM-DD, today or later. Example: 2027-03-14. |
| `check_out` | string | No | Check-out date, YYYY-MM-DD, after check-in, at most 30 nights. Example: 2027-03-18. |
| `adults` | integer | No | Number of adults, 1 to 16. Defaults to 2. |
| `children` | integer | No | Number of children, 0 to 10. Children count as guests. Defaults to 0. |
| `currency` | string | No | Price currency: EUR, USD, GBP, CHF, SEK, DKK, NOK, PLN, CZK, CAD or AUD. Defaults to EUR. |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required query parameter is missing or invalid. This response is not billable. |
| 404 | Resource Not Found | The offer id is unknown. This response is not billable. |
| 503 | Service Unavailable | HomeToGo could not be reached or blocked the request. Retry later. This response is not billable. |
| 502 | Unexpected Answer | HomeToGo answered with a shape this API does not know. This response is not billable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)