Documentation / Guides
Officials, rinks and game context
Referees and linesmen across leagues, the rinks games are played in, and what surrounds each game.Officials
Every referee and linesman named in a box score is a person of their own, with an official_id (of_) that stays the same across games, seasons and leagues.
- Who worked a game:
GET /v1/games/{game_id}/officials. - One official:
GET /v1/officials/{official_id}, with the games worked as referee and as linesman, the first and last game, and the leagues worked most. - Every game an official worked, newest first, with the role:
/v1/officials/{official_id}/games.
Rinks
A game carries its rink (venue, with vn_ id, name, city and country) and its crowd (attendance) where they are known. Each league's coverage_detail on /v1/leagues/{league_id} says how often.
- Find a rink:
GET /v1/venues?q=, or bycountry. - One rink, with the teams that have played home games there:
GET /v1/venues/{venue_id}. - Its games, newest first:
/v1/venues/{venue_id}/games.
Game context
GET /v1/games/{game_id}/context gives everything around a game in one call, upcoming games included:
- the rink with its city and country;
- the start in UTC and in the rink's own time zone;
- for each side, the days of rest, whether it is the second game of a back to back, its games in the last 7 days and its home or road run;
- for the away side, the city it came from;
- where the game has a line-up, each side's regulars who are not dressed.
Weather and ice conditions are always null: the game is played indoors, and no open source records the ice.