Skip to main content
GET
Get the remaining and used balance of the current user account. This endpoint returns user-level balance information, independent of specific tokens, for viewing the overall account balance.

Authorization

string
required
All API endpoints require Bearer Token authenticationGet your API Key:Visit the API Key Management Page to get your API KeyAdd it to the request header:

Endpoints

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

Response

boolean
Whether the request was successful
string
Error message (only returned on failure)
float
User remaining balance (returned on success).
integer
User remaining credits (returned on success).
float
User used balance (returned on success)
float
User used credits (returned on success)

Token Balance vs User Balance

Use Cases

  • View overall user account balance
  • Set up recharge reminders and balance alerts
  • Display account balance in user dashboard
Balance Unit InformationThe unit of the balance value depends on system configuration:
  • USD - US Dollars
  • CNY - Chinese Yuan
  • Tokens - Token count

Common Errors

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