NHL API. For standings, team stats, outcomes, player information. Contains each individual API endpoint as well as convience methods for easy data loading in Pandas or any ML applications.
Project description
NHL-API-PY
NHL-api-py is a Python package that provides a simple wrapper around the NHL API, allowing you to easily access and retrieve NHL data in your Python applications.
Note: This is very early, I created this to help me with some machine learning projects around the NHL and the NHL data sets. Special thanks to https://github.com/erunion/sport-api-specifications/tree/master/nhl and https://gitlab.com/dword4/nhlapi/-/blob/master/stats-api.md.
Example Notebook:
An example Collab notebook can be found here at coreyjs/nhl-api-py-examples.
Installation
You can install NHL-py-api using pip:
pip install nhl-api-py
Usage
from nhlpy import NHLClient
client = NHLClient()
Available methods:
client.teams.all()
client.teams.get_by_id(id=1, roster=False)
client.teams.get_team_next_game(id=1)
client.teams.get_team_previous_game(id=1)
client.teams.get_team_stats(id=1)
# Standings
client.standings.get_standings(season="20222023", detailed_record=False)
client.standings.get_standing_types()
# Player Stats
client.players.get_player_stats(person_id=8477949, season="20222023", stat_type="statsSingleSeason")
client.players.get_player_stats(person_id=8477949, season="20222023", stat_type="goalsByGameSituation")
client.players.get_player_stats(person_id=8477949, season="20222023", stat_type="yearByYear")
# Schedule
client.schedule.get_schedule(season="20222023")
# Games
client.games.get_game_types()
client.games.get_game_play_types()
client.games.get_game_status_codes()
client.games.get_game_live_feed(game_id=2020020001)
client.games.get_game_live_feed_diff_after_timestamp(game_id=2020020001, timestamp=1633070400)
client.games.get_game_boxscore(game_id=2020020001)
client.games.get_game_linescore(game_id=2020020001)
client.games.get_game_content(game_id=2020020001)
# Players
client.players.get_player(person_id=8477949)
client.players.get_player_stats(person_id=8477949, season="20222023", stat_type="statsSingleSeason")
client.players.get_player_stat_types()
# Helpers - Common use cases, data extraction, etc. For easier dataframe initialization.
# These return data that has been parsed
# out, with some additional calculations as well.
standings_list = nhl_client.helpers.league_standings(season="20222023")
standings_df = pd.DataFrame(standings_list)
standings_df.head(20)
game_results = nhl_client.helpers.get_all_game_results(season="20222023", detailed_game_data=True, game_type="R", team_ids=[7])
As mentioned at the top, I created a notebook to go over some of the available methods in more detail. Below is an export md of that notebook, with out cell executions.
pip install nhl-api-py
from nhlpy import NHLClient
Getting Started - Create the NHLClient
client = NHLClient()
Team APIs
teams = client.teams.all()
teams
buffalo = client.teams.get_by_id(id=7)
buffalo
next_buffalo_game = client.teams.get_team_next_game(id=7)
next_buffalo_game
prev_buffalo_game = client.teams.get_team_previous_game(id=7)
prev_buffalo_game
buffalo_with_stats = client.teams.get_team_with_stats(id=7)
buffalo_with_stats
buffalo_roster = client.teams.get_team_roster(id=7)
buffalo_roster
buffalo_full_team_stats = client.teams.get_team_stats(id=7)
buffalo_full_team_stats
Standing APIs
# These can be used in conjunction with get_standings_by_standing_type
all_standing_types = client.standings.get_standing_types()
all_standing_types
# standings by season
all_standings = client.standings.get_standings(season="20222023", detailed_record=False)
all_standings
# same as above but with more detailed information
# standings by season
all_standings = client.standings.get_standings(season="20222023", detailed_record=True)
all_standings
# Get standings by type, types can be found via get_standings_by_type, or in the docstring
post_season = client.standings.get_standings_by_standing_type(standing_type="regularSeason")
post_season
Players
# APIs to access player information. Requires person_id, found from `teams.get_team_roster()`
jj = client.players.get_player(person_id=8482175)
jj
jj_stats = client.players.get_player_stats(person_id=8482175, season="20222023", stat_type="statsSingleSeason")
jj_stats
# Differnt stat types you can access
types = client.players.get_player_stat_types()
types
Developers
poetry install --with dev
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nhl_api_py-0.4.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 754baaa12eee4d3191a2c12b4a7429c01feaee5efe3b12c952ada801422d8be3 |
|
MD5 | 56169199c64725e0baf8011300fadc32 |
|
BLAKE2b-256 | 23b7e3008cd98b3473c2931d008d90af672b8219d7ab616ea85e9d6fb6f0acea |