---
title: "Autocomplete suggestions for search-as-you-type"
method: GET
path: "/search/suggest"
tags: ["Search"]
---

# Autocomplete suggestions for search-as-you-type

`GET /search/suggest`

## Request

- Base URL: `https://data.kairos.trade`
- URL: `https://data.kairos.trade/search/suggest`
- Auth: API key in header `X-Client-Id` and API key in header `X-Api-Key` and API key in header `X-Api-Secret`

Returns autocomplete suggestions. Not provider-visibility filtered.

## Query parameters

- `q` string, required
- `limit` integer
- `provider` string

## Response `200`

Autocomplete suggestions.

- SearchSuggestResponse
  - `suggestions` SearchSuggestion[], required
    - `text` string, required: Suggested query text (market/series/category name).
    - `type` string, required: Suggestion source type, e.g. market, category.
    - `frequency` integer, required: May be an aggregated count, or always 1, depending on how the suggestion was generated.
  - `meta` object, required
    - `query` string
    - `returned` integer

## Other responses

- `400`: Empty `q` or invalid provider.
- `401`: No valid credential presented — missing/invalid API-key headers, or an invalid/expired session token.
- `403`: Authenticated but not permitted. Three distinct causes: the session user is not invited (`Invite required`), the API key lacks the operation's scope, or API-key access to the requested venue is switched off (`API access is disabled for <provider>`). Admin and API-key callers bypass the invite check; session and admin callers bypass scope and venue checks.
- `422`: Request failed FastAPI parameter validation.
- `429`: Rate limit exceeded for this route's sliding window, keyed on the session `sub` when authenticated and on the trusted client IP otherwise. Honor `Retry-After`. A per-API-key data ceiling (set per credential) rejects with `{"detail": "API key data rate limit exceeded"}` instead of the `error` envelope below.
- `500`: Suggestion query failed.

---

[API](https://skmtc.dev/kairos/apis/kairos-data-api.md) - [All operations](https://skmtc.dev/kairos/apis/kairos-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kairos/apis/kairos-data-api/revisions/cf6b76079e38?raw)