跳轉到主要內容
GET
/
v1
/
user
/
balance
curl --request GET \
  --url 'https://toapis.com/v1/user/balance' \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "remain_credits": 20000,
  "used_credits": 5100,
  "credits_per_usd": 200,
  "unlimited_quota": false
}
  • 查詢當前用戶賬戶的總體餘額
  • 監控用戶級別的使用情況
  • 支持 CORS 跨域請求
  • 實時餘額監控
獲取當前用戶賬戶的剩餘餘額和已使用餘額。此接口返回用戶級別的餘額信息,與具體令牌無關,用於查看用戶賬戶的總體餘額,同時會返回積分字段,固定按 1 USD = 200 積分 換算。

Authorizations

Authorization
string
必填
所有接口均需要使用 Bearer Token 進行認證獲取 API Key:訪問 API Key 管理頁面 獲取您的 API Key使用時在請求頭中添加:
Authorization: Bearer YOUR_API_KEY

接口端點

GET /v1/user/balance
GET /user/balance
兩個端點功能相同,可以任選其一使用。
curl --request GET \
  --url 'https://toapis.com/v1/user/balance' \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "remain_credits": 20000,
  "used_credits": 5100,
  "credits_per_usd": 200,
  "unlimited_quota": false
}

Response

success
boolean
請求是否成功
message
string
錯誤信息(僅失敗時返回)
remain_balance
float
用戶剩餘餘額(成功時返回)。當 unlimited_quotatrue 時,該值爲 -1
used_balance
float
用戶已使用餘額(成功時返回)
remain_credits
float
用戶剩餘積分(成功時返回),固定按 1 USD = 200 積分 換算
used_credits
float
用戶已使用積分(成功時返回)
credits_per_usd
float
積分換算比例,當前返回 200
unlimited_quota
boolean
是否爲無限額度用戶。true 表示無限額度,false 表示有限額度

令牌餘額 vs 用戶餘額

對比項令牌餘額 (/v1/balance)用戶餘額 (/v1/user/balance)
作用範圍單個令牌整個用戶賬戶
數據來源Token 的 RemainQuota 和 UsedQuotaUser 的 quota 和 used_quota
使用場景監控單個 API Key 的使用情況查看用戶賬戶總體餘額
受限於令牌級別的額度限制用戶級別的額度限制

使用場景

  • 查看用戶賬戶的總體餘額
  • 用於充值提醒和餘額告警
  • 在用戶控制面板顯示賬戶餘額
餘額單位說明餘額數值的單位取決於系統配置:
  • USD - 美元
  • CNY - 人民幣
  • Tokens - Token 數量
如果需要穩定讀取積分,請優先使用 remain_creditsused_credits。這兩個字段固定按 1 USD = 200 積分 換算,不受餘額展示配置影響。
無限額度用戶當用戶被設置爲無限額度時:
  • unlimited_quota 字段返回 true
  • remain_balance 字段返回 -1
  • 該用戶不受額度限制,可無限使用

常見錯誤

錯誤信息原因解決方案
無 Authorization 頭未提供 Authorization 請求頭添加 Authorization: Bearer sk-xxxxx 請求頭
獲取用戶額度失敗用戶不存在檢查令牌關聯的用戶是否存在
獲取已使用額度失敗數據庫查詢錯誤聯繫管理員檢查系統狀態
安全提示API Key 相當於密碼,請妥善保管,不要泄露給他人。生產環境請務必使用 HTTPS。