Prefix search across canonical symbol and base — for typeahead.

Sanitised prefix LIKE query. User-supplied `%`/`_` wildcards are stripped so `q=%` can't turn into a table scan.

Query parameters

All query parameters are optional unless marked required.

Response shape

Always wrapped in the standard envelope. Nullable fields are explicitly marked — treat missing numeric data as a real data-source gap, not as an error.

// Wrapped in the standard envelope:
// {
//   data: /* shape below */,
//   meta?: { total?: number; limit?: number; offset?: number; ... }
// }

Array<{
  id: number;
  canonicalSymbol: string;
  base: string;
  quote: string;
  kind: string;
  expiry: string | null;
  strike: number | null;
  optionType: string | null;
}>

Example

Copy the curl, replace YOUR_KEY with a real key from your dashboard, and run.

curl -sS "http://localhost:3000/api/v1/instruments/search?q=BTC&limit=5"

{
  "data": [
    {
      "id": 12,
      "canonicalSymbol": "BTCUSDT",
      "base": "BTC",
      "quote": "USDT",
      "kind": "perp",
      "expiry": null,
      "strike": null,
      "optionType": null
    }
  ],
  "meta": { "total": 1, "limit": 5 }
}