Leaderboard - Match Play

This endpoint is a live web socket endpoint that returns a list of every match in a Match Play Tournament and the current live score / result of this match.This is to be used in place of Leaderboard web socket for match play tournaments.The authentication token provided will be required to make a connection to this web socket endpoint.

Endpoint URL

wss://dde-streams.imggaming.com/media/golf/tournaments/{tournament ID}/matchplayleaderboard

Process for connecting the web socket endpoints

Same as Leaderboard​

Request parameters

Same as Leaderboard​​

Leaderboard - match play via RestAPI

Note that the matchplay leaderboard websockets is available via Rest - https://dde-api.data.imgarena.com/media/golf/tournaments/{EventID}}/matchplayleaderboard?rest=true​

Specifications

Match Play Leaderboard Object

Field Name	Type	Description	Possible Values	​
tournamentId	integer	Unique overall id of the Tournament	integer	​
timestamp	time stamp	Timestamp of message creation	time stamp	​
finished	boolean	checks if tournament status is official	boolean	​
seqNum	integer	Sequence number of the message	integer	​
currentRound	integer	Number of the current round. If tournament hasn’t started yet, this value will be 1	integer	​
tournamentStatus	string	Current status of the tournament	"NotStarted" "InProgress" "PlayComplete" "Official""PlaySuspended"	​
roundStatuses	array	see object docs	NA	​
matches	array	see object docs	NA	​
TournamentScores	object	see object docs	NA	YES

roundStatuses Object

Field Name	Type	Description	Possible Values
number	integer	Number of the round	integer
status	string	Enum value for Round Status	"GroupingsOfficial""InProgress""Maintenance""NotStarted""Official""PlayComplete""Suspended""Cancelled"

matches Object

Field Name	Type	Description	Possible Values	Optional
poolNo	integer	Number of the pool for the given match	integer	YES
courseId	Integer	Id of the Course for which the match will be played on	integer	​
matchNo	integer	The incremental number of the match throughout the TournamentN.B. each matchNo is unique per tournament	integer	​
poolMatchPosition	integer	Match position within the event	integer	YES
teams	array	see object docs below	NA	​
roundNo	integer	Incremental number of the Round	integer	​
roundName	string	Name of the round	see Categorical Fields​	​
matchStatus	string	Status of the match	"Not Started" "In Progress" "MatchComplete"	​
startHole	integer	Hole on which the match started; typically, either 1 or 10	integer	​
teeTime	time stamp	Match’s starting tee time with UTC offset	time stamp	​

teams Object

Field Name	Type	Description	Possible Values	Optional
players	array	see object docs	NA	​
finaMatchScore	string	The player’s final score in the match	see Categorical Fields​	​
matchLeader	integer	Indicator of whether or not player is leading in the given match	"1" or "0"	​