GetSpendableBalanceOutput

Output from the spendable balance endpoint.

balance objectrequired

Unified amount type for all API responses.

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000

decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

feeRatenumber

Fee rate used during estimation. Only when estimating BTC balances on Bitcoin.

GetSpendableBalanceOutput

{
  "balance": {
    "amount": "string",
    "rawAmount": "1500000000000000000",
    "decimals": 0,
    "symbol": "string",
    "chain": "string"
  },
  "feeRate": 0
}