Метод `topchampionships` — топ-чемпионаты

Для чего нужен метод

Метод topchampionships возвращает список самых популярных чемпионатов — до 12 — для Live или Prematch. Например, для блока «Популярные турниры» на главной странице или быстрых ссылок в меню.

По каждому чемпионату приходят его ID, название, вид спорта, страна и количество доступных матчей. Матчи выбранного чемпионата затем запрашиваются методом events по tournament_id.

Как формируется список

Тип линии	Что попадает в список
`line` (Prematch)	Главные чемпионаты букмекера: Лига Чемпионов, топ-лиги Европы, NBA, NHL и т. п. — в порядке их популярности. В ответе только чемпионаты, по которым сейчас есть матчи в линии
`live`	Чемпионаты, в которых сейчас идут матчи, — сначала самые популярные (топ-лиги), при равной популярности выше те, у которых больше матчей

Список Live меняется в течение дня: в нём только то, что идёт прямо сейчас. Поэтому ночью в нём могут оказаться менее известные турниры — это самые популярные из идущих.

Киберспорт в список не входит. Если API-ключ открывает только часть видов спорта, список формируется в их пределах.

Запрос

GET https://YOUR_API_DOMAIN/v1/topchampionships/{type}/{lang}

API-ключ необходимо передавать в HTTP-заголовке:

Package: YOUR_API_KEY

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

Параметр	Тип	Обязательный	Описание
`type`	string	да	Тип линии: `live` или `line`. Другое значение — пустой список
`lang`	string	да	Язык названий. Язык должен поддерживаться API и входить в тариф клиента

Пример запроса

curl --request GET \
  --url 'https://YOUR_API_DOMAIN/v1/topchampionships/line/ru' \
  --header 'Package: YOUR_API_KEY'

Пример ответа

Ответ Prematch для ключа с баскетболом и бейсболом:

{
  "status": 1,
  "page": "/v1/topchampionships",
  "body": [
    {
      "position": 1,
      "tournament_id": 166775,
      "tournament_name": "МЛБ",
      "sport_id": 5,
      "sport_name": "Бейсбол",
      "country_id": 153,
      "country_name": "США",
      "counter": 4
    },
    {
      "position": 2,
      "tournament_id": 13589,
      "tournament_name": "NBA",
      "sport_id": 3,
      "sport_name": "Баскетбол",
      "country_id": 153,
      "country_name": "США",
      "counter": 41
    }
  ]
}

Поля ответа

Верхний уровень

Поле	Тип	Описание
`status`	number	`1` — успешный ответ
`page`	string	Технический адрес метода: `/v1/topchampionships`
`body`	array	Список чемпионатов в порядке популярности. Может быть пустым

Объект чемпионата

Поле	Тип	Описание
`position`	number	Место в списке: `1`, `2`, …
`tournament_id`	number	ID чемпионата. Используется как `tournamentId` в `events`
`tournament_name`	string	Название чемпионата на языке `lang`
`sport_id`	number	ID вида спорта
`sport_name`	string	Название вида спорта на языке `lang`
`country_id`	number	ID страны или региона
`country_name`	string	Название страны или региона на языке `lang`
`counter`	number	Количество матчей чемпионата: в Prematch — во всей линии, в Live — идущих сейчас

Что делать с полученным `tournament_id`

Матчи чемпионата — методом events с тем же типом линии:

GET https://YOUR_API_DOMAIN/v1/events/{sport_id}/{tournament_id}/sub/50/{type}/{lang}

Например, все Prematch-матчи NBA из примера выше:

GET https://YOUR_API_DOMAIN/v1/events/3/13589/sub/50/line/ru

Иконки

Иконки чемпионата, вида спорта и страны — стандартные иконки SportAPI по ID из ответа:

https://cdn.sportapi.net/tournaments/v1/color/{tournament_id}.webp
https://cdn.sportapi.net/sports/v1/color/{sport_id}.webp
https://cdn.sportapi.net/flags/v1/color/{country_id}.webp

Подробнее — Иконки и медиафайлы SportAPI.

Отличие от `topmatches` и `toplist`

Метод	Что возвращает
`topchampionships`	Популярные чемпионаты (без матчей)
`topmatches`	Популярные матчи Live или Prematch всех видов спорта
`toplist`	Популярные Prematch-матчи одного вида спорта

Частота обновления

Список Prematch меняется редко — достаточно запрашивать его раз в 5–10 минут. Список Live следует за ходом матчей — раз в 1–2 минуты.

Метод topchampionships — топ-чемпионаты