statshawk
ReferenceData modelShared primitives

Shared primitives

Cross-resource identifiers, countries, sources, and other small reusable values.

Small reusable values that appear across several resource groups, such as countries, upstream sources, and generic shared primitives.

BattedBallTrajectoryscalarSource-reported batted-ball trajectory classification.BoardContextunionSport-specific context attached by the read-side board enricher registry.CountryscalarISO 3166-1 alpha-3 (or FIFA/IOC) three-letter country code.DetailenumHow much of each pitch's Statcast surface to project onto the wire.HalfInningenumHalf inning: top (away batting) or bottom (home batting).HandednessCodescalarSource-reported handedness / side code, such as `R`, `L`, or `S`.HeightInchesscalarLineupSlotobjectOne batting-order slot on a [`MatchupCard`]'s lineup, fromPbpFiltersobjectThe filters actually applied to the read, echoed back for a caller thatPhasescalarScoring phase namespace (e.g. `batting`, `pitching`, `skater`, `goalie`).PitchCallCodescalarSource-reported compact pitch result/call code, such as MLB's `B`.PitchCallDescriptionscalarSource-reported pitch result/call label, such as MLB's `Ball`.PitcherRefobjectA probable starting pitcher on a [`MatchupCard`] — nullable end to endPitchTypeCodescalarSource-reported compact pitch type code, such as MLB's `FF`.PitchTypeNamescalarSource-reported pitch type label, such as MLB's `Four-Seam Fastball`.PitchViewobjectOne pitch, projected to the requested [`Detail`] tier. Fields beyond thePlateAppearanceViewobjectOne plate appearance, carrying its ordered, tier-projected pitches.PlayByPlayobjectThe full play-by-play read for a contest.PlayEventNamescalarSource-reported plate-appearance event label, such as MLB's `Single`.PlayEventTypescalarSource-reported plate-appearance event classification.ProjectionSourceenumA candidate's source: confirmed lineup slot or active-roster projection.PropAveragesobjectWindowed means of a stat's per-game values: the full in-scope windowPropHitRatesobjectWindowed [`HitRate`]s against the same `line`, one per [`PropAverages`]RoleenumA game-log role filter (spec Task 3): `role=pitcher` restores the legacySeasonStatsViewobjectSeedscalarSlotscalarSourceenumUpstream data provider an external mapping or sighting was learned from.StageSelectorscalarContest stage filter: `all`, or one of `preseason`/`regular`/`postseason`/`exhibition`/`allstar`. Omitted defaults to regular-season (plus unknown-stage) contests only.StatBoardobjectGeneric over-rate board for a competition slate.StatBoardEntryobjectOne ranked stat-board row.WeightLbsscalar