Skip to main content
Version: 0.0.70

NFL — NFL.com API

sportsdataverse.nfl — 11 endpoints.

nfl_standings

GET /football/v2/standings — one row per team standing across the returned week(s).

Endpoint URL: GET https://api.nfl.com/football/v2/standings

Valid URL: https://api.nfl.com/football/v2/standings?season=2024&seasonType=REG&week=18

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
seasonTypeseason_typeYSeason type code (string): PRE, REG, or POST -- not ESPN's numeric 1/2/3.
weekweekYWeek number within the season (football).
limitlimitYMaximum number of items to return.

Returns

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

col_nametypedescription
team_idcharacterNFL.com Shield GUID for the team.
team_current_logocharacterTemplated URL of the team's current logo.
team_full_namecharacterFull team name (e.g. "Arizona Cardinals").
clinched_byelogicalWhether the team has clinched a first-round playoff bye.
clinched_divisionlogicalWhether the team has clinched its division.
clinched_eliminatedlogicalWhether the team has been mathematically eliminated from playoff contention.
clinched_home_fieldlogicalWhether the team has clinched home-field advantage throughout the playoffs.
clinched_playofflogicalWhether the team has clinched a playoff berth.
clinched_wild_cardlogicalWhether the team has clinched a wild-card playoff berth.
close_games_winsintegerWins in close games (decided by one score / 8 points or fewer).
close_games_lossesintegerLosses in close games (decided by one score / 8 points or fewer).
close_games_tiesintegerTies in close games.
conference_winsintegerWins against conference (AFC/NFC) opponents.
conference_win_pctnumericWin percentage against conference opponents.
conference_lossesintegerLosses against conference opponents.
conference_tiesintegerTies against conference opponents.
conference_rankintegerStandings rank within the conference.
conference_points_forintegerPoints scored in conference games.
conference_points_againstintegerPoints allowed in conference games.
division_winsintegerWins against division opponents.
division_win_pctnumericWin percentage against division opponents.
division_lossesintegerLosses against division opponents.
division_tiesintegerTies against division opponents.
division_rankintegerStandings rank within the division.
division_points_forintegerPoints scored in division games.
division_points_againstintegerPoints allowed in division games.
home_winsintegerWins in home games.
home_win_pctnumericWin percentage in home games.
home_lossesintegerLosses in home games.
home_tiesintegerTies in home games.
home_points_forintegerPoints scored in home games.
home_points_againstintegerPoints allowed in home games.
last5_winsintegerWins over the last five games.
last5_win_pctnumericWin percentage over the last five games.
last5_lossesintegerLosses over the last five games.
last5_tiesintegerTies over the last five games.
last5_points_forintegerPoints scored over the last five games.
last5_points_againstintegerPoints allowed over the last five games.
overall_gamesintegerTotal games played.
overall_winsintegerTotal wins.
overall_win_pctnumericOverall win percentage.
overall_lossesintegerTotal losses.
overall_tiesintegerTotal ties.
overall_points_forintegerTotal points scored.
overall_points_againstintegerTotal points allowed.
overall_streak_typecharacterCurrent streak type ("W" for winning, "L" for losing).
overall_streak_lengthintegerLength of the current win/loss streak.
road_winsintegerWins in road (away) games.
road_win_pctnumericWin percentage in road games.
road_lossesintegerLosses in road games.
road_tiesintegerTies in road games.
road_points_forintegerPoints scored in road games.
road_points_againstintegerPoints allowed in road games.

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

Example

nfl_standings(season=2024, season_type='REG', week=18)

Last validated n/a.

nfl_rosters

GET /football/v2/rosters — one row per team roster for the season.

Endpoint URL: GET https://api.nfl.com/football/v2/rosters

Valid URL: https://api.nfl.com/football/v2/rosters?season=2024

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
limitlimitYMaximum number of items to return.

Returns

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

col_nametypedescription
seasonintegerSeason (year) of the roster.
season_typecharacterSeason type code (PRE, REG, or POST).
team_idcharacterNFL.com Shield GUID for the team.
team_abbreviationcharacterTeam abbreviation (e.g. "ARI").
team_full_namecharacterFull team name (e.g. "Arizona Cardinals").
team_conference_abbrcharacterConference abbreviation (AFC or NFC).
team_conference_full_namecharacterFull conference name (e.g. "National Football Conference").
team_current_logocharacterTemplated URL of the team's current logo.
team_division_full_namecharacterFull division name (e.g. "NFC West").
team_leaguecharacterLeague name ("National Football League").
team_locationcharacterTeam location / city (e.g. "Arizona").
team_nick_namecharacterTeam nickname (e.g. "Cardinals").
team_venuescharacterJSON-stringified array of the team's venue objects (id, name, etc.).
personscharacterJSON-stringified array of roster player objects for the team.

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

Example

nfl_rosters(season=2024)

Last validated n/a.

nfl_teams_history

GET /football/v2/teams/history — one row per team for a season.

Endpoint URL: GET https://api.nfl.com/football/v2/teams/history

Valid URL: https://api.nfl.com/football/v2/teams/history?season=2024

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
limitlimitYMaximum number of items to return.

Returns

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

col_nametypedescription
idcharacterNFL.com Shield GUID for the team (or Pro Bowl team entry).
seasonintegerSeason (year) the team record applies to.
abbreviationcharacterTeam abbreviation (e.g. "AFC", "ARI").
full_namecharacterFull team name (e.g. "AFC Pro Bowl Team", "Arizona Cardinals").
team_typecharacterTeam type classification (e.g. "TEAM", "PRO" for Pro Bowl teams).
conference_abbrcharacterConference abbreviation (AFC or NFC).
conference_full_namecharacterFull conference name (e.g. "American Football Conference").
current_logocharacterTemplated URL of the team's current logo.
division_full_namecharacterFull division name (e.g. "NFC West").
leaguecharacterLeague name ("National Football League").
locationcharacterTeam location / city.
nick_namecharacterTeam nickname.
venuescharacterJSON-stringified array of the team's venue objects (empty for non-club entries).

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

Example

nfl_teams_history(season=2024)

Last validated n/a.

nfl_team

GET /football/v2/teams/{team_id} — single-team detail (one row).

Endpoint URL: GET https://api.nfl.com/football/v2/teams/{team_id}

Valid URL: https://api.nfl.com/football/v2/teams/10403800-517c-7b8c-65a3-c61b95d86123

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
idcharacterNFL.com Shield GUID for the team.
biocharacterTeam biography / description text (may be null).
current_backgroundcharacterTemplated URL of the team's current background image.
current_coachcharacterName of the team's current head coach.
current_logocharacterTemplated URL of the team's current logo.
primary_colorcharacterTeam primary color (hex code).
secondary_colorcharacterTeam secondary color (hex code).
year_establishedintegerYear the franchise was established.
full_namecharacterFull team name (e.g. "Arizona Cardinals").
nfl_shop_urlcharacterURL to the team's NFL Shop storefront.
official_website_urlcharacterURL of the team's official website.
ownerscharacterName(s) of the team's owner(s).
team_typecharacterTeam type classification (e.g. "TEAM").
socialscharacterJSON-stringified array of the team's social-media links (platform, link).
vll_channel_callsigncharacterVerizon Live League (VLL) channel call sign for the team.

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

Example

nfl_team(team_id='10403800-517c-7b8c-65a3-c61b95d86123')

Last validated n/a.

nfl_weeks

GET /football/v2/weeks/season/{season}/seasonType/{season_type} — week calendar (one row per week).

Endpoint URL: GET https://api.nfl.com/football/v2/weeks/season/{season}/seasonType/{season_type}

Valid URL: https://api.nfl.com/football/v2/weeks/season/2024/seasonType/REG

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYseason path parameter.
season_typeseason_typeYSeason type code (string): PRE, REG, or POST -- not ESPN's numeric 1/2/3.

Returns

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

col_nametypedescription
seasonintegerSeason (year) of the week.
season_typecharacterSeason type code (PRE, REG, or POST).
weekintegerWeek number within the season type.
bye_teamscharacterJSON-stringified array of teams on bye during the week (empty when none).
date_begincharacterStart date of the week (YYYY-MM-DD).
date_endcharacterEnd date of the week (YYYY-MM-DD).
week_typecharacterWeek type code (e.g. PRE, REG, WC, DIV, CONF, SB).

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

Example

nfl_weeks(season=2024, season_type='REG')

Last validated n/a.

nfl_weeks_by_date

GET /football/v2/weeks/date/{YYYY-MM-DD} — the week containing a date (one row).

Endpoint URL: GET https://api.nfl.com/football/v2/weeks/date/{date}

Valid URL: https://api.nfl.com/football/v2/weeks/date/2024-09-08

API ParameterPythonPatternRequiredNullableDescription
datedateYdate 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
seasonintegerSeason (year) the date falls in.
season_typecharacterSeason type code (PRE, REG, or POST).
weekintegerWeek number that the queried date falls within.
bye_teamscharacterJSON-stringified array of teams on bye during the week (empty when none).
date_begincharacterStart date of the week (YYYY-MM-DD).
date_endcharacterEnd date of the week (YYYY-MM-DD).
week_typecharacterWeek type code (e.g. PRE, REG, WC, DIV, CONF, SB).

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

Example

nfl_weeks_by_date(date='2024-09-08')

Last validated n/a.

nfl_combine_profiles

GET /football/v2/combine/profiles — one row per combine prospect.

Endpoint URL: GET https://api.nfl.com/football/v2/combine/profiles

Valid URL: https://api.nfl.com/football/v2/combine/profiles?year=2024

API ParameterPythonPatternRequiredNullableDescription
yearyearYyear query parameter.
limitlimitYMaximum number of items to return.

Returns

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

col_nametypedescription
idcharacterNFL.com Shield GUID for the combine profile.
yearintegerCombine / draft class year.
person_idcharacterNFL.com Shield GUID of the prospect.
person_display_namecharacterProspect's full display name.
person_esb_idcharacterProspect's Elias Sports Bureau (ESB) identifier.
person_first_namecharacterProspect's first name.
person_last_namecharacterProspect's last name.
person_hometowncharacterProspect's hometown (city, state).
person_college_namescharacterJSON-stringified array of the prospect's college(s).
arm_lengthnumericArm length measured at the combine, in inches.
athleticism_scorenumericComposite athleticism score.
bench_pressnumericBench-press measurement object (flattened; null when no measurement).
broad_jumpnumericBroad-jump measurement object (flattened; null when no measurement).
biocharacterHTML biography / career summary for the prospect.
college_classcharacterProspect's college class (e.g. Senior, Junior).
draft_gradenumericNumeric draft grade assigned to the prospect.
draft_projectioncharacterDraft projection text (e.g. "Priority free agent").
forty_yard_dashnumeric40-yard-dash measurement object (flattened; null when no measurement).
gradenumericOverall prospect grade.
hand_sizeintegerHand size measured at the combine, in inches.
headshotcharacterTemplated URL of the prospect's headshot image.
heightintegerProspect height, in inches.
nfl_comparisoncharacterPlayer the prospect is most comparable to.
overviewcharacterHTML scouting overview of the prospect.
production_scorenumericComposite college-production score.
profile_authorcharacterAuthor of the scouting profile (e.g. "Lance Zierlein").
pro_forty_yard_dashnumericPro-day 40-yard-dash measurement object (flattened; null when no measurement).
sixty_yard_shuttlenumeric60-yard-shuttle measurement object (flattened; null when no measurement).
size_scorenumericComposite size score (flattened; null when not scored).
sources_tell_uscharacter"Sources tell us" scouting commentary text.
strengthscharacterHTML list of the prospect's strengths.
ten_yard_splitnumeric10-yard-split measurement object (flattened; null when no measurement).
three_cone_drillnumericThree-cone-drill measurement object (flattened; null when no measurement).
twenty_yard_shuttlenumeric20-yard-shuttle measurement object (flattened; null when no measurement).
weaknessescharacterHTML list of the prospect's weaknesses.
combine_attendancelogicalWhether the prospect attended the combine.
positioncharacterProspect's position abbreviation (e.g. "CB").
position_groupcharacterProspect's position group (e.g. "DB").
vertical_jumpnumericVertical-jump measurement object (flattened; null when no measurement).
weightintegerProspect weight, in pounds.
pro_forty_yard_dash_designationcharacterDesignation for the pro-day 40-yard dash (OFFICIAL or UNOFFICIAL).
pro_forty_yard_dash_secondsnumericPro-day 40-yard-dash time, in seconds.
bench_press_designationcharacterDesignation for the bench-press result (OFFICIAL or UNOFFICIAL).
bench_press_repetitionsintegerNumber of 225 lb bench-press repetitions.
broad_jump_designationcharacterDesignation for the broad-jump result (OFFICIAL or UNOFFICIAL).
broad_jump_inchesintegerBroad-jump distance, in inches.
forty_yard_dash_designationcharacterDesignation for the 40-yard-dash result (OFFICIAL or UNOFFICIAL).
forty_yard_dash_secondsnumeric40-yard-dash time, in seconds.
ten_yard_split_designationcharacterDesignation for the 10-yard-split result (OFFICIAL or UNOFFICIAL).
ten_yard_split_secondsnumeric10-yard-split time, in seconds.
vertical_jump_designationcharacterDesignation for the vertical-jump result (OFFICIAL or UNOFFICIAL).
vertical_jump_inchesintegerVertical-jump height, in inches.
three_cone_drill_designationcharacterDesignation for the three-cone-drill result (OFFICIAL or UNOFFICIAL).
three_cone_drill_secondsnumericThree-cone-drill time, in seconds.
twenty_yard_shuttle_designationcharacterDesignation for the 20-yard-shuttle result (OFFICIAL or UNOFFICIAL).
twenty_yard_shuttle_secondsnumeric20-yard-shuttle time, in seconds.

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

Example

nfl_combine_profiles(year=2024)

Last validated n/a.

nfl_draft_picks

GET /football/v2/draft/picks/report — one row per draft pick.

Endpoint URL: GET https://api.nfl.com/football/v2/draft/picks/report

Valid URL: https://api.nfl.com/football/v2/draft/picks/report?year=2024

API ParameterPythonPatternRequiredNullableDescription
yearyearYyear query parameter.
limitlimitYMaximum number of items to return.

Returns

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

col_nametypedescription
yearintegerDraft year.
draft_roundintegerRound of the draft in which the pick was made.
draft_positionintegerPick position within the round.
draft_number_overallintegerOverall pick number across the entire draft.
person_idcharacterNFL.com Shield GUID of the drafted player (may be empty until the pick is announced).
pick_is_inlogicalWhether the pick has officially been submitted / announced.
team_idcharacterNFL.com Shield GUID of the team making the pick.
trade_notecharacterTrade annotation for the pick (e.g. "CAR>CHI" denoting a traded selection).
tweet_sentlogicalWhether the announcement tweet has been sent for the pick.
tweets_sentcharacterJSON-stringified array of per-account tweet-sent status objects.

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

Example

nfl_draft_picks(year=2024)

Last validated n/a.

nfl_injuries

GET /football/v2/injuries — one row per injured player.

Endpoint URL: GET https://api.nfl.com/football/v2/injuries

Valid URL: https://api.nfl.com/football/v2/injuries?season=2024&seasonType=REG&week=1

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
seasonTypeseason_typeYSeason type code (string): PRE, REG, or POST -- not ESPN's numeric 1/2/3.
weekweekYWeek number within the season (football).

Returns

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

col_nametypedescription
seasonintegerSeason (year) of the injury report.
season_typecharacterSeason type code (PRE, REG, or POST).
weekintegerWeek number of the injury report.
team_idcharacterNFL.com Shield GUID of the player's team.
team_current_logocharacterTemplated URL of the team's current logo.
team_full_namecharacterFull team name (e.g. "Atlanta Falcons").
person_idcharacterNFL.com Shield GUID of the injured player.
person_first_namecharacterPlayer's first name.
person_common_first_namecharacterPlayer's common / preferred first name.
person_last_namecharacterPlayer's last name.
person_display_namecharacterPlayer's full display name.
person_gsis_idcharacterPlayer's NFL GSIS identifier (e.g. "00-0036948").
person_headshotcharacterTemplated URL of the player's headshot image.
injuriescharacterJSON-stringified array of detailed injury objects (empty when not specified).
injury_statuscharacterGame-status designation (e.g. OUT, DOUBTFUL, QUESTIONABLE).
practicescharacterJSON-stringified array of practice-participation notes.
practice_dayscharacterJSON-stringified array of per-day practice status objects (date, status).
practice_statuscharacterMost recent practice-participation status (e.g. FULL, LIMITED, DNP).
positioncharacterPlayer's position abbreviation (e.g. "DE").

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

Example

nfl_injuries(season=2024, season_type='REG', week=1)

Last validated n/a.

nfl_game_summaries

GET /football/v2/stats/live/game-summaries — one row per game (live state).

Endpoint URL: GET https://api.nfl.com/football/v2/stats/live/game-summaries

Valid URL: https://api.nfl.com/football/v2/stats/live/game-summaries?season=2024&seasonType=REG&week=1

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
seasonTypeseason_typeYSeason type code (string): PRE, REG, or POST -- not ESPN's numeric 1/2/3.
weekweekYWeek number within the season (football).

Returns

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

col_nametypedescription
game_idcharacterNFL.com Shield GUID for the game.
offsetintegerLive-feed sequence offset for the summary snapshot.
attendanceintegerAnnounced game attendance.
clockcharacterGame clock at the snapshot (MM:SS).
distanceintegerYards to gain for a first down at the snapshot.
downintegerCurrent down (1-4) at the snapshot.
game_book_urlcharacterURL of the official game book image.
is_goal_to_gologicalWhether the current situation is goal-to-go.
is_red_zonelogicalWhether the ball is in the red zone.
phasecharacterGame phase (e.g. PREGAME, INGAME, HALFTIME, FINAL).
quartercharacterCurrent period descriptor (e.g. Q1, HALFTIME, END_OF_GAME).
start_timecharacterISO 8601 kickoff timestamp.
weathercharacterWeather summary string (temperature, humidity, wind).
yard_linecharacterCurrent line of scrimmage (e.g. "KC 10").
away_team_team_idcharacterNFL.com Shield GUID of the away team.
away_team_has_possessionlogicalWhether the away team has possession at the snapshot.
away_team_score_q1integerAway team points scored in the first quarter.
away_team_score_q2integerAway team points scored in the second quarter.
away_team_score_q3integerAway team points scored in the third quarter.
away_team_score_q4integerAway team points scored in the fourth quarter.
away_team_score_otintegerAway team points scored in overtime.
away_team_score_totalintegerAway team total points.
away_team_timeouts_remainingintegerAway team timeouts remaining at the snapshot.
away_team_timeouts_usedintegerAway team timeouts used at the snapshot.
home_team_team_idcharacterNFL.com Shield GUID of the home team.
home_team_has_possessionlogicalWhether the home team has possession at the snapshot.
home_team_score_q1integerHome team points scored in the first quarter.
home_team_score_q2integerHome team points scored in the second quarter.
home_team_score_q3integerHome team points scored in the third quarter.
home_team_score_q4integerHome team points scored in the fourth quarter.
home_team_score_otintegerHome team points scored in overtime.
home_team_score_totalintegerHome team total points.
home_team_timeouts_remainingintegerHome team timeouts remaining at the snapshot.
home_team_timeouts_usedintegerHome team timeouts used at the snapshot.

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

Example

nfl_game_summaries(season=2024, season_type='REG', week=1)

Last validated n/a.

nfl_weekly_game_details

GET /football/v2/experience/weekly-game-details — one row per game (bare list).

Endpoint URL: GET https://api.nfl.com/football/v2/experience/weekly-game-details

Valid URL: https://api.nfl.com/football/v2/experience/weekly-game-details?season=2024&type=REG&week=1

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
typeseason_typeYSeason type code (string): PRE, REG, or POST (sent as the type query param) -- not ESPN's numeric 1/2/3.
weekweekYWeek number within the season (football).
includeDriveChartinclude_drive_chartYincludeDriveChart query parameter.
includeReplaysinclude_replaysYincludeReplays query parameter.
includeStandingsinclude_standingsYincludeStandings query parameter.
includeTaggedVideosinclude_tagged_videosYincludeTaggedVideos query 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
idcharacterNFL.com Shield GUID for the game.
home_team_idcharacterNFL.com Shield GUID of the home team.
home_team_current_logocharacterTemplated URL of the home team's current logo.
home_team_full_namecharacterFull home-team name (e.g. "Kansas City Chiefs").
away_team_idcharacterNFL.com Shield GUID of the away team.
away_team_current_logocharacterTemplated URL of the away team's current logo.
away_team_full_namecharacterFull away-team name (e.g. "Baltimore Ravens").
categorycharacterGame category / window (e.g. SNF, MNF, TNF).
datecharacterGame date (YYYY-MM-DD).
timecharacterISO 8601 kickoff timestamp.
broadcast_info_home_network_channelscharacterJSON-stringified array of broadcast channels in the home market.
broadcast_info_away_network_channelscharacterJSON-stringified array of broadcast channels in the away market.
broadcast_info_international_watch_optionscharacterJSON-stringified array of international broadcaster options by country.
broadcast_info_streaming_networkscharacterJSON-stringified array of streaming-network objects.
broadcast_info_territorycharacterBroadcast territory designation (e.g. NATIONAL, REGIONAL).
broadcast_info_audio_networkscharacterJSON-stringified array of audio-broadcast network objects.
game_typecharacterGame type classification (e.g. UNSPECIFIED, REG, WC).
internationallogicalWhether the game is played at an international venue.
neutral_sitelogicalWhether the game is played at a neutral site.
venue_idcharacterNFL.com Shield GUID of the venue.
venue_namecharacterVenue name (e.g. "GEHA Field at Arrowhead Stadium").
venue_citycharacterVenue city.
venue_countrycharacterVenue country.
seasonintegerSeason (year) of the game.
season_typecharacterSeason type code (PRE, REG, or POST).
statuscharacterGame status (e.g. SCHEDULED, INGAME, FINAL).
weekintegerWeek number of the game.
week_typecharacterWeek type code (e.g. PRE, REG, WC, DIV, CONF, SB).
external_idscharacterJSON-stringified array of external game identifiers (elias, gsis, etc.).
ticket_urlcharacterPrimary ticket-purchase URL for the game.
ticket_vendorscharacterJSON-stringified array of ticket-vendor objects (vendor name, URL).
extensionscharacterJSON-stringified array of extension objects (empty when none).
versionintegerRecord version number.
summary_game_idcharacterNFL.com Shield GUID for the game (from the embedded live summary).
summary_offsetintegerLive-feed sequence offset for the embedded summary snapshot.
summary_attendanceintegerAnnounced game attendance (from the embedded summary).
summary_clockcharacterGame clock at the summary snapshot (MM:SS).
summary_distanceintegerYards to gain for a first down at the summary snapshot.
summary_downintegerCurrent down (1-4) at the summary snapshot.
summary_game_book_urlcharacterURL of the official game book image (from the embedded summary).
summary_is_goal_to_gologicalWhether the situation is goal-to-go at the summary snapshot.
summary_is_red_zonelogicalWhether the ball is in the red zone at the summary snapshot.
summary_phasecharacterGame phase (e.g. PREGAME, INGAME, HALFTIME, FINAL).
summary_quartercharacterCurrent period descriptor (e.g. Q1, HALFTIME, END_OF_GAME).
summary_start_timecharacterISO 8601 kickoff timestamp (from the embedded summary).
summary_weathercharacterWeather summary string (temperature, humidity, wind).
summary_yard_linecharacterCurrent line of scrimmage at the summary snapshot (e.g. "KC 10").
summary_away_team_team_idcharacterNFL.com Shield GUID of the away team (from the embedded summary).
summary_away_team_has_possessionlogicalWhether the away team has possession at the summary snapshot.
summary_away_team_score_q1integerAway team points scored in the first quarter.
summary_away_team_score_q2integerAway team points scored in the second quarter.
summary_away_team_score_q3integerAway team points scored in the third quarter.
summary_away_team_score_q4integerAway team points scored in the fourth quarter.
summary_away_team_score_otintegerAway team points scored in overtime.
summary_away_team_score_totalintegerAway team total points.
summary_away_team_timeouts_remainingintegerAway team timeouts remaining at the summary snapshot.
summary_away_team_timeouts_usedintegerAway team timeouts used at the summary snapshot.
summary_home_team_team_idcharacterNFL.com Shield GUID of the home team (from the embedded summary).
summary_home_team_has_possessionlogicalWhether the home team has possession at the summary snapshot.
summary_home_team_score_q1integerHome team points scored in the first quarter.
summary_home_team_score_q2integerHome team points scored in the second quarter.
summary_home_team_score_q3integerHome team points scored in the third quarter.
summary_home_team_score_q4integerHome team points scored in the fourth quarter.
summary_home_team_score_otintegerHome team points scored in overtime.
summary_home_team_score_totalintegerHome team total points.
summary_home_team_timeouts_remainingintegerHome team timeouts remaining at the summary snapshot.
summary_home_team_timeouts_usedintegerHome team timeouts used at the summary snapshot.
drive_chart_game_idcharacterNFL.com Shield GUID for the game (from the drive chart, present when include_drive_chart=true).
drive_chart_offsetintegerLive-feed sequence offset for the drive-chart snapshot.
drive_chart_drivescharacterJSON-stringified array of drive objects (sequence, team, result, etc.).
drive_chart_playscharacterJSON-stringified array of play objects within the drive chart.
drive_chart_scoring_summariescharacterJSON-stringified array of scoring-summary objects (sequence, scores, clock).
replayscharacterJSON-stringified array of replay objects (populated only when include_replays=true).
tagged_videoscharacterJSON-stringified array of tagged-video objects (populated only when include_tagged_videos=true).
away_team_standingscharacterJSON-stringified away-team standings object (populated only when include_standings=true).
home_team_standingscharacterJSON-stringified home-team standings object (populated only when include_standings=true).

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

Example

nfl_weekly_game_details(season=2024, season_type='REG', week=1)

Last validated n/a.