# HomeToGo Nearby Places API Documentation

<p><strong>HomeToGo Nearby Places API Documentation</strong> 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.</p>

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

## 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. |

## Example response

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

| 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)