Skip to main content
GET https://geekapis.com/v1/user/balance 接口用于查询当前用户账户级别的余额信息。与 /v1/balance(令牌余额)不同,此接口返回的是整个用户账户的余额,与具体使用哪个令牌无关。同时返回积分字段,固定按 1 USD = 200 积分 换算。
该接口支持两个等价端点,功能完全相同,可任选其一:
GET https://geekapis.com/v1/user/balance
GET https://geekapis.com/user/balance

令牌余额 vs 用户余额

对比项令牌余额 GET /v1/balance用户余额 GET /v1/user/balance
作用范围单个 API Key(令牌)整个用户账户
数据来源Token 的 RemainQuota / UsedQuotaUser 的 quota / used_quota
典型场景监控某个 API Key 的用量查看账户总余额、充值提醒
受限于令牌级别的额度限制用户级别的额度限制

鉴权

Authorization
string
required
Bearer Token 认证。在请求头中添加:
Authorization: Bearer YOUR_API_KEY
前往 API Key 管理页面 获取您的 API Key。

响应字段

success
boolean
请求是否成功。
message
string
错误信息,仅在请求失败时返回。
remain_balance
float
用户账户剩余余额。当 unlimited_quotatrue 时,该值返回 -1。余额单位取决于系统配置(USD / CNY / Tokens)。
used_balance
float
用户账户已使用余额。
remain_credits
float
用户剩余积分,固定按 1 USD = 200 积分 换算。推荐优先使用此字段进行余额监控。
used_credits
float
用户已使用积分,固定按 1 USD = 200 积分 换算。
credits_per_usd
float
积分换算比例,当前固定返回 200
unlimited_quota
boolean
是否为无限额度用户。true 表示无限额度,此时 remain_balance 返回 -1

代码示例

curl --request GET \
  --url 'https://geekapis.com/v1/user/balance' \
  --header 'Authorization: Bearer YOUR_API_KEY'

响应示例

200 - 查询成功
{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "remain_credits": 20000,
  "used_credits": 5100,
  "credits_per_usd": 200,
  "unlimited_quota": false
}
200 - 无限额度用户
{
  "success": true,
  "remain_balance": -1,
  "used_balance": 0,
  "remain_credits": -1,
  "used_credits": 0,
  "credits_per_usd": 200,
  "unlimited_quota": true
}
余额单位说明remain_balanceused_balance 的单位取决于系统配置,可能为 USD、CNY 或 Token 数量。如需稳定的跨配置读取,请优先使用 remain_creditsused_credits,这两个字段始终固定按 1 USD = 200 积分 换算。
无限额度用户行为unlimited_quotatrue 时,remain_balance 将返回 -1,这是正常行为,表示该账户不受额度限制。

错误码

HTTP 状态码错误信息原因解决方案
200获取用户额度失败用户不存在检查令牌关联的用户是否存在
200获取已使用额度失败服务端查询错误请稍后重试,如持续出现请联系技术支持
401无 Authorization 头未提供认证请求头添加 Authorization: Bearer sk-xxxxx 请求头
429请求过于频繁触发限流降低请求频率后重试
安全提示 — API Key 相当于账户密码,请妥善保管,不要在客户端代码或公开仓库中明文暴露。生产环境请务必使用 HTTPS。