API初心者向け更新日

残高照会 API

API キーでアカウント残高とプラン利用量を照会できます。独自のスクリプトや監視システムへの組み込みに最適です。

エンドポイントと認証

GET https://api.icodeeasy.cc/v1/user/balance

/v1 プレフィックスなしの https://api.icodeeasy.cc/user/balance も利用できます。

ご自身の API キーで認証します。以下のいずれかのヘッダーを使用してください:

Authorization: Bearer <あなたのAPIキー>
X-Api-Key: <あなたのAPIキー>
x-goog-api-key: <あなたのAPIキー>

レスポンスフィールド

フィールド説明
is_activebooleanアカウントが有効かどうか
balancenumber利用可能残高(元)
unitstring通貨。常に CNY
plan_typestringプランタイプ。従量課金ユーザーは balance、月額プランは monthly_limit_*
daily_limitnumber月額プランの1日あたりの枠(元)。プラン以外は 0
daily_usednumber本日使用した月額プラン枠(元)
daily_remainingnumber本日残りの月額プラン枠(元)
plan_expires_atstring/nullプランの有効期限(ISO 8601)。月額プランなしは null

リクエスト例

curl:

curl https://api.icodeeasy.cc/v1/user/balance \
  -H "Authorization: Bearer <あなたのAPIキー>"

レスポンス例:

{
  "is_active": true,
  "balance": 80.28,
  "unit": "CNY",
  "plan_type": "balance",
  "daily_limit": 0,
  "daily_used": 0,
  "daily_remaining": 0,
  "plan_expires_at": null
}

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']})")

補足

  • 残高の単位は人民元(CNY)です。月額プランユーザーは主に daily_remaining(1日の枠)を確認してください。balance は1日の枠を使い切った後に差し引かれる予備残高です。
  • このエンドポイントは残高照会専用です。残高が 0 でも残高チェックにブロックされず、常に正常に応答します。
  • 401 は API キーが未指定または無効であることを示します。is_activefalse の場合はアカウントが停止されています。
  • api.icodeeasy.cc への接続が遅い場合は、バックアップドメイン https://jp.icodeeasy.cc または https://sg.icodeeasy.cc に切り替えてください。