Skip to content
Scrappa Get API key
Holidu API 1 credit/request

Holidu Smart Filters API Documentation

GET https://scrappa.co/api/holidu/smart-filters

Holidu Smart Filters API Documentation 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.

Holidu Smart Filters API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/holidu/smart-filters
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "text": "apartment with pool in Paris",
        "market": "com",
        "result": {
            "adults": 0,
            "region": "Paris",
            "filters": {
                "amenities": [
                    "POOL"
                ],
                "property_type": [
                    "VACATION_APARTMENT"
                ]
...

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.

1 optional filter available.

query string Required

Free text, 3 to 200 characters.

Example value coffee shops
market string Optional

Country site: com (USD), de (EUR), uk (GBP) or fr (EUR). Defaults to com. An unknown value is rejected.

Example value US

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "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

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required query parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "market": [
            "The market is one of com, de, uk, fr."
        ]
    },
    "message": "The request validation failed"
}
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.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "smart_filters"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Holidu API is temporarily unavailable. Please retry."
    },
    "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.