Skip to main content
GET
/
balance
Account balance and trading status
curl --request GET \
  --url https://csboard.com/v1/balance \
  --header 'Authorization: Bearer <token>'
{
  "currency": "USD",
  "balance_usd": 1240.55,
  "trading_enabled": true,
  "settled_balance_usd": 980.1,
  "held_usd": 260.45,
  "held_until": "2026-07-06T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile.

Response

Current balance and trading status.

​
currency
string
required
Example:

"USD"

​
balance_usd
number
required

Total balance in USD.

​
trading_enabled
boolean
required

Whether buying is enabled for this key.

​
settled_balance_usd
number
required

Portion of the balance that is settled (reversal-safe) and spendable on reversal-safe purchases.

​
held_usd
number
required

Portion of the balance currently held.

​
held_until
string<date-time> | null
required

When the held portion clears, or null if nothing is held.