Skip to main content
Gets the current balance of the SparkWallet, including Bitcoin balance and token balances.

Method Signature

Returns

object
required
Breakdown of the sats balance by status:
  • available: Immediately spendable satoshis
  • owned: All satoshis owned (available + locked in outgoing transfers/swaps)
  • incoming: Pending inbound transfers not yet claimed
TokenBalanceMap
required
Map of Bech32m token identifiers to token balance and metadata objects. Each token balance contains:
  • ownedBalance: Total tokens owned (including those pending in outbound transfers)
  • availableToSendBalance: Tokens available to send (excludes pending outbound transfers)
  • tokenMetadata: Token metadata including name, ticker, decimals, etc.
The ownedBalance represents all tokens you own, while availableToSendBalance excludes tokens that are locked in pending outbound transfers. Use availableToSendBalance to determine how many tokens can be sent.
Incoming transfers are excluded from satsBalance.owned until claimed. A Lightning payment status or a pending transfer is not proof of spendable funds. See Received does not mean spendable.

Example