Get API Key Get API
Docs

Query User Balance

- Query overall remaining and used credits of user account

  • Get user-level balance information
  • CORS support for cross-origin requests
  • Real-time balance monitoring

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.

Request example

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

Response example

{
  "success": true,
  "remain_balance": 100.0,
  "remain_credits": 1000,
  "used_balance": 25.5,
  "used_credits": 255
}

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/user/balance
GET /user/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

User remaining balance (returned on success).

remain_credits integer

User remaining credits (returned on success).

used_balance float

User used balance (returned on success)

used_credits float

User used credits (returned on success)

Token Balance vs User Balance

Comparison Token Balance (/v1/balance) User Balance (/v1/user/balance)
Scope Single token Entire user account
Data Source Token's RemainQuota and UsedQuota User's quota and used_quota
Use Case Monitor single API Key usage View overall account balance
Limited By Token-level quota limits User-level quota limits

Use Cases

  • View overall user account balance
  • Set up recharge reminders and balance alerts
  • Display account balance in user dashboard
Note

Balance Unit Information

The unit of the balance value depends on system configuration:

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

Common Errors

Error Message Cause Solution
No Authorization header Authorization header not provided Add Authorization: Bearer sk-xxxxx header
Failed to get user quota User doesn't exist Check if the user associated with the token exists
Failed to get used quota Database query error Contact admin to check system status
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.