check_balance
Retrieve token balances for a public key, including per-token amounts, maturity details, merchant breakdowns, and loyalty tier information with cashback rates.
Instructions
Check the token balances (DAH, DAHYM, DAHLOR, W3SH) for a public key. Returns total balance, per-token breakdown, maturity info, merchant breakdown, and W3SH loyalty tier (Seed/Twig/Kindling/Log/Joist) with cashback rate and progress.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| player_publickey | Yes | The public key (hex) to check balances for. |
Implementation Reference
- src/tools.ts:394-400 (handler)The handler logic for `check_balance` which calls the `/checkbalance` endpoint using the provided `player_publickey`.
case 'check_balance': { const key = args.player_publickey as string; const res = await client.get('/checkbalance', { player_publickey: key, }); return toResult(res.data, !res.ok); } - src/tools.ts:56-73 (schema)The definition of `check_balance` including its description and input schema.
{ name: 'check_balance', description: 'Check the token balances (DAH, DAHYM, DAHLOR, W3SH) for a public key. ' + 'Returns total balance, per-token breakdown, maturity info, merchant breakdown, ' + 'and W3SH loyalty tier (Seed/Twig/Kindling/Log/Joist) with cashback rate and progress.', inputSchema: { type: 'object', properties: { player_publickey: { type: 'string', description: 'The public key (hex) to check balances for.', }, }, required: ['player_publickey'], }, access: 'read', },