KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #developer-tools #cli #codex #claude-code #dsh-plugin #mcp #react #agent #dsh #deepseek-harness

Nhl.Api

★ 31 Open GitHub ↗

The Official Unofficial .NET NHL API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build/Test](https://github.com/Afischbacher/Nhl.Api/actions/workflows/master-build.yml/badge.svg)](https://github.com/Afischbacher/Nhl.Api/actions/workflows/master-build.yml)
[![Build/Test](https://github.com/Afischbacher/Nhl.Api/actions/workflows/develop-build.yml/badge.svg)](https://github.com/Afischbacher/Nhl.Api/actions/workflows/develop-build.yml)
[![Code Analysis](https://github.com/Afischbacher/Nhl.Api/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/Afischbacher/Nhl.Api/actions/workflows/codeql-analysis.yml)
[![NuGet](https://img.shields.io/nuget/v/Nhl.Api)](https://www.nuget.org/packages/Nhl.Api)
[![NuGet Downloads](https://img.shields.io/nuget/dt/Nhl.Api.svg)](https://www.nuget.org/packages/Nhl.Api/)
[![Issues](https://img.shields.io/github/issues/Afischbacher/Nhl.Api.svg)](https://github.com/Afischbacher/Nhl.Api/issues)
[![License](https://img.shields.io/github/license/Afischbacher/Nhl.Api)](https://github.com/Afischbacher/Nhl.Api/blob/master/LICENSE)
[![codecov](https://codecov.io/github/Afischbacher/Nhl.Api/branch/master/graph/badge.svg?token=3TBEBCZJJ5)](https://codecov.io/github/Afischbacher/Nhl.Api)
# 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
`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 <a href="https://github.com/Afischbacher/Nhl.Api.Extensions.Microsoft.DependencyInjection">Nhl.Api.Extensions.Microsoft.DependencyInjection</a> NuGet, these API's are 
included automatically within your .NET Core project.

## Documentation 📖 <a name="documentation"></a>
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 🐛 <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.

### Contents 📋 <a name="contents"></a>
- [NhlApi](#T-Nhl-Api-NhlApi 'Nhl.Api.NhlApi')
 - [#ctor()](#M-Nhl-Api-NhlApi-#ctor 'Nhl.Api.NhlApi.#ctor')
 - [Dispose()](#M-Nhl-Api-NhlApi-Dispose 'Nhl.Api.NhlApi.Dispose')
 - [DisposeAsync()](#M-Nhl-Api-NhlApi-DisposeAsync 'Nhl.Api.NhlApi.DisposeAsync')
 - [GetAllPlayersAsync(cancellationToken)](#M-Nhl-Api-NhlApi-GetAllPlayersAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetAllPlayersAsync(System.Threading.CancellationToken)')
 - [GetAllRosterSeasonsByTeamAsync(teamId,cancellationToken)](#M-Nhl-Api-NhlApi-GetAllRosterSeasonsByTeamAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetAllRosterSeasonsByTeamAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetAllRosterSeasonsByTeamAsync(team,cancellationToken)](#M-Nhl-Api-NhlApi-GetAllRosterSeasonsByTeamAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetAllRosterSeasonsByTeamAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Threading.CancellationToken)')
 - [GetAllSeasonsAsync()](#M-Nhl-Api-NhlApi-GetAllSeasonsAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetAllSeasonsAsync(System.Threading.CancellationToken)')
 - [GetAllTotalPlayerStatisticValueBySeasonAsync(playerId,seasonYear,cancellationToken)](#M-Nhl-Api-NhlApi-GetAllTotalPlayerStatisticValueBySeasonAsync-System-Int32,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetAllTotalPlayerStatisticValueBySeasonAsync(System.Int32,System.String,System.Threading.CancellationToken)')
 - [GetAllTotalPlayerStatisticValueBySeasonAsync(playerEnum,seasonYear,cancellationToken)](#M-Nhl-Api-NhlApi-GetAllTotalPlayerStatisticValueBySeasonAsync-PlayerEnum,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetAllTotalPlayerStatisticValueBySeasonAsync(PlayerEnum,System.String,System.Threading.CancellationToken)')
 - [GetCurrentTeamScoreboardAsync(teamId,cancellationToken)](#M-Nhl-Api-NhlApi-GetCurrentTeamScoreboardAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetCurrentTeamScoreboardAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetCurrentTeamScoreboardAsync(team,cancellationToken)](#M-Nhl-Api-NhlApi-GetCurrentTeamScoreboardAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetCurrentTeamScoreboardAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Threading.CancellationToken)')
 - [GetGameCenterBoxScoreByGameIdAsync(gameId,cancellationToken)](#M-Nhl-Api-NhlApi-GetGameCenterBoxScoreByGameIdAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGameCenterBoxScoreByGameIdAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGameCenterLandingByGameIdAsync(gameId,cancellationToken)](#M-Nhl-Api-NhlApi-GetGameCenterLandingByGameIdAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGameCenterLandingByGameIdAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGameCenterPlayByPlayByGameIdAsync(gameId,cancellationToken)](#M-Nhl-Api-NhlApi-GetGameCenterPlayByPlayByGameIdAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGameCenterPlayByPlayByGameIdAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGameMetadataByGameIdAsync(gameId,cancellationToken)](#M-Nhl-Api-NhlApi-GetGameMetadataByGameIdAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGameMetadataByGameIdAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGameScoreboardAsync(cancellationToken)](#M-Nhl-Api-NhlApi-GetGameScoreboardAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGameScoreboardAsync(System.Threading.CancellationToken)')
 - [GetGameScoresByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlApi-GetGameScoresByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGameScoresByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [GetGoalieInformationAsync(playerId,cancellationToken)](#M-Nhl-Api-NhlApi-GetGoalieInformationAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGoalieInformationAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGoalieInformationAsync(player,cancellationToken)](#M-Nhl-Api-NhlApi-GetGoalieInformationAsync-PlayerEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGoalieInformationAsync(PlayerEnum,System.Threading.CancellationToken)')
 - [GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlApi-GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync-PlayerEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(PlayerEnum,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlApi-GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(System.Int32,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetGoalieStatisticsLeadersAsync(goalieStatisticsType,seasonYear,gameType,limit,cancellationToken)](#M-Nhl-Api-NhlApi-GetGoalieStatisticsLeadersAsync-Nhl-Api-Enumerations-Statistic-GoalieStatisticsType,Nhl-Api-Enumerations-Game-GameType,System-String,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetGoalieStatisticsLeadersAsync(Nhl.Api.Enumerations.Statistic.GoalieStatisticsType,Nhl.Api.Enumerations.Game.GameType,System.String,System.Int32,System.Threading.CancellationToken)')
 - [GetLeagueGameWeekScheduleByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlApi-GetLeagueGameWeekScheduleByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetLeagueGameWeekScheduleByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [GetLeagueMetadataInformationAsync(playerIds,teamIds,cancellationToken)](#M-Nhl-Api-NhlApi-GetLeagueMetadataInformationAsync-System-Collections-Generic-List{System-Int32},System-Collections-Generic-List{System-String},System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetLeagueMetadataInformationAsync(System.Collections.Generic.List{System.Int32},System.Collections.Generic.List{System.String},System.Threading.CancellationToken)')
 - [GetLeagueMetadataInformationAsync(players,teams,cancellationToken)](#M-Nhl-Api-NhlApi-GetLeagueMetadataInformationAsync-System-Collections-Generic-List{PlayerEnum},System-Collections-Generic-List{Nhl-Api-Models-Enumerations-Team-TeamEnum},System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetLeagueMetadataInformationAsync(System.Collections.Generic.List{PlayerEnum},System.Collections.Generic.List{Nhl.Api.Models.Enumerations.Team.TeamEnum},System.Threading.CancellationToken)')
 - [GetLeagueScheduleCalendarByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlApi-GetLeagueScheduleCalendarByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetLeagueScheduleCalendarByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [GetLeagueStandingsByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlApi-GetLeagueStandingsByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetLeagueStandingsByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [GetLeagueStandingsSeasonInformationAsync(cancellationToken)](#M-Nhl-Api-NhlApi-GetLeagueStandingsSeasonInformationAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetLeagueStandingsSeasonInformationAsync(System.Threading.CancellationToken)')
 - [GetLeagueWeekScheduleByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlApi-GetLeagueWeekScheduleByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetLeagueWeekScheduleByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [GetLiveGameFeedPlayerShiftsAsync(gameId,cancellationToken)](#M-Nhl-Api-NhlApi-GetLiveGameFeedPlayerShiftsAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetLiveGameFeedPlayerShiftsAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetPlayerHeadshotImageAsync(player,playerHeadshotImageSize,cancellationToken)](#M-Nhl-Api-NhlApi-GetPlayerHeadshotImageAsync-PlayerEnum,Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetPlayerHeadshotImageAsync(PlayerEnum,Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize,System.Threading.CancellationToken)')
 - [GetPlayerHeadshotImageAsync(playerId,playerHeadshotImageSize,cancellationToken)](#M-Nhl-Api-NhlApi-GetPlayerHeadshotImageAsync-System-Int32,Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetPlayerHeadshotImageAsync(System.Int32,Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize,System.Threading.CancellationToken)')
 - [GetPlayerInformationAsync(playerId,cancellationToken)](#M-Nhl-Api-NhlApi-GetPlayerInformationAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetPlayerInformationAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetPlayerInformationAsync(player,cancellationToken)](#M-Nhl-Api-NhlApi-GetPlayerInformationAsync-PlayerEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetPlayerInformationAsync(PlayerEnum,System.Threading.CancellationToken)')
 - [GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlApi-GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync-PlayerEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(PlayerEnum,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlApi-GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(System.Int32,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetPlayerSpotlightAsync(cancellationToken)](#M-Nhl-Api-NhlApi-GetPlayerSpotlightAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetPlayerSpotlightAsync(System.Threading.CancellationToken)')
 - [GetSkaterStatisticsLeadersAsync(playerStatisticsType,seasonYear,gameType,limit,cancellationToken)](#M-Nhl-Api-NhlApi-GetSkaterStatisticsLeadersAsync-Nhl-Api-Enumerations-Statistic-PlayerStatisticsType,Nhl-Api-Enumerations-Game-GameType,System-String,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetSkaterStatisticsLeadersAsync(Nhl.Api.Enumerations.Statistic.PlayerStatisticsType,Nhl.Api.Enumerations.Game.GameType,System.String,System.Int32,System.Threading.CancellationToken)')
 - [GetSourcesToWatchGamesAsync(cancellationToken)](#M-Nhl-Api-NhlApi-GetSourcesToWatchGamesAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetSourcesToWatchGamesAsync(System.Threading.CancellationToken)')
 - [GetTeamColorsAsync(team,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamColorsAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamColorsAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Threading.CancellationToken)')
 - [GetTeamColorsAsync(teamId,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamColorsAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamColorsAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetTeamLogoAsync(teamId,teamLogoType,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamLogoAsync-System-Int32,Nhl-Api-Models-Team-TeamLogoType,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamLogoAsync(System.Int32,Nhl.Api.Models.Team.TeamLogoType,System.Threading.CancellationToken)')
 - [GetTeamLogoAsync(team,teamLogoType,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamLogoAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,Nhl-Api-Models-Team-TeamLogoType,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamLogoAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,Nhl.Api.Models.Team.TeamLogoType,System.Threading.CancellationToken)')
 - [GetTeamProspectsByTeamAsync(teamId,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamProspectsByTeamAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamProspectsByTeamAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetTeamProspectsByTeamAsync(team,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamProspectsByTeamAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamProspectsByTeamAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Threading.CancellationToken)')
 - [GetTeamRosterBySeasonYearAsync(teamId,seasonYear,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamRosterBySeasonYearAsync-System-Int32,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamRosterBySeasonYearAsync(System.Int32,System.String,System.Threading.CancellationToken)')
 - [GetTeamRosterBySeasonYearAsync(team,seasonYear,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamRosterBySeasonYearAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamRosterBySeasonYearAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.String,System.Threading.CancellationToken)')
 - [GetTeamScheduleBySeasonAsync(teamAbbreviation,seasonYear,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamScheduleBySeasonAsync-System-String,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamScheduleBySeasonAsync(System.String,System.String,System.Threading.CancellationToken)')
 - [GetTeamSeasonScheduleBySeasonYearAsync(teamId,seasonYear,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamSeasonScheduleBySeasonYearAsync-System-Int32,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamSeasonScheduleBySeasonYearAsync(System.Int32,System.String,System.Threading.CancellationToken)')
 - [GetTeamSeasonScheduleBySeasonYearAsync(team,seasonYear,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamSeasonScheduleBySeasonYearAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamSeasonScheduleBySeasonYearAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.String,System.Threading.CancellationToken)')
 - [GetTeamSeasonScheduleByYearAndMonthAsync(teamId,year,month,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamSeasonScheduleByYearAndMonthAsync-System-Int32,System-Int32,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamSeasonScheduleByYearAndMonthAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken)')
 - [GetTeamSeasonScheduleByYearAndMonthAsync(team,year,month,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamSeasonScheduleByYearAndMonthAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Int32,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamSeasonScheduleByYearAndMonthAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Int32,System.Int32,System.Threading.CancellationToken)')
 - [GetTeamStatisticsBySeasonAndGameTypeAsync(team,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamStatisticsBySeasonAndGameTypeAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamStatisticsBySeasonAndGameTypeAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetTeamStatisticsBySeasonAndGameTypeAsync(teamId,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamStatisticsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamStatisticsBySeasonAndGameTypeAsync(System.Int32,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetTeamStatisticsBySeasonAsync(team,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamStatisticsBySeasonAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamStatisticsBySeasonAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Threading.CancellationToken)')
 - [GetTeamStatisticsBySeasonAsync(teamId,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamStatisticsBySeasonAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamStatisticsBySeasonAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetTeamWeekScheduleByDateAsync(teamAbbreviation,date,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamWeekScheduleByDateAsync-System-String,System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamWeekScheduleByDateAsync(System.String,System.DateOnly,System.Threading.CancellationToken)')
 - [GetTeamWeekScheduleByDateAsync(teamId,date,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamWeekScheduleByDateAsync-System-Int32,System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamWeekScheduleByDateAsync(System.Int32,System.DateOnly,System.Threading.CancellationToken)')
 - [GetTeamWeekScheduleByDateAsync(team,date,cancellationToken)](#M-Nhl-Api-NhlApi-GetTeamWeekScheduleByDateAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTeamWeekScheduleByDateAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.DateOnly,System.Threading.CancellationToken)')
 - [GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerEnum,playerGameCenterStatistic,seasonYear,cancellationToken)](#M-Nhl-Api-NhlApi-GetTotalPlayerStatisticValueByTypeAndSeasonAsync-PlayerEnum,Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTotalPlayerStatisticValueByTypeAndSeasonAsync(PlayerEnum,Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic,System.String,System.Threading.CancellationToken)')
 - [GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerId,playerGameCenterStatistic,seasonYear,cancellationToken)](#M-Nhl-Api-NhlApi-GetTotalPlayerStatisticValueByTypeAndSeasonAsync-System-Int32,Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTotalPlayerStatisticValueByTypeAndSeasonAsync(System.Int32,Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic,System.String,System.Threading.CancellationToken)')
 - [GetTvScheduleBroadcastByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlApi-GetTvScheduleBroadcastByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.GetTvScheduleBroadcastByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [IsLeagueActiveAsync()](#M-Nhl-Api-NhlApi-IsLeagueActiveAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlApi.IsLeagueActiveAsync(System.Threading.CancellationToken)')
 - [IsPlayoffSeasonActiveAsync(cancellationToken)](#M-Nhl-Api-NhlApi-IsPlayoffSeasonActiveAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlApi.IsPlayoffSeasonActiveAsync(System.Threading.CancellationToken)')
 - [IsPreSeasonActiveAsync(cancellationToken)](#M-Nhl-Api-NhlApi-IsPreSeasonActiveAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlApi.IsPreSeasonActiveAsync(System.Threading.CancellationToken)')
 - [IsRegularSeasonActiveAsync(cancellationToken)](#M-Nhl-Api-NhlApi-IsRegularSeasonActiveAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlApi.IsRegularSeasonActiveAsync(System.Threading.CancellationToken)')
 - [SearchAllActivePlayersAsync(query,limit,cancellationToken)](#M-Nhl-Api-NhlApi-SearchAllActivePlayersAsync-System-String,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.SearchAllActivePlayersAsync(System.String,System.Int32,System.Threading.CancellationToken)')
 - [SearchAllPlayersAsync(query,limit,cancellationToken)](#M-Nhl-Api-NhlApi-SearchAllPlayersAsync-System-String,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlApi.SearchAllPlayersAsync(System.String,System.Int32,System.Threading.CancellationToken)')
- [NhlGameApi](#T-Nhl-Api-NhlGameApi 'Nhl.Api.NhlGameApi')
 - [#ctor()](#M-Nhl-Api-NhlGameApi-#ctor 'Nhl.Api.NhlGameApi.#ctor')
 - [GetCurrentTeamScoreboardAsync(team,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetCurrentTeamScoreboardAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetCurrentTeamScoreboardAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Threading.CancellationToken)')
 - [GetCurrentTeamScoreboardAsync(teamId,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetCurrentTeamScoreboardAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetCurrentTeamScoreboardAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGameCenterBoxScoreByGameIdAsync(gameId,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetGameCenterBoxScoreByGameIdAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetGameCenterBoxScoreByGameIdAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGameCenterLandingByGameIdAsync(gameId,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetGameCenterLandingByGameIdAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetGameCenterLandingByGameIdAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGameCenterPlayByPlayByGameIdAsync(gameId,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetGameCenterPlayByPlayByGameIdAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetGameCenterPlayByPlayByGameIdAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGameMetadataByGameIdAsync(gameId,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetGameMetadataByGameIdAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetGameMetadataByGameIdAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGameScoreboardAsync(cancellationToken)](#M-Nhl-Api-NhlGameApi-GetGameScoreboardAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetGameScoreboardAsync(System.Threading.CancellationToken)')
 - [GetGameScoresByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetGameScoresByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetGameScoresByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [GetLiveGameFeedPlayerShiftsAsync(gameId,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetLiveGameFeedPlayerShiftsAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetLiveGameFeedPlayerShiftsAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetTeamSeasonScheduleBySeasonYearAsync(teamId,seasonYear,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetTeamSeasonScheduleBySeasonYearAsync-System-Int32,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetTeamSeasonScheduleBySeasonYearAsync(System.Int32,System.String,System.Threading.CancellationToken)')
 - [GetTeamSeasonScheduleBySeasonYearAsync(team,seasonYear,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetTeamSeasonScheduleBySeasonYearAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetTeamSeasonScheduleBySeasonYearAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.String,System.Threading.CancellationToken)')
 - [GetTeamSeasonScheduleByYearAndMonthAsync(teamId,year,month,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetTeamSeasonScheduleByYearAndMonthAsync-System-Int32,System-Int32,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetTeamSeasonScheduleByYearAndMonthAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken)')
 - [GetTeamSeasonScheduleByYearAndMonthAsync(team,year,month,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetTeamSeasonScheduleByYearAndMonthAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Int32,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetTeamSeasonScheduleByYearAndMonthAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Int32,System.Int32,System.Threading.CancellationToken)')
 - [GetTeamWeekScheduleByDateAsync(teamId,date,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetTeamWeekScheduleByDateAsync-System-Int32,System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetTeamWeekScheduleByDateAsync(System.Int32,System.DateOnly,System.Threading.CancellationToken)')
 - [GetTeamWeekScheduleByDateAsync(team,date,cancellationToken)](#M-Nhl-Api-NhlGameApi-GetTeamWeekScheduleByDateAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlGameApi.GetTeamWeekScheduleByDateAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.DateOnly,System.Threading.CancellationToken)')
- [NhlLeagueApi](#T-Nhl-Api-NhlLeagueApi 'Nhl.Api.NhlLeagueApi')
 - [#ctor()](#M-Nhl-Api-NhlLeagueApi-#ctor 'Nhl.Api.NhlLeagueApi.#ctor')
 - [GetAllRosterSeasonsByTeamAsync(teamId,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetAllRosterSeasonsByTeamAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetAllRosterSeasonsByTeamAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetAllRosterSeasonsByTeamAsync(team,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetAllRosterSeasonsByTeamAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetAllRosterSeasonsByTeamAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Threading.CancellationToken)')
 - [GetAllSeasonsAsync(cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetAllSeasonsAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetAllSeasonsAsync(System.Threading.CancellationToken)')
 - [GetLeagueGameWeekScheduleByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetLeagueGameWeekScheduleByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetLeagueGameWeekScheduleByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [GetLeagueMetadataInformationAsync(playerIds,teamIds,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetLeagueMetadataInformationAsync-System-Collections-Generic-List{System-Int32},System-Collections-Generic-List{System-String},System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetLeagueMetadataInformationAsync(System.Collections.Generic.List{System.Int32},System.Collections.Generic.List{System.String},System.Threading.CancellationToken)')
 - [GetLeagueMetadataInformationAsync(players,teams,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetLeagueMetadataInformationAsync-System-Collections-Generic-List{PlayerEnum},System-Collections-Generic-List{Nhl-Api-Models-Enumerations-Team-TeamEnum},System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetLeagueMetadataInformationAsync(System.Collections.Generic.List{PlayerEnum},System.Collections.Generic.List{Nhl.Api.Models.Enumerations.Team.TeamEnum},System.Threading.CancellationToken)')
 - [GetLeagueScheduleCalendarByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetLeagueScheduleCalendarByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetLeagueScheduleCalendarByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [GetLeagueStandingsByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetLeagueStandingsByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetLeagueStandingsByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [GetLeagueStandingsSeasonInformationAsync(cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetLeagueStandingsSeasonInformationAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetLeagueStandingsSeasonInformationAsync(System.Threading.CancellationToken)')
 - [GetLeagueWeekScheduleByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetLeagueWeekScheduleByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetLeagueWeekScheduleByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [GetSourcesToWatchGamesAsync(cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetSourcesToWatchGamesAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetSourcesToWatchGamesAsync(System.Threading.CancellationToken)')
 - [GetTeamColorsAsync(team,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTeamColorsAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTeamColorsAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Threading.CancellationToken)')
 - [GetTeamColorsAsync(teamId,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTeamColorsAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTeamColorsAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetTeamLogoAsync(team,teamLogoType,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTeamLogoAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,Nhl-Api-Models-Team-TeamLogoType,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTeamLogoAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,Nhl.Api.Models.Team.TeamLogoType,System.Threading.CancellationToken)')
 - [GetTeamLogoAsync(teamId,teamLogoType,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTeamLogoAsync-System-Int32,Nhl-Api-Models-Team-TeamLogoType,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTeamLogoAsync(System.Int32,Nhl.Api.Models.Team.TeamLogoType,System.Threading.CancellationToken)')
 - [GetTeamProspectsByTeamAsync(teamId,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTeamProspectsByTeamAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTeamProspectsByTeamAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetTeamProspectsByTeamAsync(team,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTeamProspectsByTeamAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTeamProspectsByTeamAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Threading.CancellationToken)')
 - [GetTeamRosterBySeasonYearAsync(teamId,seasonYear,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTeamRosterBySeasonYearAsync-System-Int32,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTeamRosterBySeasonYearAsync(System.Int32,System.String,System.Threading.CancellationToken)')
 - [GetTeamRosterBySeasonYearAsync(team,seasonYear,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTeamRosterBySeasonYearAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTeamRosterBySeasonYearAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.String,System.Threading.CancellationToken)')
 - [GetTeamScheduleBySeasonAsync(teamAbbreviation,seasonYear,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTeamScheduleBySeasonAsync-System-String,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTeamScheduleBySeasonAsync(System.String,System.String,System.Threading.CancellationToken)')
 - [GetTeamWeekScheduleByDateAsync(teamAbbreviation,date,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTeamWeekScheduleByDateAsync-System-String,System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTeamWeekScheduleByDateAsync(System.String,System.DateOnly,System.Threading.CancellationToken)')
 - [GetTvScheduleBroadcastByDateAsync(date,cancellationToken)](#M-Nhl-Api-NhlLeagueApi-GetTvScheduleBroadcastByDateAsync-System-DateOnly,System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.GetTvScheduleBroadcastByDateAsync(System.DateOnly,System.Threading.CancellationToken)')
 - [IsLeagueActiveAsync(cancellationToken)](#M-Nhl-Api-NhlLeagueApi-IsLeagueActiveAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.IsLeagueActiveAsync(System.Threading.CancellationToken)')
 - [IsPlayoffSeasonActiveAsync(cancellationToken)](#M-Nhl-Api-NhlLeagueApi-IsPlayoffSeasonActiveAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.IsPlayoffSeasonActiveAsync(System.Threading.CancellationToken)')
 - [IsPreSeasonActiveAsync(cancellationToken)](#M-Nhl-Api-NhlLeagueApi-IsPreSeasonActiveAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.IsPreSeasonActiveAsync(System.Threading.CancellationToken)')
 - [IsRegularSeasonActiveAsync(cancellationToken)](#M-Nhl-Api-NhlLeagueApi-IsRegularSeasonActiveAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlLeagueApi.IsRegularSeasonActiveAsync(System.Threading.CancellationToken)')
- [NhlPlayerApi](#T-Nhl-Api-NhlPlayerApi 'Nhl.Api.NhlPlayerApi')
 - [#ctor()](#M-Nhl-Api-NhlPlayerApi-#ctor 'Nhl.Api.NhlPlayerApi.#ctor')
 - [Dispose()](#M-Nhl-Api-NhlPlayerApi-Dispose 'Nhl.Api.NhlPlayerApi.Dispose')
 - [GetAllPlayersAsync(cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetAllPlayersAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetAllPlayersAsync(System.Threading.CancellationToken)')
 - [GetGoalieInformationAsync(playerId,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetGoalieInformationAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetGoalieInformationAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetGoalieInformationAsync(player,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetGoalieInformationAsync-PlayerEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetGoalieInformationAsync(PlayerEnum,System.Threading.CancellationToken)')
 - [GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync-PlayerEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(PlayerEnum,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync(System.Int32,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetPlayerHeadshotImageAsync(player,playerHeadshotImageSize,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetPlayerHeadshotImageAsync-PlayerEnum,Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetPlayerHeadshotImageAsync(PlayerEnum,Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize,System.Threading.CancellationToken)')
 - [GetPlayerHeadshotImageAsync(playerId,playerHeadshotImageSize,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetPlayerHeadshotImageAsync-System-Int32,Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetPlayerHeadshotImageAsync(System.Int32,Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize,System.Threading.CancellationToken)')
 - [GetPlayerInformationAsync(playerId,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetPlayerInformationAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetPlayerInformationAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetPlayerInformationAsync(player,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetPlayerInformationAsync-PlayerEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetPlayerInformationAsync(PlayerEnum,System.Threading.CancellationToken)')
 - [GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(player,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync-PlayerEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(PlayerEnum,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(playerId,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync(System.Int32,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetPlayerSpotlightAsync(cancellationToken)](#M-Nhl-Api-NhlPlayerApi-GetPlayerSpotlightAsync-System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.GetPlayerSpotlightAsync(System.Threading.CancellationToken)')
 - [SearchAllActivePlayersAsync(query,limit,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-SearchAllActivePlayersAsync-System-String,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.SearchAllActivePlayersAsync(System.String,System.Int32,System.Threading.CancellationToken)')
 - [SearchAllPlayersAsync(query,limit,cancellationToken)](#M-Nhl-Api-NhlPlayerApi-SearchAllPlayersAsync-System-String,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlPlayerApi.SearchAllPlayersAsync(System.String,System.Int32,System.Threading.CancellationToken)')
- [NhlStatisticsApi](#T-Nhl-Api-NhlStatisticsApi 'Nhl.Api.NhlStatisticsApi')
 - [#ctor()](#M-Nhl-Api-NhlStatisticsApi-#ctor 'Nhl.Api.NhlStatisticsApi.#ctor')
 - [GetAllTotalPlayerStatisticValueBySeasonAsync(playerEnum,seasonYear,cancellationToken)](#M-Nhl-Api-NhlStatisticsApi-GetAllTotalPlayerStatisticValueBySeasonAsync-PlayerEnum,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlStatisticsApi.GetAllTotalPlayerStatisticValueBySeasonAsync(PlayerEnum,System.String,System.Threading.CancellationToken)')
 - [GetAllTotalPlayerStatisticValueBySeasonAsync(playerId,seasonYear,cancellationToken)](#M-Nhl-Api-NhlStatisticsApi-GetAllTotalPlayerStatisticValueBySeasonAsync-System-Int32,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlStatisticsApi.GetAllTotalPlayerStatisticValueBySeasonAsync(System.Int32,System.String,System.Threading.CancellationToken)')
 - [GetGoalieStatisticsLeadersAsync(goalieStatisticsType,seasonYear,gameType,limit,cancellationToken)](#M-Nhl-Api-NhlStatisticsApi-GetGoalieStatisticsLeadersAsync-Nhl-Api-Enumerations-Statistic-GoalieStatisticsType,Nhl-Api-Enumerations-Game-GameType,System-String,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlStatisticsApi.GetGoalieStatisticsLeadersAsync(Nhl.Api.Enumerations.Statistic.GoalieStatisticsType,Nhl.Api.Enumerations.Game.GameType,System.String,System.Int32,System.Threading.CancellationToken)')
 - [GetSkaterStatisticsLeadersAsync(playerStatisticsType,seasonYear,gameType,limit,cancellationToken)](#M-Nhl-Api-NhlStatisticsApi-GetSkaterStatisticsLeadersAsync-Nhl-Api-Enumerations-Statistic-PlayerStatisticsType,Nhl-Api-Enumerations-Game-GameType,System-String,System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlStatisticsApi.GetSkaterStatisticsLeadersAsync(Nhl.Api.Enumerations.Statistic.PlayerStatisticsType,Nhl.Api.Enumerations.Game.GameType,System.String,System.Int32,System.Threading.CancellationToken)')
 - [GetTeamStatisticsBySeasonAndGameTypeAsync(team,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlStatisticsApi-GetTeamStatisticsBySeasonAndGameTypeAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlStatisticsApi.GetTeamStatisticsBySeasonAndGameTypeAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetTeamStatisticsBySeasonAndGameTypeAsync(teamId,seasonYear,gameType,cancellationToken)](#M-Nhl-Api-NhlStatisticsApi-GetTeamStatisticsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken- 'Nhl.Api.NhlStatisticsApi.GetTeamStatisticsBySeasonAndGameTypeAsync(System.Int32,System.String,Nhl.Api.Enumerations.Game.GameType,System.Threading.CancellationToken)')
 - [GetTeamStatisticsBySeasonAsync(team,cancellationToken)](#M-Nhl-Api-NhlStatisticsApi-GetTeamStatisticsBySeasonAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken- 'Nhl.Api.NhlStatisticsApi.GetTeamStatisticsBySeasonAsync(Nhl.Api.Models.Enumerations.Team.TeamEnum,System.Threading.CancellationToken)')
 - [GetTeamStatisticsBySeasonAsync(teamId,cancellationToken)](#M-Nhl-Api-NhlStatisticsApi-GetTeamStatisticsBySeasonAsync-System-Int32,System-Threading-CancellationToken- 'Nhl.Api.NhlStatisticsApi.GetTeamStatisticsBySeasonAsync(System.Int32,System.Threading.CancellationToken)')
 - [GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerEnum,playerGameCenterStatistic,seasonYear,cancellationToken)](#M-Nhl-Api-NhlStatisticsApi-GetTotalPlayerStatisticValueByTypeAndSeasonAsync-PlayerEnum,Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlStatisticsApi.GetTotalPlayerStatisticValueByTypeAndSeasonAsync(PlayerEnum,Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic,System.String,System.Threading.CancellationToken)')
 - [GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerId,playerGameCenterStatistic,seasonYear,cancellationToken)](#M-Nhl-Api-NhlStatisticsApi-GetTotalPlayerStatisticValueByTypeAndSeasonAsync-System-Int32,Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic,System-String,System-Threading-CancellationToken- 'Nhl.Api.NhlStatisticsApi.GetTotalPlayerStatisticValueByTypeAndSeasonAsync(System.Int32,Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic,System.String,System.Threading.CancellationToken)')

<a name='T-Nhl-Api-NhlApi'></a>
## NhlApi `type`

##### Namespace

Nhl.Api

##### Summary

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

<a name='M-Nhl-Api-NhlApi-#ctor'></a>
### #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.

<a name='M-Nhl-Api-NhlApi-Dispose'></a>
### Dispose() `method`

##### Summary

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

##### Parameters

This method has no parameters.

<a name='M-Nhl-Api-NhlApi-DisposeAsync'></a>
### 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.

<a name='M-Nhl-Api-NhlApi-GetAllPlayersAsync-System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetAllRosterSeasonsByTeamAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetAllRosterSeasonsByTeamAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetAllSeasonsAsync-System-Threading-CancellationToken-'></a>
### 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.

<a name='M-Nhl-Api-NhlApi-GetAllTotalPlayerStatisticValueBySeasonAsync-System-Int32,System-String,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL season year to retrieve the team statistics, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token to cancel the asynchronous operation |

<a name='M-Nhl-Api-NhlApi-GetAllTotalPlayerStatisticValueBySeasonAsync-PlayerEnum,System-String,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetCurrentTeamScoreboardAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The team identifier, Example: 10 - Toronto Maples Leafs |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetCurrentTeamScoreboardAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetGameCenterBoxScoreByGameIdAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL game identifier, Example: 2023020204 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetGameCenterLandingByGameIdAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetGameCenterPlayByPlayByGameIdAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetGameMetadataByGameIdAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetGameScoreboardAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetGameScoresByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date and time, Example: 2020-10-02 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetGoalieInformationAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | An NHL player id, Example: 8480313 - Logan Thompson |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetGoalieInformationAsync-PlayerEnum,System-Threading-CancellationToken-'></a>
### 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](#T-PlayerEnum 'PlayerEnum') | An NHL player id, Example: 8480313 - Logan Thompson, see [PlayerEnum](#T-PlayerEnum 'PlayerEnum') for more information on NHL players |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync-PlayerEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](#T-PlayerEnum 'PlayerEnum') | An NHL player id, Example: 8478402 - Joseph Woll, see [PlayerEnum](#T-PlayerEnum 'PlayerEnum') for more information on NHL goalies |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The season year parameter for determining the season for the season, [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for all available seasons |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | An NHL player id, Example: 8479361 - Joseph Woll |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The season year parameter for determining the season for the season, [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for all available seasons |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetGoalieStatisticsLeadersAsync-Nhl-Api-Enumerations-Statistic-GoalieStatisticsType,Nhl-Api-Enumerations-Game-GameType,System-String,System-Int32,System-Threading-CancellationToken-'></a>
### 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](#T-Nhl-Api-Enumerations-Statistic-GoalieStatisticsType 'Nhl.Api.Enumerations.Statistic.GoalieStatisticsType') | A player statistics type, [GoalieStatisticsType](#T-Nhl-Api-Enumerations-Statistic-GoalieStatisticsType 'Nhl.Api.Enumerations.Statistic.GoalieStatisticsType') for all the types of statistics |
| seasonYear | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') | The NHL season year to retrieve the player statistics leaders for, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| gameType | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL game type to retrieve the player statistics leaders for, see [GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') for more information on valid game types |
| limit | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The limit to the number of results returned when reviewing the NHL player statistics |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetLeagueGameWeekScheduleByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### GetLeagueGameWeekScheduleByDateAsync(date,cancellationToken) `method`

##### Summary

Returns the NHL team schedule for a specific date using the [DateOnly](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly')

##### Returns

A result of the current NHL schedule by the specified date

##### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| date | [System.DateOnly](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | A [DateOnly](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') for the specific date for the NHL schedule |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetLeagueMetadataInformationAsync-System-Collections-Generic-List{System-Int32},System-Collections-Generic-List{System-String},System-Threading-CancellationToken-'></a>
### 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}](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Collections.Generic.List 'System.Collections.Generic.List{System.Int32}') | A collection of NHL player identifiers, Example: [8478402,8478403] |
| teamIds | [System.Collections.Generic.List{System.String}](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Collections.Generic.List 'System.Collections.Generic.List{System.String}') | A collection of NHL team identifiers, Example: [EDM, TOR] |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetLeagueMetadataInformationAsync-System-Collections-Generic-List{PlayerEnum},System-Collections-Generic-List{Nhl-Api-Models-Enumerations-Team-TeamEnum},System-Threading-CancellationToken-'></a>
### 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}](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Collections.Generic.List '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}](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Collections.Generic.List 'System.Collections.Generic.List{Nhl.Api.Models.Enumerations.Team.TeamEnum}') | A collection of NHL team identifiers, Example: [EDM, TOR] |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetLeagueScheduleCalendarByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date requested for the NHL league schedule, Example: 2024-02-10 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetLeagueStandingsByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date requested for the NHL season standing |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetLeagueStandingsSeasonInformationAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetLeagueWeekScheduleByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date requested for the NHL league schedule, Example: 2024-02-10 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetLiveGameFeedPlayerShiftsAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The game id, Example: 2021020087 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetPlayerHeadshotImageAsync-PlayerEnum,Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize,System-Threading-CancellationToken-'></a>
### 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](#T-PlayerEnum 'PlayerEnum') | An NHL player id, Example: 8478402 - Connor McDavid, see [PlayerEnum](#T-PlayerEnum 'PlayerEnum') for more information on NHL players |
| playerHeadshotImageSize | [Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize](#T-Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize 'Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize') | The size of the head shot image, see [PlayerHeadshotImageSize](#T-Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize 'Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize') for more information |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetPlayerHeadshotImageAsync-System-Int32,Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | An NHL player id, Example: 8478402 - Connor McDavid |
| playerHeadshotImageSize | [Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize](#T-Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize 'Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize') | The size of the head shot image, see [PlayerHeadshotImageSize](#T-Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize 'Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize') for more information |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetPlayerInformationAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | An NHL player id, Example: 8478402 - Connor McDavid |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetPlayerInformationAsync-PlayerEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync-PlayerEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](#T-PlayerEnum 'PlayerEnum') | An NHL player id, Example: 8478402 - Connor McDavid, see [PlayerEnum](#T-PlayerEnum 'PlayerEnum') for more information on NHL players |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The season year parameter for determining the season for the season, [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for all available seasons |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | An NHL player id, Example: 8478402 - Connor McDavid |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The season year parameter for determining the season for the season, [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for all available seasons |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetPlayerSpotlightAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetSkaterStatisticsLeadersAsync-Nhl-Api-Enumerations-Statistic-PlayerStatisticsType,Nhl-Api-Enumerations-Game-GameType,System-String,System-Int32,System-Threading-CancellationToken-'></a>
### 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](#T-Nhl-Api-Enumerations-Statistic-PlayerStatisticsType 'Nhl.Api.Enumerations.Statistic.PlayerStatisticsType') | A player statistics type, [PlayerStatisticsType](#T-Nhl-Api-Enumerations-Statistic-PlayerStatisticsType 'Nhl.Api.Enumerations.Statistic.PlayerStatisticsType') for all the types of statistics |
| seasonYear | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') | The NHL season year to retrieve the player statistics leaders for, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| gameType | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL game type to retrieve the player statistics leaders for, see [GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') for more information on valid game types |
| limit | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The limit to the number of results returned when reviewing the NHL player statistics |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetSourcesToWatchGamesAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetTeamColorsAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetTeamColorsAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetTeamLogoAsync-System-Int32,Nhl-Api-Models-Team-TeamLogoType,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL team identifier - Seattle Kraken: 55 |
| teamLogoType | [Nhl.Api.Models.Team.TeamLogoType](#T-Nhl-Api-Models-Team-TeamLogoType 'Nhl.Api.Models.Team.TeamLogoType') | The NHL team logo image type, based on the background of light or dark |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamLogoAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,Nhl-Api-Models-Team-TeamLogoType,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetTeamProspectsByTeamAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetTeamProspectsByTeamAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetTeamRosterBySeasonYearAsync-System-Int32,System-String,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL team identifier, Example: 55 - Seattle Kraken |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The eight digit number format for the season, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information, Example: 20232024 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamRosterBySeasonYearAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,System-Threading-CancellationToken-'></a>
### 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](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') | The NHL team identifier, see [TeamEnum](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') for more information, Example: 8 - Montreal Canadiens |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The eight digit number format for the season, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information, Example: 20232024 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamScheduleBySeasonAsync-System-String,System-String,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The required team abbreviation for the NHL team, Example: WSH - Washington Capitals |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The eight digit number format for the season, Example: 20232024 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamSeasonScheduleBySeasonYearAsync-System-Int32,System-String,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetTeamSeasonScheduleBySeasonYearAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,System-Threading-CancellationToken-'></a>
### 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](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') | The NHL team identifier, see [TeamEnum](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') for more information, Example: 54 - Vegas Golden Knights |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The season year, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information, Example: 20202021 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamSeasonScheduleByYearAndMonthAsync-System-Int32,System-Int32,System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The team identifier, Example: 10 - Toronto Maples Leafs |
| year | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The year, Example: 2020 |
| month | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The month, Example: 10 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamSeasonScheduleByYearAndMonthAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Int32,System-Int32,System-Threading-CancellationToken-'></a>
### 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](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') | The NHL team identifier, see [TeamEnum](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') for more information, Example: 54 - Vegas Golden Knights |
| year | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The year, Example: 2020 |
| month | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The month, Example: 10 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamStatisticsBySeasonAndGameTypeAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') | The team enumeration identifier, specifying which the NHL team, [TeamEnum](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') for more information |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL season year to retrieve the team statistics, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') | The NHL game type to retrieve the team statistics, see [GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') for more information on valid game types |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamStatisticsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL team identifier, specifying which the NHL team, Example: 55 - Seattle Kraken |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL season year to retrieve the team statistics, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') | The NHL game type to retrieve the team statistics, see [GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') for more information on valid game types |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamStatisticsBySeasonAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetTeamStatisticsBySeasonAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetTeamWeekScheduleByDateAsync-System-String,System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The required team abbreviation for the NHL team, Example: WSH - Washington Capitals |
| date | [System.DateOnly](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date in which the request schedule for the team and for the week is request for |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamWeekScheduleByDateAsync-System-Int32,System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The team identifier, Example: 10 - Toronto Maples Leafs |
| date | [System.DateOnly](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date and time, Example: 2020-10-02 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTeamWeekScheduleByDateAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-DateOnly,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-GetTotalPlayerStatisticValueByTypeAndSeasonAsync-PlayerEnum,Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic,System-String,System-Threading-CancellationToken-'></a>
### 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](#T-PlayerEnum 'PlayerEnum') | The player enumeration identifier, specifying which the NHL player, [PlayerEnum](#T-PlayerEnum 'PlayerEnum') for more information |
| playerGameCenterStatistic | [Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic](#T-Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic 'Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic') | The NHL player game center statistic type, [PlayerGameCenterStatistic](#T-Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic 'Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic') for more information on valid game center statistics |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL season year to retrieve the team statistics, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTotalPlayerStatisticValueByTypeAndSeasonAsync-System-Int32,Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic,System-String,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL player identifier, Example: 8478402 - Connor McDavid |
| playerGameCenterStatistic | [Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic](#T-Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic 'Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic') | The NHL player game center statistic type, [PlayerGameCenterStatistic](#T-Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic 'Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic') for more information on valid game center statistics |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL season year to retrieve the team statistics, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-GetTvScheduleBroadcastByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date requested for the NHL TV broadcasts, Example: 2024-02-10 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-IsLeagueActiveAsync-System-Threading-CancellationToken-'></a>
### 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.

<a name='M-Nhl-Api-NhlApi-IsPlayoffSeasonActiveAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-IsPreSeasonActiveAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-IsRegularSeasonActiveAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlApi-SearchAllActivePlayersAsync-System-String,System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | A search term to find NHL players, Example: "Owen Power" or "Carter Hart" or "Nathan MacKinnon" |
| limit | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | A parameter to limit the number of search results returned when searching for a player |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlApi-SearchAllPlayersAsync-System-String,System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | A search term to find NHL players, Example: "Jack Adams" or "Wayne Gretzky" or "Mats Sundin" |
| limit | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | A parameter to limit the number of search results returned when searching for a player |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='T-Nhl-Api-NhlGameApi'></a>
## 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

<a name='M-Nhl-Api-NhlGameApi-#ctor'></a>
### #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.

<a name='M-Nhl-Api-NhlGameApi-GetCurrentTeamScoreboardAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlGameApi-GetCurrentTeamScoreboardAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The team identifier, Example: 10 - Toronto Maples Leafs |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlGameApi-GetGameCenterBoxScoreByGameIdAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlGameApi-GetGameCenterLandingByGameIdAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlGameApi-GetGameCenterPlayByPlayByGameIdAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlGameApi-GetGameMetadataByGameIdAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlGameApi-GetGameScoreboardAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlGameApi-GetGameScoresByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date for the requested game scores, Example: 2020-10-02 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlGameApi-GetLiveGameFeedPlayerShiftsAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The game id, Example: 2021020087 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlGameApi-GetTeamSeasonScheduleBySeasonYearAsync-System-Int32,System-String,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlGameApi-GetTeamSeasonScheduleBySeasonYearAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,System-Threading-CancellationToken-'></a>
### 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](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') | The NHL team identifier, see [TeamEnum](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') for more information, Example: 54 - Vegas Golden Knights |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The season year, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information, Example: 20202021 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlGameApi-GetTeamSeasonScheduleByYearAndMonthAsync-System-Int32,System-Int32,System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The team identifier, Example: 10 - Toronto Maples Leafs |
| year | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The year, Example: 2020 |
| month | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The month, Example: 10 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlGameApi-GetTeamSeasonScheduleByYearAndMonthAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Int32,System-Int32,System-Threading-CancellationToken-'></a>
### 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](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') | The NHL team identifier, see [TeamEnum](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') for more information, Example: 54 - Vegas Golden Knights |
| year | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The year, Example: 2020 |
| month | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The month, Example: 10 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlGameApi-GetTeamWeekScheduleByDateAsync-System-Int32,System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The team identifier, Example: 10 - Toronto Maples Leafs |
| date | [System.DateOnly](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date and time, Example: 2020-10-02 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlGameApi-GetTeamWeekScheduleByDateAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-DateOnly,System-Threading-CancellationToken-'></a>
### 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

<a name='T-Nhl-Api-NhlLeagueApi'></a>
## NhlLeagueApi `type`

##### Namespace

Nhl.Api

##### Summary

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

<a name='M-Nhl-Api-NhlLeagueApi-#ctor'></a>
### #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.

<a name='M-Nhl-Api-NhlLeagueApi-GetAllRosterSeasonsByTeamAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetAllRosterSeasonsByTeamAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetAllSeasonsAsync-System-Threading-CancellationToken-'></a>
### GetAllSeasonsAsync(cancellationToken) `method`

##### Summary

Returns all the NHL seasons for the NHL league

##### Returns

Returns all the NHL seasons for the NHL league

##### Parameters

<a name='M-Nhl-Api-NhlLeagueApi-GetLeagueGameWeekScheduleByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### GetLeagueGameWeekScheduleByDateAsync(date,cancellationToken) `method`

##### Summary

Returns the NHL team schedule for a specific date using the [DateOnly](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly')

##### Returns

A result of the current NHL schedule by the specified date

##### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| date | [System.DateOnly](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | A [DateOnly](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') for the specific date for the NHL schedule |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlLeagueApi-GetLeagueMetadataInformationAsync-System-Collections-Generic-List{System-Int32},System-Collections-Generic-List{System-String},System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetLeagueMetadataInformationAsync-System-Collections-Generic-List{PlayerEnum},System-Collections-Generic-List{Nhl-Api-Models-Enumerations-Team-TeamEnum},System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetLeagueScheduleCalendarByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date requested for the NHL league schedule, Example: 2024-02-10 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlLeagueApi-GetLeagueStandingsByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date requested for the NHL season standing |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlLeagueApi-GetLeagueStandingsSeasonInformationAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetLeagueWeekScheduleByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date requested for the NHL league schedule, Example: 2024-02-10 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlLeagueApi-GetSourcesToWatchGamesAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetTeamColorsAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetTeamColorsAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetTeamLogoAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,Nhl-Api-Models-Team-TeamLogoType,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetTeamLogoAsync-System-Int32,Nhl-Api-Models-Team-TeamLogoType,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL team identifier - Seattle Kraken: 55 |
| teamLogoType | [Nhl.Api.Models.Team.TeamLogoType](#T-Nhl-Api-Models-Team-TeamLogoType 'Nhl.Api.Models.Team.TeamLogoType') | The NHL team logo image type, based on the background of light or dark |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlLeagueApi-GetTeamProspectsByTeamAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetTeamProspectsByTeamAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-GetTeamRosterBySeasonYearAsync-System-Int32,System-String,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL team identifier, Example: 55 - Seattle Kraken |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The eight digit number format for the season, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information, Example: 20232024 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlLeagueApi-GetTeamRosterBySeasonYearAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,System-Threading-CancellationToken-'></a>
### 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](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') | The NHL team identifier, see [TeamEnum](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') for more information, Example: 9 - Ottawa Senators |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The eight digit number format for the season, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information, Example: 20232024 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlLeagueApi-GetTeamScheduleBySeasonAsync-System-String,System-String,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The required team abbreviation for the NHL team, Example: WSH - Washington |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The eight digit number format for the season, Example: 20232024 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlLeagueApi-GetTeamWeekScheduleByDateAsync-System-String,System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The required team abbreviation for the NHL team, Example: WSH - Washington |
| date | [System.DateOnly](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date in which the request schedule for the team and for the week is request for |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlLeagueApi-GetTvScheduleBroadcastByDateAsync-System-DateOnly,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateOnly 'System.DateOnly') | The date requested for the NHL TV broadcasts, Example: 2024-02-10 |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlLeagueApi-IsLeagueActiveAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-IsPlayoffSeasonActiveAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-IsPreSeasonActiveAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlLeagueApi-IsRegularSeasonActiveAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='T-Nhl-Api-NhlPlayerApi'></a>
## NhlPlayerApi `type`

##### Namespace

Nhl.Api

##### Summary

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

<a name='M-Nhl-Api-NhlPlayerApi-#ctor'></a>
### #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.

<a name='M-Nhl-Api-NhlPlayerApi-Dispose'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.NotImplementedException 'System.NotImplementedException') |  |

<a name='M-Nhl-Api-NhlPlayerApi-GetAllPlayersAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlPlayerApi-GetGoalieInformationAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | An NHL player id, Example: 8480313 - Logan Thompson |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlPlayerApi-GetGoalieInformationAsync-PlayerEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlPlayerApi-GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync-PlayerEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](#T-PlayerEnum 'PlayerEnum') | An NHL player id, Example: 8478402 - Connor McDavid, see [PlayerEnum](#T-PlayerEnum 'PlayerEnum') for more information on NHL players |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The season year parameter for determining the season for the season, [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for all available seasons |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlPlayerApi-GetGoalieSeasonGameLogsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | An NHL player id, Example: 8478402 - Connor McDavid |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The season year parameter for determining the season for the season, [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for all available seasons |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlPlayerApi-GetPlayerHeadshotImageAsync-PlayerEnum,Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlPlayerApi-GetPlayerHeadshotImageAsync-System-Int32,Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | An NHL player id, Example: 8478402 - Connor McDavid |
| playerHeadshotImageSize | [Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize](#T-Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize 'Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize') | The size of the head shot image, see [PlayerHeadshotImageSize](#T-Nhl-Api-Models-Enumerations-Player-PlayerHeadshotImageSize 'Nhl.Api.Models.Enumerations.Player.PlayerHeadshotImageSize') for more information |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlPlayerApi-GetPlayerInformationAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | An NHL player id, Example: 8478402 - Connor McDavid |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlPlayerApi-GetPlayerInformationAsync-PlayerEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlPlayerApi-GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync-PlayerEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](#T-PlayerEnum 'PlayerEnum') | An NHL player id, Example: 8478402 - Connor McDavid, see [PlayerEnum](#T-PlayerEnum 'PlayerEnum') for more information on NHL players |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The season year parameter for determining the season for the season, [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for all available seasons |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlPlayerApi-GetPlayerSeasonGameLogsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | An NHL player id, Example: 8478402 - Connor McDavid |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The season year parameter for determining the season for the season, [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for all available seasons |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlPlayerApi-GetPlayerSpotlightAsync-System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlPlayerApi-SearchAllActivePlayersAsync-System-String,System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlPlayerApi-SearchAllPlayersAsync-System-String,System-Int32,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | A search term to find NHL players, Example: "Jack Adams" or "Wayne Gretzky" or "Mats Sundin" |
| limit | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | A parameter to limit the number of search results returned when searching for a player |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='T-Nhl-Api-NhlStatisticsApi'></a>
## 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

<a name='M-Nhl-Api-NhlStatisticsApi-#ctor'></a>
### #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.

<a name='M-Nhl-Api-NhlStatisticsApi-GetAllTotalPlayerStatisticValueBySeasonAsync-PlayerEnum,System-String,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlStatisticsApi-GetAllTotalPlayerStatisticValueBySeasonAsync-System-Int32,System-String,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL season year to retrieve the team statistics, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token to cancel the asynchronous operation |

<a name='M-Nhl-Api-NhlStatisticsApi-GetGoalieStatisticsLeadersAsync-Nhl-Api-Enumerations-Statistic-GoalieStatisticsType,Nhl-Api-Enumerations-Game-GameType,System-String,System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlStatisticsApi-GetSkaterStatisticsLeadersAsync-Nhl-Api-Enumerations-Statistic-PlayerStatisticsType,Nhl-Api-Enumerations-Game-GameType,System-String,System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlStatisticsApi-GetTeamStatisticsBySeasonAndGameTypeAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') | The team enumeration identifier, specifying which the NHL team, [TeamEnum](#T-Nhl-Api-Models-Enumerations-Team-TeamEnum 'Nhl.Api.Models.Enumerations.Team.TeamEnum') for more information |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL season year to retrieve the team statistics, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') | The NHL game type to retrieve the team statistics, see [GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') for more information on valid game types |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlStatisticsApi-GetTeamStatisticsBySeasonAndGameTypeAsync-System-Int32,System-String,Nhl-Api-Enumerations-Game-GameType,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL team identifier, specifying which the NHL team, Example: 55 - Seattle Kraken |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL season year to retrieve the team statistics, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| gameType | [Nhl.Api.Enumerations.Game.GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') | The NHL game type to retrieve the team statistics, see [GameType](#T-Nhl-Api-Enumerations-Game-GameType 'Nhl.Api.Enumerations.Game.GameType') for more information on valid game types |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token that can be used by other objects or threads to receive notice of cancellation |

<a name='M-Nhl-Api-NhlStatisticsApi-GetTeamStatisticsBySeasonAsync-Nhl-Api-Models-Enumerations-Team-TeamEnum,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlStatisticsApi-GetTeamStatisticsBySeasonAsync-System-Int32,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlStatisticsApi-GetTotalPlayerStatisticValueByTypeAndSeasonAsync-PlayerEnum,Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic,System-String,System-Threading-CancellationToken-'></a>
### 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

<a name='M-Nhl-Api-NhlStatisticsApi-GetTotalPlayerStatisticValueByTypeAndSeasonAsync-System-Int32,Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic,System-String,System-Threading-CancellationToken-'></a>
### 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](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid |
| playerGameCenterStatistic | [Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic](#T-Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic 'Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic') | The NHL player game center statistic type, [PlayerGameCenterStatistic](#T-Nhl-Api-Enumerations-Statistic-PlayerGameCenterStatistic 'Nhl.Api.Enumerations.Statistic.PlayerGameCenterStatistic') for more information on valid game center statistics |
| seasonYear | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The NHL season year to retrieve the team statistics, see [SeasonYear](#T-Nhl-Api-Models-Season-SeasonYear 'Nhl.Api.Models.Season.SeasonYear') for more information on valid season years |
| cancellationToken | [System.Threading.CancellationToken](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Threading.CancellationToken 'System.Threading.CancellationToken') | A cancellation token to cancel the asynchronous operation |

Nhl.Api

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README