Structs§
- Assist
Summary - Assist summary information
- Award
- Award won by player
- Award
Season - Season when award was won
- Boxscore
- Boxscore response with detailed game and player statistics
- Boxscore
Team - Team information in boxscore
- Career
Totals - Career totals for regular season and playoffs
- Client
- Client
Config - Club
Goalie Stats - Goalie season statistics for a team
- Club
Skater Stats - Skater season statistics for a team
- Club
Stats - Club statistics response containing skater and goalie stats
- Conference
- Conference information for a team
- Daily
Schedule - Daily schedule response
- Daily
Scores - Game scores for a day
- Division
- Division information for a team
- Draft
Details - Draft details for a player
- Featured
Stats - Featured stats shown prominently on player page
- Franchise
- Franchise information
- Franchises
Response - Response from the franchises endpoint
- Game
Clock - Game clock information
- GameDay
- A day of games
- GameId
- A unique NHL game identifier
- GameLog
- Game log entry for a single game
- Game
Matchup - Game matchup/landing response
- Game
Outcome - Game outcome information
- Game
Score - Individual game score
- Game
Situation - Parsed game situation from situation code
- Game
Story - Game story
- Game
Summary - Game summary with scoring and penalties
- Goal
Summary - Goal summary information
- Goalie
Stats - Goalie statistics
- Localized
String - Localized string (NHL API returns {default: “value”})
- Matchup
Team - Team information in game matchup
- Parse
Defending Side Error - Error type for parsing DefendingSide from string
- Parse
Game Schedule State Error - Error type for parsing GameScheduleState from string
- Parse
Game State Error - Error type for parsing GameState from string
- Parse
Goalie Decision Error - Error type for parsing GoalieDecision from string
- Parse
Handedness Error - Error type for parsing Handedness from string
- Parse
Home Road Error - Error type for parsing HomeRoad from string
- Parse
Period Type Error - Error type for parsing PeriodType from string
- Parse
Position Error - Error type for parsing Position from string
- Parse
Zone Code Error - Error type for parsing ZoneCode from string
- Penalty
Player - Player information in penalty summary
- Penalty
Summary - Penalty summary information
- Period
Descriptor - Period descriptor with game period information
- Period
Penalties - Penalty summary for a period
- Period
Scoring - Scoring summary for a period
- Play
ByPlay - Play by play response with all game events
- Play
Event - Individual play event in the game
- Play
Event Details - Details for a play event (varies by event type)
- Player
ByGame Stats - Player statistics organized by team
- Player
Game Log - Player game log response
- Player
Landing - Player landing page data - comprehensive player profile
- Player
Search Result - Player search result
- Player
Stats - Player statistics (skater or goalie)
- Roster
- Team roster information Team roster with players by position
- Roster
Player - Individual player in a team roster
- Roster
Spot - Roster spot with player information
- Schedule
Game - Schedule game information
- Schedule
Team - Team information in schedule
- Scratched
Player - Scratched player information
- Season
- A season identifier (e.g., 20232024 for the 2023-2024 season)
- Season
Game Types - Season game type availability for a team
- Season
Info - Season manifest entry
- Season
Series Matchup - Season series matchup
- Season
Total - Season-by-season statistics
- Seasons
Response - Seasons manifest response
- Series
Game - Individual game in the season series
- Series
Game Info - Game information including officials and scratches
- Series
Team - Team information in season series
- Series
Wins - Season series win counts
- Shift
Chart - Shift chart data
- Shift
Entry - Individual shift entry for a player
- Shootout
Attempt - Shootout attempt information
- Skater
Stats - Skater (forward/defense) statistics
- Special
Event - Special event information
- Standing
- Standing entry for a team
- Standings
Response - Standings response
- Story
Team - Team information in game story
- Team
- NHL Team information
- Team
Game Info - Team-specific game information
- Team
Game Stats - Aggregated team statistics for game comparison
- Team
Player Stats - Team’s player statistics grouped by position
- Team
Schedule Response - Team schedule response (monthly/weekly)
- Three
Star - Three stars selection
- TvBroadcast
- TV broadcast information
- Weekly
Schedule Response - Weekly schedule response
Enums§
- Defending
Side - Which side of the ice the home team is defending
- Game
Date - A date wrapper for NHL API calls that can be “now” or a specific date
- Game
Schedule State - Game schedule state (OK, postponed, etc.)
- Game
State - NHL game state representing the current status of a game
- Game
Type - NHL Game Type
- Goalie
Decision - Goalie game decision (win/loss/OT loss)
- Handedness
- NHL player handedness (shoots/catches)
- Home
Road - Home or road game indicator
- NHLApi
Error - Period
Type - NHL period type
- Play
Event Type - Type of play event in a game
- Position
- NHL player position
- Zone
Code - Ice zone where play event occurred