State (leaderboard, scoreboard, hole-by-hole)

Overview

Use these endpoints to consume current golf state snapshots.

This section covers leaderboard and hole-by-hole resources.

REST returns the current snapshot for the requested resource.

WebSocket delivers the same resource inside a CloudEvents envelope.

REST state endpoints return the resource payload only.

WebSocket state endpoints wrap that payload in CloudEvents.

WebSocket state message format

Each WebSocket state message contains a CloudEvents envelope.

The resource-specific state snapshot is stored in data.payload.

Possible type values:

• Standings.Sport.Golf for leaderboard endpoints
• State.Statistics.Golf for hole-by-hole endpoints

WebSocket state message example

{
  "specversion": "1.0",
  "id": "0da2b5ba-b92f-42bd-b9d2-0fcd978fec85",
  "source": "/tournaments/1971",
  "type": "State.Statistics.Golf",
  "time": "2026-05-04T14:23:01.123Z",
  "tournamentid": 1971,
  "datacontenttype": "application/json",
  "data": {
    "id": "0da2b5ba-b92f-42bd-b9d2-0fcd978fec85",
    "created_at": "2026-04-24T11:09:15.267Z",
    "payload": {
      "...": "resource-specific state object"
    }
  }
}

State object fields

Name	Type	Description
specversion	String	CloudEvents specification version.
id	String (UUID)	Unique identifier of the WebSocket message.
source	String	Message source. Tournament-scoped state messages use /tournaments/{tournament_id}.
type	String	State message type, such as Standings.Sport.Golf or State.Statistics.Golf.
time	String (date-time)	Timestamp when the message was generated.
tournamentid	Integer	Tournament identifier.
datacontenttype	String	Content type of data, for example application/json.
data	Object	State message body.
data.id	String (UUID)	Identifier of the state object version.
data.created_at	String (date-time)	Timestamp when the state object version was created.
data.payload	Object	Resource payload returned by the specific leaderboard or hole-by-hole endpoint.

The structure of data.payload matches the resource page for the endpoint you consume.

Related pages

• Stroke Play leaderboard
• REST match play leaderboard
• Stroke Play hole-by-hole
• Match Play hole-by-hole