Получить баланс аккаунта
Чтение баланса аккаунта или бюджета субаккаунта
Для пользователей из материкового Китая: используйте https://api.toapis.cn в качестве эндпоинта (Base URL). Замените https://api.toapis.com на https://api.toapis.cn во всех примерах этого документа.
Аутентификация, пагинация и ошибки описаны в разделе Подключение.
Поведение
Возвращает баланс текущего аккаунта для проверки оставшейся квоты. balance_kind различает тип баланса: account_balance — баланс аккаунта, subaccount_budget — собственный бюджет суб-аккаунта (без средств родителя).
Поля remaining_* и used_* берутся из одного снимка квоты. Суммы в USD пересчитаны по credits_per_usd из ответа.
Аутентификация
AuthorizationstringзаголовокобязательноИспользуйте Bearer YOUR_SYSTEM_ACCESS_TOKEN. API-ключ модели не подходит. Заголовок X-User-Id не требуется.
Параметры запроса
Параметры пути, параметры запроса и тело запроса не используются.
Примеры запросов
Пример запроса
curl --request GET \
--url 'https://api.toapis.com/api/v1/account/balance' \
--header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'import requests
response = requests.get(
"https://api.toapis.com/api/v1/account/balance",
headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
timeout=30,
)
response.raise_for_status()
print(response.json())const url = new URL("https://api.toapis.com/api/v1/account/balance");
const response = await fetch(url, {
headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());Поля ответа
Данные примеров вымышлены и предполагают credits_per_usd="100". Используйте коэффициент из ответа API.
codeintegerЧисловой код результата; 0 означает успех.
messagestringСообщение ответа; пустое при успехе. Сообщения об ошибках локализуются.
dataobjectОбъект результата текущего запроса.
data.remaining_creditsstringОставшаяся квота аккаунта в credits. Десятичная строка для сохранения точности.
data.used_creditsstringИспользованная квота в credits. Десятичная строка для сохранения точности.
data.remaining_usdstringОставшаяся квота в USD. Десятичная строка для сохранения точности.
data.used_usdstringИспользованная квота в USD. Десятичная строка для сохранения точности.
data.credits_per_usdstringЧисло credits за 1 USD. Используйте этот коэффициент. Десятичная строка для сохранения точности.
data.balance_kindstringaccount_balance означает баланс, subaccount_budget означает собственный бюджет субаккаунта без средств родителя.
Примеры ответов
Пример ответа
{
"code": 0,
"message": "",
"data": {
"remaining_credits": "1000",
"remaining_usd": "10",
"used_credits": "100",
"used_usd": "1",
"credits_per_usd": "100",
"balance_kind": "account_balance"
}
}