# Holidu Smart Filters API Documentation

<p><strong>Holidu Smart Filters API Documentation</strong> Turn a free text such as apartment with pool in Paris into filter values: property types, amenities, region, price and guests. It returns filters, not offers. Use the filters with the search endpoint. This endpoint is slower than the others.</p>

- **Documentation:** [https://scrappa.co/docs/holidu-api/holidu_smart_filters](https://scrappa.co/docs/holidu-api/holidu_smart_filters)
- **API group:** Holidu API
- **Endpoint:** `GET https://scrappa.co/api/holidu/smart-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 |
| --- | --- | --- | --- |
| `query` | string | Yes | Free text, 3 to 200 characters. |
| `market` | string | No | Country site: com (USD), de (EUR), uk (GBP) or fr (EUR). Defaults to com. An unknown value is rejected. |

## Example response

```json
{
    "data": {
        "text": "apartment with pool in Paris",
        "market": "com",
        "result": {
            "adults": 0,
            "region": "Paris",
            "filters": {
                "amenities": [
                    "POOL"
                ],
                "property_type": [
                    "VACATION_APARTMENT"
                ]
            },
            "matched": [
                "apartment",
                "pool"
            ],
            "bedrooms": null,
            "children": 0,
            "bathrooms": null,
            "max_price": null,
            "min_price": null,
            "unmatched": [],
            "unavailable": [],
            "unrecognized": [],
            "children_ages": null,
            "hidden_filters": null,
            "max_price_total": null,
            "min_price_total": null
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "smart_filters"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required query parameter is missing or invalid. This response is not billable. |
| 503 | Service Unavailable | Holidu could not be reached, answered with an unexpected shape or returned a result that does not match the request. This response is not billable. Retry later. |

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