# HomeToGo Filters API Documentation

<p><strong>HomeToGo Filters API Documentation</strong> List what you can filter by in one HomeToGo destination: the destination path, the sub-locations such as districts with their ids, the property types, the amenities, the sale types, the rating steps and the price range per night. Use the values with the search endpoint. HomeToGo does not return reliable counts per value, so none are listed.</p>

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

## 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 |
| --- | --- | --- | --- |
| `location_id` | string | No | HomeToGo destination id from the suggest endpoint. Example: 5460aead9281b for Paris. Send this or destination. |
| `destination` | string | No | Destination name as in the HomeToGo address, e.g. paris, munich or new-york. Send this or location_id. |

## Example response

```json
{
    "data": {
        "sorts": [
            "recommended",
            "best_value",
            "price_asc",
            "price_desc",
            "rating"
        ],
        "types": [
            {
                "label": "Condo",
                "value": "condo"
            },
            {
                "label": "Apartment",
                "value": "holiday_apartment"
            },
            {
                "label": "House",
                "value": "holiday_house"
            }
        ],
        "ratings": [
            {
                "label": "3+",
                "value": 3
            },
            {
                "label": "3.5+",
                "value": 3.5
            },
            {
                "label": "4+",
                "value": 4
            },
            {
                "label": "4.5+",
                "value": 4.5
            },
            {
                "label": "5+",
                "value": 5
            }
        ],
        "amenities": [
            {
                "label": "WiFi",
                "value": "internet"
            },
            {
                "label": "Kitchen",
                "value": "kitchen"
            },
            {
                "label": "Washing machine",
                "value": "washing_machine_available"
            }
        ],
        "sale_types": [
            {
                "label": "Instant booking",
                "value": "always_instantly_bookable"
            },
            {
                "label": "On request",
                "value": "always_on_request"
            }
        ],
        "breadcrumbs": [
            {
                "id": "5460aeb1b0bf2",
                "name": "France"
            },
            {
                "id": "5460aeceb0673",
                "name": "\u00cele-de-France"
            },
            {
                "id": "5460aead9281b",
                "name": "Paris"
            }
        ],
        "location_id": "5460aead9281b",
        "sublocations": [
            {
                "id": "560309fb16bc0",
                "name": "Le Marais"
            },
            {
                "id": "5996205d997be",
                "name": "Faubourg Saint-Germain"
            },
            {
                "id": "5c8f814d18129",
                "name": "Upper Marais"
            }
        ],
        "price_per_night": {
            "max": 1000,
            "min": 9,
            "currency": "EUR"
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "rental_filters"
    },
    "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 destination 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)