Get API Key Get API
Docs

Query Token Balance

- Query remaining and used credits of the current API Key

  • Monitor single token usage
  • CORS support for cross-origin requests
  • 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.

Request example

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

Response example

{
  "success": true,
  "remain_balance": 10.5,
  "remain_credits": 105,
  "used_balance": 2.3,
  "used_credits": 23,
  "unlimited_quota": false
}

Authorization

Authorization string

All API 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.

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

remain_credits integer

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

used_balance float

Token used balance (returned on success)

used_credits integer

Token used credits (returned on success)

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
Note

Balance Unit Information

The unit of the balance value depends on system configuration:

  • USD - US Dollars
  • Credits - Credits
Tip

Unlimited Quota Token

When a token is set to unlimited quota:

  • unlimited_quota field returns true
  • remain_balance field returns -1
  • remain_credits 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
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.

This documentation is built and hosted on Mintlify, a developer documentation platform.