Paginated instrument directory — richer sibling of `/api/v1/symbols`.

Same underlying instrument table as `/api/v1/symbols`, exposed with consistent filter semantics under the instruments namespace.

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: "perp" | "spot" | "future" | "option";
  expiry: string | null;
  strike: number | null;
  optionType: "C" | "P" | 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?base=BTC&kind=perp&limit=5"

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