残高照会 API

API概要

Balance Query API は、合計クォータ、使用済みクォータ、残高、リクエスト数を含む、アカウントの現在のクォータ使用状況を取得します。この API を使うと、アカウントの残高を簡単に監視でき、事前かつ柔軟な残高アラート管理が可能になります。

認証トークンを取得する方法

コンソールにアクセス

api.apiyi.com/account/profile にアクセスしてプロフィールページを開きます

システムトークンを見つける

ページ下部の「アカウントオプション - システムトークン」セクションを見つけます

アクセストークンを生成

アカウントのパスワードを入力すると、以降の API クエリに使用できるアクセストークンを受け取れます

API情報

項目	説明
API URL	`https://api.apiyi.com/api/user/self`
メソッド	`GET`
認証	Authorization ヘッダー
レスポンス形式	JSON

リクエスト詳細

リクエストヘッダー

ヘッダー名	必須	説明
`Authorization`	はい	API アクセストークン、形式: 直接 token 文字列
`Accept`	いいえ	推奨: `application/json`
`Content-Type`	いいえ	推奨: `application/json`

リクエストパラメーター

これは GET リクエストであり、リクエストボディのパラメーターは不要です。

レスポンス詳細

成功レスポンス例

{
  "success": true,
  "message": null,
  "data": {
    "id": 19489,
    "username": "testnano",
    "display_name": "testnano",
    "role": 1,
    "status": 1,
    "email": "",
    "quota": 24997909,
    "used_quota": 10027091,
    "request_count": 339,
    "group": "ceshi",
    "aff_code": "ZM0H",
    "inviter_id": 0,
    "access_token": "...",
    "ModelFixedPrice": [...]
  }
}

主なレスポンスフィールド

Field Name	Type	Description
`success`	Boolean	リクエストが成功したかどうか
`message`	String	エラーメッセージ（成功時は null）
`data.username`	String	ユーザー名
`data.display_name`	String	表示名
`data.quota`	Integer	残りクォータ（現在利用可能な残高、quota単位）
`data.used_quota`	Integer	使用済みクォータ（quota単位）
`data.request_count`	Integer	総リクエスト数
`data.group`	String	ユーザーグループ
`data.ModelFixedPrice`	Array	モデルの料金一覧（無視してかまいません）

クォータ換算

換算ルール

500,000 quota = $1.00 USD

計算式:

USD 金額 = quota ÷ 500,000
残りクォータ = quota（quota は現在の残高を表します）
残り USD = quota ÷ 500,000

例:

quota: 24997909 → $49.99 USD（現在の残高）
used_quota: 10027091 → $20.05 USD（使用額）

エラー応答

HTTP 401 - 認証に失敗しました

{
  "success": false,
  "message": "Unauthorized"
}

理由: Authorization token は無効または期限切れです 対処: API token を確認して更新してください

HTTP 403 - 権限が拒否されました

{
  "success": false,
  "message": "Forbidden"
}

理由: 現在の token にはこの API にアクセスする権限がありません 対処: 管理者に連絡して権限設定を確認してください

コード例

cURL 例

curl --compressed 'https://api.apiyi.com/api/user/self' \
  -H 'Accept: application/json' \
  -H 'Authorization: YOUR_TOKEN_HERE' \
  -H 'Content-Type: application/json'

重要: --compressed オプションは必須です。API が gzip 圧縮されたコンテンツを返すため、これがないと文字化けした出力になります。

クイックテスト（YOUR_TOKEN_HERE を置き換えてください）:

export APIYI_TOKEN='YOUR_TOKEN_HERE'

curl --compressed -s 'https://api.apiyi.com/api/user/self' \
  -H 'Accept: application/json' \
  -H "Authorization: $APIYI_TOKEN" \
  -H 'Content-Type: application/json' | \
  jq '.data | {quota, used_quota, request_count}'

注: -s オプションは進捗バーを非表示にし、--compressed は gzip レスポンスを自動的に展開します

Python 例（基本）

import requests

{/* Configuration */}
url = "https://api.apiyi.com/api/user/self"
authorization = "YOUR_TOKEN_HERE"  # Replace with your token

{/* Request headers */}
headers = {
    'Accept': 'application/json',
    'Authorization': authorization,
    'Content-Type': 'application/json'
}

{/* Send request */}
response = requests.get(url, headers=headers, timeout=10)

{/* Check response */}
if response.status_code == 200:
    data = response.json()
    user_data = data['data']

    {/* Extract key information */}
    quota = user_data['quota']
    used_quota = user_data['used_quota']
    request_count = user_data['request_count']

    {/* Calculate USD amounts */}
    {/* Note: quota represents current remaining balance */}
    remaining_usd = quota / 500000
    used_usd = used_quota / 500000

    {/* Print results */}
    print(f"Remaining quota: ${remaining_usd:.2f} USD ({quota:,} quota)")
    print(f"Used: ${used_usd:.2f} USD ({used_quota:,} quota)")
    print(f"Request count: {request_count:,} times")
else:
    print(f"Request failed: HTTP {response.status_code}")
    print(response.text)

Python 例（最適化版）

以下の機能を備えた完全な最適化スクリプト quota_optimized.py を提供します:

エラーハンドリング

完全な例外処理とエラー捕捉

環境変数

安全な token 管理、ハードコーディングを回避

整形済み出力

見やすい表の表示と数値のフォーマット

自動変換

USD 金額の自動計算

使用方法:

{/* Method 1: Using environment variable (recommended) */}
export APIYI_TOKEN='YOUR_TOKEN_HERE'
python quota_optimized.py

{/* Method 2: Command line argument */}
python quota_optimized.py 'YOUR_TOKEN_HERE'

出力例:

============================================================
📊 APIYI Account Balance Information
============================================================
Username: testnano (testnano)
------------------------------------------------------------
Remaining quota: 24,997,909 quota ($49.99 USD)
Used:           10,027,091 quota ($20.05 USD)
Request count: 339 times
============================================================
💡 Conversion: 500,000 quota = $1.00 USD
============================================================

よくある質問

Authorization token はどう取得しますか？

上記の「Authorization Token の取得方法」セクションを参照するか、コンソールのプロフィールページでシステム token を取得してください。

残高を照会するとクォータを消費しますか？

いいえ、残高照会 API はクォータを消費しません。

残高はどのくらいの頻度で照会できますか？

レート制限を回避するため、照会間隔は少なくとも 1 秒以上を推奨します。

ModelFixedPrice フィールドは何のためのものですか？

このフィールドは、さまざまな AI モデルの料金情報を返します。残高情報だけが必要なら、無視して構いません。

クォータフィールドは何を表しますか？

quota フィールドは現在の残高を表します。quota が 0 または 0 に近い場合、アカウント残高が不足しており、チャージが必要です。

curl で文字化けしたり、jq がエラーを報告したりするのはなぜですか？

問題: curl を実行すると文字化けし、jq が “Invalid numeric literal” を報告します理由: API は gzip 圧縮されたコンテンツ（Content-Encoding: gzip）を返し、curl は自動で展開しません。対処法: curl が自動で展開するように、--compressed オプションを追加します:

{/* ✅ Correct (with --compressed) */}
curl --compressed 'https://api.apiyi.com/api/user/self' \
  -H 'Authorization: YOUR_TOKEN' | jq

{/* ❌ Wrong (missing --compressed) */}
curl 'https://api.apiyi.com/api/user/self' \
  -H 'Authorization: YOUR_TOKEN' | jq

重要な注意事項

セキュリティに関する注意

Authorization token をコードにハードコードしないでください
機密情報の管理には環境変数または設定ファイルを使用してください
token を含むコードを公開リポジトリにコミットしないでください

リクエスト制限

適切なリクエストタイムアウトを設定してください（推奨: 10秒）
過度に頻繁なクエリリクエストは避けてください

エラーハンドリングの推奨事項

ネットワーク例外、タイムアウト、認証失敗は必ず処理してください
トラブルシューティングをしやすくするため、エラーをログに記録してください

レスポンス形式に関する注意

API は gzip 圧縮されたコンテンツを返します。curl では--compressedオプションが必要です
Python の requests ライブラリは、追加設定なしで gzip の解凍を自動的に処理します

基本

基本API

画像API（公式）

動画API（公式）

マルチモーダル理解API

テキストAPI

API概要

認証トークンを取得する方法

API情報

リクエスト詳細

リクエストヘッダー

リクエストパラメーター

レスポンス詳細

成功レスポンス例

主なレスポンスフィールド

クォータ換算

換算ルール

エラー応答

HTTP 401 - 認証に失敗しました

HTTP 403 - 権限が拒否されました

コード例

cURL 例

Python 例（基本）

Python 例（最適化版）

エラーハンドリング

環境変数

整形済み出力

自動変換

よくある質問

重要な注意事項

エラーハンドリングの推奨事項

レスポンス形式に関する注意

​API概要

​認証トークンを取得する方法

​API情報

​リクエスト詳細

​リクエストヘッダー

​リクエストパラメーター

​レスポンス詳細

​成功レスポンス例

​主なレスポンスフィールド

​クォータ換算

換算ルール

​エラー応答

​HTTP 401 - 認証に失敗しました

​HTTP 403 - 権限が拒否されました

​コード例

​cURL 例

​Python 例（基本）

​Python 例（最適化版）

エラーハンドリング

環境変数

整形済み出力

自動変換

​よくある質問

​重要な注意事項

エラーハンドリングの推奨事項

レスポンス形式に関する注意

API概要

認証トークンを取得する方法

API情報

リクエスト詳細

リクエストヘッダー

リクエストパラメーター

レスポンス詳細

成功レスポンス例

主なレスポンスフィールド

クォータ換算

エラー応答

HTTP 401 - 認証に失敗しました

HTTP 403 - 権限が拒否されました

コード例

cURL 例

Python 例（基本）

Python 例（最適化版）

よくある質問

重要な注意事項