SGA‑OISOpen Interoperability Standard
1.0 Draft
SGA-OIS/Reference

Field catalog

Every dotted data name the standard defines: what it carries, in which units, and where it is specified. Filtering is instant and the URL keeps your query, so a link to a search is a link you can send somebody.

This is a dictionary, not a to-do list

Four fields make a launch monitor conformant. ball.speed_mps, ball.launch_angle_deg, ball.launch_direction_deg and ball.spin_rpm. A simulator needs five. An accessory can be one.

Everything else on this page exists so that a device which measures something unusual has a standard name for it — a pressure mat, a putting sensor, a moving lie platform. Send what you measure and omit the rest. Nothing here is required because it is listed, and no device is expected to implement a whole namespace.

Which fields does my device need? →

204 fields in the catalog

ball. How it left the face and where it went.#

The backspin component of the ball's spin.

rpm — revolutions per minute 06 §5 club and ball

Distance the ball flew before its first contact with the ground.

m — metres 06 §5 club and ball

Side movement perpendicular to the launch direction, as distinct from lateral offset measured against the target line.

m — metres 06 §5 club and ball

Angle at which the ball first returns to launch elevation, the same quantity as trajectory.descent_angle_deg.

deg — degrees 06 §5 club and ball

Vertical launch angle of the ball relative to the ground.

deg — degrees 06 §5 club and ball

Horizontal launch direction relative to the target line, positive to the right.

deg — degrees 06 §5 club and ball

Distance the ball traveled along the ground after landing.

m — metres 06 §5 club and ball

Lateral offset from the target line at the point of first landing, positive to the right.

m — metres 06 §5 club and ball

The sidespin component, carried only where a device measures the spin components directly.

rpm — revolutions per minute 06 §5 club and ball

Lateral offset from the target line where the ball came to rest, positive to the right.

m — metres 06 §5 club and ball

Ball speed divided by club head speed, a derived rather than measured quantity.

ratio — ratio, dimensionless 06 §5 club and ball

The physical specification of the ball that was struck — manufacturer, model, construction and condition.

06 §5.0 What the club and ball physically are

Ball speed immediately after impact.

mps — metres per second 06 §5 club and ball

Tilt of the ball's spin axis, positive tilted right; a geometric quantity, never a shot-shape label.

deg — degrees 06 §5 club and ball

Total spin rate of the ball off the face.

rpm — revolutions per minute 06 §5 club and ball

Which physical ball this is, from an embedded marker, carried verbatim. Nothing on the market reports it yet.

06 §5.0a The tag identifies the club; the specification can arrive later

Distance from the ball's start to where it came to rest, carry and roll together.

m — metres 06 §5 club and ball

club. What was swung, and what it was doing at impact.#

Vertical angle of the club head's approach into the ball, positive upward.

deg — degrees 06 §5 club and ball

How fast the club face was rotating through impact.

deg/s — degrees per second 06 §5 club and ball

Which club was used, carrying no confidence of its own — how it was determined lives in club.identification.

06 §5.1 How the club was identified

Lie angle actually delivered at impact, positive toe up.

deg — degrees 06 §5 club and ball

Loft actually delivered at impact, as opposed to the loft stamped on the club.

deg — degrees 06 §5 club and ball

Orientation of the club face at impact relative to the target line, positive open.

deg — degrees 06 §5 club and ball

Face angle relative to the swing path, positive when the face is open to the path. Carried directly because it is the strongest predictor of curvature.

deg — degrees 06 §5 club and ball

How club_id was arrived at — method, confidence, asserting participant and any disagreement between sources.

06 §5.1 How the club was identified

Where the club reached the bottom of its arc relative to the ball, positive meaning after the ball.

m — metres 06 §5 club and ball

Direction of the club head path through impact relative to the target line, positive in-to-out.

deg — degrees 06 §5 club and ball

The physical specification of the club that was swung — head, shaft and grip details as manufactured or fitted.

06 §5.0 What the club and ball physically are

Club head speed at the moment of impact specifically, for devices that distinguish it from peak speed.

mps — metres per second 06 §5 club and ball

Club head speed.

mps — metres per second 06 §5 club and ball

Angle between the dynamic loft and the angle of attack, which largely determines how much spin the impact generates.

deg — degrees 06 §5 club and ball

Impact position across the face from its center, positive toward the toe.

mm — millimetres 06 §5 club and ball

Impact position up the face from its center, positive above center.

mm — millimetres 06 §5 club and ball

Direction of the club head's travel through impact measured on the swing plane, positive in-to-out.

deg — degrees 06 §5 club and ball

Horizontal orientation of the swing plane.

deg — degrees 06 §5 club and ball

Vertical angle of the club head path relative to the ground, reported separately from the horizontal swing plane.

deg — degrees 06 §5 club and ball

Which PHYSICAL club this is — an RFID or NFC serial, or any other marking unique to the one club — carried verbatim and never parsed. The specification is resolved from it afterwards.

06 §5.0a The tag identifies the club; the specification can arrive later

The vendor's own opaque club identifier, passed through verbatim and unmapped.

06 §5.1 How the club was identified

origin. The state the shot started from.#

Distance from the ball to the pin at address.

m — metres 06 §3 origin — the state the shot started from

Elevation of the target relative to the ball, positive meaning the pin is above the player. Part of the state of the shot, not a modifier of it.

m — metres 06 §3 origin — the state the shot started from

Cross-slope of the lie, positive when the ground rises to the player's right regardless of handedness.

deg — degrees 06 §3 origin — the state the shot started from

Slope of the lie along the line of play, positive uphill toward the target.

deg — degrees 06 §3 origin — the state the shot started from

What the ball was sitting on before the stroke, from the registered surface vocabulary such as tee, fairway, rough, sand_bunker or green.

06 §3 origin — the state the shot started from

Absolute elevation of the ball's position in course coordinates, so origin and outcome elevations are directly comparable.

m — metres 06 §3 origin — the state the shot started from

Course-local coordinates of the ball before the stroke, where the simulator exposes them.

06 §3 origin — the state the shot started from

Flag that the player could not take a normal stance, recorded because it explains poor contact that would otherwise look like a bad swing.

06 §3 origin — the state the shot started from

outcome. Where it finished, and what it cost.#

Who added this stroke — the player, an operator or an official — since a human adjusting a score is exactly what an audit trail exists to capture.

06 §7 outcome

Whether this stroke entered the score. Everything is recorded; only some things count.

06 §7.1 Every stroke emits a record

Elevation of the resting position relative to the origin, positive meaning the ball finished above where it started.

m — metres 06 §7 outcome

Distance from the pin where the ball came to rest, which together with the origin distance is the whole of what a strokes-gained calculation needs.

m — metres 06 §7 outcome

Absolute elevation of the ball's resting position.

m — metres 06 §7 outcome

What the ball came to rest on, from the same registered surface vocabulary as origin.lie_surface.

06 §7 outcome

Course-local coordinates of where the ball came to rest.

06 §7 outcome

Whether the ball went in, which ends the hole regardless of what any other field says.

06 §7 outcome

Free text about the outcome for a human reader. Never parsed and never load-bearing.

06 §7 outcome

Why a penalty was assessed, coded so scoring and player rating can treat the categories differently.

06 §7 outcome

Penalty strokes added as a result of this stroke.

06 §7 outcome

For a drop, where the ball was before it was moved; the origin block carries where it was then played from.

06 §7 outcome

The coded rule under which a penalty or adjustment was applied.

06 §7 outcome

What kind of stroke this record represents. Kinds other than stroke, whiff, provisional, mulligan and practice involve no swing and carry no ball, club or trajectory data.

06 §7.1 Every stroke emits a record

How many strokes this record adds to the score, normally 1, allowing a conceded two-putt to be reported as one record adding 2.

06 §7.1 Every stroke emits a record

trajectory. The path between those two, as events.#

Peak height of the ball above the origin, not above the ground beneath it.

m — metres 06 §6 trajectory — the path, as events

Angle at which the ball came down, which determines how much a shot will stop.

deg — degrees 06 §6 trajectory — the path, as events

The ordered sequence of things that happened to the ball, whose minimum conformant form is launch, landing and rest.

06 §6 trajectory — the path, as events

Time from launch to first landing.

ms — milliseconds 06 §6 trajectory — the path, as events

Where the ball finished relative to where it started, which should agree with outcome.elevation_change_m.

m — metres 06 §6 trajectory — the path, as events

round. The round in progress: who is playing, whose turn, which hole.#

Engine-provided strokes received per slot for the course, tee set and format about to be played, with a completeness gate and the source of the numbers.

03 §3.4b Stroke allowances

Which hole is being played, as one object: number, par, length, and the course it belongs to. The engine spreads it across every shot record it composes.

03 §3.4 Who is playing, and who just played

Who is at the ball now, given as a slot and a display label. Provided by the simulator and requestable by any participant.

03 §3.4 Who is playing, and who just played

Who the engine attributed the last stroke to, so a device whose data completes late can still be attributed correctly after the group has rotated.

03 §3.4 Who is playing, and who just played

Every player in the round as slot, display label and optional check-in reference, supplied by the simulator so displays can name the group and a scanning member can pick which name is theirs.

03 §3.4 Who is playing, and who just played

What the simulator has in force for the round: its assists, each classified by what it does to the evidence, its conditions, course and swing inputs. Simulator-provided and standing; in an event the engine compares it with the rules package.

03 §3.4g Settings in force

player. The person at the ball.#

The handedness a launch monitor observed — which side of the ball armed, or the swing itself — and therefore measured rather than configured.

03 §3.4f Handedness, from the two places it is known

The handedness the simulator was configured for, which decides how the shot was rendered and where the ball was teed.

03 §3.4f Handedness, from the two places it is known

status. A participant reporting on its own condition.#

The launch monitor's own report that it can see the ball and record a stroke now.

03 §3.4e Ready for a stroke

The simulator's own report that the round can accept a stroke now.

03 §3.4e Ready for a stroke

bay. This installation: check-in, claim, and who has scanned in.#

The members who have scanned in at this bay and not yet left, each with an opaque check-in reference, display label and expiry. Published by the engine before any round exists.

03 §3.4a Check-in, before there is a round

The engine-minted check-in payload for this bay — QR payload, short code, expiry and whether it rotates — so a device with a screen can render it instead of sending players to a wall placard.

03 §3.4c Putting the check-in code on the screen

The payload an operator scans to claim this bay and vouch for its equipment. A different code for a different act from the check-in code, and the two must never be confused.

03 §2.0b A participant may only say what it declared

course. The course being played, by reference rather than by value.#

Opaque identifier for the course this stroke was played on.

06 §2 course — identity and version

Content hash of the course file, which is the course's real identity where name and version are only labels. It is what answers whether two bays are playing the same golf course.

02 §8.1 The hashes

True only when the engine computed the course hash itself; false means it is relaying the simulator's claim.

06 §2 course — identity and version

The single transform mapping this course file onto the real world — datum, epoch, the real-world location of local (0,0), the bearing of the local +y axis and the accuracy of the transform — declared once rather than repeated per position.

06 §12.1 Georeference the course, not every position

Length of this hole from the tees in play.

m — metres 06 §2 course — identity and version

Par for this hole as the course file states it.

06 §2 course — identity and version

Course name as the simulator presents it, a label for humans rather than an identity.

06 §2 course — identity and version

Where the hole was actually cut for this round, so two rounds on the same course file with different cuts can be told apart.

06 §12.5 course.pin_position

The facility's own human-readable label for the day's pin setup, a companion to pin_position and never a substitute for it.

06 §12.5 course.pin_position

Where the course file came from — the simulator's own library, a marketplace, a community pack.

06 §2 course — identity and version

Which tees were played, which sets both the yardage and the rating the score is judged against.

06 §2 course — identity and version

The vendor's own identifier for the course file, so support can name the same file the vendor names.

06 §2 course — identity and version

Course file version, since a layout can be revised without being renamed.

06 §2 course — identity and version

environment. The air the shot was played in — a game setting, or real weather outdoors.#

Course altitude the flight model used, which materially changes carry.

m — metres 06 §4 environment

Whether the environment values were a simulator setting or came from a real sensor, since a wind value that is a game setting and one that is the weather are not the same fact.

06 §4 environment

Ground firmness the simulator applied, on the standard coarse scale.

06 §4 environment

Green speed the simulator applied, on the stimpmeter scale.

stimp — stimpmeter feet 06 §4 environment

Relative humidity the flight model used.

pct — per cent 06 §4 environment

Barometric pressure the flight model used.

hpa — hectopascals 06 §4 environment

Air temperature the flight model used.

c — degrees Celsius 06 §4 environment

Bearing the simulated wind blows toward, 0 being north — not the meteorological from-convention.

deg — degrees 06 §4 environment

Peak gust the simulator applied, where its model varies the wind.

mps — metres per second 06 §4 environment

Wind speed the simulator applied to this shot.

mps — metres per second 06 §4 environment

ambient. The room, not the game: what was physically measured where the player stands.#

Air density measured in the bay, or derived from the measured pressure, temperature and humidity.

kg/m3 — kilograms per cubic metre 06 §4.1 ambient — the room, not the game

Altitude of the bay itself, as measured or configured, distinct from the course altitude the simulator applied.

m — metres 06 §4.1 ambient — the room, not the game

Temperature of the ball itself where a sensor reports it, since a cold ball travels measurably shorter.

c — degrees Celsius 06 §4.1 ambient — the room, not the game

Relative humidity physically measured in the bay.

pct — per cent 06 §4.1 ambient — the room, not the game

Light level measured in the bay, which is how a bay evidences the lighting a camera-based system declares it requires.

lux — lux 06 §4.1 ambient — the room, not the game

Identifier of the device that took the ambient measurements.

schema: shot-record, ambient block

Barometric pressure physically measured in the bay.

hpa — hectopascals 06 §4.1 ambient — the room, not the game

Air temperature physically measured where the player is standing, which is the field the ambient block exists for indoors.

c — degrees Celsius 06 §4.1 ambient — the room, not the game

Compass bearing the air measured in the bay is moving toward, 0 being north.

deg — degrees 06 §4.1 ambient — the room, not the game

Wind speed actually measured at the bay, for outdoor and hybrid play only; indoors it should be absent rather than zero.

mps — metres per second 06 §4.1 ambient — the room, not the game

conditions. What a competition requires a simulator to put in force.#

Course altitude the simulator's flight model must assume, fixed by the event rather than taken from the bay's location.

m — metres 08 §1 The Event Rules Package

Ground firmness the event requires, on the standard coarse scale.

08 §1 The Event Rules Package

Green speed the event requires, on the stimpmeter scale.

stimp — stimpmeter feet 08 §1 The Event Rules Package

Whether the event's playing conditions are fixed for the whole round or specified per hole.

08 §1 The Event Rules Package

The same condition keys nested under hole numbers, present when mode is per_hole.

08 §1 The Event Rules Package

Which pin placement set the event puts in force.

08 §2 Push is not enough

Barometric pressure the simulator's flight model must assume.

hpa — hectopascals 08 §1 The Event Rules Package

Air temperature the simulator's flight model must assume.

c — degrees Celsius 08 §1 The Event Rules Package

Compass bearing the event's wind blows toward, 0 being north.

deg — degrees 08 §1 The Event Rules Package

Wind speed the simulator must apply for the event.

mps — metres per second 08 §2 Push is not enough

How much the wind is permitted to vary during play, zero being a steady wind.

08 §1 The Event Rules Package

swing. The motion itself, where a device can see it.#

Body segment measurements captured at each named swing event.

schema: shot-record, swing block

The offset of each named moment of the swing — address, takeaway, top, transition, impact, finish — relative to impact, negative before it.

ms — milliseconds schema: shot-record, swing block

The order and timing in which body segments reached peak angular speed, and whether that order was proximal-to-distal.

schema: shot-record, swing block

The peak value of each body measurement across the swing, whenever it occurred.

schema: shot-record, swing block

Pointers to the sampled biomechanical traces for this swing, held on the bulk path rather than inlined in the latency-critical record.

schema: shot-record, swing block

Backswing time divided by downswing time.

ratio — ratio, dimensionless schema: shot-record, swing block

putt. The stroke on the green, which is a different measurement problem.#

Where the putter was aimed at address relative to the target line, distinct from face angle at impact.

deg — degrees schema: shot-record, putt block

Duration of the backswing, from takeaway to the top of the stroke.

ms — milliseconds schema: shot-record, putt block

Total side movement of the putt from its launch direction.

m — metres schema: shot-record, putt block

Green speed inferred from this putt's roll deceleration, distinct from the configured environment.green_speed_stimp.

stimp — stimpmeter feet schema: shot-record, putt block

How far past the hole the ball would have finished at its entry speed.

m — metres schema: shot-record, putt block

Ball speed at the hole.

mps — metres per second schema: shot-record, putt block

Duration of the forward stroke, from the top to impact.

ms — milliseconds schema: shot-record, putt block

Contact position across the putter face, positive toward the toe.

mm — millimetres schema: shot-record, putt block

Ball speed as it leaves the putter face.

mps — metres per second schema: shot-record, putt block

Angle of attack of the putter head, positive upward.

deg — degrees schema: shot-record, putt block

Putter face orientation at impact, positive open and pointing right of the target line.

deg — degrees schema: shot-record, putt block

Putter lie angle at impact, positive toe up.

deg — degrees schema: shot-record, putt block

Loft delivered at impact by the putter; negative means the ball was pressed into the green.

deg — degrees schema: shot-record, putt block

Path of the putter head through impact, positive in-to-out.

deg — degrees schema: shot-record, putt block

Launch angle of the ball off the putter face.

deg — degrees schema: shot-record, putt block

Share of the putt spent in true roll rather than skid.

pct — per cent schema: shot-record, putt block

Speed at which the ball begins rolling.

mps — metres per second schema: shot-record, putt block

Total putter face rotation through the stroke.

deg — degrees schema: shot-record, putt block

Distance the ball skids or bounces before true roll begins.

m — metres schema: shot-record, putt block

Slope across the putt's line, as a percentage grade.

pct — per cent schema: shot-record, putt block

Slope along the putt's line as a percentage grade, positive uphill toward the hole.

pct — per cent schema: shot-record, putt block

How much speed the ball lost before beginning true roll.

pct — per cent schema: shot-record, putt block

How far the putter was taken back.

m — metres schema: shot-record, putt block

Backswing time divided by forward swing time.

ratio — ratio, dimensionless schema: shot-record, putt block

Distance at which the ball begins true forward roll.

m — metres schema: shot-record, putt block

pressure. What the player did against the ground.#

Pressure measurements captured at each named swing event.

schema: shot-record, pressure block

Center of pressure along the target line, positive toward the target and zero at address.

m — metres schema: shot-record, pressure block

Share of the center of pressure carried on the lead foot.

pct — per cent schema: shot-record, pressure block

Center of pressure perpendicular to the target line, positive toward the ball.

m — metres schema: shot-record, pressure block

Share of the center of pressure carried on the trail foot.

pct — per cent schema: shot-record, pressure block

Peak horizontal ground reaction force, the one that drives rotation.

n — newtons schema: shot-record, pressure block

Pointer to the full pressure trace held on the bulk path, of which the pressure scalars are the summary.

schema: shot-record, pressure block

Width of the player's stance, measured between the feet.

m — metres schema: shot-record, pressure block

Peak torque applied against the ground.

nm — newton metres schema: shot-record, pressure block

Peak vertical force as a multiple of the player's body weight, which is the comparable form.

body weights — multiples of body weight schema: shot-record, pressure block

Peak vertical ground reaction force through the swing.

n — newtons schema: shot-record, pressure block

platform. A moving hitting surface: what it was asked for, and what it reached.#

Pitch the lie platform actually reached, as distinct from what it was asked for.

deg — degrees schema: shot-record, platform block

Pitch the simulator commanded the lie platform to, positive uphill toward the target.

deg — degrees schema: shot-record, platform block

Roll the lie platform actually reached, as distinct from what it was asked for.

deg — degrees schema: shot-record, platform block

Roll the simulator commanded the lie platform to, positive meaning the surface rises to the player's right.

deg — degrees schema: shot-record, platform block

Whether the platform reached its commanded state before the stroke.

schema: shot-record, platform block

The surface the hitting platform actually presented, from the registered lie-surface vocabulary.

schema: shot-record, platform block

The surface the simulator asked the hitting platform to present, from the registered lie-surface vocabulary.

schema: shot-record, platform block

identification. How the club in the player’s hands was worked out.#

The stated reliability of an imaged, marker or inferred club identification; a ui_selected club has no meaningful confidence.

06 §5.1 How the club was identified

The record that two sources named different clubs, carrying both values rather than resolving between them.

06 §5.1 How the club was identified

How the club in the player's hands was identified — RFID, marker, imaging, holder absence, impact inference, bag sequence or UI selection.

06 §5.1 How the club was identified

Whether the player was shown the detected club and accepted it.

06 §5.1 How the club was identified

Which participant asserted the club, often the simulator rather than the launch monitor.

06 §5.1 How the club was identified

identity. What a device says it is, at handshake.#

The device's signature over its identity, capability descriptor and the engine's session nonce together, which is what prevents a descriptor being forged or replayed from another session.

02 §8.3 The signatures

The strength of key custody the device claims, from unattested through software-held, device-held and hardware-rooted.

02 §8.3 The signatures

When the device was last calibrated.

schema: capability-descriptor, identity block

When the device's current calibration lapses.

schema: capability-descriptor, identity block

The device's own identifier within the bay. An identifier, never a credential.

schema: capability-descriptor, identity block

Firmware revision as the vendor names it; a device that omits it cannot be matched by a firmware-specific rule.

schema: capability-descriptor, identity block

Hash of the firmware build the device is actually running, which is what makes an approved-software-version requirement enforceable rather than self-reported.

02 §8.1 The hashes

Hardware revision, for vendors who ship more than one under a single model name.

schema: capability-descriptor, identity block

Model name of the device, which together with vendor is what deny rules, certificates and certified-model lists match on.

schema: capability-descriptor, identity block

Every sensing modality present on this unit, since real devices routinely combine radar, camera and infrared technologies.

guide: launch monitor

The unit's serial number. It travels to SGA for certification and audit, is not redistributed to other participants, and is what distinguishes two units that were given the same device id.

schema: capability-descriptor, identity block

Manufacturer name of the device.

schema: capability-descriptor, identity block

integrity. What the engine knows about how good this record is.#

Flag that the shot was queued against the previous player because the swing landed before any sample said the turn had moved.

schema: shot-record, integrity block

Flag that the contributing device was not bound to this bay when it sent the record, so the data lacks proof of where it came from.

schema: shot-record, integrity block

Whether every flight-critical contribution was in when the record was composed — a fact about the composition rather than about the ball.

06 §10.4 When the window closes

Flag that no launch monitor measured this stroke — it was entered, conceded or reconstructed — so it counts but is not evidence of how the ball was struck.

06 §7.1 Every stroke emits a record

The devices that were expected to contribute to this record and did not, named rather than merely counted.

06 §10.4 When the window closes

How the correlation window ended — complete, on a deadline, declined or forced — which distinguishes a record composed because everyone answered from one composed because the engine stopped waiting.

06 §10.4 When the window closes

model. The named model behind a calculated or inferred value.#

Vendor-namespaced name of the model that produced a calculated or inferred value. The model need not be published, but it must be named.

01 §2 Declaring provenance

Version of the named model, so a change in results across a season can be attributed to a model change rather than to a player.

01 §2 Declaring provenance

position. A point, in course-local coordinates.#

Radius within which the ball is actually expected to be, required in practice whenever the position's provenance is inferred.

m — metres 06 §12.3 Precision is not optional just because the fields are

The same point expressed in real-world coordinates with its datum, epoch, height reference and accuracy. Optional and additive: the local frame remains authoritative for everything the standard computes.

06 §12.2 position.world, and which end is authoritative

Course-local position across the target line, positive to the right of it.

m — metres schema: shot-record, position definition

Course-local position along the target line, positive toward the target.

m — metres schema: shot-record, position definition

Height above the reference surface.

m — metres schema: shot-record, position definition

sga. Reserved by the association.#

The pseudo-field a participant puts in its wants in order to receive notices, reusing the ordinary subscription model rather than a separate transport.

12 §3 Delivery reuses the subscription model
Simulated Golf Association · SGA-OIS · generated from the specification sources