For the complete documentation index, see llms.txt. This page is also available as Markdown.

Stroke Play Hole-by-hole

Overview

Use this endpoint to retrieve current stroke play hole-by-hole state.

The competitor can be a player or a team, depending on the tournament format.

  • All competitors: GET https://{domain}/golf/rest/v1/tournaments/{tournament_id}/stroke-play-team-hole-by-hole

  • One competitor: GET https://{domain}/golf/rest/v1/tournaments/{tournament_id}/stroke-play-team-hole-by-hole/{team_competitor_id}

Path parameters

  • tournament_id

    • type: integer

    • Tournament identifier.

    • example: 12345

  • team_competitor_id

    • type: integer, optional

    • Competitor identifier.

    • In team events, this value refers to the team rather than an individual player.

    • example: 2345

Response example

Field details

The REST response matches the payload used by the WebSocket version.

Stroke Play hole-by-hole - WebSocket Version

Use this endpoint to stream current stroke play hole-by-hole state.

The WebSocket message uses the state envelope.

The example below shows the data.payload object.

  • All competitors: wss://{domain}/golf/stream/v1/tournaments/{tournament_id}/stroke-play-team-hole-by-hole

  • One competitor: wss://{domain}/golf/stream/v1/tournaments/{tournament_id}/stroke-play-team-hole-by-hole/{team_competitor_id}

Path parameters

  • tournament_id

    • type: integer

    • Tournament identifier.

    • example: 12345

  • team_competitor_id

    • type: integer, optional

    • Competitor identifier.

    • In team events, this value refers to the team rather than an individual player.

    • example: 2345

Response example

For the full WebSocket envelope, see State (leaderboard, scoreboard, hole-by-hole).

Field details

field
type
details
required
IMGA equivalent

is_official

Boolean

Indicates whether the results/data are fully official

yes

isOfficial

playoff

Object

Aggregated results from the playoff phase.

no (optional)

playOffScore

playoff.holes[]

Array

Individual holes played during the playoff.

no

holes

playoff.holes[].hole_number

Integer

The number of the playoff hole.

yes (if playoff)

holeNo

playoff.holes[].hole_sequence

Integer

The playing order of the playoff hole.

yes (if playoff)

holeOrder

playoff.holes[].par

Integer

Par value for the playoff hole.

yes (if playoff)

holePar

playoff.holes[].score_to_par

Integer

Score relative to par for the playoff hole.

yes (if playoff)

holeScore

playoff.holes[].strokes

Integer

Strokes taken on the playoff hole.

yes (if playoff)

holeStrokes

playoff.holes[].hole_yardage

Integer

Length of the playoff hole in yards.

yes (if playoff)

holeYardage

playoff.par

Integer

Total par for the playoff holes.

yes (if playoff)

roundPar

playoff.strokes

Integer

Total strokes taken in the playoff.

yes (if playoff)

roundScore

playoff.score_to_par

Integer

Total playoff score relative to par.

yes (if playoff)

roundToPar

players[]

Array

List of player objects associated with this score

yes

players

players[].player_id

Integer

Numeric player ID

yes

id

players[].sr_player_id

String

SR format ID for the player

yes

-

players[].country

String

Three-letter country code (e.g., ENG)

yes

country

players[].display_name

String

Player's display name

yes

displayName

players[].first_name

String

Player's first name

yes

firstName

players[].last_name

String

Player's last name

yes

lastName

players[].is_amateur

Boolean

Indicates if the player is an amateur

yes

isAmateur

players[].gender

String

Player's gender (e.g., male)

yes

gender

round_scores

Map

Map containing scores grouped by round number

yes

roundScores

round_scores{round_number}.holes

Map

Scores for individual holes in this round

yes

holes

round_scores{round_number}.holes{hole_number}.hole_sequence

Integer

Playing order of the hole in this round

yes

holeOrder

round_scores{round_number}.holes{hole_number}.par

Integer

Par value for this hole

yes

holePar

round_scores{round_number}.holes{hole_number}.score_to_par

Integer

Score on this hole relative to par

yes

holeScore

round_scores{round_number}.holes{hole_number}.strokes

Integer

Number of strokes taken on this hole

yes

holeStrokes

round_scores{round_number}.holes{hole_number}.hole_yardage

Integer

Length of the hole in yards

yes

holeYardage

round_scores{round_number}.in_score

Object

Summary for Back 9 (holes 10–18)

yes

inScore

round_scores{round_number}.in_score.par

Integer

Total par for Back 9

yes

par

round_scores{round_number}.in_score.score_to_par

Integer

Score relative to par for Back 9

yes

score

round_scores{round_number}.in_score.strokes

Integer

Total strokes for Back 9

yes

strokes

round_scores{round_number}.in_score.yardage

Integer

Total yardage for Back 9

yes

yardage

round_scores{round_number}.out_score

Object

Summary for Front 9 (holes 1–9)

yes

outScore

round_scores{round_number}.out_score.par

Integer

Total par for Front 9

yes

par

round_scores{round_number}.out_score.score_to_par

Integer

Score relative to par for Front 9

yes

score

round_scores{round_number}.out_score.strokes

Integer

Total strokes for Front 9

yes

strokes

round_scores{round_number}.out_score.yardage

Integer

Total yardage for Front 9

yes

yardage

round_scores{round_number}.par

Integer

Total par for the round (usually 70–72)

yes

roundPar

round_scores{round_number}.strokes

Integer

Total strokes in the round

yes

roundScore

round_scores{round_number}.score_to_par

Integer

Round score relative to par

yes

roundToPar

scoring_format

String

The scoring format used (e.g., "single")

yes

scoringFormat

competitor_id

Integer

Numeric ID of the player or team

yes

teamNo

sr_competitor_id

String

SR format ID of the player or team

yes

-

tournament_id

Integer

Numeric ID of the tournament

yes

tournamentId

timestamp

String (date-time)

Time when the hole-by-hole snapshot was generated

yes

timestamp

sr_tournament_id

String

SR format ID of the tournament

yes

-

Last updated

Was this helpful?