PWHL — additional Python functions

Hand-written wrappers, loaders, and helpers in sportsdataverse.pwhl not covered by the generated API-endpoint reference above.

Dataset loaders

load_pwhl_games(return_as_pandas: 'bool' = False)

Load the PWHL games-in-data-repo manifest (no seasons argument).

Mirrors fastRhockey (R) load_pwhl_games() which reads a manifest of every PWHL game that has processed data in the data repository.

Tries the sportsdataverse-data release asset first; falls back to the raw fastRhockey-data GitHub path.

Parameters

Parameter	Type	Default	Description
return_as_pandas	bool	False	return a pandas DataFrame instead of polars.

Returns

A polars (or pandas) DataFrame of all games in the data repository.

col_name	type	description
game_id	character	Unique game identifier.
season	integer	Season year (echoed from arg).
game_date	character	Game date.
game_status	character	Game status text.
home_team	character	Home team name.
home_team_id	character	Home team identifier.
away_team	character	Away team name.
away_team_id	character	Away team identifier.
home_score	character	Home team final score.
away_score	character	Away team final score.
winner	character	Whether this competitor won the game.
venue	character	Venue where the game was played.
venue_url	character	URL for the venue.
game_type	character	Game type the row belongs to.
game_json	logical	Whether processed game JSON is available.
game_json_url	character	URL to the processed game JSON.
PBP	logical	Whether play-by-play data is available.
player_box	logical	Whether player box score data is available.
skater_box	logical	Whether skater box data is available.
goalie_box	logical	Whether goalie box data is available.
team_box	logical	Whether team box score data is available.
game_info	logical	Whether game info data is available.
game_rosters	logical	Whether game rosters data is available.
scoring_summary	logical	Whether scoring summary data is available.
penalty_summary	logical	Whether penalty summary data is available.
three_stars	logical	Whether three stars data is available.
officials	logical	Whether officials data is available.
shots_by_period	logical	Whether shots-by-period data is available.
shootout	logical	Whether shootout data is available.

Example

>>> load_pwhl_games()

load_pwhl_goalie_box(seasons, return_as_pandas: 'bool' = False)

Alias of load_pwhl_goalie_boxscores() for naming parity with fastRhockey (R).

Parameters

Parameter	Type	Default	Description
seasons
return_as_pandas	bool	False

load_pwhl_player_box(seasons, return_as_pandas: 'bool' = False)

Alias of load_pwhl_player_boxscores() for naming parity with fastRhockey (R).

Parameters

Parameter	Type	Default	Description
seasons
return_as_pandas	bool	False

load_pwhl_schedule(seasons, return_as_pandas: 'bool' = False)

Alias of load_pwhl_schedules() for naming parity with fastRhockey (R).

Parameters

Parameter	Type	Default	Description
seasons
return_as_pandas	bool	False

load_pwhl_skater_box(seasons, return_as_pandas: 'bool' = False)

Alias of load_pwhl_skater_boxscores() for naming parity with fastRhockey (R).

Parameters

Parameter	Type	Default	Description
seasons
return_as_pandas	bool	False

load_pwhl_team_box(seasons, return_as_pandas: 'bool' = False)

Alias of load_pwhl_team_boxscores() for naming parity with fastRhockey (R).

Parameters

Parameter	Type	Default	Description
seasons
return_as_pandas	bool	False

Utilities & helpers

most_recent_pwhl_season() -> 'int'

Most-recent PWHL season as an end-year integer (max season_yr).

Other

pwhl_game_corsi(game_id: 'int', return_as_pandas: 'bool' = False) -> "'Union[pl.DataFrame, pd.DataFrame]'"

Player-level on-ice Corsi and Fenwick for a single PWHL game.

Computes shot-attempt counts for every player found on ice during a shot/blocked_shot/goal event, then joins their time-on-ice so per-60 rates are available.

Corsi/Fenwick note: the HockeyTech feed has no missed-shot event, so both metrics are proxies that count only shot + blocked_shot + goal. Every output row carries corsi_includes_missed = False.

Parameters

Parameter	Type	Default	Description
game_id	int		HockeyTech game identifier (integer or string).
return_as_pandas	bool	False	If True, return a pandas.DataFrame instead of a polars.DataFrame.

Returns

One row per on-ice player with columns: - player_id (Utf8) - corsi_for, corsi_against (Int64) - corsi_for_pct (Float64) - fenwick_for, fenwick_against (Int64) - fenwick_for_pct (Float64) - toi_seconds (Int64, from shifts; null if player not in shift data) - corsi_for_per60 (Float64) - corsi_includes_missed (Boolean, always False)

col_name	type	description
player_id	character	Unique player identifier.
corsi_for	integer
corsi_against	integer
corsi_for_pct	double
fenwick_for	integer
fenwick_against	integer
fenwick_for_pct	double
corsi_includes_missed	logical
toi_seconds	double
corsi_for_per60	double

pwhl_game_shifts(game_id: 'int', return_as_pandas: 'bool' = False) -> "'Union[pl.DataFrame, pd.DataFrame]'"

Parsed shift stints for a single PWHL game.

Calls the HockeyTech modulekit/gameshifts endpoint and returns one row per player-shift stint via ~sportsdataverse.hockeytech._parsers.parse_shifts.

Parameters

Parameter	Type	Default	Description
game_id	int		HockeyTech game identifier (integer or string).
return_as_pandas	bool	False	If True, return a pandas.DataFrame instead of a polars.DataFrame.

Returns

Columns include player_id, first_name, last_name, home, period, start_time, end_time, start_s, end_s, goal_on_shift, penalty_on_shift.

col_name	type	description
game_id	integer	Unique game identifier.
player_id	integer	Unique player identifier.
first_name	character	Player first name.
last_name	character	Player last name.
jersey_number	character	Jersey number.
home	integer	Whether the player's team was home.
period	integer	Period number.
start_time	character	Start time (local).
end_time	character	End time (local).
length	character	Length of the streak in games.
start_s	integer
end_s	double
goal_on_shift	integer
penalty_on_shift	integer

pwhl_game_summary(game_id: 'int') -> 'dict'

PWHL game summary — dict of frames (game/goals/penalties/shots_by_period/three_stars).

Parameters

Parameter	Type	Default	Description
game_id	int

pwhl_leaders(season: 'Optional[int]' = None, season_id: 'Optional[int]' = None, return_as_pandas: 'bool' = False) -> 'Any'

PWHL statistical leaders for a given season.

NOTE: the leadersExtended endpoint uses season_id (integer) to filter by season, not season (name string). The resolved integer is passed as the season_id param so historical-season requests return results.

Parameters

Parameter	Type	Default	Description
season	Optional[int]	None
season_id	Optional[int]	None
return_as_pandas	bool	False

Returns

col_name	type	description
rank	integer	Rank of the streak.
player_id	character	Unique player identifier.
jersey_number	character	Jersey number.
name	character	Team mascot name.
team_id	character	Unique team identifier.
team_name	character	Team name.
team_code	character	Team abbreviation.
team_logo	character	URL to the team logo image.
team_logo_small	character
stat_formatted	character
type_formatted	character
photo	character	URL to the player photo.
photo_small	character
position	character	Player position.
division	character	Division identifier.

pwhl_player_box(game_id: 'int', return_as_pandas: 'bool' = False) -> 'Any'

PWHL player box score for a single game.

NOTE: returns an empty frame pending a captured fixture + correct endpoint wiring (A1.8 follow-up); not yet functional.

Parameters

Parameter	Type	Default	Description
game_id	int
return_as_pandas	bool	False

pwhl_player_game_log(player_id: 'int', return_as_pandas: 'bool' = False) -> 'Any'

PWHL player game-by-game log.

Parameters

Parameter	Type	Default	Description
player_id	int
return_as_pandas	bool	False

pwhl_player_info(player_id: 'int', return_as_pandas: 'bool' = False) -> 'Any'

PWHL player biographical info.

NOTE: returns an empty frame pending a captured fixture + correct endpoint wiring (A1.8 follow-up); not yet functional.

Parameters

Parameter	Type	Default	Description
player_id	int
return_as_pandas	bool	False

pwhl_player_search(name: 'str', return_as_pandas: 'bool' = False) -> 'Any'

Search for PWHL players by name.

Parameters

Parameter	Type	Default	Description
name	str
return_as_pandas	bool	False

Returns

col_name	type	description
person_id	character	Unique person identifier.
player_id	character	Unique player identifier.
active	character	Whether athlete is currently active.
first_name	character	Player first name.
last_name	character	Player last name.
phonetic_name	character	Phonetic spelling of the player name.
shoots	character	Shooting hand.
catches	character	Catching hand (goalies).
height	character	Player height in inches.
weight	character	Player weight in pounds.
rawbirthdate	character
birthdate	character	Date of birth.
birthtown	character	Player birth town.
birthprov	character	Player birth province/state.
birthcntry	character	Player birth country.
team_id	character	Unique team identifier.
jersey_number	character	Jersey number.
role_id	character
season_id	character	Season identifier.
role_name	character
all_roles	character
last_team_name	character
last_team_code	character
division	character	Division identifier.
position	character	Player position.
profile_image	character
score	character	Final score string.
last_active_date	character

pwhl_player_stats(player_id: 'int', return_as_pandas: 'bool' = False) -> 'Any'

PWHL player season stats across all seasons.

Parameters

Parameter	Type	Default	Description
player_id	int
return_as_pandas	bool	False

Returns

col_name	type	description
season_id	character	Season identifier.
season_name	character	Full season name (e.g., "2024-25 Regular Season").
shortname	character	Player short name.
playoff	character	Whether the row is playoff statistics.
career	character	Whether this is a career-stats season.
sopt_track_faceoffs	character
max_start_date	character	Latest game start date for the season.
veteran_status	character	Player veteran status.
veteran	character	Whether the player is a veteran.
jersey_number	character	Jersey number.
goals	character	Goals scored.
games_played	character	Games played.
assists	character	Assists.
points	character	Total points (goals + assists).
plus_minus	character	Plus/minus rating.
penalty_minutes	character	Penalty minutes.
power_play_goals	character	Power-play goals.
power_play_assists	character	Power-play assists.
shots	character	Shots on goal.
shootout_attempts	character	Shootout attempts.
shootout_goals	character	Shootout goals.
shootout_percentage	character	Shootout scoring percentage.
shooting_percentage	character	Shooting percentage.
shootout_winning_goals	character	Shootout game-winning goals.
points_per_game	character	Points per game.
short_handed_goals	character	Short-handed goals.
short_handed_assists	character	Short-handed assists.
game_winning_goals	character	Game-winning goals.
game_tieing_goals	character	Game-tying goals.
faceoff_wins	character	Faceoff wins.
faceoff_attempts	character	Faceoff attempts.
faceoff_pct	character	Faceoff win percentage.
hits	character	Hits.
team_name	character	Team name.
team_code	character	Team abbreviation.
team_city	character	Team city.
team_nickname	character	Team nickname.
team_id	character	Unique team identifier.
active	character	Whether athlete is currently active.
first_goals	character	First goals of a game.
insurance_goals	character	Insurance goals.
overtime_goals	character	Overtime goals.
unassisted_goals	character	Unassisted goals.
empty_net_goals	character	Empty-net goals.
penalty_minutes_per_game	character	Penalty minutes per game.
division	character	Division identifier.
ice_time	character	Total ice time.
ice_time_minutes_seconds	character	Ice time in minutes and seconds.
shots_blocked_by_player	character	Shots blocked by the player.
stat_type	character	Statistic type ("regular"/"playoff").

pwhl_player_toi(game_id: 'int', return_as_pandas: 'bool' = False) -> "'Union[pl.DataFrame, pd.DataFrame]'"

Per-player time-on-ice totals for a single PWHL game.

Fetches shifts via pwhl_game_shifts then aggregates via ~sportsdataverse.hockeytech._analytics.player_toi.

Parameters

Parameter	Type	Default	Description
game_id	int		HockeyTech game identifier (integer or string).
return_as_pandas	bool	False	If True, return a pandas.DataFrame instead of a polars.DataFrame.

Returns

One row per player with player_id, first_name, last_name, toi_seconds, num_shifts, avg_shift_s, sorted by toi_seconds descending.

col_name	type	description
player_id	integer	Unique player identifier.
first_name	character	Player first name.
last_name	character	Player last name.
toi_seconds	double
num_shifts	integer
avg_shift_s	double

pwhl_playoff_bracket(season: 'Optional[int]' = None, season_id: 'Optional[int]' = None, return_as_pandas: 'bool' = False) -> 'Any'

PWHL playoff bracket for a given season.

Parameters

Parameter	Type	Default	Description
season	Optional[int]	None
season_id	Optional[int]	None
return_as_pandas	bool	False

pwhl_schedule(season: 'Optional[int]' = None, season_id: 'Optional[int]' = None, return_as_pandas: 'bool' = False) -> 'Any'

PWHL schedule — one row per game (matches fastRhockey pwhl_schedule).

Parameters

Parameter	Type	Default	Description
season	Optional[int]	None
season_id	Optional[int]	None
return_as_pandas	bool	False

Returns

col_name	type	description
game_id	character	Unique game identifier.
game_date	character	Game date.
game_status	character	Game status text.
home_team	character	Home team name.
home_team_id	character	Home team identifier.
home_score	character	Home team final score.
away_team	character	Away team name.
away_team_id	character	Away team identifier.
away_score	character	Away team final score.
venue	character	Venue where the game was played.
season_id	character	Season identifier.
game_type	character	Game type the row belongs to.

pwhl_scorebar(return_as_pandas: 'bool' = False) -> 'Any'

PWHL live scorebar (today ± 3 days).

Parameters

Parameter	Type	Default	Description
return_as_pandas	bool	False

Returns

col_name	type	description
id	character	Unique player identifier.
season_id	character	Season identifier.
league_id	character	League identifier of the team.
game_number	character	Game number within the schedule.
game_letter	character
game_type	character	Game type the row belongs to.
quick_score	character
date	character	Game date (ISO 8601 datetime string).
flo_core_event_id	character
flo_live_event_id	character
game_date	character	Game date.
game_date_iso8601	character
scheduled_time	character
scheduled_formatted_time	character
timezone	character	Time zone of the transaction.
ticket_url	character
home_id	character	Home team ESPN identifier.
home_code	character
home_city	character	Hometown of the athlete.
home_nickname	character
home_long_name	character
home_division	character	Home team division.
home_goals	character	Home goals in the period.
home_audio_url	character
home_video_url	character
home_webcast_url	character
visitor_id	character
visitor_code	character
visitor_city	character
visitor_nickname	character
visitor_long_name	character
visiting_division	character	Visiting team division.
visitor_goals	character
visitor_audio_url	character
visitor_video_url	character
visitor_webcast_url	character
period	character	Period number.
period_name_short	character
period_name_long	character
game_clock	character	Game clock.
game_summary_url	character
home_wins	character	Wins at home.
home_regulation_losses	character
home_ot_losses	character	Home overtime losses.
home_shootout_losses	character
visitor_wins	character
visitor_regulation_losses	character
visitor_ot_losses	character
visitor_shootout_losses	character
game_status	character	Game status text.
intermission	character
game_status_string	character
game_status_string_long	character
ord	character
venue_name	character	Name of the venue.
venue_location	character
league_name	character	League name.
league_code	character
timezone_short	character
home_logo	character	Home team logo URL.
visitor_logo	character
flo_hockey_url	character
combined_client_code	character

pwhl_season_id(return_as_pandas: 'bool' = False) -> 'Any'

All PWHL seasons with end-year + game-type labels (HockeyTech seasons).

Parameters

Parameter	Type	Default	Description
return_as_pandas	bool	False

Returns

col_name	type	description
season_id	integer	Season identifier.
season_name	character	Full season name (e.g., "2024-25 Regular Season").
season_short	character	Short season name.
career	character	Whether this is a career-stats season.
playoff	character	Whether the row is playoff statistics.
start_date	character	Season start date.
end_date	character	Season end date.
season_yr	integer	Year derived from the season name (concluding year).
game_type_label	character	Game type: "preseason", "regular", or "playoffs".

pwhl_standings(season: 'Optional[int]' = None, season_id: 'Optional[int]' = None, return_as_pandas: 'bool' = False) -> 'Any'

PWHL standings — one row per team.

Parameters

Parameter	Type	Default	Description
season	Optional[int]	None
season_id	Optional[int]	None
return_as_pandas	bool	False

Returns

col_name	type	description
team_code	character	Team abbreviation.
losses	character	Losses.
regulation_wins	character	Wins in regulation.
points	character	Total points (goals + assists).
goals_for	character	Goals for.
goals_against	character	Goals against.
non_reg_wins	character	Non-regulation wins.
non_reg_losses	character	Non-regulation losses.
games_remaining	character	Games remaining in the season.
percentage	character
overall_rank	character	Overall recruit ranking (top recruits only; may be NA).
games_played	character	Games played.
team_rank	integer	Team rank in the standings.
team	character	Team name.
wins	integer	Wins.

pwhl_stats(season: 'Optional[int]' = None, season_id: 'Optional[int]' = None, position: 'str' = 'skaters', return_as_pandas: 'bool' = False) -> 'Any'

PWHL aggregate stats by season and position.

Parameters

Parameter	Type	Default	Description
season	Optional[int]	None
season_id	Optional[int]	None
position	str	'skaters'
return_as_pandas	bool	False

Returns

col_name	type	description
player_id	character	Unique player identifier.
shortname	character	Player short name.
first_name	character	Player first name.
last_name	character	Player last name.
name	character	Team mascot name.
phonetic_name	character	Phonetic spelling of the player name.
active	character	Whether athlete is currently active.
height	character	Player height in inches.
weight	character	Player weight in pounds.
last_years_club	character	Player's club in the previous season.
age	character	Player age.
shoots	character	Shooting hand.
position	character	Player position.
suspension_games_remaining	character	Suspension games remaining.
suspension_indefinite	character	Whether the suspension is indefinite.
rookie	character	Whether the player is a rookie.
veteran	character	Whether the player is a veteran.
draft_eligible	character	Whether the player is draft eligible.
jersey_number	character	Jersey number.
team_name	character	Team name.
team_code	character	Team abbreviation.
team_id	character	Unique team identifier.
division	character	Division identifier.
birthdate	character	Date of birth.
birthdate_year	character	Player birth year.
hometown	character	Prospect hometown.
homeprov	character	Player home province/state.
homecntry	character	Player home country.
birthtown	character	Player birth town.
birthprov	character	Player birth province/state.
birthcntry	character	Player birth country.
hometownprov	character	Player hometown and province/state.
homeplace	character	Player home place description.
games_played	character	Games played.
game_winning_goals	character	Game-winning goals.
game_tieing_goals	character	Game-tying goals.
first_goals	character	First goals of a game.
insurance_goals	character	Insurance goals.
unassisted_goals	character	Unassisted goals.
empty_net_goals	character	Empty-net goals.
overtime_goals	character	Overtime goals.
ice_time	character	Total ice time.
ice_time_avg	character	Average ice time.
goals	character	Goals scored.
shots	character	Shots on goal.
loose_ball_recoveries	character	Loose ball recoveries.
caused_turnovers	character	Turnovers caused.
turnovers	character	Turnovers committed.
hits	character	Hits.
shots_blocked_by_player	character	Shots blocked by the player.
ice_time_minutes_seconds	character	Ice time in minutes and seconds.
shooting_percentage	character	Shooting percentage.
assists	character	Assists.
points	character	Total points (goals + assists).
points_per_game	character	Points per game.
plus_minus	character	Plus/minus rating.
penalty_minutes	character	Penalty minutes.
penalty_minutes_per_game	character	Penalty minutes per game.
ice_time_per_game_avg	character	Average ice time per game.
hits_per_game_avg	character	Average hits per game.
minor_penalties	character	Minor penalties.
major_penalties	character	Major penalties.
power_play_goals	character	Power-play goals.
power_play_assists	character	Power-play assists.
power_play_points	character	Power play points.
short_handed_goals	character	Short-handed goals.
short_handed_assists	character	Short-handed assists.
short_handed_points	character	Short-handed points.
shootout_goals	character	Shootout goals.
shootout_attempts	character	Shootout attempts.
shootout_winning_goals	character	Shootout game-winning goals.
shootout_games_played	character	Games played that went to a shootout.
faceoff_attempts	character	Faceoff attempts.
faceoff_wins	character	Faceoff wins.
faceoff_pct	character	Faceoff win percentage.
faceoff_wa	character	Faceoff wins-to-attempts metric.
shots_on	character	Shots on goal count.
shootout_percentage	character	Shootout scoring percentage.
latest_team_id	character	Most recent team identifier.
num_teams	character	Number of teams the player has played for.
logo	character	URL to the team logo.
rank	integer	Rank of the streak.
player_page_link	character	URL to the player page.
player_image	character
namelink	character	HTML link for the player name.
teamlink	character	HTML link for the team.
team_breakdown	integer	Per-team statistical breakdown.
is_total	double	Whether the row is a season total.

pwhl_streaks(return_as_pandas: 'bool' = False) -> 'Any'

Current PWHL player/team streaks.

Parameters

Parameter	Type	Default	Description
return_as_pandas	bool	False

pwhl_team_roster(team_id: 'int', season: 'Optional[int]' = None, season_id: 'Optional[int]' = None, return_as_pandas: 'bool' = False) -> 'Any'

PWHL team roster for a given team + season.

Parameters

Parameter	Type	Default	Description
team_id	int
season	Optional[int]	None
season_id	Optional[int]	None
return_as_pandas	bool	False

Returns

col_name	type	description
id	character	Unique player identifier.
person_id	character	Unique person identifier.
active	character	Whether athlete is currently active.
first_name	character	Player first name.
last_name	character	Player last name.
phonetic_name	character	Phonetic spelling of the player name.
display_name	character	Player display name.
shoots	character	Shooting hand.
hometown	character	Prospect hometown.
homeprov	character	Player home province/state.
homecntry	character	Player home country.
homeplace	character	Player home place description.
birthtown	character	Player birth town.
birthprov	character	Player birth province/state.
birthcntry	character	Player birth country.
birthplace	character
height	character	Player height in inches.
weight	character	Player weight in pounds.
height_hyphenated	character
hidden	character
current_team	character
player_id	character	Unique player identifier.
status	character	Status string (e.g. captain markers).
birthdate	character	Date of birth.
birthdate_year	character	Player birth year.
rawbirthdate	character
latest_team_id	character	Most recent team identifier.
veteran_status	character	Player veteran status.
veteran_description	character
team_name	character	Team name.
division	character	Division identifier.
tp_jersey_number	character
rookie	character	Whether the player is a rookie.
position_id	character	Official position identifier.
position	character	Player position.
nhlteam	character
player_id_1	character
is_rookie	character	Whether the player is a rookie.
h	character	Hits.
w	character	Wins.
draft_status	character
name	character	Team mascot name.
player_image	character
catches	character	Catching hand (goalies).

pwhl_teams(season: 'Optional[int]' = None, season_id: 'Optional[int]' = None, return_as_pandas: 'bool' = False) -> 'Any'

PWHL teams for a given season.

Parameters

Parameter	Type	Default	Description
season	Optional[int]	None
season_id	Optional[int]	None
return_as_pandas	bool	False

Returns

col_name	type	description
team_name	character	Team name.
team_id	character	Unique team identifier.
team_code	character	Team abbreviation.
team_nickname	character	Team nickname.
team_label	character	Short city label.
division	character	Division identifier.
team_logo	character	URL to the team logo image.

pwhl_transactions(return_as_pandas: 'bool' = False) -> 'Any'

PWHL roster transactions.

Parameters

Parameter	Type	Default	Description
return_as_pandas	bool	False