Response envelope
List endpoints return:| Field | Description |
|---|---|
data | The page of records. |
_meta.generatedAt | Server timestamp the response was produced. |
_meta.url | The canonical request URL. |
_meta.offset / _meta.limit | Pagination state for this page. |
_meta.totalRecords | Total records matching the request, across all pages. |
_links | Pagination links (e.g. next, prev) when applicable. |
/players/{id}, etc.) return the record under data with the same _meta wrapper.
Pagination
Two query parameters drive pagination on every list endpoint:| Parameter | Default | Max | Description |
|---|---|---|---|
offset | 0 | — | Number of records to skip before returning results. |
limit | 100 | 1000 | Number of records to return on this page. |
_meta.totalRecords and _links.next to walk through a list.
Sorting
Thesort parameter accepts one or more field names. Prefix a field with - to sort descending.
Filtering
Filters are passed as query parameters. The available filters vary per endpoint and are listed in the reference.Operators
Some numeric filters support comparison operators via a colon suffix:| Suffix | Meaning |
|---|---|
:gt | Greater than |
:gte | Greater than or equal |
:lt | Less than |
:lte | Less than or equal |
Field selection
Use thefields parameter to request a subset of fields. This reduces payload size and is recommended when you only need a few attributes.
Default and available fields
Each endpoint defines a default field set returned whenfields is omitted, and a wider set you can opt into. Available fields can depend on your subscription — the endpoint reference lists everything. Requesting an unknown or unavailable field returns 400 Bad Request.
Identifiers and slugs
- Numeric IDs identify players (
/players/{id}), teams, games, transfers, arenas, agencies, etc. - Slugs identify leagues, countries, draft types, and award types — e.g.
/leagues/nhl,/countries/swe,/draft-types/nhl-entry-draft. - Country codes follow ISO 3166-1 alpha-3 (e.g.
SWE,USA,FIN).
Dates and timestamps
All timestamps in responses are ISO 8601. Server time is Europe/Stockholm; timestamps are emitted with explicit timezone offsets.Caching
The API ships responses with HTTP cache headers. Most data is updated within minutes of changes at the source. For high-volume integrations, respectCache-Control and conditional requests where present.