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

HolidayCheck Autocomplete API Documentation

GET https://scrappa.co/api/holidaycheck/autocomplete

HolidayCheck Autocomplete API Documentation Find HolidayCheck destinations (regions and cities) and hotels by name. Each suggestion has the id, type, name, parent places and a relevance score. Hotel suggestions also have the public HolidayCheck page url. Use the destination id with the hotels endpoint and the hotel id with the hotel and reviews endpoints. hotels_count is capped at 10000 by HolidayCheck. A text without matches is a successful response with empty lists.

HolidayCheck Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/holidaycheck/autocomplete
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "mallorca",
        "hotels": [
            {
                "id": "90a9d6db-5941-446f-91ba-9a4a2893ab95",
                "url": "https://www.holidaycheck.de/hi/x/90a9d6db-5941-446f-91ba-9a4a2893ab95",
                "name": "Alua Calas de Mallorca Resort",
                "type": "HOTEL",
                "score": 972.15,
                "parents": [
                    "Cales de Mallorca / Calas de Mallorca",
                    "Mallorca",
                    "Spanien"
...

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

Search text, 1 to 100 characters. Example: mallorca.

Example value coffee shops
limit integer Optional

Maximum number of suggestions, 1 to 20. Defaults to 10.

Example value 10

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": {
        "query": "mallorca",
        "hotels": [
            {
                "id": "90a9d6db-5941-446f-91ba-9a4a2893ab95",
                "url": "https://www.holidaycheck.de/hi/x/90a9d6db-5941-446f-91ba-9a4a2893ab95",
                "name": "Alua Calas de Mallorca Resort",
                "type": "HOTEL",
                "score": 972.15,
                "parents": [
                    "Cales de Mallorca / Calas de Mallorca",
                    "Mallorca",
                    "Spanien"
                ]
            }
        ],
        "destinations": [
            {
                "id": "07f5f656-4acc-3230-b7dd-aec3c13af37c",
                "name": "Mallorca",
                "type": "DESTINATION_REGION",
                "score": 1419.62,
                "parents": [
                    "Spanien"
                ]
            },
            {
                "id": "b934be2d-e042-3a8e-8fcc-00301dc2fb7d",
                "name": "Palma de Mallorca",
                "type": "DESTINATION_CITY",
                "score": 630.42,
                "parents": [
                    "Mallorca",
                    "Spanien"
                ]
            }
        ],
        "hotels_count": 10000,
        "destinations_count": 131
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "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": {
        "query": [
            "A search text is required, e.g. mallorca."
        ]
    },
    "message": "The request validation failed"
}
503

Service Unavailable

HolidayCheck could not be reached or answered in an unexpected format. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "hotel"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The HolidayCheck 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.