Docs
Coverage MatrixDocumentationChange LogLog InContact Us
Docs

Provides detailed roster information for a given game.

⏱️

Update Frequency

1s Time To Live / Cache



Data Points

Category & Sport:
AttributeParent ElementTypeDescription
country_codesport_event_context - categoryStringCountry code for a sport event's category
ex. ENG (England)
idsport_event_context - categoryStringUnique category ID for a sport event
ex. sr:category:83
namesport_event_context - categoryStringName for a sport event's category
ex. Rugby League
idsport_event_context - sportStringUnique sport ID for a sport event
ex. sr:sport:12
namesport_event_context - sportStringName for a sport event's sport
ex. Rugby
Competition:
AttributeParent ElementTypeDescription
gendersport_event_context - competitionStringGender for a competition
men, women
idsport_event_context - competitionStringUnique ID for a competition
ex. sr:competition:302 (Super League)
namesport_event_context - competitionStringName of a competition
ex. Super League, NRL, Women
Groups:
AttributeParent ElementTypeDescription
idsport_event_context - groups - groupStringUnique ID for a sport event's group
ex. sr:league:80301 (Super League 2024)
namesport_event_context - groups - groupStringName of a sport event's group
ex. Super League 2024, Super League 2024, Playoffs
group_namesport_event_context - groups - groupStringAbbreviated name of a sport event's group
ex. D
Rounds:
AttributeParent ElementTypeDescription
competition_sport_event_numbersport_event_context - roundIntegerSport event number within a competition. Used for competitions that have fixed match numbers.
cup_round_idsport_event_context - roundStringUnique ID for a sport event's cup round
ex. sr:cup_round:2120411
cup_round_number_of_sport_eventssport_event_context - roundIntegerNumber of events in a sport event's round
cup_round_sport_event_numbersport_event_context - roundIntegerNumber within the cup_round of a match ID. For example, 1st leg of 2
namesport_event_context - roundStringName of a sport event's round
ex. semifinal or final
numbersport_event_context - roundIntegerNumber of a sport event's round
other_sport_event_idsport_event_context - roundStringA linked sport event ID, typically in a two-legged tie
ex. sr:sport_event:47395897
Seasons:
AttributeParent ElementTypeDescription
competition_idsport_event_context - seasonStringUnique ID for the competition a sport event belongs to
ex. sr:competition:302 (Super League)
disabledsport_event_context - seasonBooleanSignifies a season has been disabled when true
end_datesport_event_context - seasonDateEnd date of a sport event's season
ex. 2024-10-12
idsport_event_context - seasonStringUnique ID for a sport event's season
ex. sr:season:112664 (Super League 2024)
namesport_event_context - seasonStringName of a sport event's season
ex. Super League 2024
start_datesport_event_context - seasonDateStart date of a sport event's season
ex. 2024-02-15
yearsport_event_context - seasonStringYear of a sport event's season
ex. 2024
Stages:
AttributeParent ElementTypeDescription
end_datesport_event_context - stageDateEnd date of a sport event's stage
ex. 2024-09-21
ordersport_event_context - stageIntegerOrder of a stage within a season
phasesport_event_context - stageStringName of a sport event's stage
ex. final_phase, knockout_stage, playoffs

See the enum_phase entry in our Rugby OpenAPI specs for a complete list of valid phase enum values
start_datesport_event_context - stageDateStart date of a sport event's stage
ex. 2024-02-15
typesport_event_context - stageStringType of a sport event's stage
cup, league
yearsport_event_context - stageStringYear of a sport event's stage
ex. 2024
Competitor:
AttributeParent ElementTypeDescription
abbreviationcompetitors - competitorStringAbbreviation for a competitor name
ex. WGW (Wigan Warriors)
age_groupcompetitors - competitorStringAge group of a competitor, when applicable
ex. U23
gendercompetitors - competitorStringGender for a competitor
male, female
idcompetitors - competitorStringUnique ID for a competitor
ex. sr:competitor:4233 (Wigan Warriors)
namecompetitors - competitorStringName for a competitor
ex. Wigan Warriors
qualifiercompetitors - competitorStringDesignation of a competitor for a sport event
home, away
virtualcompetitors - competitorBooleanSignifies a competitor is a virtual team whan true. Used for placeholder teams in TBD vs TBD matchups.
Player:
AttributeParent ElementTypeDescription
country_codeplayerStringCountry code of a player
ex. ENG (England)
date_of_birthplayerDateDate of birth of a player
ex. 1988-09-15
genderplayerStringGender of a player
male, female
heightplayerIntegerHeight of a player in centimeters
ex. 187
idplayerStringUnique ID of a player
ex. sr:player:472010
jersey_numberplayerIntegerJersey number of a player
nameplayerStringName of a player
ex. Cooper, Mike
nationalityplayerStringNationality of a player
ex. England
nicknameplayerStringNickname of a player
playedplayerBooleanSignifies a player appeared in a game when true

We do not currently differentiate between starter and played in the API.
starterplayerBooleanSignifies a player is in the starting lineup of a match when true

We do not currently differentiate between starter and played in the API.
typeplayerStringPosition of a player
ex. FB, C, W, SR, Back

See our FAQ for a complete list of our positions.
weightplayerIntegerWeight of a player in kilograms
ex. 103
Manager:
AttributeParent ElementTypeDescription
country_codemanagerStringCountry code of a manager
ex. AUS (Australia)
date_of_birthmanagerDateDate of birth of a manager
ex. 1961-06-23
gendermanagerStringGender of a manager
male, female
idmanagerStringUnique ID of a manager
ex. sr:player:1096992
namemanagerStringName of a manager
ex. Fagan, Chris
nationalitymanagerStringNationality of a manager
ex. Australia
nicknamemanagerStringNickname of a manager
Sport Event:
AttributeParent ElementTypeDescription
idsport_eventStringUnique ID of a sport event
ex. sr:sport_event:53800561
replaced_bysport_eventStringAn alternative sport event ID if the match is postponed and played at a later date
ex. sr:sport_event:47395897
resume_timesport_eventDateAn updated timestamp if there is a delay at the start or interruption during a match
ex. 2024-03-26T20:00:00+00:00
start_timesport_eventDateStart time of a sport event
ex. 2024-03-26T20:00:00+00:00
start_time_confirmedsport_eventBooleanSignifies the start time of a sport event is confirmed when true
overall_conditionssport_event_conditions - weatherStringWeather conditions for a sport event
good, medium, bad, indoor, extreme
pitch_conditionssport_event_conditions - weatherStringPitch conditions for a sport event
good, medium, bad
Sport Event - Coverage Properties:
AttributeParent ElementTypeDescription
livesport_event - coverageBooleanSignifies a sport event is covered live when true
typesport_event - coverage - propertyStringType of coverage for a sport event
ex. boxscore, lineups, match_clock
valuesport_event - coverage - propertyBooleanSignifies a coverage types is available when true

For example, type="boxscore" value="true" signifies additional team and player stats are available for this sport event. See our FAQ for more info on coverage.
Sport Event - Referee:
AttributeParent ElementTypeDescription
idsport_event_conditions - referees - refereeStringUnique ID for a referee
ex. sr:referee:766676
namesport_event_conditions - referees - refereeStringName of a referee
ex. Ridley, Christophe
nationalitysport_event_conditions - referees - refereeStringNationality of a referee
ex. Wales
country_codesport_event_conditions - referees - refereeStringCountry code of a referee
ex. WAL
typesport_event_conditions - referees - refereeStringType of a referee
ex. main_referee
Sport Event Status:
AttributeParent ElementTypeDescription
away_scoresport_event_statusIntegerTotal score for the away team in the match
away_normaltime_scoresport_event_statusIntegerScore for the away team in normal time
home_scoresport_event_statusIntegerTotal score for the home team in the match
home_normaltime_scoresport_event_statusIntegerScore for the home team in normal time
match_statussport_event_statusStringStatus within a match (sport event). Provides more detail on the state of a sport event when live than status
ex. not_started, 1st_quarter, ended, cancelled

See our FAQ for a complete list of statuses and their definitions.
match_tiesport_event_statusBooleanSignifies a matched ended in a tie when true
scount_abandonedsport_event_statusBooleanSignifies a sport event was abandoned by a scout when true
statussport_event_statusStringStatus of a sport event
ex. not_started, live, ended, closed

See our FAQ for a complete list of statuses and their definitions.
winner_idsport_event_statusStringUnique ID of the match winner
ex. sr:competitor:4231
Period Scores:
AttributeParent ElementTypeDescription
away_scoresport_event_status - period_scores - period_scoreIntegerAway team period score
home_scoresport_event_status - period_scores - period_scoreIntegerHome team period score
numbersport_event_status - period_scores - period_scoreIntegerPeriod number
typesport_event_status - period_scores - period_scoreStringPeriod type
ex. 1st_half, 2nd_half, pause, 1st_extra, 2nd_extra, extra_time_halftime, awaiting_extra, interrupted, overtime, regular_period
Venue:
AttributeParent ElementTypeDescription
capacityvenueIntegerCapacity of a venue
ex. 25138
changedvenueBooleanSignifies a venue has been changed when true
city_namevenueStringCity name of a venue
ex. Wigan
country_codevenueStringCountry code of a venue
ex. ENG (England)
country_namevenueStringCountry name of a venue
ex. England
idvenueStringUnique ID of a venue
ex. sr:venue:666
map_coordinatesvenueStringCoordinates of a venue
ex. 53.547367,-2.654146
namevenueStringName of a venue
ex. DW Stadium
reduced_capacityvenueBooleanOptional attribute signifying a venue has a restricted capacity when true
reduced_capacity_maxvenueIntegerValue of a venue's restrictued capacity
timezonevenueStringTimezone of a venue
ex. Europe/London
Language
Credentials
Query
Click Try It! to start a request and see the response here!