Skip to main content
GET
Account balance and trading status
The balance endpoint returns your current balance in USD along with the breakdown that matters for automated buying: how much is settled versus how much is currently held. Settled funds are reversal-safe and available to spend on reversal-safe purchases. 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

string
required
Always "USD". All amounts are denominated in US dollars.
number
required
Your total balance in USD.
boolean
required
Whether buying is enabled for this API key. If false, purchase endpoints return trading_not_enabled.
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.
number
required
The portion of your balance currently held.
datetime | null
required
ISO 8601 timestamp of when the held portion clears, or null if nothing is held.

Example request

Example response

Error codes

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.