Skip to content

NFL Models

models

Territory module-attribute 

Territory = Literal['NATIONAL', 'REGIONAL']

Broadcast territory scope

CameraSource module-attribute 

CameraSource = Literal['Endzone', 'Sideline', 'Broadcast']

Camera angle/source for the video

CoachesFilmVideoType module-attribute 

CoachesFilmVideoType = Literal['video',]

Content type (always \"video\")

SubType module-attribute 

SubType = Literal['Coaches Film', 'Coaches Film Pro']

Video subtype classification

CurrentGameCategory module-attribute 

CurrentGameCategory = Literal['MNF', 'SNF', 'TNF', 'OTHER']

Prime time game designation

FantasyPlayerStatsPosition module-attribute 

FantasyPlayerStatsPosition = Literal[
    "QB", "RB", "WR", "TE", "K", "DST"
]

Player position

PositionGroup module-attribute 

PositionGroup = Literal['QB', 'RB', 'WR', 'TE', 'SPEC']

Position group

GameCategory module-attribute 

GameCategory = Literal['MNF', 'SNF', 'TNF', 'OTHER']

Prime time game designation

GameStatus module-attribute 

GameStatus = Literal[
    "SCHEDULED",
    "IN_PROGRESS",
    "FINAL",
    "POSTPONED",
    "CANCELLED",
    "FINAL_OVERTIME",
]

Game status

InjuryEntryGameStatus module-attribute 

InjuryEntryGameStatus = Literal[
    "QUESTIONABLE", "DOUBTFUL", "OUT", "IR"
]

Game status designation

InsightPosition module-attribute 

InsightPosition = Literal[
    "QB", "RB", "WR", "TE", "OL", "DL", "LB", "DB", "K", "P"
]

Player position

SecondTeamType module-attribute 

SecondTeamType = Literal['offense', 'defense']

Context of the second team (typically \"defense\" for opponent)

OverallRecordType module-attribute 

OverallRecordType = Literal[
    "W",
    "L",
    "T",
    "STREAK_TYPE_WINNING",
    "STREAK_TYPE_LOSING",
    "STREAK_TYPE_TYING",
]

Type of current streak

PlayDirection module-attribute 

PlayDirection = Literal['left', 'right', 'middle']

Direction of play

PlayState module-attribute 

PlayState = Literal['APPROVED', 'PENDING', 'REVIEWED']

Review state of play

TypePlayer module-attribute 

TypePlayer = Literal['player',]

Resource type

ProGameCategory module-attribute 

ProGameCategory = Literal['MNF', 'SNF', 'TNF', 'OTHER']

Prime time game designation

ProGameStatus module-attribute 

ProGameStatus = Literal[
    "SCHEDULED",
    "IN_PROGRESS",
    "FINAL",
    "POSTPONED",
    "CANCELLED",
    "FINAL_OVERTIME",
]

Game status

ProTeamConferenceAbbr module-attribute 

ProTeamConferenceAbbr = Literal['AFC', 'NFC']

Conference abbreviation

ProTeamTeamType module-attribute 

ProTeamTeamType = Literal['TEAM', 'PRO']

Type of team (regular or Pro Bowl)

ProWeekWeekType module-attribute 

ProWeekWeekType = Literal['HOF', 'PRE', 'REG']

Type of week

TeamConferenceAbbr module-attribute 

TeamConferenceAbbr = Literal['AFC', 'NFC']

Conference abbreviation

TeamTeamType module-attribute 

TeamTeamType = Literal['TEAM', 'PRO']

Type of team (regular or Pro Bowl)

WeekWeekType module-attribute 

WeekWeekType = Literal['HOF', 'PRE', 'REG']

Type of week

WeeklyGameDetailCategory module-attribute 

WeeklyGameDetailCategory = Literal[
    "MNF", "SNF", "TNF", "OTHER"
]

Prime time game designation

WeeklyGameDetailStatus module-attribute 

WeeklyGameDetailStatus = Literal[
    "SCHEDULED",
    "IN_PROGRESS",
    "FINAL",
    "POSTPONED",
    "CANCELLED",
    "FINAL_OVERTIME",
]

Game status

BinaryFlagEnum module-attribute 

BinaryFlagEnum = Literal[0, 1]

Binary flag for boolean filters (0=false, 1=true)

CombinePositionEnum module-attribute 

CombinePositionEnum = Literal[
    "C",
    "CB",
    "DE",
    "DT",
    "EDGE",
    "FB",
    "FS",
    "G",
    "ILB",
    "IOL",
    "K",
    "LB",
    "LS",
    "NT",
    "OG",
    "OLB",
    "OT",
    "P",
    "QB",
    "RB",
    "S",
    "SS",
    "T",
    "TE",
    "WR",
]

NFL Combine prospect position

CombinePositionGroupEnum module-attribute 

CombinePositionGroupEnum = Literal[
    "DB", "DL", "LB", "OL", "QB", "RB", "SPEC", "TE", "WR"
]

NFL Combine prospect position group

ConferenceEnum module-attribute 

ConferenceEnum = Literal['AFC', 'NFC']

NFL conference

DefensivePositionGroupEnum module-attribute 

DefensivePositionGroupEnum = Literal['DB', 'DL', 'LB']

Defensive position group

GameResultEnum module-attribute 

GameResultEnum = Literal['W', 'L', 'T']

Game result (Win/Loss/Tie)

GameStatusEnum module-attribute 

GameStatusEnum = Literal[
    "CANCELLED",
    "FINAL",
    "IN_PROGRESS",
    "POSTPONED",
    "SCHEDULED",
    "FINAL_OVERTIME",
]

Game status

MeridiemEnum module-attribute 

MeridiemEnum = Literal['AM', 'PM']

Time of day indicator

OffensivePlayerPositionEnum module-attribute 

OffensivePlayerPositionEnum = Literal[
    "FB", "QB", "RB", "TE", "WR"
]

Offensive player position

OffensiveSkillPositionEnum module-attribute 

OffensiveSkillPositionEnum = Literal["FB", "RB", "TE", "WR"]

Offensive skill position (excluding QB)

PassingStatsCategoryEnum module-attribute 

PassingStatsCategoryEnum = Literal[
    "cmp",
    "att",
    "yds",
    "td",
    "int",
    "rating",
    "ypa",
    "cmpPct",
    "sack",
    "xCmp",
    "cpoe",
    "db",
    "epa",
    "epaDb",
    "avgTTT",
    "avgTTP",
    "avgTTS",
    "qbp",
    "qbpR",
    "blitzR",
    "drop",
    "dropR",
    "ay",
    "yac",
    "xYac",
    "yacPct",
    "ayAtt",
    "avgSep",
    "deepAttPct",
    "paDbPct",
    "twAttPct",
]

Statistics categories for passing stats sorting

PlayStateEnum module-attribute 

PlayStateEnum = Literal[
    "IN_PROGRESS", "POST_PLAY", "PRE_SNAP"
]

State of a play during a game

PlayTypeEnum module-attribute 

PlayTypeEnum = Literal[
    "play_type_kickoff",
    "play_type_field_goal",
    "play_type_rush",
    "play_type_sack",
    "play_type_two_point_conversion",
    "play_type_xp",
    "play_type_pass",
    "play_type_punt",
    "play_type_unknown",
    "PASS",
    "RUSH",
    "PUNT",
    "KICKOFF",
    "FIELD_GOAL",
    "EXTRA_POINT",
    "PENALTY",
    "TIMEOUT",
    "TWO_MINUTE_WARNING",
]

Enumeration of all possible play types

PlayerPositionEnum module-attribute 

PlayerPositionEnum = Literal[
    "C",
    "CB",
    "DB",
    "DE",
    "DL",
    "DT",
    "FB",
    "FS",
    "G",
    "ILB",
    "K",
    "LB",
    "LS",
    "MLB",
    "NT",
    "OG",
    "OL",
    "OLB",
    "OT",
    "P",
    "QB",
    "RB",
    "SAF",
    "SS",
    "T",
    "TE",
    "WR",
]

NFL player position

PlayerPositionGroupEnum module-attribute 

PlayerPositionGroupEnum = Literal[
    "DB", "DL", "LB", "OL", "QB", "RB", "SPEC", "TE", "WR"
]

NFL player position group

PlayerStatusEnum module-attribute 

PlayerStatusEnum = Literal[
    "ACT",
    "CUT",
    "DEV",
    "EXE",
    "INA",
    "NFI",
    "NWT",
    "PRA",
    "PUP",
    "RES",
    "RET",
    "RSN",
    "SUS",
    "TRD",
    "TRL",
    "UDF",
]

NFL player roster status

DefenseNGSPositionEnum module-attribute 

DefenseNGSPositionEnum = Literal[
    "S", "CB", "SCB", "LB", "DE", "DT", "ED"
]

Next Gen Stats position

PracticeStatusEnum module-attribute 

PracticeStatusEnum = Literal[
    "DNP", "LIMITED", "FULL", "NOT_LISTED"
]

Player practice participation status

ReceivingStatsCategoryEnum module-attribute 

ReceivingStatsCategoryEnum = Literal[
    "rt",
    "tgt",
    "rec",
    "yds",
    "td",
    "int",
    "rating",
    "catch",
    "xCatch",
    "croe",
    "ydsRec",
    "ydsRt",
    "epa",
    "epaTgt",
    "epaRt",
    "drop",
    "yac",
    "xYac",
    "yacoe",
    "yacRec",
    "avgSep",
    "ay",
    "ayTgt",
    "tgtRt",
    "avgRtDep",
    "ezTgt",
    "ezRec",
    "deepTgtPct",
    "twPct",
]

Statistics categories for receiving stats sorting

SeasonTypeEnum module-attribute 

SeasonTypeEnum = Literal['PRE', 'REG', 'POST']

Type of NFL season

SortOrderEnum module-attribute 

SortOrderEnum = Literal['ASC', 'DESC']

Sort direction for ordered results

TeamDefenseStatsSortKeyEnum module-attribute 

TeamDefenseStatsSortKeyEnum = Literal[
    "total",
    "pass",
    "run",
    "yds",
    "passPct",
    "ypp",
    "td",
    "passTd",
    "rushTd",
    "epa",
    "epaPP",
    "passYds",
    "passYpp",
    "epaPass",
    "epaPassPP",
    "rushYds",
    "rushYpp",
    "epaRush",
    "epaRushPP",
    "ttt",
    "qbp",
    "qbpPct",
    "sackedYds",
    "ryoe",
    "interception",
    "forcedFumble",
    "fumbleRecovered",
    "defensiveTouchdown",
    "totalTakeaways",
    "ppg",
    "ypg",
    "passYpg",
    "rushYpg",
    "sackedYpg",
]

Field to sort team defense stats by

TeamDefenseStatsSplitEnum module-attribute 

TeamDefenseStatsSplitEnum = Literal[
    "TEAM_DEFENSE_BASE",
    "TEAM_DEFENSE_NICKEL",
    "TEAM_DEFENSE_DIME",
    "TEAM_DEFENSE_WHEN_LEADING",
    "TEAM_DEFENSE_WHEN_TRAILING",
    "TEAM_DEFENSE_WHEN_TIED",
    "TEAM_DEFENSE_RED_ZONE",
    "TEAM_DEFENSE_GOAL_TO_GO",
    "TEAM_DEFENSE_SHOTGUN",
    "TEAM_DEFENSE_UNDER_CENTER",
    "TEAM_DEFENSE_PISTOL",
    "TEAM_DEFENSE_MOTION",
]

Defensive situation splits

TeamTypeEnum module-attribute 

TeamTypeEnum = Literal['PRO', 'TEAM']

Team type classification

WeekSlugEnum module-attribute 

WeekSlugEnum = Literal[
    "WEEK_1",
    "WEEK_10",
    "WEEK_11",
    "WEEK_12",
    "WEEK_13",
    "WEEK_14",
    "WEEK_15",
    "WEEK_16",
    "WEEK_17",
    "WEEK_18",
    "WEEK_2",
    "WEEK_3",
    "WEEK_4",
    "WEEK_5",
    "WEEK_6",
    "WEEK_7",
    "WEEK_8",
    "WEEK_9",
]

Week identifier slug

GetDefensiveOverviewStatsBySeasonSortKey module-attribute 

GetDefensiveOverviewStatsBySeasonSortKey = Literal[
    "snap",
    "rd",
    "pr",
    "tck",
    "tStop",
    "hStop",
    "qbp",
    "qbpR",
    "sack",
    "tgtNd",
    "recNd",
    "recYdsNd",
    "recTdNd",
    "int",
    "passRatingNd",
    "gameSnap",
    "snapPct",
]

Field to sort by

GetDefensiveOverviewStatsByWeekSortKey module-attribute 

GetDefensiveOverviewStatsByWeekSortKey = Literal[
    "snap",
    "rd",
    "pr",
    "tck",
    "tStop",
    "hStop",
    "qbp",
    "qbpR",
    "sack",
    "tgtNd",
    "recNd",
    "recYdsNd",
    "recTdNd",
    "int",
    "passRatingNd",
    "gameSnap",
    "snapPct",
]

Field to sort by

GetDefensivePassRushStatsBySeasonSortKey module-attribute 

GetDefensivePassRushStatsBySeasonSortKey = Literal[
    "pr",
    "prR",
    "qbp",
    "qbpR",
    "ttp",
    "qp",
    "sack",
    "sackR",
    "tts",
    "prGo",
    "turnQbp",
    "gameSnap",
]

Field to sort by

GetDefensivePassRushStatsByWeekSortKey module-attribute 

GetDefensivePassRushStatsByWeekSortKey = Literal[
    "pr",
    "prR",
    "qbp",
    "qbpR",
    "ttp",
    "qp",
    "sack",
    "sackR",
    "tts",
    "prGo",
    "turnQbp",
    "gameSnap",
]

Field to sort by

GetDefensiveStatsBySeasonSortKey module-attribute 

GetDefensiveStatsBySeasonSortKey = Literal[
    "cov",
    "covNd",
    "tgtNd",
    "recNd",
    "recYdsNd",
    "recTdNd",
    "int",
    "passRatingNd",
    "tgtEpaNd",
    "catchNd",
    "croeNd",
    "bhPct",
    "sep",
    "twfPct",
    "yacprNd",
    "tgtRNd",
]

Field to sort by

GetFantasyStatsBySeasonSortKey module-attribute 

GetFantasyStatsBySeasonSortKey = Literal[
    "fpStd",
    "fpPpr",
    "fpHalfPpr",
    "passYds",
    "passTd",
    "passInt",
    "rushYds",
    "rushTd",
    "recYds",
    "recTd",
    "rec",
    "tgt",
    "snapPct",
    "targetShare",
    "redZoneTargets",
]

Field to sort by

GetPlayerRushingStatsBySeasonSortKey module-attribute 

GetPlayerRushingStatsBySeasonSortKey = Literal[
    "att",
    "yds",
    "td",
    "ypc",
    "epa",
    "epaAtt",
    "xRy",
    "xYpc",
    "ryoe",
    "ryoeAtt",
    "yaco",
    "yacoAtt",
    "ybco",
    "success",
    "fum",
    "lost",
    "rush10PYds",
    "rush15PMph",
    "rush20PMph",
    "eff",
    "inTPct",
    "stBoxPct",
    "underPct",
]

Field to sort by

GetPlayerRushingStatsByWeekSortKey module-attribute 

GetPlayerRushingStatsByWeekSortKey = Literal[
    "att",
    "yds",
    "td",
    "ypc",
    "epa",
    "epaAtt",
    "xRy",
    "xYpc",
    "ryoe",
    "ryoeAtt",
    "yaco",
    "yacoAtt",
    "ybco",
    "success",
    "fum",
    "lost",
    "rush10PYds",
    "rush15PMph",
    "rush20PMph",
    "eff",
    "inTPct",
    "stBoxPct",
    "underPct",
]

Field to sort by

GameID module-attribute 

GameID = TypeAliasType('GameID', Union[str, List[str]])

Game identifier(s) in 10-digit format (YYYYMMDDNN). Can be a single game ID or multiple game IDs for batch retrieval.

GetSeasonPlayerStatsPosition module-attribute 

GetSeasonPlayerStatsPosition = Literal[
    "QB",
    "RB",
    "WR",
    "TE",
    "OL",
    "DL",
    "LB",
    "DB",
    "K",
    "P",
    "LS",
]

Filter by position group

StatCategory module-attribute 

StatCategory = Literal[
    "passing",
    "rushing",
    "receiving",
    "defense",
    "kicking",
    "punting",
    "returning",
]

Statistical category to retrieve

GetTeamDefensePassStatsBySeasonSortKey module-attribute 

GetTeamDefensePassStatsBySeasonSortKey = Literal[
    "total",
    "pass",
    "passPct",
    "passTd",
    "passYds",
    "passYpp",
    "epaPass",
    "epaPassPP",
    "ttt",
    "qbp",
    "qbpPct",
    "sackedYds",
    "sack",
    "sackPct",
    "ttp",
    "blitzPct",
    "yac",
    "yacoe",
    "sep",
    "go",
    "passYpg",
    "sackedYpg",
]

Field to sort by

GetTeamDefensePassStatsByWeekSortKey module-attribute 

GetTeamDefensePassStatsByWeekSortKey = Literal[
    "total",
    "pass",
    "passPct",
    "passTd",
    "passYds",
    "passYpp",
    "epaPass",
    "epaPassPP",
    "ttt",
    "qbp",
    "qbpPct",
    "sackedYds",
    "sack",
    "sackPct",
    "ttp",
    "blitzPct",
    "yac",
    "yacoe",
    "sep",
    "go",
    "passYpg",
    "sackedYpg",
]

Field to sort by

GetTeamDefenseRushStatsBySeasonSortKey module-attribute 

GetTeamDefenseRushStatsBySeasonSortKey = Literal[
    "total",
    "run",
    "runPct",
    "rushTd",
    "rushYds",
    "rushYpp",
    "epaRush",
    "epaRushPP",
    "rush10PYds",
    "stuffPct",
    "ryoe",
    "ryoeAtt",
    "ybcoAtt",
    "yacoAtt",
    "inPct",
    "outPct",
    "lightPct",
    "stackedPct",
    "rushYpg",
]

Field to sort by

GetTeamDefenseRushStatsByWeekSortKey module-attribute 

GetTeamDefenseRushStatsByWeekSortKey = Literal[
    "total",
    "run",
    "runPct",
    "rushTd",
    "rushYds",
    "rushYpp",
    "epaRush",
    "epaRushPP",
    "rush10PYds",
    "stuffPct",
    "ryoe",
    "ryoeAtt",
    "ybcoAtt",
    "yacoAtt",
    "inPct",
    "outPct",
    "lightPct",
    "stackedPct",
    "rushYpg",
]

Field to sort by

GetTeamDefenseStatsBySeasonSortKey module-attribute 

GetTeamDefenseStatsBySeasonSortKey = Literal[
    "total",
    "pass",
    "run",
    "yds",
    "passPct",
    "ypp",
    "td",
    "passTd",
    "rushTd",
    "epa",
    "epaPP",
    "passYds",
    "passYpp",
    "epaPass",
    "epaPassPP",
    "rushYds",
    "rushYpp",
    "epaRush",
    "epaRushPP",
    "ttt",
    "qbp",
    "qbpPct",
    "sackedYds",
    "ryoe",
    "interception",
    "forcedFumble",
    "fumbleRecovered",
    "defensiveTouchdown",
    "totalTakeaways",
    "ppg",
    "ypg",
    "passYpg",
    "rushYpg",
    "sackedYpg",
]

Field to sort by

GetTeamOffenseStatsBySeasonSortKey module-attribute 

GetTeamOffenseStatsBySeasonSortKey = Literal[
    "total",
    "pass",
    "run",
    "yds",
    "passPct",
    "ypp",
    "td",
    "passTd",
    "rushTd",
    "epa",
    "epaPP",
    "passYds",
    "passYpp",
    "epaPass",
    "epaPassPP",
    "rushYds",
    "rushYpp",
    "epaRush",
    "epaRushPP",
    "to",
    "ppg",
    "ypg",
    "passYpg",
    "rushYpg",
    "redZonePct",
    "thirdDownPct",
]

Field to sort by

GetTeamOffenseStatsByWeekSortKey module-attribute 

GetTeamOffenseStatsByWeekSortKey = Literal[
    "total",
    "pass",
    "run",
    "yds",
    "passPct",
    "ypp",
    "td",
    "passTd",
    "rushTd",
    "epa",
    "epaPP",
    "passYds",
    "passYpp",
    "epaPass",
    "epaPassPP",
    "rushYds",
    "rushYpp",
    "epaRush",
    "epaRushPP",
    "to",
    "ppg",
    "ypg",
    "passYpg",
    "rushYpg",
    "redZonePct",
    "thirdDownPct",
]

Field to sort by

GetTeamOffensePassStatsBySeasonSortKey module-attribute 

GetTeamOffensePassStatsBySeasonSortKey = Literal[
    "total",
    "pass",
    "passPct",
    "passTd",
    "passYds",
    "passYpp",
    "epaPass",
    "epaPassPP",
    "ttt",
    "qbp",
    "qbpPct",
    "att",
    "sackedYds",
    "sack",
    "sackPct",
    "ttp",
    "blitzPct",
    "paPct",
    "yac",
    "yacoe",
    "sep",
    "passYpg",
    "sackedYpg",
]

Field to sort by

GetTeamOffensePassStatsByWeekSortKey module-attribute 

GetTeamOffensePassStatsByWeekSortKey = Literal[
    "total",
    "pass",
    "passPct",
    "passTd",
    "passYds",
    "passYpp",
    "epaPass",
    "epaPassPP",
    "ttt",
    "qbp",
    "qbpPct",
    "att",
    "sackedYds",
    "sack",
    "sackPct",
    "ttp",
    "blitzPct",
    "paPct",
    "yac",
    "yacoe",
    "sep",
    "passYpg",
    "sackedYpg",
]

Field to sort by

GetTransactionsTransactionType module-attribute 

GetTransactionsTransactionType = Literal[
    "TRADE",
    "SIGNED",
    "RELEASED",
    "WAIVED",
    "PRACTICE_SQUAD",
    "IR",
    "SUSPENDED",
]

Type of transaction

RefreshTokenRequestNetworkType module-attribute 

RefreshTokenRequestNetworkType = Literal[
    "other", "wifi", "cellular", "ethernet"
]

Type of network connection

TokenRequestNetworkType module-attribute 

TokenRequestNetworkType = Literal[
    "other", "wifi", "cellular", "ethernet"
]

Type of network connection

Award

Bases: BaseModel

NFL player award information such as MVP, All-Pro, or Pro Bowl.

BoxscoreSchedule

Bases: BaseModel

Schedule information associated with a boxscore.

game_type class-attribute instance-attribute 

game_type = None

Type of NFL season

iso_time class-attribute instance-attribute 

iso_time = None

Unix timestamp in milliseconds

ngs_game class-attribute instance-attribute 

ngs_game = None

Whether Next Gen Stats are available

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

BoxscoreScore

Bases: BaseModel

Score breakdown within a boxscore.

phase class-attribute instance-attribute 

phase = None

Game phase (P=Pregame, 1-4=Quarter, F=Final)

BoxscoreSite

Bases: BaseModel

Venue and site details for a boxscore game.

BoxscoreTeam

Bases: BaseModel

Team-level data within a boxscore.

conference_abbr class-attribute instance-attribute 

conference_abbr = None

NFL conference

team_type class-attribute instance-attribute 

team_type = None

Team type classification

BroadcastInfo

Bases: BaseModel

Broadcast and streaming information for a game.

away_network_channels class-attribute instance-attribute 

away_network_channels = None

Networks broadcasting in away market

home_network_channels class-attribute instance-attribute 

home_network_channels = None

Networks broadcasting in home market

international_watch_options class-attribute instance-attribute 

international_watch_options = None

International viewing options

territory class-attribute instance-attribute 

territory = None

Broadcast territory scope

InternationalWatchOption

Bases: BaseModel

International broadcast viewing option.

StreamingNetwork

Bases: BaseModel

Streaming network availability details.

host_network class-attribute instance-attribute 

host_network = None

Primary streaming network

networks class-attribute instance-attribute 

networks = None

Available streaming networks

CareerStats

Bases: BaseModel

Aggregated career statistics for a player.

Clinched

Bases: BaseModel

Playoff clinching status for a team.

bye class-attribute instance-attribute 

bye = None

Clinched first-round bye

division class-attribute instance-attribute 

division = None

Clinched division title

eliminated class-attribute instance-attribute 

eliminated = None

Eliminated from playoff contention

home_field class-attribute instance-attribute 

home_field = None

Clinched home field advantage

playoff class-attribute instance-attribute 

playoff = None

Clinched playoff berth

wild_card class-attribute instance-attribute 

wild_card = None

Clinched wild card berth

Background

Bases: BaseModel

Background configuration

CoachesFilmVideo

Bases: BaseModel

Coaches film video entry with metadata and assets.

camera_source instance-attribute 

camera_source

Camera angle/source for the video

description instance-attribute 

description

Play description

duration instance-attribute 

duration

Video duration in seconds

external_id instance-attribute 

external_id

External video identifier

title instance-attribute 

title

Video title

type instance-attribute 

type

Content type (always \"video\")

advertiser_id class-attribute instance-attribute 

advertiser_id = UNSET

Associated advertiser ID

author class-attribute instance-attribute 

author = UNSET

Content author

authorizations class-attribute instance-attribute 

authorizations = None

Authorization requirements for video access

background class-attribute instance-attribute 

background = None

Background configuration

clip_type class-attribute instance-attribute 

clip_type = UNSET

Type of video clip

cta_link = UNSET

Call-to-action link

cta_target class-attribute instance-attribute 

cta_target = UNSET

Call-to-action target

cta_text class-attribute instance-attribute 

cta_text = UNSET

Call-to-action text

ctas class-attribute instance-attribute 

ctas = None

Call-to-action elements

display_title class-attribute instance-attribute 

display_title = UNSET

Display title override

end_date class-attribute instance-attribute 

end_date = UNSET

Content end date

entitlement class-attribute instance-attribute 

entitlement = UNSET

Entitlement information

episode_number class-attribute instance-attribute 

episode_number = UNSET

Episode number if part of series

expiration_date class-attribute instance-attribute 

expiration_date = None

Content expiration date

fantasy_link = UNSET

Related fantasy content link

host_network class-attribute instance-attribute 

host_network = UNSET

Broadcasting network

id class-attribute instance-attribute 

id = UNSET

Internal content ID

images class-attribute instance-attribute 

images = None

Associated images

intended_audience class-attribute instance-attribute 

intended_audience = UNSET

Target audience

intro_end class-attribute instance-attribute 

intro_end = UNSET

Introduction end timestamp

language class-attribute instance-attribute 

language = UNSET

Content language

last_updated class-attribute instance-attribute 

last_updated = UNSET

Last update timestamp

mcp_playback_id class-attribute instance-attribute 

mcp_playback_id = None

Media control platform playback ID

mobile_link = UNSET

Mobile-specific link

mobile_title class-attribute instance-attribute 

mobile_title = UNSET

Mobile-specific title

original_air_date class-attribute instance-attribute 

original_air_date = None

Original broadcast air date

outro_start class-attribute instance-attribute 

outro_start = UNSET

Outro start timestamp

play_ids class-attribute instance-attribute 

play_ids = None

Play identifiers associated with this video

pre_roll_disabled class-attribute instance-attribute 

pre_roll_disabled = False

Whether pre-roll ads are disabled

promo_assets class-attribute instance-attribute 

promo_assets = None

Promotional assets

promo_link = UNSET

Promotional link

promo_target class-attribute instance-attribute 

promo_target = '_self'

Promotional link target

promo_text class-attribute instance-attribute 

promo_text = UNSET

Promotional text

publish_date class-attribute instance-attribute 

publish_date = None

Content publish date

radio_station class-attribute instance-attribute 

radio_station = UNSET

Associated radio station

series class-attribute instance-attribute 

series = UNSET

Series information

series_season class-attribute instance-attribute 

series_season = UNSET

Series season if applicable

series_title class-attribute instance-attribute 

series_title = UNSET

Series title if part of series

slug class-attribute instance-attribute 

slug = UNSET

URL slug

start_date class-attribute instance-attribute 

start_date = UNSET

Content start date

sub_type class-attribute instance-attribute 

sub_type = None

Video subtype classification

summary class-attribute instance-attribute 

summary = UNSET

Content summary

tags class-attribute instance-attribute 

tags = None

Content tags and metadata

videos class-attribute instance-attribute 

videos = None

Additional video information

web_link = UNSET

Web-specific link

Cta

Bases: BaseModel

Call-to-action element for coaches film content.

Image

Bases: BaseModel

Image asset for coaches film content.

PromoAsset

Bases: BaseModel

Promotional asset for coaches film content.

Video

Bases: BaseModel

Video asset for coaches film content.

BenchPress

Bases: HasDesignation

NFL Combine bench press results.

repetitions instance-attribute 

repetitions

Bench press reps

BroadJump

Bases: HasDesignation

NFL Combine broad jump results.

inches instance-attribute 

inches

Broad jump distance in inches

FortyYardDash

Bases: HasDesignation

NFL Combine 40-yard dash results.

seconds instance-attribute 

seconds

40 yard dash time

HasDesignation

Bases: BaseModel

Combine event participation flag.

designation instance-attribute 

designation

Whether the result is official/unofficial

TenYardSplit

Bases: HasDesignation

NFL Combine 10-yard split results.

seconds instance-attribute 

seconds

Split time

ThreeConeDrill

Bases: HasDesignation

NFL Combine three-cone drill results.

seconds instance-attribute 

seconds

Three cone drill time

TwentyYardShuffle

Bases: HasDesignation

NFL Combine 20-yard shuttle results.

seconds instance-attribute 

seconds

Twenty yard shuffle time

VerticalJump

Bases: HasDesignation

NFL Combine vertical jump results.

inches instance-attribute 

inches

Vertical jump height

CombinePerson

Bases: BaseModel

Biographical details for an NFL Combine participant.

id_ instance-attribute 

id_

UUID assigned to the prospect by the NFL

display_name instance-attribute 

display_name

Fist and last name

esb_id instance-attribute 

esb_id

String ID containing first three letters of surname followed by a number

first_name instance-attribute 

first_name

Prospect's given name

last_name instance-attribute 

last_name

Prospect's last name

hometown class-attribute instance-attribute 

hometown = None

Prospect's hometown

college_names instance-attribute 

college_names

College(s) the prospect attended

CombineProfile

Bases: BaseModel

Full NFL Combine profile including measurements and drill results.

id_ instance-attribute 

id_

UUID assigned by the NFL

year instance-attribute 

year

Draft year of the combine testing

person instance-attribute 

person

Bio information about the prospect

arm_length class-attribute instance-attribute 

arm_length = None

Arm length in inches precise to ⅛ inch, represented as a float

athletic_score class-attribute instance-attribute 

athletic_score = None

A 0-100 grade of the prospect's overall athleticism

bench_press class-attribute instance-attribute 

bench_press = None

Bench press results

broad_jump class-attribute instance-attribute 

broad_jump = None

Broad jump results

bio class-attribute instance-attribute 

bio = None

HTML formatted snippet containing brief summary of prospect's background

college_class instance-attribute 

college_class

College year of the prospect

draft_grade class-attribute instance-attribute 

draft_grade = None

0-100 overall grade

draft_projection class-attribute instance-attribute 

draft_projection = None

Anticipated draft outcome for the prospect

forty_yard_dash class-attribute instance-attribute 

forty_yard_dash = None

Forty yard dash outcome

grade class-attribute instance-attribute 

grade = None

hand_size class-attribute instance-attribute 

hand_size = None

Thumb to pinky tip measurement, precise to ⅛ inch

headshot class-attribute instance-attribute 

headshot = None

URL to the prospect's headshot

height instance-attribute 

height

Prospect height in inches

nfl_comparison class-attribute instance-attribute 

nfl_comparison = None

Name of an NFL player with a similar profile

overview class-attribute instance-attribute 

overview = None

HTML formatted snippet with scouting elevator pitch

production_score class-attribute instance-attribute 

production_score = None

0-100 grade of player's on-field statistical profile

profile_author class-attribute instance-attribute 

profile_author = None

Name of the person who wrote the scouting profile

pro_forty_yard_dash class-attribute instance-attribute 

pro_forty_yard_dash = None

Forty yard dash from prospect's pro day

sources_tell_us class-attribute instance-attribute 

sources_tell_us = None

HTML - Comments on the prospect from talent evaluators around the league

strengths class-attribute instance-attribute 

strengths = None

HTML - Prospect strengths

ten_yard_split class-attribute instance-attribute 

ten_yard_split = None

Ten yard split time in 40 yd dash

three_cone_drill class-attribute instance-attribute 

three_cone_drill = None

Three cone drill result

twenty_yard_shuffle class-attribute instance-attribute 

twenty_yard_shuffle = None

Twenty yard shuffle result

weaknesses class-attribute instance-attribute 

weaknesses = None

HTML - Prospect weaknesses

combine_attendance instance-attribute 

combine_attendance

Whether or not the prospect attended the official scouting combine

position instance-attribute 

position

Player's position in college

position_group class-attribute instance-attribute 

position_group = None

Position group in college

vertical_jump class-attribute instance-attribute 

vertical_jump = None

Vertical jump result

weight instance-attribute 

weight

Weight in pounds

Conference

Bases: BaseModel

NFL conference (AFC or NFC) with its divisions.

abbr class-attribute instance-attribute 

abbr = None

NFL conference

full_name class-attribute instance-attribute 

full_name = None

Full conference name

id class-attribute instance-attribute 

id = None

Conference identifier

ContractInfo

Bases: BaseModel

Player contract details.

expiration_year class-attribute instance-attribute 

expiration_year = None

Contract expiration year

guaranteed class-attribute instance-attribute 

guaranteed = None

Guaranteed money

signing_bonus class-attribute instance-attribute 

signing_bonus = None

Signing bonus

total_value class-attribute instance-attribute 

total_value = None

Total contract value

years class-attribute instance-attribute 

years = None

Contract length in years

CurrentGame

Bases: BaseModel

Currently active or recently completed NFL game.

date_ class-attribute instance-attribute 

date_ = None

Game date (YYYY-MM-DD)

date_am_pm class-attribute instance-attribute 

date_am_pm = None

Time of day indicator

date_day class-attribute instance-attribute 

date_day = None

Day of week (full)

date_day_month class-attribute instance-attribute 

date_day_month = None

Date in M/D format

date_day_short class-attribute instance-attribute 

date_day_short = None

Day of week (abbreviated)

date_time class-attribute instance-attribute 

date_time = None

Time without AM/PM

date_time_am_pm class-attribute instance-attribute 

date_time_am_pm = None

Time with AM/PM

game_type class-attribute instance-attribute 

game_type = None

Type of game

id class-attribute instance-attribute 

id = None

Unique game identifier

international class-attribute instance-attribute 

international = None

Whether game is played internationally

neutral_site class-attribute instance-attribute 

neutral_site = None

Whether game is at neutral venue

phase class-attribute instance-attribute 

phase = None

Game phase (e.g., PREGAME, FINAL)

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

status class-attribute instance-attribute 

status = None

Game status

time class-attribute instance-attribute 

time = None

Game time in UTC

CurrentGameExtension

Bases: BaseModel

Extended metadata for a current in-progress game.

DefensiveNearestDefenderStats

Bases: BaseModel

Next Gen Stats nearest-defender metrics for a defensive player.

cov instance-attribute 

cov

Total coverage snaps

cov_nd instance-attribute 

cov_nd

Coverage snaps (no data excluded)

display_name instance-attribute 

display_name

Player's full name

gp instance-attribute 

gp

Games played

gs instance-attribute 

gs

Games started

nfl_id instance-attribute 

nfl_id

NFL player identifier

position instance-attribute 

position

Player position

team_id instance-attribute 

team_id

Team identifier

bh_pct class-attribute instance-attribute 

bh_pct = None

Burn percentage (deep completions allowed rate)

catch_nd class-attribute instance-attribute 

catch_nd = None

Catch rate allowed (0-1)

croe_nd class-attribute instance-attribute 

croe_nd = None

Completion Rate Over Expected allowed

game_snap class-attribute instance-attribute 

game_snap = None

Defensive snaps played

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image (contains formatInstructions placeholder)

int_ class-attribute instance-attribute 

int_ = None

Interceptions

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

ngs_position class-attribute instance-attribute 

ngs_position = None

Next Gen Stats position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = None

Defensive position group

pass_rating_nd class-attribute instance-attribute 

pass_rating_nd = None

Passer rating allowed when targeted

position_group class-attribute instance-attribute 

position_group = None

Defensive position group

qd class-attribute instance-attribute 

qd = None

Qualified defender status

rec_nd class-attribute instance-attribute 

rec_nd = None

Receptions allowed

rec_td_nd class-attribute instance-attribute 

rec_td_nd = None

Receiving touchdowns allowed

rec_yds_nd class-attribute instance-attribute 

rec_yds_nd = None

Receiving yards allowed

sep class-attribute instance-attribute 

sep = None

Average separation allowed at target (yards)

short_name class-attribute instance-attribute 

short_name = None

Abbreviated player name

team_snap class-attribute instance-attribute 

team_snap = None

Total team defensive snaps

tg class-attribute instance-attribute 

tg = None

Team games for player

tgt_epa_nd class-attribute instance-attribute 

tgt_epa_nd = None

Target EPA (Expected Points Added) allowed

tgt_nd class-attribute instance-attribute 

tgt_nd = None

Times targeted in coverage

tgt_r_nd class-attribute instance-attribute 

tgt_r_nd = None

Target rate (targets per coverage snap)

total_tg class-attribute instance-attribute 

total_tg = None

Total team games in period

twf_pct class-attribute instance-attribute 

twf_pct = None

Tight window frequency (percentage of targets in tight windows)

yacpr_nd class-attribute instance-attribute 

yacpr_nd = None

Yards After Catch allowed per reception

DefensivePassRushStats

Bases: BaseModel

Next Gen Stats pass rush metrics for a defensive player.

display_name instance-attribute 

display_name

Player's full name

gp instance-attribute 

gp

Games played

gs instance-attribute 

gs

Games started

nfl_id instance-attribute 

nfl_id

NFL player identifier

position instance-attribute 

position

Player position

pr instance-attribute 

pr

Pass rush grade/rating

pr_r instance-attribute 

pr_r

Pass rush rate (0-1)

qbp instance-attribute 

qbp

Quarterback pressures

qbp_r instance-attribute 

qbp_r

Quarterback pressure rate (0-1)

sack instance-attribute 

sack

Sacks (can be fractional for shared sacks)

sack_r instance-attribute 

sack_r

Sack rate (0-1)

team_id instance-attribute 

team_id

Team identifier

game_snap class-attribute instance-attribute 

game_snap = None

Defensive snaps played

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image (contains formatInstructions placeholder)

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

ngs_position class-attribute instance-attribute 

ngs_position = None

Next Gen Stats position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = None

Defensive position group

position_group class-attribute instance-attribute 

position_group = None

Defensive position group

pr_go class-attribute instance-attribute 

pr_go = None

Pass rush get-off metric

qd class-attribute instance-attribute 

qd = None

Qualified defender status

qp class-attribute instance-attribute 

qp = None

Quarterback hits

short_name class-attribute instance-attribute 

short_name = None

Abbreviated player name

team_snap class-attribute instance-attribute 

team_snap = None

Total team defensive snaps

tg class-attribute instance-attribute 

tg = None

Team games for player

total_tg class-attribute instance-attribute 

total_tg = None

Total team games in period

ttp class-attribute instance-attribute 

ttp = None

Time to pressure (seconds)

tts class-attribute instance-attribute 

tts = None

Time to sack (seconds)

turn_qbp class-attribute instance-attribute 

turn_qbp = None

Quarterback pressures that resulted in turnovers

DefensivePlayerOverviewStats

Bases: BaseModel

Aggregated defensive overview statistics for a player.

display_name instance-attribute 

display_name

Player's full name

gp instance-attribute 

gp

Games played

gs instance-attribute 

gs

Games started

nfl_id instance-attribute 

nfl_id

NFL player identifier

position instance-attribute 

position

Player position

snap instance-attribute 

snap

Total defensive snaps played

team_id instance-attribute 

team_id

Team identifier

game_snap class-attribute instance-attribute 

game_snap = None

Defensive snaps played in games

h_stop class-attribute instance-attribute 

h_stop = None

Hard stops (tackles for loss or no gain)

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image (contains formatInstructions placeholder)

int_ class-attribute instance-attribute 

int_ = None

Interceptions

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

ngs_position class-attribute instance-attribute 

ngs_position = None

Next Gen Stats position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = None

Defensive position group

pass_rating_nd class-attribute instance-attribute 

pass_rating_nd = None

Passer rating allowed when targeted (no data excluded)

position_group class-attribute instance-attribute 

position_group = None

Defensive position group

pr class-attribute instance-attribute 

pr = None

Pass rush snaps

qbp class-attribute instance-attribute 

qbp = None

Quarterback pressures

qbp_r class-attribute instance-attribute 

qbp_r = None

Quarterback pressure rate (0-1)

qd class-attribute instance-attribute 

qd = None

Qualified defender status

rd class-attribute instance-attribute 

rd = None

Run defense snaps

rec_nd class-attribute instance-attribute 

rec_nd = None

Receptions allowed (no data excluded)

rec_td_nd class-attribute instance-attribute 

rec_td_nd = None

Receiving touchdowns allowed (no data excluded)

rec_yds_nd class-attribute instance-attribute 

rec_yds_nd = None

Receiving yards allowed (no data excluded)

sack class-attribute instance-attribute 

sack = None

Sacks

short_name class-attribute instance-attribute 

short_name = None

Abbreviated player name

snap_pct class-attribute instance-attribute 

snap_pct = None

Percentage of team snaps played (0-1)

t_stop class-attribute instance-attribute 

t_stop = None

Tackle stops (successful tackles)

tck class-attribute instance-attribute 

tck = None

Total tackles

team_snap class-attribute instance-attribute 

team_snap = None

Total team defensive snaps

tg class-attribute instance-attribute 

tg = None

Team games for player

tgt_nd class-attribute instance-attribute 

tgt_nd = None

Times targeted in coverage (no data excluded)

total_tg class-attribute instance-attribute 

total_tg = None

Total team games in period

DefensiveStats

Bases: BaseModel

Team-level defensive statistics.

Division

Bases: BaseModel

NFL division within a conference.

abbr class-attribute instance-attribute 

abbr = None

Division abbreviation

full_name class-attribute instance-attribute 

full_name = None

Full division name

id class-attribute instance-attribute 

id = None

Division identifier

DraftDay

Bases: BaseModel

Single day within the NFL Draft.

DraftPick

Bases: BaseModel

Individual NFL Draft pick with player and team details.

Tweet

Bases: BaseModel

Tweet associated with a draft pick.

ExternalID

Bases: BaseModel

External identifier mapping for an NFL entity.

id class-attribute instance-attribute 

id = None

ID in external system

source class-attribute instance-attribute 

source = None

External system name

FantasyPlayerStats

Bases: BaseModel

Fantasy football statistics for a player.

display_name instance-attribute 

display_name

Player's full name

fp_std instance-attribute 

fp_std

Fantasy points (standard scoring)

gp instance-attribute 

gp

Games played

nfl_id instance-attribute 

nfl_id

NFL player identifier

position instance-attribute 

position

Player position

team_id instance-attribute 

team_id

Team identifier

fp_half_ppr class-attribute instance-attribute 

fp_half_ppr = None

Fantasy points (half-PPR scoring)

fp_ppr class-attribute instance-attribute 

fp_ppr = None

Fantasy points (PPR scoring)

fp_ppr_pg class-attribute instance-attribute 

fp_ppr_pg = None

Fantasy points per game (PPR)

fp_std_pg class-attribute instance-attribute 

fp_std_pg = None

Fantasy points per game (standard)

gs class-attribute instance-attribute 

gs = None

Games started

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

pass_int class-attribute instance-attribute 

pass_int = None

Passing interceptions

pass_td class-attribute instance-attribute 

pass_td = None

Passing touchdowns

pass_yds class-attribute instance-attribute 

pass_yds = None

Passing yards

pass_yds_pg class-attribute instance-attribute 

pass_yds_pg = None

Passing yards per game

position_group class-attribute instance-attribute 

position_group = None

Position group

rec class-attribute instance-attribute 

rec = None

Receptions

rec_pg class-attribute instance-attribute 

rec_pg = None

Receptions per game

rec_td class-attribute instance-attribute 

rec_td = None

Receiving touchdowns

rec_yds class-attribute instance-attribute 

rec_yds = None

Receiving yards

red_zone_targets class-attribute instance-attribute 

red_zone_targets = None

Targets inside the red zone

rush_td class-attribute instance-attribute 

rush_td = None

Rushing touchdowns

rush_yds class-attribute instance-attribute 

rush_yds = None

Rushing yards

rush_yds_pg class-attribute instance-attribute 

rush_yds_pg = None

Rushing yards per game

short_name class-attribute instance-attribute 

short_name = None

Abbreviated player name

snap_pct class-attribute instance-attribute 

snap_pct = None

Percentage of offensive snaps played (0-1)

target_share class-attribute instance-attribute 

target_share = None

Percentage of team targets (0-1)

tgt class-attribute instance-attribute 

tgt = None

Targets

FilmCard

Bases: BaseModel

Film card entry for coaches film content.

link_params

Parameters for constructing film room link

team_id instance-attribute 

team_id

Team identifier

title instance-attribute 

title

Title of the film content

LinkParams

Bases: BaseModel

Parameters for constructing film room link

dropback class-attribute instance-attribute 

dropback = None

Dropback indicator (1 for yes)

nfl_id class-attribute instance-attribute 

nfl_id = None

NFL player identifier

passer_id class-attribute instance-attribute 

passer_id = None

Passer ID for QB film

rusher_id class-attribute instance-attribute 

rusher_id = None

Rusher ID for RB film

season class-attribute instance-attribute 

season = None

Season year

target_id class-attribute instance-attribute 

target_id = None

Target ID for receiver film

week_slug class-attribute instance-attribute 

week_slug = None

Week identifier

FilmroomPlay

Bases: BaseModel

Play entry from the NFL Film Room.

defense_team_id instance-attribute 

defense_team_id

Defensive team identifier

down instance-attribute 

down

Down number

fapi_game_id instance-attribute 

fapi_game_id

Football API game identifier

game_clock instance-attribute 

game_clock

Game clock time when play occurred

game_id instance-attribute 

game_id

Game identifier (10-digit format YYYYMMDDNN)

home_team_abbr instance-attribute 

home_team_abbr

Home team abbreviation

home_team_id instance-attribute 

home_team_id

Home team identifier

play_description instance-attribute 

play_description

Detailed description of the play

play_id instance-attribute 

play_id

Unique play identifier within the game

play_type instance-attribute 

play_type

Enumeration of all possible play types

possession_team_id instance-attribute 

possession_team_id

Team with possession of the ball

quarter instance-attribute 

quarter

Quarter of the play

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sequence instance-attribute 

sequence

Play sequence number

visitor_team_abbr instance-attribute 

visitor_team_abbr

Visiting team abbreviation

visitor_team_id instance-attribute 

visitor_team_id

Visiting team identifier

week instance-attribute 

week

Week number

week_slug instance-attribute 

week_slug

Week identifier slug

yardline instance-attribute 

yardline

Field position where play occurred

yards_to_go instance-attribute 

yards_to_go

Yards needed for first down

selected_param_values class-attribute instance-attribute 

selected_param_values = None

Selected parameter values for the play filter

FootballRoster

Bases: BaseModel

Player entry within a team roster.

season instance-attribute 

season

Season the roster reflects

season_type instance-attribute 

season_type

Season type

team instance-attribute 

team

Team info

persons instance-attribute 

persons

List of players on the team roster

Fixture

Bases: BaseModel

Associated fixture information

FuturesMarket

Bases: BaseModel

Futures betting market odds for a team.

fixture class-attribute instance-attribute 

fixture = UNSET

Associated fixture information

fixture_id class-attribute instance-attribute 

fixture_id = UNSET

Associated fixture ID if applicable

hierarchy class-attribute instance-attribute 

hierarchy = None

Full betting hierarchy path

is_available class-attribute instance-attribute 

is_available = None

Whether market is currently available

is_suspended class-attribute instance-attribute 

is_suspended = None

Whether market is currently suspended

name class-attribute instance-attribute 

name = None

Market name (e.g., \"Winner\", \"Division Winner\")

source_id class-attribute instance-attribute 

source_id = None

Source identifier for the market

Game

Bases: BaseModel

NFL game with schedule, score, and broadcast details.

date_ class-attribute instance-attribute 

date_ = None

Game date (YYYY-MM-DD)

date_am_pm class-attribute instance-attribute 

date_am_pm = None

Time of day indicator

date_day class-attribute instance-attribute 

date_day = None

Day of week (full)

date_day_month class-attribute instance-attribute 

date_day_month = None

Date in M/D format

date_day_short class-attribute instance-attribute 

date_day_short = None

Day of week (abbreviated)

date_time class-attribute instance-attribute 

date_time = None

Time without AM/PM

date_time_am_pm class-attribute instance-attribute 

date_time_am_pm = None

Time with AM/PM

extensions class-attribute instance-attribute 

extensions = None

Additional game data extensions

game_type class-attribute instance-attribute 

game_type = None

Type of game

id class-attribute instance-attribute 

id = None

Unique game identifier

international class-attribute instance-attribute 

international = None

Whether game is played internationally

neutral_site class-attribute instance-attribute 

neutral_site = None

Whether game is at neutral venue

phase class-attribute instance-attribute 

phase = None

Game phase

season class-attribute instance-attribute 

season = None

Season year

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

status class-attribute instance-attribute 

status = None

Game status

ticket_url class-attribute instance-attribute 

ticket_url = UNSET

Primary ticket purchase URL

time class-attribute instance-attribute 

time = None

Game time in UTC

version class-attribute instance-attribute 

version = None

Data version number

week class-attribute instance-attribute 

week = None

Week number

week_type class-attribute instance-attribute 

week_type = None

Week type (e.g., REG, HOF)

GameExtension

Bases: BaseModel

Extended metadata fields for a game.

GamecenterSchedule

Bases: BaseModel

Game schedule entry for the NFL Game Center.

GameDetail

Bases: BaseModel

Detailed game information including teams, scores, and venue.

game_type class-attribute instance-attribute 

game_type = None

Type of NFL season

home_team class-attribute instance-attribute 

home_team = None

Basic team information included in roster responses

iso_time class-attribute instance-attribute 

iso_time = None

Unix timestamp in milliseconds

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

visitor_team class-attribute instance-attribute 

visitor_team = None

Basic team information included in roster responses

Content

Bases: BaseModel

Insight content and analysis

GameInsight

Bases: BaseModel

Pre-game or in-game insight and analysis.

content class-attribute instance-attribute 

content = None

Insight content and analysis

game_id class-attribute instance-attribute 

game_id = None

Game identifier

id class-attribute instance-attribute 

id = None

Insight identifier

type class-attribute instance-attribute 

type = None

Type of insight

GameOdds

Bases: BaseModel

Betting odds for a game including spread and over/under.

game_id class-attribute instance-attribute 

game_id = None

Game identifier (10-digit format YYYYMMDDNN)

game_key class-attribute instance-attribute 

game_key = None

Unique game key identifier

home_team_abbr class-attribute instance-attribute 

home_team_abbr = None

Home team abbreviation

home_team_id class-attribute instance-attribute 

home_team_id = None

Home team identifier

moneyline class-attribute instance-attribute 

moneyline = None

Money line betting odds

spread class-attribute instance-attribute 

spread = None

Point spread betting odds

totals class-attribute instance-attribute 

totals = None

Over/Under (totals) betting odds

updated_at class-attribute instance-attribute 

updated_at = None

Timestamp of last odds update

visitor_team_abbr class-attribute instance-attribute 

visitor_team_abbr = None

Visitor team abbreviation

visitor_team_id class-attribute instance-attribute 

visitor_team_id = None

Visitor team identifier

GameSchedule

Bases: BaseModel

Scheduled game entry with date, time, and matchup details.

game_date class-attribute instance-attribute 

game_date = None

Game date MM/DD/YYYY

game_time_eastern class-attribute instance-attribute 

game_time_eastern = None

Eastern time

game_type class-attribute instance-attribute 

game_type = None

Type of NFL season

home_team class-attribute instance-attribute 

home_team = None

Basic team information included in roster responses

iso_time class-attribute instance-attribute 

iso_time = None

ISO timestamp in milliseconds

network_channel class-attribute instance-attribute 

network_channel = None

Broadcast network

ngs_game class-attribute instance-attribute 

ngs_game = None

Next Gen Stats available

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

visitor_team class-attribute instance-attribute 

visitor_team = None

Basic team information included in roster responses

GameScore

Bases: BaseModel

Score details for a game.

away_score class-attribute instance-attribute 

away_score = None

Away team current score

home_score class-attribute instance-attribute 

home_score = None

Home team current score

phase class-attribute instance-attribute 

phase = None

Game phase (P=Pregame, 1-4=Quarter, FINAL=Final)

time class-attribute instance-attribute 

time = None

Game clock time or status

GameSite

Bases: BaseModel

Venue and site information for a game.

site_full_name class-attribute instance-attribute 

site_full_name = None

Stadium name

GameTeam

Bases: BaseModel

Team entry within a game with score and record.

current_logo = None

URL to team logo (may contain formatInstructions placeholder)

Score

Bases: BaseModel

Quarterly score breakdown for a team.

total class-attribute instance-attribute 

total = None

Total score (empty string for future games)

HistoricalDefenseStats

Bases: BaseModel

Historical defensive statistics for a player or team.

HistoricalDownAndDistanceStats

Bases: BaseModel

Historical down-and-distance conversion statistics.

HistoricalGoalToGoStats

Bases: BaseModel

Historical goal-to-go statistics.

HistoricalKickingStats

Bases: BaseModel

Historical kicking statistics.

HistoricalKickoffsStats

Bases: BaseModel

Historical kickoff statistics.

HistoricalKickReturnsStats

Bases: BaseModel

Historical kick return statistics.

HistoricalPassingStats

Bases: BaseModel

Historical passing statistics for a player or team.

HistoricalPenaltiesStats

Bases: BaseModel

Historical penalty statistics.

HistoricalPuntingStats

Bases: BaseModel

Historical punting statistics.

HistoricalPuntReturnsStats

Bases: BaseModel

Historical punt return statistics.

HistoricalReceivingStats

Bases: BaseModel

Historical receiving statistics for a player or team.

HistoricalRedzoneStats

Bases: BaseModel

Historical red zone statistics.

HistoricalRushingStats

Bases: BaseModel

Historical rushing statistics for a player or team.

HistoricalScoringStats

Bases: BaseModel

Historical scoring statistics.

HistoricalStatCategories

Bases: BaseModel

Container for all historical stat categories.

HistoricalTimeOfPossessionStats

Bases: BaseModel

Historical time of possession statistics.

KickingDetails

Bases: BaseModel

Detailed kicking breakdown by distance range.

InjuryEntry

Bases: BaseModel

Individual injury report entry for a player.

game_status class-attribute instance-attribute 

game_status = None

Game status designation

injury class-attribute instance-attribute 

injury = None

Injury description

PracticeStatus

Bases: BaseModel

Player practice participation status.

friday class-attribute instance-attribute 

friday = None

Player practice participation status

thursday class-attribute instance-attribute 

thursday = None

Player practice participation status

wednesday class-attribute instance-attribute 

wednesday = None

Player practice participation status

Insight

Bases: BaseModel

Content insight or editorial analysis.

created_at instance-attribute 

created_at

Content creation timestamp

created_by instance-attribute 

created_by

Content creator identifier

date_ instance-attribute 

date_

Content publication date

id instance-attribute 

id

Unique content identifier

nfl_id class-attribute instance-attribute 

nfl_id = None

NFL player identifier

player_name class-attribute instance-attribute 

player_name = None

Player's full name

position class-attribute instance-attribute 

position = None

Player position

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

tags instance-attribute 

tags

Content classification tags

team_abbr instance-attribute 

team_abbr

Player's team abbreviation

team_id instance-attribute 

team_id

Player's team identifier

title instance-attribute 

title

Main insight headline or title

updated_at instance-attribute 

updated_at

Last update timestamp

updated_by instance-attribute 

updated_by

Last editor identifier

week instance-attribute 

week

Week number (if applicable)

esb_id class-attribute instance-attribute 

esb_id = None

ESB player identifier

evergreen class-attribute instance-attribute 

evergreen = False

Whether content is evergreen (timeless) or time-sensitive

game_id class-attribute instance-attribute 

game_id = UNSET

Game identifier (10-digit format YYYYMMDDNN)

gsis_id class-attribute instance-attribute 

gsis_id = None

GSIS player identifier

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image (contains formatInstructions placeholder)

image_url class-attribute instance-attribute 

image_url = UNSET

Associated image or chart URL (optional)

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

second_team_abbr class-attribute instance-attribute 

second_team_abbr = UNSET

Opponent or related team abbreviation

second_team_id class-attribute instance-attribute 

second_team_id = UNSET

Opponent or related team identifier

second_team_type class-attribute instance-attribute 

second_team_type = UNSET

Context of the second team (typically \"defense\" for opponent)

smart_id class-attribute instance-attribute 

smart_id = None

Smart player identifier

sub_note1 class-attribute instance-attribute 

sub_note1 = None

Detailed insight content and analysis

KickingStats

Bases: BaseModel

Kicking statistics for a player.

AwayTeam

Bases: BaseModel

Away team score and status in a live game.

HomeTeam

Bases: BaseModel

Home team score and status in a live game.

LiveGame

Bases: BaseModel

Live game scoring and status information

game_id class-attribute instance-attribute 

game_id = None

Game identifier

last_play class-attribute instance-attribute 

last_play = None

Description of last play

possession class-attribute instance-attribute 

possession = None

Team abbreviation with current possession

quarter class-attribute instance-attribute 

quarter = None

Current quarter/period

red_zone class-attribute instance-attribute 

red_zone = None

Whether team is in red zone

time_remaining class-attribute instance-attribute 

time_remaining = None

Time remaining in current period

LivePlayerStatEntry

Bases: BaseModel

A single player's statistics from a live player-statistics response.

LivePlayerTeamEntry

Bases: BaseModel

A team wrapper in a live player-statistics response (teamId + players array).

LiveTeamStatEntry

Bases: BaseModel

A single team's statistics from a live team-statistics response.

MoneyLine

Bases: BaseModel

Money line betting odds

away_price class-attribute instance-attribute 

away_price = None

Away team money line odds (American format)

home_price class-attribute instance-attribute 

home_price = None

Home team money line odds (American format)

MultipleRankingsCategory

Bases: BaseModel

Category grouping for multiple team or player rankings.

stat_category class-attribute instance-attribute 

stat_category = None

Category of statistic

stat_name class-attribute instance-attribute 

stat_name = None

Name of specific statistic

MultipleRankingsCategoryPagination

Bases: BaseModel

Pagination details for multiple rankings queries.

NFLAuth

Bases: BaseModel

NFL API authentication token details.

access_token instance-attribute 

access_token

Bearer token for NFL API requests.

refresh_token class-attribute instance-attribute 

refresh_token = None

Token used to obtain a new access token when the current one expires.

expires_in class-attribute instance-attribute 

expires_in = None

Unix timestamp (seconds) when the access token expires.

NgsChart

Bases: BaseModel

A player chart (route, pass, or carry).

NgsChartPlayer

Bases: BaseModel

A player available in the chart system.

NgsHighlight

Bases: BaseModel

A play highlight.

NgsGameLeaders

Bases: BaseModel

Game leaders for speed, sacks, and pass distance.

NgsGamePassDistanceLeader

Bases: BaseModel

Pass distance leader for a game.

NgsGameSackLeader

Bases: BaseModel

Sack leader for a game.

NgsGameScheduleInfo

Bases: BaseModel

Game schedule information in overview.

NgsGameSpeedLeader

Bases: BaseModel

Speed leader for a game.

NgsLeagueAverage

Bases: BaseModel

League average value.

NgsPassDistanceLeadersMap

Bases: BaseModel

Pass distance leaders for home and visitor.

NgsPasserInfo

Bases: BaseModel

Passer information in game overview.

NgsPassersOverview

Bases: BaseModel

Passers overview for home and visitor teams.

NgsPassInfo

Bases: BaseModel

Pass info with air distance.

NgsPassingZone

Bases: BaseModel

Passing zone statistics.

NgsPassRusherInfo

Bases: BaseModel

Pass rusher information in game overview.

NgsPassRushersOverview

Bases: BaseModel

Pass rushers overview for home and visitor teams.

NgsReceiverInfo

Bases: BaseModel

Receiver information in game overview.

NgsReceiversOverview

Bases: BaseModel

Receivers overview for home and visitor teams.

NgsReceptionInfo

Bases: BaseModel

Reception info for a receiver.

NgsRusherInfo

Bases: BaseModel

Rusher information in game overview.

NgsRushersOverview

Bases: BaseModel

Rushers overview for home and visitor teams.

NgsRushInfo

Bases: BaseModel

Rush info for a rusher.

NgsRushLocationStats

Bases: BaseModel

Rush location statistics.

NgsSackLeadersMap

Bases: BaseModel

Sack leaders for home and visitor.

NgsSpeedLeadersMap

Bases: BaseModel

Speed leaders for home and visitor.

NgsTackleInfo

Bases: BaseModel

Tackle info with time to tackle.

NgsCompletionLeader

Bases: BaseModel

Leader info for completion probability leaderboards.

NgsCompletionLeaderEntry

Bases: BaseModel

Entry in completion probability leaderboards.

NgsDistanceLeader

Bases: BaseModel

Leader info for distance leaderboards.

NgsDistanceLeaderEntry

Bases: BaseModel

Entry in distance leaderboards.

NgsERYLeader

Bases: BaseModel

Leader info for expected rush yards (ERY) leaderboards.

NgsERYLeaderEntry

Bases: BaseModel

Entry in ERY leaderboards.

NgsSackLeader

Bases: BaseModel

Leader info for sack leaderboards.

NgsSackLeaderEntry

Bases: BaseModel

Entry in sack leaderboards.

NgsSpeedLeader

Bases: BaseModel

Leader info for speed leaderboards.

NgsSpeedLeaderEntry

Bases: BaseModel

Entry in speed leaderboards.

NgsTackleLeader

Bases: BaseModel

Leader info for tackle distance leaderboards.

NgsTackleLeaderEntry

Bases: BaseModel

Entry in tackle distance leaderboards.

NgsYACLeader

Bases: BaseModel

Leader info for YAC (yards after catch) leaderboards.

NgsYACLeaderEntry

Bases: BaseModel

Entry in YAC leaderboards.

NgsContentItem

Bases: BaseModel

A content item (article or video).

NgsContentMetadata

Bases: BaseModel

Metadata for content responses.

NgsContentPagination

Bases: BaseModel

Pagination for content responses.

NgsContentTag

Bases: BaseModel

Tag for content items.

NgsThumbnail

Bases: BaseModel

Thumbnail for content items.

NgsPlay

Bases: BaseModel

Detailed play information from NGS endpoints.

NgsPlayStat

Bases: BaseModel

Statistics for a single play.

NgsPassingStat

Bases: BaseModel

NGS passing statistics for a player.

NgsReceivingStat

Bases: BaseModel

NGS receiving statistics for a player.

NgsRushingStat

Bases: BaseModel

NGS rushing statistics for a player.

OddsSelection

Bases: BaseModel

Individual betting odds selection option.

decimal class-attribute instance-attribute 

decimal = None

Decimal odds for this selection

is_available class-attribute instance-attribute 

is_available = None

Whether this selection is currently available for betting

name class-attribute instance-attribute 

name = None

Team name (e.g., \"KC Chiefs\", \"BUF Bills\")

OverallRecord

Bases: BaseModel

Overall win-loss-tie record for a team.

games class-attribute instance-attribute 

games = None

Total games played

OverallRecordPoints

Bases: BaseModel

Points scored and allowed in team record.

Streak

Bases: BaseModel

Win or loss streak details.

length class-attribute instance-attribute 

length = None

Length of current streak

type class-attribute instance-attribute 

type = None

Type of current streak

Pagination

Bases: BaseModel

Pagination metadata for paginated API responses.

limit class-attribute instance-attribute 

limit = None

Maximum items per page

token class-attribute instance-attribute 

token = UNSET

Token for next page of results

PasserStats

Bases: BaseModel

Passer statistics by zone and game.

Zone

Bases: BaseModel

Passing zone identifier.

PassingStats

Bases: BaseModel

Passing statistics for a player.

Penalty

Bases: BaseModel

Penalty details within a game.

Person

Bases: BaseModel

Basic biographical information for an NFL person.

id_ instance-attribute 

id_

UUUID assigned by the NFL

college_names instance-attribute 

college_names

Colleges the person attended

display_name instance-attribute 

display_name

First and last name

birth_date class-attribute instance-attribute 

birth_date = None

Person's date of birth as YYYY-MM-DD

first_name instance-attribute 

first_name

Person's formal first name

common_first_name instance-attribute 

common_first_name

e.g. Mike instead of Michael

esb_id instance-attribute 

esb_id

Another form of ID tracked by the NFL

gsis_id class-attribute instance-attribute 

gsis_id = None

Yet another ID

headshot class-attribute instance-attribute 

headshot = None

A URL for the person's headshot used in Media

height instance-attribute 

height

Person's height rounded to nearest whole inch

internation_exempt instance-attribute 

internation_exempt

Not sure what this is

jersey_number class-attribute instance-attribute 

jersey_number = None

Number the player wears on the field.

last_name instance-attribute 

last_name

Person's surname

nfl_experience instance-attribute 

nfl_experience

Number of years the person has been a part of the NFL

position instance-attribute 

position

Player's position on the field

position_group instance-attribute 

position_group

Player's position group

status instance-attribute 

status

Whether the player is active or retired

weight instance-attribute 

weight

Player's weight rounded to the nearest pound

Play

Bases: BaseModel

Individual play within a game.

PlayDetail

Bases: BaseModel

Detailed play information including formation and result.

absolute_yardline_number class-attribute instance-attribute 

absolute_yardline_number = None

Absolute position on 100-yard field

down class-attribute instance-attribute 

down = None

Current down (0 for kickoff)

end_game_clock class-attribute instance-attribute 

end_game_clock = None

Game clock at play end

expected_points class-attribute instance-attribute 

expected_points = None

Expected points value

expected_points_added class-attribute instance-attribute 

expected_points_added = None

Expected points added on this play

game_clock class-attribute instance-attribute 

game_clock = None

Time on game clock

home_timeouts_left class-attribute instance-attribute 

home_timeouts_left = None

Home team timeouts remaining

is_st_play class-attribute instance-attribute 

is_st_play = None

Special teams play

play_description class-attribute instance-attribute 

play_description = None

Play description without jersey numbers

play_description_with_jersey_numbers class-attribute instance-attribute 

play_description_with_jersey_numbers = None

Play description including jersey numbers

play_direction class-attribute instance-attribute 

play_direction = None

Direction of play

play_state class-attribute instance-attribute 

play_state = None

Review state of play

play_stats class-attribute instance-attribute 

play_stats = None

Individual player statistics for this play

play_type class-attribute instance-attribute 

play_type = None

Type of play

play_type_code class-attribute instance-attribute 

play_type_code = None

Numeric code for play type

possession_team_id class-attribute instance-attribute 

possession_team_id = None

Team ID with possession

post_play_home_team_win_probability class-attribute instance-attribute 

post_play_home_team_win_probability = None

Home team win probability after play

post_play_visitor_team_win_probability class-attribute instance-attribute 

post_play_visitor_team_win_probability = None

Visitor team win probability after play

pre_snap_home_team_win_probability class-attribute instance-attribute 

pre_snap_home_team_win_probability = None

Home team win probability before play

pre_snap_visitor_team_win_probability class-attribute instance-attribute 

pre_snap_visitor_team_win_probability = None

Visitor team win probability before play

quarter class-attribute instance-attribute 

quarter = None

Current quarter

sequence class-attribute instance-attribute 

sequence = None

Play sequence number

start_game_clock class-attribute instance-attribute 

start_game_clock = None

Game clock at play start

time_of_day_utc class-attribute instance-attribute 

time_of_day_utc = None

UTC timestamp of play

visitor_timeouts_left class-attribute instance-attribute 

visitor_timeouts_left = None

Visitor team timeouts remaining

yardline class-attribute instance-attribute 

yardline = None

Field position

yardline_number class-attribute instance-attribute 

yardline_number = None

Yard line number

yardline_side class-attribute instance-attribute 

yardline_side = None

Side of field

yards_to_go class-attribute instance-attribute 

yards_to_go = None

Yards needed for first down

PlayParticipant

Bases: BaseModel

Player participation record for a single play.

stats class-attribute instance-attribute 

stats = None

Play-specific statistics

PlayParticipantStats

Bases: BaseModel

Play-specific statistics

PlayPlayer

Bases: BaseModel

Player involved in a play with statistical contribution.

gsis_id instance-attribute 

gsis_id

GSIS player ID

nfl_id instance-attribute 

nfl_id

NFL player ID

player_name instance-attribute 

player_name

Full player name

position instance-attribute 

position

Player position

position_group instance-attribute 

position_group

Position group

team_id instance-attribute 

team_id

Team ID

uniform_number class-attribute instance-attribute 

uniform_number = None

Jersey number

PlayStat

Bases: BaseModel

Individual statistic recorded on a play.

club_code instance-attribute 

club_code

Team abbreviation

stat_id instance-attribute 

stat_id

Type of statistic

yards instance-attribute 

yards

Yards gained/lost

gsis_id class-attribute instance-attribute 

gsis_id = None

Player GSIS ID. Absent on team-level stats.

player_name class-attribute instance-attribute 

player_name = None

Player name. Absent on team-level stats.

PlayWinProbability

Bases: BaseModel

Win probability values associated with a play.

down instance-attribute 

down

Down number (0 for kickoffs and special plays, 1-4 for regular plays)

home_score instance-attribute 

home_score

Home team score after the play

home_timeouts_left class-attribute instance-attribute 

home_timeouts_left = None

Number of timeouts remaining for home team

play_description instance-attribute 

play_description

Detailed description of the play or game event

play_id instance-attribute 

play_id

Unique play identifier

possession_team_id instance-attribute 

possession_team_id

Team ID with possession (4-digit string)

pre_snap_home_score instance-attribute 

pre_snap_home_score

Home team score before the play

pre_snap_visitor_score instance-attribute 

pre_snap_visitor_score

Visitor team score before the play

quarter instance-attribute 

quarter

Quarter number (1-4, or 5 for overtime)

sequence instance-attribute 

sequence

Play sequence number (can be decimal for special plays)

visitor_score instance-attribute 

visitor_score

Visitor team score after the play

visitor_timeouts_left class-attribute instance-attribute 

visitor_timeouts_left = None

Number of timeouts remaining for visitor team

yards_to_go instance-attribute 

yards_to_go

Yards needed for first down

home_team_win_probability_added class-attribute instance-attribute 

home_team_win_probability_added = UNSET

Win Probability Added (WPA) for home team on this play

post_play_home_team_win_probability class-attribute instance-attribute 

post_play_home_team_win_probability = UNSET

Home team win probability after the play (0-1)

post_play_visitor_team_win_probability class-attribute instance-attribute 

post_play_visitor_team_win_probability = UNSET

Visiting team win probability after the play (0-1)

pre_snap_home_team_win_probability class-attribute instance-attribute 

pre_snap_home_team_win_probability = UNSET

Home team win probability before the play (0-1, null for game start)

pre_snap_visitor_team_win_probability class-attribute instance-attribute 

pre_snap_visitor_team_win_probability = UNSET

Visitor team win probability before the play (0-1, null for game start)

visitor_team_win_probability_added class-attribute instance-attribute 

visitor_team_win_probability_added = UNSET

Win Probability Added (WPA) for visitor team on this play (negative of home WPA)

yardline class-attribute instance-attribute 

yardline = None

Field position description (e.g., \"NE 27\" or empty for special plays)

yardline_number class-attribute instance-attribute 

yardline_number = UNSET

Yard line number (null for special plays)

yardline_side class-attribute instance-attribute 

yardline_side = UNSET

Side of field (team abbreviation or null for midfield/special plays)

Player

Bases: BaseModel

NFL player profile.

birth_date class-attribute instance-attribute 

birth_date = None

Player's birth date

college_conference class-attribute instance-attribute 

college_conference = None

Player's college conference

college_name class-attribute instance-attribute 

college_name = None

Player's college

current_team_id class-attribute instance-attribute 

current_team_id = None

Current team identifier

display_name class-attribute instance-attribute 

display_name = None

Player's display name

draft_club class-attribute instance-attribute 

draft_club = UNSET

Team that drafted the player

draft_number class-attribute instance-attribute 

draft_number = UNSET

Overall draft pick number

draftround class-attribute instance-attribute 

draftround = UNSET

Draft round

entry_year class-attribute instance-attribute 

entry_year = None

Year player entered the league

esb_id class-attribute instance-attribute 

esb_id = None

ESB identifier

first_name class-attribute instance-attribute 

first_name = None

Player's first name

football_name class-attribute instance-attribute 

football_name = None

Player's football name (nickname)

gsis_id class-attribute instance-attribute 

gsis_id = None

GSIS identifier

gsis_it_id class-attribute instance-attribute 

gsis_it_id = None

GSIS IT identifier

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image

height class-attribute instance-attribute 

height = None

Player height (format is feet-inches)

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

last_name class-attribute instance-attribute 

last_name = None

Player's last name

nfl_id class-attribute instance-attribute 

nfl_id = None

NFL player identifier

ngs_position class-attribute instance-attribute 

ngs_position = UNSET

Next Gen Stats position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = UNSET

Next Gen Stats position group

position class-attribute instance-attribute 

position = None

Player's position

position_group class-attribute instance-attribute 

position_group = None

Player's position group

rookie_year class-attribute instance-attribute 

rookie_year = None

Player's rookie year

season class-attribute instance-attribute 

season = None

Current season

short_name class-attribute instance-attribute 

short_name = None

Shortened player name

smart_id class-attribute instance-attribute 

smart_id = None

Smart identifier for the player

status class-attribute instance-attribute 

status = None

Player status code

status_description_abbr class-attribute instance-attribute 

status_description_abbr = None

Abbreviated status description

status_short_description class-attribute instance-attribute 

status_short_description = None

Short status description

team_abbr class-attribute instance-attribute 

team_abbr = None

Current team abbreviation

uniform_number class-attribute instance-attribute 

uniform_number = None

Player's uniform number (formatted)

weight class-attribute instance-attribute 

weight = None

Player weight in pounds

years_of_experience class-attribute instance-attribute 

years_of_experience = None

Years of NFL experience

PlayerDetail

Bases: BaseModel

Extended player profile with biographical and career details.

birth_date class-attribute instance-attribute 

birth_date = None

Player's birth date

college_conference class-attribute instance-attribute 

college_conference = None

Player's college conference

college_name class-attribute instance-attribute 

college_name = None

Player's college

current_team_id class-attribute instance-attribute 

current_team_id = None

Current team identifier

display_name class-attribute instance-attribute 

display_name = None

Player's display name

draft_club class-attribute instance-attribute 

draft_club = UNSET

Team that drafted the player

draft_number class-attribute instance-attribute 

draft_number = UNSET

Overall draft pick number

draftround class-attribute instance-attribute 

draftround = UNSET

Draft round

entry_year class-attribute instance-attribute 

entry_year = None

Year player entered the league

esb_id class-attribute instance-attribute 

esb_id = None

ESB identifier

first_name class-attribute instance-attribute 

first_name = None

Player's first name

football_name class-attribute instance-attribute 

football_name = None

Player's football name (nickname)

gsis_id class-attribute instance-attribute 

gsis_id = None

GSIS identifier

gsis_it_id class-attribute instance-attribute 

gsis_it_id = None

GSIS IT identifier

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image

height class-attribute instance-attribute 

height = None

Player height (format is feet-inches)

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

last_name class-attribute instance-attribute 

last_name = None

Player's last name

nfl_id class-attribute instance-attribute 

nfl_id = None

NFL player identifier

ngs_position class-attribute instance-attribute 

ngs_position = UNSET

Next Gen Stats position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = UNSET

Next Gen Stats position group

position class-attribute instance-attribute 

position = None

Player's position

position_group class-attribute instance-attribute 

position_group = None

Player's position group

rookie_year class-attribute instance-attribute 

rookie_year = None

Player's rookie year

season class-attribute instance-attribute 

season = None

Current season

short_name class-attribute instance-attribute 

short_name = None

Shortened player name

smart_id class-attribute instance-attribute 

smart_id = None

Smart identifier for the player

status class-attribute instance-attribute 

status = None

Player status code

status_description_abbr class-attribute instance-attribute 

status_description_abbr = None

Abbreviated status description

status_short_description class-attribute instance-attribute 

status_short_description = None

Short status description

team_abbr class-attribute instance-attribute 

team_abbr = None

Current team abbreviation

uniform_number class-attribute instance-attribute 

uniform_number = None

Player's uniform number (formatted)

weight class-attribute instance-attribute 

weight = None

Player weight in pounds

years_of_experience class-attribute instance-attribute 

years_of_experience = None

Years of NFL experience

biography class-attribute instance-attribute 

biography = None

Player biography

PlayerGameStats

Bases: BaseModel

Player statistics for a single game.

PlayerPassingStats

Bases: BaseModel

Player-level passing statistics.

display_name instance-attribute 

display_name

Player's full name

gp instance-attribute 

gp

Games played

gs instance-attribute 

gs

Games started

nfl_id instance-attribute 

nfl_id

NFL player identifier

position instance-attribute 

position

Player position

team_id instance-attribute 

team_id

Team identifier

att class-attribute instance-attribute 

att = None

Attempts

att_pg class-attribute instance-attribute 

att_pg = None

Attempts per game

avg_sep class-attribute instance-attribute 

avg_sep = None

Average receiver separation at target (yards)

avg_ttp class-attribute instance-attribute 

avg_ttp = None

Average time to pass (seconds)

avg_tts class-attribute instance-attribute 

avg_tts = None

Average time to sack (seconds)

avg_ttt class-attribute instance-attribute 

avg_ttt = None

Average time to throw (seconds)

ay class-attribute instance-attribute 

ay = None

Air yards

ay_att class-attribute instance-attribute 

ay_att = None

Air yards per attempt

blitz_r class-attribute instance-attribute 

blitz_r = None

Blitz rate faced

cmp class-attribute instance-attribute 

cmp = None

Completions

cmp_pg class-attribute instance-attribute 

cmp_pg = None

Completions per game

cmp_pct class-attribute instance-attribute 

cmp_pct = None

Completion percentage (0-1)

cpoe class-attribute instance-attribute 

cpoe = None

Completion percentage over expected

db class-attribute instance-attribute 

db = None

Dropbacks

db_pg class-attribute instance-attribute 

db_pg = None

Dropbacks per game

deep_att_pct class-attribute instance-attribute 

deep_att_pct = None

Deep attempt percentage (20+ air yards)

drop class-attribute instance-attribute 

drop = None

Dropped passes by receivers

drop_pg class-attribute instance-attribute 

drop_pg = None

Drops per game

drop_r class-attribute instance-attribute 

drop_r = None

Drop rate

epa class-attribute instance-attribute 

epa = None

Expected Points Added

epa_db class-attribute instance-attribute 

epa_db = None

EPA per dropback

epa_pg class-attribute instance-attribute 

epa_pg = None

EPA per game

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image (contains formatInstructions placeholder)

int_ class-attribute instance-attribute 

int_ = None

Interceptions

int_pg class-attribute instance-attribute 

int_pg = None

Interceptions per game

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

ngs_position class-attribute instance-attribute 

ngs_position = None

Next Gen Stats position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = None

Next Gen Stats position group

pa_db_pct class-attribute instance-attribute 

pa_db_pct = None

Play action dropback percentage

position_group class-attribute instance-attribute 

position_group = None

Position group

qbp class-attribute instance-attribute 

qbp = None

Times under QB pressure

qbp_pg class-attribute instance-attribute 

qbp_pg = None

QB pressure per game

qbp_r class-attribute instance-attribute 

qbp_r = None

QB pressure rate

qp class-attribute instance-attribute 

qp = None

Qualified passer status

rating class-attribute instance-attribute 

rating = None

Passer rating

sack class-attribute instance-attribute 

sack = None

Times sacked

sack_pg class-attribute instance-attribute 

sack_pg = None

Sacks per game

short_name class-attribute instance-attribute 

short_name = None

Abbreviated player name

td class-attribute instance-attribute 

td = None

Touchdown passes

td_pg class-attribute instance-attribute 

td_pg = None

Touchdowns per game

tg class-attribute instance-attribute 

tg = None

Team games for player

total_tg class-attribute instance-attribute 

total_tg = None

Total team games in period

tw_att_pg class-attribute instance-attribute 

tw_att_pg = None

Two-minute attempts per game

tw_att_pct class-attribute instance-attribute 

tw_att_pct = None

Two-minute drill attempt percentage

x_cmp class-attribute instance-attribute 

x_cmp = None

Expected completion percentage

x_yac class-attribute instance-attribute 

x_yac = None

Expected yards after catch

yac class-attribute instance-attribute 

yac = None

Yards after catch

yac_pct class-attribute instance-attribute 

yac_pct = None

YAC percentage of total yards

yds class-attribute instance-attribute 

yds = None

Passing yards

yds_pg class-attribute instance-attribute 

yds_pg = None

Yards per game

ypa class-attribute instance-attribute 

ypa = None

Yards per attempt

PlayerProjection

Bases: BaseModel

Fantasy projection data for a player.

id instance-attribute 

id

Player SMART ID

type instance-attribute 

type

Resource type

Relationships

Bases: BaseModel

Related entities for a player projection.

WeekPoint

Bases: BaseModel

Projected fantasy points for a single week.

id class-attribute instance-attribute 

id = None

Reference to projected points

WeekStat

Bases: BaseModel

Projected statistical output for a single week.

id class-attribute instance-attribute 

id = None

Reference to projected stats

PlayerReceivingStats

Bases: BaseModel

Player-level receiving statistics.

display_name instance-attribute 

display_name

Player's full name

gp instance-attribute 

gp

Games played

gs instance-attribute 

gs

Games started

nfl_id instance-attribute 

nfl_id

NFL player identifier

position instance-attribute 

position

Offensive skill position (excluding QB)

rec instance-attribute 

rec

Receptions

rt instance-attribute 

rt

Routes run

td instance-attribute 

td

Touchdown receptions

team_id instance-attribute 

team_id

Team identifier

tgt instance-attribute 

tgt

Targets

yds instance-attribute 

yds

Receiving yards

avg_rt_dep class-attribute instance-attribute 

avg_rt_dep = None

Average route depth (yards)

avg_sep class-attribute instance-attribute 

avg_sep = None

Average receiver separation at target (yards)

ay class-attribute instance-attribute 

ay = None

Air yards

ay_pg class-attribute instance-attribute 

ay_pg = None

Air yards per game

ay_tgt class-attribute instance-attribute 

ay_tgt = None

Air yards per target

catch class-attribute instance-attribute 

catch = None

Catch rate (0-1)

croe class-attribute instance-attribute 

croe = None

Catch Rate Over Expected

deep_tgt_pct class-attribute instance-attribute 

deep_tgt_pct = None

Deep target percentage (20+ air yards)

drop class-attribute instance-attribute 

drop = None

Dropped passes

drop_pg class-attribute instance-attribute 

drop_pg = None

Drops per game

drop_tgt class-attribute instance-attribute 

drop_tgt = None

Drop rate (0-1)

epa class-attribute instance-attribute 

epa = None

Expected Points Added

epa_pg class-attribute instance-attribute 

epa_pg = None

EPA per game

epa_rt class-attribute instance-attribute 

epa_rt = None

EPA per route run

epa_tgt class-attribute instance-attribute 

epa_tgt = None

EPA per target

ez_rec class-attribute instance-attribute 

ez_rec = None

End zone receptions

ez_rec_pg class-attribute instance-attribute 

ez_rec_pg = None

End zone receptions per game

ez_tgt class-attribute instance-attribute 

ez_tgt = None

End zone targets

ez_tgt_pg class-attribute instance-attribute 

ez_tgt_pg = None

End zone targets per game

fapi_game_id class-attribute instance-attribute 

fapi_game_id = None

Football API game identifier

final_score class-attribute instance-attribute 

final_score = None

Final score of the game

game_id class-attribute instance-attribute 

game_id = None

Game identifier (10-digit format YYYYMMDDNN)

game_result class-attribute instance-attribute 

game_result = None

Game result (Win/Loss/Tie)

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image (contains formatInstructions placeholder)

int_ class-attribute instance-attribute 

int_ = None

Interceptions thrown on targets to this receiver

int_pg class-attribute instance-attribute 

int_pg = None

Interceptions per game

is_home class-attribute instance-attribute 

is_home = None

Whether player's team was at home

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

ngs_position class-attribute instance-attribute 

ngs_position = None

Offensive skill position (excluding QB)

ngs_position_group class-attribute instance-attribute 

ngs_position_group = None

Offensive skill position (excluding QB)

opponent_team_id class-attribute instance-attribute 

opponent_team_id = None

Opponent team identifier

position_group class-attribute instance-attribute 

position_group = None

Offensive skill position (excluding QB)

qr class-attribute instance-attribute 

qr = None

Qualified receiver status

rating class-attribute instance-attribute 

rating = None

Passer rating when targeting this receiver

rec_pg class-attribute instance-attribute 

rec_pg = None

Receptions per game

rt_pg class-attribute instance-attribute 

rt_pg = None

Routes per game

short_name class-attribute instance-attribute 

short_name = None

Abbreviated player name

td_pg class-attribute instance-attribute 

td_pg = None

Touchdowns per game

tg class-attribute instance-attribute 

tg = None

Team games for player

tgt_pg class-attribute instance-attribute 

tgt_pg = None

Targets per game

tgt_rt class-attribute instance-attribute 

tgt_rt = None

Target rate (targets per route run)

total_tg class-attribute instance-attribute 

total_tg = None

Total team games in period

tw_pct class-attribute instance-attribute 

tw_pct = None

Tight window percentage

week_slug class-attribute instance-attribute 

week_slug = None

Week identifier slug

x_catch class-attribute instance-attribute 

x_catch = None

Expected catch rate (0-1)

x_yac class-attribute instance-attribute 

x_yac = None

Expected yards after catch

x_yac_pg class-attribute instance-attribute 

x_yac_pg = None

Expected YAC per game

yac class-attribute instance-attribute 

yac = None

Yards after catch

yac_pg class-attribute instance-attribute 

yac_pg = None

YAC per game

yac_rec class-attribute instance-attribute 

yac_rec = None

YAC per reception

yacoe class-attribute instance-attribute 

yacoe = None

Yards after catch over expected

yacoe_pg class-attribute instance-attribute 

yacoe_pg = None

YACOE per game

yds_pg class-attribute instance-attribute 

yds_pg = None

Yards per game

yds_rec class-attribute instance-attribute 

yds_rec = None

Yards per reception

yds_rt class-attribute instance-attribute 

yds_rt = None

Yards per route run

PlayerRushingStats

Bases: BaseModel

Player-level rushing statistics.

att instance-attribute 

att

Rushing attempts

display_name instance-attribute 

display_name

Player's full name

gp instance-attribute 

gp

Games played

gs instance-attribute 

gs

Games started

nfl_id instance-attribute 

nfl_id

NFL player identifier

position instance-attribute 

position

Offensive player position

td instance-attribute 

td

Rushing touchdowns

team_id instance-attribute 

team_id

Team identifier

yds instance-attribute 

yds

Rushing yards

ypc instance-attribute 

ypc

Yards per carry

att_pg class-attribute instance-attribute 

att_pg = None

Attempts per game

eff class-attribute instance-attribute 

eff = None

Efficiency rating

epa class-attribute instance-attribute 

epa = None

Expected Points Added

epa_att class-attribute instance-attribute 

epa_att = None

EPA per attempt

epa_pg class-attribute instance-attribute 

epa_pg = None

EPA per game

fum class-attribute instance-attribute 

fum = None

Fumbles

fum_pg class-attribute instance-attribute 

fum_pg = None

Fumbles per game

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image (contains formatInstructions placeholder)

in_t_pct class-attribute instance-attribute 

in_t_pct = None

Inside tackles percentage (0-1)

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

lost class-attribute instance-attribute 

lost = None

Fumbles lost

lost_pg class-attribute instance-attribute 

lost_pg = None

Fumbles lost per game

ngs_position class-attribute instance-attribute 

ngs_position = None

Offensive player position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = None

Offensive player position

position_group class-attribute instance-attribute 

position_group = None

Offensive player position

qr class-attribute instance-attribute 

qr = None

Qualified rusher status

rush10_p_yds class-attribute instance-attribute 

rush10_p_yds = None

Rushes of 10+ yards

rush10_p_yds_pg class-attribute instance-attribute 

rush10_p_yds_pg = None

10+ yard rushes per game

rush15_p_mph class-attribute instance-attribute 

rush15_p_mph = None

Rushes of 15+ mph

rush15_p_mph_pg class-attribute instance-attribute 

rush15_p_mph_pg = None

15+ mph rushes per game

rush20_p_mph class-attribute instance-attribute 

rush20_p_mph = None

Rushes of 20+ mph

rush20_p_mph_pg class-attribute instance-attribute 

rush20_p_mph_pg = None

20+ mph rushes per game

ryoe class-attribute instance-attribute 

ryoe = None

Rush Yards Over Expected

ryoe_att class-attribute instance-attribute 

ryoe_att = None

RYOE per attempt

ryoe_pg class-attribute instance-attribute 

ryoe_pg = None

RYOE per game

short_name class-attribute instance-attribute 

short_name = None

Abbreviated player name

st_box_pct class-attribute instance-attribute 

st_box_pct = None

Stacked box percentage (0-1)

success class-attribute instance-attribute 

success = None

Success rate (0-1)

td_pg class-attribute instance-attribute 

td_pg = None

Touchdowns per game

tg class-attribute instance-attribute 

tg = None

Team games for player

total_tg class-attribute instance-attribute 

total_tg = None

Total team games in period

under_pct class-attribute instance-attribute 

under_pct = None

Under center percentage (0-1)

x_ry class-attribute instance-attribute 

x_ry = None

Expected rushing yards

x_ry_pg class-attribute instance-attribute 

x_ry_pg = None

Expected rushing yards per game

x_ypc class-attribute instance-attribute 

x_ypc = None

Expected yards per carry

yaco class-attribute instance-attribute 

yaco = None

Yards after contact

yaco_att class-attribute instance-attribute 

yaco_att = None

Yards after contact per attempt

yaco_pg class-attribute instance-attribute 

yaco_pg = None

Yards after contact per game

ybco class-attribute instance-attribute 

ybco = None

Yards before contact

ybco_pg class-attribute instance-attribute 

ybco_pg = None

Yards before contact per game

yds_pg class-attribute instance-attribute 

yds_pg = None

Yards per game

PlayerSearchResult

Bases: BaseModel

Player data returned in search results (may have nullable fields for retired players)

birth_date class-attribute instance-attribute 

birth_date = None

Player's birth date

college_conference class-attribute instance-attribute 

college_conference = None

Player's college conference

college_name class-attribute instance-attribute 

college_name = None

Player's college

current_team_id class-attribute instance-attribute 

current_team_id = None

Current team identifier

display_name class-attribute instance-attribute 

display_name = None

Player's display name

draft_club class-attribute instance-attribute 

draft_club = UNSET

Team that drafted the player

draft_number class-attribute instance-attribute 

draft_number = UNSET

Overall draft pick number

draftround class-attribute instance-attribute 

draftround = UNSET

Draft round

entry_year class-attribute instance-attribute 

entry_year = None

Year player entered the league

esb_id class-attribute instance-attribute 

esb_id = None

ESB identifier

first_name class-attribute instance-attribute 

first_name = None

Player's first name

football_name class-attribute instance-attribute 

football_name = None

Player's football name (nickname)

gsis_id class-attribute instance-attribute 

gsis_id = None

GSIS identifier

gsis_it_id class-attribute instance-attribute 

gsis_it_id = None

GSIS IT identifier

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image

height class-attribute instance-attribute 

height = None

Player height (format is feet-inches)

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

last_name class-attribute instance-attribute 

last_name = None

Player's last name

nfl_id class-attribute instance-attribute 

nfl_id = None

NFL player identifier

ngs_position class-attribute instance-attribute 

ngs_position = UNSET

Next Gen Stats position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = UNSET

Next Gen Stats position group

position class-attribute instance-attribute 

position = None

Player's position

position_group class-attribute instance-attribute 

position_group = None

Player's position group

rookie_year class-attribute instance-attribute 

rookie_year = None

Player's rookie year

season class-attribute instance-attribute 

season = None

Current season

short_name class-attribute instance-attribute 

short_name = None

Shortened player name

smart_id class-attribute instance-attribute 

smart_id = None

Smart identifier for the player

status class-attribute instance-attribute 

status = None

Player status code

status_description_abbr class-attribute instance-attribute 

status_description_abbr = None

Abbreviated status description

status_short_description class-attribute instance-attribute 

status_short_description = None

Short status description

team_abbr class-attribute instance-attribute 

team_abbr = None

Current team abbreviation

uniform_number class-attribute instance-attribute 

uniform_number = None

Player's uniform number (formatted)

weight class-attribute instance-attribute 

weight = None

Player weight in pounds

years_of_experience class-attribute instance-attribute 

years_of_experience = None

Years of NFL experience

biography class-attribute instance-attribute 

biography = None

Player biography

PlayerWeekProjectedPoints

Bases: BaseModel

Weekly projected fantasy points for a player.

id instance-attribute 

id

Unique identifier for this projection

PlayerWeekProjectedPointsAttributes

Bases: BaseModel

Projected fantasy point attributes for a player-week.

player_id instance-attribute 

player_id

Player SMART ID

season instance-attribute 

season

Season year

settings_code instance-attribute 

settings_code

Fantasy settings code

week instance-attribute 

week

Week number

points class-attribute instance-attribute 

points = UNSET

Projected fantasy points

PlayerWeekProjectedStats

Bases: BaseModel

Weekly projected statistics for a player.

id instance-attribute 

id

Unique identifier for these stats

PlayerWeekProjectedStatsAttributes

Bases: BaseModel

Projected statistical attributes for a player-week.

PointSpread

Bases: BaseModel

Point spread betting odds

away_handicap class-attribute instance-attribute 

away_handicap = None

Away team point spread

away_price class-attribute instance-attribute 

away_price = None

Away team spread odds (American format)

home_handicap class-attribute instance-attribute 

home_handicap = None

Home team point spread

home_price class-attribute instance-attribute 

home_price = None

Home team spread odds (American format)

PointsRecord

Bases: BaseModel

Win-loss record with associated point totals.

PointsRecordPoints

Bases: BaseModel

Points for and against in a record.

ProGame

Bases: BaseModel

Game data from the NFL Pro API.

date_ class-attribute instance-attribute 

date_ = None

Game date (YYYY-MM-DD)

date_am_pm class-attribute instance-attribute 

date_am_pm = None

Time of day indicator

date_day class-attribute instance-attribute 

date_day = None

Day of week (full)

date_day_month class-attribute instance-attribute 

date_day_month = None

Date in M/D format

date_day_short class-attribute instance-attribute 

date_day_short = None

Day of week (abbreviated)

date_time class-attribute instance-attribute 

date_time = None

Time without AM/PM

date_time_am_pm class-attribute instance-attribute 

date_time_am_pm = None

Time with AM/PM

extensions class-attribute instance-attribute 

extensions = None

Additional game data extensions

game_type class-attribute instance-attribute 

game_type = None

Type of game

id class-attribute instance-attribute 

id = None

Unique game identifier

international class-attribute instance-attribute 

international = None

Whether game is played internationally

neutral_site class-attribute instance-attribute 

neutral_site = None

Whether game is at neutral venue

phase class-attribute instance-attribute 

phase = None

Game phase

season class-attribute instance-attribute 

season = None

Season year

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

status class-attribute instance-attribute 

status = None

Game status

ticket_url class-attribute instance-attribute 

ticket_url = UNSET

Primary ticket purchase URL

time class-attribute instance-attribute 

time = None

Game time in UTC

version class-attribute instance-attribute 

version = None

Data version number

week class-attribute instance-attribute 

week = None

Week number

week_type class-attribute instance-attribute 

week_type = None

Week type (e.g., REG, HOF)

ProGameExtension

Bases: BaseModel

Extended metadata for a Pro API game.

DefenseInfo

Bases: BaseModel

Defensive alignment and coverage details for a play.

OffenseInfo

Bases: BaseModel

Offensive formation and personnel details for a play.

PassInfo

Bases: BaseModel

Pass-specific details for a play.

ProPlay

Bases: BaseModel

Detailed play data from the NFL Pro API.

RecInfo

Bases: BaseModel

Receiver route information for a play.

UnofficialPlay

Bases: BaseModel

Unofficial play timestamp data.

ProTeam

Bases: BaseModel

Team data from the NFL Pro API.

abbr class-attribute instance-attribute 

abbr = None

Three-letter team abbreviation

alt_color class-attribute instance-attribute 

alt_color = None

Alternate team color in hex format

city class-attribute instance-attribute 

city = None

Team city/location

city_state class-attribute instance-attribute 

city_state = None

Team city and state

conference_abbr class-attribute instance-attribute 

conference_abbr = None

Conference abbreviation

dark_color class-attribute instance-attribute 

dark_color = None

Dark team color in hex format

domain class-attribute instance-attribute 

domain = None

Team website domain prefix

full_name class-attribute instance-attribute 

full_name = None

Full team name

is_pro_bowl class-attribute instance-attribute 

is_pro_bowl = False

Whether this is a Pro Bowl team

logo = None

URL to team logo (may contain formatInstructions placeholder)

name class-attribute instance-attribute 

name = None

Team name

nick class-attribute instance-attribute 

nick = None

Team nickname (short form)

nickname class-attribute instance-attribute 

nickname = None

Team nickname

primary_color class-attribute instance-attribute 

primary_color = None

Primary team color in hex format

season class-attribute instance-attribute 

season = None

Current season year

secondary_color class-attribute instance-attribute 

secondary_color = None

Secondary team color in hex format

slug class-attribute instance-attribute 

slug = None

URL-friendly team identifier

smart_id class-attribute instance-attribute 

smart_id = None

Unique smart identifier for the team

stadium_name class-attribute instance-attribute 

stadium_name = None

Name of the team's home stadium

team_id class-attribute instance-attribute 

team_id = None

Team identifier (4-digit string)

team_site_ticket_url class-attribute instance-attribute 

team_site_ticket_url = UNSET

URL to team's ticket purchase page

team_site_url class-attribute instance-attribute 

team_site_url = UNSET

Team's official website URL

team_type class-attribute instance-attribute 

team_type = None

Type of team (regular or Pro Bowl)

tertiary_color class-attribute instance-attribute 

tertiary_color = None

Tertiary team color in hex format

ticket_phone_number class-attribute instance-attribute 

ticket_phone_number = UNSET

Phone number for ticket purchases

year_found class-attribute instance-attribute 

year_found = None

Year the team was founded

ProWeek

Bases: BaseModel

Week metadata from the NFL Pro API.

bye_teams class-attribute instance-attribute 

bye_teams = None

Teams on bye this week (empty array if no bye teams)

date_begin class-attribute instance-attribute 

date_begin = None

First day of the week

date_end class-attribute instance-attribute 

date_end = None

Last day of the week

season class-attribute instance-attribute 

season = None

Season year

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

season_type_week class-attribute instance-attribute 

season_type_week = None

Combined season type and week identifier

text class-attribute instance-attribute 

text = None

Human-readable week description

week class-attribute instance-attribute 

week = None

Week number (0 for Hall of Fame game)

week_slug class-attribute instance-attribute 

week_slug = None

Week identifier slug

week_type class-attribute instance-attribute 

week_type = None

Type of week

ReceivingStats

Bases: BaseModel

Team or player receiving statistics.

Record

Bases: BaseModel

Win-loss-tie record.

ResponseMetadata

Bases: BaseModel

Metadata included in NFL API responses.

generated_at instance-attribute 

generated_at

Response generation timestamp

RushingStats

Bases: BaseModel

Team or player rushing statistics.

ScheduleTeam

Bases: BaseModel

Team information within a schedule entry.

conference_abbr class-attribute instance-attribute 

conference_abbr = None

NFL conference

team_type class-attribute instance-attribute 

team_type = None

Team type classification

ScheduledGame

Bases: BaseModel

Scheduled NFL game with matchup and timing details.

game_date class-attribute instance-attribute 

game_date = UNSET

Game date (YYYY-MM-DD format)

game_id class-attribute instance-attribute 

game_id = None

Game identifier (format is YYYYMMDDNN)

game_key class-attribute instance-attribute 

game_key = None

Unique game key

game_time class-attribute instance-attribute 

game_time = UNSET

Game time in UTC

game_time_eastern class-attribute instance-attribute 

game_time_eastern = UNSET

Game time in Eastern timezone (HH:MM:SS)

game_type class-attribute instance-attribute 

game_type = None

Type of NFL season

home_display_name class-attribute instance-attribute 

home_display_name = None

Home team display name

home_nickname class-attribute instance-attribute 

home_nickname = None

Home team nickname

home_team_abbr class-attribute instance-attribute 

home_team_abbr = None

Home team abbreviation

home_team_id class-attribute instance-attribute 

home_team_id = None

Home team identifier

iso_time class-attribute instance-attribute 

iso_time = UNSET

Unix timestamp in milliseconds

network_channel class-attribute instance-attribute 

network_channel = UNSET

Broadcast network

ngs_game class-attribute instance-attribute 

ngs_game = None

Whether Next Gen Stats are available

released_to_clubs class-attribute instance-attribute 

released_to_clubs = None

Whether game info is released to clubs

season class-attribute instance-attribute 

season = None

Season year

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

smart_id class-attribute instance-attribute 

smart_id = None

Smart identifier for the game

validated class-attribute instance-attribute 

validated = None

Whether game info is validated

visitor_display_name class-attribute instance-attribute 

visitor_display_name = None

Visitor team display name

visitor_nickname class-attribute instance-attribute 

visitor_nickname = None

Visitor team nickname

visitor_team_abbr class-attribute instance-attribute 

visitor_team_abbr = None

Visitor team abbreviation

visitor_team_id class-attribute instance-attribute 

visitor_team_id = None

Visitor team identifier

week class-attribute instance-attribute 

week = None

Week number

week_name_abbr class-attribute instance-attribute 

week_name_abbr = None

Week name abbreviation

ScoringPlay

Bases: BaseModel

Scoring play within a game.

SearchPlayersRequest

Bases: BaseModel

Request parameters for searching NFL players.

term instance-attribute 

term

Search term for player name (first or last name)

SeasonStats

Bases: BaseModel

Player statistics aggregated for a season.

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

Security

Bases: BaseModel

Security credentials for NFL API authentication.

Site

Bases: BaseModel

Venue site details.

SocialMedia

Bases: BaseModel

Social media account links for an NFL entity.

link = None

URL to social media profile

platform class-attribute instance-attribute 

platform = None

Social media platform name

Standings

Bases: BaseModel

Division standings with team records.

StandingsTeam

Bases: BaseModel

Team entry within standings.

StandingsRecord

Bases: BaseModel

Team standings record with wins, losses, and ties.

rank class-attribute instance-attribute 

rank = None

Ranking within group

win_pct class-attribute instance-attribute 

win_pct = None

Win percentage

StandingsRecordPoints

Bases: BaseModel

Points for and against in standings.

against class-attribute instance-attribute 

against = None

Points allowed

for_ class-attribute instance-attribute 

for_ = None

Points scored

Statistic

Bases: BaseModel

Named statistic with its value.

type class-attribute instance-attribute 

type = None

Statistical category name

value class-attribute instance-attribute 

value = None

Statistical value

StatisticRanking

Bases: BaseModel

Player or team ranking for a specific statistic.

rank class-attribute instance-attribute 

rank = None

Team's rank in this category (1-32)

Team

Bases: BaseModel

NFL team profile.

abbreviation class-attribute instance-attribute 

abbreviation = None

Three-letter team abbreviation

conference_abbr class-attribute instance-attribute 

conference_abbr = None

Conference abbreviation

conference_full_name class-attribute instance-attribute 

conference_full_name = None

Full conference name

current_logo = None

URL to team logo (may contain {formatInstructions} placeholder)

division_full_name class-attribute instance-attribute 

division_full_name = None

Full division name

full_name class-attribute instance-attribute 

full_name = None

Full team name

id class-attribute instance-attribute 

id = None

Unique team identifier

league class-attribute instance-attribute 

league = None

League name

location class-attribute instance-attribute 

location = None

Team location/city

nfl_shop_url class-attribute instance-attribute 

nfl_shop_url = UNSET

URL to team's NFL shop

nick_name class-attribute instance-attribute 

nick_name = None

Team nickname

official_website_url class-attribute instance-attribute 

official_website_url = UNSET

Team's official website

owners class-attribute instance-attribute 

owners = UNSET

Team ownership information

primary_color class-attribute instance-attribute 

primary_color = None

Primary team color (hex)

season class-attribute instance-attribute 

season = None

Current season

secondary_color class-attribute instance-attribute 

secondary_color = None

Secondary team color (hex)

team_type class-attribute instance-attribute 

team_type = None

Type of team (regular or Pro Bowl)

year_established class-attribute instance-attribute 

year_established = None

Year team was established

TeamBoxscore

Bases: BaseModel

Team-level boxscore statistics for a game.

TeamDefensePassStats

Bases: BaseModel

Team defensive passing statistics.

gp instance-attribute 

gp

Games played

pass_ instance-attribute 

pass_

Pass attempts faced

pass_pct instance-attribute 

pass_pct

Percentage of plays that were passes (0-1)

pass_yds instance-attribute 

pass_yds

Passing yards allowed

pass_ypp instance-attribute 

pass_ypp

Passing yards allowed per pass attempt

team_id instance-attribute 

team_id

Team identifier

total instance-attribute 

total

Total defensive plays

blitz_pct class-attribute instance-attribute 

blitz_pct = None

Blitz percentage (0-1)

epa_pass class-attribute instance-attribute 

epa_pass = None

EPA allowed on passing plays (negative is better for defense)

epa_pass_pp class-attribute instance-attribute 

epa_pass_pp = None

EPA allowed per pass play

go class-attribute instance-attribute 

go = None

Get-off metric (coverage disruption)

pass_td class-attribute instance-attribute 

pass_td = None

Passing touchdowns allowed

pass_ypg class-attribute instance-attribute 

pass_ypg = None

Pass yards allowed per game

qbp class-attribute instance-attribute 

qbp = None

Quarterback pressures generated

qbp_pct class-attribute instance-attribute 

qbp_pct = None

Quarterback pressure rate (0-1)

sack class-attribute instance-attribute 

sack = None

Sacks

sack_pct class-attribute instance-attribute 

sack_pct = None

Sack rate (0-1)

sacked_yds class-attribute instance-attribute 

sacked_yds = None

Sack yards generated

sacked_ypg class-attribute instance-attribute 

sacked_ypg = None

Sack yards generated per game

sep class-attribute instance-attribute 

sep = None

Average receiver separation allowed at target (yards)

ttp class-attribute instance-attribute 

ttp = None

Time to pressure (seconds)

ttt class-attribute instance-attribute 

ttt = None

Average time to throw allowed (seconds)

yac class-attribute instance-attribute 

yac = None

Yards after catch allowed

yacoe class-attribute instance-attribute 

yacoe = None

Yards after catch over expected allowed (negative is better)

TeamDefenseRushStats

Bases: BaseModel

Team defensive rushing statistics.

gp instance-attribute 

gp

Games played

run instance-attribute 

run

Rush attempts faced

run_pct instance-attribute 

run_pct

Percentage of plays that were rushes (0-1)

rush_yds instance-attribute 

rush_yds

Rushing yards allowed

rush_ypp instance-attribute 

rush_ypp

Rushing yards allowed per rush attempt

team_id instance-attribute 

team_id

Team identifier

total instance-attribute 

total

Total defensive plays

epa_rush class-attribute instance-attribute 

epa_rush = None

EPA allowed on rushing plays (negative is better for defense)

epa_rush_pp class-attribute instance-attribute 

epa_rush_pp = None

EPA allowed per rush play

in_pct class-attribute instance-attribute 

in_pct = None

Percentage of rushes between tackles (inside)

light_pct class-attribute instance-attribute 

light_pct = None

Percentage of rushes against light box (6 or fewer defenders)

out_pct class-attribute instance-attribute 

out_pct = None

Percentage of rushes outside tackles

rush10_p_yds class-attribute instance-attribute 

rush10_p_yds = None

Rush attempts of 10+ yards allowed

rush_td class-attribute instance-attribute 

rush_td = None

Rushing touchdowns allowed

rush_ypg class-attribute instance-attribute 

rush_ypg = None

Rush yards allowed per game

ryoe class-attribute instance-attribute 

ryoe = None

Rush Yards Over Expected allowed (negative is better)

ryoe_att class-attribute instance-attribute 

ryoe_att = None

RYOE per rush attempt

stacked_pct class-attribute instance-attribute 

stacked_pct = None

Percentage of rushes against stacked box (8+ defenders)

stuff_pct class-attribute instance-attribute 

stuff_pct = None

Stuff rate - percentage of rushes stopped for 0 or negative yards

yaco_att class-attribute instance-attribute 

yaco_att = None

Yards after contact per attempt allowed

ybco_att class-attribute instance-attribute 

ybco_att = None

Yards before contact per attempt allowed

TeamDefenseStats

Bases: BaseModel

Aggregated team defensive statistics.

gp instance-attribute 

gp

Games played

pass_ instance-attribute 

pass_

Pass attempts faced

run instance-attribute 

run

Rush attempts faced

team_id instance-attribute 

team_id

Team identifier

total instance-attribute 

total

Total defensive plays

yds instance-attribute 

yds

Total yards allowed

defensive_touchdown class-attribute instance-attribute 

defensive_touchdown = None

Defensive touchdowns scored

epa class-attribute instance-attribute 

epa = None

Total EPA allowed (negative is better for defense)

epa_pp class-attribute instance-attribute 

epa_pp = None

EPA allowed per play

epa_pass class-attribute instance-attribute 

epa_pass = None

EPA allowed on passing plays

epa_pass_pp class-attribute instance-attribute 

epa_pass_pp = None

EPA allowed per pass play

epa_rush class-attribute instance-attribute 

epa_rush = None

EPA allowed on rushing plays

epa_rush_pp class-attribute instance-attribute 

epa_rush_pp = None

EPA allowed per rush play

forced_fumble class-attribute instance-attribute 

forced_fumble = None

Forced fumbles

fumble_recovered class-attribute instance-attribute 

fumble_recovered = None

Fumble recoveries

interception class-attribute instance-attribute 

interception = None

Interceptions

pass_pct class-attribute instance-attribute 

pass_pct = None

Percentage of plays that were passes (0-1)

pass_td class-attribute instance-attribute 

pass_td = None

Passing touchdowns allowed

pass_yds class-attribute instance-attribute 

pass_yds = None

Passing yards allowed

pass_ypg class-attribute instance-attribute 

pass_ypg = None

Pass yards allowed per game

pass_ypp class-attribute instance-attribute 

pass_ypp = None

Passing yards allowed per pass attempt

ppg class-attribute instance-attribute 

ppg = None

Points allowed per game

qbp class-attribute instance-attribute 

qbp = None

Quarterback pressures generated

qbp_pct class-attribute instance-attribute 

qbp_pct = None

Quarterback pressure rate (0-1)

rush_td class-attribute instance-attribute 

rush_td = None

Rushing touchdowns allowed

rush_yds class-attribute instance-attribute 

rush_yds = None

Rushing yards allowed

rush_ypg class-attribute instance-attribute 

rush_ypg = None

Rush yards allowed per game

rush_ypp class-attribute instance-attribute 

rush_ypp = None

Rushing yards allowed per rush attempt

ryoe class-attribute instance-attribute 

ryoe = None

Rush Yards Over Expected allowed (negative is better for defense)

sacked_yds class-attribute instance-attribute 

sacked_yds = None

Sack yards generated

sacked_ypg class-attribute instance-attribute 

sacked_ypg = None

Sack yards generated per game

td class-attribute instance-attribute 

td = None

Total touchdowns allowed

total_takeaways class-attribute instance-attribute 

total_takeaways = None

Total takeaways (interceptions + fumble recoveries)

ttt class-attribute instance-attribute 

ttt = None

Average time to throw allowed (seconds)

ypg class-attribute instance-attribute 

ypg = None

Yards allowed per game

ypp class-attribute instance-attribute 

ypp = None

Yards allowed per play

TeamGameStats

Bases: BaseModel

Team-level statistics for a single game.

TeamInfo

Bases: BaseModel

Basic team information included in roster responses

conference_abbr class-attribute instance-attribute 

conference_abbr = None

NFL conference

team_type class-attribute instance-attribute 

team_type = None

Team type classification

TeamInjuryReport

Bases: BaseModel

Injury report for a team.

TeamMatchupRankings

Bases: BaseModel

Comprehensive team rankings across multiple statistical categories

passing_overall_advantage class-attribute instance-attribute 

passing_overall_advantage = None

Advantage rating (-4 to 4)

passing_overall_z_diff class-attribute instance-attribute 

passing_overall_z_diff = None

Z-score differential for passing offense vs defense

team_passing_overall_rank class-attribute instance-attribute 

team_passing_overall_rank = None

Overall passing offense rank (1-32)

team_passing_overall_z class-attribute instance-attribute 

team_passing_overall_z = None

Z-score for passing offense

TeamNeeds

Bases: BaseModel

Draft needs and positional priorities for a team.

team_id instance-attribute 

team_id

Team's UUID as defined by the NFL

year instance-attribute 

year

The year for which these team needs are relevant

analysis instance-attribute 

analysis

A couple sentence blurb providing justification for the listed needs.

position_needs instance-attribute 

position_needs

List of positions the team needs to address in the draft

TeamOffenseStats

Bases: BaseModel

Team offensive overview statistics.

gp instance-attribute 

gp

Games played

pass_ instance-attribute 

pass_

Pass attempts (including sacks)

run instance-attribute 

run

Rush attempts

team_id instance-attribute 

team_id

Team identifier

total instance-attribute 

total

Total offensive plays

yds instance-attribute 

yds

Total offensive yards

epa class-attribute instance-attribute 

epa = None

Total EPA (positive is better for offense)

epa_pp class-attribute instance-attribute 

epa_pp = None

EPA per play

epa_pass class-attribute instance-attribute 

epa_pass = None

EPA on passing plays

epa_pass_pp class-attribute instance-attribute 

epa_pass_pp = None

EPA per pass play

epa_rush class-attribute instance-attribute 

epa_rush = None

EPA on rushing plays

epa_rush_pp class-attribute instance-attribute 

epa_rush_pp = None

EPA per rush play

pass_pct class-attribute instance-attribute 

pass_pct = None

Percentage of plays that were passes (0-1)

pass_td class-attribute instance-attribute 

pass_td = None

Passing touchdowns

pass_yds class-attribute instance-attribute 

pass_yds = None

Passing yards

pass_ypg class-attribute instance-attribute 

pass_ypg = None

Pass yards per game

pass_ypp class-attribute instance-attribute 

pass_ypp = None

Passing yards per pass attempt

ppg class-attribute instance-attribute 

ppg = None

Points per game

red_zone_pct class-attribute instance-attribute 

red_zone_pct = None

Red zone touchdown percentage (0-1)

rush_td class-attribute instance-attribute 

rush_td = None

Rushing touchdowns

rush_yds class-attribute instance-attribute 

rush_yds = None

Rushing yards

rush_ypg class-attribute instance-attribute 

rush_ypg = None

Rush yards per game

rush_ypp class-attribute instance-attribute 

rush_ypp = None

Rushing yards per rush attempt

td class-attribute instance-attribute 

td = None

Total touchdowns

third_down_pct class-attribute instance-attribute 

third_down_pct = None

Third down conversion percentage (0-1)

to class-attribute instance-attribute 

to = None

Turnovers

ypg class-attribute instance-attribute 

ypg = None

Yards per game

ypp class-attribute instance-attribute 

ypp = None

Yards per play

TeamOffensePassStats

Bases: BaseModel

Team offensive passing statistics.

gp instance-attribute 

gp

Games played

pass_ instance-attribute 

pass_

Pass attempts (including sacks)

pass_pct instance-attribute 

pass_pct

Percentage of plays that were passes (0-1)

pass_yds instance-attribute 

pass_yds

Passing yards

pass_ypp instance-attribute 

pass_ypp

Passing yards per pass attempt

team_id instance-attribute 

team_id

Team identifier

total instance-attribute 

total

Total offensive plays

att class-attribute instance-attribute 

att = None

Pass attempts (not including sacks)

blitz_pct class-attribute instance-attribute 

blitz_pct = None

Blitz percentage faced (0-1)

epa_pass class-attribute instance-attribute 

epa_pass = None

EPA on passing plays (positive is better for offense)

epa_pass_pp class-attribute instance-attribute 

epa_pass_pp = None

EPA per pass play

pa_pct class-attribute instance-attribute 

pa_pct = None

Play action percentage (0-1)

pass_td class-attribute instance-attribute 

pass_td = None

Passing touchdowns

pass_ypg class-attribute instance-attribute 

pass_ypg = None

Pass yards per game

qbp class-attribute instance-attribute 

qbp = None

Times quarterback was pressured

qbp_pct class-attribute instance-attribute 

qbp_pct = None

Quarterback pressure rate (0-1)

sack class-attribute instance-attribute 

sack = None

Sacks taken

sack_pct class-attribute instance-attribute 

sack_pct = None

Sack rate (0-1)

sacked_yds class-attribute instance-attribute 

sacked_yds = None

Sack yards lost

sacked_ypg class-attribute instance-attribute 

sacked_ypg = None

Sack yards lost per game

sep class-attribute instance-attribute 

sep = None

Average receiver separation at target (yards)

ttp class-attribute instance-attribute 

ttp = None

Time to pressure (seconds)

ttt class-attribute instance-attribute 

ttt = None

Average time to throw (seconds)

yac class-attribute instance-attribute 

yac = None

Yards after catch

yacoe class-attribute instance-attribute 

yacoe = None

Yards after catch over expected (positive is better)

TeamOffenseRushStats

Bases: BaseModel

Team offensive rushing statistics.

gp instance-attribute 

gp

Games played

total instance-attribute 

total

Total offensive plays

run instance-attribute 

run

Count of run plays

run_pct instance-attribute 

run_pct

Percentage of all plays that are runs

rush_td instance-attribute 

rush_td

Rushing touchdowns

rush_yds instance-attribute 

rush_yds

Total rushing yards

rush_yds_per_play instance-attribute 

rush_yds_per_play

Rush yards per play

rush_epa_total instance-attribute 

rush_epa_total

Total expected points added by rushing

rush_epa_per_play instance-attribute 

rush_epa_per_play

Expected points added per rushing play

rush_ten_yds_plus instance-attribute 

rush_ten_yds_plus

Rushing plays of 10+ yards

rush_success_pct instance-attribute 

rush_success_pct

Team rushing success rate

stuff_pct instance-attribute 

stuff_pct

Team rushing stuff rate

ryoe instance-attribute 

ryoe

Rushing yards over expected

ryoe_att instance-attribute 

ryoe_att

Rushing yards over expected per rush

ybco_att instance-attribute 

ybco_att

Rush yards before contact per attempt

yaco_att instance-attribute 

yaco_att

Rush yards after contact per play

in_pct instance-attribute 

in_pct

Inside tackles rush pct

out_pct instance-attribute 

out_pct

Outside tackles rush pct

light_pct instance-attribute 

light_pct

Opponent light box pct

stacked_pct instance-attribute 

stacked_pct

Opponent stacked box pct

rush_ypg instance-attribute 

rush_ypg

Team rushing yards per game

team_id instance-attribute 

team_id

Team identifier

TeamRankingEntry

Bases: BaseModel

Team ranking entry for a statistical category.

rank class-attribute instance-attribute 

rank = None

Team's rank (1-32)

stats class-attribute instance-attribute 

stats = None

Statistical value

TeamRankings

Bases: BaseModel

Collection of team rankings across statistical categories.

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

TeamScore

Bases: BaseModel

Team score details within a game.

point_ot class-attribute instance-attribute 

point_ot = None

Overtime points

point_q1 class-attribute instance-attribute 

point_q1 = None

First quarter points

point_q2 class-attribute instance-attribute 

point_q2 = None

Second quarter points

point_q3 class-attribute instance-attribute 

point_q3 = None

Third quarter points

point_q4 class-attribute instance-attribute 

point_q4 = None

Fourth quarter points

point_total class-attribute instance-attribute 

point_total = None

Total points scored

timeouts_remaining class-attribute instance-attribute 

timeouts_remaining = None

Timeouts left

TeamVenue

Bases: BaseModel

Venue information associated with a team.

city class-attribute instance-attribute 

city = None

Venue city

country class-attribute instance-attribute 

country = None

Venue country

id class-attribute instance-attribute 

id = None

Venue identifier

name class-attribute instance-attribute 

name = None

Venue name

TicketVendor

Bases: BaseModel

Ticket vendor information for a game.

ticket_url class-attribute instance-attribute 

ticket_url = None

Vendor-specific ticket URL

vendor_name class-attribute instance-attribute 

vendor_name = None

Vendor identifier

Totals

Bases: BaseModel

Over/Under (totals) betting odds

over_handicap class-attribute instance-attribute 

over_handicap = None

Total points line for over

over_price class-attribute instance-attribute 

over_price = None

Over odds (American format)

under_handicap class-attribute instance-attribute 

under_handicap = None

Total points line for under

under_price class-attribute instance-attribute 

under_price = None

Under odds (American format)

Transaction

Bases: BaseModel

NFL player transaction such as a trade, signing, or release.

compensation_details class-attribute instance-attribute 

compensation_details = None

Trade compensation or contract details

details class-attribute instance-attribute 

details = None

Transaction details

Venue

Bases: BaseModel

NFL venue details.

address class-attribute instance-attribute 

address = UNSET

Street address

city class-attribute instance-attribute 

city = None

City name

country class-attribute instance-attribute 

country = None

Country name

id class-attribute instance-attribute 

id = None

Unique venue identifier

name class-attribute instance-attribute 

name = None

Venue name

postal_code class-attribute instance-attribute 

postal_code = UNSET

Postal/ZIP code

territory class-attribute instance-attribute 

territory = UNSET

State or territory code

VenueInfo

Bases: BaseModel

Extended venue information.

NflPlusPlus

Bases: BaseModel

NFL+ Plus subscription tier details.

NFLPLUSPLUSNFLPLUSCOACHESFILM

Bases: BaseModel

NFL+ Plus coaches film authorization.

NflPlusPlusRequirements

Bases: BaseModel

Requirements for NFL+ Plus tier access.

NflPlusPremium

Bases: BaseModel

NFL+ Premium subscription tier details.

NFLPLUSPremiumNFLPLUSCOACHESFILM

Bases: BaseModel

NFL+ Premium coaches film authorization.

NflPlusPremiumRequirements

Bases: BaseModel

Requirements for NFL+ Premium tier access.

ProPremium

Bases: BaseModel

Pro Premium subscription tier details.

ProPremiumNFLPLUSCOACHESFILM

Bases: BaseModel

Pro Premium coaches film authorization.

ProPremiumRequirements

Bases: BaseModel

Requirements for Pro Premium tier access.

VideoAuthorizations

Bases: BaseModel

Authorization requirements for video access

VideoGamePlayIds

Bases: BaseModel

Game and play identifiers for a video replay.

away_team_id instance-attribute 

away_team_id

Away team UUID

game_id instance-attribute 

game_id

Game UUID

home_team_id instance-attribute 

home_team_id

Home team UUID

play_id instance-attribute 

play_id

Play identifier

VideoTag

Bases: BaseModel

Video tag information

game_id class-attribute instance-attribute 

game_id = None

Game identifier (for game tags)

person_id class-attribute instance-attribute 

person_id = None

Person identifier (for player tags)

season class-attribute instance-attribute 

season = None

Season year (for game tags)

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

slug class-attribute instance-attribute 

slug = None

URL-friendly tag identifier

team_id class-attribute instance-attribute 

team_id = None

Team identifier (for team tags)

title class-attribute instance-attribute 

title = None

Tag title

week class-attribute instance-attribute 

week = None

Week number (for game tags)

VideoThumbnail

Bases: BaseModel

Thumbnail image for a video.

thumbnail_url instance-attribute 

thumbnail_url

Video thumbnail image URL

Week

Bases: BaseModel

NFL season week metadata.

bye_teams class-attribute instance-attribute 

bye_teams = None

Teams on bye this week (empty array if no bye teams)

date_begin class-attribute instance-attribute 

date_begin = None

First day of the week

date_end class-attribute instance-attribute 

date_end = None

Last day of the week

season class-attribute instance-attribute 

season = None

Season year

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

season_type_week class-attribute instance-attribute 

season_type_week = None

Combined season type and week identifier

text class-attribute instance-attribute 

text = None

Human-readable week description

week class-attribute instance-attribute 

week = None

Week number (0 for Hall of Fame game)

week_slug class-attribute instance-attribute 

week_slug = None

Week identifier slug

week_type class-attribute instance-attribute 

week_type = None

Type of week

Drive

Bases: BaseModel

Drive summary within a weekly game detail.

DriveChart

Bases: BaseModel

Drive-by-drive data

DriveChartPlay

Bases: BaseModel

Play entry within a drive chart.

DriveChartPlayStat

Bases: BaseModel

Individual statistic within a drive chart play.

Replay

Bases: BaseModel

Video replay reference for a game.

Summary

Bases: BaseModel

Game summary information

TaggedVideos

Bases: BaseModel

Tagged video content

WeeklyGameDetail

Bases: BaseModel

Comprehensive game detail for a specific week.

date_ class-attribute instance-attribute 

date_ = None

Game date (YYYY-MM-DD)

date_am_pm class-attribute instance-attribute 

date_am_pm = None

Time of day indicator

date_day class-attribute instance-attribute 

date_day = None

Day of week (full)

date_day_month class-attribute instance-attribute 

date_day_month = None

Date in M/D format

date_day_short class-attribute instance-attribute 

date_day_short = None

Day of week (abbreviated)

date_time class-attribute instance-attribute 

date_time = None

Time without AM/PM

date_time_am_pm class-attribute instance-attribute 

date_time_am_pm = None

Time with AM/PM

extensions class-attribute instance-attribute 

extensions = None

Additional game data extensions

game_type class-attribute instance-attribute 

game_type = None

Type of game

id class-attribute instance-attribute 

id = None

Unique game identifier

international class-attribute instance-attribute 

international = None

Whether game is played internationally

neutral_site class-attribute instance-attribute 

neutral_site = None

Whether game is at neutral venue

phase class-attribute instance-attribute 

phase = None

Game phase

season class-attribute instance-attribute 

season = None

Season year

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

status class-attribute instance-attribute 

status = None

Game status

ticket_url class-attribute instance-attribute 

ticket_url = None

Primary ticket purchase URL

time class-attribute instance-attribute 

time = None

Game time in UTC

version class-attribute instance-attribute 

version = None

Data version number

week class-attribute instance-attribute 

week = None

Week number

week_type class-attribute instance-attribute 

week_type = None

Week type (e.g., REG, HOF)

drive_chart class-attribute instance-attribute 

drive_chart = None

Drive-by-drive data

replays class-attribute instance-attribute 

replays = None

Replay video links

summary class-attribute instance-attribute 

summary = None

Game summary information

WeeklyGameDetailExtension

Bases: BaseModel

Extended metadata for a weekly game detail.

WeeklyPlayer

Bases: BaseModel

Player information with weekly status

birth_date class-attribute instance-attribute 

birth_date = None

Player's birth date

college_conference class-attribute instance-attribute 

college_conference = None

Player's college conference

college_name class-attribute instance-attribute 

college_name = None

Player's college

current_team_id class-attribute instance-attribute 

current_team_id = None

Current team identifier

display_name class-attribute instance-attribute 

display_name = None

Player's display name

draft_club class-attribute instance-attribute 

draft_club = UNSET

Team that drafted the player

draft_number class-attribute instance-attribute 

draft_number = UNSET

Overall draft pick number

draftround class-attribute instance-attribute 

draftround = UNSET

Draft round

entry_year class-attribute instance-attribute 

entry_year = None

Year player entered the league

esb_id class-attribute instance-attribute 

esb_id = None

ESB identifier

first_name class-attribute instance-attribute 

first_name = None

Player's first name

football_name class-attribute instance-attribute 

football_name = None

Player's football name (nickname)

gsis_id class-attribute instance-attribute 

gsis_id = None

GSIS identifier

gsis_it_id class-attribute instance-attribute 

gsis_it_id = None

GSIS IT identifier

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image

height class-attribute instance-attribute 

height = None

Player height (format is feet-inches)

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

last_name class-attribute instance-attribute 

last_name = None

Player's last name

nfl_id class-attribute instance-attribute 

nfl_id = None

NFL player identifier

ngs_position class-attribute instance-attribute 

ngs_position = UNSET

Next Gen Stats position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = UNSET

Next Gen Stats position group

position class-attribute instance-attribute 

position = None

Player's position

position_group class-attribute instance-attribute 

position_group = None

Player's position group

rookie_year class-attribute instance-attribute 

rookie_year = None

Player's rookie year

season class-attribute instance-attribute 

season = None

Current season

short_name class-attribute instance-attribute 

short_name = None

Shortened player name

smart_id class-attribute instance-attribute 

smart_id = None

Smart identifier for the player

status class-attribute instance-attribute 

status = None

Player status code

status_description_abbr class-attribute instance-attribute 

status_description_abbr = None

Abbreviated status description

status_short_description class-attribute instance-attribute 

status_short_description = None

Short status description

team_abbr class-attribute instance-attribute 

team_abbr = None

Current team abbreviation

uniform_number class-attribute instance-attribute 

uniform_number = None

Player's uniform number (formatted)

weight class-attribute instance-attribute 

weight = None

Player weight in pounds

years_of_experience class-attribute instance-attribute 

years_of_experience = None

Years of NFL experience

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

week class-attribute instance-attribute 

week = None

Week number

WeeklyPlayerPassingStats

Bases: BaseModel

Player passing statistics for a specific week.

att instance-attribute 

att

Attempts

cmp instance-attribute 

cmp

Completions

display_name instance-attribute 

display_name

Player's full name

gp instance-attribute 

gp

Games played

gs instance-attribute 

gs

Games started

int_ instance-attribute 

int_

Interceptions

nfl_id instance-attribute 

nfl_id

NFL player identifier

position instance-attribute 

position

Player position

td instance-attribute 

td

Touchdown passes

team_id instance-attribute 

team_id

Team identifier

yds instance-attribute 

yds

Passing yards

att_pg class-attribute instance-attribute 

att_pg = None

Attempts per game

avg_sep class-attribute instance-attribute 

avg_sep = None

Average receiver separation at target (yards)

avg_ttp class-attribute instance-attribute 

avg_ttp = None

Average time to pass (seconds)

avg_tts class-attribute instance-attribute 

avg_tts = None

Average time to sack (seconds)

avg_ttt class-attribute instance-attribute 

avg_ttt = None

Average time to throw (seconds)

ay class-attribute instance-attribute 

ay = None

Air yards

ay_att class-attribute instance-attribute 

ay_att = None

Air yards per attempt

blitz_r class-attribute instance-attribute 

blitz_r = None

Blitz rate faced (0-1)

cmp_pg class-attribute instance-attribute 

cmp_pg = None

Completions per game

cmp_pct class-attribute instance-attribute 

cmp_pct = None

Completion percentage (0-1)

cpoe class-attribute instance-attribute 

cpoe = None

Completion percentage over expected

db class-attribute instance-attribute 

db = None

Dropbacks

db_pg class-attribute instance-attribute 

db_pg = None

Dropbacks per game

deep_att_pct class-attribute instance-attribute 

deep_att_pct = None

Deep attempt percentage (20+ air yards) (0-1)

drop class-attribute instance-attribute 

drop = None

Dropped passes by receivers

drop_pg class-attribute instance-attribute 

drop_pg = None

Drops per game

drop_r class-attribute instance-attribute 

drop_r = None

Drop rate (0-1)

epa class-attribute instance-attribute 

epa = None

Expected Points Added

epa_db class-attribute instance-attribute 

epa_db = None

EPA per dropback

epa_pg class-attribute instance-attribute 

epa_pg = None

EPA per game

fapi_game_id class-attribute instance-attribute 

fapi_game_id = None

Football API game identifier

final_score class-attribute instance-attribute 

final_score = None

Final score of the game

game_id class-attribute instance-attribute 

game_id = None

Game identifier (10-digit format YYYYMMDDNN)

game_result class-attribute instance-attribute 

game_result = None

Game result (Win/Loss/Tie)

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image (contains formatInstructions placeholder)

int_pg class-attribute instance-attribute 

int_pg = None

Interceptions per game

is_home class-attribute instance-attribute 

is_home = None

Whether player's team was at home

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

ngs_position class-attribute instance-attribute 

ngs_position = None

Next Gen Stats position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = None

Next Gen Stats position group

opponent_team_id class-attribute instance-attribute 

opponent_team_id = None

Opponent team identifier

pa_db_pct class-attribute instance-attribute 

pa_db_pct = None

Play action dropback percentage (0-1)

position_group class-attribute instance-attribute 

position_group = None

Position group

qbp class-attribute instance-attribute 

qbp = None

Times under QB pressure

qbp_pg class-attribute instance-attribute 

qbp_pg = None

QB pressure per game

qbp_r class-attribute instance-attribute 

qbp_r = None

QB pressure rate (0-1)

qp class-attribute instance-attribute 

qp = None

Qualified passer status

rating class-attribute instance-attribute 

rating = None

Passer rating

sack class-attribute instance-attribute 

sack = None

Times sacked

sack_pg class-attribute instance-attribute 

sack_pg = None

Sacks per game

short_name class-attribute instance-attribute 

short_name = None

Abbreviated player name

td_pg class-attribute instance-attribute 

td_pg = None

Touchdowns per game

tg class-attribute instance-attribute 

tg = None

Team games for player

total_tg class-attribute instance-attribute 

total_tg = None

Total team games in period

tw_att_pg class-attribute instance-attribute 

tw_att_pg = None

Two-minute attempts per game

tw_att_pct class-attribute instance-attribute 

tw_att_pct = None

Two-minute drill attempt percentage (0-1)

week_slug class-attribute instance-attribute 

week_slug = None

Week identifier slug

x_cmp class-attribute instance-attribute 

x_cmp = None

Expected completion percentage (0-1)

x_yac class-attribute instance-attribute 

x_yac = None

Expected yards after catch

yac class-attribute instance-attribute 

yac = None

Yards after catch

yac_pct class-attribute instance-attribute 

yac_pct = None

YAC percentage of total yards (0-1)

yds_pg class-attribute instance-attribute 

yds_pg = None

Yards per game

ypa class-attribute instance-attribute 

ypa = None

Yards per attempt

WeeklyPlayerRushingStats

Bases: BaseModel

Player rushing statistics for a specific week.

att instance-attribute 

att

Rushing attempts

display_name instance-attribute 

display_name

Player's full name

gp instance-attribute 

gp

Games played

gs instance-attribute 

gs

Games started

nfl_id instance-attribute 

nfl_id

NFL player identifier

position instance-attribute 

position

Offensive player position

td instance-attribute 

td

Rushing touchdowns

team_id instance-attribute 

team_id

Team identifier

yds instance-attribute 

yds

Rushing yards

ypc instance-attribute 

ypc

Yards per carry

att_pg class-attribute instance-attribute 

att_pg = None

Attempts per game

eff class-attribute instance-attribute 

eff = None

Efficiency rating

epa class-attribute instance-attribute 

epa = None

Expected Points Added

epa_att class-attribute instance-attribute 

epa_att = None

EPA per attempt

epa_pg class-attribute instance-attribute 

epa_pg = None

EPA per game

fapi_game_id class-attribute instance-attribute 

fapi_game_id = None

Football API game identifier

final_score class-attribute instance-attribute 

final_score = None

Final score of the game

fum class-attribute instance-attribute 

fum = None

Fumbles

fum_pg class-attribute instance-attribute 

fum_pg = None

Fumbles per game

game_id class-attribute instance-attribute 

game_id = None

Game identifier (10-digit format YYYYMMDDNN)

game_result class-attribute instance-attribute 

game_result = None

Game result (Win/Loss/Tie)

headshot class-attribute instance-attribute 

headshot = None

URL to player headshot image (contains formatInstructions placeholder)

in_t_pct class-attribute instance-attribute 

in_t_pct = None

Inside tackles percentage (0-1)

is_home class-attribute instance-attribute 

is_home = None

Whether player's team was at home

jersey_number class-attribute instance-attribute 

jersey_number = None

Player's jersey number

lost class-attribute instance-attribute 

lost = None

Fumbles lost

lost_pg class-attribute instance-attribute 

lost_pg = None

Fumbles lost per game

ngs_position class-attribute instance-attribute 

ngs_position = None

Offensive player position

ngs_position_group class-attribute instance-attribute 

ngs_position_group = None

Offensive player position

opponent_team_id class-attribute instance-attribute 

opponent_team_id = None

Opponent team identifier

position_group class-attribute instance-attribute 

position_group = None

Offensive player position

qr class-attribute instance-attribute 

qr = None

Qualified rusher status

rush10_p_yds class-attribute instance-attribute 

rush10_p_yds = None

Rushes of 10+ yards

rush10_p_yds_pg class-attribute instance-attribute 

rush10_p_yds_pg = None

10+ yard rushes per game

rush15_p_mph class-attribute instance-attribute 

rush15_p_mph = None

Rushes of 15+ mph

rush15_p_mph_pg class-attribute instance-attribute 

rush15_p_mph_pg = None

15+ mph rushes per game

rush20_p_mph class-attribute instance-attribute 

rush20_p_mph = None

Rushes of 20+ mph

rush20_p_mph_pg class-attribute instance-attribute 

rush20_p_mph_pg = None

20+ mph rushes per game

ryoe class-attribute instance-attribute 

ryoe = None

Rush Yards Over Expected

ryoe_att class-attribute instance-attribute 

ryoe_att = None

RYOE per attempt

ryoe_pg class-attribute instance-attribute 

ryoe_pg = None

RYOE per game

short_name class-attribute instance-attribute 

short_name = None

Abbreviated player name

st_box_pct class-attribute instance-attribute 

st_box_pct = None

Stacked box percentage (0-1)

success class-attribute instance-attribute 

success = None

Success rate (0-1)

td_pg class-attribute instance-attribute 

td_pg = None

Touchdowns per game

tg class-attribute instance-attribute 

tg = None

Team games for player

total_tg class-attribute instance-attribute 

total_tg = None

Total team games in period

under_pct class-attribute instance-attribute 

under_pct = None

Under center percentage (0-1)

week_slug class-attribute instance-attribute 

week_slug = None

Week identifier slug

x_ry class-attribute instance-attribute 

x_ry = None

Expected rushing yards

x_ry_pg class-attribute instance-attribute 

x_ry_pg = None

Expected rushing yards per game

x_ypc class-attribute instance-attribute 

x_ypc = None

Expected yards per carry

yaco class-attribute instance-attribute 

yaco = None

Yards after contact

yaco_att class-attribute instance-attribute 

yaco_att = None

Yards after contact per attempt

yaco_pg class-attribute instance-attribute 

yaco_pg = None

Yards after contact per game

ybco class-attribute instance-attribute 

ybco = None

Yards before contact

ybco_pg class-attribute instance-attribute 

ybco_pg = None

Yards before contact per game

yds_pg class-attribute instance-attribute 

yds_pg = None

Yards per game

GetCoachesFilmVideosRequest

Bases: BaseModel

Request parameters for fetching coaches film videos.

game_id instance-attribute 

game_id

Game identifiers (UUID format, supports multiple games)

play_id instance-attribute 

play_id

Play identifiers for specific plays within the games

GetCombineProfilesRequest

Bases: BaseModel

Request parameters for fetching NFL Combine profiles.

year instance-attribute 

year

Draft year

GetCombineRankingsRequest

Bases: BaseModel

Request parameters for fetching NFL Combine rankings.

rank_attribute instance-attribute 

rank_attribute

Which event to get rankings for

sort_order instance-attribute 

sort_order

Sort ascending or descending

year instance-attribute 

year

Get performances only for the specified year. If omitted, get all time

limit class-attribute instance-attribute 

limit = 25

Maximum number of rankings to fetch

GetDefensiveNearestDefenderStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal nearest-defender stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of players to skip

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'cov'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_defender class-attribute instance-attribute 

qualified_defender = False

Filter to only qualified defenders (minimum snap threshold)

GetDefensiveNearestDefenderStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly nearest-defender stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week of the Season

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of players to skip

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'cov'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_defender class-attribute instance-attribute 

qualified_defender = False

Filter to only qualified defenders (minimum snap threshold)

GetDefensiveOverviewStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal defensive overview stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'snap'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_defender class-attribute instance-attribute 

qualified_defender = False

Filter to only qualified defenders (minimum snap threshold)

team_defense class-attribute instance-attribute 

team_defense = None

Filter by specific team IDs (supports multiple teams)

GetDefensiveOverviewStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly defensive overview stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week identifier

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'snap'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_defender class-attribute instance-attribute 

qualified_defender = False

Filter to only qualified defenders (minimum snap threshold)

team_defense class-attribute instance-attribute 

team_defense = None

Filter by specific team IDs (supports multiple teams)

GetDefensivePassRushStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal pass rush stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'pr'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_defender class-attribute instance-attribute 

qualified_defender = False

Filter to only qualified defenders (minimum snap threshold)

GetDefensivePassRushStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly pass rush stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week identifier

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'pr'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_defender class-attribute instance-attribute 

qualified_defender = False

Filter to only qualified defenders (minimum snap threshold)

GetDefensiveStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal defensive stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'cov'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_defender class-attribute instance-attribute 

qualified_defender = False

Filter to only qualified defenders (minimum snap threshold)

team_defense class-attribute instance-attribute 

team_defense = None

Filter by specific team IDs (supports multiple teams)

GetDraftInfoRequest

Bases: BaseModel

Request parameters for fetching NFL Draft information.

year instance-attribute 

year

Draft year

round class-attribute instance-attribute 

round = None

Filter by round

team_id class-attribute instance-attribute 

team_id = None

Filter by team

GetDraftPicksReportRequest

Bases: BaseModel

Request parameters for fetching a draft picks report.

year instance-attribute 

year

Draft year

GetFantasyStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal fantasy stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'fpStd'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

position_group class-attribute instance-attribute 

position_group = None

Filter by position groups (supports multiple positions)

team_offense class-attribute instance-attribute 

team_offense = None

Filter by specific offensive team ID

team_defense class-attribute instance-attribute 

team_defense = None

Filter by specific defensive team ID (opponent analysis)

min_offensive_snaps class-attribute instance-attribute 

min_offensive_snaps = 0

Minimum offensive snaps threshold for inclusion

last_n_weeks class-attribute instance-attribute 

last_n_weeks = None

Number of recent weeks to analyze (rolling window)

GetFilmroomPlaysRequest

Bases: BaseModel

Request parameters for fetching Film Room plays.

game_id class-attribute instance-attribute 

game_id = None

Filter by specific game IDs (supports multiple values)

week_slug class-attribute instance-attribute 

week_slug = None

Filter by week identifier (supports multiple values)

season class-attribute instance-attribute 

season = None

Filter by season year (supports multiple values)

season_type class-attribute instance-attribute 

season_type = None

Filter by season type

nfl_id class-attribute instance-attribute 

nfl_id = None

Filter by player NFL ID

quarter class-attribute instance-attribute 

quarter = None

Filter by quarter

down class-attribute instance-attribute 

down = None

Filter by down

yards_to_go_type class-attribute instance-attribute 

yards_to_go_type = None

Filter by yards to go category

touchdown class-attribute instance-attribute 

touchdown = None

Filter for touchdown plays (1 = yes, 0 = no)

rush10_plus_yards class-attribute instance-attribute 

rush10_plus_yards = None

Filter for rushing plays of 10+ yards

fumble_lost class-attribute instance-attribute 

fumble_lost = None

Filter for plays with fumbles lost

fumble class-attribute instance-attribute 

fumble = None

Filter for plays with fumbles

qb_alignment class-attribute instance-attribute 

qb_alignment = None

Filter by quarterback alignment

redzone class-attribute instance-attribute 

redzone = None

Filter for red zone plays

goal_to_go class-attribute instance-attribute 

goal_to_go = None

Filter for goal-to-go situations

pass_play class-attribute instance-attribute 

pass_play = None

Filter for passing plays

run_play class-attribute instance-attribute 

run_play = None

Filter for running plays

play_type class-attribute instance-attribute 

play_type = None

Filter by specific play types

attempt class-attribute instance-attribute 

attempt = None

Filter for passing attempts

completion class-attribute instance-attribute 

completion = None

Filter for completed passes

interception class-attribute instance-attribute 

interception = None

Filter for interceptions

reception class-attribute instance-attribute 

reception = None

Filter for receptions

sack class-attribute instance-attribute 

sack = None

Filter for sacks

rec_motion class-attribute instance-attribute 

rec_motion = None

Filter by receiver motion

target_location class-attribute instance-attribute 

target_location = None

Filter by target location on field

air_yard_type class-attribute instance-attribute 

air_yard_type = None

Filter by air yards category

dropback_time_type class-attribute instance-attribute 

dropback_time_type = None

Filter by dropback time

pressure class-attribute instance-attribute 

pressure = None

Filter by quarterback pressure

blitz class-attribute instance-attribute 

blitz = None

Filter by defensive blitz

play_action class-attribute instance-attribute 

play_action = None

Filter by play action usage

rush_direction class-attribute instance-attribute 

rush_direction = None

Filter by rush direction

run_stuff class-attribute instance-attribute 

run_stuff = None

Filter for stuffed runs

receiver_alignment class-attribute instance-attribute 

receiver_alignment = None

Filter by receiver alignment

separation_type class-attribute instance-attribute 

separation_type = None

Filter by receiver separation

personnel class-attribute instance-attribute 

personnel = None

Filter by defensive personnel package

defenders_in_the_box_type class-attribute instance-attribute 

defenders_in_the_box_type = None

Filter by defenders in the box

def_coverage_type class-attribute instance-attribute 

def_coverage_type = None

Filter by defensive coverage type

GetFootballBoxScoreRequest

Bases: BaseModel

Request parameters for fetching a football boxscore.

game_id instance-attribute 

game_id

Game identifier (UUID)

GetFootballGamesRequest

Bases: BaseModel

Request parameters for fetching football games.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number

with_external_ids class-attribute instance-attribute 

with_external_ids = False

Include external IDs in response

GetFootballRostersRequest

Bases: BaseModel

Request parameters for fetching football rosters.

limit instance-attribute 

limit

Maximum number of teams to fetch

season instance-attribute 

season

Season year

GetFootballTeamsRequest

Bases: BaseModel

Request parameters for fetching football teams.

limit instance-attribute 

limit

Maximum number of teams to fetch

season instance-attribute 

season

Season year

GetGamecenterRequest

Bases: BaseModel

Request parameters for fetching Game Center data.

game_id instance-attribute 

game_id

Game identifier

GetGameDetailsBySlugRequest

Bases: BaseModel

Request parameters for fetching game details by slug.

slug instance-attribute 

slug

Game slug identifier

include_replays class-attribute instance-attribute 

include_replays = None

Include replay videos in response

GetGameDetailsRequest

Bases: BaseModel

Request parameters for fetching game details.

game_id instance-attribute 

game_id

Game identifier (UUID)

include_drive_chart class-attribute instance-attribute 

include_drive_chart = None

Include drive chart data in response

include_replays class-attribute instance-attribute 

include_replays = None

Include replay videos in response

include_standings class-attribute instance-attribute 

include_standings = None

Include standings data in response

include_tagged_videos class-attribute instance-attribute 

include_tagged_videos = None

Include tagged videos in response

include_summary class-attribute instance-attribute 

include_summary = None

Include summary information in response

GetGameInsightsRequest

Bases: BaseModel

Request parameters for fetching game insights.

season instance-attribute 

season

Season year

fapi_game_id instance-attribute 

fapi_game_id

FAPI Game identifier (UUID)

away_team_id instance-attribute 

away_team_id

Away team identifier

home_team_id instance-attribute 

home_team_id

Home team identifier

limit class-attribute instance-attribute 

limit = 20

Maximum number of insights to return

tags class-attribute instance-attribute 

tags = None

Comma-separated list of tags to filter by

exclude_tags class-attribute instance-attribute 

exclude_tags = None

Comma-separated list of tags to exclude

GetGameMatchupRankingsRequest

Bases: BaseModel

Request parameters for fetching game matchup rankings.

game_id instance-attribute 

game_id

Game identifier (10-digit format YYYYMMDDNN)

GetGamePreviewRequest

Bases: BaseModel

Request parameters for fetching a game preview.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number

visitor_display_name instance-attribute 

visitor_display_name

Visiting team display name

home_display_name instance-attribute 

home_display_name

Home team display name

GetGameTeamRankingsRequest

Bases: BaseModel

Request parameters for fetching game team rankings.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

away_team_id instance-attribute 

away_team_id

Away team UUID

home_team_id instance-attribute 

home_team_id

Home team UUID

week instance-attribute 

week

Week number

GetHistoricalPlayerStatsRequest

Bases: BaseModel

Request parameters for fetching historical player stats.

game_id instance-attribute 

game_id

Game identifier (UUID)

team_id instance-attribute 

team_id

Team identifier (UUID)

GetHistoricalTeamStatsRequest

Bases: BaseModel

Request parameters for fetching historical team stats.

game_id instance-attribute 

game_id

Game identifier (UUID)

team_id instance-attribute 

team_id

Team identifier (UUID)

GetInjuryReportsRequest

Bases: BaseModel

Request parameters for fetching injury reports.

season instance-attribute 

season

Season year

week instance-attribute 

week

Week number

team_id class-attribute instance-attribute 

team_id = None

Filter by specific team

GetLiveGameScoresRequest

Bases: BaseModel

Request parameters for fetching live game scores.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number

GetLiveGameStatsRequest

Bases: BaseModel

Request parameters for fetching live game stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number

GetLivePlayerStatisticsRequest

Bases: BaseModel

Request parameters for fetching live player statistics.

game_id instance-attribute 

game_id

Game identifier (UUID)

GetLiveTeamStatisticsRequest

Bases: BaseModel

Request parameters for fetching live team statistics.

game_id instance-attribute 

game_id

Game identifier (UUID)

GetMultipleRankingsAllTeamsRequest

Bases: BaseModel

Request parameters for fetching multiple rankings for all teams.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

stat0 instance-attribute 

stat0

First statistical category

stat1 class-attribute instance-attribute 

stat1 = None

Second statistical category

stat2 class-attribute instance-attribute 

stat2 = None

Third statistical category

stat3 class-attribute instance-attribute 

stat3 = None

Fourth statistical category

stat4 class-attribute instance-attribute 

stat4 = None

Fifth statistical category

GetNgsChartsRequest

Bases: BaseModel

Request model for getting NGS charts.

GetNgsHighlightsRequest

Bases: BaseModel

Request model for getting NGS highlights.

GetNgsCurrentScheduleRequest

Bases: BaseModel

Request model for getting the current NGS schedule.

This endpoint takes no parameters.

GetNgsGameOverviewRequest

Bases: BaseModel

Request model for getting NGS game overview.

game_id instance-attribute 

game_id

Unique game identifier (e.g., 2025112700)

GetNgsLeadersRequest

Bases: BaseModel

Request model for NGS leaders endpoints with limit/week support.

season instance-attribute 

season

Season year (e.g., 2025)

season_type instance-attribute 

season_type

Season type (REG, PRE, POST)

limit class-attribute instance-attribute 

limit = 20

Number of results to return (default: 20)

week class-attribute instance-attribute 

week = None

Optional week filter

GetNgsSeasonLeadersRequest

Bases: BaseModel

Request model for NGS season-aggregated leaders (no week/limit).

season instance-attribute 

season

Season year (e.g., 2025)

season_type instance-attribute 

season_type

Season type (REG, PRE, POST)

GetNgsLiveScoresRequest

Bases: BaseModel

Request model for getting NGS live scores.

season instance-attribute 

season

Season year (e.g., 2025)

season_type instance-attribute 

season_type

Season type (REG, PRE, POST)

week instance-attribute 

week

Week number

GetNgsArticlesRequest

Bases: BaseModel

Request model for getting NGS articles.

GetNgsMixedContentRequest

Bases: BaseModel

Request model for getting NGS mixed content.

GetNgsVideoClipsRequest

Bases: BaseModel

Request model for getting NGS video clips.

GetNgsPassingStatsRequest

Bases: BaseModel

Request model for getting NGS passing stats.

season instance-attribute 

season

Season year (e.g., 2025)

season_type instance-attribute 

season_type

Season type (REG, PRE, POST)

week class-attribute instance-attribute 

week = None

Optional week filter

GetNgsReceivingStatsRequest

Bases: BaseModel

Request model for getting NGS receiving stats.

season instance-attribute 

season

Season year (e.g., 2025)

season_type instance-attribute 

season_type

Season type (REG, PRE, POST)

week class-attribute instance-attribute 

week = None

Optional week filter

GetNgsRushingStatsRequest

Bases: BaseModel

Request model for getting NGS rushing stats.

season instance-attribute 

season

Season year (e.g., 2025)

season_type instance-attribute 

season_type

Season type (REG, PRE, POST)

week class-attribute instance-attribute 

week = None

Optional week filter

GetNgsScheduleRequest

Bases: BaseModel

Request model for getting the full NGS schedule.

season instance-attribute 

season

Season year (e.g., 2025)

GetNgsTeamsRequest

Bases: BaseModel

Request model for getting NGS teams.

This endpoint takes no parameters.

GetPlayByPlayRequest

Bases: BaseModel

Request parameters for fetching play-by-play data.

game_id instance-attribute 

game_id

Game identifier (UUID)

include_penalties class-attribute instance-attribute 

include_penalties = True

Include penalty details

include_formations class-attribute instance-attribute 

include_formations = False

Include offensive/defensive formations

GetPlayListRequest

Bases: BaseModel

Request parameters for fetching a play list.

game_id instance-attribute 

game_id

Game identifier(s) in 10-digit format (YYYYMMDDNN). Can be a single game ID or multiple game IDs for batch retrieval.

GetPlayerDetailsRequest

Bases: BaseModel

Request parameters for fetching player details.

player_id instance-attribute 

player_id

Player identifier

season class-attribute instance-attribute 

season = None

Season for statistics (defaults to current)

GetPlayerRequest

Bases: BaseModel

Request parameters for fetching a player.

nfl_id instance-attribute 

nfl_id

NFL player identifier

GetPlayerPassingStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal player passing stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = None

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_passer class-attribute instance-attribute 

qualified_passer = True

Filter to only qualified passers (minimum attempts threshold)

team_offense class-attribute instance-attribute 

team_offense = None

Filter by specific team IDs (supports multiple teams)

GetPlayerPassingStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly player passing stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week identifier

limit class-attribute instance-attribute 

limit = 50

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = None

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_passer class-attribute instance-attribute 

qualified_passer = False

Filter to only qualified passers (minimum attempts threshold)

team_offense class-attribute instance-attribute 

team_offense = None

Filter by specific team IDs (supports multiple teams)

GetPlayerReceivingStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal player receiving stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = None

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_receiver class-attribute instance-attribute 

qualified_receiver = False

Filter to only qualified receivers (minimum target threshold)

team_offense class-attribute instance-attribute 

team_offense = None

Filter by specific team IDs (supports multiple teams)

GetPlayerReceivingStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly player receiving stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week identifier

limit class-attribute instance-attribute 

limit = 50

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = None

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_receiver class-attribute instance-attribute 

qualified_receiver = False

Filter to only qualified receivers (minimum target threshold)

team_offense class-attribute instance-attribute 

team_offense = None

Filter by specific team IDs (supports multiple teams)

GetPlayerRushingStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal player rushing stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'yds'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_rusher class-attribute instance-attribute 

qualified_rusher = False

Filter to only qualified rushers (minimum attempts threshold)

team_offense class-attribute instance-attribute 

team_offense = None

Filter by specific team IDs (supports multiple teams)

GetPlayerRushingStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly player rushing stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week identifier

limit class-attribute instance-attribute 

limit = 50

Maximum number of players to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'yds'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

qualified_rusher class-attribute instance-attribute 

qualified_rusher = False

Filter to only qualified rushers (minimum attempts threshold)

team_offense class-attribute instance-attribute 

team_offense = None

Filter by specific team IDs (supports multiple teams)

GetPlayersTeamRosterRequest

Bases: BaseModel

Request parameters for fetching a team roster's players.

team_id instance-attribute 

team_id

Team identifier (UUID)

season instance-attribute 

season

Season year

include_stats class-attribute instance-attribute 

include_stats = False

Include current season statistics

GetPlaysWinProbabilityRequest

Bases: BaseModel

Request parameters for fetching play win probabilities.

game_id instance-attribute 

game_id

Game identifier(s) in 10-digit format (YYYYMMDDNN). Can be a single game ID or multiple game IDs for batch retrieval.

GetProjectedStatsRequest

Bases: BaseModel

Request parameters for fetching projected stats.

season instance-attribute 

season

Season year

week instance-attribute 

week

Week number within the season

filter_nfl_team_id class-attribute instance-attribute 

filter_nfl_team_id = None

Filter by NFL team ID (UUID format)

page_size class-attribute instance-attribute 

page_size = 20

Number of results per page

GetScheduleSeasonWeeksRequest

Bases: BaseModel

Request parameters for fetching schedule season weeks.

season instance-attribute 

season

Season year

GetScheduledGameRequest

Bases: BaseModel

Request parameters for fetching a scheduled game.

game_id instance-attribute 

game_id

Game identifier (UUID format)

GetScheduledGamesRequest

Bases: BaseModel

Request parameters for fetching scheduled games.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number within the season

GetSeasonContentInsightsRequest

Bases: BaseModel

Request parameters for fetching season content insights.

season instance-attribute 

season

Season year

limit class-attribute instance-attribute 

limit = 20

Maximum number of insights to return

tags class-attribute instance-attribute 

tags = None

Content tags to filter by (supports multiple comma-separated tags)

team_id class-attribute instance-attribute 

team_id = None

Filter by specific team identifier

nfl_id class-attribute instance-attribute 

nfl_id = None

Filter by specific player NFL identifier

GetSeasonPlayerStatsRequest

Bases: BaseModel

Request parameters for fetching season player stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

position class-attribute instance-attribute 

position = None

Filter by position group

team_id class-attribute instance-attribute 

team_id = None

Filter by team

stat_category class-attribute instance-attribute 

stat_category = None

Statistical category to retrieve

sort class-attribute instance-attribute 

sort = None

Sort field and order

limit class-attribute instance-attribute 

limit = 50

Maximum number of results

offset class-attribute instance-attribute 

offset = 0

Offset for pagination

GetSeasonWeeksRequest

Bases: BaseModel

Request parameters for fetching season weeks.

season instance-attribute 

season

Season year

limit class-attribute instance-attribute 

limit = 20

Maximum number of weeks to return

GetStandingsRequest

Bases: BaseModel

Request parameters for fetching standings.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number

limit class-attribute instance-attribute 

limit = 20

Maximum number of results to return

GetStatsBoxscoreRequest

Bases: BaseModel

Request parameters for fetching stats boxscore data.

game_id instance-attribute 

game_id

Game identifier (10-digit format YYYYMMDDNN)

GetSummaryPlayRequest

Bases: BaseModel

Request parameters for fetching a play summary.

game_id instance-attribute 

game_id

Game identifier (UUID format)

play_id instance-attribute 

play_id

Play identifier within the game

GetTeamDefensePassStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal team defense pass stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'passYpg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

GetTeamDefensePassStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly team defense pass stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'passYpg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

GetTeamDefenseRushStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal team defense rush stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'rushYpg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

GetTeamDefenseRushStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly team defense rush stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'rushYpg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

GetTeamDefenseStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal team defense stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'ypg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

split class-attribute instance-attribute 

split = None

Defensive situation splits to filter by (supports multiple values)

GetTeamDefenseStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly team defense stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'ypg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

split class-attribute instance-attribute 

split = None

Defensive situation splits to filter by (supports multiple values)

GetTeamInjuriesRequest

Bases: BaseModel

Request parameters for fetching team injuries.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

team_id instance-attribute 

team_id

Team identifier (UUID format)

week instance-attribute 

week

Week number within the season

GetTeamNeedsRequest

Bases: BaseModel

Request parameters for fetching team draft needs.

year instance-attribute 

year

Draft year

GetTeamOffenseStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal team offense stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'ypg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

team_defense class-attribute instance-attribute 

team_defense = None

Filter by specific team identifier

split class-attribute instance-attribute 

split = None

Offensive situation splits to filter by (supports multiple values)

GetTeamOffenseStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly team offense stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week identifier

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'ypg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

team_defense class-attribute instance-attribute 

team_defense = None

Filter by specific team identifier

split class-attribute instance-attribute 

split = None

Offensive situation splits to filter by (supports multiple values)

GetTeamOffensePassStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal team offense pass stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'passYpg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

team_defense class-attribute instance-attribute 

team_defense = None

Filter by specific team ID

GetTeamOffensePassStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly team offense pass stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week identifier

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'passYpg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

team_defense class-attribute instance-attribute 

team_defense = None

Filter by specific team ID

GetTeamOffenseRushStatsBySeasonRequest

Bases: BaseModel

Request parameters for fetching seasonal team offense rush stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'passYpg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

GetTeamOffenseRushStatsByWeekRequest

Bases: BaseModel

Request parameters for fetching weekly team offense rush stats.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week identifier

limit class-attribute instance-attribute 

limit = 35

Maximum number of teams to return

offset class-attribute instance-attribute 

offset = 0

Number of records to skip for pagination

page class-attribute instance-attribute 

page = 1

Page number for pagination

sort_key class-attribute instance-attribute 

sort_key = 'passYpg'

Field to sort by

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction

GetTeamRosterRequest

Bases: BaseModel

Request parameters for fetching a team roster.

team_id instance-attribute 

team_id

Team identifier (4-digit string)

season instance-attribute 

season

Season year

GetTeamScheduleRequest

Bases: BaseModel

Request parameters for fetching a team schedule.

team_id instance-attribute 

team_id

Team identifier (4-digit string)

season instance-attribute 

season

Season year

GetTeamStandingsRequest

Bases: BaseModel

Request parameters for fetching team standings.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number within the season

GetTransactionsRequest

Bases: BaseModel

Request parameters for fetching player transactions.

month instance-attribute 

month

Month (number) to fetch transactions for

year instance-attribute 

year

Year (all four digits, as int) to fetch transactions for

team_id instance-attribute 

team_id

Team UUID string

limit class-attribute instance-attribute 

limit = 20

Maximum number of results

GetVenuesRequest

Bases: BaseModel

Request parameters for fetching venue information.

season instance-attribute 

season

Season year

limit class-attribute instance-attribute 

limit = 20

Maximum number of venues to return

GetVideoReplaysRequest

Bases: BaseModel

Request parameters for fetching video replays.

game_id instance-attribute 

game_id

Game identifier (UUID)

GetWeekOfDateRequest

Bases: BaseModel

Request parameters for fetching the NFL week for a given date.

date instance-attribute 

date

Date for which to fetch week information. YYYY-MM-DD

GetWeeklyBettingOddsRequest

Bases: BaseModel

Request parameters for fetching weekly betting odds.

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number within the season

GetWeeklyGameDetailsRequest

Bases: BaseModel

Request parameters for fetching weekly game details.

season instance-attribute 

season

Season year

type instance-attribute 

type

Season type

week instance-attribute 

week

Week number

include_drive_chart class-attribute instance-attribute 

include_drive_chart = False

Include drive chart data

include_replays class-attribute instance-attribute 

include_replays = False

Include replay videos

include_standings class-attribute instance-attribute 

include_standings = False

Include team standings

include_tagged_videos class-attribute instance-attribute 

include_tagged_videos = False

Include tagged video content

GetWeeklyTeamRosterRequest

Bases: BaseModel

Request parameters for fetching a weekly team roster.

team_id instance-attribute 

team_id

Team identifier (4-digit string)

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

week instance-attribute 

week

Week number within the season

GetWinProbabilityMinRequest

Bases: BaseModel

Request parameters for fetching minute-level win probability.

fapi_game_id instance-attribute 

fapi_game_id

Football API game identifiers (UUID format). Supports multiple game IDs to retrieve win probability data for multiple games simultaneously.

RefreshTokenRequest

Bases: BaseModel

Request parameters for refreshing an authentication token.

client_key instance-attribute 

client_key

Client application identifier key

client_secret instance-attribute 

client_secret

Client application secret for authentication

device_id instance-attribute 

device_id

Unique device identifier (UUID format)

device_info instance-attribute 

device_info

Base64-encoded JSON containing device information such as:

network_type instance-attribute 

network_type

Type of network connection

refresh_token instance-attribute 

refresh_token

Valid refresh token from previous authentication

signature_timestamp instance-attribute 

signature_timestamp

Unix timestamp for signature verification

uid instance-attribute 

uid

User identifier hash

uid_signature instance-attribute 

uid_signature

HMAC signature for request verification

TokenRequest

Bases: BaseModel

Request parameters for obtaining an authentication token.

client_key instance-attribute 

client_key

Client application identifier key

client_secret instance-attribute 

client_secret

Client application secret for authentication

device_id instance-attribute 

device_id

Unique device identifier (UUID format)

device_info instance-attribute 

device_info

Base64-encoded JSON containing device information such as:

network_type instance-attribute 

network_type

Type of network connection

BoxscoreResponse

Bases: BaseModel

Response containing boxscore data for a game.

game_id class-attribute instance-attribute 

game_id = None

Game identifier

CoachesFilmResponse

Bases: BaseModel

Response containing coaches film videos.

CombineProfilesResponse

Bases: BaseModel

Response containing NFL Combine profiles.

combine_profiles instance-attribute 

combine_profiles

List of CombineProfile objects

pagination instance-attribute 

pagination

Pagination information object

CombineRankingsResponse

Bases: BaseModel

Response containing NFL Combine rankings.

combine_profiles instance-attribute 

combine_profiles

List of CombineProfile objects

pagination instance-attribute 

pagination

Pagination information object

CurrentGamesResponse

Bases: BaseModel

Response containing currently active games.

games_played_smart_ids class-attribute instance-attribute 

games_played_smart_ids = None

Smart IDs of games already played

number_of_games class-attribute instance-attribute 

number_of_games = None

Total number of games in the week

number_of_games_played class-attribute instance-attribute 

number_of_games_played = None

Number of games already played

season class-attribute instance-attribute 

season = None

Current season year

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

week class-attribute instance-attribute 

week = None

Current week number

DefensiveOverviewStatsResponse

Bases: BaseModel

Response containing defensive overview statistics.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of players matching the criteria

qualified_defender class-attribute instance-attribute 

qualified_defender = None

Whether results are filtered to qualified defenders only

team_defense class-attribute instance-attribute 

team_defense = None

Team filter applied (if any)

DraftResponse

Bases: BaseModel

Response containing NFL Draft data.

FantasyStatsResponse

Bases: BaseModel

Response containing fantasy statistics.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of players matching the criteria

last_n_weeks class-attribute instance-attribute 

last_n_weeks = None

Number of recent weeks analyzed (if applied)

min_offensive_snaps class-attribute instance-attribute 

min_offensive_snaps = None

Minimum offensive snaps filter applied

position_group class-attribute instance-attribute 

position_group = None

Position groups included in results

team_offense class-attribute instance-attribute 

team_offense = None

Offensive team filter applied (if any)

week class-attribute instance-attribute 

week = None

Specific weeks included in analysis

FilmroomPlaysResponse

Bases: BaseModel

Response containing Film Room plays.

count instance-attribute 

count

Total number of plays matching the filter criteria

plays instance-attribute 

plays

Array of play data matching the filter criteria

FootballGamesResponse

Bases: BaseModel

Response containing football games.

FootballRostersResponse

Bases: BaseModel

Response containing football rosters.

FootballTeamsResponse

Bases: BaseModel

Response containing football teams.

FuturesOddsResponse

Bases: BaseModel

Response containing futures betting odds.

FuturesOddsResponseData

Bases: BaseModel

Futures odds data grouped by market.

GamecenterResponse

Bases: BaseModel

Response containing Game Center data with NGS stats.

Leaders

Bases: BaseModel

Aggregated NGS leaders across categories.

LeagueAverageReceiverSeparation

Bases: BaseModel

League-average receiver separation metrics.

LeagueAverageSeparationToQb

Bases: BaseModel

League-average separation to quarterback metrics.

PassDistanceLeaders

Bases: BaseModel

Next Gen Stats pass distance leaders.

Passers

Bases: BaseModel

NGS passer statistics for a game.

PassRushers

Bases: BaseModel

NGS pass rusher statistics for a game.

Receivers

Bases: BaseModel

NGS receiver statistics for a game.

Rushers

Bases: BaseModel

NGS rusher statistics for a game.

SpeedLeaders

Bases: BaseModel

Next Gen Stats speed leaders.

TimeToSackLeaders

Bases: BaseModel

Next Gen Stats time-to-sack leaders.

GamePreviewResponse

Bases: BaseModel

Game preview content (may be empty if no preview available)

preview class-attribute instance-attribute 

preview = UNSET

Preview content and analysis

Preview

Bases: BaseModel

Preview content and analysis

GameStatsResponse

Bases: BaseModel

Response containing game statistics.

GameStatsResponseData

Bases: BaseModel

Game statistics data

GamesResponse

Bases: BaseModel

Response containing a list of games.

season class-attribute instance-attribute 

season = None

Season year

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

week class-attribute instance-attribute 

week = None

Week number

HistoricalPlayerStatsResponse

Bases: BaseModel

Historical player statistics for a specific game and team.

PersonStat

Bases: BaseModel

Individual player statistics for a game.

The stats field contains nullable stat category objects (defense, passing, rushing, receiving, etc.) with camelCase keys.

PersonStatLineup

Bases: BaseModel

Player historical stat lineup entry.

HistoricalGameInfo

Bases: BaseModel

Historical game information with stats.

HistoricalTeamStatsResponse

Bases: BaseModel

Historical team statistics for a specific game.

The stats field contains typed stat category models for defense, passing, rushing, receiving, kicking, and other categories.

HomeFilmCardsResponse

Bases: BaseModel

Response containing home page film cards.

title instance-attribute 

title

Title of the film card collection

InjuryReportResponse

Bases: BaseModel

Response containing injury report data.

LivePlayerStatisticsResponse

Bases: BaseModel

Live player statistics for a game.

The awayTeam and homeTeam fields each contain a teamId and a players array. Each player has identification fields (gsisPlayerId, gsisPlayerName, personId) and 100+ stat fields.

LiveScoresResponse

Bases: BaseModel

Response containing live game scores.

games instance-attribute 

games

Array of live game data (empty when no games are active)

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

week instance-attribute 

week

Week number

LiveTeamStatisticsResponse

Bases: BaseModel

Live team statistics for a game.

The awayTeam and homeTeam fields each contain a teamId and 100+ stat fields covering defense, passing, rushing, receiving, kicking, and more.

MatchupRankingsResponse

Bases: BaseModel

Response containing matchup rankings.

home_team_matchup_rankings class-attribute instance-attribute 

home_team_matchup_rankings = None

Comprehensive team rankings across multiple statistical categories

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

visitor_team_matchup_rankings class-attribute instance-attribute 

visitor_team_matchup_rankings = None

Comprehensive team rankings across multiple statistical categories

NearestDefenderStatsResponse

Bases: BaseModel

Response containing nearest-defender statistics.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of players matching the criteria

qualified_defender class-attribute instance-attribute 

qualified_defender = None

Whether results are filtered to qualified defenders only

NgsChartPlayersResponse

Bases: BaseModel

Response from the NGS chart players endpoint.

NgsChartsResponse

Bases: BaseModel

Response from the NGS charts endpoint.

NgsHighlightsResponse

Bases: BaseModel

Response from the NGS highlights endpoint.

NgsCurrentScheduleResponse

Bases: BaseModel

Response from the NGS current schedule endpoint.

season class-attribute instance-attribute 

season = None

Season year

season_type class-attribute instance-attribute 

season_type = None

Season type (REG, PRE, POST)

week class-attribute instance-attribute 

week = None

Current week number

games class-attribute instance-attribute 

games = None

List of games in the current week

NgsGameCenterOverviewResponse

Bases: BaseModel

Response from the NGS game center overview endpoint.

NgsCompletionLeadersResponse

Bases: BaseModel

Response from the NGS improbable completions endpoint.

NgsDistanceLeadersResponse

Bases: BaseModel

Response from the NGS longest plays endpoint.

NgsERYLeadersResponse

Bases: BaseModel

Response from the NGS remarkable rushes endpoint.

NgsSackLeadersResponse

Bases: BaseModel

Response from the NGS fastest sacks endpoint.

NgsSpeedLeadersResponse

Bases: BaseModel

Response from the NGS fastest ball carriers endpoint.

NgsTackleLeadersResponse

Bases: BaseModel

Response from the NGS longest tackles endpoint.

NgsYACLeadersResponse

Bases: BaseModel

Response from the NGS incredible YAC endpoint.

NgsGameScoreDetail

Bases: BaseModel

Detailed score information for a game.

NgsLiveGameScore

Bases: BaseModel

A single game score entry in the live scores response.

NgsLiveScoresResponse

Bases: BaseModel

Response from the NGS live scores endpoint.

NgsTeamInfo

Bases: BaseModel

Team information in NGS responses.

NgsTeamScore

Bases: BaseModel

Score breakdown by quarter for a team.

NgsArticlesResponse

Bases: BaseModel

Response from the NGS articles endpoint.

NgsMixedContentResponse

Bases: BaseModel

Response from the NGS mixed content endpoint.

NgsVideosResponse

Bases: BaseModel

Response from the NGS videos endpoint.

NgsPassingStatsResponse

Bases: BaseModel

Response from the NGS passing stats endpoint.

NgsReceivingStatsResponse

Bases: BaseModel

Response from the NGS receiving stats endpoint.

NgsRushingStatsResponse

Bases: BaseModel

Response from the NGS rushing stats endpoint.

PassRushStatsResponse

Bases: BaseModel

Response containing pass rush statistics.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of players matching the criteria

qualified_defender class-attribute instance-attribute 

qualified_defender = None

Whether results are filtered to qualified defenders only

PassingStatsResponse

Bases: BaseModel

Response containing passing statistics.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of players matching the criteria

qualified_passer class-attribute instance-attribute 

qualified_passer = None

Whether results are filtered to qualified passers only

PlayByPlayResponse

Bases: BaseModel

Response containing play-by-play data.

PlaySummaryResponse

Bases: BaseModel

Response containing a play summary.

game_id instance-attribute 

game_id

Game identifier in integer format

play_id instance-attribute 

play_id

Play identifier

away class-attribute instance-attribute 

away = None

Away team players involved in the play

game_key class-attribute instance-attribute 

game_key = None

Unique game key

gsis_play_id class-attribute instance-attribute 

gsis_play_id = None

GSIS play identifier

home class-attribute instance-attribute 

home = None

Home team players involved in the play

home_is_offense class-attribute instance-attribute 

home_is_offense = None

Whether home team has offensive possession

PlayWinProbabilityResponse

Bases: BaseModel

Response containing play win probabilities.

PlayerSearchResponse

Bases: BaseModel

Response containing player search results.

players instance-attribute 

players

Array of players matching search criteria

term instance-attribute 

term

Search term used

PlayerStatsResponse

Bases: BaseModel

Response containing player statistics.

PlayerStatsResponsePagination

Bases: BaseModel

Pagination details for player stats responses.

PlayerStatsResponsePlayer

Bases: BaseModel

Player entry within a stats response.

stats class-attribute instance-attribute 

stats = None

Statistics object varies by category

PlayerStatsResponseStats

Bases: BaseModel

Statistics object varies by category

PlaylistResponse

Bases: BaseModel

Response containing a playlist of plays.

Away

Bases: BaseModel

Away team player statistics breakdown.

Home

Bases: BaseModel

Home team player statistics breakdown.

PlayerStats

Bases: BaseModel

Player statistics grouped by team.

ProBoxScoreResponse

Bases: BaseModel

Detailed boxscore response with player and team stats.

TeamStats

Bases: BaseModel

Team statistics grouped by team.

Meta

Bases: BaseModel

Response metadata.

Page

Bases: BaseModel

Page navigation details.

number class-attribute instance-attribute 

number = None

Current page number

size class-attribute instance-attribute 

size = None

Page size

ProjectedStatsResponse

Bases: BaseModel

JSON:API formatted response for projected statistics

data instance-attribute 

data

Primary player data with relationships

included instance-attribute 

included

Related data included in response

ProjectedStatsResponsePagination

Bases: BaseModel

Pagination details for projected stats responses.

token class-attribute instance-attribute 

token = None

Token for next page of results

ReceivingStatsResponse

Bases: BaseModel

Response containing receiving statistics.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of players matching the criteria

qualified_receiver class-attribute instance-attribute 

qualified_receiver = None

Whether results are filtered to qualified receivers only

team_offense class-attribute instance-attribute 

team_offense = None

Team filter applied (if any)

week class-attribute instance-attribute 

week = None

Week identifier

Roster

Bases: BaseModel

Team roster with players and metadata.

RosterResponse

Bases: BaseModel

Response containing roster data.

RushingStatsResponse

Bases: BaseModel

Response containing rushing statistics.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of players matching the criteria

qualified_rusher class-attribute instance-attribute 

qualified_rusher = None

Whether results are filtered to qualified rushers only

team_offense class-attribute instance-attribute 

team_offense = None

Team filter applied (if any)

SeasonWeeksResponse

Bases: BaseModel

Response containing season week data.

season class-attribute instance-attribute 

season = None

Season year

StandingsResponse

Bases: BaseModel

Response containing standings data.

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

week class-attribute instance-attribute 

week = None

Current week for standings

StandingsResponseWeek

Bases: BaseModel

Week metadata within a standings response.

TeamDefensePassStatsResponse

Bases: BaseModel

Response containing team defense pass stats.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of teams matching the criteria

TeamDefenseRushStatsResponse

Bases: BaseModel

Response containing team defense rush stats.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of teams matching the criteria

TeamDefenseStatsResponse

Bases: BaseModel

Response containing team defense stats.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of teams matching the criteria

split class-attribute instance-attribute 

split = None

Applied defensive situation splits

TeamNeedsResponse

Bases: BaseModel

Response containing team draft needs.

teams instance-attribute 

teams

List of teams along with their needs analysis

pagination instance-attribute 

pagination

Pagination information

TeamOffenseStatsResponse

Bases: BaseModel

Response containing team offense stats.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of teams matching the criteria

split class-attribute instance-attribute 

split = None

Applied offensive situation splits

team_defense class-attribute instance-attribute 

team_defense = None

Team filter applied (if any)

TeamOffensePassStatsResponse

Bases: BaseModel

Response containing team offense pass stats.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of teams matching the criteria

team_defense class-attribute instance-attribute 

team_defense = None

Applied team filter (if any)

TeamOffenseRushStatsResponse

Bases: BaseModel

Response containing team offense rush stats.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of season

sort_key class-attribute instance-attribute 

sort_key = None

Field used to sort results

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for results

total instance-attribute 

total

Number of records matching criteria

TeamRankingsResponse

Bases: BaseModel

Response containing team rankings.

TeamRosterResponse

Bases: BaseModel

Response containing a team roster.

season class-attribute instance-attribute 

season = None

Season year

team class-attribute instance-attribute 

team = None

Basic team information included in roster responses

TokenResponse

Bases: BaseModel

Response containing authentication token data.

access_token instance-attribute 

access_token

JWT access token containing user permissions, subscription plans, location data, and roles. Include this token in the Authorization header as \"Bearer {accessToken}\" for authenticated requests.

expires_in instance-attribute 

expires_in

Unix timestamp when the access token expires

refresh_token instance-attribute 

refresh_token

New refresh token for future token refresh requests

TransactionsResponse

Bases: BaseModel

Response containing player transactions.

VenuesResponse

Bases: BaseModel

Response containing venue information.

VideoReplaysMetadata

Bases: BaseModel

Metadata for video replays.

VideoReplaysPagination

Bases: BaseModel

Pagination details for video replays.

VideoReplaysResponse

Bases: BaseModel

Video replays for a game.

Each item in the items array is a Replay object (same type used by WeeklyGameDetail.replays).

WeeklyOddsResponse

Bases: BaseModel

Response containing weekly betting odds.

season class-attribute instance-attribute 

season = None

Season year

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

week class-attribute instance-attribute 

week = None

Week number

WeeklyPassingStatsResponse

Bases: BaseModel

Response containing weekly passing stats.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of players matching the criteria

week instance-attribute 

week

Week identifier

qualified_passer class-attribute instance-attribute 

qualified_passer = None

Whether results are filtered to qualified passers only

team_offense class-attribute instance-attribute 

team_offense = None

Team filter applied (if any)

WeeklyRosterResponse

Bases: BaseModel

Response containing a weekly roster.

season class-attribute instance-attribute 

season = None

Season year

season_type class-attribute instance-attribute 

season_type = None

Type of NFL season

team class-attribute instance-attribute 

team = None

Basic team information included in roster responses

week class-attribute instance-attribute 

week = None

Week number

WeeklyRushingStatsResponse

Bases: BaseModel

Response containing weekly rushing stats.

limit instance-attribute 

limit

Maximum number of results returned

offset instance-attribute 

offset

Number of records skipped

season instance-attribute 

season

Season year

season_type instance-attribute 

season_type

Type of NFL season

sort_key class-attribute instance-attribute 

sort_key = None

Field used for sorting

sort_value class-attribute instance-attribute 

sort_value = None

Sort direction for ordered results

total instance-attribute 

total

Total number of players matching the criteria

week instance-attribute 

week

Week identifier

qualified_rusher class-attribute instance-attribute 

qualified_rusher = None

Whether results are filtered to qualified rushers only

team_offense class-attribute instance-attribute 

team_offense = None

Team filter applied (if any)

WeeksResponse

Bases: BaseModel

Response containing weeks data.

WinProbabilityResponse

Bases: BaseModel

Response containing win probability data.

game_id instance-attribute 

game_id

Game identifier (10-digit format YYYYMMDDNN)

game_key instance-attribute 

game_key

Unique game key identifier

plays instance-attribute 

plays

Chronological list of all plays with win probability data

pregame_away_team_win_probability instance-attribute 

pregame_away_team_win_probability

Away team's win probability before the game started

pregame_home_team_win_probability instance-attribute 

pregame_home_team_win_probability

Home team's win probability before the game started