balances.list
Retrieve Ryft balance information for a specific currency to monitor available funds and track financial resources.
Instructions
List Ryft balances for a currency.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| currency | Yes | ||
| accountId | No |
Implementation Reference
- src/tools/balances.ts:23-30 (handler)The handler function for balances.list tool.
async (args) => { const parsed = listBalancesSchema.parse(args); const { accountId, ...query } = parsed; return client.get('/balances', { query: query as Record<string, QueryValue>, ...(accountId ? { accountId } : {}), }); }, - src/tools/balances.ts:6-9 (schema)The Zod schema for input validation of balances.list.
const listBalancesSchema = z.object({ currency: z.string().length(3), accountId: z.string().min(1).optional(), }); - src/tools/balances.ts:19-22 (registration)The registration of balances.list tool.
registerTool( 'balances.list', 'List Ryft balances for a currency.', listBalancesSchema.shape,