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

Мы также предоставляем публичное API для получения базовой информации о записях.

Список записей

Список записей, отсортированный по убыванию даты загрузки (новые - в начале).

GET https://archive.zakviel.ru/api/records?shift={сдвиг}&limit={лимит}

Сдвиг (shift) - количество записей, которое необходимо пропустить (число больше или равное 0).
Лимит (limit) - ограничение количества записей в результате (число от 1 до 1000 включительно).

Демонстрация

GET

https://archive.zakviel.ru/api/records?shift=&limit=

Параметр shift

Параметр limit

Выполнить

Информация о записи

Предоставляет расширенную информацию о записи.

GET https://archive.zakviel.ru/api/records/info/{id записи}

Демонстрация

GET

https://archive.zakviel.ru/api/records/info/

Параметр id

Выполнить

Поисковые подсказки

Выдаёт список названий стримов, найденных по поисковому запросу. В этот список попадают не только названия самих записей, отображаемые на сайте, а и названия, которые менялись во время стрима.

GET https://archive.zakviel.ru/api/records/search/tips?limit={лимит}&query={запрос}

Запрос (query) - строка поискового запроса, не короче одного символа.
Лимит (limit) - ограничение количества подсказок в результате (число от 1 до 100 включительно).

Демонстрация

GET

https://archive.zakviel.ru/api/records/search/tips?limit=&query=

Параметр limit

Параметр query

Выполнить

Поиск записей

Список записей с наложенным поисковым фильтром, отсортированный по убыванию даты загрузки (новые - в начале).

GET https://archive.zakviel.ru/api/records/search?shift={сдвиг}&limit={лимит}&query={запрос}

Демонстрация

GET

https://archive.zakviel.ru/api/records/search?shift=&limit=&query=

Параметр shift

Параметр limit

Параметр query

Выполнить

Ограничения на использование

Частота запросов к API ограничена. Не рекомендуется совершать более 5 запросов в секунду.