> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# トークン残高照会

>  - 現在のAPIキーの残高と使用済みクレジットを照会
- 単一トークンの使用状況を監視
- CORSクロスオリジンリクエストをサポート
- リアルタイム残高監視 

現在のAPIキー（トークン）の残高と使用済み残高を取得します。このエンドポイントは単一トークンの使用状況を監視するために使用されます。

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.apimart.ai/v1/balance' \
    --header 'Authorization: Bearer <token>'
  ```

  ```python Python theme={null}
  import requests

  API_BASE = 'https://api.apimart.ai'
  API_KEY = 'sk-xxxxxxxxxxxxxxxxxxxxxx'

  headers = {
      'Authorization': f'Bearer {API_KEY}'
  }

  def get_token_balance():
      response = requests.get(f'{API_BASE}/v1/balance', headers=headers)
      data = response.json()
      
      if data.get('success'):
          if data.get('unlimited_quota'):
              print("クォータ: 無制限")
          else:
              print(f"残高: {data['remain_balance']}")
          print(f"使用済み: {data['used_balance']}")
      else:
          print(f"照会失敗: {data.get('message')}")
      
      return data

  get_token_balance()
  ```

  ```javascript JavaScript theme={null}
  const API_BASE = 'https://api.apimart.ai';
  const API_KEY = 'sk-xxxxxxxxxxxxxxxxxxxxxx';

  async function getTokenBalance() {
    const response = await fetch(`${API_BASE}/v1/balance`, {
      headers: {
        'Authorization': `Bearer ${API_KEY}`
      }
    });
    
    const data = await response.json();
    
    if (data.success) {
      if (data.unlimited_quota) {
        console.log('クォータ: 無制限');
      } else {
        console.log(`残高: ${data.remain_balance}`);
      }
      console.log(`使用済み: ${data.used_balance}`);
    } else {
      console.error('照会失敗:', data.message);
    }
    
    return data;
  }

  getTokenBalance();
  ```

  ```go Go theme={null}
  package main

  import (
      "encoding/json"
      "fmt"
      "io/ioutil"
      "net/http"
  )

  type BalanceResponse struct {
      Success        bool    `json:"success"`
      Message        string  `json:"message,omitempty"`
      RemainBalance  float64 `json:"remain_balance"`
      UsedBalance    float64 `json:"used_balance"`
      UnlimitedQuota bool    `json:"unlimited_quota"`
  }

  func main() {
      url := "https://api.apimart.ai/v1/balance"

      req, _ := http.NewRequest("GET", url, nil)
      req.Header.Set("Authorization", "Bearer <token>")

      client := &http.Client{}
      resp, err := client.Do(req)
      if err != nil {
          panic(err)
      }
      defer resp.Body.Close()

      body, _ := ioutil.ReadAll(resp.Body)
      
      var result BalanceResponse
      json.Unmarshal(body, &result)
      
      if result.Success {
          if result.UnlimitedQuota {
              fmt.Println("クォータ: 無制限")
          } else {
              fmt.Printf("残高: %.2f\n", result.RemainBalance)
          }
          fmt.Printf("使用済み: %.2f\n", result.UsedBalance)
      }
  }
  ```

  ```java Java theme={null}
  import java.net.http.HttpClient;
  import java.net.http.HttpRequest;
  import java.net.http.HttpResponse;
  import java.net.URI;

  public class Main {
      public static void main(String[] args) throws Exception {
          String url = "https://api.apimart.ai/v1/balance";

          HttpClient client = HttpClient.newHttpClient();
          HttpRequest request = HttpRequest.newBuilder()
              .uri(URI.create(url))
              .header("Authorization", "Bearer <token>")
              .GET()
              .build();

          HttpResponse<String> response = client.send(request,
              HttpResponse.BodyHandlers.ofString());

          System.out.println(response.body());
      }
  }
  ```

  ```php PHP theme={null}
  <?php

  $api_key = 'sk-xxxxxxxxxxxxxxxxxxxxxx';

  $ch = curl_init('https://api.apimart.ai/v1/balance');
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      "Authorization: Bearer $api_key"
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  $data = json_decode($response, true);

  if ($data['success']) {
      if ($data['unlimited_quota']) {
          echo "クォータ: 無制限\n";
      } else {
          echo "残高: " . $data['remain_balance'] . "\n";
      }
      echo "使用済み: " . $data['used_balance'] . "\n";
  } else {
      echo "照会失敗: " . $data['message'] . "\n";
  }
  ?>
  ```

  ```ruby Ruby theme={null}
  require 'net/http'
  require 'json'
  require 'uri'

  api_key = 'sk-xxxxxxxxxxxxxxxxxxxxxx'

  url = URI("https://api.apimart.ai/v1/balance")

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true

  request = Net::HTTP::Get.new(url)
  request["Authorization"] = "Bearer #{api_key}"

  response = http.request(request)
  data = JSON.parse(response.body)

  if data['success']
    if data['unlimited_quota']
      puts "クォータ: 無制限"
    else
      puts "残高: #{data['remain_balance']}"
    end
    puts "使用済み: #{data['used_balance']}"
  else
    puts "照会失敗: #{data['message']}"
  end
  ```

  ```swift Swift theme={null}
  import Foundation

  let apiKey = "sk-xxxxxxxxxxxxxxxxxxxxxx"
  let url = URL(string: "https://api.apimart.ai/v1/balance")!

  var request = URLRequest(url: url)
  request.httpMethod = "GET"
  request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")

  let task = URLSession.shared.dataTask(with: request) { data, response, error in
      if let error = error {
          print("Error: \(error)")
          return
      }

      if let data = data, let responseString = String(data: data, encoding: .utf8) {
          print(responseString)
      }
  }

  task.resume()
  ```

  ```csharp C# theme={null}
  using System;
  using System.Net.Http;
  using System.Threading.Tasks;

  class Program
  {
      static async Task Main(string[] args)
      {
          var apiKey = "sk-xxxxxxxxxxxxxxxxxxxxxx";
          var url = "https://api.apimart.ai/v1/balance";

          using var client = new HttpClient();
          client.DefaultRequestHeaders.Add("Authorization", $"Bearer {apiKey}");

          var response = await client.GetAsync(url);
          var result = await response.Content.ReadAsStringAsync();

          Console.WriteLine(result);
      }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json 200 - 成功 theme={null}
  {
    "success": true,
    "remain_balance": 10.5,
    "remain_credits": 105,
    "used_balance": 2.3,
    "used_credits": 23,
    "unlimited_quota": false
  }
  ```

  ```json 200 - 無制限トークン theme={null}
  {
    "success": true,
    "remain_balance": -1,
    "remain_credits": -1,
    "used_balance": 2.3,
    "used_credits": 23,
    "unlimited_quota": true
  }
  ```

  ```json 200 - トークンが見つかりません theme={null}
  {
    "success": false,
    "message": "トークン情報の取得に失敗しました: record not found"
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": 401,
      "message": "認証に失敗しました。APIキーを確認してください",
      "type": "authentication_error"
    }
  }
  ```

  ```json 429 theme={null}
  {
    "error": {
      "code": 429,
      "message": "リクエストが多すぎます。後でもう一度お試しください",
      "type": "rate_limit_error"
    }
  }
  ```
</ResponseExample>

## 認証

<ParamField header="Authorization" type="string" required>
  すべてのAPIエンドポイントにはBearer Token認証が必要です

  APIキーの取得：

  [APIキー管理ページ](https://apimart.ai/keys)にアクセスしてAPIキーを取得してください

  リクエストヘッダーに追加：

  ```
  Authorization: Bearer YOUR_API_KEY
  ```
</ParamField>

## エンドポイント

```
GET /v1/balance
GET /balance
```

両方のエンドポイントは同じ機能を持っています。どちらでも使用できます。

## レスポンス

<ResponseField name="success" type="boolean">
  リクエストが成功したかどうか
</ResponseField>

<ResponseField name="message" type="string">
  エラーメッセージ（失敗時のみ返却）
</ResponseField>

<ResponseField name="remain_balance" type="float">
  トークン残高（成功時に返却）。`unlimited_quota` が `true` の場合、値は `-1` になります
</ResponseField>

<ResponseField name="remain_credits" type="integer">
  トークン残りクレジット（成功時に返却）。`unlimited_quota` が `true` の場合、値は `-1` になります
</ResponseField>

<ResponseField name="used_balance" type="float">
  トークン使用済み残高（成功時に返却）
</ResponseField>

<ResponseField name="used_credits" type="integer">
  トークン使用済みクレジット（成功時に返却）
</ResponseField>

<ResponseField name="unlimited_quota" type="boolean">
  トークンが無制限かどうか。`true` は無制限、`false` は制限ありを意味します
</ResponseField>

## ユースケース

* 単一APIキーの消費状況を監視
* アプリケーションで現在のトークン残高を表示
* 残高がしきい値を下回った時にアラートを設定

<Note>
  **残高単位について**

  残高の単位はシステム設定によって異なります：

  * **USD** - 米ドル
  * **Credits** - クレジット
</Note>

<Tip>
  **無制限トークン**

  トークンが無制限に設定されている場合：

  * `unlimited_quota` フィールドは `true` を返します
  * `remain_balance` フィールドは `-1` を返します
  * `remain_credits` フィールドは `-1` を返します
  * そのトークンは制限なしで無制限に使用できます
</Tip>

## 一般的なエラー

| エラーメッセージ            | 原因                         | 解決策                                     |
| ------------------- | -------------------------- | --------------------------------------- |
| Authorizationヘッダーなし | Authorizationヘッダーが提供されていない | `Authorization: Bearer sk-xxxxx`ヘッダーを追加 |
| トークン情報の取得に失敗        | トークンが存在しないか削除された           | トークンキーが正しいか確認                           |

<Warning>
  **セキュリティに関する注意**

  APIキーはパスワードと同様です。安全に保管し、他人と共有しないでください。本番環境では必ずHTTPSを使用してください。
</Warning>