Единый справочник полей Sport Line API
В этом файле собраны параметры запросов и поля JSON, подтверждённые реальными ответами Sport Line API.
Объяснение связей между полями и различий объекта матча в разных методах: «Модель данных: матч».
Если ячейка «Описание» пустая, назначение поля пока не подтверждено. Такие значения не нужно интерпретировать самостоятельно: описание будет добавлено после пояснения разработчика или владельца API.
Параметры запросов
| Параметр | Где передаётся | Тип | Значения или формат | Описание |
|---|---|---|---|---|
Package | HTTP-заголовок | string | API-ключ клиента | Ключ авторизации |
type | URL | string | live, line | Тип спортивной линии |
lang | URL | string | Например, ru, en | Язык ответа, доступный в тарифе клиента |
sportId | URL | number | ID вида спорта | Получается из menu или sports |
countryId | URL | number | ID страны | Получается из menu или countries |
tournamentId | URL | number | ID турнира; 0 — все турниры спорта | Получается из menu или tournaments |
gameId | URL | number | ID матча | Получается из events |
text | URL | string | Название команды или его часть | Поисковый текст метода search; должен быть закодирован для передачи в URL |
format | URL | string | sub для events; group для event | sub группирует матчи по турнирам; group формирует коэффициенты конкретного матча по группам и колонкам и сортирует их по значениям |
count | URL | number | Передавайте 50 | Изначально задавал количество возвращаемых данных, но ограничение отменено. API возвращает все доступные матчи выбранной выборки |
cybersport | query-параметр | boolean | true, false | Переключение на киберспортивные данные в поддерживающих параметр методах |
full | query-параметр | boolean | true, false; по умолчанию false | В topmatches и toplist переключает сокращённую карточку на расширенный объект матча. Не означает получение полного списка коэффициентов |
Общий формат успешного ответа
Правила разбора успешных ответов, пустых выборок, служебных сообщений и ошибок: «Общий формат ответа Sport Line API».
| Поле | Тип | Методы | Значения или формат | Описание |
|---|---|---|---|---|
status | number | все описанные методы | 1 в успешных ответах | Статус выполнения запроса |
page | string | все описанные методы | Например, /v1/menu, /v1/events, /v1/event, /v1/toplist, /v1/search; в topmatches фактически возвращается /v1/topmathes | Название метода, сформировавшего ответ |
body | array или object | все описанные методы | Зависит от метода | Основные данные ответа |
Ошибка API
| Поле | Тип | Методы | Значения или формат | Описание |
|---|---|---|---|---|
error_code | number | все методы | Например, 90, 100 | Код категории ошибки |
error_message | string | все методы | Текст ошибки | Причина ошибки |
Вид спорта
Объект возвращается в sports и на верхнем уровне menu.
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
id | number | ID вида спорта | Используется как sportId в URL |
name | string | Название на языке запроса | Название вида спорта |
counter | number | Целое число от 0 | Количество доступных матчей этого вида спорта |
sub | array | Только в menu | Страны выбранного вида спорта |
Стандартная иконка:
https://cdn.sportapi.net/sports/v1/color/{id}.webpСтрана
Объект возвращается в countries и внутри вида спорта в menu.
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
id | number | ID страны | Используется как countryId в URL |
name | string | Название на языке запроса | Название страны |
sport_id | number | ID вида спорта | Вид спорта, к которому относится выборка страны |
counter | number | Целое число от 0 | Количество доступных матчей выбранного спорта в стране |
sub | array | Только в menu | Турниры выбранной страны |
Стандартная иконка:
https://cdn.sportapi.net/flags/v1/color/{id}.webpТурнир в навигационных методах
Объект возвращается в tournaments и внутри страны в menu.
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
id | number | ID турнира | Используется как tournamentId в URL |
name | string | Название или пустая строка | Название турнира |
counter | number | Целое число от 0 | Количество доступных матчей турнира |
sport_id | number | ID вида спорта | Вид спорта турнира |
countryId | number | ID страны | Страна турнира |
Стандартная иконка:
https://cdn.sportapi.net/tournaments/v1/color/{id}.webpТурнир в ответе events
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
tournament_id | number | ID турнира | Идентификатор турнира |
tournament_name | string | Название на языке запроса | Название турнира |
events_list | array | Массив матчей | Матчи турнира |
Матч: идентификаторы и расположение
Сокращённые поля матча из этого раздела также используются в ответе метода search.
Поиск возвращает плоский массив матчей без коэффициентов.
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
sgame_id | string | Строковый ID | Зарезервированное тестовое поле для статистики матча, команд и игроков. Пока не используется в API |
stat_id | string | Строковый ID | Зарезервированное тестовое поле для подробной статистики. Пока не используется в API |
game_id | number | Числовой ID | ID матча для запроса event |
game_mid | number или null | Числовой ID или null | ID основного матча. У субматча свой game_id, а game_mid указывает на главную игру |
game_num | number | Целое число | Старое неиспользуемое поле. Планируется к удалению из API |
game_start | number | Unix Timestamp в секундах | Время начала матча |
sport_id | number | ID вида спорта | Вид спорта матча |
sport_name | string | Название на языке запроса | Название вида спорта |
country_id | number | ID страны | Страна матча |
country_name | string | Название на языке запроса | Название страны |
tournament_id | number | ID турнира | Турнир матча |
tournament_name | string | Название на языке запроса | Название турнира |
game_dop_name | string | Например, Угловые, Жёлтые карточки, 1-й тайм | Название типа субматча |
game_desk | string | Например, Тайм, Сет, Четверть | Тип игрового отрезка |
Важно: для Live-версии матча формируется новый game_id. Prematch- и Live-матчи нельзя
связывать по этому полю.
Поля sgame_id, stat_id, game_num, stat_list_extra и game_plan не следует
использовать как обязательную часть клиентской интеграции. Они являются старыми,
тестовыми или зарезервированными. game_num планируется удалить из API.
Матч: команды или участники
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
opp_1_name | string | Название | Первая команда или участник |
opp_2_name | string | Название | Вторая команда или участник |
opp_1_id | number | Числовой ID | ID первой команды или участника |
opp_2_id | number | Числовой ID | ID второй команды или участника |
opp_1_ids | array of number | Массив ID | Участники первой стороны, если она состоит из нескольких игроков или команд, например в теннисной паре или групповом матче |
opp_2_ids | array of number | Массив ID | Участники второй стороны, если она состоит из нескольких игроков или команд, например в теннисной паре или групповом матче |
opp_1_icon | string | Имя файла, например hash.png | Иконка первой команды или участника |
opp_2_icon | string | Имя файла, например hash.png | Иконка второй команды или участника |
Для получения стандартной иконки удалите расширение из opp_1_icon или opp_2_icon и
подставьте оставшееся имя в URL:
https://cdn.sportapi.net/opp/v1/color/{iconName}.webpМатч: краткий список ставок
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
game_oc_counter | number | Целое число от 0 | Общее количество доступных ставок или исходов матча |
game_oc_list | array | Массив групп | Краткий список основных групп и лучших коэффициентов для events, topmatches?full=true и toplist?full=true |
Набор групп и исходов зависит от вида спорта. Полный список исходов получается через
метод event по game_id.
Группа ставок в game_oc_list
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
group_id | number | ID группы | Идентификатор группы ставок |
group_name | string | Название на языке запроса | Название группы ставок |
columns | number | Целое число | Рекомендуемое количество колонок для отображения. Не обязано совпадать с количеством вложенных массивов oc_list |
oc_list | array | В events, topmatches?full=true и toplist?full=true — массив исходов; в event — массив массивов | В event каждый вложенный массив представляет колонку исходов формата group |
В формате group данные уже сформированы по колонкам и отсортированы по значениям.
Рекомендуется сохранять порядок, полученный от API, а не группировать и сортировать
исходы повторно на стороне клиента.
Исход в oc_list
Практические правила использования этих полей и реальные примеры разных типов ставок: «Модель данных: коэффициенты и группы ставок».
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
oc_group_name | string | Название на языке запроса | Название группы ставки |
oc_name | string | Название на языке запроса | Название исхода |
oc_rate | number | Десятичное число | Коэффициент |
oc_size | string или number | Например, 0, "2.5", "-0.25" | Значение форы, тотала или другого параметра |
oc_pointer | string | Составной строковый ID | Основной код ставки или исхода. Передаётся в отдельную систему приёма и расчёта ставок, если она подключена. Для персональных исходов дополнительно учитывайте op_id |
oc_block | boolean | true, false | true — исход заблокирован; false — доступен |
op_id | number или null | ID или null | ID игрока или участника для персонального исхода, если применимо |
Матч: счёт, период и дополнительные данные
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
timer | number | Целое количество секунд; в Prematch обычно 0 | Таймер матча. Для получения минут разделите значение на 60 |
score_full | string | Например, "1:0" | Общий счёт |
score_period | string | Счёт или пустая строка | Счёт текущего периода |
score_extra | string | Например, "0:15" или пустая строка | Счёт гейма в теннисе. В основном используется в теннисе и может встречаться в близких форматах, включая кибертеннис |
period_name | string | Название или пустая строка | Текущий период матча |
extra_time | string | Например, "+10" или пустая строка | Количество добавленных минут |
finale | boolean или null | true, false, null | Показывает, что матч закончился. Поле доступно не для всех матчей |
pitch | string | ID или пустая строка | ID участника, выполняющего подачу, для соответствующих видов спорта |
stat_list | array | Массив статистики | Статистика матча |
stat_list_extra | array | Массив | Зарезервированное тестовое поле для дополнительного описания матча. Пока не используется |
sub_games | array | Массив субматчей | В events, topmatches?full=true и toplist?full=true возвращается как []. В конкретном event содержит ссылки на субматчи, но не их коэффициенты |
event_plan | array | Массив объектов | В events, topmatches?full=true и toplist?full=true возвращается как []. Полный список команд со стороны хозяев и гостей в групповом матче доступен только в конкретном event |
game_plan | любое JSON-значение или null | В реальных примерах null | Зарезервированное тестовое поле для описания матча, например стадии турнира или типа корта. Пока не используется |
Строка статистики в stat_list
Правила обработки, реальные примеры и подтверждённые ID показателей: «Модель данных: статистика матча».
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
id | number | ID показателя | Идентификатор показателя статистики |
name | string | Название на языке запроса | Название показателя |
opp1 | string | Число или другое значение в строковом формате | Значение первой команды или участника |
opp2 | string | Число или другое значение в строковом формате | Значение второй команды или участника |
Субматч в sub_games
Полная схема получения и открытия дополнительных матчей описана в документе «Дополнительные матчи и субматчи».
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
game_id | number или null | ID или null | ID субсобытия |
game_num | number или null | Число или null | Старое неиспользуемое поле. Планируется к удалению из API |
game_name | string или null | Название или null | Название субсобытия |
sub_games содержит ссылки на отдельные типы субматча: таймы, угловые, карточки, фолы,
статистику игроков и другие доступные варианты.
В списке events поле возвращается как пустой массив:
"sub_games": []Метод events не использует sub_games: здесь поле возвращается только как [].
Список доступен при запросе конкретного матча через event. Каждый элемент содержит
game_id, game_num и game_name. Для получения коэффициентов субматча необходимо
выполнить отдельный запрос event по его game_id.
Объект в event_plan
Метод events не использует event_plan и возвращает здесь только []. Заполненное
поле доступно в ответе конкретного event для группового матча. Основной матч может
называться «Хозяева — Гости», а массив содержит полный список конкретных команд обеих
сторон. Каждый объект описывает пару команд и время её встречи.
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
opp_1_name | string | Название | Команда со стороны хозяев |
opp_2_name | string | Название | Команда со стороны гостей |
opp_1_id | number или null | ID или null | ID команды со стороны хозяев |
opp_2_id | number или null | ID или null | ID команды со стороны гостей |
opp_1_country_id | number или null | ID или null | ID страны команды со стороны хозяев |
opp_2_country_id | number или null | ID или null | ID страны команды со стороны гостей |
opp_1_icon | string | Имя файла | Иконка команды со стороны хозяев |
opp_2_icon | string | Имя файла | Иконка команды со стороны гостей |
opp_1_date | number или null | Unix Timestamp или null | Дата и время команды со стороны хозяев |
opp_2_date | number или null | Unix Timestamp или null | Дата и время команды со стороны гостей |
game_start | number или null | Unix Timestamp или null | Время начала встречи этой пары |
Видео и Live 3D Tracker
Подробные правила:
| Поле | Тип | Значения или формат | Описание |
|---|---|---|---|
vi | string или null | ID или null | ID видеотрансляции Live-матча |
zp | number или null | ID или null | ID Live 3D Tracker; передаётся в трекер как gameid |
va | number или null | Только 1 или null | 1 — есть видеотрансляция; null — видеотрансляции нет. Значение 0 не используется |
Если zp равно null, Live 3D Tracker для матча недоступен.