Nhl.Api 3.6.0

.NET 8.0

dotnet add package Nhl.Api --version 3.6.0

NuGet\Install-Package Nhl.Api -Version 3.6.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Nhl.Api" Version="3.6.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Nhl.Api --version 3.6.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Nhl.Api, 3.6.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Nhl.Api as a Cake Addin
#addin nuget:?package=Nhl.Api&version=3.6.0

// Install Nhl.Api as a Cake Tool
#tool nuget:?package=Nhl.Api&version=3.6.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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 💭 <a href="#installing-nhl-api">Installing Nhl.Api</a>
Implementation 🚀 <a href="#implementation">Implementation</a>
Documentation 📖 <a href="#documentation">Documentation</a>
Bugs 🐛 <a href="#bugs">Bugs</a>
Feature Backlog 📈 <a href="#feature-backlog">Feature Backlog</a>
Notable Mentions 🙏 <a href="#notable-mentions">Notable Mentions</a>
Contents 📋 <a href="#contents">Contents</a>

Installing Nhl.Api 💭 <a name="installing-nhl-api"></a>

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 🚀 <a name="implementation"></a>

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, <a href="https://github.com/Afischbacher/Nhl.Api.Extensions.Microsoft.DependencyInjection">Nhl.Api.Extensions.Microsoft.DependencyInjection</a> 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

AutoFac

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

Simple Object Instantiation

var nhlLeagueApi = new NhlLeagueApi();

Bugs 🐛 <a name="bugs"></a>

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 📈 <a name="feature-backlog"></a>

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 🙏 <a name="notable-mentions"></a>

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

<a target="_blank" href="https://gitlab.com/dword4/nhlapi">Drew Hynes</a> 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.
<a target="_blank" href="https://www.zacharymaludzinski.com/">Zachary Maludzinski</a> to contributed to documenting the <a href="https://api-web.nhle.com/api/v1" target="_blank">NHL Web API</a>. Without all this help, and documentation one of this would be possible.
<a target="_blank" href="https://www.nhl.com/">NHL</a> for providing the API for the community to use to build awesome stuff.

Returns

Parameters

Name	Type	Description
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
expressionPlayerFilter	Nhl.Api.Models.Player.ExpressionPlayerFilter	The expression player filter to filter the player statistics by, see PlayerFilterExpressionBuilder for more information on valid player filters
playerStatisticsFilterToSortBy	Nhl.Api.Models.Player.PlayerStatisticsFilter	The player statistics filter to sort the player statistics by, see PlayerStatisticsFilter for more information on valid player statistics filters
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics, by default -1 represents no limit applied to results
offsetStart	System.Int32	The offset to start the results from when reviewing the NHL player statistics
gameType	Nhl.Api.Enumerations.Game.GameType	The game type for the NHL season for the player statistics
cancellationToken	System.Threading.CancellationToken	A cancellation token to cancel the asynchronous operation

GetRealtimePlayerStatisticsBySeasonAndFilterExpressionAsync(seasonYear,expressionPlayerFilter,playerRealtimeStatisticsFilterToSortBy,limit,offsetStart,gameType,cancellationToken) `method`

Summary

Returns all the NHL real-time player game center statistics for players matching the provided filter expression for a specific season, including face-off percentage, points per game, overtime goals, shorthanded points, power-play points, shooting percentage, shots, time on ice per game, and more

Returns

Returns all the NHL real-time player game center statistics for players matching the filter expression for the specified season.

Parameters

Name	Type	Description
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
expressionPlayerFilter	Nhl.Api.Models.Player.ExpressionPlayerFilter	The expression player filter to filter the player statistics by, see PlayerFilterExpressionBuilder for more information on valid player filters
playerRealtimeStatisticsFilterToSortBy	Nhl.Api.Models.Player.PlayerRealtimeStatisticsFilter	The player real-time statistics filter to sort the player statistics by, see PlayerRealtimeStatisticsFilter for more information on valid player statistics filters
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics, by default -1 represents no limit applied to results
offsetStart	System.Int32	The offset to start the results from when reviewing the NHL player statistics
gameType	Nhl.Api.Enumerations.Game.GameType	The game type for the NHL season for the player statistics
cancellationToken	System.Threading.CancellationToken	A cancellation token to cancel the asynchronous operation

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

GetTimeOnIcePlayerStatisticsBySeasonAndFilterExpressionAsync(seasonYear,expressionPlayerFilter,playerTimeOnIceStatisticsFilterToSortBy,limit,offsetStart,gameType,cancellationToken) `method`

Summary

Returns all the NHL time-on-ice player game center statistics for players matching the provided filter expression for a specified season, including even-strength time on ice, overtime time on ice, time on ice per game, and more

Returns

Returns all the NHL time-on-ice player game center statistics for players matching the filter expression for the specified season.

Parameters

Name	Type	Description
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
expressionPlayerFilter	Nhl.Api.Models.Player.ExpressionPlayerFilter	The expression player filter to filter the player statistics by, see PlayerFilterExpressionBuilder for more information on valid player filters
playerTimeOnIceStatisticsFilterToSortBy	Nhl.Api.Models.Player.PlayerTimeOnIceStatisticsFilter	The player time-on-ice statistics filter to sort the player statistics by, see PlayerTimeOnIceStatisticsFilter for more information on valid player statistics filters
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics, by default -1 represents no limit applied to results
offsetStart	System.Int32	The offset to start the results from when reviewing the NHL player statistics
gameType	Nhl.Api.Enumerations.Game.GameType	The game type for the NHL season for the player statistics
cancellationToken	System.Threading.CancellationToken	A cancellation token to cancel the asynchronous operation

GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerEnum,playerGameCenterStatistic,seasonYear,gameType,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	Nhl.Api.Models.Enumerations.Player.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
gameType	System.Nullable{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

GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerId,playerGameCenterStatistic,seasonYear,gameType,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
gameType	System.Nullable{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

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

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 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

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

#ctor() `constructor`

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
gameType	System.Nullable{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 to cancel the asynchronous operation

GetGoalieStatisticsBySeasonAndFilterExpressionAsync(seasonYear,expressionGoalieFilter,goalieStatisticsFilterToSortBy,limit,offsetStart,gameType,cancellationToken) `method`

Summary

Returns

Parameters

Name	Type	Description
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
expressionGoalieFilter	Nhl.Api.Models.Player.ExpressionGoalieFilter	The expression goalie filter to filter the goalie statistics by, see GoalieFilterExpressionBuilder for more information on valid goalie filters
goalieStatisticsFilterToSortBy	Nhl.Api.Models.Player.GoalieStatisticsFilter	The goalie statistics filter to sort the goalie statistics by, see GoalieStatisticsFilter for more information on valid goalie statistics filters
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics, by default -1 represents no limit applied to results
offsetStart	System.Int32	The offset to start the results from when reviewing the NHL goalie statistics
gameType	Nhl.Api.Enumerations.Game.GameType	The game type for the NHL season for the player statistics
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

GetPlayerStatisticsBySeasonAndFilterExpressionAsync(seasonYear,expressionPlayerFilter,playerStatisticsFilterToSortBy,limit,offsetStart,gameType,cancellationToken) `method`

Summary

Returns

Parameters

Name	Type	Description
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
expressionPlayerFilter	Nhl.Api.Models.Player.ExpressionPlayerFilter	The expression player filter to filter the player statistics by, see PlayerFilterExpressionBuilder for more information on valid player filters
playerStatisticsFilterToSortBy	Nhl.Api.Models.Player.PlayerStatisticsFilter	The player statistics filter to sort the player statistics by, see PlayerStatisticsFilter for more information on valid player statistics filters
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics, by default -1 represents no limit applied to results
offsetStart	System.Int32	The offset to start the results from when reviewing the NHL player statistics
gameType	Nhl.Api.Enumerations.Game.GameType	The game type for the NHL season for the player statistics
cancellationToken	System.Threading.CancellationToken	A cancellation token to cancel the asynchronous operation

GetRealtimePlayerStatisticsBySeasonAndFilterExpressionAsync(seasonYear,expressionPlayerFilter,playerRealtimeStatisticsFilterToSortBy,limit,offsetStart,gameType,cancellationToken) `method`

Summary

Returns all the NHL real time player game center statistics for a specific player for a specific season including face off percentage, points per game, overtime goals, short handed points, power play points, shooting percentage, shots, time on ice per game and more

Returns

Parameters

Name	Type	Description
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
expressionPlayerFilter	Nhl.Api.Models.Player.ExpressionPlayerFilter	The expression player filter to filter the player statistics by, see PlayerFilterExpressionBuilder for more information on valid player filters
playerRealtimeStatisticsFilterToSortBy	Nhl.Api.Models.Player.PlayerRealtimeStatisticsFilter	The player statistics filter to sort the player statistics by, see PlayerRealtimeStatisticsFilter for more information on valid player statistics filters
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics, by default -1 represents no limit applied to results
offsetStart	System.Int32	The offset to start the results from when reviewing the NHL player statistics
gameType	Nhl.Api.Enumerations.Game.GameType	The game type for the NHL season for the player statistics
cancellationToken	System.Threading.CancellationToken	A cancellation token to cancel the asynchronous operation

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

GetTimeOnIcePlayerStatisticsBySeasonAndFilterExpressionAsync(seasonYear,expressionPlayerFilter,playerTimeOnIceStatisticsFilterToSortBy,limit,offsetStart,gameType,cancellationToken) `method`

Summary

Returns all the NHL time on ice player game center statistics for a specific player for a specific season including even time on ice, overtime time on ice, over time on ice per over time game time on ice per game and more

Returns

Parameters

Name	Type	Description
seasonYear	System.String	The NHL season year to retrieve the team statistics, see SeasonYear for more information on valid season years
expressionPlayerFilter	Nhl.Api.Models.Player.ExpressionPlayerFilter	The expression player filter to filter the player statistics by, see PlayerFilterExpressionBuilder for more information on valid player filters
playerTimeOnIceStatisticsFilterToSortBy	Nhl.Api.Models.Player.PlayerTimeOnIceStatisticsFilter	The player statistics filter to sort the player statistics by, see PlayerTimeOnIceStatisticsFilter for more information on valid player statistics filters
limit	System.Int32	The limit to the number of results returned when reviewing the NHL player statistics, by default -1 represents no limit applied to results
offsetStart	System.Int32	The offset to start the results from when reviewing the NHL player statistics
gameType	Nhl.Api.Enumerations.Game.GameType	The game type for the NHL season for the player statistics
cancellationToken	System.Threading.CancellationToken	A cancellation token to cancel the asynchronous operation

GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerEnum,playerGameCenterStatistic,seasonYear,gameType,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	Nhl.Api.Models.Enumerations.Player.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
gameType	System.Nullable{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

GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerId,playerGameCenterStatistic,seasonYear,gameType,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
gameType	System.Nullable{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 to cancel the asynchronous operation

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Newtonsoft.Json (>= 13.0.1)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Nhl.Api:

Package	Downloads
Nhl.Api.Extensions.Microsoft.DependencyInjection The Microsoft .NET dependency injection library extension for the official unofficial .NET NHL API	31.4K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
3.6.0	158	11/5/2024
3.5.0	503	9/30/2024
3.4.2	477	8/9/2024
3.4.1	203	3/28/2024
3.4.0	166	3/8/2024
3.3.0	259	2/24/2024
3.2.2	162	1/30/2024
3.2.1	128	1/30/2024
3.2.0	152	1/24/2024
3.1.0	208	1/5/2024
3.0.0	202	12/31/2023
2.2.1	2,655	10/9/2023
2.2.0	5,180	9/1/2023
2.1.0	13,410	10/18/2022
2.0.0	1,812	7/28/2022
1.9.2	706	3/17/2022
1.9.1	697	2/20/2022
1.9.0	735	1/28/2022
1.8.0	391	12/30/2021
1.7.0	415	12/21/2021
1.6.1	461	12/12/2021
1.6.0	621	12/11/2021
1.5.1	2,036	11/26/2021
1.5.0	1,925	11/26/2021
1.4.0	1,242	11/15/2021
1.3.0	532	10/28/2021
1.2.0	328	10/14/2021
1.1.3	355	10/8/2021
1.1.2	346	10/8/2021
1.1.1	315	10/8/2021
1.1.0	349	10/8/2021
1.0.2	338	9/30/2021
1.0.1	353	9/30/2021
1.0.0	424	9/30/2021

Nhl.Api 3.6.0

The Official Unofficial .NET NHL API 🏒

Table of Contents 📚

Installing Nhl.Api 💭 <a name="installing-nhl-api"></a>

Implementation 🚀 <a name="implementation"></a>

Nhl.Api.Extensions.Microsoft.DependencyInjection

.NET

Unity

AutoFac

Simple Object Instantiation

Documentation 📖 <a name="documentation"></a>

Nhl Player Api

.NET

Unity

AutoFac

Simple Object Instantiation

Nhl Game Api

.NET

Unity

AutoFac

Simple Object Instantiation

Nhl Statistics Api

.NET

Unity

AutoFac

Simple Object Instantiation

Nhl League Api

.NET

Unity

AutoFac

Simple Object Instantiation

Bugs 🐛 <a name="bugs"></a>

Feature Backlog 📈 <a name="feature-backlog"></a>

Notable Mentions 🙏 <a name="notable-mentions"></a>

Contents 📋 <a name="contents"></a>

NhlApi type

Namespace

Summary

#ctor() constructor

Summary

Parameters

Dispose() method

Summary

Parameters

DisposeAsync() method

Summary

Returns

Parameters

GetAllPlayersAsync(cancellationToken) method

Summary

Returns

Parameters

GetAllPlayersStatisticValuesBySeasonAsync(seasonYear,gameType,cancellationToken) method

Summary

Returns

Parameters

GetAllRosterSeasonsByTeamAsync(teamId,cancellationToken) method

Summary

Returns

Parameters

GetAllRosterSeasonsByTeamAsync(team,cancellationToken) method

Summary

Returns

Parameters

GetAllSeasonsAsync() method

Summary

Returns

Parameters

GetAllTotalPlayerStatisticValuesBySeasonAsync(playerId,seasonYear,gameType,cancellationToken) method

Summary

Returns

Parameters

GetAllTotalPlayerStatisticValuesBySeasonAsync(playerEnum,seasonYear,gameType,cancellationToken) method

Summary

Returns

Parameters

GetBoxscoreByGameIdAsync(gameId,cancellationToken) method

Summary

Returns

Parameters

NhlApi `type`

#ctor() `constructor`

Dispose() `method`

DisposeAsync() `method`

GetAllPlayersAsync(cancellationToken) `method`

GetAllPlayersStatisticValuesBySeasonAsync(seasonYear,gameType,cancellationToken) `method`

GetAllRosterSeasonsByTeamAsync(teamId,cancellationToken) `method`

GetAllRosterSeasonsByTeamAsync(team,cancellationToken) `method`

GetAllSeasonsAsync() `method`

GetAllTotalPlayerStatisticValuesBySeasonAsync(playerId,seasonYear,gameType,cancellationToken) `method`

GetAllTotalPlayerStatisticValuesBySeasonAsync(playerEnum,seasonYear,gameType,cancellationToken) `method`

GetBoxscoreByGameIdAsync(gameId,cancellationToken) `method`

GetCurrentTeamScoreboardAsync(teamId,cancellationToken) `method`

GetCurrentTeamScoreboardAsync(team,cancellationToken) `method`

GetGameCenterBoxScoreByGameIdAsync(gameId,cancellationToken) `method`

GetGameCenterLandingByGameIdAsync(gameId,cancellationToken) `method`

GetGameCenterPlayByPlayByGameIdAsync(gameId,cancellationToken,includeEventDateTime) `method`

GetGameMetadataByGameIdAsync(gameId,cancellationToken) `method`

GetGameScoreboardAsync(cancellationToken) `method`

GetGameScoresByDateAsync(date,cancellationToken) `method`

GetGoalieInformationAsync(playerId,cancellationToken) `method`

GetGoalieInformationAsync(player,cancellationToken) `method`

GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken) `method`

GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken) `method`

GetGoalieStatisticsBySeasonAndFilterExpressionAsync(seasonYear,expressionGoalieFilter,goalieStatisticsFilterToSortBy,limit,offsetStart,gameType,cancellationToken) `method`

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

GetLeagueGameWeekScheduleByDateAsync(date,cancellationToken) `method`

GetLeagueMetadataInformationAsync(playerIds,teamIds,cancellationToken) `method`

GetLeagueMetadataInformationAsync(players,teams,cancellationToken) `method`

GetLeagueScheduleCalendarByDateAsync(date,cancellationToken) `method`