TGScore EN

TGScore API

Программная проверка качества аудитории Telegram-каналов — для агентств, бирж и медиабаеров.

Доступ

Ключ выдаётся в один тап — нажмите кнопку, и бот сразу пришлёт ваш персональный ключ. Он передаётся в заголовке X-API-Key.

Получить ключ
01 Создать проверку
POST /api/v1/checks

Отправьте список каналов — @handle или t.me-ссылки. В ответ — идентификатор задачи.

cURL
curl -X POST https://tgscore.ru/api/v1/checks \
  -H "X-API-Key: tgs_..." \
  -H "Content-Type: application/json" \
  -d '{"channels": ["@durov", "https://t.me/telegram"]}'
202

Задача принята: job_id, status: queued и список channels. Готовые отчёты-документы дополнительно приходят в ваш диалог с ботом.

02 Получить результаты
GET /api/v1/checks/<job_id>

Опрашивайте задачу по идентификатору. Когда статус становится delivered — в ответе появляется поле results.

cURL
curl https://tgscore.ru/api/v1/checks/<job_id> \
  -H "X-API-Key: tgs_..."
200

По каждому каналу — машиночитаемый вердикт suitability (buy / maybe / avoid), локализованная зона риска, топ-флаги и дата проверки.

03 Остаток проверок
GET /api/v1/credits

Узнайте, сколько проверок осталось на балансе ключа. Только чтение — баланс не меняется.

cURL
curl https://tgscore.ru/api/v1/credits \
  -H "X-API-Key: tgs_..."
200

Ответ: credits — остаток доступных проверок, daily_credit — устаревшее поле совместимости, всегда равное 0. Ежедневного бесплатного пополнения нет.

Ошибки
401 Нет ключа или ключ отозван.
402 На балансе аккаунта нет проверок.
422 Нет валидных каналов или больше 50 за запрос.
429 Превышен лимит запросов — 30 в минуту на ключ.
Получить ключ