GET/api/v1/contracts

List tokens in a vault

Lists every token held in one vault, each with its supply figures, decimals, whitelist setting, deployment status, and signing progress.

AccessRequires a permission in the workspaceMANAGE_WORKSPACEPAYMENT_APPROVEVIEW_BALANCES

This is the call behind a vault's token list: one request returns every token the vault holds, whether it is live or still collecting approvals for its deployment. Each entry is a Contract, documented under Shared objects, and the fields a deployment fills in later, contract_id among them, are null until it has done so.

Use the contract_uid from an entry wherever a token has to be named, including GET /api/v1/contract for one token in full and POST /api/v1/call-contract to act on it. For holdings rather than token records, see GET /api/v1/get-tokens.

Query parameters

vault_idstringrequired

The vault whose tokens to list.

workspace_idnumberrequired

The workspace the vault belongs to. You must hold MANAGE_WORKSPACE, PAYMENT_APPROVE, or VIEW_BALANCES in it.

bash

curl "$SQRL_API/api/v1/contracts?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/contracts?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { contracts } = await res.json();

rust

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

Response200 OK

{
"contracts": [
  {
    "contract_uid": 512,
    "vault_id": "vault_01HZXB2K7P",
    "contract_id": "9f2c8b1d4a…41a",
    "symbol": "NGT",
    "icon": "https://cdn.example.com/tokens/ngt.svg",
    "decimals": 2,
    "total_supply": "500000000",
    "max_supply": "1000000000",
    "status": "CONFIRMED",
    "bytecode_hash": "b7f1e2c9…9ac",
    "network": "mainnet",
    "deploy_psbt_id": "psbt_01HZXC9F4R",
    "whitelist_enabled": true,
    "signers": [
      { "key_id": "key_01HZX4M8QT", "is_signed": true, "user_id": "4021" },
      { "key_id": "key_01HZX52NRB", "is_signed": true, "user_id": "4088" }
    ]
  },
  {
    "contract_uid": 513,
    "vault_id": "vault_01HZXB2K7P",
    "contract_id": null,
    "symbol": "NGX",
    "icon": "https://cdn.example.com/tokens/ngx.svg",
    "decimals": 0,
    "total_supply": "20000",
    "max_supply": "20000",
    "status": "PENDING",
    "bytecode_hash": "e3c7a4d1…5f2",
    "network": "mainnet",
    "deploy_psbt_id": "psbt_01HZXF7B3K",
    "whitelist_enabled": false,
    "signers": [
      { "key_id": "key_01HZX4M8QT", "is_signed": true, "user_id": "4021" },
      { "key_id": "key_01HZX52NRB", "is_signed": false, "user_id": "4088" }
    ]
  }
]
}

Was this page helpful?