Query Token Balance

Query the remaining and used quota of the current API Key

GET /v1/balance

cURL

curl --request GET \
  --url 'https://toapis.com/v1/balance' \
  --header 'Authorization: Bearer <token>'

200 - Success

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "remain_credits": 2100,
  "used_credits": 460,
  "credits_per_usd": 200,
  "unlimited_quota": false
}

• 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

Authorization · string · required

All endpoints require Bearer Token authentication

Get your API Key:

Visit the API Key Management Page to get your API Key

Add it to the request header:

Authorization: Bearer YOUR_API_KEY

Endpoints

GET /v1/balance
GET /balance

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

cURL

curl --request GET \
  --url 'https://toapis.com/v1/balance' \
  --header 'Authorization: Bearer <token>'

200 - Success

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "remain_credits": 2100,
  "used_credits": 460,
  "credits_per_usd": 200,
  "unlimited_quota": false
}

Response

success · boolean

Whether the request was successful

message · string

Error message (only returned on failure)

remain_balance · float

Token remaining balance (returned on success). Returns -1 when unlimited_quota is true

used_balance · float

Token used balance (returned on success)

remain_credits · float

Token remaining credits (returned on success). Credits are calculated with 1 USD = 200 credits

used_credits · float

Token used credits (returned on success)

credits_per_usd · float

Credit conversion rate. Currently returns 200

unlimited_quota · boolean

Whether the token has unlimited quota. true means unlimited, false means limited

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

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.

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

Common Errors

Error 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

Security Note

Your API Key is like a password. Keep it secure and don’t share it with others. Always use HTTPS in production.