Nhl.Api 3.2.1

There is a newer version of this package available.
See the version list below for details.

dotnet add package Nhl.Api --version 3.2.1

NuGet\Install-Package Nhl.Api -Version 3.2.1

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.2.1" />

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

paket add Nhl.Api --version 3.2.1

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

#r "nuget: Nhl.Api, 3.2.1"

#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.2.1

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

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.

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

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Newtonsoft.Json (>= 13.0.1)
net7.0
- Newtonsoft.Json (>= 13.0.1)
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.5K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
3.6.1	76	11/25/2024
3.6.0	223	11/5/2024
3.5.0	507	9/30/2024
3.4.2	504	8/9/2024
3.4.1	205	3/28/2024
3.4.0	168	3/8/2024
3.3.0	261	2/24/2024
3.2.2	164	1/30/2024
3.2.1	132	1/30/2024
3.2.0	154	1/24/2024
3.1.0	210	1/5/2024
3.0.0	204	12/31/2023
2.2.1	2,657	10/9/2023
2.2.0	5,182	9/1/2023
2.1.0	13,412	10/18/2022
2.0.0	1,814	7/28/2022
1.9.2	708	3/17/2022
1.9.1	699	2/20/2022
1.9.0	737	1/28/2022
1.8.0	393	12/30/2021
1.7.0	417	12/21/2021
1.6.1	463	12/12/2021
1.6.0	623	12/11/2021
1.5.1	2,038	11/26/2021
1.5.0	1,927	11/26/2021
1.4.0	1,244	11/15/2021
1.3.0	534	10/28/2021
1.2.0	330	10/14/2021
1.1.3	357	10/8/2021
1.1.2	348	10/8/2021
1.1.1	319	10/8/2021
1.1.0	351	10/8/2021
1.0.2	340	9/30/2021
1.0.1	355	9/30/2021
1.0.0	426	9/30/2021

Nhl.Api 3.2.1

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

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

GetCurrentTeamScoreboardAsync(teamId,cancellationToken) method

Summary

Returns

Parameters

GetCurrentTeamScoreboardAsync(team,cancellationToken) method

Summary

Returns

Parameters

NhlApi `type`

#ctor() `constructor`

Dispose() `method`

DisposeAsync() `method`

GetAllPlayersAsync(cancellationToken) `method`

GetAllRosterSeasonsByTeamAsync(teamId,cancellationToken) `method`

GetAllRosterSeasonsByTeamAsync(team,cancellationToken) `method`

GetAllSeasonsAsync() `method`

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

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

GetCurrentTeamScoreboardAsync(teamId,cancellationToken) `method`

GetCurrentTeamScoreboardAsync(team,cancellationToken) `method`

GetGameCenterBoxScoreByGameIdAsync(gameId,cancellationToken) `method`

GetGameCenterLandingByGameIdAsync(gameId,cancellationToken) `method`

GetGameCenterPlayByPlayByGameIdAsync(gameId,cancellationToken) `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`

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`

GetLeagueStandingsByDateAsync(date,cancellationToken) `method`

GetLeagueStandingsSeasonInformationAsync(cancellationToken) `method`

GetLeagueWeekScheduleByDateAsync(date,cancellationToken) `method`