Play By Play Shot Commentary
This endpoint returns play by play (PBP) shot commentary to be used for significant match play events such as the Ryder Cup as well as top stroke play events.
Endpoint URLs
Stroke Play:
https://dde-api.data.imgarena.com/golf/pbp_commentary/{tournamentId}/{holeNo}
Match Play:
https://dde-api.data.imgarena.com/golf/pbp_commentary_mp/{tournamentId}/{holeNo}
URL Sample:
https://dde-api.data.imgarena.com/golf/pbp_commentary/690/1
https://dde-api.data.imgarena.com/golf/pbp_commentary_mp/698/1
Required Headers
Key
Value
Accept
application/vnd.imggaming.dde.api+json;version=1
Content-Type
application/json
Authorization
Bearer eyvhaoudfgpdfgo*
*Authorization header includes a truncated Bearer token, contact IMG for your auth token if you do not have.
Request Parameters
This endpoint currently takes no additional parameters other than tournament Id and hole No, as stated above
Recommended Polling Limits
Our current polling request limit is: 1 request per 5 seconds per hole.
We therefore recommend and advise that polling is kept under that limit where possible.
The endpoints are per hole, so that's 18 endpoints to poll.
The other thing to consider is that any other requests being made will contribute to the overall request count.
Response Model
Shot Commentary Object
Field Name
Type
Description
distanceToPinYards
float
Distance in yards from the player's current ball position to the pin of the hole
groupNo
string
The group number of the player, shared with who they are playing their round with
holeNo
string
The current Hole Number the event took place on. Holes 1 - 18
latestStrokeNo
int
The nth shot/stroke on the current hole.
pbpCommentary
string
Generated text commentary relative to the shot in question and the surrounding situation of the player's shot
playerId
string
The internal ID of the Player of the current event
tournamentId
string
The unique Tournament ID of the current event
roundNumber
string
The current Round Number the event took place on. Usually would be 1 to 4
playerName
string
The first name and surname of the player
prevDistanceToPinYards
float
Distance in yards from the player's previous ball position from their previous shot to the pin of the hole
teamNumber
string
The player's Team Number for the current Tournament format
shotFromLocation
string
The description of the location on the hole from where the player took their most recent shot, e.g. rough, fairway, bunker, tee
shotToLocation
string
The description of the location on the hole from where the player's ball has landed after their most recent shot, e.g. rough, fairway, bunker, green
externalPlayerId
string
Match Play Only Field
The recognised external (Golf tour) player ID
rcTeam
string
Match Play Only Field
The Ryder Cup / Match Play Team. For Ryder Cup this will be either "U" or "E" USA or Europe
finishedGroup
Binary
1 = This group has just finished their round/session. 0 = This group has not finished their round/session.
latestPlayed
Binary
1 = This group was the last to play. 0 = This group was not the last to play.
nextToPlay
Binary
1 = This group is the next to play. 0 = This group is not the next to play.
timestamp
timestamp
The time stamp of this action.
Sample Response for Stroke Play
Sample Response 1 for Match Play (Ryder Cup)
Sample Response 2 for Match Play (Ryder Cup)
Last updated