Skip to main content

NHL — NHL Records API — Draft

nhl_records_draft​

Retrieve NHL Entry Draft picks.

Endpoint URL: GET https://records.nhl.com/site/api/draft/{draft_id}

Valid URL: https://records.nhl.com/site/api/draft

API ParameterPythonPatternRequiredNullableDescription
draft_iddraft_idYdraft_id path parameter.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
idintegerUnique player identifier.
age_in_dayscharacterPlayer age in days.
age_in_days_for_yearcharacterPlayer age in days for the draft year.
age_in_yearscharacterPlayer age in years.
amateur_club_namecharacterAmateur club the player played for.
amateur_leaguecharacterAmateur league the player played in.
birth_datecharacterPlayer birth date.
birth_placecharacterPlayer birth place.
country_codecharacterPlayer country code.
cs_player_idcharacterCentral Scouting player identifier.
draft_datecharacterDate the player was drafted.
draft_master_idintegerDraft master record identifier.
draft_yearintegerDraft year the lottery applies to.
drafted_by_team_idcharacterIdentifier of the drafting team.
first_namecharacterPlayer first name.
heightcharacterPlayer height in inches.
last_namecharacterPlayer last name.
notescharacterNotes flag for the pick.
overall_pick_numberintegerOverall pick number in the draft.
pick_in_roundintegerPick number within the round.
player_idcharacterUnique player identifier.
player_namecharacterPlayer name.
positioncharacterPlayer position.
removed_outrightcharacterRemoved-outright indicator.
removed_outright_whycharacterReason the pick was removed outright.
round_numberintegerDraft round number.
shoots_catchescharacterHandedness (shoots/catches).
supplemental_draftcharacterSupplemental draft indicator.
team_pick_historycharacterHistory of the team's picks at this slot.
tri_codecharacterTeam three-letter code.
weightcharacterPlayer weight in pounds.

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
NoDataErrorThe host answered 404 -- the requested resource does not exist.
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nhl_records_draft()

Last validated n/a.

nhl_records_draft_by_team​

All draft picks made by a single team.

Endpoint URL: GET https://records.nhl.com/site/api/draft/byTeam/{team_id}

Valid URL: https://records.nhl.com/site/api/draft/byTeam/10

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
idintegerUnique player identifier.
age_in_daysintegerPlayer age in days.
age_in_days_for_yearintegerPlayer age in days for the draft year.
age_in_yearsintegerPlayer age in years.
amateur_club_namecharacterAmateur club the player played for.
amateur_leaguecharacterAmateur league the player played in.
birth_datecharacterPlayer birth date.
birth_placecharacterPlayer birth place.
country_codecharacterPlayer country code.
cs_player_idcharacterCentral Scouting player identifier.
draft_datecharacterDate the player was drafted.
draft_master_idintegerDraft master record identifier.
draft_yearintegerDraft year the lottery applies to.
drafted_by_team_idintegerIdentifier of the drafting team.
first_namecharacterPlayer first name.
heightdoublePlayer height in inches.
last_namecharacterPlayer last name.
notescharacterNotes flag for the pick.
overall_pick_numberintegerOverall pick number in the draft.
pick_in_roundintegerPick number within the round.
player_idcharacterUnique player identifier.
player_namecharacterPlayer name.
positioncharacterPlayer position.
removed_outrightcharacterRemoved-outright indicator.
removed_outright_whycharacterReason the pick was removed outright.
round_numberintegerDraft round number.
shoots_catchescharacterHandedness (shoots/catches).
supplemental_draftcharacterSupplemental draft indicator.
team_pick_historycharacterHistory of the team's picks at this slot.
tri_codecharacterTeam three-letter code.
weightdoublePlayer weight in pounds.

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
NoDataErrorThe host answered 404 -- the requested resource does not exist.
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nhl_records_draft_by_team(team_id=10)

Last validated n/a.

nhl_records_draft_prospect​

Draft prospect records.

Endpoint URL: GET https://records.nhl.com/site/api/draft-prospect/{prospect_id}

Valid URL: https://records.nhl.com/site/api/draft-prospect

API ParameterPythonPatternRequiredNullableDescription
prospect_idprospect_idYprospect_id path parameter.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
idintegerUnique player identifier.
birth_citycharacterBirth city.
birth_country3codecharacterProspect birth country three-letter code.
birth_datecharacterPlayer birth date.
birth_state_prov_codecharacterProspect birth state/province code.
category_idintegerProspect category identifier.
created_oncharacterDate the trophy record was created.
cs_player_idintegerCentral Scouting player identifier.
draft_status_codecharacterDraft eligibility status code.
ep_player_idintegerEliteProspects player identifier.
first_namecharacterPlayer first name.
headshot_idintegerHeadshot image identifier.
heightintegerPlayer height in inches.
hometowncharacterProspect hometown.
last_club_namecharacterMost recent club name.
last_league_abbrcharacterMost recent league abbreviation.
last_namecharacterPlayer last name.
nationality_codecharacterNationality code of the official.
news_articlescharacterAssociated news articles.
playeridintegerUnique player identifier.
position_desccharacterPlayer position description.
profilecharacterProspect profile text.
quotescharacterQuotes about the prospect.
scouting_reportcharacterScouting report text.
shoots_catchescharacterHandedness (shoots/catches).
stats_textcharacterStatistical summary text.
videocharacterAssociated video content.
weightintegerPlayer weight in pounds.

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
NoDataErrorThe host answered 404 -- the requested resource does not exist.
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nhl_records_draft_prospect()

Last validated n/a.

nhl_records_draft_lottery_odds​

Draft lottery odds (current year or filtered by season).

Endpoint URL: GET https://records.nhl.com/site/api/draft-lottery-odds

Valid URL: https://records.nhl.com/site/api/draft-lottery-odds

API ParameterPythonPatternRequiredNullableDescription

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
idintegerUnique player identifier.
draft_yearintegerDraft year the lottery applies to.
format_contentcharacterDescription of the lottery format.
odds_contentcharacterDescription of the lottery odds.
result_notescharacterNotes on the lottery results.

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
NoDataErrorThe host answered 404 -- the requested resource does not exist.
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nhl_records_draft_lottery_odds()

Last validated n/a.