The Official Unofficial .NET NHL API 🏒

A modern C# .NET library for the NHL API providing various NHL information about players, games, teams, conferences, divisions, statistics and more

Table of Contents 📚

• Installation 💭 Installing Nhl.Api
• Implementation 🚀 Implementation
• Documentation 📖 Documentation
• Bugs 🐛 Bugs
• Feature Backlog 📈 Feature Backlog
• Notable Mentions 🙏 Notable Mentions
• Contents 📋 Contents

Installing Nhl.Api 💭

You should install Nhl.Api with NuGet:

Install-Package Nhl.Api

Or via the .NET Core command line interface:

dotnet add package Nhl.Api

Either commands, from Package Manager Console or .NET Core CLI, will download and install all required dependencies.

Implementation 🚀

If you are using any type of a inversion of control or dependency injection library such as the built in library within .NET Core, Unity, or AutoFac. It's very simple to implement, or you can create an instance of the NhlApi class and use the API as you would like.

If you are using the built-in .NET Core dependency injection library, there is a NuGet package to easily add the Nhl.Api to your .NET application, Nhl.Api.Extensions.Microsoft.DependencyInjection this extension, it's highly recommended.

Nhl.Api.Extensions.Microsoft.DependencyInjection

builder.Services.AddNhlApi();

.NET

builder.Services.AddSingleton<INhlApi, NhlApi>();

Unity

container.RegisterType<INhlApi, NhlApi>();

AutoFac

builder.RegisterType<NhlApi>().As<INhlApi>();

Simple Object Instantiation

var nhlApi = new NhlApi();

You can also use a subset of the Nhl.Api for specific data within the Nhl.Api, such as only game data, player data, statistics or league information.
These individual API's make up the Nhl.Api in it's entirety.
If you are using the Nhl.Api.Extensions.Microsoft.DependencyInjection NuGet, these API's are included automatically within your .NET Core project.

Documentation 📖

Once registered using your dependency injection library of choice or just using the simple instance of the NHL API. Explore the API and see the all the possibilities.

Nhl Player Api

.NET

builder.Services.AddSingleton<INhlPlayerApi, NhlPlayerApi>();

Unity

container.RegisterType<INhlPlayerApi, NhlPlayerApi>();

AutoFac

builder.RegisterType<NhlPlayerApi>().As<INhlPlayerApi>();

Simple Object Instantiation

var nhlPlayerApi = new NhlPlayerApi();

Nhl Game Api

.NET

builder.Services.AddSingleton<INhlGameApi, NhlGameApi>();

Unity

container.RegisterType<INhlGameApi, NhlGameApi>();

AutoFac

builder.RegisterType<NhlGameApi>().As<INhlGameApi>();

Simple Object Instantiation

var nhlGameApi = new NhlGameApi();

Nhl Statistics Api

.NET

builder.Services.AddSingleton<INhlStatisticsApi, NhlStatisticsApi>();

Unity

container.RegisterType<INhlStatisticsApi, NhlStatisticsApi>();

AutoFac

builder.RegisterType<NhlStatisticsApi>().As<INhlStatisticsApi>();

Simple Object Instantiation

var nhlStatisticsApi = new NhlStatisticsApi();

Nhl League Api

.NET

builder.Services.AddSingleton<INhlLeagueApi, NhlLeagueApi>();

Unity

container.RegisterType<INhlLeagueApi, NhlLeagueApi>();

AutoFac

builder.RegisterType<NhlLeagueApi>().As<INhlLeagueApi>();

Simple Object Instantiation

var nhlLeagueApi = new NhlLeagueApi();

Bugs 🐛

If you have any issues with the library or suggestions, please feel free to create an issue and it will be adressed as soon as possible :)

Feature Backlog 📈

Currently there are no features in the backlog, but if you have any suggestions, please feel free to create an issue and it will be adressed as soon as possible :)

Notable Mentions 🙏

Thank you to all the people in the hockey community, especially:

• Drew Hynes for providing the leading guidance for the all of the NHL stat heads for having the new API documented for usage, without him this would not be possible.
• Zachary Maludzinski to contributed to documenting the NHL Web API. Without all this help, and documentation one of this would be possible.
• NHL for providing the API for the community to use to build awesome stuff.

Contents 📋

• NhlApi
  • #ctor()
  • Dispose()
  • DisposeAsync()
  • GetAllPlayersAsync(cancellationToken)
  • GetAllRosterSeasonsByTeamAsync(teamId,cancellationToken)
  • GetAllRosterSeasonsByTeamAsync(team,cancellationToken)
  • GetAllSeasonsAsync()
  • GetAllTotalPlayerStatisticValueBySeasonAsync(playerId,seasonYear,cancellationToken)
  • GetAllTotalPlayerStatisticValueBySeasonAsync(playerEnum,seasonYear,cancellationToken)
  • GetCurrentTeamScoreboardAsync(teamId,cancellationToken)
  • GetCurrentTeamScoreboardAsync(team,cancellationToken)
  • GetGameCenterBoxScoreByGameIdAsync(gameId,cancellationToken)
  • GetGameCenterLandingByGameIdAsync(gameId,cancellationToken)
  • GetGameCenterPlayByPlayByGameIdAsync(gameId,cancellationToken)
  • GetGameMetadataByGameIdAsync(gameId,cancellationToken)
  • GetGameScoreboardAsync(cancellationToken)
  • GetGameScoresByDateAsync(date,cancellationToken)
  • GetGoalieInformationAsync(playerId,cancellationToken)
  • GetGoalieInformationAsync(player,cancellationToken)
  • GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken)
  • GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken)
  • GetGoalieStatisticsLeadersAsync(goalieStatisticsType,seasonYear,gameType,limit,cancellationToken)
  • GetLeagueGameWeekScheduleByDateAsync(date,cancellationToken)
  • GetLeagueMetadataInformationAsync(playerIds,teamIds,cancellationToken)
  • GetLeagueMetadataInformationAsync(players,teams,cancellationToken)
  • GetLeagueScheduleCalendarByDateAsync(date,cancellationToken)
  • GetLeagueStandingsByDateAsync(date,cancellationToken)
  • GetLeagueStandingsSeasonInformationAsync(cancellationToken)
  • GetLeagueWeekScheduleByDateAsync(date,cancellationToken)
  • GetLiveGameFeedPlayerShiftsAsync(gameId,cancellationToken)
  • GetPlayerHeadshotImageAsync(player,playerHeadshotImageSize,cancellationToken)
  • GetPlayerHeadshotImageAsync(playerId,playerHeadshotImageSize,cancellationToken)
  • GetPlayerInformationAsync(playerId,cancellationToken)
  • GetPlayerInformationAsync(player,cancellationToken)
  • GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken)
  • GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken)
  • GetPlayerSpotlightAsync(cancellationToken)
  • GetSkaterStatisticsLeadersAsync(playerStatisticsType,seasonYear,gameType,limit,cancellationToken)
  • GetSourcesToWatchGamesAsync(cancellationToken)
  • GetTeamColorsAsync(team,cancellationToken)
  • GetTeamColorsAsync(teamId,cancellationToken)
  • GetTeamLogoAsync(teamId,teamLogoType,cancellationToken)
  • GetTeamLogoAsync(team,teamLogoType,cancellationToken)
  • GetTeamProspectsByTeamAsync(teamId,cancellationToken)
  • GetTeamProspectsByTeamAsync(team,cancellationToken)
  • GetTeamRosterBySeasonYearAsync(teamId,seasonYear,cancellationToken)
  • GetTeamRosterBySeasonYearAsync(team,seasonYear,cancellationToken)
  • GetTeamScheduleBySeasonAsync(teamAbbreviation,seasonYear,cancellationToken)
  • GetTeamSeasonScheduleBySeasonYearAsync(teamId,seasonYear,cancellationToken)
  • GetTeamSeasonScheduleBySeasonYearAsync(team,seasonYear,cancellationToken)
  • GetTeamSeasonScheduleByYearAndMonthAsync(teamId,year,month,cancellationToken)
  • GetTeamSeasonScheduleByYearAndMonthAsync(team,year,month,cancellationToken)
  • GetTeamStatisticsBySeasonAndGameTypeAsync(team,seasonYear,gameType,cancellationToken)
  • GetTeamStatisticsBySeasonAndGameTypeAsync(teamId,seasonYear,gameType,cancellationToken)
  • GetTeamStatisticsBySeasonAsync(team,cancellationToken)
  • GetTeamStatisticsBySeasonAsync(teamId,cancellationToken)
  • GetTeamWeekScheduleByDateAsync(teamAbbreviation,date,cancellationToken)
  • GetTeamWeekScheduleByDateAsync(teamId,date,cancellationToken)
  • GetTeamWeekScheduleByDateAsync(team,date,cancellationToken)
  • GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerEnum,playerGameCenterStatistic,seasonYear,cancellationToken)
  • GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerId,playerGameCenterStatistic,seasonYear,cancellationToken)
  • GetTvScheduleBroadcastByDateAsync(date,cancellationToken)
  • IsLeagueActiveAsync()
  • IsPlayoffSeasonActiveAsync(cancellationToken)
  • IsPreSeasonActiveAsync(cancellationToken)
  • IsRegularSeasonActiveAsync(cancellationToken)
  • SearchAllActivePlayersAsync(query,limit,cancellationToken)
  • SearchAllPlayersAsync(query,limit,cancellationToken)
• NhlGameApi
  • #ctor()
  • GetCurrentTeamScoreboardAsync(team,cancellationToken)
  • GetCurrentTeamScoreboardAsync(teamId,cancellationToken)
  • GetGameCenterBoxScoreByGameIdAsync(gameId,cancellationToken)
  • GetGameCenterLandingByGameIdAsync(gameId,cancellationToken)
  • GetGameCenterPlayByPlayByGameIdAsync(gameId,cancellationToken)
  • GetGameMetadataByGameIdAsync(gameId,cancellationToken)
  • GetGameScoreboardAsync(cancellationToken)
  • GetGameScoresByDateAsync(date,cancellationToken)
  • GetLiveGameFeedPlayerShiftsAsync(gameId,cancellationToken)
  • GetTeamSeasonScheduleBySeasonYearAsync(teamId,seasonYear,cancellationToken)
  • GetTeamSeasonScheduleBySeasonYearAsync(team,seasonYear,cancellationToken)
  • GetTeamSeasonScheduleByYearAndMonthAsync(teamId,year,month,cancellationToken)
  • GetTeamSeasonScheduleByYearAndMonthAsync(team,year,month,cancellationToken)
  • GetTeamWeekScheduleByDateAsync(teamId,date,cancellationToken)
  • GetTeamWeekScheduleByDateAsync(team,date,cancellationToken)
• NhlLeagueApi
  • #ctor()
  • GetAllRosterSeasonsByTeamAsync(teamId,cancellationToken)
  • GetAllRosterSeasonsByTeamAsync(team,cancellationToken)
  • GetAllSeasonsAsync(cancellationToken)
  • GetLeagueGameWeekScheduleByDateAsync(date,cancellationToken)
  • GetLeagueMetadataInformationAsync(playerIds,teamIds,cancellationToken)
  • GetLeagueMetadataInformationAsync(players,teams,cancellationToken)
  • GetLeagueScheduleCalendarByDateAsync(date,cancellationToken)
  • GetLeagueStandingsByDateAsync(date,cancellationToken)
  • GetLeagueStandingsSeasonInformationAsync(cancellationToken)
  • GetLeagueWeekScheduleByDateAsync(date,cancellationToken)
  • GetSourcesToWatchGamesAsync(cancellationToken)
  • GetTeamColorsAsync(team,cancellationToken)
  • GetTeamColorsAsync(teamId,cancellationToken)
  • GetTeamLogoAsync(team,teamLogoType,cancellationToken)
  • GetTeamLogoAsync(teamId,teamLogoType,cancellationToken)
  • GetTeamProspectsByTeamAsync(teamId,cancellationToken)
  • GetTeamProspectsByTeamAsync(team,cancellationToken)
  • GetTeamRosterBySeasonYearAsync(teamId,seasonYear,cancellationToken)
  • GetTeamRosterBySeasonYearAsync(team,seasonYear,cancellationToken)
  • GetTeamScheduleBySeasonAsync(teamAbbreviation,seasonYear,cancellationToken)
  • GetTeamWeekScheduleByDateAsync(teamAbbreviation,date,cancellationToken)
  • GetTvScheduleBroadcastByDateAsync(date,cancellationToken)
  • IsLeagueActiveAsync(cancellationToken)
  • IsPlayoffSeasonActiveAsync(cancellationToken)
  • IsPreSeasonActiveAsync(cancellationToken)
  • IsRegularSeasonActiveAsync(cancellationToken)
• NhlPlayerApi
  • #ctor()
  • Dispose()
  • GetAllPlayersAsync(cancellationToken)
  • GetGoalieInformationAsync(playerId,cancellationToken)
  • GetGoalieInformationAsync(player,cancellationToken)
  • GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken)
  • GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken)
  • GetPlayerHeadshotImageAsync(player,playerHeadshotImageSize,cancellationToken)
  • GetPlayerHeadshotImageAsync(playerId,playerHeadshotImageSize,cancellationToken)
  • GetPlayerInformationAsync(playerId,cancellationToken)
  • GetPlayerInformationAsync(player,cancellationToken)
  • GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken)
  • GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken)
  • GetPlayerSpotlightAsync(cancellationToken)
  • SearchAllActivePlayersAsync(query,limit,cancellationToken)
  • SearchAllPlayersAsync(query,limit,cancellationToken)
• NhlStatisticsApi
  • #ctor()
  • GetAllTotalPlayerStatisticValueBySeasonAsync(playerEnum,seasonYear,cancellationToken)
  • GetAllTotalPlayerStatisticValueBySeasonAsync(playerId,seasonYear,cancellationToken)
  • GetGoalieStatisticsLeadersAsync(goalieStatisticsType,seasonYear,gameType,limit,cancellationToken)
  • GetSkaterStatisticsLeadersAsync(playerStatisticsType,seasonYear,gameType,limit,cancellationToken)
  • GetTeamStatisticsBySeasonAndGameTypeAsync(team,seasonYear,gameType,cancellationToken)
  • GetTeamStatisticsBySeasonAndGameTypeAsync(teamId,seasonYear,gameType,cancellationToken)
  • GetTeamStatisticsBySeasonAsync(team,cancellationToken)
  • GetTeamStatisticsBySeasonAsync(teamId,cancellationToken)
  • GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerEnum,playerGameCenterStatistic,seasonYear,cancellationToken)
  • GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerId,playerGameCenterStatistic,seasonYear,cancellationToken)

NhlApi type

Namespace

Nhl.Api

Summary

The official unofficial Nhl.Api providing various NHL information about players, teams, conferences, divisions, statistics and more

#ctor() constructor

Summary

The official unofficial Nhl.Api providing various NHL information about players, teams, conferences, divisions, statistics and more

Parameters

This constructor has no parameters.

Dispose() method

Summary

Releases and disposes all unused or garbage collected resources for the Nhl.Api

Parameters

This method has no parameters.

DisposeAsync() method

Summary

Releases and disposes all unused or garbage collected resources for the Nhl.Api asynchronously

Returns

The await-able result of the asynchronous operation

Parameters

This method has no parameters.

GetAllPlayersAsync(cancellationToken) method

Summary

Returns all the NHL players to ever play in the NHL

Returns

Returns all the NHL players to ever play in the NHL

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetAllRosterSeasonsByTeamAsync(teamId,cancellationToken) method

Summary

Returns every active season for an NHL team and their participation in the NHL

Returns

Returns every active season for an NHL team and their participation in the NHL

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier, Example: 55 - Seattle Kraken
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetAllRosterSeasonsByTeamAsync(team,cancellationToken) method

Summary

Returns every active season for an NHL team and their participation in the NHL

Returns

Returns every active season for an NHL team and their participation in the NHL

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 9 - Ottawa Senators
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetAllSeasonsAsync() method

Summary

Returns all the NHL seasons for the NHL league

Returns

Returns all the NHL seasons for the NHL league

Parameters

This method has no parameters.

GetAllTotalPlayerStatisticValueBySeasonAsync(playerId,seasonYear,cancellationToken) method

Summary

Returns the all the NHL player game center statistics for a specific player for a specific season and game type

Returns

Returns the all the NHL player game center statistics for a specific player for a specific season and game type

Parameters

Name	Type	Description
playerId	System.Int32	The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
cancellationToken	System.Threading.CancellationToken	A cancellation token to cancel the asynchronous operation

GetAllTotalPlayerStatisticValueBySeasonAsync(playerEnum,seasonYear,cancellationToken) method

Summary

Returns the all the NHL player game center statistics for a specific player for a specific season and game type

Returns

Returns the all the NHL player game center statistics for a specific player for a specific season and game type

Parameters

Name	Type	Description
playerEnum	PlayerEnum	The player enumeration identifier, specifying which the NHL player, PlayerEnum for more information
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
cancellationToken	System.Threading.CancellationToken	A cancellation token to cancel the asynchronous operation

GetCurrentTeamScoreboardAsync(teamId,cancellationToken) method

Summary

Returns the current NHL team scoreboard for the current date and time, with upcoming game scores and completed game scores

Returns

Returns the current NHL team scoreboard for the current date and time, with upcoming game scores and completed game scores

Parameters

Name	Type	Description
teamId	System.Int32	The team identifier, Example: 10 - Toronto Maples Leafs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetCurrentTeamScoreboardAsync(team,cancellationToken) method

Summary

Returns the current NHL team scoreboard for the current date and time, with upcoming game scores and completed game scores

Returns

Returns the current NHL team scoreboard for the current date and time, with upcoming game scores and completed game scores

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, 55 - Seattle Kraken, see TeamEnum for more information
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameCenterBoxScoreByGameIdAsync(gameId,cancellationToken) method

Summary

Returns the NHL game center box score for the specified game id, including the game information, game status, game venue and more

Returns

Returns the NHL game center box score for the specified game id, including the game information, game status, game venue and more

Parameters

Name	Type	Description
gameId	System.Int32	The NHL game identifier, Example: 2023020204
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameCenterLandingByGameIdAsync(gameId,cancellationToken) method

Summary

Returns the NHL game center feed for the specified game id, including the game information, game status, game venue and more

Returns

Returns the NHL game center feed for the specified game id, including the game information, game status, game venue and more

Parameters

Name	Type	Description
gameId	System.Int32	The NHL game identifier, Example: 2023020204
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameCenterPlayByPlayByGameIdAsync(gameId,cancellationToken) method

Summary

Returns the NHL game center feed for the specified game id, including the game information, game status, game venue and more

Returns

Returns the NHL game center feed for the specified game id, including the game information, game status, game venue and more

Parameters

Name	Type	Description
gameId	System.Int32	The NHL game identifier, Example: 2023020204
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameMetadataByGameIdAsync(gameId,cancellationToken) method

Summary

Returns the NHL game meta data for the specified game id, including the teams, season states and more

Returns

Returns the NHL game meta data for the specified game id, including the teams, season states and more

Parameters

Name	Type	Description
gameId	System.Int32	The NHL game identifier, Example: 2023020204
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameScoreboardAsync(cancellationToken) method

Summary

Returns the live NHL game scoreboard, including the game information, game status, game venue and more

Returns

Returns the live NHL game scoreboard, including the game information, game status, game venue and more

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameScoresByDateAsync(date,cancellationToken) method

Summary

Returns all of the NHL game scores for the specified date, including the game id, game date and time, game status, game venue and more

Returns

Returns all of the NHL game scores for the specified date, including the game id, game date and time, game status, game venue and more

Parameters

Name	Type	Description
date	System.DateOnly	The date and time, Example: 2020-10-02
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGoalieInformationAsync(playerId,cancellationToken) method

Summary

Returns the NHL goalie's profile information including their birth date, birth city, height, weight, position and much more

Returns

Returns the NHL player's profile information

Parameters

Name	Type	Description
playerId	System.Int32	An NHL player id, Example: 8480313 - Logan Thompson
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGoalieInformationAsync(player,cancellationToken) method

Summary

Returns the NHL goalie's profile information including their birth date, birth city, height, weight, position and much more

Returns

Returns the NHL player's profile information

Parameters

Name	Type	Description
player	PlayerEnum	An NHL player id, Example: 8480313 - Logan Thompson, see PlayerEnum for more information on NHL players
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken) method

Summary

The goalie season game log for an NHL goalie for a specific season and game type including stats such as saves, goals against, save percentage and more

Returns

The collection of player season game logs with each game played including statistics, all available season and more

Parameters

Name	Type	Description
player	PlayerEnum	An NHL player id, Example: 8478402 - Joseph Woll, see PlayerEnum for more information on NHL goalies
seasonYear	System.String	The season year parameter for determining the season for the season, SeasonYear for all available seasons
gameType	Nhl.Api.Enumerations.Game.GameType	The game type parameter for determining the game type for the type of player season logs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken) method

Summary

The goalie season game log for an NHL goalie for a specific season and game type including stats such as saves, goals against, save percentage and more

Returns

The collection of player season game logs with each game played including statistics, all available season and more

Parameters

Name	Type	Description
playerId	System.Int32	An NHL player id, Example: 8479361 - Joseph Woll
seasonYear	System.String	The season year parameter for determining the season for the season, SeasonYear for all available seasons
gameType	Nhl.Api.Enumerations.Game.GameType	The game type parameter for determining the game type for the type of player season logs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGoalieStatisticsLeadersAsync(goalieStatisticsType,seasonYear,gameType,limit,cancellationToken) method

Summary

Returns the NHL goalie statistics leaders in the NHL for a specific goalie statistic type based on the game type and season year

Returns

Returns the current NHL player statistics leaders in the NHL for a specific player statistic type

Parameters

Name	Type	Description
goalieStatisticsType	Nhl.Api.Enumerations.Statistic.GoalieStatisticsType	A player statistics type, GoalieStatisticsType for all the types of statistics
seasonYear	Nhl.Api.Enumerations.Game.GameType	The NHL season year to retrieve the player statistics leaders for, see SeasonYear for more information on valid season years
gameType	System.String	The NHL game type to retrieve the player statistics leaders for, see GameType for more information on valid game types
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueGameWeekScheduleByDateAsync(date,cancellationToken) method

Summary

Returns the NHL team schedule for a specific date using the DateOnly

Returns

A result of the current NHL schedule by the specified date

Parameters

Name	Type	Description
date	System.DateOnly	A DateOnly for the specific date for the NHL schedule
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueMetadataInformationAsync(playerIds,teamIds,cancellationToken) method

Summary

Returns the meta data information about the NHL league including players, teams and season states

Returns

Returns the meta data information about the NHL league including players, teams and season states

Parameters

Name	Type	Description
playerIds	System.Collections.Generic.List{System.Int32}	A collection of NHL player identifiers, Example: [8478402,8478403]
teamIds	System.Collections.Generic.List{System.String}	A collection of NHL team identifiers, Example: [EDM, TOR]
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueMetadataInformationAsync(players,teams,cancellationToken) method

Summary

Returns the meta data information about the NHL league including players, teams and season states

Returns

Returns the meta data information about the NHL league including players, teams and season states

Parameters

Name	Type	Description
players	System.Collections.Generic.List{PlayerEnum}	A collection of NHL player identifiers, Example: [8478402,8478403]
teams	System.Collections.Generic.List{Nhl.Api.Models.Enumerations.Team.TeamEnum}	A collection of NHL team identifiers, Example: [EDM, TOR]
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueScheduleCalendarByDateAsync(date,cancellationToken) method

Summary

Returns the NHL league calendar schedule for the specified date and all applicable teams

Returns

Returns the NHL league calendar schedule for the specified date and all applicable teams

Parameters

Name	Type	Description
date	System.DateOnly	The date requested for the NHL league schedule, Example: 2024-02-10
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueStandingsByDateAsync(date,cancellationToken) method

Summary

Returns the NHL league standings for the current NHL season by the specified date

Returns

Return the NHL league standings for the specified date with specific team information

Parameters

Name	Type	Description
date	System.DateOnly	The date requested for the NHL season standing
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueStandingsSeasonInformationAsync(cancellationToken) method

Summary

Returns the NHL league standings for the all NHL seasons with specific league season information

Returns

Returns the NHL league standings information for each season since 1917-1918

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueWeekScheduleByDateAsync(date,cancellationToken) method

Summary

Returns the NHL league schedule for the specified date

Returns

Returns the NHL league schedule for the specified date

Parameters

Name	Type	Description
date	System.DateOnly	The date requested for the NHL league schedule, Example: 2024-02-10
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLiveGameFeedPlayerShiftsAsync(gameId,cancellationToken) method

Summary

Returns all of the individual shifts of each NHL player for a specific NHL game id

Returns

A collection of all the NHL player game shifts for a specific game, including start and end times, on ice duration and more

Parameters

Name	Type	Description
gameId	System.Int32	The game id, Example: 2021020087
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerHeadshotImageAsync(player,playerHeadshotImageSize,cancellationToken) method

Summary

Returns the NHL player's head shot image by the selected size

Returns

A byte array content of an NHL player head shot image

Parameters

Name	Type	Description
player	PlayerEnum	An NHL player id, Example: 8478402 - Connor McDavid, see PlayerEnum for more information on NHL players
playerHeadshotImageSize	Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize	The size of the head shot image, see PlayerHeadshotImageSize for more information
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerHeadshotImageAsync(playerId,playerHeadshotImageSize,cancellationToken) method

Summary

Returns the NHL player's head shot image by the selected size

Returns

A byte array content of an NHL player head shot image

Parameters

Name	Type	Description
playerId	System.Int32	An NHL player id, Example: 8478402 - Connor McDavid
playerHeadshotImageSize	Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize	The size of the head shot image, see PlayerHeadshotImageSize for more information
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerInformationAsync(playerId,cancellationToken) method

Summary

Returns the NHL player's profile information including their birth date, birth city, height, weight, position and much more

Returns

Returns the NHL player's profile information

Parameters

Name	Type	Description
playerId	System.Int32	An NHL player id, Example: 8478402 - Connor McDavid
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerInformationAsync(player,cancellationToken) method

Summary

Returns the NHL player's profile information including their birth date, birth city, height, weight, position and much more

Returns

Returns the NHL player's profile information

Parameters

Name	Type	Description
player	PlayerEnum	An NHL player id, Example: 8478402 - Connor McDavid, see PlayerEnum for more information on NHL players
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken) method

Summary

The player season game log for an NHL player for a specific season and game type including stats such as goals, assists, points, plus/minus and more

Returns

The collection of player season game logs with each game played including statistics, all available seasons player, shifts and in game statistics

Parameters

Name	Type	Description
player	PlayerEnum	An NHL player id, Example: 8478402 - Connor McDavid, see PlayerEnum for more information on NHL players
seasonYear	System.String	The season year parameter for determining the season for the season, SeasonYear for all available seasons
gameType	Nhl.Api.Enumerations.Game.GameType	The game type parameter for determining the game type for the type of player season logs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken) method

Summary

The player season game log for an NHL player for a specific season and game type including stats such as goals, assists, points, plus/minus and more

Returns

The collection of player season game logs with each game played including statistics, all available seasons player, shifts and in game statistics

Parameters

Name	Type	Description
playerId	System.Int32	An NHL player id, Example: 8478402 - Connor McDavid
seasonYear	System.String	The season year parameter for determining the season for the season, SeasonYear for all available seasons
gameType	Nhl.Api.Enumerations.Game.GameType	The game type parameter for determining the game type for the type of player season logs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerSpotlightAsync(cancellationToken) method

Summary

Returns the NHL player's in the spotlight based on their recent performances

Returns

A collection of players and their information for players in the NHL spotlight

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetSkaterStatisticsLeadersAsync(playerStatisticsType,seasonYear,gameType,limit,cancellationToken) method

Summary

Returns the current NHL player statistics leaders in the NHL for a specific player statistic type

Returns

Returns the current NHL player statistics leaders in the NHL for a specific player statistic type

Parameters

Name	Type	Description
playerStatisticsType	Nhl.Api.Enumerations.Statistic.PlayerStatisticsType	A player statistics type, PlayerStatisticsType for all the types of statistics
seasonYear	Nhl.Api.Enumerations.Game.GameType	The NHL season year to retrieve the player statistics leaders for, see SeasonYear for more information on valid season years
gameType	System.String	The NHL game type to retrieve the player statistics leaders for, see GameType for more information on valid game types
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetSourcesToWatchGamesAsync(cancellationToken) method

Summary

Returns the collection of countries and where you can watch NHL games with links and more

Returns

Returns the collection of countries and where you can watch NHL games with links and more

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamColorsAsync(team,cancellationToken) method

Summary

Returns the hexadecimal code for an NHL team's colors

Returns

An NHL team color scheme using hexadecimal codes

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, 55 - Seattle Kraken, see TeamEnum for more information
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamColorsAsync(teamId,cancellationToken) method

Summary

Returns the hexadecimal code for an NHL team's colors

Returns

An NHL team color scheme using hexadecimal codes

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier - Seattle Kraken: 55
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamLogoAsync(teamId,teamLogoType,cancellationToken) method

Summary

Returns an the NHL team logo based a dark or light preference using the NHL team id

Returns

Returns NHL team logo information including a byte array, base64 encoded string and the Uri endpoint

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier - Seattle Kraken: 55
teamLogoType	Nhl.Api.Models.Team.TeamLogoType	The NHL team logo image type, based on the background of light or dark
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamLogoAsync(team,teamLogoType,cancellationToken) method

Summary

Returns an the NHL team logo based a dark or light preference using the NHL team enumeration

Returns

Returns NHL team logo information including a byte array, base64 encoded string and the Uri endpoint

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, 55 - Seattle Kraken, see TeamEnum for more information
teamLogoType	Nhl.Api.Models.Team.TeamLogoType	The NHL team logo image type, based on the background of light or dark
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamProspectsByTeamAsync(teamId,cancellationToken) method

Summary

Returns all the NHL prospects for the specified NHL team including forwards, defense men and goalies

Returns

Returns all the NHL prospects for the specified NHL team including forwards, defense men and goalies

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier, Example: 55 - Seattle Kraken
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamProspectsByTeamAsync(team,cancellationToken) method

Summary

Returns all the NHL prospects for the specified NHL team including forwards, defense men and goalies

Returns

Returns all the NHL prospects for the specified NHL team including forwards, defense men and goalies

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 10 - Toronto Maple Leafs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamRosterBySeasonYearAsync(teamId,seasonYear,cancellationToken) method

Summary

Returns the NHL team roster for a specific team by the team identifier and season year

Returns

Returns the NHL team roster for a specific team by the team identifier and season year

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier, Example: 55 - Seattle Kraken
seasonYear	System.String	The eight digit number format for the season, see SeasonYear for more information, Example: 20232024
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamRosterBySeasonYearAsync(team,seasonYear,cancellationToken) method

Summary

Returns the NHL team roster for a specific team by the team identifier and season year

Returns

Returns the NHL team roster for a specific team by the team identifier and season year

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 8 - Montreal Canadiens
seasonYear	System.String	The eight digit number format for the season, see SeasonYear for more information, Example: 20232024
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamScheduleBySeasonAsync(teamAbbreviation,seasonYear,cancellationToken) method

Summary

This returns the NHL team schedule for a specific season and a specific team by the team abbreviation and season

Returns

A collection of all games in the requested season for the requested NHL team

Parameters

Name	Type	Description
teamAbbreviation	System.String	The required team abbreviation for the NHL team, Example: WSH - Washington Capitals
seasonYear	System.String	The eight digit number format for the season, Example: 20232024
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamSeasonScheduleBySeasonYearAsync(teamId,seasonYear,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and season year

Returns

Returns the NHL team schedule for the specified team and season year

Parameters

Name	Type	Description
teamId	System.Int32	The team identifier, Example: 10 - Toronto Maples Leafs
seasonYear	System.String	The season year, see SeasonYear for more information, Example: 20202021
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamSeasonScheduleBySeasonYearAsync(team,seasonYear,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and season year

Returns

Returns the NHL team schedule for the specified team and season year

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 54 - Vegas Golden Knights
seasonYear	System.String	The season year, see SeasonYear for more information, Example: 20202021
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamSeasonScheduleByYearAndMonthAsync(teamId,year,month,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and season year and month

Returns

Returns the NHL team schedule for the specified team and season year and month

Parameters

Name	Type	Description
teamId	System.Int32	The team identifier, Example: 10 - Toronto Maples Leafs
year	System.Int32	The year, Example: 2020
month	System.Int32	The month, Example: 10
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamSeasonScheduleByYearAndMonthAsync(team,year,month,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and season year and month

Returns

Returns the NHL team schedule for the specified team and season year and month

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 54 - Vegas Golden Knights
year	System.Int32	The year, Example: 2020
month	System.Int32	The month, Example: 10
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamStatisticsBySeasonAndGameTypeAsync(team,seasonYear,gameType,cancellationToken) method

Summary

Returns the NHL team statistics for individual players for a specific NHL team statistic type based on the game type and season year

Returns

The NHL team season statistics for the specified season and game type

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The team enumeration identifier, specifying which the NHL team, TeamEnum for more information
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
gameType	Nhl.Api.Enumerations.Game.GameType	The NHL game type to retrieve the team statistics, see GameType for more information on valid game types
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamStatisticsBySeasonAndGameTypeAsync(teamId,seasonYear,gameType,cancellationToken) method

Summary

Returns the NHL team statistics for individual players for a specific NHL team statistic type based on the game type and season year

Returns

The NHL team season statistics for the specified season and game type

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier, specifying which the NHL team, Example: 55 - Seattle Kraken
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
gameType	Nhl.Api.Enumerations.Game.GameType	The NHL game type to retrieve the team statistics, see GameType for more information on valid game types
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamStatisticsBySeasonAsync(team,cancellationToken) method

Summary

Returns all the NHL team valid game types for all valid NHL seasons for the selected NHL team

Returns

Returns all the NHL team valid game types for all valid NHL seasons for the selected NHL team

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The team enumeration identifier, specifying which the NHL team, TeamEnum for more information
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamStatisticsBySeasonAsync(teamId,cancellationToken) method

Summary

Returns all the NHL team valid game types for all valid NHL seasons for the selected NHL team

Returns

Returns all the NHL team valid game types for all valid NHL seasons for the selected NHL team

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier, specifying which the NHL team, Example: 55 - Seattle Kraken
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamWeekScheduleByDateAsync(teamAbbreviation,date,cancellationToken) method

Summary

This returns the NHL team schedule for a specific season and a specific team by the team abbreviation and season

Returns

A collection of all games in the requested season for the requested NHL team

Parameters

Name	Type	Description
teamAbbreviation	System.String	The required team abbreviation for the NHL team, Example: WSH - Washington Capitals
date	System.DateOnly	The date in which the request schedule for the team and for the week is request for
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamWeekScheduleByDateAsync(teamId,date,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and the specified date and time

Returns

Returns the NHL team schedule for the specified team and the specified date and time

Parameters

Name	Type	Description
teamId	System.Int32	The team identifier, Example: 10 - Toronto Maples Leafs
date	System.DateOnly	The date and time, Example: 2020-10-02
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamWeekScheduleByDateAsync(team,date,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and the specified date and time

Returns

Returns the NHL team schedule for the specified team and the specified date and time

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 54 - Vegas Golden Knights
date	System.DateOnly	The date and time, Example: 2020-10-02
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerEnum,playerGameCenterStatistic,seasonYear,cancellationToken) method

Summary

Returns the number of total number of a player statistics for a player for a specific season

Returns

Returns the number of total number of a player statistics for a player for a specific season

Parameters

Name	Type	Description
playerEnum	PlayerEnum	The player enumeration identifier, specifying which the NHL player, PlayerEnum for more information
playerGameCenterStatistic	Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic	The NHL player game center statistic type, PlayerGameCenterStatistic for more information on valid game center statistics
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerId,playerGameCenterStatistic,seasonYear,cancellationToken) method

Summary

Returns the number of total number of a player statistics for a player for a specific season

Returns

Returns the number of total number of a player statistics for a player for a specific season

Parameters

Name	Type	Description
playerId	System.Int32	The NHL player identifier, Example: 8478402 - Connor McDavid
playerGameCenterStatistic	Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic	The NHL player game center statistic type, PlayerGameCenterStatistic for more information on valid game center statistics
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTvScheduleBroadcastByDateAsync(date,cancellationToken) method

Summary

Returns the NHL TV broadcasts for the specified date with information about the broadcasts

Returns

Returns the NHL TV broadcasts for the specified date with information about the broadcasts

Parameters

Name	Type	Description
date	System.DateOnly	The date requested for the NHL TV broadcasts, Example: 2024-02-10
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

IsLeagueActiveAsync() method

Summary

Determines if the NHL league is active or inactive based on the current date and time

Returns

Returns true or false based on the current time and date

Parameters

This method has no parameters.

IsPlayoffSeasonActiveAsync(cancellationToken) method

Summary

Returns the true or false if the NHL playoff season is active or inactive

Returns

Returns a result of true or false if the NHL playoff season is active

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

IsPreSeasonActiveAsync(cancellationToken) method

Summary

Returns the true or false if the NHL playoff pre season is active or inactive

Returns

Returns a result of true or false if the NHL pre-season is active

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

IsRegularSeasonActiveAsync(cancellationToken) method

Summary

Returns the true or false if the NHL regular season is active or inactive

Returns

Returns a result of true or false if the NHL regular season is active

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

SearchAllActivePlayersAsync(query,limit,cancellationToken) method

Summary

Returns only active NHL players based on the search query provided

Returns

A collection of all NHL players based on the search query provided

Parameters

Name	Type	Description
query	System.String	A search term to find NHL players, Example: "Owen Power" or "Carter Hart" or "Nathan MacKinnon"
limit	System.Int32	A parameter to limit the number of search results returned when searching for a player
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

SearchAllPlayersAsync(query,limit,cancellationToken) method

Summary

Returns any active or inactive NHL players based on the search query provided

Returns

A collection of all NHL players based on the search query provided

Parameters

Name	Type	Description
query	System.String	A search term to find NHL players, Example: "Jack Adams" or "Wayne Gretzky" or "Mats Sundin"
limit	System.Int32	A parameter to limit the number of search results returned when searching for a player
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

NhlGameApi type

Namespace

Nhl.Api

Summary

The official unofficial NHL Game API providing various NHL information game information, game schedules, live game feeds and more

#ctor() constructor

Summary

The official unofficial NHL Game API providing various NHL information game information, game schedules, live game feeds and more

Parameters

This constructor has no parameters.

GetCurrentTeamScoreboardAsync(team,cancellationToken) method

Summary

Returns the current NHL team scoreboard for the current date and time, with upcoming game scores and completed game scores

Returns

Returns the current NHL team scoreboard for the current date and time, with upcoming game scores and completed game scores

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, 55 - Seattle Kraken, see TeamEnum for more information
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetCurrentTeamScoreboardAsync(teamId,cancellationToken) method

Summary

Returns the current NHL team scoreboard for the current date and time, with upcoming game scores and completed game scores

Returns

Returns the current NHL team scoreboard for the current date and time, with upcoming game scores and completed game scores

Parameters

Name	Type	Description
teamId	System.Int32	The team identifier, Example: 10 - Toronto Maples Leafs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameCenterBoxScoreByGameIdAsync(gameId,cancellationToken) method

Summary

Returns the NHL game center box score for the specified game id, including the game information, game status, game venue and more

Returns

Returns the NHL game center box score for the specified game id, including the game information, game status, game venue and more

Parameters

Name	Type	Description
gameId	System.Int32	The NHL game identifier, Example: 2023020204
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameCenterLandingByGameIdAsync(gameId,cancellationToken) method

Summary

Returns the NHL game center feed for the specified game id, including the game information, game status, game venue and more

Returns

Returns the NHL game center feed for the specified game id, including the game information, game status, game venue and more

Parameters

Name	Type	Description
gameId	System.Int32	The NHL game identifier, Example: 2023020204
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameCenterPlayByPlayByGameIdAsync(gameId,cancellationToken) method

Summary

Returns the NHL game center feed for the specified game id, including the game information, game status, game venue and more

Returns

Returns the NHL game center feed for the specified game id, including the game information, game status, game venue and more

Parameters

Name	Type	Description
gameId	System.Int32	The NHL game identifier, Example: 2023020204
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameMetadataByGameIdAsync(gameId,cancellationToken) method

Summary

Returns the NHL game meta data for the specified game id, including the teams, season states and more

Returns

Returns the NHL game meta data for the specified game id, including the teams, season states and more

Parameters

Name	Type	Description
gameId	System.Int32	The NHL game identifier, Example: 2023020204
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameScoreboardAsync(cancellationToken) method

Summary

Returns the live NHL game scoreboard, including the game information, game status, game venue and more

Returns

Returns the live NHL game scoreboard, including the game information, game status, game venue and more

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGameScoresByDateAsync(date,cancellationToken) method

Summary

Returns all of the NHL game scores for the specified date, including the game id, game date and time, game status, game venue and more

Returns

Returns all of the NHL game scores for the specified date, including the game id, game date and time, game status, game venue and more

Parameters

Name	Type	Description
date	System.DateOnly	The date for the requested game scores, Example: 2020-10-02
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLiveGameFeedPlayerShiftsAsync(gameId,cancellationToken) method

Summary

Returns all of the individual shifts of each NHL player for a specific NHL game id

Returns

A collection of all the NHL player game shifts for a specific game, including start and end times, on ice duration and more

Parameters

Name	Type	Description
gameId	System.Int32	The game id, Example: 2021020087
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamSeasonScheduleBySeasonYearAsync(teamId,seasonYear,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and season year

Returns

Returns the NHL team schedule for the specified team and season year

Parameters

Name	Type	Description
teamId	System.Int32	The team identifier, Example: 10 - Toronto Maples Leafs
seasonYear	System.String	The season year, see SeasonYear for more information, Example: 20202021
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamSeasonScheduleBySeasonYearAsync(team,seasonYear,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and season year

Returns

Returns the NHL team schedule for the specified team and season year

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 54 - Vegas Golden Knights
seasonYear	System.String	The season year, see SeasonYear for more information, Example: 20202021
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamSeasonScheduleByYearAndMonthAsync(teamId,year,month,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and season year and month

Returns

Returns the NHL team schedule for the specified team and season year and month

Parameters

Name	Type	Description
teamId	System.Int32	The team identifier, Example: 10 - Toronto Maples Leafs
year	System.Int32	The year, Example: 2020
month	System.Int32	The month, Example: 10
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamSeasonScheduleByYearAndMonthAsync(team,year,month,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and season year and month

Returns

Returns the NHL team schedule for the specified team and season year and month

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 54 - Vegas Golden Knights
year	System.Int32	The year, Example: 2020
month	System.Int32	The month, Example: 10
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamWeekScheduleByDateAsync(teamId,date,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and the specified date and time

Returns

Returns the NHL team schedule for the specified team and the specified date and time

Parameters

Name	Type	Description
teamId	System.Int32	The team identifier, Example: 10 - Toronto Maples Leafs
date	System.DateOnly	The date and time, Example: 2020-10-02
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamWeekScheduleByDateAsync(team,date,cancellationToken) method

Summary

Returns the NHL team schedule for the specified team and the specified date and time

Returns

Returns the NHL team schedule for the specified team and the specified date and time

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 54 - Vegas Golden Knights
date	System.DateOnly	The date and time, Example: 2020-10-02
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

NhlLeagueApi type

Namespace

Nhl.Api

Summary

The official unofficial NHL League API providing various NHL league information including teams, franchises, standings, awards and more

#ctor() constructor

Summary

The official unofficial NHL League API providing various NHL league information including teams, franchises, standings, awards and more

Parameters

This constructor has no parameters.

GetAllRosterSeasonsByTeamAsync(teamId,cancellationToken) method

Summary

Returns every active season for an NHL team and their participation in the NHL

Returns

Returns every active season for an NHL team and their participation in the NHL

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier, Example: 55 - Seattle Kraken
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetAllRosterSeasonsByTeamAsync(team,cancellationToken) method

Summary

Returns every active season for an NHL team and their participation in the NHL

Returns

Returns every active season for an NHL team and their participation in the NHL

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 9 - Ottawa Senators
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetAllSeasonsAsync(cancellationToken) method

Summary

Returns all the NHL seasons for the NHL league

Returns

Returns all the NHL seasons for the NHL league

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueGameWeekScheduleByDateAsync(date,cancellationToken) method

Summary

Returns the NHL team schedule for a specific date using the DateOnly

Returns

A result of the current NHL schedule by the specified date

Parameters

Name	Type	Description
date	System.DateOnly	A DateOnly for the specific date for the NHL schedule
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueMetadataInformationAsync(playerIds,teamIds,cancellationToken) method

Summary

Returns the meta data information about the NHL league including players, teams and season states

Returns

Returns the meta data information about the NHL league including players, teams and season states

Parameters

Name	Type	Description
playerIds	System.Collections.Generic.List{System.Int32}	A collection of NHL player identifiers, Example: [8478402,8478403]
teamIds	System.Collections.Generic.List{System.String}	A collection of NHL team identifiers, Example: [EDM, TOR]
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueMetadataInformationAsync(players,teams,cancellationToken) method

Summary

Returns the meta data information about the NHL league including players, teams and season states

Returns

Returns the meta data information about the NHL league including players, teams and season states

Parameters

Name	Type	Description
players	System.Collections.Generic.List{PlayerEnum}	A collection of NHL player identifiers, Example: [8478402,8478403]
teams	System.Collections.Generic.List{Nhl.Api.Models.Enumerations.Team.TeamEnum}	A collection of NHL team identifiers, Example: [EDM, TOR]
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueScheduleCalendarByDateAsync(date,cancellationToken) method

Summary

Returns the NHL league calendar schedule for the specified date and all applicable teams

Returns

Returns the NHL league calendar schedule for the specified date and all applicable teams

Parameters

Name	Type	Description
date	System.DateOnly	The date requested for the NHL league schedule, Example: 2024-02-10
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueStandingsByDateAsync(date,cancellationToken) method

Summary

Returns the NHL league standings for the current NHL season by the specified date

Returns

Return the NHL league standings for the specified date with specific team information

Parameters

Name	Type	Description
date	System.DateOnly	The date requested for the NHL season standing
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueStandingsSeasonInformationAsync(cancellationToken) method

Summary

Returns the NHL league standings for the all NHL seasons with specific league season information

Returns

Returns the NHL league standings information for each season since 1917-1918

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetLeagueWeekScheduleByDateAsync(date,cancellationToken) method

Summary

Returns the NHL league schedule for the specified date

Returns

Returns the NHL league schedule for the specified date

Parameters

Name	Type	Description
date	System.DateOnly	The date requested for the NHL league schedule, Example: 2024-02-10
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetSourcesToWatchGamesAsync(cancellationToken) method

Summary

Returns the collection of countries and where you can watch NHL games with links and more

Returns

Returns the collection of countries and where you can watch NHL games with links and more

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamColorsAsync(team,cancellationToken) method

Summary

Returns the hexadecimal code for an NHL team's colors

Returns

An NHL team color scheme using hexadecimal codes

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, 55 - Seattle Kraken, see TeamEnum for more information
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamColorsAsync(teamId,cancellationToken) method

Summary

Returns the hexadecimal code for an NHL team's colors

Returns

An NHL team color scheme using hexadecimal codes

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier - Seattle Kraken: 55
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamLogoAsync(team,teamLogoType,cancellationToken) method

Summary

Returns an the NHL team logo based a dark or light preference using the NHL team enumeration

Returns

Returns NHL team logo information including a byte array, base64 encoded string and the Uri endpoint

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, 55 - Seattle Kraken, see TeamEnum for more information
teamLogoType	Nhl.Api.Models.Team.TeamLogoType	The NHL team logo image type, based on the background of light or dark
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamLogoAsync(teamId,teamLogoType,cancellationToken) method

Summary

Returns an the NHL team logo based a dark or light preference using the NHL team id

Returns

Returns NHL team logo information including a byte array, base64 encoded string and the Uri endpoint

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier - Seattle Kraken: 55
teamLogoType	Nhl.Api.Models.Team.TeamLogoType	The NHL team logo image type, based on the background of light or dark
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamProspectsByTeamAsync(teamId,cancellationToken) method

Summary

Returns all the NHL prospects for the specified NHL team including forwards, defense men and goalies

Returns

Returns all the NHL prospects for the specified NHL team including forwards, defense men and goalies

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier, Example: 55 - Seattle Kraken
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamProspectsByTeamAsync(team,cancellationToken) method

Summary

Returns all the NHL prospects for the specified NHL team including forwards, defense men and goalies

Returns

Returns all the NHL prospects for the specified NHL team including forwards, defense men and goalies

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 10 - Toronto Maple Leafs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamRosterBySeasonYearAsync(teamId,seasonYear,cancellationToken) method

Summary

Returns the NHL team roster for a specific team by the team identifier and season year

Returns

Returns the NHL team roster for a specific team by the team identifier and season year

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier, Example: 55 - Seattle Kraken
seasonYear	System.String	The eight digit number format for the season, see SeasonYear for more information, Example: 20232024
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamRosterBySeasonYearAsync(team,seasonYear,cancellationToken) method

Summary

Returns the NHL team roster for a specific team by the team and season year

Returns

Returns the NHL team roster for a specific team by the team identifier and season year

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The NHL team identifier, see TeamEnum for more information, Example: 9 - Ottawa Senators
seasonYear	System.String	The eight digit number format for the season, see SeasonYear for more information, Example: 20232024
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamScheduleBySeasonAsync(teamAbbreviation,seasonYear,cancellationToken) method

Summary

This returns the NHL team schedule for a specific season and a specific team by the team abbreviation and season

Returns

A collection of all games in the requested season for the requested NHL team

Parameters

Name	Type	Description
teamAbbreviation	System.String	The required team abbreviation for the NHL team, Example: WSH - Washington
seasonYear	System.String	The eight digit number format for the season, Example: 20232024
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamWeekScheduleByDateAsync(teamAbbreviation,date,cancellationToken) method

Summary

This returns the NHL team schedule for a specific season and a specific team by the team abbreviation and season

Returns

A collection of all games in the requested season for the requested NHL team

Parameters

Name	Type	Description
teamAbbreviation	System.String	The required team abbreviation for the NHL team, Example: WSH - Washington
date	System.DateOnly	The date in which the request schedule for the team and for the week is request for
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTvScheduleBroadcastByDateAsync(date,cancellationToken) method

Summary

Returns the NHL TV broadcasts for the specified date with information about the broadcasts

Returns

Returns the NHL TV broadcasts for the specified date with information about the broadcasts

Parameters

Name	Type	Description
date	System.DateOnly	The date requested for the NHL TV broadcasts, Example: 2024-02-10
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

IsLeagueActiveAsync(cancellationToken) method

Summary

Determines if the NHL league is active or inactive based on the current date and time

Returns

Returns true or false based on the current time and date

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

IsPlayoffSeasonActiveAsync(cancellationToken) method

Summary

Returns the true or false if the NHL playoff season is active

Returns

Returns a result of true or false if the NHL playoff season is active

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

IsPreSeasonActiveAsync(cancellationToken) method

Summary

Returns the true or false if the NHL playoff pre season is active or inactive

Returns

Returns a result of true or false if the NHL pre-season is active

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

IsRegularSeasonActiveAsync(cancellationToken) method

Summary

Returns the true or false if the NHL regular season is active or inactive

Returns

Returns a result of true or false if the NHL regular season is active

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

NhlPlayerApi type

Namespace

Nhl.Api

Summary

The official unofficial NHL Player API providing various NHL information about players, draft prospects, rosters and more

#ctor() constructor

Summary

The official unofficial NHL Player API providing various NHL information about players, draft prospects, rosters and more

Parameters

This constructor has no parameters.

Dispose() method

Summary

Disposes and releases all unneeded resources for the NHL player API

Parameters

This method has no parameters.

Exceptions

Name	Description
System.NotImplementedException

GetAllPlayersAsync(cancellationToken) method

Summary

Returns all the NHL players to ever play in the NHL

Returns

Returns all the NHL players to ever play in the NHL

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGoalieInformationAsync(playerId,cancellationToken) method

Summary

Returns the NHL goalie's profile information including their birth date, birth city, height, weight, position and much more

Returns

Returns the NHL player's profile information

Parameters

Name	Type	Description
playerId	System.Int32	An NHL player id, Example: 8480313 - Logan Thompson
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGoalieInformationAsync(player,cancellationToken) method

Summary

Returns the NHL goalie's profile information including their birth date, birth city, height, weight, position and much more

Returns

Returns the NHL player's profile information

Parameters

Name	Type	Description
player	PlayerEnum	An NHL player id, Example: 8480313 - Logan Thompson, see PlayerEnum for more information on NHL players
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken) method

Summary

The player season game log for an NHL player for a specific season and game type including stats such as goals, assists, points, plus/minus and more

Returns

The collection of player season game logs with each game played including statistics, all available season and more

Parameters

Name	Type	Description
player	PlayerEnum	An NHL player id, Example: 8478402 - Connor McDavid, see PlayerEnum for more information on NHL players
seasonYear	System.String	The season year parameter for determining the season for the season, SeasonYear for all available seasons
gameType	Nhl.Api.Enumerations.Game.GameType	The game type parameter for determining the game type for the type of player season logs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken) method

Summary

The player season game log for an NHL player for a specific season and game type including stats such as goals, assists, points, plus/minus and more

Returns

The collection of player season game logs with each game played including statistics, all available season and more

Parameters

Name	Type	Description
playerId	System.Int32	An NHL player id, Example: 8478402 - Connor McDavid
seasonYear	System.String	The season year parameter for determining the season for the season, SeasonYear for all available seasons
gameType	Nhl.Api.Enumerations.Game.GameType	The game type parameter for determining the game type for the type of player season logs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerHeadshotImageAsync(player,playerHeadshotImageSize,cancellationToken) method

Summary

Returns the NHL player's head shot image by the selected size

Returns

A URI endpoint with the image of an NHL player head shot image

Parameters

Name	Type	Description
player	PlayerEnum	An NHL player id, Example: 8478402 - Connor McDavid, see PlayerEnum for more information on NHL players
playerHeadshotImageSize	Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize	The size of the head shot image, see PlayerHeadshotImageSize for more information
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerHeadshotImageAsync(playerId,playerHeadshotImageSize,cancellationToken) method

Summary

Returns the NHL player's head shot image by the selected size

Returns

A URI endpoint with the image of an NHL player head shot image

Parameters

Name	Type	Description
playerId	System.Int32	An NHL player id, Example: 8478402 - Connor McDavid
playerHeadshotImageSize	Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize	The size of the head shot image, see PlayerHeadshotImageSize for more information
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerInformationAsync(playerId,cancellationToken) method

Summary

Returns the NHL player's profile information including their birth date, birth city, height, weight, position and much more

Returns

Returns the NHL player's profile information

Parameters

Name	Type	Description
playerId	System.Int32	An NHL player id, Example: 8478402 - Connor McDavid
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerInformationAsync(player,cancellationToken) method

Summary

Returns the NHL player's profile information including their birth date, birth city, height, weight, position and much more

Returns

Returns the NHL player's profile information

Parameters

Name	Type	Description
player	PlayerEnum	An NHL player id, Example: 8478402 - Connor McDavid, see PlayerEnum for more information on NHL players
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken) method

Summary

The player season game log for an NHL player for a specific season and game type including stats such as goals, assists, points, plus/minus and more

Returns

The collection of player season game logs with each game played including statistics, all available season and more

Parameters

Name	Type	Description
player	PlayerEnum	An NHL player id, Example: 8478402 - Connor McDavid, see PlayerEnum for more information on NHL players
seasonYear	System.String	The season year parameter for determining the season for the season, SeasonYear for all available seasons
gameType	Nhl.Api.Enumerations.Game.GameType	The game type parameter for determining the game type for the type of player season logs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken) method

Summary

The player season game log for an NHL player for a specific season and game type including stats such as goals, assists, points, plus/minus and more

Returns

The collection of player season game logs with each game played including statistics, all available season and more

Parameters

Name	Type	Description
playerId	System.Int32	An NHL player id, Example: 8478402 - Connor McDavid
seasonYear	System.String	The season year parameter for determining the season for the season, SeasonYear for all available seasons
gameType	Nhl.Api.Enumerations.Game.GameType	The game type parameter for determining the game type for the type of player season logs
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetPlayerSpotlightAsync(cancellationToken) method

Summary

Returns the NHL player's in the spotlight based on their recent performances

Returns

A collection of players and their information for players in the NHL spotlight

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

SearchAllActivePlayersAsync(query,limit,cancellationToken) method

Summary

Returns only active NHL players based on the search query provided

Returns

A collection of all NHL players based on the search query provided

Parameters

Name	Type	Description
query	System.String	A search term to find NHL players, Example: "Owen Power" or "Carter Hart" or "Nathan MacKinnon"
limit	System.Int32	A parameter to limit the number of search results returned when searching for a player
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

SearchAllPlayersAsync(query,limit,cancellationToken) method

Summary

Returns any active or inactive NHL players based on the search query provided

Returns

A collection of all NHL players based on the search query provided

Parameters

Name	Type	Description
query	System.String	A search term to find NHL players, Example: "Jack Adams" or "Wayne Gretzky" or "Mats Sundin"
limit	System.Int32	A parameter to limit the number of search results returned when searching for a player
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

NhlStatisticsApi type

Namespace

Nhl.Api

Summary

The official unofficial NHL Statistics API providing various NHL information about in-depth player statistics, team statistics and more

#ctor() constructor

Summary

The official unofficial NHL Statistics API providing various NHL information about in-depth player statistics, team statistics and more

Parameters

This constructor has no parameters.

GetAllTotalPlayerStatisticValueBySeasonAsync(playerEnum,seasonYear,cancellationToken) method

Summary

Returns the all the NHL player game center statistics for a specific player for a specific season and game type

Returns

Returns the number of total number of a player statistics for a player for a specific season

Parameters

Name	Type	Description
playerEnum	PlayerEnum	The player enumeration identifier, specifying which the NHL player, PlayerEnum for more information
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetAllTotalPlayerStatisticValueBySeasonAsync(playerId,seasonYear,cancellationToken) method

Summary

Returns the all the NHL player game center statistics for a specific player for a specific season and game type

Returns

Returns the number of total number of a player statistics for a player for a specific season

Parameters

Name	Type	Description
playerId	System.Int32	The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
cancellationToken	System.Threading.CancellationToken	A cancellation token to cancel the asynchronous operation

GetGoalieStatisticsLeadersAsync(goalieStatisticsType,seasonYear,gameType,limit,cancellationToken) method

Summary

Returns the NHL goalie statistics leaders in the NHL for a specific goalie statistic type based on the game type and season year

Returns

Returns the current NHL player statistics leaders in the NHL for a specific player statistic type

Parameters

Name	Type	Description
goalieStatisticsType	Nhl.Api.Enumerations.Statistic.GoalieStatisticsType	A player statistics type, GoalieStatisticsType for all the types of statistics
seasonYear	Nhl.Api.Enumerations.Game.GameType	The NHL season year to retrieve the player statistics leaders for, see SeasonYear for more information on valid season years
gameType	System.String	The NHL game type to retrieve the player statistics leaders for, see GameType for more information on valid game types
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetSkaterStatisticsLeadersAsync(playerStatisticsType,seasonYear,gameType,limit,cancellationToken) method

Summary

Returns the current NHL player statistics leaders in the NHL for a specific player statistic type

Returns

Returns the current NHL player statistics leaders in the NHL for a specific player statistic type

Parameters

Name	Type	Description
playerStatisticsType	Nhl.Api.Enumerations.Statistic.PlayerStatisticsType	A player statistics type, PlayerStatisticsType for all the types of statistics
seasonYear	Nhl.Api.Enumerations.Game.GameType	The NHL season year to retrieve the player statistics leaders for, see SeasonYear for more information on valid season years
gameType	System.String	The NHL game type to retrieve the player statistics leaders for, see GameType for more information on valid game types
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamStatisticsBySeasonAndGameTypeAsync(team,seasonYear,gameType,cancellationToken) method

Summary

Returns the NHL team statistics for individual players for a specific NHL team statistic type based on the game type and season year

Returns

The NHL team season statistics for the specified season and game type

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The team enumeration identifier, specifying which the NHL team, TeamEnum for more information
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
gameType	Nhl.Api.Enumerations.Game.GameType	The NHL game type to retrieve the team statistics, see GameType for more information on valid game types
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamStatisticsBySeasonAndGameTypeAsync(teamId,seasonYear,gameType,cancellationToken) method

Summary

Returns the NHL team statistics for individual players for a specific NHL team statistic type based on the game type and season year

Returns

The NHL team season statistics for the specified season and game type

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier, specifying which the NHL team, Example: 55 - Seattle Kraken
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
gameType	Nhl.Api.Enumerations.Game.GameType	The NHL game type to retrieve the team statistics, see GameType for more information on valid game types
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamStatisticsBySeasonAsync(team,cancellationToken) method

Summary

Returns all the NHL team valid game types for all valid NHL seasons for the selected NHL team

Returns

Returns all the NHL team valid game types for all valid NHL seasons for the selected NHL team

Parameters

Name	Type	Description
team	Nhl.Api.Models.Enumerations.Team.TeamEnum	The team enumeration identifier, specifying which the NHL team, TeamEnum for more information
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTeamStatisticsBySeasonAsync(teamId,cancellationToken) method

Summary

Returns all the NHL team valid game types for all valid NHL seasons for the selected NHL team

Returns

Returns all the NHL team valid game types for all valid NHL seasons for the selected NHL team

Parameters

Name	Type	Description
teamId	System.Int32	The NHL team identifier, specifying which the NHL team, Example: 55 - Seattle Kraken
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerEnum,playerGameCenterStatistic,seasonYear,cancellationToken) method

Summary

Returns the number of total number of a player statistics for a player for a specific season

Returns

Returns the number of total number of a player statistics for a player for a specific season

Parameters

Name	Type	Description
playerEnum	PlayerEnum	The player enumeration identifier, specifying which the NHL player, PlayerEnum for more information
playerGameCenterStatistic	Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic	The NHL player game center statistic type, PlayerGameCenterStatistic for more information on valid game center statistics
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
cancellationToken	System.Threading.CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerId,playerGameCenterStatistic,seasonYear,cancellationToken) method

Summary

Returns the number of total number of a player statistics for a player for a specific season

Returns

Returns the number of total number of a player statistics for a player for a specific season

Parameters

Name	Type	Description
playerId	System.Int32	The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid
playerGameCenterStatistic	Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic	The NHL player game center statistic type, PlayerGameCenterStatistic for more information on valid game center statistics
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
cancellationToken	System.Threading.CancellationToken	A cancellation token to cancel the asynchronous operation