GET/api/v1/contract

Get a token

Returns one token in full: its supply figures and decimals, its whitelist setting, its deployment status and bytecode hash, and which of the vault's signers have signed.

AccessRequires a permission in the workspaceMANAGE_WORKSPACE

The response is a Contract, documented under Shared objects. It is the single-token counterpart of GET /api/v1/contracts, and the place to watch a deployment started by POST /api/v1/create-token: status moves through the token deployment statuses, and the signers array shows who has signed so far.

The token must belong to the workspace you pass in workspace_id, and this call requires MANAGE_WORKSPACE in that workspace. The list call is the one to reach for when the caller holds only PAYMENT_APPROVE or VIEW_BALANCES.

Query parameters

contract_uidnumberrequired

The token to show, as returned by create-token or contracts.

workspace_idnumberrequired

The workspace the token belongs to. You must hold MANAGE_WORKSPACE in it.

bash

curl "$SQRL_API/api/v1/contract?contract_uid=512&workspace_id=342" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({
  contract_uid: "512",
  workspace_id: "342",
});
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/contract?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { symbol, status, total_supply, signers } = await res.json();

rust

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

Response200 OK

{
"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" }
]
}

Was this page helpful?