README.md

NhlClient C# SDK 1.0.0

Welcome to the NhlClient SDK documentation. This guide will help you get started with integrating and using the NhlClient SDK in your project.

Versions

• API version: 1.0.0
• SDK version: 1.0.0

About the API

This section provides documentation for the NHL Web API. Based on the unofficial documentation https://github.com/Zmalski/NHL-API-Reference

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: C# >= .NET 6

Installation

To get started with the SDK, we recommend installing using nuget:

dotnet add package NhlClient

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

using NhlClient;
using NhlClient.Config;
using Environment = NhlClient.Http.Environment;

var config = new NhlClientConfig
{
  Environment = Environment.Default
};

var client = new NhlClientClient(config);

var response = await client.SkaterStats.GetCurrentSkaterStatsLeadersAsync("categories", 3);

Console.WriteLine(response);

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:

Name
PlayerService
SkaterStatsService
GoalieStatsService
PlayerSpotlightService
StandingsService
ClubStatsService
ScoreboardService
RosterService
ScheduleService

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.