listInstruments

listInstruments walks catalogue rows; use getInstrument for full detail on one id.

Setup

import { Canton } from '@fairmint/canton-node-sdk';

const canton = new Canton({
  network: 'devnet',
  provider: '5n',
  partyId: 'OWN_PARTY_ID',
});

Import and receiver

import { Canton } from '@fairmint/canton-node-sdk';

Receiver: canton.validator.listInstruments.

Minimal example

const page = await canton.validator.listInstruments({ pageSize: 25 });
const next = page.nextPageToken
  ? await canton.validator.listInstruments({ pageSize: 25, pageToken: page.nextPageToken })
  : null;

Parameters

• pageSize (optional, number) — Page size hint as query parameter.
• pageToken (optional, string) — Cursor from a previous response’s nextPageToken.

Returns

• instruments (array) — Summary rows (id, name, symbol, decimals, supportedApis, optional supply fields).
• nextPageToken (optional, string) — Present when more pages exist.

Errors and pitfalls

• Invalid pageToken yields HTTP errors—restart pagination from the first page.

Auth and party

Authenticated bearer token.

See also

• getInstrument

Source

src/clients/validator-api/operations/v0/scan-proxy/registry/metadata/v1/list-instruments.ts on GitHub.