Skip to main content
Version: 0.1.5

NFL — additional Python functions — NFL Pro: nfl_ngs

nfl_ngs_gamecenter_overview​

nfl_ngs_gamecenter_overview(game_id, group: 'str' = 'passers', return_as_pandas: 'bool' = False)

NGS gamecenter overview for one game -- one row per player on a side.

Wraps /api/gamecenter/overview (keyed by NGS gameId). The payload splits each stat group into home and visitor entries; this function stacks both and tags every row with side ("home"/"visitor") plus the game's gameId. Note passers carries a single primary QB per side (two rows total) while rushers/receivers/passRushers are full lists.

Parameters

ParameterTypeDefaultDescription
game_idNGS gameId (e.g. "2024090500") from nfl_ngs_league_schedule.
groupstr'passers'which player group -- one of "passers", "rushers", "receivers", "passRushers".
return_as_pandasboolFalsereturn a pandas frame instead of polars.

Returns

A polars (or pandas) DataFrame, one row per player (both teams), with side and gameId columns prepended.

col_nametypedescription
sidecharacter"home" or "visitor" -- which team's roster the row belongs to.
gameIdcharacterUnique identifier for the NFL game in the NGS/Shield data system.
esbIdcharacterElias Sports Bureau identifier for the player, used to link to official NFL records and statistics.
teamIdcharacterUnique numeric identifier for the player's team in the NFL NGS/Shield data system.
teamAbbrcharacterTwo- or three-letter abbreviation identifying the player's team (e.g., 'KC', 'PHI').
shortNamecharacterAbbreviated display name of the player (e.g., 'P.Mahomes') used in compact UI contexts.
positioncharacterPrimary position as reported by NFL.com
jerseyNumberintegerJersey number worn by the player during the game.
playerNamecharacterFull display name of the player as shown in the NFL Next Gen Stats gamecenter.
zonesintegerSerialized or structured representation of field zones targeted or covered by the player during the game.
passYardsintegerTotal passing yards accumulated by the player (relevant for quarterbacks) in the NGS gamecenter overview.
touchdownsintegerTotal number of touchdowns scored or thrown by the player in the NGS gamecenter overview.
interceptionsintegerThe number of interceptions thrown.
attemptsintegerThe number of pass attempts as defined by the NFL.
completionsintegerThe number of completed passes.
headshotcharacterNFL headshot url for player

Example

from sportsdataverse.nfl import nfl_ngs_gamecenter_overview
ov = nfl_ngs_gamecenter_overview(game_id="2024090500", group="passers")
ov.select(["side", "playerName", "position"]).head()

nfl_ngs_leaders​

nfl_ngs_leaders(category: 'str' = 'speed', season: 'int' = 2024, season_type: 'str' = 'REG', week: 'Optional[int]' = None, return_as_pandas: 'bool' = False)

NGS top-N "leaders" board for a single category (one row per leader play).

One parameterized wrapper over the single-list leader endpoints. Each record nests a leader (player/stat) block and a play (the play that produced the highlight) block, flattened to leader_* / play_* columns.

Categories (category= value -> endpoint):

  • "speed" -> /leaders/speed/ballCarrier (fastest ball-carrier speeds)
  • "distance_ballcarrier" -> /leaders/distance/ballCarrier
  • "distance_tackle" -> /leaders/distance/tackle
  • "time_sack" -> /leaders/time/sack
  • "completion_season" / "completion_week" -> /leaders/expectation/completion/{season,week} (most-improbable completions)
  • "ery_season" / "ery_week" -> /leaders/expectation/ery/{season,week} (expected rush yards over expectation)
  • "yac_season" / "yac_week" -> /leaders/expectation/yac/{season,week} (yards after catch over expectation)

Parameters

ParameterTypeDefaultDescription
categorystr'speed'one of the keys above. Defaults to "speed".
seasonint2024season year.
season_typestr'REG'"REG", "POST", or "PRE".
weekint | NoneNoneweek filter -- required (and only used) by the *_week categories; ignored by season/non-expectation boards.
return_as_pandasboolFalsereturn a pandas frame instead of polars.

Returns

A polars (or pandas) DataFrame, one row per leader entry.

col_nametypedescription
leader_esbIdcharacterElias Sports Bureau identifier for the statistical leader, used to link to official NFL records.
leader_firstNamecharacterFirst name of the statistical leader player.
leader_gsisIdcharacterNFL GSIS (Game Statistics and Information System) identifier for the statistical leader player.
leader_jerseyNumberintegerJersey number worn by the statistical leader player.
leader_lastNamecharacterLast name of the statistical leader player.
leader_playerNamecharacterFull display name of the statistical leader player as shown in NFL NGS.
leader_positioncharacterSpecific position designation of the statistical leader (e.g., 'QB', 'WR', 'CB').
leader_positionGroupcharacterBroader position group of the statistical leader (e.g., 'Offense', 'Defense', 'Special Teams').
leader_shortNamecharacterAbbreviated display name of the statistical leader (e.g., 'P.Mahomes') for compact UI usage.
leader_teamAbbrcharacterTwo- or three-letter abbreviation identifying the statistical leader's team.
leader_teamIdcharacterUnique numeric identifier for the statistical leader's team in the NFL NGS/Shield system.
leader_weekintegerNFL week number during which the statistical leader achieved the highlighted performance.
leader_yardsintegerTotal yards associated with the statistical leader's highlighted play or performance metric.
leader_inPlayDistdoubleTotal in-play distance traveled (in yards) by the statistical leader during the highlighted play.
leader_maxSpeeddoubleMaximum recorded speed (in miles per hour) reached by the statistical leader during the highlighted play.
leader_headshotcharacterURL to the player's official headshot image as provided by the NFL NGS system.
play_gameIdintegerUnique identifier for the NFL game in which the highlighted play occurred.
play_playIdintegerUnique identifier for the specific play within the game in the NFL NGS/Shield system.
play_sequenceintegerSequential order number of the play within the game or drive as recorded in the NGS system.
play_downintegerDown number (1–4) on which the highlighted play occurred.
play_gameClockcharacterGame clock time (MM:SS) at the start of the highlighted play.
play_gameKeyintegerAlternate numeric key for the NFL game in which the highlighted play occurred, used in official NFL systems.
play_health_playerTrackingcharacterIndicator of whether player-tracking data from the NGS health/tracking system is available for this play.
play_health_ballTrackingcharacterIndicator of whether ball-tracking data from the NGS health/tracking system is available for this play.
play_homeScoreintegerHome team's score at the time of the highlighted play.
play_isBigPlaylogicalBoolean flag indicating whether the highlighted play is classified as a 'big play' in the NGS system.
play_isEndQuarterlogicalBoolean flag indicating whether the highlighted play occurred at the end of a quarter.
play_isGoalToGologicalBoolean flag indicating whether the highlighted play occurred in a goal-to-go situation.
play_isPenaltylogicalBoolean flag indicating whether the highlighted play involved a penalty.
play_isSTPlaylogicalBoolean flag indicating whether the highlighted play was a special teams play.
play_isScoringlogicalBoolean flag indicating whether the highlighted play resulted in a score.
play_playDescriptioncharacterFull text description of the highlighted play as recorded by official NFL scorers.
play_playStatecharacterState or status of the highlighted play (e.g., 'APPROVED', 'CHALLENGED') in the NGS system.
play_playStatsintegerSerialized statistical outcomes or stat codes associated with the highlighted play.
play_playTypecharacterText label describing the type of the highlighted play (e.g., 'PASS', 'RUSH', 'KICK').
play_playTypeCodeintegerNumeric or short code identifying the play type of the highlighted play in the NGS system.
play_possessionTeamIdcharacterUnique identifier for the team that had possession of the ball during the highlighted play.
play_preSnapHomeScoreintegerHome team's score immediately before the snap on the highlighted play.
play_preSnapVisitorScoreintegerVisitor team's score immediately before the snap on the highlighted play.
play_quarterintegerQuarter (1–4, or 5 for overtime) in which the highlighted play occurred.
play_timeOfDayUTCcharacterWall-clock timestamp in UTC representing the real-world time the highlighted play occurred.
play_visitorScoreintegerVisitor team's score at the time of the highlighted play.
play_yardlinecharacterFormatted yard line string (e.g., 'KC 35') indicating the field position of the highlighted play.
play_yardlineNumberintegerNumeric yard line (1–50) indicating the field position of the highlighted play.
play_yardlineSidecharacterTeam abbreviation indicating which team's side of the field the highlighted play occurred on.
play_yardsToGointegerNumber of yards needed for a first down at the start of the highlighted play.
play_absoluteYardlineNumberintegerAbsolute yard line number (1–100) on the field where the highlighted play occurred.
play_actualYardlineForFirstDowndoubleYard line the offense must reach to convert a first down on the highlighted play.
play_actualYardsToGodoubleActual distance in yards the offense needed to gain a first down on the highlighted play.
play_endGameClockcharacterGame clock time (MM:SS) at the end of the highlighted play.
play_isChangeOfPossessionlogicalBoolean flag indicating whether the highlighted play resulted in a change of ball possession.
play_playDirectioncharacterDirection of the highlighted play on the field (e.g., left, middle, right).
play_startGameClockcharacterGame clock time (MM:SS) at the start of the highlighted play.

Example

from sportsdataverse.nfl import nfl_ngs_leaders
fast = nfl_ngs_leaders(category="speed", season=2024, season_type="REG")
fast.select(["leader_playerName", "leader_maxSpeed", "play_playDescription"]).head()

nfl_ngs_league_schedule​

nfl_ngs_league_schedule(season: 'int' = 2024, season_type: 'str' = 'REG', week: 'Optional[int]' = None, return_as_pandas: 'bool' = False)

NGS league schedule -- one row per game; source of NGS gameId values.

Wraps /api/league/schedule (which returns a top-level list of games). Each row carries gameId (the YYYYMMDDNN id used by the game-scoped functions here), gameKey, smartId (the api.nfl.com uuid), team abbreviations/ids/names, kickoff times, ngsGame (tracking-data flag) and season/seasonType/week.

Parameters

ParameterTypeDefaultDescription
seasonint2024season year.
season_typestr'REG'"REG", "POST", or "PRE".
weekint | NoneNoneoptional single-week filter.
return_as_pandasboolFalsereturn a pandas frame instead of polars.

Returns

A polars (or pandas) DataFrame, one row per scheduled game.

col_nametypedescription
gameKeyintegerLegacy NFL game key used as an alternative identifier in the NGS scheduling system.
gameDatecharacter
gameIdintegerNFL Next Gen Stats integer identifier for the game.
gameTimecharacterScheduled kickoff time for the game in local or UTC format.
gameTimeEasterncharacterScheduled kickoff time for the game expressed in Eastern Time.
gameTypecharacter
homeDisplayNamecharacterFull display name of the home team (e.g., 'Kansas City Chiefs').
homeNicknamecharacterNickname (mascot name) of the home team (e.g., 'Chiefs').
homeTeamAbbrcharacterAbbreviated team name for the home team at the schedule row level.
homeTeamIdcharacterNFL Next Gen Stats team identifier for the home team at the schedule row level.
isoTimeintegerScheduled kickoff time expressed as a Unix timestamp (milliseconds since epoch).
networkChannelcharacterTelevision network or channel broadcasting this game (e.g., 'NBC', 'ESPN').
ngsGamelogicalIndicates whether this game has full Next Gen Stats data collection enabled.
seasoninteger4 digit number indicating to which season(s) the specified timeframe belongs to.
seasonTypecharacterSeason segment in which the game occurs (e.g., 'REG' for regular season, 'POST' for playoffs).
smartIdcharacterNFL Next Gen Stats smart (UUID-style) identifier for this scheduled game.
visitorDisplayNamecharacterFull display name of the visiting (away) team (e.g., 'San Francisco 49ers').
visitorNicknamecharacterNickname (mascot name) of the visiting team (e.g., '49ers').
visitorTeamAbbrcharacterAbbreviated team name for the visiting team at the schedule row level.
visitorTeamIdcharacterNFL Next Gen Stats team identifier for the visiting team at the schedule row level.
weekintegerSeason week.
weekNameAbbrcharacterAbbreviated label for the week of the season (e.g., 'WK1', 'WC' for Wild Card).
liveDotsGamelogicalIndicates whether this game has live player-tracking dot data available via NGS.
validatedlogicalIndicates whether the schedule entry has been validated and confirmed by the NFL.
releasedToClubslogicalIndicates whether NGS data for this game has been released to team personnel.
homeTeam_teamIdcharacterNFL Next Gen Stats integer team identifier for the home team from the nested team object.
homeTeam_smartIdcharacterNFL Next Gen Stats smart (UUID-style) identifier for the home team.
homeTeam_logocharacterURL of the home team's logo from the nested team object.
homeTeam_abbrcharacterAbbreviated team name for the home team from the nested team object.
homeTeam_cityStatecharacterCity and state of the home team as provided in the nested team object.
homeTeam_fullNamecharacterFull official name of the home team from the nested team object.
homeTeam_nickcharacterNickname of the home team from the nested team object.
homeTeam_teamTypecharacterClassification of the home team type (e.g., 'NFL' for active franchises).
homeTeam_conferenceAbbrcharacterConference abbreviation for the home team from the nested team object (e.g., 'AFC').
homeTeam_divisionAbbrcharacterDivision abbreviation for the home team from the nested team object (e.g., 'AFC West').
site_smartIdcharacterNFL Next Gen Stats smart (UUID-style) identifier for the game venue.
site_siteIdintegerNFL Next Gen Stats integer identifier for the game venue.
site_siteFullNamecharacterFull official name of the game venue (e.g., 'Arrowhead Stadium').
site_siteCitycharacterCity where the game venue is located.
site_siteStatecharacterState (or country for international games) where the game venue is located.
site_postalCodecharacterPostal (ZIP) code of the venue where the game is played.
site_roofTypecharacterRoof type of the game venue (e.g., 'OUTDOOR', 'DOME', 'RETRACTABLE').
visitorTeam_teamIdcharacterNFL Next Gen Stats integer team identifier for the visiting team from the nested team object.
visitorTeam_smartIdcharacterNFL Next Gen Stats smart (UUID-style) identifier for the visiting team.
visitorTeam_logocharacterURL of the visiting team's logo from the nested team object.
visitorTeam_abbrcharacterAbbreviated team name for the visiting team from the nested team object.
visitorTeam_cityStatecharacterCity and state of the visiting team as provided in the nested team object.
visitorTeam_fullNamecharacterFull official name of the visiting team from the nested team object.
visitorTeam_nickcharacterNickname of the visiting team from the nested team object.
visitorTeam_teamTypecharacterClassification of the visiting team type (e.g., 'NFL' for active franchises).
visitorTeam_conferenceAbbrcharacterConference abbreviation for the visiting team from the nested team object (e.g., 'NFC').
visitorTeam_divisionAbbrcharacterDivision abbreviation for the visiting team from the nested team object (e.g., 'NFC West').
score_timecharacterGame clock time at the current state as reported by the live score sub-object.
score_phasecharacterCurrent phase or status of the game as reported by the live score sub-object (e.g., 'FINAL', 'IN_PROGRESS').
score_visitorTeamScore_pointTotalintegerVisitor team total points scored through the current game state, from the live score sub-object.
score_visitorTeamScore_pointQ1integerVisitor team points scored in the first quarter, from the live score sub-object.
score_visitorTeamScore_pointQ2integerVisitor team points scored in the second quarter, from the live score sub-object.
score_visitorTeamScore_pointQ3integerVisitor team points scored in the third quarter, from the live score sub-object.
score_visitorTeamScore_pointQ4integerVisitor team points scored in the fourth quarter, from the live score sub-object.
score_visitorTeamScore_pointOTintegerVisitor team points scored in overtime, from the live score sub-object.
score_visitorTeamScore_timeoutsRemainingintegerNumber of timeouts remaining for the visitor team, from the live score sub-object.
score_homeTeamScore_pointTotalintegerHome team total points scored through the current game state, from the live score sub-object.
score_homeTeamScore_pointQ1integerHome team points scored in the first quarter, from the live score sub-object.
score_homeTeamScore_pointQ2integerHome team points scored in the second quarter, from the live score sub-object.
score_homeTeamScore_pointQ3integerHome team points scored in the third quarter, from the live score sub-object.
score_homeTeamScore_pointQ4integerHome team points scored in the fourth quarter, from the live score sub-object.
score_homeTeamScore_pointOTintegerHome team points scored in overtime, from the live score sub-object.
score_homeTeamScore_timeoutsRemainingintegerNumber of timeouts remaining for the home team, from the live score sub-object.

Example

from sportsdataverse.nfl import nfl_ngs_league_schedule
sched = nfl_ngs_league_schedule(season=2024, season_type="REG", week=1)
first_game_id = sched["gameId"][0]

nfl_ngs_league_schedule_current​

nfl_ngs_league_schedule_current(return_as_pandas: 'bool' = False)

NGS schedule for the current week -- one row per game.

Wraps /api/league/schedule/current; the games are under the games key (alongside scalar season/seasonType/week describing the slice).

Parameters

ParameterTypeDefaultDescription
return_as_pandasboolFalsereturn a pandas frame instead of polars.

Returns

A polars (or pandas) DataFrame, one row per game in the current week.

col_nametypedescription
gameKeyintegerAlternate numeric key for the NFL game used in official NFL NGS record-keeping.
gameDatecharacter
gameIdintegerUnique identifier for the NFL game in the NGS/Shield data system.
gameTimecharacterScheduled kickoff time for the game in local or ET representation.
gameTimeEasterncharacterScheduled kickoff time for the game in Eastern Time (ET), as published by the NFL.
gameTypecharacter
homeDisplayNamecharacterFull display name of the home team (e.g., 'Kansas City Chiefs') for the scheduled game.
homeNicknamecharacterNickname of the home team (e.g., 'Chiefs') for the scheduled game.
homeTeamAbbrcharacterTwo- or three-letter abbreviation identifying the home team at the top-level game record.
homeTeamIdcharacterUnique numeric identifier for the home team at the top-level game record.
isoTimeintegerISO 8601 formatted datetime string representing the scheduled kickoff time of the game.
networkChannelcharacterBroadcast network or channel airing the game (e.g., 'NBC', 'ESPN', 'FOX').
ngsGamelogicalBoolean or indicator flag marking whether this game entry is an official NGS-tracked game.
seasoninteger4 digit number indicating to which season(s) the specified timeframe belongs to.
seasonTypecharacterSeason type classification for the game (e.g., 'REG' for regular season, 'POST' for playoffs, 'PRE' for preseason).
smartIdcharacterSmart ID (NGS/Shield internal identifier) for the game record itself.
visitorDisplayNamecharacterFull display name of the visiting team (e.g., 'Philadelphia Eagles') for the scheduled game.
visitorNicknamecharacterNickname of the visiting team (e.g., 'Eagles') for the scheduled game.
visitorTeamAbbrcharacterTwo- or three-letter abbreviation identifying the visiting team at the top-level game record.
visitorTeamIdcharacterUnique numeric identifier for the visiting team at the top-level game record.
weekintegerSeason week.
weekNameAbbrcharacterAbbreviated name or label for the NFL week (e.g., 'WK1', 'WLD' for Wild Card) in which the game is scheduled.
releasedToClubslogicalBoolean flag indicating whether the schedule entry has been officially released to NFL clubs.
validatedlogicalBoolean flag indicating whether the schedule entry has been validated by NFL operations.
homeTeam_teamIdcharacterUnique numeric identifier for the home team in the NFL NGS/Shield data system.
homeTeam_smartIdcharacterSmart ID (NGS/Shield internal identifier) for the home team.
homeTeam_logocharacterURL to the home team's official logo image as provided in the NGS schedule feed.
homeTeam_abbrcharacterTwo- or three-letter abbreviation for the home team (e.g., 'KC').
homeTeam_cityStatecharacterCity and state string for the home team's primary market (e.g., 'Kansas City, MO').
homeTeam_fullNamecharacterFull official name of the home team (e.g., 'Kansas City Chiefs').
homeTeam_nickcharacterShort nickname of the home team (e.g., 'Chiefs') as used in the NGS system.
homeTeam_teamTypecharacterClassification of the home team type (e.g., 'NFL' for a standard league franchise).
homeTeam_conferenceAbbrcharacterConference abbreviation for the home team (e.g., 'AFC' or 'NFC').
homeTeam_divisionAbbrcharacterDivision abbreviation for the home team (e.g., 'AFC West').
site_smartIdcharacterSmart ID (NGS/Shield internal identifier) for the game venue.
site_siteIdintegerUnique identifier for the venue or stadium in the NFL NGS/Shield data system.
site_siteFullNamecharacterFull official name of the stadium or venue where the game is scheduled (e.g., 'Arrowhead Stadium').
site_siteCitycharacterCity in which the game's venue (stadium) is located.
site_siteStatecharacterState (or country) in which the game's venue is located.
site_postalCodecharacterPostal (ZIP) code of the stadium or venue where the game is scheduled to be played.
site_roofTypecharacterRoof type of the game venue (e.g., 'OPEN', 'DOME', 'RETRACTABLE') affecting playing conditions.
visitorTeam_teamIdcharacterUnique numeric identifier for the visiting team in the NFL NGS/Shield data system.
visitorTeam_smartIdcharacterSmart ID (NGS/Shield internal identifier) for the visiting team.
visitorTeam_logocharacterURL to the visiting team's official logo image as provided in the NGS schedule feed.
visitorTeam_abbrcharacterTwo- or three-letter abbreviation for the visiting team (e.g., 'PHI').
visitorTeam_cityStatecharacterCity and state string for the visiting team's primary market (e.g., 'Philadelphia, PA').
visitorTeam_fullNamecharacterFull official name of the visiting team (e.g., 'Philadelphia Eagles').
visitorTeam_nickcharacterShort nickname of the visiting team (e.g., 'Eagles') as used in the NGS system.
visitorTeam_teamTypecharacterClassification of the visiting team type (e.g., 'NFL' for a standard league franchise).
visitorTeam_conferenceAbbrcharacterConference abbreviation for the visiting team (e.g., 'AFC' or 'NFC').
visitorTeam_divisionAbbrcharacterDivision abbreviation for the visiting team (e.g., 'NFC East').
score_timecharacterGame clock time or elapsed time associated with the current scoring state snapshot.
score_phasecharacterCurrent phase or status of the game (e.g., 'FINAL', 'IN_PROGRESS', 'PREGAME').
score_visitorTeamScore_pointTotalintegerVisitor team's total final score (sum of all quarters and overtime) for the game.
score_visitorTeamScore_pointQ1integerVisitor team's points scored in the first quarter of the game.
score_visitorTeamScore_pointQ2integerVisitor team's points scored in the second quarter of the game.
score_visitorTeamScore_pointQ3integerVisitor team's points scored in the third quarter of the game.
score_visitorTeamScore_pointQ4integerVisitor team's points scored in the fourth quarter of the game.
score_visitorTeamScore_pointOTintegerVisitor team's points scored in overtime during the game, if applicable.
score_visitorTeamScore_timeoutsRemainingintegerNumber of timeouts remaining for the visitor team at the current game state.
score_homeTeamScore_pointTotalintegerHome team's total final score (sum of all quarters and overtime) for the game.
score_homeTeamScore_pointQ1integerHome team's points scored in the first quarter of the game.
score_homeTeamScore_pointQ2integerHome team's points scored in the second quarter of the game.
score_homeTeamScore_pointQ3integerHome team's points scored in the third quarter of the game.
score_homeTeamScore_pointQ4integerHome team's points scored in the fourth quarter of the game.
score_homeTeamScore_pointOTintegerHome team's points scored in overtime during the game, if applicable.
score_homeTeamScore_timeoutsRemainingintegerNumber of timeouts remaining for the home team at the current game state.

Example

from sportsdataverse.nfl import nfl_ngs_league_schedule_current
cur = nfl_ngs_league_schedule_current()
cur.select(["gameId", "homeTeamAbbr", "visitorTeamAbbr"]).head()

nfl_ngs_league_teams​

nfl_ngs_league_teams(return_as_pandas: 'bool' = False)

NGS team directory -- one row per team.

Wraps /api/league/teams (top-level list). Each row carries teamId, abbr, fullName, nick, conference/division, cityState, stadiumName, smartId, logo and site/ticket URLs.

Parameters

ParameterTypeDefaultDescription
return_as_pandasboolFalsereturn a pandas frame instead of polars.

Returns

A polars (or pandas) DataFrame, one row per team.

col_nametypedescription
abbrcharacterOfficial team abbreviation used by the NFL Next Gen Stats system (e.g., 'KC', 'NE').
cityStatecharacterCity and state where the team is based (e.g., 'Kansas City, MO').
conferenceAbbrcharacterAbbreviation of the conference the team belongs to (e.g., 'AFC', 'NFC').
fullNamecharacter
logocharacter
nickcharacterTeam nickname or mascot name (e.g., 'Chiefs', 'Patriots').
seasoninteger4 digit number indicating to which season(s) the specified timeframe belongs to.
smartIdcharacterNFL Next Gen Stats smart (UUID-style) identifier for the team.
stadiumNamecharacterName of the team's home stadium (e.g., 'Arrowhead Stadium').
teamIdcharacterNFL Next Gen Stats integer identifier for the team.
teamSiteTicketUrlcharacterURL for purchasing tickets via the team's official website.
teamSiteUrlcharacterURL of the team's official website.
teamTypecharacterClassification of the team type within the NFL system (e.g., 'NFL' for active franchises).
ticketPhoneNumbercharacterPhone number for ticket sales inquiries for this team.
yearFoundintegerYear the franchise was founded.
conference_idcharacter
conference_abbrcharacter
conference_fullNamecharacterFull name of the conference the team belongs to (e.g., 'American Football Conference').
division_idcharacter
division_abbrcharacter
division_fullNamecharacterFull name of the division the team belongs to (e.g., 'AFC West').
divisionAbbrcharacterAbbreviation of the division the team belongs to (e.g., 'AFC West').

Example

from sportsdataverse.nfl import nfl_ngs_league_teams
teams = nfl_ngs_league_teams()
teams.select(["teamId", "abbr", "fullName", "conferenceAbbr"]).head()

nfl_ngs_man_zone_rates​

nfl_ngs_man_zone_rates(seasons: 'Union[int, Sequence[int]]', *, return_as_pandas: 'bool' = False, _loader: 'Optional[Callable[..., pl.DataFrame]]' = None) -> 'Union[pl.DataFrame, pd.DataFrame]'

Descriptive man/zone coverage rates from NGS-charted labels — NOT a trained classifier.

This is a group-by of the defense_man_zone_type / defense_coverage_type labels that ship in sportsdataverse.nfl.load_nfl_pbp_participation for charted seasons (2016-2023). A trained coverage classifier is data-blocked — see the module docstring's "Blocked (needs snap tracking)" section. Unlabelled plays are dropped before rates are computed; 2_MAN and PREVENT calls stay in the plays denominator but have no dedicated rate column, so the cover_*_rate columns sum to slightly under 1 while man_rate + zone_rate == 1 exactly.

Parameters

ParameterTypeDefaultDescription
seasonsUnion[int, Sequence[int]]Season(s), charted 2016-2023. Seasons are loaded one at a time and concatenated diagonal_relaxed (the participation feed drifts schema across seasons).
return_as_pandasboolFalseIf True, returns a pandas DataFrame.
_loaderOptional[Callable]NoneInjectable loader for offline tests.

Returns

One row per (season, defteam) with plays (labelled plays only), man_rate, zone_rate and cover_0_rate ... cover_6_rate. Un-charted seasons (all labels null, e.g. 2024+) return a zero-row frame with the documented schema.

col_nametypedescription
seasonintegerNFL season (YYYY), derived from the nflverse game id.
defteamcharacterDefensive team abbreviation (the non-possession team of the game).
playsintegerNumber of charted (labelled) defensive plays in the denominator; unlabelled plays are dropped.
man_ratedoubleShare of labelled plays charted as man coverage. man_rate + zone_rate == 1 exactly.
zone_ratedoubleShare of labelled plays charted as zone coverage.
cover_0_ratedoubleShare of labelled plays charted as COVER_0. 2_MAN and PREVENT calls stay in the denominator without a dedicated column, so the cover_*_rate columns sum to slightly under 1.
cover_1_ratedoubleShare of labelled plays charted as COVER_1.
cover_2_ratedoubleShare of labelled plays charted as COVER_2.
cover_3_ratedoubleShare of labelled plays charted as COVER_3.
cover_4_ratedoubleShare of labelled plays charted as COVER_4.
cover_5_ratedoubleShare of labelled plays charted as COVER_5.
cover_6_ratedoubleShare of labelled plays charted as COVER_6.

Example

from sportsdataverse.nfl import nfl_ngs_man_zone_rates
df = nfl_ngs_man_zone_rates([2022])
print(df.sort("man_rate", descending=True).head())

nfl_ngs_microsite_chart​

nfl_ngs_microsite_chart(season: 'int' = 2024, season_type: 'str' = 'REG', week=None, chart_type=None, team_id=None, limit: 'int' = 100, offset: 'int' = 0, return_as_pandas: 'bool' = False)

NGS microsite chart catalogue -- one row per rendered player chart image.

Wraps /api/content/microsite/chart; records live under charts and each carries the chart imageName/type (qb-grid, pass, route, carry) plus the player and headline stats (passerRating, completions, etc.) and image-size URLs. Supports server-side paging.

Parameters

ParameterTypeDefaultDescription
seasonint2024season year.
season_typestr'REG'"REG", "POST", or "PRE".
weekNoneoptional week filter (the API accepts "all" by default).
chart_typeNoneoptional chart-type filter (e.g. "qb-grid", "pass").
team_idNoneoptional team-id filter.
limitint100page size (passed as limit).
offsetint0page offset.
return_as_pandasboolFalsereturn a pandas frame instead of polars.

Returns

A polars (or pandas) DataFrame, one row per chart in the page.

col_nametypedescription
imageNamecharacterFilename or label for the player image asset used on the NGS microsite chart.
esbIdcharacterElias Sports Bureau identifier for the player featured on the NGS microsite chart.
firstNamecharacter
gameIdintegerUnique identifier for the NFL game associated with the NGS microsite chart entry.
headshotcharacterNFL headshot url for player
lastNamecharacter
playerNamecharacterFull display name of the player featured on the NGS microsite chart.
positioncharacterPrimary position as reported by NFL.com
receivingYardsintegerTotal receiving yards for the player (receiver) featured on the NGS microsite chart.
receptionsintegerThe number of pass receptions. Lateral receptions officially don't count as reception.
seasoninteger4 digit number indicating to which season(s) the specified timeframe belongs to.
seasonTypecharacterSeason type classification for the chart entry (e.g., 'REG' for regular season, 'POST' for playoffs).
teamIdcharacterUnique numeric identifier for the player's team in the NFL NGS/Shield data system.
timestampinteger
touchdownsintegerTotal number of touchdowns scored or thrown by the player featured on the NGS microsite chart.
typecharacter
weekintegerSeason week.
extraLargeImgcharacterURL to the extra-large player image asset used on the NFL NGS microsite chart display.
playerNameSlugcharacterURL-safe slug version of the player's name used in NGS microsite routing (e.g., 'patrick-mahomes').
smallImgcharacterURL to the small player image asset used on the NFL NGS microsite chart display.
mediumImgcharacterURL to the medium-sized player image asset used on the NFL NGS microsite chart display.
largeImgcharacterURL to the large player image asset used on the NFL NGS microsite chart display.
carriesintegerThe number of official rush attempts (incl. scrambles and kneel downs). Rushes after a lateral reception don't count as carry.
rushingYardsintegerTotal rushing yards for the player featured on the NGS microsite chart.
attemptsintegerThe number of pass attempts as defined by the NFL.
completionPercentagedoubleCompletion percentage for the quarterback featured on the NGS microsite chart.
completionsintegerThe number of completed passes.
interceptionsintegerThe number of interceptions thrown.
passerRatingdoubleNFL passer rating for the quarterback featured on the NGS microsite chart.
passingYardsintegerTotal passing yards for the player (quarterback) featured on the NGS microsite chart.

Example

from sportsdataverse.nfl import nfl_ngs_microsite_chart
charts = nfl_ngs_microsite_chart(season=2024, season_type="REG", limit=25)
charts.select(["playerName", "type", "imageName"]).head()

nfl_ngs_microsite_chart_players​

nfl_ngs_microsite_chart_players(season: 'int' = 2024, season_type: 'str' = 'REG', return_as_pandas: 'bool' = False)

NGS microsite chart player index -- one row per player with a chart.

Wraps /api/content/microsite/chart/players; records live under players and carry esbId, firstName, lastName and playerName. Useful as the lookup list of who has charts available for a given season.

Parameters

ParameterTypeDefaultDescription
seasonint2024season year.
season_typestr'REG'"REG", "POST", or "PRE".
return_as_pandasboolFalsereturn a pandas frame instead of polars.

Returns

A polars (or pandas) DataFrame, one row per player.

col_nametypedescription
esbIdcharacterElias Sports Bureau identifier for the player used in NFL Next Gen Stats microsite chart data.
firstNamecharacter
lastNamecharacter
playerNamecharacterFull display name of the player as shown in NFL Next Gen Stats microsite charts.

Example

from sportsdataverse.nfl import nfl_ngs_microsite_chart_players
who = nfl_ngs_microsite_chart_players(season=2024, season_type="REG")
who.select(["playerName", "esbId"]).head()

nfl_ngs_play_is_highlight​

nfl_ngs_play_is_highlight(game_id, play_id, return_as_pandas: 'bool' = False)

Look up whether a single play is an NGS highlight -- one-row frame.

Wraps /api/plays/isHighlight (keyed by NGS gameId + playId). When the play is a highlight, the response's nested highlight block (the play metadata, the players involved, season/week/team) is flattened onto the row alongside the top-level gameId/playId/isHighlight flag. Pull a real (gameId, playId) pair from nfl_ngs_leaders -- each leader entry's play_gameId / play_playId is a known highlight.

Parameters

ParameterTypeDefaultDescription
game_idNGS gameId (e.g. "2024111800").
play_idthe play id within that game (e.g. 1214).
return_as_pandasboolFalsereturn a pandas frame instead of polars.

Returns

A one-row polars (or pandas) DataFrame with gameId, playId, isHighlight and (when true) flattened highlight_* columns.

col_nametypedescription
gameIdintegerNFL Shield API game identifier for the game this highlight record belongs to.
playIdinteger
isHighlightlogicalBoolean flag indicating whether this play record has been designated as a highlight by the NFL Shield API.
highlight_gameIdintegerNFL Shield API game identifier associated with the specific highlight clip.
highlight_playIdintegerNFL Shield API play identifier for the specific play associated with the highlight clip.
highlight_play_playTypecharacterText label for the type of play (e.g., 'PASS', 'RUSH', 'PUNT') as classified by the NFL Shield API.
highlight_play_gameIdintegerNFL Shield API game identifier embedded in the play detail record for the highlight.
highlight_play_gameKeyintegerNFL Shield internal game key integer used to identify the game in internal API routing.
highlight_play_yardlineSidecharacterTeam abbreviation indicating which team's side of the field the yardline is on.
highlight_play_absoluteYardlineNumberintegerAbsolute yard line number (1–100 from one end zone) of the line of scrimmage at the snap for the highlighted play.
highlight_play_yardlineNumberintegerNumeric yard line (1–50 from nearest end zone) of the line of scrimmage at the snap.
highlight_play_timeOfDayUTCcharacterWall-clock timestamp in UTC at which the highlighted play occurred during the broadcast.
highlight_play_isPenaltylogicalBoolean flag indicating whether a penalty was assessed on the highlighted play.
highlight_play_homeScoreintegerHome team's score at the end of the highlighted play.
highlight_play_visitorScoreintegerVisiting team's score at the end of the highlighted play.
highlight_play_playStatsintegerSerialized or encoded statistical detail associated with the play outcomes (e.g., yards, player ids).
highlight_play_playIdintegerNFL Shield API unique integer identifier for the specific play within the game.
highlight_play_playDescriptioncharacterOfficial NFL text description of the highlighted play (e.g., '(12:34) T.Brady pass short right to J.Edelman for 8 yards').
highlight_play_playTypeCodeintegerInteger code corresponding to the play type classification in the NFL Shield API.
highlight_play_quarterintegerQuarter number (1–4, or 5 for overtime) during which the highlighted play occurred.
highlight_play_downintegerDown number (1–4) at the time of the highlighted play.
highlight_play_yardsToGointegerInteger yards needed for a first down on the highlighted play.
highlight_play_actualYardsToGodoubleExact decimal yards required for a first down on the highlighted play.
highlight_play_actualYardlineForFirstDowndoubleActual yard line marker needed for a first down on the highlighted play.
highlight_play_possessionTeamIdcharacterNFL Shield team identifier for the team that had possession during the highlighted play.
highlight_play_isGoalToGologicalBoolean flag indicating whether the highlighted play occurred in a goal-to-go situation.
highlight_play_healthcharacterData quality or tracking health status string indicating the reliability of player/ball tracking data for this play.
highlight_play_endGameClockcharacterGame clock time remaining at the end of the highlighted play in MM:SS format.
highlight_play_startGameClockcharacterGame clock time remaining at the start of the highlighted play in MM:SS format.
highlight_play_playStatecharacterState or status of the play record (e.g., 'FINAL', 'LIVE') in the NFL Shield API at time of capture.
highlight_play_preSnapHomeScoreintegerHome team's score immediately before the snap of the highlighted play.
highlight_play_preSnapVisitorScoreintegerVisitor team's score immediately before the snap of the highlighted play.
highlight_play_sequenceintegerSequential order integer of this play within the game, as used by the NFL Shield API.
highlight_play_gameClockcharacterGame clock time remaining at the start of the highlighted play in MM:SS format.
highlight_play_yardlinecharacterHuman-readable yardline string (e.g., 'KC 35') indicating where the play began.
highlight_play_isScoringlogicalBoolean flag indicating whether the highlighted play resulted in a score.
highlight_play_isEndQuarterlogicalBoolean flag indicating whether the highlighted play was the final play of a quarter.
highlight_play_isSTPlaylogicalBoolean flag indicating whether the highlighted play was a special teams play.
highlight_play_playDirectioncharacterDirection of the play (left, right, middle) as recorded in the NFL Shield tracking data.
highlight_play_isBigPlaylogicalBoolean flag indicating whether the play was classified as a 'big play' (e.g., long gain or turnover) by the NFL Shield API.
highlight_play_isChangeOfPossessionlogicalBoolean flag indicating whether the highlighted play resulted in a change of possession.
highlight_playersintegerSerialized list or count of player tracking records associated with the highlight clip.
highlight_seasonintegerNFL season year (e.g., 2024) in which the highlighted play occurred.
highlight_seasonTypecharacterSeason phase of the highlighted play (e.g., 'REG' for regular season, 'POST' for playoffs).
highlight_teamAbbrcharacterTeam abbreviation of the team featured in or associated with the highlight clip.
highlight_teamIdcharacterNFL Shield team identifier for the team featured in the highlight clip.
highlight_weekintegerWeek number within the season during which the highlighted play occurred.

Example

from sportsdataverse.nfl import nfl_ngs_leaders, nfl_ngs_play_is_highlight
lead = nfl_ngs_leaders(category="speed", season=2024, season_type="REG")
gid, pid = lead["play_gameId"][0], lead["play_playId"][0]
hl = nfl_ngs_play_is_highlight(game_id=gid, play_id=pid)
hl.select(["gameId", "playId", "isHighlight"]).head()

nfl_ngs_ryoe​

nfl_ngs_ryoe(seasons: 'Union[int, Sequence[int]]', *, min_attempts: 'int' = 20, return_as_pandas: 'bool' = False, _loader: 'Optional[Callable[..., pl.DataFrame]]' = None) -> 'Union[pl.DataFrame, pd.DataFrame]'

Rush yards over expected per rusher-season, stabilised with EB shrinkage.

ryoe_per_att_raw is the NGS-shipped rush_yards_over_expected_per_att passed through unchanged (the NGS tracking-model residual); ryoe_total is the season total rush_yards_over_expected. ryoe_per_att_shrunk applies per-season Efron-Morris empirical-Bayes shrinkage toward the attempt-weighted league mean, weighted by rush_attempts. pct_stacked_box (percent_attempts_gte_eight_defenders) is reported as a context covariate — v1 does not adjust on it. The prior is fit at call time on rows with rush_attempts >= min_attempts — no bundled artifact.

Parameters

ParameterTypeDefaultDescription
seasonsUnion[int, Sequence[int]]Season(s) to compute, 2016+.
min_attemptsint20Qualification threshold for the prior fit and for receiving a ryoe_rank. Defaults to sportsdataverse.nfl.nfl_ngs_constants.MIN_ATTEMPTS.
return_as_pandasboolFalseIf True, returns a pandas DataFrame.
_loaderOptional[Callable]NoneInjectable loader for offline tests.

Returns

One row per (season, player_gsis_id) with raw + shrunk RYOE/attempt, reliability in [0, 1], and a dense descending ryoe_rank over qualified rows (null for unqualified rows). Empty input returns a zero-row frame with the documented schema.

col_nametypedescription
seasonintegerNFL season (YYYY).
player_gsis_idcharacterPlayer GSIS identifier (nflverse id, e.g. "00-0036223"), pinned Utf8.
player_display_namecharacterPlayer display name as shipped by NGS.
team_abbrcharacterTeam abbreviation.
positioncharacterPlayer position (from NGS player_position).
rush_attemptsdoubleSeason rush attempts — the shrinkage weight.
rush_yardsdoubleSeason rushing yards.
expected_rush_yardsdoubleNGS tracking-model expected rushing yards for the season.
ryoe_totaldoubleSeason rush yards over expected (NGS rush_yards_over_expected, passed through).
ryoe_per_att_rawdoubleNGS rush_yards_over_expected_per_att passed through unchanged — the tracking-model residual per attempt.
ryoe_per_att_shrunkdoubleryoe_per_att_raw after per-season empirical-Bayes shrinkage toward the attempt-weighted league mean (sampling variance identified from weekly rows).
pct_stacked_boxdoublePercent of attempts against 8+ defenders in the box (NGS percent_attempts_gte_eight_defenders) — reported as a context covariate, not adjusted on.
reliabilitydoubleShrinkage reliability tau2 / (tau2 + sigma2 / rush_attempts) in [0, 1]; the fraction of the raw deviation retained.
ryoe_rankintegerDense descending rank of ryoe_per_att_shrunk within season over qualified rows; null when rush_attempts < min_attempts.

Example

from sportsdataverse.nfl import nfl_ngs_ryoe
df = nfl_ngs_ryoe([2023])
print(df.sort("ryoe_rank").head())

# Pandas output

df_pd = nfl_ngs_ryoe(2023, return_as_pandas=True)

nfl_ngs_separation_oe​

nfl_ngs_separation_oe(seasons: 'Union[int, Sequence[int]]', *, min_targets: 'int' = 20, return_as_pandas: 'bool' = False, _loader: 'Optional[Callable[..., pl.DataFrame]]' = None) -> 'Union[pl.DataFrame, pd.DataFrame]'

Separation over a built context expectation, per receiver-season.

Unlike YAC-OE and RYOE, NGS ships no expected-separation field, so this model BUILDS one: a per-season weighted ridge (sportsdataverse.nfl.nfl_ngs_constants.expected_separation_ridge) of avg_separation on avg_cushion, avg_intended_air_yards and a position one-hot, weighted by targets. sep_oe_raw is the residual — a CONTEXT residual (role/scheme proxies), not a tracking-model expectation; treat it as descriptive, not causal. sep_oe_shrunk applies the same per-season empirical-Bayes shrinkage as the sibling models, weighted by targets. All parameters are fit from the requested seasons at call time — no bundled artifact.

Parameters

ParameterTypeDefaultDescription
seasonsUnion[int, Sequence[int]]Season(s) to compute, 2016+.
min_targetsint20Qualification threshold for the shrinkage prior and for receiving a sep_oe_rank. Defaults to sportsdataverse.nfl.nfl_ngs_constants.MIN_TARGETS.
return_as_pandasboolFalseIf True, returns a pandas DataFrame.
_loaderOptional[Callable]NoneInjectable loader for offline tests.

Returns

One row per (season, player_gsis_id) with the built expected_separation, raw + shrunk separation-over-expected, reliability in [0, 1], and a dense descending sep_oe_rank over qualified rows. Rows with null separation/cushion/air-yards inputs are dropped before the fit. Empty input returns a zero-row frame with the documented schema.

col_nametypedescription
seasonintegerNFL season (YYYY).
player_gsis_idcharacterPlayer GSIS identifier (nflverse id, e.g. "00-0036223"), pinned Utf8.
player_display_namecharacterPlayer display name as shipped by NGS.
team_abbrcharacterTeam abbreviation.
positioncharacterPlayer position (from NGS player_position); one-hot feature in the expectation ridge.
targetsdoubleSeason target count — the ridge weight and the shrinkage weight.
avg_cushiondoubleAverage defender cushion at snap, yards (ridge feature).
avg_separationdoubleAverage separation from the nearest defender at catch/incompletion, yards.
avg_intended_air_yardsdoubleAverage intended air yards on targets (ridge feature).
expected_separationdoubleBuilt per-season weighted-ridge expectation of avg_separation from cushion, intended air yards and position — a CONTEXT expectation, not a tracking model.
sep_oe_rawdoubleavg_separation minus expected_separation (context residual).
sep_oe_shrunkdoublesep_oe_raw after per-season empirical-Bayes shrinkage toward the target-weighted league mean (sampling variance identified from weekly rows).
reliabilitydoubleShrinkage reliability tau2 / (tau2 + sigma2 / targets) in [0, 1]; the fraction of the raw deviation retained.
sep_oe_rankintegerDense descending rank of sep_oe_shrunk within season over qualified rows; null when targets < min_targets.

Example

from sportsdataverse.nfl import nfl_ngs_separation_oe
df = nfl_ngs_separation_oe([2023])
print(df.sort("sep_oe_rank").head())

# Pandas output

df_pd = nfl_ngs_separation_oe(2023, return_as_pandas=True)

nfl_ngs_statboard​

nfl_ngs_statboard(stat_type: 'str' = 'passing', season: 'int' = 2024, season_type: 'str' = 'REG', week: 'Optional[int]' = None, return_as_pandas: 'bool' = False)

NGS season/week statboard leaderboard for a stat family (one row per player).

Wraps /api/statboard/{passing,receiving,rushing}. Each record is a flat per-player stat line (e.g. for passing: completionPercentageAboveExpectation, avgTimeToThrow, aggressiveness, passerRating ...). The player's bio is nested under a player object and is flattened to player_* columns.

Parameters

ParameterTypeDefaultDescription
stat_typestr'passing'one of "passing", "receiving", "rushing". (For the cross-stat highlight board use nfl_ngs_statboard_leaders.)
seasonint2024season year, e.g. 2024.
season_typestr'REG'"REG", "POST", or "PRE".
weekint | NoneNonesingle week to filter to; None returns the full-season board.
return_as_pandasboolFalsereturn a pandas frame instead of polars.

Returns

A polars (or pandas) DataFrame, one row per qualifying player.

col_nametypedescription
aggressivenessdoubleAggressiveness tracks the amount of passing attempts a quarterback makes that are into tight coverage, where there is a defender within 1 yard or less of the receiver at the time of completion or incompletion. AGG is shown as a % of attempts into tight windows over all passing attempts.
attemptsintegerThe number of pass attempts as defined by the NFL.
avgAirDistancedoubleAverage air distance in yards on all pass attempts, measuring how far the ball travels through the air regardless of direction.
avgAirYardsDifferentialdoubleAverage difference between intended air yards and completed air yards, measuring accuracy relative to target depth.
avgAirYardsToSticksdoubleAverage air yards relative to the first-down marker on pass attempts, where positive values indicate throws beyond the sticks.
avgCompletedAirYardsdoubleAverage air yards on completed passes only, measuring depth of actual completions.
avgIntendedAirYardsdoubleAverage depth of target on all pass attempts, regardless of completion.
avgTimeToThrowdoubleAverage time in seconds from snap to release for the passer, as tracked by NFL Next Gen Stats.
completionPercentagedoubleActual completion percentage for the passer during the period covered.
completionPercentageAboveExpectationdoubleCompletion percentage above the model-expected completion rate (CPAE), measuring accuracy relative to difficulty of throws attempted.
completionsintegerThe number of completed passes.
expectedCompletionPercentagedoubleModel-expected completion percentage based on factors such as target depth, separation, and defensive coverage as calculated by NFL Next Gen Stats.
gamesPlayedintegerNumber of games played by the passer during the period covered.
interceptionsintegerThe number of interceptions thrown.
maxAirDistancedoubleMaximum air distance in yards recorded on any single pass attempt during the period covered.
maxCompletedAirDistancedoubleMaximum air distance in yards recorded on any single completed pass during the period covered.
passTouchdownsintegerTotal passing touchdowns thrown by the passer during the period covered.
passYardsintegerTotal passing yards accumulated by the passer during the period covered.
passerRatingdoubleNFL passer rating (0–158.3 scale) for the passer during the period covered.
playerNamecharacterDisplay name of the passer as returned at the top-level statboard row.
seasoninteger4 digit number indicating to which season(s) the specified timeframe belongs to.
seasonTypecharacterSeason segment covered by this statboard record (e.g., 'REG' for regular season, 'POST' for playoffs).
positioncharacterPrimary position as reported by NFL.com
teamIdcharacterNFL Next Gen Stats team identifier for the passer's team at the time of this record.
player_seasonintegerNFL season year associated with this player's statboard record.
player_currentTeamIdcharacterNFL Next Gen Stats team identifier for the team the player is currently rostered on.
player_displayNamecharacterFull display name of the player as used in NFL Next Gen Stats records.
player_esbIdcharacterESPN-Elias Sports Bureau (ESB) identifier for the player.
player_firstNamecharacterFirst name of the player.
player_footballNamecharacterFootball name used by the player, which may differ from the legal first name.
player_gsisIdcharacterNFL GSIS (Game Statistics and Information System) identifier, the primary nflverse player key.
player_gsisItIdintegerNFL GSIS internal tracking integer identifier for the player.
player_headshotcharacter
player_jerseyNumberintegerJersey number worn by the player.
player_lastNamecharacterLast name of the player.
player_positioncharacterPosition of the player accordinng to NGS
player_positionGroupcharacterBroad position group for the player (e.g., 'QB', 'WR') in the NGS player record.
player_shortNamecharacterShortened display name for the player (e.g., 'P.Mahomes').
player_smartIdcharacterNFL Next Gen Stats smart (UUID-style) identifier for the player.
player_statuscharacterCurrent roster status of the player (e.g., 'ACT' for active, 'IR' for injured reserve).
player_uniformNumbercharacterUniform number worn by the player, stored as a string to preserve leading zeros if applicable.
player_ngsPositioncharacterPlayer's position as classified by the NFL Next Gen Stats system.
player_ngsPositionGroupcharacterBroader position group the player belongs to as classified by the NFL Next Gen Stats system.

Example

from sportsdataverse.nfl import nfl_ngs_statboard
qb = nfl_ngs_statboard(stat_type="passing", season=2024, season_type="REG")
qb.select(["playerName", "passerRating", "completionPercentageAboveExpectation"]).head()