Инструменты · key

`getlimits` Сколько лимитов осталось

Отдаёт счётчики лимитов аккаунта: сколько начислено, сколько потрачено и сколько осталось. Метод синхронный и бесплатный — его можно вызывать перед запуском инструментов, чтобы не упереться в нехватку лимитов. Баланс в рублях и тариф отдаёт другой метод — userinfo.

Стоимость: бесплатно
Режим: синхронный
Проверка лимитов: не выполняется — метод отвечает даже при нулевом остатке

Остаток лимитов

GET /api/getlimits

Возвращает общий объём лимитов, потраченное и доступное. Если на тарифе действует месячное ограничение расхода, в ответ добавляются month_total и month_limits.

Параметры query

key string обязательный

Ключ API из настроек аккаунта.

Ответ

total int

Всего лимитов на аккаунте: по тарифу и дополнительные.
used int

Потрачено.
available int

Доступно: total − used.
month_total int

Только если у тарифа есть месячное ограничение: сколько можно потратить за месяц.
month_limits int

Вместе с month_total: сколько уже потрачено в этом месяце.

GET /api/getlimits

curl -G 'https://tools.pixelplus.ru/api/getlimits' \
  --data-urlencode 'key=ВАШ_КЛЮЧ'

<?php
$url = 'https://tools.pixelplus.ru/api/getlimits?' . http_build_query([
    'key' => 'ВАШ_КЛЮЧ',
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.get(
    "https://tools.pixelplus.ru/api/getlimits",
    params={
        "key": "ВАШ_КЛЮЧ",
    },
    timeout=60,
)
print(response.json())

Пример ответа

{
    "total": 75000,
    "used": 1250,
    "available": 73750
}

Ошибки

Код	Сообщение	Когда
`-1`	`Access denied`	Не передан `key`. HTTP-код 404.
`-2`	`Access denied`	Ключ не найден. HTTP-код 403.

Ответ с ошибкой

{
    "error": "Access denied",
    "code": -1
}

Для корпоративного аккаунта сотрудника месячное ограничение берётся у работодателя.