Skip to main content

Documenting the publicly accessible portions of the NHL API.

Project description

Nhl Python SDK 1.0.0

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

Versions

  • API version: 1.0.0
  • SDK version: 1.0.0

About the API

Documenting the publicly accessible portions of the NHL API.

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

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

pip install nhl-client

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
ConferencesService
DivisionsService
DraftService
GamesService
PlayersService
ScheduleService
StandingsService
StatsService
TeamsService

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:
Name Description
Conferences
Division
Divisions
Draft
DraftProspects
GameBoxscores
GameContent
Game
Players
PlayerStats
GetPlayerStatsStats
Schedule
GetScheduleExpand
Standings
GetStandingsByTypeType
StandingTypes
StatTypes
Teams
GetTeamsExpand
Team
Rosters
TeamStats
Conference
ConferenceName
Abbreviation
ShortName
DivisionConference
Drafts
Rounds
Picks
PicksTeam
Prospect
DraftProspect
DraftProspectPrimaryPosition
ProspectCategory
AmateurTeam
AmateurLeague
GameBoxscoresTeams
GameOfficial
GameBoxscoreTeam
GameBoxscoreTeamTeam
GameBoxscoreTeamTeamStats
GameBoxscoreTeamPlayers
OnIcePlus
Coaches
TeamSkaterStats
PlayersPerson
PlayersPosition
PlayersStats
SkaterStats
CoachesPerson
CoachesPosition
Official
OfficialType
Editorial
GameContentMedia
Highlights
GameEditorials
GameEditorial
TokenData
Contributor
GameEditorialKeyword
GameEditorialMedia
TokenDataType
Contributors
GameEditorialKeywordType
Photo
Cuts
Milestones
Title
Items
ItemsType
GameHighlight
GameHighlightType_1
Playbacks
PlaybacksName
GameHighlights
GameHighlightsGameCenter_2
MetaData
GameData
LiveData
GameDataGame
Datetime
GameDataStatus
GameDataTeams
Player
GameDataVenue
Venue
TeamDivision
TeamConference
Franchise
TeamRoster
NextGameSchedule
TimeZone
Roster
RosterPerson
RosterPosition
Dates
Games
GamesStatus
GamesTeams
GamesVenue
GamesContent
AbstractGameState
CodedGameState
DetailedState
StatusCode
TeamsAway_1
TeamsHome_1
AwayLeagueRecord_1
AwayTeam_1
HomeLeagueRecord_1
HomeTeam_1
ShootsCatches
CurrentTeam
PlayerPrimaryPosition
Plays
GameLinescore
GameBoxscore
Decisions
GamePlay
PlaysByPeriod
GamePlayPlayers
Result
About
Coordinates
GamePlayTeam
PlayersPlayer
Goals
GamePeriod
ShootoutInfo
GameLinescoreTeams
IntermissionInfo
PowerPlayInfo
GamePeriodHome
GamePeriodAway
ShootoutInfoAway
ShootoutInfoHome
GameLinescoreTeam
GameLinescoreTeamTeam
GameBoxscoreTeams
GameDecisionPlayer
PlayerStatsStats
StatsType_1
StatsSplits_1
TypeDisplayName
SplitsStat_1
Opponent
OpponentDivision
OpponentConference
ScheduleDay
ScheduleGame
ScheduleGameStatus
ScheduleGameTeams
ScheduleGameVenue
Tickets
ScheduleGameContent
TeamsAway_2
TeamsHome_2
AwayLeagueRecord_2
AwayTeam_2
HomeLeagueRecord_2
HomeTeam_2
TicketType
Records
StandingsType
League
RecordsDivision
RecordsConference
TeamRecords
TeamRecordsTeam
TeamRecordsLeagueRecord
Streak
StatTypesDisplayName
TeamStatsStats
StatsType_2
StatsSplits_2
SplitsStat_2
SplitsTeam

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nhl-client-1.0.0.tar.gz (50.3 kB view details)

Uploaded Source

Built Distribution

nhl_client-1.0.0-py3-none-any.whl (83.4 kB view details)

Uploaded Python 3

File details

Details for the file nhl-client-1.0.0.tar.gz.

File metadata

  • Download URL: nhl-client-1.0.0.tar.gz
  • Upload date:
  • Size: 50.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for nhl-client-1.0.0.tar.gz
Algorithm Hash digest
SHA256 cb86bad7154658ae91f806850945274931aaef627a8bcc58858f7b67ba475b90
MD5 a57694350a827f6cbba3af0284bb4673
BLAKE2b-256 5d13512c23f99c51e5bcf79b2e853999f7a2230872c9910353745026e6ff8e1d

See more details on using hashes here.

File details

Details for the file nhl_client-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: nhl_client-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 83.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for nhl_client-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cf814be2335ad19a5cab66a6aa360eb179ef9c3808cc6fb98f6b81606ccb0bb8
MD5 521c0da9aef5e22f9ab66481eda4ce74
BLAKE2b-256 ee8a43631f9522067132a152278150e8182f051eee72a0d4fc5a91167e1dcbe7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page