Получить баланс аккаунта

GET

/api/v1/account/balance

Для пользователей из материкового Китая: используйте https://toapis.cn в качестве эндпоинта (Base URL). Замените https://toapis.com на https://toapis.cn во всех примерах этого документа.

Аутентификация, пагинация и ошибки описаны в разделе Начало работы.

Поведение

balance_kind=account_balance означает баланс, а subaccount_budget означает собственный бюджет субаккаунта, не средства родителя. remaining_* и used_* основаны на одном снимке. Используйте возвращенный credits_per_usd.

Аутентификация

Authorizationstringзаголовокобязательно

Используйте Bearer YOUR_SYSTEM_ACCESS_TOKEN. API-ключ модели не подходит. Заголовок X-User-Id не требуется.

Параметры

Параметры пути, параметры запроса и тело запроса не используются.

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

curl --request GET \
  --url 'https://toapis.com/api/v1/account/balance' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'

import requests

response = requests.get(
    "https://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://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_kindstring

account_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"
  }
}