Запрос баланса

Для удобства пользователей ProxyAPI предоставляет доступ к балансу личного кабинета посредством простого запроса API.

Разрешения для ключа

В целях безопасности по умолчанию у ключей ProxyAPI нет доступа к методу получения баланса. Для того, чтобы открыть доступ необходимо зайти в личный кабинет, перейти в раздел Ключи API , нажать кнопку редактирования желаемого ключа и поставить галочку напротив метода Запрос баланса.

Метод API

GET https://api.proxyapi.ru/proxyapi/balance

Формат ответа

Формат ответа зависит от типа API ключа:

Для ключей без ограничения бюджета:

Возвращается общий баланс аккаунта:

{
    "balance": 123.45
}

Для ключей с ограничением бюджета:

Возвращается баланс, подсчитанный для данного ключа:

{
    "balance": 37.66,
    "budget": {
        "limit": 50.00,
        "used": 12.34
    }
}

Где:

• balance - для неограниченных ключей: общий баланс аккаунта; для ключей с бюджетом: остаток бюджета ключа (рассчитывается как limit - used)
• budget.limit - установленный лимит бюджета для данного ключа
• budget.used - использованная сумма данным ключом

Пример запроса:

curl --location 'https://api.proxyapi.ru/proxyapi/balance' --header 'Authorization: Bearer <КЛЮЧ>'