nfl — ESPN reference
- sport slug:
football - league slug:
nfl - scopes:
universal,football - wrappers: 112 (+ 11 native)
Every endpoint is called as sdv.nfl.espnNfl<Endpoint>(params). Each method is also available under its snake_case name (espn_nfl_<endpoint>) for parity with the Python / R packages. Parameters accept snake_case or camelCase. Required path params are marked *. This league also ships 11 native (non-ESPN) API wrappers — see the Native API sections below.
import sdv from 'sportsdataverse';
await sdv.nfl.espnNflScoreboard({});
Universal endpoints
| Method | HTTP | Path params | Query params |
|---|---|---|---|
espnNflAthleteAwards | core_v2 /football/leagues/nfl/athletes/{athlete_id}/awards | athlete_id* | — |
espnNflAthleteBio | site_v2 /football/nfl/athletes/{athlete_id}/bio | athlete_id* | — |
espnNflAthleteCareerStats | core_v2 /football/leagues/nfl/athletes/{athlete_id}/statistics[/{stat_type}] | athlete_id*, stat_type | — |
espnNflAthleteContracts | core_v2 /football/leagues/nfl/athletes/{athlete_id}/contracts | athlete_id* | — |
espnNflAthleteCore | core_v2 /football/leagues/nfl/athletes/{athlete_id} | athlete_id* | — |
espnNflAthleteEventlog | core_v2 /football/leagues/nfl/athletes/{athlete_id}/eventlog | athlete_id* | — |
espnNflAthleteGamelog | web_v3 /football/nfl/athletes/{athlete_id}/gamelog | athlete_id* | season |
espnNflAthleteInfo | site_v2 /football/nfl/athletes/{athlete_id} | athlete_id* | — |
espnNflAthleteInjuries | core_v2 /football/leagues/nfl/athletes/{athlete_id}/injuries | athlete_id* | — |
espnNflAthleteNews | site_v2 /football/nfl/athletes/{athlete_id}/news | athlete_id* | — |
espnNflAthleteNotes | core_v2 /football/leagues/nfl/athletes/{athlete_id}/notes | athlete_id* | — |
espnNflAthleteOverview | web_v3 /football/nfl/athletes/{athlete_id}/overview | athlete_id* | — |
espnNflAthleteRecords | core_v2 /football/leagues/nfl/athletes/{athlete_id}/records | athlete_id* | — |
espnNflAthleteSeasons | core_v2 /football/leagues/nfl/athletes/{athlete_id}/seasons | athlete_id* | — |
espnNflAthleteSplits | web_v3 /football/nfl/athletes/{athlete_id}/splits | athlete_id* | season |
espnNflAthleteStatisticslog | core_v2 /football/leagues/nfl/athletes/{athlete_id}/statisticslog | athlete_id* | — |
espnNflAthleteStats | web_v3 /football/nfl/athletes/{athlete_id}/stats | athlete_id* | season |
espnNflAthleteVsAthlete | core_v2 /football/leagues/nfl/athletes/{athlete_id}/vsathlete/{opp_id} | athlete_id*, opp_id* | — |
espnNflAthletesIndex | core_v2 /football/leagues/nfl/athletes | — | active, limit, page |
espnNflAward | core_v2 /football/leagues/nfl/awards/{award_id} | award_id* | — |
espnNflAwards | core_v2 /football/leagues/nfl/awards | — | — |
espnNflCalendar | site_v2 /football/nfl/calendar | — | — |
espnNflCoach | core_v2 /football/leagues/nfl/coaches/{coach_id} | coach_id* | — |
espnNflCoachRecord | core_v2 /football/leagues/nfl/coaches/{coach_id}/record/{record_type} | coach_id*, record_type | — |
espnNflCoachSeason | core_v2 /football/leagues/nfl/coaches/{coach_id}/seasons/{season} | coach_id*, season* | — |
espnNflConferences | site_v2 /football/nfl/groups | — | — |
espnNflDraft | site_v2 /football/nfl/draft | — | — |
espnNflEvent | core_v2 /football/leagues/nfl/events/{event_id} | event_id* | — |
espnNflEventBroadcasts | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/broadcasts | event_id*, cid | — |
espnNflEventCompetition | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid} | event_id*, cid | — |
espnNflEventCompetitor | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/competitors/{team_id} | event_id*, team_id*, cid | — |
espnNflEventCompetitorLeaders | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/competitors/{team_id}/leaders | event_id*, team_id*, cid | — |
espnNflEventCompetitorLinescores | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/competitors/{team_id}/linescores | event_id*, team_id*, cid | — |
espnNflEventCompetitorRecord | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/competitors/{team_id}/record | event_id*, team_id*, cid | — |
espnNflEventCompetitorRoster | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/competitors/{team_id}/roster | event_id*, team_id*, cid | — |
espnNflEventCompetitorStatistics | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/competitors/{team_id}/statistics | event_id*, team_id*, cid | — |
espnNflEventCompetitors | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/competitors | event_id*, cid | — |
espnNflEventLeaders | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/leaders | event_id*, cid | — |
espnNflEventOdds | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/odds | event_id*, cid | — |
espnNflEventOfficialDetail | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/officials/{official_id} | event_id*, official_id*, cid | — |
espnNflEventOfficials | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/officials | event_id*, cid | — |
espnNflEventPlay | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/plays/{play_id} | event_id*, play_id*, cid | — |
espnNflEventPlayPersonnel | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/plays/{play_id}/personnel | event_id*, play_id*, cid | — |
espnNflEventPlays | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/plays | event_id*, cid | limit |
espnNflEventPowerindex | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/powerindex | event_id*, cid | — |
espnNflEventPredictor | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/predictor | event_id*, cid | — |
espnNflEventProbabilities | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/probabilities | event_id*, cid | limit |
espnNflEventPropbets | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/propbets | event_id*, cid | — |
espnNflEventScoringplays | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/scoringplays | event_id*, cid | — |
espnNflEventSituation | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/situation | event_id*, cid | — |
espnNflEventStatus | core_v2 /football/leagues/nfl/events/{event_id}/competitions/{cid}/status | event_id*, cid | — |
espnNflEvents | core_v2 /football/leagues/nfl/events | — | dates, limit |
espnNflFranchise | core_v2 /football/leagues/nfl/franchises/{franchise_id} | franchise_id* | — |
espnNflFranchises | core_v2 /football/leagues/nfl/franchises | — | limit |
espnNflInjuries | site_v2 /football/nfl/injuries | — | — |
espnNflLeaders | web_v3 /football/nfl/statistics/byathlete | — | category, season, season_type → seasontype, limit, page, sort |
espnNflLeadersCore | core_v2 /football/leagues/nfl/leaders | — | — |
espnNflLeagueNotes | core_v2 /football/leagues/nfl/notes | — | — |
espnNflLeagueRoot | core_v2 /football/leagues/nfl | — | — |
espnNflNews | site_v2 /football/nfl/news | — | limit |
espnNflPosition | core_v2 /football/leagues/nfl/positions/{position_id} | position_id* | — |
espnNflPositions | core_v2 /football/leagues/nfl/positions | — | — |
espnNflScoreboard | site_v2 /football/nfl/scoreboard | — | dates, week, season_type → seasontype, groups, limit |
espnNflSeasonAthletes | core_v2 /football/leagues/nfl/seasons/{season}/athletes | season* | limit, page |
espnNflSeasonAwards | core_v2 /football/leagues/nfl/seasons/{season}/awards | season* | — |
espnNflSeasonCoaches | core_v2 /football/leagues/nfl/seasons/{season}/coaches | season* | limit |
espnNflSeasonDraft | core_v2 /football/leagues/nfl/seasons/{season}/draft | season* | — |
espnNflSeasonDraftRoundPicks | core_v2 /football/leagues/nfl/seasons/{season}/draft/rounds/{round_num}/picks | season*, round_num* | — |
espnNflSeasonFreeagents | core_v2 /football/leagues/nfl/seasons/{season}/freeagents | season* | — |
espnNflSeasonFutures | core_v2 /football/leagues/nfl/seasons/{season}/futures | season* | — |
espnNflSeasonGroup | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}/groups/{group_id} | season*, season_type*, group_id* | — |
espnNflSeasonGroupChildren | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}/groups/{group_id}/children | season*, season_type*, group_id* | — |
espnNflSeasonGroupTeams | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}/groups/{group_id}/teams | season*, season_type*, group_id* | limit |
espnNflSeasonGroups | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}/groups | season*, season_type* | — |
espnNflSeasonInfo | core_v2 /football/leagues/nfl/seasons/{season} | season* | — |
espnNflSeasonPointer | core_v2 /football/leagues/nfl/season | — | — |
espnNflSeasonPowerindex | core_v2 /football/leagues/nfl/seasons/{season}/powerindex[/{team_id}] | season*, team_id | — |
espnNflSeasonPowerindexLeaders | core_v2 /football/leagues/nfl/seasons/{season}/powerindex/leaders | season* | — |
espnNflSeasonTeam | core_v2 /football/leagues/nfl/seasons/{season}/teams/{team_id} | season*, team_id* | — |
espnNflSeasonTeams | core_v2 /football/leagues/nfl/seasons/{season}/teams | season* | limit |
espnNflSeasonType | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type} | season*, season_type* | — |
espnNflSeasonTypeCorrections | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}/corrections | season*, season_type* | — |
espnNflSeasonTypeLeaders | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}/leaders | season*, season_type* | — |
espnNflSeasonTypes | core_v2 /football/leagues/nfl/seasons/{season}/types | season* | — |
espnNflSeasonWeek | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}/weeks/{week} | season*, season_type*, week* | — |
espnNflSeasonWeekEvents | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}/weeks/{week}/events | season*, season_type*, week* | limit |
espnNflSeasonWeeks | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}/weeks | season*, season_type* | — |
espnNflSeasons | core_v2 /football/leagues/nfl/seasons | — | limit |
espnNflStandings | site_v2_alt /football/nfl/standings | — | season, group, standings_type → type |
espnNflStandingsCore | core_v2 /football/leagues/nfl/standings | — | — |
espnNflStatisticsLeague | site_v2 /football/nfl/statistics | — | — |
espnNflSummary | site_v2 /football/nfl/summary | — | event_id → event |
espnNflTalentpicks | core_v2 /football/leagues/nfl/talentpicks | — | — |
espnNflTeam | site_v2 /football/nfl/teams/{team_id} | team_id* | — |
espnNflTeamCore | core_v2 /football/leagues/nfl/teams/{team_id} | team_id* | — |
espnNflTeamDepthcharts | site_v2 /football/nfl/teams/{team_id}/depthcharts | team_id* | — |
espnNflTeamHistory | site_v2 /football/nfl/teams/{team_id}/history | team_id* | — |
espnNflTeamInjuries | site_v2 /football/nfl/teams/{team_id}/injuries | team_id* | — |
espnNflTeamLeaders | site_v2 /football/nfl/teams/{team_id}/leaders | team_id* | — |
espnNflTeamNews | site_v2 /football/nfl/teams/{team_id}/news | team_id* | limit |
espnNflTeamRecord | site_v2 /football/nfl/teams/{team_id}/record | team_id* | — |
espnNflTeamRoster | site_v2 /football/nfl/teams/{team_id}/roster | team_id* | — |
espnNflTeamSchedule | site_v2 /football/nfl/teams/{team_id}/schedule | team_id* | season |
espnNflTeamTransactions | site_v2 /football/nfl/teams/{team_id}/transactions | team_id* | — |
espnNflTeamsCore | core_v2 /football/leagues/nfl/teams | — | limit |
espnNflTeamsSite | site_v2 /football/nfl/teams | — | limit |
espnNflTournaments | core_v2 /football/leagues/nfl/tournaments | — | — |
espnNflTransactions | site_v2 /football/nfl/transactions | — | — |
espnNflVenue | core_v2 /football/leagues/nfl/venues/{venue_id} | venue_id* | — |
espnNflVenues | core_v2 /football/leagues/nfl/venues | — | limit |
Football endpoints
| Method | HTTP | Path params | Query params |
|---|---|---|---|
espnNflSeasonQbr | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}[/groups/{group_id}]/qbr/{split} | season*, season_type, group_id, split | — |
espnNflSeasonQbrWeek | core_v2 /football/leagues/nfl/seasons/{season}/types/{season_type}/weeks/{week}/qbr/{split} | season*, week*, season_type, split | — |
Parsed output: pass
{ parsed: true }to any endpoint above to get tidy rows instead of raw JSON. The columns are determined by each endpoint's parser — see ESPN parsed returns for the full column reference (and thesummarydispatcher's 21 sub-frames).
Native API — NFL.com Shield API
Flat (non-ESPN) wrappers for the NFL.com "Shield" data API. Host: https://api.nfl.com. Each method is exposed under BOTH nfl_api_<endpoint> (snake_case, py/R parity) and nflApi<Endpoint> (camelCase canonical) on sdv.nfl. Pass { parsed: true } to run the payload through its tidy.js parser; omit it for the raw response. Auth: this family mints a bearer token automatically before each call (no credentials required).
| Method | HTTP | Path params | Query params | Parser | Auth |
|---|---|---|---|---|---|
nfl_api_combine_profiles / nflApiCombineProfiles | https://api.nfl.com/football/v2/combine/profiles | — | year, limit | parse_nfl_combine_profiles | yes |
nfl_api_draft_picks / nflApiDraftPicks | https://api.nfl.com/football/v2/draft/picks/report | — | year, limit | parse_nfl_draft_picks | yes |
nfl_api_game_summaries / nflApiGameSummaries | https://api.nfl.com/football/v2/stats/live/game-summaries | — | season, season_type → seasonType, week | parse_nfl_game_summaries | yes |
nfl_api_injuries / nflApiInjuries | https://api.nfl.com/football/v2/injuries | — | season, season_type → seasonType, week | parse_nfl_injuries | yes |
nfl_api_rosters / nflApiRosters | https://api.nfl.com/football/v2/rosters | — | season, limit | parse_nfl_rosters | yes |
nfl_api_standings / nflApiStandings | https://api.nfl.com/football/v2/standings | — | season, season_type → seasonType, week, limit | parse_nfl_standings | yes |
nfl_api_team / nflApiTeam | https://api.nfl.com/football/v2/teams/{team_id} | team_id* | — | parse_nfl_team | yes |
nfl_api_teams_history / nflApiTeamsHistory | https://api.nfl.com/football/v2/teams/history | — | season, limit | parse_nfl_teams_history | yes |
nfl_api_weekly_game_details / nflApiWeeklyGameDetails | https://api.nfl.com/football/v2/experience/weekly-game-details | — | season, season_type → type, week, include_drive_chart → includeDriveChart, include_replays → includeReplays, include_standings → includeStandings, include_tagged_videos → includeTaggedVideos | parse_nfl_weekly_game_details | yes |
nfl_api_weeks / nflApiWeeks | https://api.nfl.com/football/v2/weeks/season/{season}/seasonType/{season_type} | season, season_type | — | parse_nfl_weeks | yes |
nfl_api_weeks_by_date / nflApiWeeksByDate | https://api.nfl.com/football/v2/weeks/date/{date} | date* | — | parse_nfl_weeks_by_date | yes |
Returns — nfl_api_combine_profiles / nflApiCombineProfiles
| col_name | type | description |
|---|---|---|
id | character | NFL.com Shield GUID for the combine profile. |
year | integer | Combine / draft class year. |
person_id | character | NFL.com Shield GUID of the prospect. |
person_display_name | character | Prospect's full display name. |
person_esb_id | character | Prospect's Elias Sports Bureau (ESB) identifier. |
person_first_name | character | Prospect's first name. |
person_last_name | character | Prospect's last name. |
person_hometown | character | Prospect's hometown (city, state). |
person_college_names | character | JSON-stringified array of the prospect's college(s). |
arm_length | numeric | Arm length measured at the combine, in inches. |
athleticism_score | numeric | Composite athleticism score. |
bench_press | numeric | Bench-press measurement object (flattened; null when no measurement). |
broad_jump | numeric | Broad-jump measurement object (flattened; null when no measurement). |
bio | character | HTML biography / career summary for the prospect. |
college_class | character | Prospect's college class (e.g. Senior, Junior). |
draft_grade | numeric | Numeric draft grade assigned to the prospect. |
draft_projection | character | Draft projection text (e.g. "Priority free agent"). |
forty_yard_dash | numeric | 40-yard-dash measurement object (flattened; null when no measurement). |
grade | numeric | Overall prospect grade. |
hand_size | integer | Hand size measured at the combine, in inches. |
headshot | character | Templated URL of the prospect's headshot image. |
height | integer | Prospect height, in inches. |
nfl_comparison | character | Player the prospect is most comparable to. |
overview | character | HTML scouting overview of the prospect. |
production_score | numeric | Composite college-production score. |
profile_author | character | Author of the scouting profile (e.g. "Lance Zierlein"). |
pro_forty_yard_dash | numeric | Pro-day 40-yard-dash measurement object (flattened; null when no measurement). |
sixty_yard_shuttle | numeric | 60-yard-shuttle measurement object (flattened; null when no measurement). |
size_score | numeric | Composite size score (flattened; null when not scored). |
sources_tell_us | character | "Sources tell us" scouting commentary text. |
strengths | character | HTML list of the prospect's strengths. |
ten_yard_split | numeric | 10-yard-split measurement object (flattened; null when no measurement). |
three_cone_drill | numeric | Three-cone-drill measurement object (flattened; null when no measurement). |
twenty_yard_shuttle | numeric | 20-yard-shuttle measurement object (flattened; null when no measurement). |
weaknesses | character | HTML list of the prospect's weaknesses. |
combine_attendance | logical | Whether the prospect attended the combine. |
position | character | Prospect's position abbreviation (e.g. "CB"). |
position_group | character | Prospect's position group (e.g. "DB"). |
vertical_jump | numeric | Vertical-jump measurement object (flattened; null when no measurement). |
weight | integer | Prospect weight, in pounds. |
pro_forty_yard_dash_designation | character | Designation for the pro-day 40-yard dash (OFFICIAL or UNOFFICIAL). |
pro_forty_yard_dash_seconds | numeric | Pro-day 40-yard-dash time, in seconds. |
bench_press_designation | character | Designation for the bench-press result (OFFICIAL or UNOFFICIAL). |
bench_press_repetitions | integer | Number of 225 lb bench-press repetitions. |
broad_jump_designation | character | Designation for the broad-jump result (OFFICIAL or UNOFFICIAL). |
broad_jump_inches | integer | Broad-jump distance, in inches. |
forty_yard_dash_designation | character | Designation for the 40-yard-dash result (OFFICIAL or UNOFFICIAL). |
forty_yard_dash_seconds | numeric | 40-yard-dash time, in seconds. |
ten_yard_split_designation | character | Designation for the 10-yard-split result (OFFICIAL or UNOFFICIAL). |
ten_yard_split_seconds | numeric | 10-yard-split time, in seconds. |
vertical_jump_designation | character | Designation for the vertical-jump result (OFFICIAL or UNOFFICIAL). |
vertical_jump_inches | integer | Vertical-jump height, in inches. |
three_cone_drill_designation | character | Designation for the three-cone-drill result (OFFICIAL or UNOFFICIAL). |
three_cone_drill_seconds | numeric | Three-cone-drill time, in seconds. |
twenty_yard_shuttle_designation | character | Designation for the 20-yard-shuttle result (OFFICIAL or UNOFFICIAL). |
twenty_yard_shuttle_seconds | numeric | 20-yard-shuttle time, in seconds. |
Returns — nfl_api_draft_picks / nflApiDraftPicks
| col_name | type | description |
|---|---|---|
year | integer | Draft year. |
draft_round | integer | Round of the draft in which the pick was made. |
draft_position | integer | Pick position within the round. |
draft_number_overall | integer | Overall pick number across the entire draft. |
person_id | character | NFL.com Shield GUID of the drafted player (may be empty until the pick is announced). |
pick_is_in | logical | Whether the pick has officially been submitted / announced. |
team_id | character | NFL.com Shield GUID of the team making the pick. |
trade_note | character | Trade annotation for the pick (e.g. "CAR>CHI" denoting a traded selection). |
tweet_sent | logical | Whether the announcement tweet has been sent for the pick. |
tweets_sent | character | JSON-stringified array of per-account tweet-sent status objects. |
Returns — nfl_api_game_summaries / nflApiGameSummaries
| col_name | type | description |
|---|---|---|
game_id | character | NFL.com Shield GUID for the game. |
offset | integer | Live-feed sequence offset for the summary snapshot. |
attendance | integer | Announced game attendance. |
clock | character | Game clock at the snapshot (MM:SS). |
distance | integer | Yards to gain for a first down at the snapshot. |
down | integer | Current down (1-4) at the snapshot. |
game_book_url | character | URL of the official game book image. |
is_goal_to_go | logical | Whether the current situation is goal-to-go. |
is_red_zone | logical | Whether the ball is in the red zone. |
phase | character | Game phase (e.g. PREGAME, INGAME, HALFTIME, FINAL). |
quarter | character | Current period descriptor (e.g. Q1, HALFTIME, END_OF_GAME). |
start_time | character | ISO 8601 kickoff timestamp. |
weather | character | Weather summary string (temperature, humidity, wind). |
yard_line | character | Current line of scrimmage (e.g. "KC 10"). |
away_team_team_id | character | NFL.com Shield GUID of the away team. |
away_team_has_possession | logical | Whether the away team has possession at the snapshot. |
away_team_score_q1 | integer | Away team points scored in the first quarter. |
away_team_score_q2 | integer | Away team points scored in the second quarter. |
away_team_score_q3 | integer | Away team points scored in the third quarter. |
away_team_score_q4 | integer | Away team points scored in the fourth quarter. |
away_team_score_ot | integer | Away team points scored in overtime. |
away_team_score_total | integer | Away team total points. |
away_team_timeouts_remaining | integer | Away team timeouts remaining at the snapshot. |
away_team_timeouts_used | integer | Away team timeouts used at the snapshot. |
home_team_team_id | character | NFL.com Shield GUID of the home team. |
home_team_has_possession | logical | Whether the home team has possession at the snapshot. |
home_team_score_q1 | integer | Home team points scored in the first quarter. |
home_team_score_q2 | integer | Home team points scored in the second quarter. |
home_team_score_q3 | integer | Home team points scored in the third quarter. |
home_team_score_q4 | integer | Home team points scored in the fourth quarter. |
home_team_score_ot | integer | Home team points scored in overtime. |
home_team_score_total | integer | Home team total points. |
home_team_timeouts_remaining | integer | Home team timeouts remaining at the snapshot. |
home_team_timeouts_used | integer | Home team timeouts used at the snapshot. |
Returns — nfl_api_injuries / nflApiInjuries
| col_name | type | description |
|---|---|---|
season | integer | Season (year) of the injury report. |
season_type | character | Season type code (PRE, REG, or POST). |
week | integer | Week number of the injury report. |
team_id | character | NFL.com Shield GUID of the player's team. |
team_current_logo | character | Templated URL of the team's current logo. |
team_full_name | character | Full team name (e.g. "Atlanta Falcons"). |
person_id | character | NFL.com Shield GUID of the injured player. |
person_first_name | character | Player's first name. |
person_common_first_name | character | Player's common / preferred first name. |
person_last_name | character | Player's last name. |
person_display_name | character | Player's full display name. |
person_gsis_id | character | Player's NFL GSIS identifier (e.g. "00-0036948"). |
person_headshot | character | Templated URL of the player's headshot image. |
injuries | character | JSON-stringified array of detailed injury objects (empty when not specified). |
injury_status | character | Game-status designation (e.g. OUT, DOUBTFUL, QUESTIONABLE). |
practices | character | JSON-stringified array of practice-participation notes. |
practice_days | character | JSON-stringified array of per-day practice status objects (date, status). |
practice_status | character | Most recent practice-participation status (e.g. FULL, LIMITED, DNP). |
position | character | Player's position abbreviation (e.g. "DE"). |
Returns — nfl_api_rosters / nflApiRosters
| col_name | type | description |
|---|---|---|
season | integer | Season (year) of the roster. |
season_type | character | Season type code (PRE, REG, or POST). |
team_id | character | NFL.com Shield GUID for the team. |
team_abbreviation | character | Team abbreviation (e.g. "ARI"). |
team_full_name | character | Full team name (e.g. "Arizona Cardinals"). |
team_conference_abbr | character | Conference abbreviation (AFC or NFC). |
team_conference_full_name | character | Full conference name (e.g. "National Football Conference"). |
team_current_logo | character | Templated URL of the team's current logo. |
team_division_full_name | character | Full division name (e.g. "NFC West"). |
team_league | character | League name ("National Football League"). |
team_location | character | Team location / city (e.g. "Arizona"). |
team_nick_name | character | Team nickname (e.g. "Cardinals"). |
team_venues | character | JSON-stringified array of the team's venue objects (id, name, etc.). |
persons | character | JSON-stringified array of roster player objects for the team. |
Returns — nfl_api_standings / nflApiStandings
| col_name | type | description |
|---|---|---|
team_id | character | NFL.com Shield GUID for the team. |
team_current_logo | character | Templated URL of the team's current logo. |
team_full_name | character | Full team name (e.g. "Arizona Cardinals"). |
clinched_bye | logical | Whether the team has clinched a first-round playoff bye. |
clinched_division | logical | Whether the team has clinched its division. |
clinched_eliminated | logical | Whether the team has been mathematically eliminated from playoff contention. |
clinched_home_field | logical | Whether the team has clinched home-field advantage throughout the playoffs. |
clinched_playoff | logical | Whether the team has clinched a playoff berth. |
clinched_wild_card | logical | Whether the team has clinched a wild-card playoff berth. |
close_games_wins | integer | Wins in close games (decided by one score / 8 points or fewer). |
close_games_losses | integer | Losses in close games (decided by one score / 8 points or fewer). |
close_games_ties | integer | Ties in close games. |
conference_wins | integer | Wins against conference (AFC/NFC) opponents. |
conference_win_pct | numeric | Win percentage against conference opponents. |
conference_losses | integer | Losses against conference opponents. |
conference_ties | integer | Ties against conference opponents. |
conference_rank | integer | Standings rank within the conference. |
conference_points_for | integer | Points scored in conference games. |
conference_points_against | integer | Points allowed in conference games. |
division_wins | integer | Wins against division opponents. |
division_win_pct | numeric | Win percentage against division opponents. |
division_losses | integer | Losses against division opponents. |
division_ties | integer | Ties against division opponents. |
division_rank | integer | Standings rank within the division. |
division_points_for | integer | Points scored in division games. |
division_points_against | integer | Points allowed in division games. |
home_wins | integer | Wins in home games. |
home_win_pct | numeric | Win percentage in home games. |
home_losses | integer | Losses in home games. |
home_ties | integer | Ties in home games. |
home_points_for | integer | Points scored in home games. |
home_points_against | integer | Points allowed in home games. |
last5_wins | integer | Wins over the last five games. |
last5_win_pct | numeric | Win percentage over the last five games. |
last5_losses | integer | Losses over the last five games. |
last5_ties | integer | Ties over the last five games. |
last5_points_for | integer | Points scored over the last five games. |
last5_points_against | integer | Points allowed over the last five games. |
overall_games | integer | Total games played. |
overall_wins | integer | Total wins. |
overall_win_pct | numeric | Overall win percentage. |
overall_losses | integer | Total losses. |
overall_ties | integer | Total ties. |
overall_points_for | integer | Total points scored. |
overall_points_against | integer | Total points allowed. |
overall_streak_type | character | Current streak type ("W" for winning, "L" for losing). |
overall_streak_length | integer | Length of the current win/loss streak. |
road_wins | integer | Wins in road (away) games. |
road_win_pct | numeric | Win percentage in road games. |
road_losses | integer | Losses in road games. |
road_ties | integer | Ties in road games. |
road_points_for | integer | Points scored in road games. |
road_points_against | integer | Points allowed in road games. |
Returns — nfl_api_team / nflApiTeam
| col_name | type | description |
|---|---|---|
id | character | NFL.com Shield GUID for the team. |
bio | character | Team biography / description text (may be null). |
current_background | character | Templated URL of the team's current background image. |
current_coach | character | Name of the team's current head coach. |
current_logo | character | Templated URL of the team's current logo. |
primary_color | character | Team primary color (hex code). |
secondary_color | character | Team secondary color (hex code). |
year_established | integer | Year the franchise was established. |
full_name | character | Full team name (e.g. "Arizona Cardinals"). |
nfl_shop_url | character | URL to the team's NFL Shop storefront. |
official_website_url | character | URL of the team's official website. |
owners | character | Name(s) of the team's owner(s). |
team_type | character | Team type classification (e.g. "TEAM"). |
socials | character | JSON-stringified array of the team's social-media links (platform, link). |
vll_channel_callsign | character | Verizon Live League (VLL) channel call sign for the team. |
Returns — nfl_api_teams_history / nflApiTeamsHistory
| col_name | type | description |
|---|---|---|
id | character | NFL.com Shield GUID for the team (or Pro Bowl team entry). |
season | integer | Season (year) the team record applies to. |
abbreviation | character | Team abbreviation (e.g. "AFC", "ARI"). |
full_name | character | Full team name (e.g. "AFC Pro Bowl Team", "Arizona Cardinals"). |
team_type | character | Team type classification (e.g. "TEAM", "PRO" for Pro Bowl teams). |
conference_abbr | character | Conference abbreviation (AFC or NFC). |
conference_full_name | character | Full conference name (e.g. "American Football Conference"). |
current_logo | character | Templated URL of the team's current logo. |
division_full_name | character | Full division name (e.g. "NFC West"). |
league | character | League name ("National Football League"). |
location | character | Team location / city. |
nick_name | character | Team nickname. |
venues | character | JSON-stringified array of the team's venue objects (empty for non-club entries). |
Returns — nfl_api_weekly_game_details / nflApiWeeklyGameDetails
| col_name | type | description |
|---|---|---|
id | character | NFL.com Shield GUID for the game. |
home_team_id | character | NFL.com Shield GUID of the home team. |
home_team_current_logo | character | Templated URL of the home team's current logo. |
home_team_full_name | character | Full home-team name (e.g. "Kansas City Chiefs"). |
away_team_id | character | NFL.com Shield GUID of the away team. |
away_team_current_logo | character | Templated URL of the away team's current logo. |
away_team_full_name | character | Full away-team name (e.g. "Baltimore Ravens"). |
category | character | Game category / window (e.g. SNF, MNF, TNF). |
date | character | Game date (YYYY-MM-DD). |
time | character | ISO 8601 kickoff timestamp. |
broadcast_info_home_network_channels | character | JSON-stringified array of broadcast channels in the home market. |
broadcast_info_away_network_channels | character | JSON-stringified array of broadcast channels in the away market. |
broadcast_info_international_watch_options | character | JSON-stringified array of international broadcaster options by country. |
broadcast_info_streaming_networks | character | JSON-stringified array of streaming-network objects. |
broadcast_info_territory | character | Broadcast territory designation (e.g. NATIONAL, REGIONAL). |
broadcast_info_audio_networks | character | JSON-stringified array of audio-broadcast network objects. |
game_type | character | Game type classification (e.g. UNSPECIFIED, REG, WC). |
international | logical | Whether the game is played at an international venue. |
neutral_site | logical | Whether the game is played at a neutral site. |
venue_id | character | NFL.com Shield GUID of the venue. |
venue_name | character | Venue name (e.g. "GEHA Field at Arrowhead Stadium"). |
venue_city | character | Venue city. |
venue_country | character | Venue country. |
season | integer | Season (year) of the game. |
season_type | character | Season type code (PRE, REG, or POST). |
status | character | Game status (e.g. SCHEDULED, INGAME, FINAL). |
week | integer | Week number of the game. |
week_type | character | Week type code (e.g. PRE, REG, WC, DIV, CONF, SB). |
external_ids | character | JSON-stringified array of external game identifiers (elias, gsis, etc.). |
ticket_url | character | Primary ticket-purchase URL for the game. |
ticket_vendors | character | JSON-stringified array of ticket-vendor objects (vendor name, URL). |
extensions | character | JSON-stringified array of extension objects (empty when none). |
version | integer | Record version number. |
summary_game_id | character | NFL.com Shield GUID for the game (from the embedded live summary). |
summary_offset | integer | Live-feed sequence offset for the embedded summary snapshot. |
summary_attendance | integer | Announced game attendance (from the embedded summary). |
summary_clock | character | Game clock at the summary snapshot (MM:SS). |
summary_distance | integer | Yards to gain for a first down at the summary snapshot. |
summary_down | integer | Current down (1-4) at the summary snapshot. |
summary_game_book_url | character | URL of the official game book image (from the embedded summary). |
summary_is_goal_to_go | logical | Whether the situation is goal-to-go at the summary snapshot. |
summary_is_red_zone | logical | Whether the ball is in the red zone at the summary snapshot. |
summary_phase | character | Game phase (e.g. PREGAME, INGAME, HALFTIME, FINAL). |
summary_quarter | character | Current period descriptor (e.g. Q1, HALFTIME, END_OF_GAME). |
summary_start_time | character | ISO 8601 kickoff timestamp (from the embedded summary). |
summary_weather | character | Weather summary string (temperature, humidity, wind). |
summary_yard_line | character | Current line of scrimmage at the summary snapshot (e.g. "KC 10"). |
summary_away_team_team_id | character | NFL.com Shield GUID of the away team (from the embedded summary). |
summary_away_team_has_possession | logical | Whether the away team has possession at the summary snapshot. |
summary_away_team_score_q1 | integer | Away team points scored in the first quarter. |
summary_away_team_score_q2 | integer | Away team points scored in the second quarter. |
summary_away_team_score_q3 | integer | Away team points scored in the third quarter. |
summary_away_team_score_q4 | integer | Away team points scored in the fourth quarter. |
summary_away_team_score_ot | integer | Away team points scored in overtime. |
summary_away_team_score_total | integer | Away team total points. |
summary_away_team_timeouts_remaining | integer | Away team timeouts remaining at the summary snapshot. |
summary_away_team_timeouts_used | integer | Away team timeouts used at the summary snapshot. |
summary_home_team_team_id | character | NFL.com Shield GUID of the home team (from the embedded summary). |
summary_home_team_has_possession | logical | Whether the home team has possession at the summary snapshot. |
summary_home_team_score_q1 | integer | Home team points scored in the first quarter. |
summary_home_team_score_q2 | integer | Home team points scored in the second quarter. |
summary_home_team_score_q3 | integer | Home team points scored in the third quarter. |
summary_home_team_score_q4 | integer | Home team points scored in the fourth quarter. |
summary_home_team_score_ot | integer | Home team points scored in overtime. |
summary_home_team_score_total | integer | Home team total points. |
summary_home_team_timeouts_remaining | integer | Home team timeouts remaining at the summary snapshot. |
summary_home_team_timeouts_used | integer | Home team timeouts used at the summary snapshot. |
drive_chart_game_id | character | NFL.com Shield GUID for the game (from the drive chart, present when include_drive_chart=true). |
drive_chart_offset | integer | Live-feed sequence offset for the drive-chart snapshot. |
drive_chart_drives | character | JSON-stringified array of drive objects (sequence, team, result, etc.). |
drive_chart_plays | character | JSON-stringified array of play objects within the drive chart. |
drive_chart_scoring_summaries | character | JSON-stringified array of scoring-summary objects (sequence, scores, clock). |
replays | character | JSON-stringified array of replay objects (populated only when include_replays=true). |
tagged_videos | character | JSON-stringified array of tagged-video objects (populated only when include_tagged_videos=true). |
away_team_standings | character | JSON-stringified away-team standings object (populated only when include_standings=true). |
home_team_standings | character | JSON-stringified home-team standings object (populated only when include_standings=true). |
Returns — nfl_api_weeks / nflApiWeeks
| col_name | type | description |
|---|---|---|
season | integer | Season (year) of the week. |
season_type | character | Season type code (PRE, REG, or POST). |
week | integer | Week number within the season type. |
bye_teams | character | JSON-stringified array of teams on bye during the week (empty when none). |
date_begin | character | Start date of the week (YYYY-MM-DD). |
date_end | character | End date of the week (YYYY-MM-DD). |
week_type | character | Week type code (e.g. PRE, REG, WC, DIV, CONF, SB). |
Returns — nfl_api_weeks_by_date / nflApiWeeksByDate
| col_name | type | description |
|---|---|---|
season | integer | Season (year) the date falls in. |
season_type | character | Season type code (PRE, REG, or POST). |
week | integer | Week number that the queried date falls within. |
bye_teams | character | JSON-stringified array of teams on bye during the week (empty when none). |
date_begin | character | Start date of the week (YYYY-MM-DD). |
date_end | character | End date of the week (YYYY-MM-DD). |
week_type | character | Week type code (e.g. PRE, REG, WC, DIV, CONF, SB). |