> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Проверка баланса аккаунта

> Получение доступного баланса и валюты аккаунта YCloud.

## Что это такое

Balance API возвращает доступный баланс для аутентифицированного аккаунта YCloud.
Используйте его для операционного мониторинга, оповещений о биллинге и
проверки аутентификации.

## Перед началом работы

* Обеспечьте безопасное хранение вашего API-ключа YCloud.
* Определите, как часто вашему приложению требуются данные о балансе.
* Задайте пороговое значение для оповещений с учетом ожидаемого объема отправки.

## Как это работает

Этот эндпоинт доступен только для чтения и всегда применяется к аккаунту,
определенному по API-ключу. Он не принимает идентификатор аккаунта в пути или теле запроса.

Используйте его в задачах мониторинга, а не перед отправкой каждого сообщения.
Частые проверки баланса перед каждым сообщением увеличивают задержку и не резервируют средства.

## Запрос

`GET /balance`

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl https://api.ycloud.com/v2/balance \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Accept: application/json"
```

## Ответ

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "amount": 190.0765,
  "currency": "USD"
}
```

| Поле | Описание |
| - | - |
| `amount` | Доступный баланс аккаунта. |
| `currency` | Валюта, используемая аккаунтом. |

## Рекомендации по мониторингу

* Настройте оповещения до того, как баланс достигнет уровня, способного прервать
  отправку рабочего трафика.
* Отображайте валюту в дашбордах и оповещениях.
* Используйте отдельное оповещение для сбоев API, чтобы недоступность проверки
  не принималась за нулевой баланс.
* Ограничьте доступ к данным о балансе как к конфиденциальной финансовой информации.

## Лимиты и устранение неполадок

* Успешный ответ на запрос баланса подтверждает корректность API-ключа и базового URL.
* Низкий баланс может повлиять на работу тарифицируемых сервисов обмена сообщениями,
  даже если аутентификация API прошла успешно.
* Не предполагайте, что сумма указана в USD; проверяйте `currency`.
* Избегайте логирования API-ключа в журналах мониторинга.

<Card title="Справочник Balance API" icon="wallet" href="/api-reference/balance/retrieve-balance">
  Изучите полную схему ответа и протестируйте запрос, доступный только для чтения.
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.