ReferenceData model
Data model
Every object the API returns, grouped and explorable. Generated from the OpenAPI spec.
This is the full set of schemas the Statshawk API serves — every object that can appear in a response, with its fields, types, and descriptions. It is generated from the same OpenAPI spec that powers the REST API reference, so it stays in lockstep with the live API.
How to read a model
- Every successful response is wrapped in the envelope
{ data, meta }; errors return{ error }. Start with Envelope & meta to see those wrappers, then followdatainto the concrete types. - A field whose type is another model is a link — click it to jump to that model's full entry, or expand the field in place to see one level of its fields.
- Polymorphic fields (e.g. sport-specific stat lines) show a selector table — the
payload is one of several shapes, picked by sport or by a discriminator field
like
role. The table maps each key to the model you'll get. - Each model page ends with a Used by list — the wrappers and fields that point at it, so you can see where a type plugs in.
optionalfields may be absent ornull; everything else is always present.
Groups
| Group | What's in it |
|---|---|
| Envelope & meta | Response/error wrappers, meta, and cache status. |
| Persons | Person profiles, appearances, memberships, and person game logs. |
| Teams | Team profiles, rosters, game logs, standings rows, and team traits. |
| Competitions & editions | Competitions, editions/seasons, capability discovery, and event summaries. |
| Contests & box scores | Contest summaries, match projections, entrants, results, box scores, and scores. |
| Per-sport stat lines | Sport-specific player/team season and game stat lines. |
| Analysis cards | Player-prop cards, hit rates, and team comparison shapes. |
| Shared primitives | Small reusable values shared across resource groups. |
Prefer the raw spec? It's at /api-docs/openapi.json,
and every endpoint page has a live playground.