JSON API · v1

Живая база как рабочий инструмент.

Публичные маршруты возвращают те же проверенные сущности, которые видны в каталоге, с происхождением данных и отдельным типом объекта.

Маршруты

Доступные endpoints

GET/api/v1/catalog?type=channels&q=технологии

Поиск по живому каталогу

GET/api/v1/health

Состояние приложения и постоянной базы

POST/api/v1/submissions

Добавление публичного @username в очередь

POST/api/v1/reports

Сообщение об ошибке с источником

Пример

Ответ каталога

{
  "data": [{
    "slug": "telegramtips",
    "type": "channels",
    "provenance": {
      "source": "Открытая страница Telegram"
    }
  }],
  "meta": { "liveCorpus": true }
}
Коротко о главном

Частые вопросы

Нужен ли ключ для чтения каталога?

Для небольшого числа публичных GET-запросов ключ не нужен. Квоты и авторизация появятся до массового экспорта.

Какие типы поддерживаются?

Параметр type принимает channels, bots или chats.

Можно ли публиковать копию базы?

Нет. Массовая перепубликация требует отдельного соглашения; отдельные результаты можно цитировать со ссылкой.