Match Play Leaderboard
Overview
Use this endpoint to retrieve the current match play leaderboard.
It includes match-level standings and tournament score by squad.
URL: GET https://{domain}/golf/rest/v1/tournaments/{tournament_id}/match-play-leaderboard
Path parameters
tournament_idtype: integer
Tournament identifier.
example:
12345
Response example
Field details
The REST response matches the payload used by the WebSocket version.
WebSocket version
Use this endpoint to stream the current match play leaderboard.
The WebSocket message uses the state envelope.
The example below shows the data.payload object.
URL: wss://{domain}/golf/stream/v1/tournaments/{tournament_id}/match-play-leaderboard
Path parameters
tournament_idtype: integer
Tournament identifier.
example:
12345
Response example
For the full WebSocket envelope, see State (leaderboard, scoreboard, hole-by-hole).
Field details
tournament_id
Integer
Unique tournament identifier
yes
tournamentId
sr_tournament_id
String
SR format tournament ID
yes
-
tournament_status
String
Tournament status (e.g., IN_PROGRESS, ENDED)
yes
tournamentStatus
current_round
Integer
Current round number
yes
currentRound
timestamp
DateTime
Timestamp when feed was generated
yes
timestamp
round_statuses[]
Array
List of round status objects
yes
roundStatuses
round_statuses[].round_number
Integer
Round number
yes
number
round_statuses[].status
String
Round status
yes
status
matches[]
Array
List of matches
yes
matches
matches[].match_id
Integer
Match unique ID
yes
matchNo
matches[].sr_match_id
String
SR format match ID
no
-
matches[].course_id
Integer
Course ID
yes
courseId
matches[].sr_course_id
String
SR format course ID
no
-
matches[].round_number
Integer
Round number of match
yes
roundNo
matches[].round_name
String
Round name (e.g., Friday Foursomes)
yes
roundName
matches[].match_status
String
Match status (IN_PROGRESS, ENDED, NOT_STARTED)
yes
matchStatus
matches[].start_hole
Integer
Starting hole
yes
startHole
matches[].tee_time
DateTime
Tee time of match
yes
teeTime
matches[].teams[]
Array
Teams in match
yes
teams
matches[].teams[].team_id
Integer
Match-level team ID
yes
teamNo
matches[].teams[].sr_team_id
String
SR format team ID
no
-
matches[].teams[].squad_id
Integer
Tournament squad ID
yes
squadNo
matches[].teams[].sr_squad_id
String
SR format squad ID
no
-
matches[].teams[].players[]
Array
Players in the team
yes
players
matches[].teams[].players[].player_id
Integer
Player ID
yes
id
matches[].teams[].players[].sr_player_id
String
SR format player ID
no
-
matches[].teams[].players[].country
String
Country (ISO-3)
yes
country
matches[].teams[].players[].display_name
String
Player display name
yes
-
matches[].teams[].players[].first_name
String
First name
yes
firstName
matches[].teams[].players[].last_name
String
Last name
yes
lastName
matches[].teams[].players[].is_amateur
Boolean
Amateur flag
yes
-
matches[].teams[].players[].gender
String
Gender
yes
-
matches[].teams[].score
Integer
Current match play score (lead, e.g., +3 / -3)
yes
currentMatchScore
matches[].teams[].holes_through
Integer
Number of holes completed
yes
thru
matches[].teams[].is_leader
Boolean
Indicates if team is leading
yes
matchLeader
matches[].teams[].is_winner
Boolean
Indicates if team won match
yes
matchWinner
matches[].teams[].is_tied
Boolean
Indicates if match is tied
yes
isTied
tournament_score[]
Array
Overall tournament score per squad
yes
tournamentScores
tournament_score[].squad_name
String
Squad name (USA, Europe)
yes
squadName
tournament_score[].squad_id
Integer
Squad ID
yes
squadNo
tournament_score[].sr_squad_id
String
SR format squad ID
no
-
tournament_score[].is_host
Boolean
Host indicator
yes
host
tournament_score[].score
Decimal
Current points total
yes
score
Last updated
Was this helpful?