残高照会

現在の API キーが属するアカウントの残高ステータスを返します。利用可能残高、累計入金、累計消費が含まれます。

このエンドポイントは OfoxAI OpenAPI に属し、プロトコル（OpenAI / Anthropic / Gemini）に依存しません。有効な OfoxAI API キーであれば呼び出し可能で、レスポンス構造は cc-switch などの第三者ツールと互換です。

エンドポイント


GET https://api.ofox.ai/v1/user/balance

同じエンドポイントは Anthropic / Gemini の入口経由でも公開されており、異なる Base URL を設定済みのクライアントから再利用できます：

URL
`https://api.ofox.ai/v1/user/balance`
`https://api.ofox.ai/anthropic/user/balance`
`https://api.ofox.ai/gemini/user/balance`

3 つの URL は完全に同一のレスポンス構造を返します。

認証

有効な OfoxAI API キー（sk-...）を Authorization: Bearer ヘッダーで渡します：


Authorization: Bearer sk-xxx

ユーザーレベル API キー（Dashboard で作成）を使用してください。Internal / Gateway 内部キーは使わないでください。

リクエスト例

cURL

Terminal


curl https://api.ofox.ai/v1/user/balance \
  -H "Authorization: Bearer $OFOX_API_KEY"

Python

balance.py


import os
import requests
 
resp = requests.get(
    "https://api.ofox.ai/v1/user/balance",
    headers={"Authorization": f"Bearer {os.environ['OFOX_API_KEY']}"},
)
data = resp.json()
print(f"利用可能残高: ${data['balance']:.4f} {data['currency']}")

TypeScript

balance.ts


const resp = await fetch('https://api.ofox.ai/v1/user/balance', {
  headers: { Authorization: `Bearer ${process.env.OFOX_API_KEY}` },
})
const data = await resp.json()
console.log(`利用可能残高: $${data.balance.toFixed(4)} ${data.currency}`)

レスポンス形式

成功レスポンス 200 OK：


{
  "is_active": true,
  "balance": 42.1357,
  "total": 100.0000,
  "used": 57.8643,
  "currency": "USD"
}

レスポンスフィールド

フィールド	型	説明
`is_active`	boolean	アカウントが利用可能かどうか。認証成功時 `true`、失敗時 `false`
`balance`	number	現在の利用可能残高、`total - used` に等しい
`total`	number	累計入金：チャージ + ボーナス + ギフトカードの合計
`used`	number	累計消費：全呼び出しによる消費合計
`currency`	string	通貨単位、固定で `"USD"`

すべての金額は USD で 64 ビット浮動小数点数として表現されます。内部精度は NanoDollar（10⁻⁹ USD）で、サブセント単位まで正確です。

エラーレスポンス

認証失敗またはサービス異常時は 200 以外のステータスコードを返し、レスポンスボディは cc-switch と互換の形式です：


{
  "error": "unauthenticated",
  "is_active": false
}

ステータス	`error` 値	説明
`401`	`unauthenticated`	API キーが無効、無効化済み、または期限切れ
`500`	`internal error`	内部サービスエラー、後でリトライしてください

第三者ツール互換性

本エンドポイントのレスポンス構造は cc-switch の残高照会テンプレートと互換で、cc-switch の残高プロバイダとして直接組み込めます：

is_active でステータスチェック
balance は cc-switch の remaining フィールドにマッピング
total / used で消費進捗を表示