Перейти к основному содержанию
GET
/
v1
/
user
/
balance
curl --request GET \
  --url 'https://toapis.com/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "remain_credits": 20000,
  "used_credits": 5100,
  "credits_per_usd": 200,
  "unlimited_quota": false
}
  • Запрос общего баланса аккаунта пользователя
  • Мониторинг использования на уровне пользователя
  • Поддержка CORS
  • Мониторинг баланса в реальном времени
Получение остатка и использованного баланса аккаунта пользователя. Этот эндпоинт возвращает информацию о балансе на уровне пользователя, независимо от конкретных токенов. Также возвращаются поля кредитов с фиксированной конвертацией 1 USD = 200 credits.

​
Авторизация

​
Authorization
string
обязательно
Все эндпоинты требуют аутентификации Bearer TokenПолучить API ключ:Посетите Страницу управления API ключами для получения API ключаДобавьте в заголовок запроса:
Authorization: Bearer YOUR_API_KEY

​
Эндпоинты

GET /v1/user/balance
GET /user/balance
Оба эндпоинта имеют одинаковую функциональность. 
curl --request GET \
  --url 'https://toapis.com/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "remain_credits": 20000,
  "used_credits": 5100,
  "credits_per_usd": 200,
  "unlimited_quota": false
}

​
Ответ

​
success
boolean
Успешность запроса
​
message
string
Сообщение об ошибке (только при неудаче)
​
remain_balance
float
Остаток баланса пользователя (возвращается при успехе). Возвращает -1 когда unlimited_quota равно true
​
used_balance
float
Использованный баланс пользователя (возвращается при успехе)
​
remain_credits
float
Оставшиеся credits пользователя (возвращается при успехе). Рассчитывается по курсу 1 USD = 200 credits
​
used_credits
float
Использованные credits пользователя (возвращается при успехе)
​
credits_per_usd
float
Курс конвертации credits. Сейчас возвращает 200
​
unlimited_quota
boolean
Имеет ли пользователь безлимитную квоту. true означает безлимитную, false означает ограниченную

​
Баланс токена vs Баланс пользователя

СравнениеБаланс токена (/v1/balance)Баланс пользователя (/v1/user/balance)
ОбластьОдин токенВесь аккаунт пользователя
Источник данныхRemainQuota и UsedQuota токенаquota и used_quota пользователя
ПрименениеМониторинг использования одного API ключаПросмотр общего баланса аккаунта
ОграниченЛимитами квоты токенаЛимитами квоты пользователя

​
Применение

  • Просмотр общего баланса аккаунта пользователя
  • Настройка напоминаний о пополнении и оповещений о балансе
  • Отображение баланса аккаунта в панели управления
Информация о единицах балансаЕдиница измерения баланса зависит от конфигурации системы:
  • USD - Доллары США
  • CNY - Китайские юани
  • Tokens - Количество токенов
Для стабильной интеграции используйте remain_credits и used_credits, если нужны значения в credits. Эти поля всегда используют 1 USD = 200 credits и не зависят от настройки отображения баланса.
Безлимитный пользовательКогда пользователь имеет безлимитную квоту:
  • Поле unlimited_quota возвращает true
  • Поле remain_balance возвращает -1
  • Пользователь не имеет ограничений квоты

​
Частые ошибки

Сообщение об ошибкеПричинаРешение
Нет заголовка AuthorizationЗаголовок Authorization не предоставленДобавьте заголовок Authorization: Bearer sk-xxxxx
Не удалось получить квоту пользователяПользователь не существуетПроверьте существует ли пользователь связанный с токеном
Не удалось получить использованную квотуОшибка запроса к базе данныхСвяжитесь с администратором
Примечание по безопасностиВаш API ключ подобен паролю. Храните его в безопасности и не делитесь с другими. Всегда используйте HTTPS в продакшене.