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"
}
The balance endpoint returns your current balance in USD along with the breakdown that matters for automated buying: how much is settled (reversal-safe and available to spend on reversal-safe purchases) versus how much is currently held. Use trading_enabled to confirm buying is turned on for the key before you attempt an order. Authentication required. Send your key as Authorization: Bearer csb_pub_....

​
Parameters

This endpoint takes no query parameters.

​
Response fields

​
currency
string
required
Always "USD". All amounts are denominated in US dollars.
​
balance_usd
number
required
Your total balance in USD.
​
trading_enabled
boolean
required
Whether buying is enabled for this API key. If false, purchase endpoints return trading_not_enabled.
​
settled_balance_usd
number
required
The portion of your balance that is settled and reversal-safe. This is what you can spend on reversal-safe purchases such as POST /v1/market/buy.
​
held_usd
number
required
The portion of your balance currently held.
​
held_until
datetime | null
required
ISO 8601 timestamp of when the held portion clears, or null if nothing is held.

​
Example request

curl https://csboard.com/v1/balance \
  -H "Authorization: Bearer csb_pub_..."

​
Example response

{
  "currency": "USD",
  "balance_usd": 1240.55,
  "trading_enabled": true,
  "settled_balance_usd": 980.10,
  "held_usd": 260.45,
  "held_until": "2026-07-06T12:00:00Z"
}

​
Error codes

HTTP statusCodeMeaning
401missing_api_key / invalid_api_keyMissing or invalid API key.
429rate_limit_exceededToo many requests. Back off for the Retry-After header value.
Check settled_balance_usd, not balance_usd, before calling reversal-safe purchase endpoints — held funds cannot be spent there.

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.