Перейти к содержимому
Разделы: Подборка

Подборки и витрины

Подборка

GET/v1.3/collections/{slug}

Тайтлы подборки в порядке редактора — или с фильтрами и сортировкой каталога.

Без параметров подборка приходит в порядке редактора: ord — место тайтла в ней, с 1. У топов Кинопоиска это место в топе.

Стоит добавить фильтр, поиск q или sort — и подборка становится областью поиска: ответ собирает движок каталога, а ord остаётся исходным местом. С фильтром или q total равен null, как в каталоге. Работают все фильтры и сортировки и fields.

Тайтлы подборки можно выбрать и в каталоге: /titles?collection=popular-titles. Там есть курсор, но нет ord.

Параметры пути

Параметры запроса

  • фильтры, q и sort

    Фильтры, поиск и сортировка каталога: kind=movie, q=матрица, sort=-rating_imdb. Подробно — в Фильтры и сортировка.

    По умолчанию:

    порядок редактора

  • fieldscsv

    Какие поля элемента вернуть, как в каталоге, плюс ord и note. ID приходят всегда.

    Пример: fields=title,year,ord
  • langru | en

    Оставить в ответе один язык. Без него текстовые поля приходят парами _ru и _en. Подробнее — Языки ответа.

    Пример: lang=en
  • limitinteger

    Сколько тайтлов вернуть, целое от 1 до 50.

    По умолчанию:

    50

    Пример: limit=10
  • offsetinteger

    Сколько тайтлов пропустить, целое от 0.

    По умолчанию:

    0

Поля ответа

  • collectionobject

    Сама подборка — тот же объект, что в списке подборок.

    Показать 9 полей
    • slugstring

      Имя подборки в адресе и в фильтре каталога collection.

    • name_ru · name_enstring | null

      Название.

    • description_ru · description_enstring | null

      Описание. У авторских подборок его может не быть.

    • poster_urlstring | null

      Обложка подборки. Если своей нет — постер первого тайтла.

    • items_countinteger

      Сколько тайтлов в подборке.

    • created_at · updated_atstring

      Когда подборку создали и когда в последний раз меняли состав, ISO 8601 в UTC.

  • itemsarray

    Тайтлы — та же карточка, что в каталоге.

    Показать 26 полей
    • imdb_id · kp_id · tmdb_id · tmdb_tv_id · kinorium_idstring | null

      ID тайтла в каталогах. Приходят всегда, даже с fields.

    • title_ru · title_en · title_originalstring | null

      Названия: на русском, на английском и на языке оригинала.

    • yearinteger | null

      Год выхода.

    • release_datestring | null

      Первая дата выхода, YYYY-MM-DD.

    • kindenum

      Вид тайтла: movie, series, mini_series, tv_show, anime, cartoon, short.

    • poster_url_ru · poster_url_enstring | null

      Постер для русской и английской витрины.

    • posters_by_sourceobject

      Постер каждого источника: kp, tmdb, imdb, kinorium.

    • rating_kp · rating_tmdb · rating_imdb · rating_kr · rating_letterboxdnumber | null

      Оценки Кинопоиска, TMDB, IMDb, Кинориума и Letterboxd, шкала 0–10.

    • votes_kp · votes_tmdb · votes_imdbinteger | null

      Голоса Кинопоиска, TMDB и IMDb.

    • countriesarray

      Страны: code, name_ru, name_en.

    • genresarray

      Жанры: slug, name_ru, name_en.

    • ordinteger

      Место тайтла в подборке, с 1.

    • notestring | null

      Комментарий редактора к тайтлу.

  • totalinteger | null

    Сколько тайтлов в подборке. С фильтром или q — null.

  • limit · offset · has_more

    Пагинация — как в любом списке.

Ошибки

статускодкогда
400invalid_request

Неизвестный фильтр, ключ sort или поле в fields; параметр другого эндпоинта (например, role или relation); limit не целое от 1 или offset меньше 0; повторённый параметр; cursor — подборка листается offset.

404not_found

Подборки с таким slug нет.

401unauthorized

Нет заголовка X-API-Key, ключ неизвестен или отозван.

429rate_limited

Исчерпан предел в секунду или квота на сутки.

Все коды и что с ними делать — на странице Ошибки.

Esc

Загружаем оглавление…

    ↑ ↓ выбратьEnter открытьEsc закрыть