Skip to content

Events

Returns a list of games that are available for simulation.

FieldTypeRequiredDescription
tokenheaderauthentication token provided from /auth route
sourcequeryData provider source
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
sportquerySport type
(Enum: SOCCER, BASKETBALL, BASEBALL, FOOTBALL)
FieldTypeRequiredDescription
idstringKero UUID of the event
sim_game_idstringID of the game in the stats source
namestringTitle of the event
sourcestringEnum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta
sportstringEnum: "SOCCER", "BASKETBALL", "BASEBALL", "FOOTBALL"
team_home_positionstringIndicates if the home team is on the "LEFT" or "RIGHT"
short_namestringShort title of the event
event_imagestringURL to the event image
leagueLeagueLeague object containing league metadata
started_atintegerTimestamp of the event’s start in UNIX seconds
team_aTeamHome team object
team_bTeamAway team object

League Object

FieldTypeRequiredDescription
idintegerKero ID for the league
namestringFull name of the league (tournament)
source_league_idstringPrimary league ID from the external data source
(related to the provider in the source field)
locationstringCountry or region where the league is based
source_namestringData provider source
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
sources[]LeagueSourceA list of league sources

League Source Object

FieldTypeRequiredDescription
idintegerKero ID for the league source
sourcestringData provider source
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
source_season_idstringSeason ID from the external data source
source_league_idstringLeague ID from the external data source
source_league_namestringLeague name from the external data source

Team Object

FieldTypeRequiredDescription
idintegerKero team ID
namestringFull name of the team
short_namestringabbreviated name of the team
common_namestringteam name preferable for mapping
imagestringPublic URL of the team’s logo or image
sourceTeamSourcePrimary source info (e.g., from betradar)
sources[]TeamSourceList of all source mappings for the team

Team Source Object

FieldTypeRequiredDescription
sourcestringName of the data provider
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
source_team_idstringTeam ID within the external data provider
source_team_namestringTeam name within the external data provider

Starts a simulation of up to 5 concurrent games.

FieldTypeDescription
tokenheaderauthentication token provided from /auth route
FieldTypeRequiredDefaultDescription
catalogue_idstring-UUID of the catalogue item
starts_atinteger5 minutes from NOWTimestamp in UNIX seconds (when the sim should start)
FieldTypeRequiredDescription
idstringKero UUID of the event
sim_game_idstringSimulated ID of the game in the stats source
namestringFull event name
sourcestringData provider source
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
sportstringSport type
(Enum: SOCCER, BASKETBALL, BASEBALL, FOOTBALL)
team_home_positionstringSide of the home team (LEFT or RIGHT)
short_namestringShort display version of the event name
leagueLeagueLeague info (see below)
started_atintegerGame start time as UNIX timestamp (seconds)
team_aTeamHome team data (see below)
team_bTeamAway team data (see below)

League Object

FieldTypeRequiredDescription
idintegerKero ID for the league
namestringFull name of the league (tournament)
source_league_idstringPrimary league ID from the external data source
(related to the provider in the source field)
locationstringCountry or region where the league is based
source_namestringData provider source
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
sources[]LeagueSourceA list of league sources

League Source Object

FieldTypeRequiredDescription
idintegerKero ID for the league source
sourcestringData provider source
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
source_season_idstringSeason ID from the external data source
source_league_idstringLeague ID from the external data source
source_league_namestringLeague name from the external data source

Team Object

FieldTypeRequiredDescription
idintegerKero team ID
namestringFull name of the team
short_namestringabbreviated name of the team
common_namestringteam name preferable for mapping
imagestringPublic URL of the team’s logo or image
sourceTeamSourcePrimary source info (e.g., from betradar)
sources[]TeamSourceList of all source mappings for the team

Team Source Object

FieldTypeRequiredDescription
sourcestringName of the data provider
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
source_team_idstringTeam ID within the external data provider
source_team_namestringTeam name within the external data provider

Stops the provided sim if present.

FieldTypeDescription
tokenheaderauthentication token provided from /auth route
pathsim_game_idsim_game_id field value of the simulated game to stop

Empty response

Subscribes your account to a specific game in the provided source.

FieldTypeDescription
tokenheaderAuthentication token provided from /auth route
game_idpathID of the game in the provided stats source
sourcepathStats source name (Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
Empty response

Unsubscribes your account to a specific game in the provided source.

FieldTypeDescription
tokenheaderAuthentication token provided from /auth route
game_idpathID of the game in the provided stats source
sourcepathStats source name (Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
Empty response

Returns a page of events that you are allowed to subscribe to (or defined by the passed parameters).

FieldTypeData TypeRequiredDescription
tokenheaderstringauthentication token provided from /auth route
sportquerystringSport type
(Enum: SOCCER, BASKETBALL, BASEBALL, FOOTBALL)
livequerybooleanwhen true only returns events which are already started and not finished yet
endedquerybooleanwhen true only returns events which are already finished
searchquerystringfilter for events by team names
pagequeryintegernumber of page (starts from 1)
sizequeryintegersize of page
availablequerybooleanwhen true shows games available for subscription (which are not already subscribed)
FieldTypeRequiredDescription
pageintegerpage number passed in the request
sizeintegerpage size passed in the request
last_pagebooleantrue if the current page is the last page
content[]Eventarray of events

Event Object

FieldTypeRequiredDescription
idstringUnique identifier of the event (Kero UUID)
namestringFull event name
short_namestringShort display version of the event name
game_idstringGame ID from the source system
sportstringSport type
(Enum: SOCCER, BASKETBALL, BASEBALL, FOOTBALL)
sourcestringData provider source
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
team_home_positionstringSide of the home team (LEFT or RIGHT)
team_aTeamHome team data (see below)
team_bTeamAway team data (see below)
started_atintegerGame start time as UNIX timestamp (seconds)
leagueLeagueLeague info (see below)
alternate_game_idsobjectMap of provider-specific game IDs
(key = provider name
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta),
value = provider id)

League Object

FieldTypeRequiredDescription
idintegerKero ID for the league
namestringFull name of the league (tournament)
source_league_idstringPrimary league ID from the external data source
(related to the provider in the source field)
locationstringCountry or region where the league is based
source_namestringData provider source
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
sources[]LeagueSourceA list of league sources

League Source Object

FieldTypeRequiredDescription
idintegerKero ID for the league source
sourcestringData provider source
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
source_season_idstringSeason ID from the external data source
source_league_idstringLeague ID from the external data source
source_league_namestringLeague name from the external data source

Team Object

FieldTypeRequiredDescription
idintegerKero team ID
namestringFull name of the team
short_namestringabbreviated name of the team
common_namestringteam name preferable for mapping
imagestringPublic URL of the team’s logo or image
sourceTeamSourcePrimary source info (e.g., from betradar)
sources[]TeamSourceList of all source mappings for the team

Team Source Object

FieldTypeRequiredDescription
sourcestringName of the data provider
(Enum: betradar, sportradar, nba_cdn, genius, statsapi_nhl, opta)
source_team_idstringTeam ID within the external data provider
source_team_namestringTeam name within the external data provider