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

# トークン残高の照会

> Query the remaining and used quota of the current API Key

* Query the remaining and used quota of the current API Key
* Monitor single token usage
* CORS cross-origin support
* Real-time balance monitoring

Get the remaining and used balance of the current API Key (token). This endpoint is used to monitor the usage of a single token. Credit fields are also returned using the fixed conversion rate `1 USD = 200 credits`.

## Authorizations

<ParamField header="Authorization" type="string" required>
  All endpoints require Bearer Token authentication

  Get your API Key:

  Visit the [API Key Management Page](https://toapis.com/console/token) to get your API Key

  Add it to the request header:

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

## エンドポイントs

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

Both endpoints have the same functionality, you can use either one.

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

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

  API_BASE = 'https://toapis.com'
  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("Token quota: Unlimited")
          else:
              print(f"Token remaining balance: {data['remain_balance']}")
              print(f"Token remaining credits: {data['remain_credits']}")
          print(f"Token used: {data['used_balance']}")
          print(f"Token used credits: {data['used_credits']}")
      else:
          print(f"Query failed: {data.get('message')}")

      return data

  get_token_balance()
  ```

  ```javascript JavaScript theme={null}
  const API_BASE = 'https://toapis.com';
  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('Token quota: Unlimited');
      } else {
        console.log(`Token remaining balance: ${data.remain_balance}`);
        console.log(`Token remaining credits: ${data.remain_credits}`);
      }
      console.log(`Token used: ${data.used_balance}`);
      console.log(`Token used credits: ${data.used_credits}`);
    } else {
      console.error('Query failed:', 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"`
      RemainCredits  float64 `json:"remain_credits"`
      UsedCredits    float64 `json:"used_credits"`
      CreditsPerUSD  float64 `json:"credits_per_usd"`
      UnlimitedQuota bool    `json:"unlimited_quota"`
  }

  func main() {
      url := "https://toapis.com/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("Quota: Unlimited")
          } else {
              fmt.Printf("Remaining balance: %.2f\n", result.RemainBalance)
              fmt.Printf("Remaining credits: %.2f\n", result.RemainCredits)
          }
          fmt.Printf("Used: %.2f\n", result.UsedBalance)
          fmt.Printf("Used credits: %.2f\n", result.UsedCredits)
      }
  }
  ```

  ```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://toapis.com/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://toapis.com/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 "Quota: Unlimited\n";
      } else {
          echo "Remaining balance: " . $data['remain_balance'] . "\n";
      }
      echo "Used: " . $data['used_balance'] . "\n";
  } else {
      echo "Query failed: " . $data['message'] . "\n";
  }
  ?>
  ```

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

  api_key = 'sk-xxxxxxxxxxxxxxxxxxxxxx'

  url = URI("https://toapis.com/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 "Quota: Unlimited"
    else
      puts "Remaining balance: #{data['remain_balance']}"
    end
    puts "Used: #{data['used_balance']}"
  else
    puts "Query failed: #{data['message']}"
  end
  ```

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

  let apiKey = "sk-xxxxxxxxxxxxxxxxxxxxxx"
  let url = URL(string: "https://toapis.com/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()
  ```
</RequestExample>

<ResponseExample>
  ```json 200 - Success theme={null}
  {
    "success": true,
    "remain_balance": 10.5,
    "used_balance": 2.3,
    "remain_credits": 2100,
    "used_credits": 460,
    "credits_per_usd": 200,
    "unlimited_quota": false
  }
  ```

  ```json 200 - Unlimited Quota Token theme={null}
  {
    "success": true,
    "remain_balance": -1,
    "used_balance": 2.3,
    "remain_credits": 2100,
    "used_credits": 460,
    "credits_per_usd": 200,
    "unlimited_quota": true
  }
  ```

  ```json 200 - Token Not Found theme={null}
  {
    "success": false,
    "message": "Failed to get token info: record not found"
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": 401,
      "message": "Authentication failed, please check your API key",
      "type": "authentication_error"
    }
  }
  ```

  ```json 429 theme={null}
  {
    "error": {
      "code": 429,
      "message": "Too many requests, please try again later",
      "type": "rate_limit_error"
    }
  }
  ```
</ResponseExample>

## レスポンス

<ResponseField name="success" type="boolean">
  Whether the request was successful
</ResponseField>

<ResponseField name="message" type="string">
  エラー message (only returned on failure)
</ResponseField>

<ResponseField name="remain_balance" type="float">
  Token remaining balance (returned on success). Returns `-1` when `unlimited_quota` is `true`
</ResponseField>

<ResponseField name="used_balance" type="float">
  Token used balance (returned on success)
</ResponseField>

<ResponseField name="remain_credits" type="float">
  Token remaining credits (returned on success). Credits are calculated with `1 USD = 200 credits`
</ResponseField>

<ResponseField name="used_credits" type="float">
  Token used credits (returned on success)
</ResponseField>

<ResponseField name="credits_per_usd" type="float">
  Credit conversion rate. Currently returns `200`
</ResponseField>

<ResponseField name="unlimited_quota" type="boolean">
  Whether the token has unlimited quota. `true` means unlimited, `false` means limited
</ResponseField>

## Use Cases

* Monitor consumption of a single API Key
* Display current token balance in your application
* Set up balance alerts when balance falls below threshold

<Note>
  **Balance Unit Information**

  The unit of the balance value depends on system configuration:

  * **USD** - US Dollars
  * **CNY** - Chinese Yuan
  * **Tokens** - Token count

  For stable integration, prefer `remain_credits` and `used_credits` when you need credit values. These fields always use `1 USD = 200 credits` and do not depend on the balance display configuration.
</Note>

<Tip>
  **Unlimited Quota Token**

  When a token is set to unlimited quota:

  * `unlimited_quota` field returns `true`
  * `remain_balance` field returns `-1`
  * The token has no quota restrictions and can be used without limits
</Tip>

## Common エラー

| エラー Message              | Cause                                   | Solution                                    |
| ------------------------ | --------------------------------------- | ------------------------------------------- |
| No Authorization header  | Authorization header not provided       | Add `Authorization: Bearer sk-xxxxx` header |
| Failed to get token info | Token doesn't exist or has been deleted | Check if the token key is correct           |

<Warning>
  **Security Note**

  Your API Key is like a password. Keep it secure and don't share it with others. Always use HTTPS in production.
</Warning>