账户
GET /v1/balance — 账户余额与交易状态
查询您的 CSBoard 美元余额，已结算和冻结的金额，以及您的 API 密钥是否启用了交易。
GET
/
balance
Account balance and trading status
curl --request GET \
--url https://csboard.com/v1/balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://csboard.com/v1/balance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://csboard.com/v1/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://csboard.com/v1/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://csboard.com/v1/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://csboard.com/v1/balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://csboard.com/v1/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}{
"code": "missing_api_key",
"detail": "Provide your API key via `Authorization: Bearer csb_pub_…`. Generate one at https://csboard.com/profile?tab=api"
}{
"code": "rate_limit_exceeded",
"detail": "Read rate limit of 100 requests/min exceeded. The counter restarts in 23 s. For new listings use GET /v1/listings/stream instead of polling.",
"bucket": "read",
"limit_per_min": 100,
"retry_after_sec": 23
}balance 端点返回您当前以美元计的余额，以及对自动化购买至关重要的明细：有多少是已结算（不可撤销且可用于不可撤销购买）的，以及当前有多少处于冻结状态。请使用
trading_enabled 在尝试下单之前确认该密钥已开启购买功能。
需要身份验证。 请将密钥作为 Authorization: Bearer csb_pub_... 发送。
参数
此端点不接受任何查询参数。响应字段
string
必填
始终为
"USD"。所有金额均以美元计价。number
必填
您以美元计的总余额。
boolean
必填
此 API 密钥是否启用了购买功能。如果为
false，购买端点将返回 trading_not_enabled。number
必填
您余额中已结算且不可撤销的部分。这部分余额可用于不可撤销的购买，例如
POST /v1/market/buy。number
必填
您余额中当前处于冻结状态的部分。
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 状态码 | 代码 | 含义 |
|---|---|---|
| 401 | missing_api_key / invalid_api_key | API 密钥缺失或无效。 |
| 429 | rate_limit_exceeded | 请求过多。请按照 Retry-After 响应头中的秒数退避。 |
在调用不可撤销的购买端点之前，请检查
settled_balance_usd 而非 balance_usd——冻结资金无法用于此类购买。授权
Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile. Calls made with a key are metered only by that key's own limits — there is no per-IP limit on top — and every answer carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and X-RateLimit-Bucket for the bucket the call spent. See Rate limits.
响应
Current balance and trading status.
示例:
"USD"
Total balance in USD.
Whether buying is enabled for this key.
Portion of the balance that is settled (reversal-safe) and spendable on reversal-safe purchases.
Portion of the balance currently held.
When the held portion clears, or null if nothing is held.
⌘I
Account balance and trading status
curl --request GET \
--url https://csboard.com/v1/balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://csboard.com/v1/balance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://csboard.com/v1/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://csboard.com/v1/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://csboard.com/v1/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://csboard.com/v1/balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://csboard.com/v1/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}{
"code": "missing_api_key",
"detail": "Provide your API key via `Authorization: Bearer csb_pub_…`. Generate one at https://csboard.com/profile?tab=api"
}{
"code": "rate_limit_exceeded",
"detail": "Read rate limit of 100 requests/min exceeded. The counter restarts in 23 s. For new listings use GET /v1/listings/stream instead of polling.",
"bucket": "read",
"limit_per_min": 100,
"retry_after_sec": 23
}