API リファレンス初心者向け更新日
GET/v1/user/balance
残高照会 API
API キーでアカウント残高とプラン利用量を照会できます。独自のスクリプトや監視システムへの組み込みに最適です。
エンドポイントと認証
text
GET https://api.icodeeasy.cc/v1/user/balance
/v1 プレフィックスなしの https://api.icodeeasy.cc/user/balance も利用できます。
ご自身の API キーで認証します。以下のいずれかのヘッダーを使用してください：
text
Authorization: Bearer <あなたのAPIキー>
X-Api-Key: <あなたのAPIキー>
x-goog-api-key: <あなたのAPIキー>
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
is_active | boolean | アカウントが有効かどうか |
balance | number | 利用可能残高 |
unit | string | 残高と利用枠の通貨。常に CNY（人民元） |
plan_type | string | 従量課金は paygo。月額プランの値は monthly_ で始まる（例 monthly_2、monthly_limit_5、monthly_gpt_5） |
daily_limit | number | 月額プランの 1 日あたりの利用枠 |
daily_used | number | 本日使用した月額プラン枠 |
daily_remaining | number | 有効な月額プランの本日の残り利用枠。有効な月額プランがなければ 0 |
plan_expires_at | string/null | プランの有効期限（ISO 8601）。月額プランなしは null |
リクエスト例
curl：
bash
curl https://api.icodeeasy.cc/v1/user/balance \
-H "Authorization: Bearer <あなたのAPIキー>"
レスポンス例：
json
{
"is_active": true,
"balance": 80.28,
"unit": "CNY",
"plan_type": "paygo",
"daily_limit": 0,
"daily_used": 0,
"daily_remaining": 0,
"plan_expires_at": null
}
Python：
python
import requests
resp = requests.get(
"https://api.icodeeasy.cc/v1/user/balance",
headers={"Authorization": "Bearer <あなたのAPIキー>"},
timeout=10,
)
resp.raise_for_status()
data = resp.json()
print(f"残高: ¥{data['balance']:.2f} ({data['unit']})")
補足
残高照会は利用枠を消費せず、残高が 0 でも利用できます。月額プランの対象外のリクエストにはアカウント残高が使われることがあります。
HTTP 401 は API キーが未指定または無効であることを示します。接続に問題がある場合は接続の切り分けを参照してください。