Nhl.Api 2.2.1

This package has been deprecated as it has critical bugs.

Additional Details

All versions of this NuGet prior to version 3.0.0 no longer work due to the NHL removing their original REST API and replacing it with a new one. Please use version 3.0.0 for the latest API and features.

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

dotnet add package Nhl.Api --version 2.2.1

NuGet\Install-Package Nhl.Api -Version 2.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="2.2.1" />

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

paket add Nhl.Api --version 2.2.1

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

#r "nuget: Nhl.Api, 2.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=2.2.1

// Install Nhl.Api as a Cake Tool
#tool nuget:?package=Nhl.Api&version=2.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 C# .NET Standard 2.1 library for the .NET NHL API providing various NHL information about players, games, teams, conferences, divisions, statistics and more

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

Simple Object Instantiation

var nhlLeagueApi = new NhlLeagueApi();

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.

NhlApi
NhlGameApi
NhlLeagueApi
NhlPlayerApi
NhlStatisticsApi

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.

Returns all of the NHL team's statistics for the specific NHL season

Returns

A collection of NHL team statistics for the specified season

Parameters

Name	Type	Description
seasonYear	System.String	A season year for the all the NHL statistics, Example: 19971998, see SeasonYear for more information

GetBoxScoreByIdAsync(gameId) `method`

Summary

Returns the box score content for an NHL game

Returns

Returns information about the current score, penalties, players, team statistics and more

Parameters

Name	Type	Description
gameId	System.Int32	The game id, Example: 2021020087

GetConferenceByIdAsync(conferenceId) `method`

Summary

Returns all of the NHL conferences

Returns

An NHL conference, see Conference for more information

Parameters

Name	Type	Description
conferenceId	System.Int32	The NHL conference id, Example: Eastern Conference is the number 6

GetConferenceByIdAsync(conference) `method`

Summary

Returns the NHL conference by the conference enumeration Example: Eastern

Returns

An NHL conference, see Conference for more information

Parameters

Name	Type	Description
conference	Nhl.Api.Models.Enumerations.Conference.ConferenceEnum	The NHL conference id, Example: 6 - Eastern Conference, see ConferenceEnum for more information on NHL conferences

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

True or false if the NHL player is a goalie or player

Parameters

Name	Type	Description
player	Nhl.Api.Models.Player.Player	The NHL player model representing an NHL player

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 📈

Here are some of the future items I would like to add and are currently in the backlog:

Player Search within the NHL league
Add additional API functionality for ease of searching for various NHL entities
Add NHL player enum dynamically generated by T4 runtime templates
Live Game Feed for Live Games
Content and Media for Games

Notable Mentions 🙏

Thank you to all the people in the hockey community, especially <a href="https://gitlab.com/dword4" target="_blank">Drew Hynes</a> to contributed to documenting the <a href="https://statsapi.web.nhl.com/api/v1" target="_blank">NHL Stats API</a>. Without all of their help, guidance and knowledge none of this would be possible.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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.
.NET Core	netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.1 is compatible.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.1
- Newtonsoft.Json (>= 13.0.1)
net6.0
- Newtonsoft.Json (>= 13.0.1)
net7.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 2.2.1

The Official Unofficial .NET NHL API 🏒

Installing Nhl.Api 💭

Implementation 🚀

Nhl.Api.Extensions.Microsoft.DependencyInjection

.NET

Unity

AutoFac

Simple Object Instantiation

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

Documentation 📖

Contents

NhlApi type

Namespace

Summary

#ctor() constructor

Summary

Parameters

Dispose() method

Summary

Parameters

DisposeAsync() method

Summary

Returns

Parameters

GetActiveFranchisesAsync() method

Summary

Returns

Parameters

GetActiveTeamsAsync() method

Summary

Returns

Parameters

GetAllPlayersAsAsyncEnumerable() method

Summary

Returns

Parameters

GetAllPlayersAsync() method

Summary

Returns

Parameters

GetAllTeamsStatisticsBySeasonAsync(seasonYear) method

Summary

Returns

Parameters

GetBoxScoreByIdAsync(gameId) method

Summary

Returns

Parameters

GetConferenceByIdAsync(conferenceId) method

Summary

Returns

Parameters

GetConferenceByIdAsync(conference) method

Summary

Returns

Parameters

GetConferencesAsync() method

Summary

Returns

Parameters

NhlApi `type`

#ctor() `constructor`

Dispose() `method`

DisposeAsync() `method`

GetActiveFranchisesAsync() `method`

GetActiveTeamsAsync() `method`

GetAllPlayersAsAsyncEnumerable() `method`

GetAllPlayersAsync() `method`

GetAllTeamsStatisticsBySeasonAsync(seasonYear) `method`

GetBoxScoreByIdAsync(gameId) `method`

GetConferenceByIdAsync(conferenceId) `method`

GetConferenceByIdAsync(conference) `method`

GetConferencesAsync() `method`

GetCurrentSeasonAsync() `method`

GetDivisionByIdAsync(divisionId) `method`

GetDivisionByIdAsync(division) `method`

GetDivisionsAsync() `method`

GetDraftByYearAsync(year) `method`

GetEventTypesAsync() `method`

GetFranchiseByIdAsync(franchiseId) `method`

GetFranchiseByIdAsync(franchise) `method`

GetFranchisesAsync() `method`

GetGameScheduleAsync(gameScheduleConfiguration) `method`

GetGameScheduleByDateAsync(date,gameScheduleConfiguration) `method`

GetGameScheduleByDateAsync(year,month,day,gameScheduleConfiguration) `method`

GetGameScheduleBySeasonAsync(seasonYear,includePlayoffGames,gameScheduleConfiguration) `method`

GetGameScheduleForTeamByDateAsync(team,startDate,endDate,gameScheduleConfiguration) `method`

GetGameScheduleForTeamByDateAsync(teamId,startDate,endDate,gameScheduleConfiguration) `method`

GetGameStatusesAsync() `method`

GetGameTypesAsync() `method`

GetGoalieByStatisticTypeBySeasonAsync(goalieStatisticEnum,seasonYear,isDescending) `method`