# Flaconi Suggest API Documentation

<p><strong>Flaconi Suggest API</strong> returns public product hits and query suggestions from the storefront flyout. Each product carries the variant id that the product and reviews routes accept unchanged. Set popular=true for popular terms from a single separate lookup.</p><p><strong>Cost:</strong> 1 credit per request. Failed requests are not billed.</p>

- **Documentation:** [https://scrappa.co/docs/flaconi-api/flaconi_suggest](https://scrappa.co/docs/flaconi-api/flaconi_suggest)
- **API group:** Flaconi API
- **Endpoint:** `GET https://scrappa.co/api/flaconi/suggest`

## 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 |
| --- | --- | --- | --- |
| `q` | string | Yes | Search text, 2 to 100 characters. |
| `max` | integer | No | Maximum hits, 1 to 20 (default 5). |
| `locale` | string | No | Locale de-DE (default) or de-AT. |
| `popular` | boolean | No | true returns popular terms instead of query suggestions. |

## Example response

```json
{
    "data": {
        "query": "dior",
        "terms": [
            "dior",
            "dior parfum"
        ],
        "locale": "de-DE",
        "products": [
            {
                "id": "80041833-30",
                "name": "Sauvage",
                "brand": "Dior",
                "image": "https://cdn.flaconi.net/media/catalog/product/3/3/3348901567572-1_c_live.jpg",
                "price": {
                    "current": 98,
                    "currency": "EUR",
                    "original": null,
                    "discount_percent": null
                },
                "variant_sku": "80041833-30"
            }
        ],
        "popular_terms": []
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "suggest"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | Error | The query or locale is invalid. Not billed. |
|  | Error | Flaconi could not be reached. Not billed. |

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