GET/api/v1/get-tokens

Get a vault's token balances

Returns the token balances held in one vault, each with the token's decimals, supply figures, and whether this vault owns the token contract.

AccessRequires a permission in the workspaceVIEW_BALANCES

Each entry is a TokenBalance, documented under Shared objects. balance, total_supply, and max_supply are raw units, already scaled by the token's decimals, and owned is true when this vault owns the token contract, which is what allows it to mint and burn.

Note the capitalised key: the array comes back as Tokens, not tokens. For the same figures across every vault in the workspace, with per-token totals, use GET /api/v1/get-workspace-balances. For the token records behind these holdings, use GET /api/v1/contracts.

Query parameters

vault_idstringrequired

The vault whose token balances to show.

workspace_idnumberrequired

The workspace the vault belongs to. You must hold VIEW_BALANCES in it.

bash

curl "$SQRL_API/api/v1/get-tokens?vault_id=vault_01HZXB2K7P&workspace_id=342" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({
  vault_id: "vault_01HZXB2K7P",
  workspace_id: "342",
});
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/get-tokens?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { Tokens } = await res.json();

rust

let res = client
    .get(format!("{}/api/v1/get-tokens", api_base))
    .query(&[("vault_id", "vault_01HZXB2K7P"), ("workspace_id", "342")])
    .bearer_auth(&token)
    .send()
    .await?;

Response200 OK

{
"Tokens": [
  {
    "contract_uid": 512,
    "contract_address": "9f2c8b1d4a…41a",
    "name": "Northgate Token",
    "balance": "12750000",
    "decimals": 2,
    "icon": "https://cdn.example.com/tokens/ngt.svg",
    "owned": true,
    "total_supply": "500000000",
    "max_supply": "1000000000"
  },
  {
    "contract_uid": 514,
    "contract_address": "5d1b7f3e8c…92f",
    "name": "Northgate Bond",
    "balance": "20000",
    "decimals": 0,
    "icon": "https://cdn.example.com/tokens/ngb.svg",
    "owned": false,
    "total_supply": "20000",
    "max_supply": "20000"
  }
]
}

Was this page helpful?