APIs
1.1 Get the entity definitions for the web api
Returns the defintions for the web api (Id and Description)
Method Invocation
REST Url
api/NRL/configuration/entities
Response
Entity definitions V1.0
1.2 Retrieve Season List
Get a list of available seasons for the specified competition
Method Invocation
REST Url
api/NRL/competitions/seasons/{competitionId}/{seasonId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition identifier.
No
seasonId
Integer
The season identifier.
No
Response
Season Schema V1.1
1.3 Retrieve a competition/season/Round Schedule
Returns a list of Rounds/matches for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/competitions/fixtures/{competitionId}/{seasonId}/{teamId}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Series
Yes
seasonId
Integer
Identifier of the season
Yes
teamId
Integer
Identifier of the team (Optional)
No
Response
Fixture Schema V1.07
1.4 Retrieve Ladder data
Returns the current Ladder for a specified Competition and Season. It is not possible to return a ladder for a
previous point in time using this method.
Method Invocation
REST Url
api/NRL/competitions/ladder/{competitionId}/{seasonId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition identifier.
Yes
seasonId
Integer
The season identifier.
Yes
Response
Ladder Schema V1.04
1.5 Retrieve Live Ladder data
Returns the current Ladder for a specified Competition and Season. It is not possible to return a ladder for a
previous point in time using this method.
Method Invocation
REST Url
api/NRL/competitions/liveladder/{competitionId}/{seasonId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition identifier.
Yes
seasonId
Integer
The season identifier.
Yes
Response
Ladder Schema V1.04
1.6 Retrieve a list of players in the current Squad of a team in a specified Competition/Season.
Returns a list of competitions with associated IDs.
Method Invocation
REST Url
api/NRL/competitions/squads/{competitionId}/{seasonId}/{teamId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition ID
Yes
seasonId
Integer
The season ID
Yes
teamId
Integer
The team ID (Optional - all teams will be returned if not specified)
No
Response
Team Squads Schema V1.00
1.7 Retrieve a list of players in the current Squad of a team in all competitions for a specified Season.
Returns a list of competitions with associated IDs.
Method Invocation
REST Url
api/NRL/competitions/squads/{seasonId}
Parameter Name
Type
Description
Required
seasonId
Integer
The season ID
Yes
Response
Team Squads Schema V1.00
1.8 Retrieve player profile information
Returns player bio for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/playerProfiles/{competitionId}/{seasonId}/{playerId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season identifier.
Yes
playerId
Integer
The player identifier.
No
Response
Player Profile Schema V1.03
1.9 Retrieve Competition/Season/Historical statistics for player(s)
Returns player profiles and statsitics for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/playerStats/{competitionId}/{seasonId}/{playerId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season identifier.
Yes
playerId
Integer
The player identifier (Optional - all players will be returned if not specified)
No
Response
Player Stats Schema V1.05
1.10 Retrieve Competition/Season/Historical statistics for player(s) - Version 2 added for 2016
Returns Version 2 Player profiles and statsitics for a specified Competition/Season.
Method Invocation
REST Url
api/NRL/playerStatsV2/{competitionId}/{seasonId}/{playerId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season identifier.
Yes
playerId
Integer
The player identifier (Optional - all players will be returned if not specified)
No
Response
Player Stats V2 Schema V1.00
1.11 Retrieve Competition/Season Historic statistics for team(s)
Returns team profiles and statistics for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/teamStats/{competitionId}/{seasonId}/{teamId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season identifier.
Yes
teamId
Integer
The team identifier.
No
Response
Team Stats Schema V1.07
1.12 Retrieve Competition/Season Historic statistics for team(s)
Returns team profiles and statistics for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/teamStatsV2/{competitionId}/{seasonId}/{teamId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season identifier.
Yes
teamId
Integer
The team identifier.
No
Response
Team Stats V2 Schema V1.01
1.13 Retrieve a competition/season Team (Total) Leaderboard Report
Returns a list of Leaderboards sorted by Stat Type ID for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/competitions/teamLeaderboards/{competitionId}/{seasonId}/{roundNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
seasonId
Integer
Identifier of the season
Yes
roundNumber
Integer
Optional Round Number to filter the data
No
Response
Team Leaderboard Total Schema V1.00
1.14 Retrieve a competition/season Team (Average) Leaderboard Report
Returns a list of Leaderboards sorted by Stat Type ID for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/competitions/teamLeaderboardsAverage/{competitionId}/{seasonId}/{roundNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
seasonId
Integer
Identifier of the season
Yes
roundNumber
Integer
Identifier of the season
No
Response
Team Leaderboard Total Schema V1.00
1.15 Retrieve a competition/season Team (Performance) Leaderboard Report
Returns a list of Leaderboards sorted by Stat Type ID for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/competitions/teamLeaderboardsPerformance/{competitionId}/{seasonId}/{roundNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
seasonId
Integer
Identifier of the season
Yes
roundNumber
Integer
Optional Round Number to filter the data
No
Response
Team Leaderboard Total Schema V1.00
1.16 Retrieve a competition/season Player (Total) Leaderboard Report
Returns a list of Leaderboards sorted by Stat Type ID for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/competitions/playerLeaderboards/{competitionId}/{seasonId}/{roundNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
seasonId
Integer
Identifier of the season
Yes
roundNumber
Integer
Optional Round Number to filter the data
No
Response
Player Leaderboard Total Schema V1.00
1.17 Retrieve a competition/season Player (Average) Leaderboard Report
Returns a list of Leaderboards sorted by Stat Type ID for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/competitions/playerLeaderboardsAverage/{competitionId}/{seasonId}/{roundNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
seasonId
Integer
Identifier of the season
Yes
roundNumber
Integer
Optional Round Number to filter the data
No
Response
Player Leaderboard Average Schema V1.00
1.18 Retrieve a competition/season Player (Performance) Leaderboard Report
Returns a list of Leaderboards sorted by Stat Type ID for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/competitions/playerLeaderboardsPerformance/{competitionId}/{seasonId}/{roundNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
seasonId
Integer
Identifier of the season
Yes
roundNumber
Integer
Optional Round Number to filter the data
No
Response
Player Leaderboard Performance Schema V1.00
1.19 Retrieve List of Upcoming Player Milestones
Returns the Player Milestones for a given competition ID
Method Invocation
REST Url
api/NRL/competitions/playerMilestones/{competitionId}/{seasonId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season id.
No
Response
Player Milestones Schema V1.00
1.20 Retrieve List of Upcoming Team Milestones
Returns the Team Milestones for a given competition ID
Method Invocation
REST Url
api/NRL/competitions/teamMilestones/{competitionId}/{seasonId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season id.
No
Response
Team Milestones Schema V1.00
1.21 Retrieve Breakdown of Tries Scored/Conceded
Returns the breakdown for Tries scored/conceded for a given competition/season
Method Invocation
REST Url
api/NRL/competitions/teamTrySources/{competitionId}/{seasonId}/{teamId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season identifier.
Yes
teamId
Integer
The team identifier.
No
Response
Team Try Source Schema V1.00
1.22 Retrieve a competition Player Career (Total) Leaderboard Report
Returns a list of Leaderboards sorted by Stat Type ID for a specified Competition.
Method Invocation
REST Url
api/NRL/competitions/playerLeaderboardsCareerTotal/{competitionId}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
Response
Player Leaderboard Career Total Schema V1.00
1.23 Retrieve a competition Player Career (Best Performance) Leaderboard Report
Returns a list of best performance Leaderboards sorted by Stat Type ID for a specified Competition.
Method Invocation
REST Url
api/NRL/competitions/playerLeaderboardsCareerBestPerformance/{competitionId}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
Response
Player Leaderboard Career Best Schema V1.00
1.24 Retrieve a competition Team History (Total) Leaderboard Report
Returns a list of Leaderboards sorted by Stat Type ID for a specified Competition.
Method Invocation
REST Url
api/NRL/competitions/teamLeaderboardsCareerTotal/{competitionId}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
Response
Team Leaderboard Career Total Schema V1.00
1.25 Retrieve a competition Team Career Best Leaderboard Report
Returns a list of Leaderboards sorted by Stat Type ID for a specified Competition.
Method Invocation
REST Url
api/NRL/competitions/teamLeaderboardsCareerBestPerformance/{competitionId}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
Response
Team Leaderboard Total Schema V1.00
1.26 Retrieve a competition/season Player (Total) Top Three Leaderboard Report
Returns a list of Leaderboards sorted by Player/Stat Type ID for a specified Competition and Season. Optionally filtered by players
appearing in a specified game.
Method Invocation
REST Url
api/NRL/competitions/playerTopThreeSeasonStats/{competitionId}/{seasonId}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
seasonId
Integer
Identifier of the season
Yes
Response
Player Top Three Leaderboard Total Schema V1.00
1.27 Retrieve a competition Player (Total) Top Three Leaderboard Report
Returns a list of Leaderboards sorted by Player/Stat Type ID for a specified Competition. Optionally filtered by players
appearing in a specified game.
Method Invocation
REST Url
api/NRL/competitions/playerTopThreeCareerStats/{competitionId}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
Response
Player Top Three Leaderboard Total Schema V1.00
1.28 Retrieve a competition/season Team (Total) Top Three Leaderboard Report
Returns a list of Leaderboards sorted by Team/Stat Type ID for a specified Competition and Season. Optionally filtered by teams
appearing in a specified game.
Method Invocation
REST Url
api/NRL/competitions/teamTopThreeSeasonStats/{competitionId}/{seasonId}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
seasonId
Integer
Identifier of the season
Yes
Response
Team Top Three Leaderboard Total Schema V1.00
1.29 Retrieve a competition Team (Total) Top Three Leaderboard Report
Returns a list of Leaderboards sorted by Team/Stat Type ID for a specified Competition. Optionally filtered by teams
appearing in a specified game.
Method Invocation
REST Url
api/NRL/competitions/teamTopThreeCareerStats/{competitionId}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Competition
Yes
Response
Team Top Three Leaderboard Total Schema V1.00
1.30 Retrieve Competition/Season/Historical statistics for player(s) by round - Version 2 added for 2016
Returns Version 2 Player profiles and statsitics by round for a specified Competition/Season/.
Method Invocation
REST Url
api/NRL/playerStatsV2Master/{competitionId}/{seasonId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season identifier.
Yes
Response
Player Stats V2 Schema V1.00
1.31 Retrieve Player Associations
Returns a list of players showing the competition(s) they've played in,
the season(s) they played in the competition(s) and the team(s) they played for.
Method Invocation
REST Url
api/NRL/playerAssociations/playerAssociations
Response
Player Associations Schema V1.00
2.1 Retrieve Match Data
Returns the GameStats feed relevant to the match status in the Database. The same XMl schema will be delivered
regardless of match state (Pre-Match, Live, Post-Match). Any data that cannot be populated in each state will still
be represented by empty XML nodes or NULL attributes.
Method Invocation
REST Url
api/NRL/matchStats/{matchId}
Parameter Name
Type
Description
Required
matchId
String
The match identifier.
Yes
Response
Game Stats Schema V1.10
2.2 Retrieve Form Guide for an upcoming match
Returns a Form Guide comprising previous match and head-to-head information for a specified match.
Method Invocation
REST Url
api/NRL/matchStats/FormGuide/{matchId}
Parameter Name
Type
Description
Required
matchId
String
The match identifier.
Yes
Response
Form Guide Schema V1.07
2.3 Retrieve Match Events Flow
Returns a list of Events for a match, grouped by Team and Event types. Currently, only scoring events are captured
by this feed but additional event types can be captured in the same feed for future requirements.
Method Invocation
REST Url
api/NRL/matchstats/eventsFlow/{matchId}
Parameter Name
Type
Description
Required
matchId
String
The match identifier.
Yes
Response
Events Flow Schema V1.02
2.4 Retrieve Match Snapshot Data
Returns the GameSnapshot feed relevant to the match status in the Database. The same XMl schema will be delivered
regardless of match state (Pre-Match, Live, Post-Match). Any data that cannot be populated in each state will still
be represented by empty XML nodes or NULL attributes.
Method Invocation
REST Url
api/NRL/matchSnapshot/{matchId}
Parameter Name
Type
Description
Required
matchId
String
The match identifier.
Yes
Response
Game Snapshot Schema V1.01
2.5 Retrieve Form Guide (Version 2) for an upcoming match
Returns a Form Guide comprising previous match and head-to-head information for a specified match.
Method Invocation
REST Url
api/NRL/matchStats/FormGuideV2/{matchId}
Parameter Name
Type
Description
Required
matchId
String
The match identifier.
Yes
Response
Form Guide Schema V1.07
2.6 Retrieve Match XY Data
Returns the Match Referee feed relevant to the match status in the Database. The same XMl schema will be delivered
regardless of match state (Pre-Match, Live, Post-Match). Any data that cannot be populated in each state will still
be represented by empty XML nodes or NULL attributes.
Method Invocation
REST Url
api/NRL/LiveXY/{matchId}
Parameter Name
Type
Description
Required
matchId
String
The match identifier.
Yes
Response
Live Referee Schema V1.01
2.7 Retrieve Match Stats and Events combined
Returns the GameStats feed relevant to the match status in the Database along with the events. The same XMl schema will be delivered
regardless of match state (Pre-Match, Live, Post-Match). Any data that cannot be populated in each state will still
be represented by empty XML nodes or NULL attributes.
Method Invocation
REST Url
api/NRL/matchStatsAndEvents/{matchId}
Parameter Name
Type
Description
Required
matchId
String
The match identifier.
Yes
Response
Game Stats and Events Schema V1.10
2.8 Retrieve Match Score Flow
Returns a list of Scoring Events for a match, grouped by Team and Event types. Currently, only scoring events are captured
by this feed but additional event types can be captured in the same feed for future requirements.
Method Invocation
REST Url
api/NRL/matchStats/scoreFlow/{matchId}
Parameter Name
Type
Description
Required
matchId
String
The match identifier.
Yes
Response
Events Flow Schema V1.02
2.9 Retrieve List of Upcoming Match Milestones
Returns the Match Milestones for a given Match ID
Method Invocation
REST Url
api/NRL/matchStats/milestones/{matchId}
Parameter Name
Type
Description
Required
matchId
String
The match id.
Yes
Response
Match Milestones Schema V1.00
2.10 Retrieve List of Top Three Stats for an upcoming match
Returns the Match Top Three Stats for a given Match ID
Method Invocation
REST Url
api/NRL/matchStats/topThreeStats/{matchId}
Parameter Name
Type
Description
Required
matchId
String
The match id.
Yes
Response
Match Top Three Schema V1.00
3.1 Retrieve a competition/season/Round Schedule
Returns a list of Rounds/matches for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/competitions/roundFixtures/{competitionId}/{seasonId}/{roundNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
Identifier of the Series
Yes
seasonId
Integer
Identifier of the season
Yes
roundNumber
Integer
Identifier of the season
No
Response
Fixture Schema V1.07
3.2 Retrieve Ladder data By Round
Returns the current Ladder for a specified Competition/Season/Round. A null/missing Round returns the current ladder.
Method Invocation
REST Url
api/NRL/competitions/roundLadder/{competitionId}/{seasonId}/{roundNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition identifier.
Yes
seasonId
Integer
The season identifier.
Yes
roundNumber
Integer
The Round Number.
No
Response
Ladder Schema V1.04
3.3 Retrieve Competition/Season Historic statistics for team(s)
Returns team profiles and statistics for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/roundTeamStats/{competitionId}/{seasonId}/{roundNumber}/{teamId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season identifier.
Yes
roundNumber
Integer
The season identifier.
Yes
teamId
Integer
The team identifier.
No
Response
Team Stats Schema V1.07
3.4 Retrieve Competition/Season Historical statistics for player(s)
Returns player profiles and statsitics for a specified Competition and Season.
Method Invocation
REST Url
api/NRL/roundPlayerStats/{competitionId}/{seasonId}/{roundNumber}/{playerId}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition id.
Yes
seasonId
Integer
The season identifier.
Yes
roundNumber
Integer
The round identifier.
Yes
playerId
Integer
The player identifier.
No
Response
Player Stats Schema V1.05
4.1 Retrieve Match Data By Round breakdown
Returns the GameStats feed relevant to the match status in the Database. The same XMl schema will be delivered
regardless of match state (Pre-Match, Live, Post-Match). Any data that cannot be populated in each state will still
be represented by empty XML nodes or NULL attributes.
Method Invocation
REST Url
api/NRL/roundMatchStats/{competitionId}/{seasonId}/{roundNumber}/{gameNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition identifier.
Yes
seasonId
Integer
The season identifier.
Yes
roundNumber
Integer
The round number.
Yes
gameNumber
Integer
The game number.
Yes
Response
Game Stats Schema V1.10
4.2 Retrieve Form Guide for an upcoming match
Returns a Form Guide comprising previous match and head-to-head information for a specified match.
Method Invocation
REST Url
api/NRL/roundMatchStats/FormGuide/{competitionId}/{seasonId}/{roundNumber}/{gameNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition identifier.
Yes
seasonId
Integer
The season identifier.
Yes
roundNumber
Integer
The round number.
Yes
gameNumber
Integer
The game number.
Yes
Response
Form Guide Schema V1.07
4.3 Retrieve Match Events Flow by Round
Returns a list of Events for a match, grouped by Team and Event types. Currently, only scoring events are captured
by this feed but additional event types can be captured in the same feed for future requirements.
Method Invocation
REST Url
api/NRL/roundMatchstats/eventsFlow/{competitionId}/{seasonId}/{roundNumber}/{gameNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition identifier.
Yes
seasonId
Integer
The season identifier.
Yes
roundNumber
Integer
The round number.
Yes
gameNumber
Integer
The game number.
Yes
Response
Events Flow Schema V1.02
4.4 Retrieve Match Snapshot by Round
Returns the GameSnapshot feed relevant to the match status in the Database. The same XMl schema will be delivered
regardless of match state (Pre-Match, Live, Post-Match). Any data that cannot be populated in each state will still
be represented by empty XML nodes or NULL attributes.
Method Invocation
REST Url
api/NRL/roundMatchSnapshot/{competitionId}/{seasonId}/{roundNumber}/{gameNumber}
Parameter Name
Type
Description
Required
competitionId
Integer
The competition identifier.
Yes
seasonId
Integer
The season identifier.
Yes
roundNumber
Integer
The round number.
Yes
gameNumber
Integer
The game number.
Yes
Response
Game Snapshot Schema V1.01