Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clear-box.io/llms.txt

Use this file to discover all available pages before exploring further.

A wallet has two balances that matter for spend:
BalanceMeaning
SettledFunds that have fully settled on-chain.
AvailableSettled funds minus active holds — the amount the mirror ledger will authorize against.

​
Get a balance

GET /v1/wallets/wlt_5c1d.../balance
Authorization: Bearer $CLEARBOX_API_KEY

{
  "wallet_id": "wlt_5c1d...",
  "currency": "USDC",
  "settled": "100.00",
  "available": "85.00",
  "holds": "15.00"
}

​
Staying in sync

Rather than polling, subscribe to balance-affecting webhooks (deposit.settled, transaction.authorized, transaction.settled) and update your local view on each event. See Event types.