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

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

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.

Last updated

Was this helpful?