Перейти к основному содержанию
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"
}
Эндпоинт balance возвращает ваш текущий баланс в USD вместе с разбивкой, которая важна для автоматических покупок: сколько средств подтверждено (защищено от реверса и доступно для покупок, безопасных к реверсу) и сколько в данный момент удерживается. Используйте trading_enabled, чтобы убедиться, что покупки включены для ключа, прежде чем оформлять заказ. Требуется аутентификация. Отправьте ключ как Authorization: Bearer csb_pub_....

​
Параметры

Этот эндпоинт не принимает query-параметров.

​
Поля ответа

​
currency
string
обязательно
Всегда "USD". Все суммы выражены в долларах США.
​
balance_usd
number
обязательно
Ваш общий баланс в USD.
​
trading_enabled
boolean
обязательно
Включены ли покупки для этого API-ключа. Если false, эндпоинты покупки возвращают trading_not_enabled.
​
settled_balance_usd
number
обязательно
Часть баланса, которая подтверждена и защищена от реверса. Именно эти средства вы можете тратить на покупки, безопасные к реверсу, например через POST /v1/market/buy.
​
held_usd
number
обязательно
Часть баланса, которая в данный момент удерживается.
​
held_until
datetime | null
обязательно
Временная метка ISO 8601, когда удерживаемая часть будет освобождена, либо null, если ничего не удерживается.

​
Пример запроса

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

​
Пример ответа

{
  "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"
}

​
Коды ошибок

HTTP-статусКодЗначение
401missing_api_key / invalid_api_keyОтсутствует или некорректный API-ключ.
429rate_limit_exceededСлишком много запросов. Подождите время, указанное в заголовке Retry-After.
Перед вызовом эндпоинтов покупки, безопасных к реверсу, проверяйте settled_balance_usd, а не balance_usd — удерживаемые средства там потратить нельзя.

Авторизации

​
Authorization
string
header
обязательно

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

Ответ

Current balance and trading status.

​
currency
string
обязательно
Пример:

"USD"

​
balance_usd
number
обязательно

Total balance in USD.

​
trading_enabled
boolean
обязательно

Whether buying is enabled for this key.

​
settled_balance_usd
number
обязательно

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

​
held_usd
number
обязательно

Portion of the balance currently held.

​
held_until
string<date-time> | null
обязательно

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