The purpose of this package is to scrape data from ice hockey leagues, currently the NHL, from available APIs and websites. The information that is scraped is both play by play and shift data, with support for all parts of the seasons (preseason, regular season, all star and playoffs) for seasons starting from 2010-2011.
A short introduction to the prerequisites and installation.
This package is built on Python, particularly Python3. To use this package, the Python version should be at least 3.7.0.
To install, simply open a terminal and run either of the following commands:
pip install hockey_api
python -m pip install hockey_api
To scrape data, three different functions are provided. Each function provides the same output structure, with a tuple containing play by play data for all the game(s) as well as the shifts.
from hockey_api import scrape_list_of_games
# Scrape the first three games of the 2021-2022 NHL season.
pbp, shifts = scrape_list_of_games(game_id_list=[2021020001, 2021020002, 2021020003])
from hockey_api import scrape_date_range
# Scrape the all the games during the month of October in 2021.
pbp, shifts = scrape_date_range(start_date="2021-10-01", end_date="2021-10-31")
# Scrape games from a given date.
pbp, shifts = scrape_date_range(start_date="2021-10-31")
from hockey_api import scrape_season
# Scrape all games from the 2021-2022 NHL regular season.
pbp, shifts = scrape_season(season=2021, season_type="R")
# Scrape all games from the 2021-2022 NHL playoffs.
pbp_playoffs, shifts_playoffs = scrape_season(season=2021, season_type="P")
To save data to a local file the following command should do:
pbp.to_csv("desired/path/pbp.csv", index=False)
An additional scraper is also available, called get_player_data(), which
downloads metadata about all players in the NHL database. To use, simply run:
from hockey_api import get_player_data
# Scrape player data
players = get_player_data()
To get in contact with me send me an email at rasmus.safvenberg@gmail.com.
Copyright (C) 2022-2023 Rasmus Säfvenberg
This file is part of hockey_api
hockey_api is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.
FAQs
Scraper for ice hockey data
We found that hockey-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.