TrendScope REST API v1

Документация API

Программный доступ к каналам, постам и алертам вашего аккаунта. Доступно на тарифе Business.

Начало работы

TrendScope REST API позволяет автоматизировать получение данных: каналы, посты, алерты и статистику аккаунта — программно, без браузера.

Тариф

Business

обязателен для доступа

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

X-API-Key

заголовок запроса

Формат

JSON

все ответы и тела

Базовый URL всех API-запросов:

https://trendscope.website/api/v1

Перед началом работы создайте API-ключ в разделе «API» вашего дашборда.

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

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

Заголовок запроса

X-API-Key: ts_ваш_api_ключ

Пример полного запроса:

bash

curl -X GET "https://trendscope.website/api/v1/me" \
  -H "X-API-Key: ts_ваш_api_ключ"

Никогда не передавайте ключ в параметрах URL (?key=…) — только в заголовке. URL логируются серверами, прокси и CDN.

Аккаунт

GET

/api/v1/me

Информация об аккаунте

Возвращает данные текущего аккаунта: email, имя, тариф и дату регистрации.

bash

curl "https://trendscope.website/api/v1/me" \
  -H "X-API-Key: ts_ваш_ключ"

Каналы

GET

/api/v1/channels

Список каналов

Возвращает все отслеживаемые каналы аккаунта: YouTube, Telegram, VK, Dzen и другие.

bash

curl "https://trendscope.website/api/v1/channels" \
  -H "X-API-Key: ts_ваш_ключ"

Посты

GET

/api/v1/posts

Список постов

Возвращает посты по всем каналам аккаунта с последними метриками. История ограничена 90 днями (тариф Business).

Параметры

Параметр	Тип	Описание
platform	string	Фильтр: youtube \| telegram \| vk \| dzen \| instagram
channel_id	integer	ID конкретного канала
limit	integer	Кол-во записей, 1–200 (по умолчанию 50)

bash

# Все посты
curl "https://trendscope.website/api/v1/posts" \
  -H "X-API-Key: ts_ваш_ключ"

# 20 последних с YouTube
curl "https://trendscope.website/api/v1/posts?platform=youtube&limit=20" \
  -H "X-API-Key: ts_ваш_ключ"

# Посты конкретного канала
curl "https://trendscope.website/api/v1/posts?channel_id=1" \
  -H "X-API-Key: ts_ваш_ключ"

Поле insight_class

viral
Подтверждённый вирусный контент
viral_candidate
Потенциально вирусный
confirmed_viral
Мощный вирусный всплеск
anomaly
Аномальный рост метрик
trending
Устойчивый рост
normal
Обычная активность

Алерты

GET

/api/v1/alerts

Список алертов

Возвращает алерты — события вирусности и аномалий по каналам аккаунта. История — 90 дней.

Параметры

Параметр	Тип	Описание
unread_only	boolean	true — только непрочитанные (по умолчанию false)
limit	integer	Кол-во записей, 1–200 (по умолчанию 50)

bash

# Все алерты
curl "https://trendscope.website/api/v1/alerts" \
  -H "X-API-Key: ts_ваш_ключ"

# Только непрочитанные
curl "https://trendscope.website/api/v1/alerts?unread_only=true&limit=20" \
  -H "X-API-Key: ts_ваш_ключ"

Значения alert_type

viral
Вирусный рост
viral_candidate
Потенциально вирусный
confirmed_viral
Подтверждённый вирусный
anomaly
Аномальный скачок метрик
trending
Устойчивый тренд
engagement
Высокая вовлечённость

Коды ошибок

Код	Ситуация	Что делать
401	Заголовок X-API-Key отсутствует или ключ недействителен	Проверьте ключ в дашборде. Возможно, он был отозван.
403	Тариф не Business или ключ создан до обновления	Убедитесь, что тариф Business активен, создайте новый ключ.
404	Ресурс не найден	Проверьте правильность URL и идентификатора.
422	Неверные параметры запроса	Проверьте типы и допустимые значения параметров.
429	Превышен лимит запросов (будущее)	Добавьте задержку между запросами.
5xx	Внутренняя ошибка сервера	Повторите запрос через несколько секунд.

Тело ошибки всегда содержит поле detail:

json

{
  "detail": "API-ключ недействителен или отозван."
}

Безопасность

Хранение ключа

Используйте переменные окружения (.env файл). Никогда не хардкодьте ключ в исходном коде и не коммитьте в репозиторий.

Передача ключа

Только в заголовке X-API-Key. Никогда — в URL или теле запроса. URL логируются серверами, прокси и CDN.

Отзыв при компрометации

Если ключ мог утечь — немедленно отзовите его в разделе «API» дашборда и создайте новый.

Несколько ключей

Создавайте отдельный ключ для каждой интеграции (Zapier, свой сервер, Telegram-бот). Так легче отозвать один без ущерба другим.

Пример безопасного использования в Python:

python

import os
import httpx

# Загружаем ключ из переменной окружения, не хардкодим
API_KEY = os.environ["TRENDSCOPE_API_KEY"]
BASE = "https://trendscope.website"

headers = {"X-API-Key": API_KEY}

with httpx.Client() as client:
    resp = client.get(f"{BASE}/api/v1/channels", headers=headers)
    resp.raise_for_status()
    channels = resp.json()
    print(f"Каналов: {len(channels)}")

Хранение в .env

# .env (добавьте этот файл в .gitignore!)
TRENDSCOPE_API_KEY=ts_ваш_секретный_ключ

Готовы начать?

Создайте API-ключ в дашборде и начните интегрировать данные TrendScope прямо сейчас.

Перейти к управлению ключами