Data Models

griddy / nfl / models**

---

Module Contents

Attributes

BinaryFlagEnum module-attribute

BinaryFlagEnum = Literal[0, 1]

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

ConferenceEnum module-attribute

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

NFL conference

GameResultEnum module-attribute

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

Game result (Win/Loss/Tie)

GameStatusEnum module-attribute

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

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

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

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

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.

GameIDTypedDict module-attribute

GameIDTypedDict = TypeAliasType(
    "GameIDTypedDict", 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

GetTeamDefenseStatsByWeekSortKey module-attribute

GetTeamDefenseStatsByWeekSortKey = 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

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']

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']

Prime time game designation

GameStatus module-attribute

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

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",
]

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']

Prime time game designation

ProGameStatus module-attribute

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

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']

Prime time game designation

WeeklyGameDetailStatus module-attribute

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

Game status

DefenseNGSPositionEnum module-attribute

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

Next Gen Stats position

Classes

BenchPress

Bases: HasDesignation

              flowchart TD
              griddy.nfl.models.BenchPress[BenchPress]
              griddy.nfl.models.entities.combine_events.HasDesignation[HasDesignation]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.models.entities.combine_events.HasDesignation --> griddy.nfl.models.BenchPress
                                griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.combine_events.HasDesignation
                



              click griddy.nfl.models.BenchPress href "" "griddy.nfl.models.BenchPress"
              click griddy.nfl.models.entities.combine_events.HasDesignation href "" "griddy.nfl.models.entities.combine_events.HasDesignation"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

repetitions instance-attribute

repetitions: int

Bench press reps

BenchPressTypedDict

Bases: HasDesignationTypedDict

              flowchart TD
              griddy.nfl.models.BenchPressTypedDict[BenchPressTypedDict]
              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict[HasDesignationTypedDict]

                              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict --> griddy.nfl.models.BenchPressTypedDict
                


              click griddy.nfl.models.BenchPressTypedDict href "" "griddy.nfl.models.BenchPressTypedDict"
              click griddy.nfl.models.entities.combine_events.HasDesignationTypedDict href "" "griddy.nfl.models.entities.combine_events.HasDesignationTypedDict"
            

Attributes

repetitions instance-attribute

repetitions: int

Bench press reps

BroadJump

Bases: HasDesignation

              flowchart TD
              griddy.nfl.models.BroadJump[BroadJump]
              griddy.nfl.models.entities.combine_events.HasDesignation[HasDesignation]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.models.entities.combine_events.HasDesignation --> griddy.nfl.models.BroadJump
                                griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.combine_events.HasDesignation
                



              click griddy.nfl.models.BroadJump href "" "griddy.nfl.models.BroadJump"
              click griddy.nfl.models.entities.combine_events.HasDesignation href "" "griddy.nfl.models.entities.combine_events.HasDesignation"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

inches instance-attribute

inches: int

Broad jump distance in inches

BroadJumpTypedDict

Bases: HasDesignationTypedDict

              flowchart TD
              griddy.nfl.models.BroadJumpTypedDict[BroadJumpTypedDict]
              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict[HasDesignationTypedDict]

                              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict --> griddy.nfl.models.BroadJumpTypedDict
                


              click griddy.nfl.models.BroadJumpTypedDict href "" "griddy.nfl.models.BroadJumpTypedDict"
              click griddy.nfl.models.entities.combine_events.HasDesignationTypedDict href "" "griddy.nfl.models.entities.combine_events.HasDesignationTypedDict"
            

Attributes

inches instance-attribute

inches: int

Broad jump distance in inches

FortyYardDash

Bases: HasDesignation

              flowchart TD
              griddy.nfl.models.FortyYardDash[FortyYardDash]
              griddy.nfl.models.entities.combine_events.HasDesignation[HasDesignation]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.models.entities.combine_events.HasDesignation --> griddy.nfl.models.FortyYardDash
                                griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.combine_events.HasDesignation
                



              click griddy.nfl.models.FortyYardDash href "" "griddy.nfl.models.FortyYardDash"
              click griddy.nfl.models.entities.combine_events.HasDesignation href "" "griddy.nfl.models.entities.combine_events.HasDesignation"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

seconds instance-attribute

seconds: float

40 yard dash time

FortyYardDashTypedDict

Bases: HasDesignationTypedDict

              flowchart TD
              griddy.nfl.models.FortyYardDashTypedDict[FortyYardDashTypedDict]
              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict[HasDesignationTypedDict]

                              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict --> griddy.nfl.models.FortyYardDashTypedDict
                


              click griddy.nfl.models.FortyYardDashTypedDict href "" "griddy.nfl.models.FortyYardDashTypedDict"
              click griddy.nfl.models.entities.combine_events.HasDesignationTypedDict href "" "griddy.nfl.models.entities.combine_events.HasDesignationTypedDict"
            

Attributes

seconds instance-attribute

seconds: float

40 yard dash time

TenYardSplit

Bases: HasDesignation

              flowchart TD
              griddy.nfl.models.TenYardSplit[TenYardSplit]
              griddy.nfl.models.entities.combine_events.HasDesignation[HasDesignation]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.models.entities.combine_events.HasDesignation --> griddy.nfl.models.TenYardSplit
                                griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.combine_events.HasDesignation
                



              click griddy.nfl.models.TenYardSplit href "" "griddy.nfl.models.TenYardSplit"
              click griddy.nfl.models.entities.combine_events.HasDesignation href "" "griddy.nfl.models.entities.combine_events.HasDesignation"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

seconds instance-attribute

seconds: float

Split time

TenYardSplitTypedDict

Bases: HasDesignationTypedDict

              flowchart TD
              griddy.nfl.models.TenYardSplitTypedDict[TenYardSplitTypedDict]
              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict[HasDesignationTypedDict]

                              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict --> griddy.nfl.models.TenYardSplitTypedDict
                


              click griddy.nfl.models.TenYardSplitTypedDict href "" "griddy.nfl.models.TenYardSplitTypedDict"
              click griddy.nfl.models.entities.combine_events.HasDesignationTypedDict href "" "griddy.nfl.models.entities.combine_events.HasDesignationTypedDict"
            

Attributes

seconds instance-attribute

seconds: float

Split time

ThreeConeDrill

Bases: HasDesignation

              flowchart TD
              griddy.nfl.models.ThreeConeDrill[ThreeConeDrill]
              griddy.nfl.models.entities.combine_events.HasDesignation[HasDesignation]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.models.entities.combine_events.HasDesignation --> griddy.nfl.models.ThreeConeDrill
                                griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.combine_events.HasDesignation
                



              click griddy.nfl.models.ThreeConeDrill href "" "griddy.nfl.models.ThreeConeDrill"
              click griddy.nfl.models.entities.combine_events.HasDesignation href "" "griddy.nfl.models.entities.combine_events.HasDesignation"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

seconds instance-attribute

seconds: float

Three cone drill time

ThreeConeDrillTypedDict

Bases: HasDesignationTypedDict

              flowchart TD
              griddy.nfl.models.ThreeConeDrillTypedDict[ThreeConeDrillTypedDict]
              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict[HasDesignationTypedDict]

                              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict --> griddy.nfl.models.ThreeConeDrillTypedDict
                


              click griddy.nfl.models.ThreeConeDrillTypedDict href "" "griddy.nfl.models.ThreeConeDrillTypedDict"
              click griddy.nfl.models.entities.combine_events.HasDesignationTypedDict href "" "griddy.nfl.models.entities.combine_events.HasDesignationTypedDict"
            

Attributes

seconds instance-attribute

seconds: float

Three cone drill time

TwentyYardShuffle

Bases: HasDesignation

              flowchart TD
              griddy.nfl.models.TwentyYardShuffle[TwentyYardShuffle]
              griddy.nfl.models.entities.combine_events.HasDesignation[HasDesignation]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.models.entities.combine_events.HasDesignation --> griddy.nfl.models.TwentyYardShuffle
                                griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.combine_events.HasDesignation
                



              click griddy.nfl.models.TwentyYardShuffle href "" "griddy.nfl.models.TwentyYardShuffle"
              click griddy.nfl.models.entities.combine_events.HasDesignation href "" "griddy.nfl.models.entities.combine_events.HasDesignation"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

seconds instance-attribute

seconds: float

Twenty yard shuffle time

TwentyYardShuffleTypedDict

Bases: HasDesignationTypedDict

              flowchart TD
              griddy.nfl.models.TwentyYardShuffleTypedDict[TwentyYardShuffleTypedDict]
              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict[HasDesignationTypedDict]

                              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict --> griddy.nfl.models.TwentyYardShuffleTypedDict
                


              click griddy.nfl.models.TwentyYardShuffleTypedDict href "" "griddy.nfl.models.TwentyYardShuffleTypedDict"
              click griddy.nfl.models.entities.combine_events.HasDesignationTypedDict href "" "griddy.nfl.models.entities.combine_events.HasDesignationTypedDict"
            

Attributes

seconds instance-attribute

seconds: float

Twenty yard shuffle time

VerticalJump

Bases: HasDesignation

              flowchart TD
              griddy.nfl.models.VerticalJump[VerticalJump]
              griddy.nfl.models.entities.combine_events.HasDesignation[HasDesignation]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.models.entities.combine_events.HasDesignation --> griddy.nfl.models.VerticalJump
                                griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.combine_events.HasDesignation
                



              click griddy.nfl.models.VerticalJump href "" "griddy.nfl.models.VerticalJump"
              click griddy.nfl.models.entities.combine_events.HasDesignation href "" "griddy.nfl.models.entities.combine_events.HasDesignation"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

inches instance-attribute

inches: float

Vertical jump height

VerticalJumpTypedDict

Bases: HasDesignationTypedDict

              flowchart TD
              griddy.nfl.models.VerticalJumpTypedDict[VerticalJumpTypedDict]
              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict[HasDesignationTypedDict]

                              griddy.nfl.models.entities.combine_events.HasDesignationTypedDict --> griddy.nfl.models.VerticalJumpTypedDict
                


              click griddy.nfl.models.VerticalJumpTypedDict href "" "griddy.nfl.models.VerticalJumpTypedDict"
              click griddy.nfl.models.entities.combine_events.HasDesignationTypedDict href "" "griddy.nfl.models.entities.combine_events.HasDesignationTypedDict"
            

Attributes

inches instance-attribute

inches: float

Vertical jump height

CombinePerson

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.CombinePerson[CombinePerson]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.CombinePerson
                


              click griddy.nfl.models.CombinePerson href "" "griddy.nfl.models.CombinePerson"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

id_ instance-attribute

id_: Annotated[str, Field(alias=id)]

UUID assigned to the prospect by the NFL

display_name instance-attribute

display_name: Annotated[str, Field(alias=displayName)]

Fist and last name

esb_id instance-attribute

esb_id: Annotated[str, Field(alias=esbId)]

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

first_name instance-attribute

first_name: Annotated[str, Field(alias=firstName)]

Prospect's given name

last_name instance-attribute

last_name: Annotated[str, Field(alias=lastName)]

Prospect's last name

hometown class-attribute instance-attribute

hometown: Optional[str] = None

Prospect's hometown

college_names instance-attribute

college_names: Annotated[
    List[str], Field(alias=collegeNames)
]

College(s) the prospect attended

CombinePersonTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.CombinePersonTypedDict[CombinePersonTypedDict]

              

              click griddy.nfl.models.CombinePersonTypedDict href "" "griddy.nfl.models.CombinePersonTypedDict"
            

Attributes

id_ instance-attribute

id_: str

UUID assigned to the prospect by the NFL

display_name instance-attribute

display_name: str

Fist and last name

esb_id instance-attribute

esb_id: str

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

first_name instance-attribute

first_name: str

Prospect's given name

last_name instance-attribute

last_name: str

Prospect's last name

hometown instance-attribute

hometown: NotRequired[str]

Prospect's hometown

college_names instance-attribute

college_names: List[str]

College(s) the prospect attended

CombineProfile

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.CombineProfile[CombineProfile]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.CombineProfile
                


              click griddy.nfl.models.CombineProfile href "" "griddy.nfl.models.CombineProfile"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

id_ instance-attribute

id_: Annotated[str, Field(alias=id)]

UUID assigned by the NFL

year instance-attribute

year: int

Draft year of the combine testing

person instance-attribute

person: CombinePerson

Bio information about the prospect

arm_length class-attribute instance-attribute

arm_length: Annotated[
    Optional[float], Field(alias=armLength)
] = None

Arm length in inches precise to 1/8 inch, represented as a float

athletic_score class-attribute instance-attribute

athletic_score: Annotated[
    Optional[float], Field(alias=athleticScore)
] = None

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

bench_press class-attribute instance-attribute

bench_press: Annotated[
    Optional[BenchPress], Field(alias=benchPress)
] = None

Bench press results

broad_jump class-attribute instance-attribute

broad_jump: Annotated[
    Optional[BroadJump], Field(alias=broadJump)
] = None

Broad jump results

bio class-attribute instance-attribute

bio: Optional[str] = None

HTML formatted snippet containing brief summary of prospect's background

college_class instance-attribute

college_class: Annotated[
    CollegeClassEnum, Field(alias=collegeClass)
]

College year of the prospect

draft_grade class-attribute instance-attribute

draft_grade: Annotated[
    Optional[float], Field(alias=draftGrade)
] = None

0-100 overall grade

draft_projection class-attribute instance-attribute

draft_projection: Annotated[
    Optional[str], Field(alias=draftProjection)
] = None

Anticipated draft outcome for the prospect

forty_yard_dash class-attribute instance-attribute

forty_yard_dash: Annotated[
    Optional[FortyYardDash], Field(alias=fortyYardDash)
] = None

Forty yard dash outcome

grade class-attribute instance-attribute

grade: Optional[float] = None

hand_size class-attribute instance-attribute

hand_size: Annotated[
    Optional[float], Field(alias=handSize)
] = None

Thumb to pinky tip measurement, precise to 1/8 inch

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to the prospect's headshot

height instance-attribute

height: float

Prospect height in inches

nfl_comparison class-attribute instance-attribute

nfl_comparison: Annotated[
    Optional[str], Field(alias=nflComparison)
] = None

Name of an NFL player with a similar profile

overview class-attribute instance-attribute

overview: Optional[str] = None

HTML formatted snippet with scouting elevator pitch

production_score class-attribute instance-attribute

production_score: Annotated[
    Optional[float], Field(alias=productionScore)
] = None

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

profile_author class-attribute instance-attribute

profile_author: Annotated[
    Optional[str], Field(alias=profileAuthor)
] = None

Name of the person who wrote the scouting profile

pro_forty_yard_dash class-attribute instance-attribute

pro_forty_yard_dash: Annotated[
    Optional[FortyYardDash], Field(alias=proFortyYardDash)
] = None

Forty yard dash from prospect's pro day

sources_tell_us class-attribute instance-attribute

sources_tell_us: Annotated[
    Optional[str], Field(alias=sourcesTellUs)
] = None

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

strengths class-attribute instance-attribute

strengths: Optional[str] = None

HTML - Prospect strengths

ten_yard_split class-attribute instance-attribute

ten_yard_split: Annotated[
    Optional[TenYardSplit], Field(alias=tenYardSplit)
] = None

Ten yard split time in 40 yd dash

three_cone_drill class-attribute instance-attribute

three_cone_drill: Annotated[
    Optional[ThreeConeDrill], Field(alias=threeConeDrill)
] = None

Three cone drill result

twenty_yard_shuffle class-attribute instance-attribute

twenty_yard_shuffle: Annotated[
    Optional[TwentyYardShuffle],
    Field(alias=twentyYardShuffle),
] = None

Twenty yard shuffle result

weaknesses class-attribute instance-attribute

weaknesses: Optional[str] = None

HTML - Prospect weaknesses

combine_attendance instance-attribute

combine_attendance: Annotated[
    bool, Field(alias=combineAttendance)
]

Whether or not the prospect attended the official scouting combine

position instance-attribute

position: str

Player's position in college

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[str], Field(alias=positionGroup)
] = None

Position group in college

vertical_jump class-attribute instance-attribute

vertical_jump: Annotated[
    Optional[VerticalJump], Field(alias=verticalJump)
] = None

Vertical jump result

weight instance-attribute

weight: float

Weight in pounds

CombineProfileTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.CombineProfileTypedDict[CombineProfileTypedDict]

              

              click griddy.nfl.models.CombineProfileTypedDict href "" "griddy.nfl.models.CombineProfileTypedDict"
            

Attributes

id_ instance-attribute

id_: str

UUID assigned by the NFL

year instance-attribute

year: int

Draft year of the combine testing

person instance-attribute

person: CombinePersonTypedDict

Bio information about the prospect

arm_length instance-attribute

arm_length: NotRequired[float]

Arm length in inches precise to 1/8 inch, represented as a float

athletic_score instance-attribute

athletic_score: NotRequired[float]

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

bench_press instance-attribute

bench_press: NotRequired[BenchPressTypedDict]

Bench press results

broad_jump instance-attribute

broad_jump: NotRequired[BroadJumpTypedDict]

Broad jump results

bio instance-attribute

bio: NotRequired[str]

HTML formatted snippet containing brief summary of prospect's background

college_class instance-attribute

college_class: CollegeClassEnum

College year of the prospect

draft_grade instance-attribute

draft_grade: NotRequired[float]

0-100 overall grade

draft_projection instance-attribute

draft_projection: NotRequired[str]

Anticipated draft outcome for the prospect

forty_yard_dash instance-attribute

forty_yard_dash: NotRequired[FortyYardDashTypedDict]

Forty yard dash outcome

grade instance-attribute

grade: NotRequired[float]

hand_size instance-attribute

hand_size: NotRequired[float]

Thumb to pinky tip measurement, precise to 1/8 inch

headshot instance-attribute

headshot: NotRequired[str]

URL to the prospect's headshot

height instance-attribute

height: float

Prospect height in inches

nfl_comparison instance-attribute

nfl_comparison: NotRequired[str]

Name of an NFL player with a similar profile

overview instance-attribute

overview: NotRequired[str]

HTML formatted snippet with scouting elevator pitch

production_score instance-attribute

production_score: NotRequired[float]

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

profile_author instance-attribute

profile_author: NotRequired[str]

Name of the person who wrote the scouting profile

pro_forty_yard_dash instance-attribute

pro_forty_yard_dash: NotRequired[FortyYardDashTypedDict]

Forty yard dash from prospect's pro day

sources_tell_us instance-attribute

sources_tell_us: NotRequired[str]

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

strengths instance-attribute

strengths: NotRequired[str]

HTML - Prospect strengths

ten_yard_split instance-attribute

ten_yard_split: NotRequired[TenYardSplitTypedDict]

Ten yard split time in 40 yd dash

three_cone_drill instance-attribute

three_cone_drill: NotRequired[ThreeConeDrillTypedDict]

Three cone drill result

twenty_yard_shuffle instance-attribute

twenty_yard_shuffle: NotRequired[TwentyYardShuffleTypedDict]

Twenty yard shuffle result

weaknesses instance-attribute

weaknesses: NotRequired[str]

HTML - Prospect weaknesses

combine_attendance instance-attribute

combine_attendance: bool

Whether or not the prospect attended the official scouting combine

position instance-attribute

position: str

Player's position in college

position_group instance-attribute

position_group: NotRequired[str]

Position group in college

vertical_jump instance-attribute

vertical_jump: NotRequired[VerticalJumpTypedDict]

Vertical jump result

weight instance-attribute

weight: float

Weight in pounds

FootballRoster

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.FootballRoster[FootballRoster]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.FootballRoster
                


              click griddy.nfl.models.FootballRoster href "" "griddy.nfl.models.FootballRoster"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: int

Season the roster reflects

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias=seasonType)
]

Season type

team instance-attribute

team: Team

Team info

persons instance-attribute

persons: List[Person]

List of players on the team roster

FootballRosterTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.FootballRosterTypedDict[FootballRosterTypedDict]

              

              click griddy.nfl.models.FootballRosterTypedDict href "" "griddy.nfl.models.FootballRosterTypedDict"
            

Attributes

season instance-attribute

season: int

Season the roster reflects

season_type instance-attribute

season_type: SeasonTypeEnum

Season type

team instance-attribute

team: TeamTypedDict

Team info

persons instance-attribute

persons: List[PersonTypedDict]

List of players on the team roster

NgsChart

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsChart[NgsChart]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsChart
                


              click griddy.nfl.models.NgsChart href "" "griddy.nfl.models.NgsChart"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

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

NgsChartPlayer

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsChartPlayer[NgsChartPlayer]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsChartPlayer
                


              click griddy.nfl.models.NgsChartPlayer href "" "griddy.nfl.models.NgsChartPlayer"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

A player available in the chart system.

NgsChartPlayerTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsChartPlayerTypedDict[NgsChartPlayerTypedDict]

              

              click griddy.nfl.models.NgsChartPlayerTypedDict href "" "griddy.nfl.models.NgsChartPlayerTypedDict"
            

A player available in the chart system.

NgsChartTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsChartTypedDict[NgsChartTypedDict]

              

              click griddy.nfl.models.NgsChartTypedDict href "" "griddy.nfl.models.NgsChartTypedDict"
            

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

NgsHighlight

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsHighlight[NgsHighlight]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsHighlight
                


              click griddy.nfl.models.NgsHighlight href "" "griddy.nfl.models.NgsHighlight"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

A play highlight.

NgsHighlightTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsHighlightTypedDict[NgsHighlightTypedDict]

              

              click griddy.nfl.models.NgsHighlightTypedDict href "" "griddy.nfl.models.NgsHighlightTypedDict"
            

A play highlight.

NgsGameLeaders

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsGameLeaders[NgsGameLeaders]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsGameLeaders
                


              click griddy.nfl.models.NgsGameLeaders href "" "griddy.nfl.models.NgsGameLeaders"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Game leaders for speed, sacks, and pass distance.

NgsGameLeadersTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsGameLeadersTypedDict[NgsGameLeadersTypedDict]

              

              click griddy.nfl.models.NgsGameLeadersTypedDict href "" "griddy.nfl.models.NgsGameLeadersTypedDict"
            

Game leaders for speed, sacks, and pass distance.

NgsGamePassDistanceLeader

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsGamePassDistanceLeader[NgsGamePassDistanceLeader]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsGamePassDistanceLeader
                


              click griddy.nfl.models.NgsGamePassDistanceLeader href "" "griddy.nfl.models.NgsGamePassDistanceLeader"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Pass distance leader for a game.

NgsGamePassDistanceLeaderTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsGamePassDistanceLeaderTypedDict[NgsGamePassDistanceLeaderTypedDict]

              

              click griddy.nfl.models.NgsGamePassDistanceLeaderTypedDict href "" "griddy.nfl.models.NgsGamePassDistanceLeaderTypedDict"
            

Pass distance leader for a game.

NgsGameSackLeader

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsGameSackLeader[NgsGameSackLeader]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsGameSackLeader
                


              click griddy.nfl.models.NgsGameSackLeader href "" "griddy.nfl.models.NgsGameSackLeader"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Sack leader for a game.

NgsGameSackLeaderTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsGameSackLeaderTypedDict[NgsGameSackLeaderTypedDict]

              

              click griddy.nfl.models.NgsGameSackLeaderTypedDict href "" "griddy.nfl.models.NgsGameSackLeaderTypedDict"
            

Sack leader for a game.

NgsGameScheduleInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsGameScheduleInfo[NgsGameScheduleInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsGameScheduleInfo
                


              click griddy.nfl.models.NgsGameScheduleInfo href "" "griddy.nfl.models.NgsGameScheduleInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Game schedule information in overview.

NgsGameScheduleInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsGameScheduleInfoTypedDict[NgsGameScheduleInfoTypedDict]

              

              click griddy.nfl.models.NgsGameScheduleInfoTypedDict href "" "griddy.nfl.models.NgsGameScheduleInfoTypedDict"
            

Game schedule information in overview.

NgsGameSpeedLeader

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsGameSpeedLeader[NgsGameSpeedLeader]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsGameSpeedLeader
                


              click griddy.nfl.models.NgsGameSpeedLeader href "" "griddy.nfl.models.NgsGameSpeedLeader"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Speed leader for a game.

NgsGameSpeedLeaderTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsGameSpeedLeaderTypedDict[NgsGameSpeedLeaderTypedDict]

              

              click griddy.nfl.models.NgsGameSpeedLeaderTypedDict href "" "griddy.nfl.models.NgsGameSpeedLeaderTypedDict"
            

Speed leader for a game.

NgsLeagueAverage

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsLeagueAverage[NgsLeagueAverage]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsLeagueAverage
                


              click griddy.nfl.models.NgsLeagueAverage href "" "griddy.nfl.models.NgsLeagueAverage"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

League average value.

NgsLeagueAverageTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsLeagueAverageTypedDict[NgsLeagueAverageTypedDict]

              

              click griddy.nfl.models.NgsLeagueAverageTypedDict href "" "griddy.nfl.models.NgsLeagueAverageTypedDict"
            

League average value.

NgsPassDistanceLeadersMap

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPassDistanceLeadersMap[NgsPassDistanceLeadersMap]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPassDistanceLeadersMap
                


              click griddy.nfl.models.NgsPassDistanceLeadersMap href "" "griddy.nfl.models.NgsPassDistanceLeadersMap"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Pass distance leaders for home and visitor.

NgsPassDistanceLeadersMapTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPassDistanceLeadersMapTypedDict[NgsPassDistanceLeadersMapTypedDict]

              

              click griddy.nfl.models.NgsPassDistanceLeadersMapTypedDict href "" "griddy.nfl.models.NgsPassDistanceLeadersMapTypedDict"
            

Pass distance leaders for home and visitor.

NgsPasserInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPasserInfo[NgsPasserInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPasserInfo
                


              click griddy.nfl.models.NgsPasserInfo href "" "griddy.nfl.models.NgsPasserInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Passer information in game overview.

NgsPasserInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPasserInfoTypedDict[NgsPasserInfoTypedDict]

              

              click griddy.nfl.models.NgsPasserInfoTypedDict href "" "griddy.nfl.models.NgsPasserInfoTypedDict"
            

Passer information in game overview.

NgsPassersOverview

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPassersOverview[NgsPassersOverview]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPassersOverview
                


              click griddy.nfl.models.NgsPassersOverview href "" "griddy.nfl.models.NgsPassersOverview"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Passers overview for home and visitor teams.

NgsPassersOverviewTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPassersOverviewTypedDict[NgsPassersOverviewTypedDict]

              

              click griddy.nfl.models.NgsPassersOverviewTypedDict href "" "griddy.nfl.models.NgsPassersOverviewTypedDict"
            

Passers overview for home and visitor teams.

NgsPassInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPassInfo[NgsPassInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPassInfo
                


              click griddy.nfl.models.NgsPassInfo href "" "griddy.nfl.models.NgsPassInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Pass info with air distance.

NgsPassInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPassInfoTypedDict[NgsPassInfoTypedDict]

              

              click griddy.nfl.models.NgsPassInfoTypedDict href "" "griddy.nfl.models.NgsPassInfoTypedDict"
            

Pass info with air distance.

NgsPassingZone

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPassingZone[NgsPassingZone]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPassingZone
                


              click griddy.nfl.models.NgsPassingZone href "" "griddy.nfl.models.NgsPassingZone"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Passing zone statistics.

NgsPassingZoneTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPassingZoneTypedDict[NgsPassingZoneTypedDict]

              

              click griddy.nfl.models.NgsPassingZoneTypedDict href "" "griddy.nfl.models.NgsPassingZoneTypedDict"
            

Passing zone statistics.

NgsPassRusherInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPassRusherInfo[NgsPassRusherInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPassRusherInfo
                


              click griddy.nfl.models.NgsPassRusherInfo href "" "griddy.nfl.models.NgsPassRusherInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Pass rusher information in game overview.

NgsPassRusherInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPassRusherInfoTypedDict[NgsPassRusherInfoTypedDict]

              

              click griddy.nfl.models.NgsPassRusherInfoTypedDict href "" "griddy.nfl.models.NgsPassRusherInfoTypedDict"
            

Pass rusher information in game overview.

NgsPassRushersOverview

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPassRushersOverview[NgsPassRushersOverview]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPassRushersOverview
                


              click griddy.nfl.models.NgsPassRushersOverview href "" "griddy.nfl.models.NgsPassRushersOverview"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Pass rushers overview for home and visitor teams.

NgsPassRushersOverviewTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPassRushersOverviewTypedDict[NgsPassRushersOverviewTypedDict]

              

              click griddy.nfl.models.NgsPassRushersOverviewTypedDict href "" "griddy.nfl.models.NgsPassRushersOverviewTypedDict"
            

Pass rushers overview for home and visitor teams.

NgsReceiverInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsReceiverInfo[NgsReceiverInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsReceiverInfo
                


              click griddy.nfl.models.NgsReceiverInfo href "" "griddy.nfl.models.NgsReceiverInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Receiver information in game overview.

NgsReceiverInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsReceiverInfoTypedDict[NgsReceiverInfoTypedDict]

              

              click griddy.nfl.models.NgsReceiverInfoTypedDict href "" "griddy.nfl.models.NgsReceiverInfoTypedDict"
            

Receiver information in game overview.

NgsReceiversOverview

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsReceiversOverview[NgsReceiversOverview]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsReceiversOverview
                


              click griddy.nfl.models.NgsReceiversOverview href "" "griddy.nfl.models.NgsReceiversOverview"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Receivers overview for home and visitor teams.

NgsReceiversOverviewTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsReceiversOverviewTypedDict[NgsReceiversOverviewTypedDict]

              

              click griddy.nfl.models.NgsReceiversOverviewTypedDict href "" "griddy.nfl.models.NgsReceiversOverviewTypedDict"
            

Receivers overview for home and visitor teams.

NgsReceptionInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsReceptionInfo[NgsReceptionInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsReceptionInfo
                


              click griddy.nfl.models.NgsReceptionInfo href "" "griddy.nfl.models.NgsReceptionInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Reception info for a receiver.

NgsReceptionInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsReceptionInfoTypedDict[NgsReceptionInfoTypedDict]

              

              click griddy.nfl.models.NgsReceptionInfoTypedDict href "" "griddy.nfl.models.NgsReceptionInfoTypedDict"
            

Reception info for a receiver.

NgsRusherInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsRusherInfo[NgsRusherInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsRusherInfo
                


              click griddy.nfl.models.NgsRusherInfo href "" "griddy.nfl.models.NgsRusherInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Rusher information in game overview.

NgsRusherInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsRusherInfoTypedDict[NgsRusherInfoTypedDict]

              

              click griddy.nfl.models.NgsRusherInfoTypedDict href "" "griddy.nfl.models.NgsRusherInfoTypedDict"
            

Rusher information in game overview.

NgsRushersOverview

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsRushersOverview[NgsRushersOverview]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsRushersOverview
                


              click griddy.nfl.models.NgsRushersOverview href "" "griddy.nfl.models.NgsRushersOverview"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Rushers overview for home and visitor teams.

NgsRushersOverviewTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsRushersOverviewTypedDict[NgsRushersOverviewTypedDict]

              

              click griddy.nfl.models.NgsRushersOverviewTypedDict href "" "griddy.nfl.models.NgsRushersOverviewTypedDict"
            

Rushers overview for home and visitor teams.

NgsRushInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsRushInfo[NgsRushInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsRushInfo
                


              click griddy.nfl.models.NgsRushInfo href "" "griddy.nfl.models.NgsRushInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Rush info for a rusher.

NgsRushInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsRushInfoTypedDict[NgsRushInfoTypedDict]

              

              click griddy.nfl.models.NgsRushInfoTypedDict href "" "griddy.nfl.models.NgsRushInfoTypedDict"
            

Rush info for a rusher.

NgsRushLocationStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsRushLocationStats[NgsRushLocationStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsRushLocationStats
                


              click griddy.nfl.models.NgsRushLocationStats href "" "griddy.nfl.models.NgsRushLocationStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Rush location statistics.

NgsRushLocationStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsRushLocationStatsTypedDict[NgsRushLocationStatsTypedDict]

              

              click griddy.nfl.models.NgsRushLocationStatsTypedDict href "" "griddy.nfl.models.NgsRushLocationStatsTypedDict"
            

Rush location statistics.

NgsSackLeadersMap

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsSackLeadersMap[NgsSackLeadersMap]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsSackLeadersMap
                


              click griddy.nfl.models.NgsSackLeadersMap href "" "griddy.nfl.models.NgsSackLeadersMap"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Sack leaders for home and visitor.

NgsSackLeadersMapTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsSackLeadersMapTypedDict[NgsSackLeadersMapTypedDict]

              

              click griddy.nfl.models.NgsSackLeadersMapTypedDict href "" "griddy.nfl.models.NgsSackLeadersMapTypedDict"
            

Sack leaders for home and visitor.

NgsSpeedLeadersMap

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsSpeedLeadersMap[NgsSpeedLeadersMap]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsSpeedLeadersMap
                


              click griddy.nfl.models.NgsSpeedLeadersMap href "" "griddy.nfl.models.NgsSpeedLeadersMap"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Speed leaders for home and visitor.

NgsSpeedLeadersMapTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsSpeedLeadersMapTypedDict[NgsSpeedLeadersMapTypedDict]

              

              click griddy.nfl.models.NgsSpeedLeadersMapTypedDict href "" "griddy.nfl.models.NgsSpeedLeadersMapTypedDict"
            

Speed leaders for home and visitor.

NgsTackleInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsTackleInfo[NgsTackleInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsTackleInfo
                


              click griddy.nfl.models.NgsTackleInfo href "" "griddy.nfl.models.NgsTackleInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Tackle info with time to tackle.

NgsTackleInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsTackleInfoTypedDict[NgsTackleInfoTypedDict]

              

              click griddy.nfl.models.NgsTackleInfoTypedDict href "" "griddy.nfl.models.NgsTackleInfoTypedDict"
            

Tackle info with time to tackle.

NgsCompletionLeader

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsCompletionLeader[NgsCompletionLeader]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsCompletionLeader
                


              click griddy.nfl.models.NgsCompletionLeader href "" "griddy.nfl.models.NgsCompletionLeader"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Leader info for completion probability leaderboards.

NgsCompletionLeaderEntry

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsCompletionLeaderEntry[NgsCompletionLeaderEntry]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsCompletionLeaderEntry
                


              click griddy.nfl.models.NgsCompletionLeaderEntry href "" "griddy.nfl.models.NgsCompletionLeaderEntry"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Entry in completion probability leaderboards.

NgsCompletionLeaderEntryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsCompletionLeaderEntryTypedDict[NgsCompletionLeaderEntryTypedDict]

              

              click griddy.nfl.models.NgsCompletionLeaderEntryTypedDict href "" "griddy.nfl.models.NgsCompletionLeaderEntryTypedDict"
            

Entry in completion probability leaderboards.

NgsCompletionLeaderTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsCompletionLeaderTypedDict[NgsCompletionLeaderTypedDict]

              

              click griddy.nfl.models.NgsCompletionLeaderTypedDict href "" "griddy.nfl.models.NgsCompletionLeaderTypedDict"
            

Leader info for completion probability leaderboards.

NgsDistanceLeader

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsDistanceLeader[NgsDistanceLeader]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsDistanceLeader
                


              click griddy.nfl.models.NgsDistanceLeader href "" "griddy.nfl.models.NgsDistanceLeader"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Leader info for distance leaderboards.

NgsDistanceLeaderEntry

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsDistanceLeaderEntry[NgsDistanceLeaderEntry]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsDistanceLeaderEntry
                


              click griddy.nfl.models.NgsDistanceLeaderEntry href "" "griddy.nfl.models.NgsDistanceLeaderEntry"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Entry in distance leaderboards.

NgsDistanceLeaderEntryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsDistanceLeaderEntryTypedDict[NgsDistanceLeaderEntryTypedDict]

              

              click griddy.nfl.models.NgsDistanceLeaderEntryTypedDict href "" "griddy.nfl.models.NgsDistanceLeaderEntryTypedDict"
            

Entry in distance leaderboards.

NgsDistanceLeaderTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsDistanceLeaderTypedDict[NgsDistanceLeaderTypedDict]

              

              click griddy.nfl.models.NgsDistanceLeaderTypedDict href "" "griddy.nfl.models.NgsDistanceLeaderTypedDict"
            

Leader info for distance leaderboards.

NgsERYLeader

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsERYLeader[NgsERYLeader]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsERYLeader
                


              click griddy.nfl.models.NgsERYLeader href "" "griddy.nfl.models.NgsERYLeader"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Leader info for expected rush yards (ERY) leaderboards.

NgsERYLeaderEntry

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsERYLeaderEntry[NgsERYLeaderEntry]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsERYLeaderEntry
                


              click griddy.nfl.models.NgsERYLeaderEntry href "" "griddy.nfl.models.NgsERYLeaderEntry"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Entry in ERY leaderboards.

NgsERYLeaderEntryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsERYLeaderEntryTypedDict[NgsERYLeaderEntryTypedDict]

              

              click griddy.nfl.models.NgsERYLeaderEntryTypedDict href "" "griddy.nfl.models.NgsERYLeaderEntryTypedDict"
            

Entry in ERY leaderboards.

NgsERYLeaderTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsERYLeaderTypedDict[NgsERYLeaderTypedDict]

              

              click griddy.nfl.models.NgsERYLeaderTypedDict href "" "griddy.nfl.models.NgsERYLeaderTypedDict"
            

Leader info for expected rush yards (ERY) leaderboards.

NgsSackLeader

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsSackLeader[NgsSackLeader]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsSackLeader
                


              click griddy.nfl.models.NgsSackLeader href "" "griddy.nfl.models.NgsSackLeader"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Leader info for sack leaderboards.

NgsSackLeaderEntry

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsSackLeaderEntry[NgsSackLeaderEntry]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsSackLeaderEntry
                


              click griddy.nfl.models.NgsSackLeaderEntry href "" "griddy.nfl.models.NgsSackLeaderEntry"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Entry in sack leaderboards.

NgsSackLeaderEntryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsSackLeaderEntryTypedDict[NgsSackLeaderEntryTypedDict]

              

              click griddy.nfl.models.NgsSackLeaderEntryTypedDict href "" "griddy.nfl.models.NgsSackLeaderEntryTypedDict"
            

Entry in sack leaderboards.

NgsSackLeaderTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsSackLeaderTypedDict[NgsSackLeaderTypedDict]

              

              click griddy.nfl.models.NgsSackLeaderTypedDict href "" "griddy.nfl.models.NgsSackLeaderTypedDict"
            

Leader info for sack leaderboards.

NgsSpeedLeader

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsSpeedLeader[NgsSpeedLeader]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsSpeedLeader
                


              click griddy.nfl.models.NgsSpeedLeader href "" "griddy.nfl.models.NgsSpeedLeader"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Leader info for speed leaderboards.

NgsSpeedLeaderEntry

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsSpeedLeaderEntry[NgsSpeedLeaderEntry]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsSpeedLeaderEntry
                


              click griddy.nfl.models.NgsSpeedLeaderEntry href "" "griddy.nfl.models.NgsSpeedLeaderEntry"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Entry in speed leaderboards.

NgsSpeedLeaderEntryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsSpeedLeaderEntryTypedDict[NgsSpeedLeaderEntryTypedDict]

              

              click griddy.nfl.models.NgsSpeedLeaderEntryTypedDict href "" "griddy.nfl.models.NgsSpeedLeaderEntryTypedDict"
            

Entry in speed leaderboards.

NgsSpeedLeaderTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsSpeedLeaderTypedDict[NgsSpeedLeaderTypedDict]

              

              click griddy.nfl.models.NgsSpeedLeaderTypedDict href "" "griddy.nfl.models.NgsSpeedLeaderTypedDict"
            

Leader info for speed leaderboards.

NgsTackleLeader

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsTackleLeader[NgsTackleLeader]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsTackleLeader
                


              click griddy.nfl.models.NgsTackleLeader href "" "griddy.nfl.models.NgsTackleLeader"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Leader info for tackle distance leaderboards.

NgsTackleLeaderEntry

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsTackleLeaderEntry[NgsTackleLeaderEntry]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsTackleLeaderEntry
                


              click griddy.nfl.models.NgsTackleLeaderEntry href "" "griddy.nfl.models.NgsTackleLeaderEntry"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Entry in tackle distance leaderboards.

NgsTackleLeaderEntryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsTackleLeaderEntryTypedDict[NgsTackleLeaderEntryTypedDict]

              

              click griddy.nfl.models.NgsTackleLeaderEntryTypedDict href "" "griddy.nfl.models.NgsTackleLeaderEntryTypedDict"
            

Entry in tackle distance leaderboards.

NgsTackleLeaderTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsTackleLeaderTypedDict[NgsTackleLeaderTypedDict]

              

              click griddy.nfl.models.NgsTackleLeaderTypedDict href "" "griddy.nfl.models.NgsTackleLeaderTypedDict"
            

Leader info for tackle distance leaderboards.

NgsYACLeader

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsYACLeader[NgsYACLeader]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsYACLeader
                


              click griddy.nfl.models.NgsYACLeader href "" "griddy.nfl.models.NgsYACLeader"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Leader info for YAC (yards after catch) leaderboards.

NgsYACLeaderEntry

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsYACLeaderEntry[NgsYACLeaderEntry]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsYACLeaderEntry
                


              click griddy.nfl.models.NgsYACLeaderEntry href "" "griddy.nfl.models.NgsYACLeaderEntry"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Entry in YAC leaderboards.

NgsYACLeaderEntryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsYACLeaderEntryTypedDict[NgsYACLeaderEntryTypedDict]

              

              click griddy.nfl.models.NgsYACLeaderEntryTypedDict href "" "griddy.nfl.models.NgsYACLeaderEntryTypedDict"
            

Entry in YAC leaderboards.

NgsYACLeaderTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsYACLeaderTypedDict[NgsYACLeaderTypedDict]

              

              click griddy.nfl.models.NgsYACLeaderTypedDict href "" "griddy.nfl.models.NgsYACLeaderTypedDict"
            

Leader info for YAC (yards after catch) leaderboards.

NgsContentItem

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsContentItem[NgsContentItem]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsContentItem
                


              click griddy.nfl.models.NgsContentItem href "" "griddy.nfl.models.NgsContentItem"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

A content item (article or video).

NgsContentItemTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsContentItemTypedDict[NgsContentItemTypedDict]

              

              click griddy.nfl.models.NgsContentItemTypedDict href "" "griddy.nfl.models.NgsContentItemTypedDict"
            

A content item (article or video).

NgsContentMetadata

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsContentMetadata[NgsContentMetadata]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsContentMetadata
                


              click griddy.nfl.models.NgsContentMetadata href "" "griddy.nfl.models.NgsContentMetadata"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Metadata for content responses.

NgsContentMetadataTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsContentMetadataTypedDict[NgsContentMetadataTypedDict]

              

              click griddy.nfl.models.NgsContentMetadataTypedDict href "" "griddy.nfl.models.NgsContentMetadataTypedDict"
            

Metadata for content responses.

NgsContentPagination

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsContentPagination[NgsContentPagination]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsContentPagination
                


              click griddy.nfl.models.NgsContentPagination href "" "griddy.nfl.models.NgsContentPagination"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Pagination for content responses.

NgsContentPaginationTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsContentPaginationTypedDict[NgsContentPaginationTypedDict]

              

              click griddy.nfl.models.NgsContentPaginationTypedDict href "" "griddy.nfl.models.NgsContentPaginationTypedDict"
            

Pagination for content responses.

NgsContentTag

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsContentTag[NgsContentTag]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsContentTag
                


              click griddy.nfl.models.NgsContentTag href "" "griddy.nfl.models.NgsContentTag"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Tag for content items.

NgsContentTagTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsContentTagTypedDict[NgsContentTagTypedDict]

              

              click griddy.nfl.models.NgsContentTagTypedDict href "" "griddy.nfl.models.NgsContentTagTypedDict"
            

Tag for content items.

NgsThumbnail

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsThumbnail[NgsThumbnail]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsThumbnail
                


              click griddy.nfl.models.NgsThumbnail href "" "griddy.nfl.models.NgsThumbnail"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Thumbnail for content items.

NgsThumbnailTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsThumbnailTypedDict[NgsThumbnailTypedDict]

              

              click griddy.nfl.models.NgsThumbnailTypedDict href "" "griddy.nfl.models.NgsThumbnailTypedDict"
            

Thumbnail for content items.

NgsPlay

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPlay[NgsPlay]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPlay
                


              click griddy.nfl.models.NgsPlay href "" "griddy.nfl.models.NgsPlay"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Detailed play information from NGS endpoints.

NgsPlayStat

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPlayStat[NgsPlayStat]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPlayStat
                


              click griddy.nfl.models.NgsPlayStat href "" "griddy.nfl.models.NgsPlayStat"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Statistics for a single play.

NgsPlayStatTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPlayStatTypedDict[NgsPlayStatTypedDict]

              

              click griddy.nfl.models.NgsPlayStatTypedDict href "" "griddy.nfl.models.NgsPlayStatTypedDict"
            

Statistics for a single play.

NgsPlayTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPlayTypedDict[NgsPlayTypedDict]

              

              click griddy.nfl.models.NgsPlayTypedDict href "" "griddy.nfl.models.NgsPlayTypedDict"
            

Detailed play information from NGS endpoints.

NgsPassingStat

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPassingStat[NgsPassingStat]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPassingStat
                


              click griddy.nfl.models.NgsPassingStat href "" "griddy.nfl.models.NgsPassingStat"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

NGS passing statistics for a player.

NgsPassingStatTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPassingStatTypedDict[NgsPassingStatTypedDict]

              

              click griddy.nfl.models.NgsPassingStatTypedDict href "" "griddy.nfl.models.NgsPassingStatTypedDict"
            

NGS passing statistics for a player.

NgsReceivingStat

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsReceivingStat[NgsReceivingStat]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsReceivingStat
                


              click griddy.nfl.models.NgsReceivingStat href "" "griddy.nfl.models.NgsReceivingStat"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

NGS receiving statistics for a player.

NgsReceivingStatTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsReceivingStatTypedDict[NgsReceivingStatTypedDict]

              

              click griddy.nfl.models.NgsReceivingStatTypedDict href "" "griddy.nfl.models.NgsReceivingStatTypedDict"
            

NGS receiving statistics for a player.

NgsRushingStat

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsRushingStat[NgsRushingStat]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsRushingStat
                


              click griddy.nfl.models.NgsRushingStat href "" "griddy.nfl.models.NgsRushingStat"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

NGS rushing statistics for a player.

NgsRushingStatTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsRushingStatTypedDict[NgsRushingStatTypedDict]

              

              click griddy.nfl.models.NgsRushingStatTypedDict href "" "griddy.nfl.models.NgsRushingStatTypedDict"
            

NGS rushing statistics for a player.

Person

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Person[Person]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Person
                


              click griddy.nfl.models.Person href "" "griddy.nfl.models.Person"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

id_ instance-attribute

id_: Annotated[str, Field(alias=id)]

UUUID assigned by the NFL

college_names instance-attribute

college_names: Annotated[
    Optional[List[str]], Field(alias=collegeNames)
]

Colleges the person attended

display_name instance-attribute

display_name: Annotated[str, Field(alias=displayName)]

First and last name

birth_date class-attribute instance-attribute

birth_date: Annotated[
    Optional[str], Field(alias=birthDate)
] = None

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

first_name instance-attribute

first_name: Annotated[str, Field(alias=firstName)]

Person's formal first name

common_first_name instance-attribute

common_first_name: Annotated[
    str, Field(alias=commonFirstName)
]

e.g. Mike instead of Michael

esb_id instance-attribute

esb_id: Annotated[str, Field(alias=esbId)]

Another form of ID tracked by the NFL

gsis_id class-attribute instance-attribute

gsis_id: Annotated[Optional[str], Field(alias=gsisId)] = (
    None
)

Yet another ID

headshot class-attribute instance-attribute

headshot: Optional[str] = None

A URL for the person's headshot used in Media

height instance-attribute

height: int

Person's height rounded to nearest whole inch

internation_exempt instance-attribute

internation_exempt: Annotated[
    bool, Field(alias=internationalExempt)
]

Not sure what this is

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[str],
    Field(alias=jerseyNumber),
    BeforeValidator(int_to_str),
] = None

Number the player wears on the field.

last_name instance-attribute

last_name: Annotated[str, Field(alias=lastName)]

Person's surname

nfl_experience instance-attribute

nfl_experience: Annotated[int, Field(alias=nflExperience)]

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

position instance-attribute

position: str

Player's position on the field

position_group instance-attribute

position_group: Annotated[str, Field(alias=positionGroup)]

Player's position group

status instance-attribute

status: str

Whether the player is active or retired

weight instance-attribute

weight: int

Player's weight rounded to the nearest pound

PersonTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PersonTypedDict[PersonTypedDict]

              

              click griddy.nfl.models.PersonTypedDict href "" "griddy.nfl.models.PersonTypedDict"
            

Attributes

id_ instance-attribute

id_: str

UUUID assigned by the NFL

college_names instance-attribute

college_names: NotRequired[List[str]]

Colleges the person attended

display_name instance-attribute

display_name: str

First and last name

birth_date instance-attribute

birth_date: NotRequired[str]

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

first_name instance-attribute

first_name: str

Person's formal first name

common_first_name instance-attribute

common_first_name: str

e.g. Mike instead of Michael

esb_id instance-attribute

esb_id: str

Another form of ID tracked by the NFL

gsis_id instance-attribute

gsis_id: NotRequired[str]

Yet another ID

headshot instance-attribute

headshot: NotRequired[str]

A URL for the person's headshot used in Media

height instance-attribute

height: int

Person's height rounded to nearest whole inch

internation_exempt instance-attribute

internation_exempt: bool

Not sure what this is

jersey_number instance-attribute

jersey_number: NotRequired[str]

Number the player wears on the field.

last_name instance-attribute

last_name: str

Person's surname

nfl_experience instance-attribute

nfl_experience: int

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

position instance-attribute

position: str

Player's position on the field

position_group instance-attribute

position_group: str

Player's position group

status instance-attribute

status: str

Whether the player is active or retired

weight instance-attribute

weight: int

Player's weight rounded to the nearest pound

TeamOffenseRushStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamOffenseRushStats[TeamOffenseRushStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamOffenseRushStats
                


              click griddy.nfl.models.TeamOffenseRushStats href "" "griddy.nfl.models.TeamOffenseRushStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

gp instance-attribute

gp: int

Games played

total instance-attribute

total: int

Total offensive plays

run instance-attribute

run: int

Count of run plays

run_pct instance-attribute

run_pct: Annotated[float, Field(alias=runPct)]

Percentage of all plays that are runs

rush_td instance-attribute

rush_td: Annotated[int, Field(alias=rushTd)]

Rushing touchdowns

rush_yds instance-attribute

rush_yds: Annotated[int, Field(alias=rushYds)]

Total rushing yards

rush_yds_per_play instance-attribute

rush_yds_per_play: Annotated[float, Field(alias=rushYpp)]

Rush yards per play

rush_epa_total instance-attribute

rush_epa_total: Annotated[float, Field(alias=epaRush)]

Total expected points added by rushing

rush_epa_per_play instance-attribute

rush_epa_per_play: Annotated[float, Field(alias=epaRushPP)]

Expected points added per rushing play

rush_ten_yds_plus instance-attribute

rush_ten_yds_plus: Annotated[int, Field(alias=rush10PYds)]

Rushing plays of 10+ yards

rush_success_pct instance-attribute

rush_success_pct: Annotated[
    float, Field(alias=rushSuccessPct)
]

Team rushing success rate

stuff_pct instance-attribute

stuff_pct: Annotated[float, Field(alias=stuffPct)]

Team rushing stuff rate

ryoe instance-attribute

ryoe: Annotated[float, Field(alias=ryoe)]

Rushing yards over expected

ryoe_att instance-attribute

ryoe_att: Annotated[float, Field(alias=ryoeAtt)]

Rushing yards over expected per rush

ybco_att instance-attribute

ybco_att: Annotated[float, Field(alias=ybcoAtt)]

Rush yards before contact per attempt

yaco_att instance-attribute

yaco_att: Annotated[float, Field(alias=yacoAtt)]

Rush yards after contact per play

in_pct instance-attribute

in_pct: Annotated[float, Field(alias=inPct)]

Inside tackles rush pct

out_pct instance-attribute

out_pct: Annotated[float, Field(alias=outPct)]

Outside tackles rush pct

light_pct instance-attribute

light_pct: Annotated[float, Field(alias=lightPct)]

Opponent light box pct

stacked_pct instance-attribute

stacked_pct: Annotated[float, Field(alias=stackedPct)]

Opponent stacked box pct

rush_ypg instance-attribute

rush_ypg: Annotated[float, Field(alias=rushYpg)]

Team rushing yards per game

team_id instance-attribute

team_id: Annotated[str, Field(alias=teamId)]

Team identifier

TeamOffenseRushStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamOffenseRushStatsTypedDict[TeamOffenseRushStatsTypedDict]

              

              click griddy.nfl.models.TeamOffenseRushStatsTypedDict href "" "griddy.nfl.models.TeamOffenseRushStatsTypedDict"
            

Attributes

gp instance-attribute

gp: int

Games played

total instance-attribute

total: int

Total offensive plays

run instance-attribute

run: int

Count of run plays

run_pct instance-attribute

run_pct: float

Percentage of all plays that are runs

rush_td instance-attribute

rush_td: int

Rushing touchdowns

rush_yds instance-attribute

rush_yds: int

Total rushing yards

rush_yds_per_play instance-attribute

rush_yds_per_play: float

Rush yards per play

rush_epa_total instance-attribute

rush_epa_total: float

Total expected points added by rushing

rush_epa_per_play instance-attribute

rush_epa_per_play: float

Expected points added per rushing play

rush_ten_yds_plus instance-attribute

rush_ten_yds_plus: int

Rushing plays of 10+ yards

rush_success_pct instance-attribute

rush_success_pct: float

Team rushing success rate

stuff_pct instance-attribute

stuff_pct: float

Team rushing stuff rate

ryoe instance-attribute

ryoe: float

Rushing yards over expected

ryoe_att instance-attribute

ryoe_att: float

Rushing yards over expected per rush

ybco_att instance-attribute

ybco_att: float

Rush yards before contact per attempt

yaco_att instance-attribute

yaco_att: float

Rush yards after contact per play

in_pct instance-attribute

in_pct: float

Inside tackles rush pct

out_pct instance-attribute

out_pct: float

Outside tackles rush pct

light_pct instance-attribute

light_pct: float

Opponent light box pct

stacked_pct instance-attribute

stacked_pct: float

Opponent stacked box pct

rush_ypg instance-attribute

rush_ypg: float

Team rushing yards per game

team_id instance-attribute

team_id: str

Team identifier

GetCoachesFilmVideosRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetCoachesFilmVideosRequest[GetCoachesFilmVideosRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetCoachesFilmVideosRequest
                


              click griddy.nfl.models.GetCoachesFilmVideosRequest href "" "griddy.nfl.models.GetCoachesFilmVideosRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[
    List[str],
    Field(alias="gameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Game identifiers (UUID format, supports multiple games)

play_id instance-attribute

play_id: Annotated[
    List[str],
    Field(alias="playId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Play identifiers for specific plays within the games

GetCoachesFilmVideosRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetCoachesFilmVideosRequestTypedDict[GetCoachesFilmVideosRequestTypedDict]

              

              click griddy.nfl.models.GetCoachesFilmVideosRequestTypedDict href "" "griddy.nfl.models.GetCoachesFilmVideosRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: List[str]

Game identifiers (UUID format, supports multiple games)

play_id instance-attribute

play_id: List[str]

Play identifiers for specific plays within the games

GetCombineProfilesRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetCombineProfilesRequest[GetCombineProfilesRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetCombineProfilesRequest
                


              click griddy.nfl.models.GetCombineProfilesRequest href "" "griddy.nfl.models.GetCombineProfilesRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

year instance-attribute

year: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Draft year

GetCombineProfilesRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetCombineProfilesRequestTypedDict[GetCombineProfilesRequestTypedDict]

              

              click griddy.nfl.models.GetCombineProfilesRequestTypedDict href "" "griddy.nfl.models.GetCombineProfilesRequestTypedDict"
            

Attributes

year instance-attribute

year: int

Draft year

limit instance-attribute

limit: int

Maximum number of profiles to fetch

GetCombineRankingsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetCombineRankingsRequest[GetCombineRankingsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetCombineRankingsRequest
                


              click griddy.nfl.models.GetCombineRankingsRequest href "" "griddy.nfl.models.GetCombineRankingsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

rank_attribute instance-attribute

rank_attribute: Annotated[
    Optional[EventFilterEnum],
    Field(alias=rankAttribute),
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Which event to get rankings for

sort_order instance-attribute

sort_order: Annotated[
    Optional[SortOrderEnum],
    Field(alias=sortOrder),
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Sort ascending or descending

year instance-attribute

year: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

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

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = 25

Maximum number of rankings to fetch

GetCombineRankingsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetCombineRankingsRequestTypedDict[GetCombineRankingsRequestTypedDict]

              

              click griddy.nfl.models.GetCombineRankingsRequestTypedDict href "" "griddy.nfl.models.GetCombineRankingsRequestTypedDict"
            

Attributes

rank_attribute instance-attribute

rank_attribute: EventFilterEnum

Which event to get rankings for

sort_order instance-attribute

sort_order: SortOrderEnum

Sort ascending or descending

year instance-attribute

year: Optional[int]

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

limit instance-attribute

limit: int

Maximum number of rankings to fetch

GetDefensiveNearestDefenderStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetDefensiveNearestDefenderStatsBySeasonRequest[GetDefensiveNearestDefenderStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetDefensiveNearestDefenderStatsBySeasonRequest
                


              click griddy.nfl.models.GetDefensiveNearestDefenderStatsBySeasonRequest href "" "griddy.nfl.models.GetDefensiveNearestDefenderStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of players to skip

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[
        GetDefensiveNearestDefenderStatsBySeasonSortKey
    ],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "cov"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_defender class-attribute instance-attribute

qualified_defender: Annotated[
    Optional[bool],
    Field(alias="qualifiedDefender"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified defenders (minimum snap threshold)

GetDefensiveNearestDefenderStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetDefensiveNearestDefenderStatsBySeasonRequestTypedDict[GetDefensiveNearestDefenderStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetDefensiveNearestDefenderStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetDefensiveNearestDefenderStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of players to skip

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[
    GetDefensiveNearestDefenderStatsBySeasonSortKey
]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_defender instance-attribute

qualified_defender: NotRequired[bool]

Filter to only qualified defenders (minimum snap threshold)

GetDefensiveNearestDefenderStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetDefensiveNearestDefenderStatsByWeekRequest[GetDefensiveNearestDefenderStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetDefensiveNearestDefenderStatsByWeekRequest
                


              click griddy.nfl.models.GetDefensiveNearestDefenderStatsByWeekRequest href "" "griddy.nfl.models.GetDefensiveNearestDefenderStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week of the Season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of players to skip

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetDefensiveNearestDefenderStatsByWeekSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "cov"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_defender class-attribute instance-attribute

qualified_defender: Annotated[
    Optional[bool],
    Field(alias="qualifiedDefender"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified defenders (minimum snap threshold)

GetDefensiveNearestDefenderStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetDefensiveNearestDefenderStatsByWeekRequestTypedDict[GetDefensiveNearestDefenderStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetDefensiveNearestDefenderStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetDefensiveNearestDefenderStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week of the Season

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of players to skip

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[
    GetDefensiveNearestDefenderStatsByWeekSortKey
]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_defender instance-attribute

qualified_defender: NotRequired[bool]

Filter to only qualified defenders (minimum snap threshold)

GetDefensiveOverviewStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetDefensiveOverviewStatsBySeasonRequest[GetDefensiveOverviewStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetDefensiveOverviewStatsBySeasonRequest
                


              click griddy.nfl.models.GetDefensiveOverviewStatsBySeasonRequest href "" "griddy.nfl.models.GetDefensiveOverviewStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetDefensiveOverviewStatsBySeasonSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "snap"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_defender class-attribute instance-attribute

qualified_defender: Annotated[
    Optional[bool],
    Field(alias="qualifiedDefender"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified defenders (minimum snap threshold)

team_defense class-attribute instance-attribute

team_defense: Annotated[
    Optional[List[str]],
    Field(alias="teamDefense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team IDs (supports multiple teams)

GetDefensiveOverviewStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetDefensiveOverviewStatsBySeasonRequestTypedDict[GetDefensiveOverviewStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetDefensiveOverviewStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetDefensiveOverviewStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[
    GetDefensiveOverviewStatsBySeasonSortKey
]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_defender instance-attribute

qualified_defender: NotRequired[bool]

Filter to only qualified defenders (minimum snap threshold)

team_defense instance-attribute

team_defense: NotRequired[List[str]]

Filter by specific team IDs (supports multiple teams)

GetDefensiveOverviewStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetDefensiveOverviewStatsByWeekRequest[GetDefensiveOverviewStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetDefensiveOverviewStatsByWeekRequest
                


              click griddy.nfl.models.GetDefensiveOverviewStatsByWeekRequest href "" "griddy.nfl.models.GetDefensiveOverviewStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week identifier

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetDefensiveOverviewStatsByWeekSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "snap"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_defender class-attribute instance-attribute

qualified_defender: Annotated[
    Optional[bool],
    Field(alias="qualifiedDefender"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified defenders (minimum snap threshold)

team_defense class-attribute instance-attribute

team_defense: Annotated[
    Optional[List[str]],
    Field(alias="teamDefense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team IDs (supports multiple teams)

GetDefensiveOverviewStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetDefensiveOverviewStatsByWeekRequestTypedDict[GetDefensiveOverviewStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetDefensiveOverviewStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetDefensiveOverviewStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week identifier

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[
    GetDefensiveOverviewStatsByWeekSortKey
]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_defender instance-attribute

qualified_defender: NotRequired[bool]

Filter to only qualified defenders (minimum snap threshold)

team_defense instance-attribute

team_defense: NotRequired[List[str]]

Filter by specific team IDs (supports multiple teams)

GetDefensivePassRushStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetDefensivePassRushStatsBySeasonRequest[GetDefensivePassRushStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetDefensivePassRushStatsBySeasonRequest
                


              click griddy.nfl.models.GetDefensivePassRushStatsBySeasonRequest href "" "griddy.nfl.models.GetDefensivePassRushStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetDefensivePassRushStatsBySeasonSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "pr"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_defender class-attribute instance-attribute

qualified_defender: Annotated[
    Optional[bool],
    Field(alias="qualifiedDefender"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified defenders (minimum snap threshold)

GetDefensivePassRushStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetDefensivePassRushStatsBySeasonRequestTypedDict[GetDefensivePassRushStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetDefensivePassRushStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetDefensivePassRushStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[
    GetDefensivePassRushStatsBySeasonSortKey
]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_defender instance-attribute

qualified_defender: NotRequired[bool]

Filter to only qualified defenders (minimum snap threshold)

GetDefensivePassRushStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetDefensivePassRushStatsByWeekRequest[GetDefensivePassRushStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetDefensivePassRushStatsByWeekRequest
                


              click griddy.nfl.models.GetDefensivePassRushStatsByWeekRequest href "" "griddy.nfl.models.GetDefensivePassRushStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week identifier

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetDefensivePassRushStatsByWeekSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "pr"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_defender class-attribute instance-attribute

qualified_defender: Annotated[
    Optional[bool],
    Field(alias="qualifiedDefender"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified defenders (minimum snap threshold)

GetDefensivePassRushStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetDefensivePassRushStatsByWeekRequestTypedDict[GetDefensivePassRushStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetDefensivePassRushStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetDefensivePassRushStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week identifier

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[
    GetDefensivePassRushStatsByWeekSortKey
]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_defender instance-attribute

qualified_defender: NotRequired[bool]

Filter to only qualified defenders (minimum snap threshold)

GetDefensiveStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetDefensiveStatsBySeasonRequestTypedDict[GetDefensiveStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetDefensiveStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetDefensiveStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetDefensiveStatsBySeasonSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_defender instance-attribute

qualified_defender: NotRequired[bool]

Filter to only qualified defenders (minimum snap threshold)

team_defense instance-attribute

team_defense: NotRequired[List[str]]

Filter by specific team IDs (supports multiple teams)

GetDraftInfoRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetDraftInfoRequest[GetDraftInfoRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetDraftInfoRequest
                


              click griddy.nfl.models.GetDraftInfoRequest href "" "griddy.nfl.models.GetDraftInfoRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

year instance-attribute

year: Annotated[
    int,
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Draft year

round class-attribute instance-attribute

round: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by round

team_id class-attribute instance-attribute

team_id: Annotated[
    Optional[str],
    Field(alias="teamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by team

GetDraftInfoRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetDraftInfoRequestTypedDict[GetDraftInfoRequestTypedDict]

              

              click griddy.nfl.models.GetDraftInfoRequestTypedDict href "" "griddy.nfl.models.GetDraftInfoRequestTypedDict"
            

Attributes

year instance-attribute

year: int

Draft year

round instance-attribute

round: NotRequired[int]

Filter by round

team_id instance-attribute

team_id: NotRequired[str]

Filter by team

GetDraftPicksReportRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetDraftPicksReportRequest[GetDraftPicksReportRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetDraftPicksReportRequest
                


              click griddy.nfl.models.GetDraftPicksReportRequest href "" "griddy.nfl.models.GetDraftPicksReportRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

year instance-attribute

year: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Draft year

GetDraftPicksReportRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetDraftPicksReportRequestTypedDict[GetDraftPicksReportRequestTypedDict]

              

              click griddy.nfl.models.GetDraftPicksReportRequestTypedDict href "" "griddy.nfl.models.GetDraftPicksReportRequestTypedDict"
            

Attributes

year instance-attribute

year: int

Draft year

limit instance-attribute

limit: NotRequired[int]

Maximum picks to return

GetFantasyStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetFantasyStatsBySeasonRequest[GetFantasyStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetFantasyStatsBySeasonRequest
                


              click griddy.nfl.models.GetFantasyStatsBySeasonRequest href "" "griddy.nfl.models.GetFantasyStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetFantasyStatsBySeasonSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "fpStd"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[List[GetFantasyStatsBySeasonPositionGroup]],
    Field(alias="positionGroup"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by position groups (supports multiple positions)

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[str],
    Field(alias="teamOffense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific offensive team ID

team_defense class-attribute instance-attribute

team_defense: Annotated[
    Optional[str],
    Field(alias="teamDefense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific defensive team ID (opponent analysis)

min_offensive_snaps class-attribute instance-attribute

min_offensive_snaps: Annotated[
    Optional[int],
    Field(alias="minOffensiveSnaps"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Minimum offensive snaps threshold for inclusion

last_n_weeks class-attribute instance-attribute

last_n_weeks: Annotated[
    Optional[int],
    Field(alias="lastNWeeks"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Number of recent weeks to analyze (rolling window)

GetFantasyStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetFantasyStatsBySeasonRequestTypedDict[GetFantasyStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetFantasyStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetFantasyStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetFantasyStatsBySeasonSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

position_group instance-attribute

position_group: NotRequired[
    List[GetFantasyStatsBySeasonPositionGroup]
]

Filter by position groups (supports multiple positions)

team_offense instance-attribute

team_offense: NotRequired[str]

Filter by specific offensive team ID

team_defense instance-attribute

team_defense: NotRequired[str]

Filter by specific defensive team ID (opponent analysis)

min_offensive_snaps instance-attribute

min_offensive_snaps: NotRequired[int]

Minimum offensive snaps threshold for inclusion

last_n_weeks instance-attribute

last_n_weeks: NotRequired[int]

Number of recent weeks to analyze (rolling window)

GetFilmroomPlaysRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetFilmroomPlaysRequest[GetFilmroomPlaysRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetFilmroomPlaysRequest
                


              click griddy.nfl.models.GetFilmroomPlaysRequest href "" "griddy.nfl.models.GetFilmroomPlaysRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id class-attribute instance-attribute

game_id: Annotated[
    Optional[List[str]],
    Field(alias="gameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific game IDs (supports multiple values)

week_slug class-attribute instance-attribute

week_slug: Annotated[
    Optional[List[WeekSlugEnum]],
    Field(alias="weekSlug"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by week identifier (supports multiple values)

season class-attribute instance-attribute

season: Annotated[
    Optional[List[int]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by season year (supports multiple values)

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[List[SeasonTypeEnum]],
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by season type

nfl_id class-attribute instance-attribute

nfl_id: Annotated[
    Optional[List[str]],
    Field(alias="nflId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by player NFL ID

quarter class-attribute instance-attribute

quarter: Annotated[
    Optional[List[int]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by quarter

down class-attribute instance-attribute

down: Annotated[
    Optional[List[int]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by down

yards_to_go_type class-attribute instance-attribute

yards_to_go_type: Annotated[
    Optional[List[YardsToGoType]],
    Field(alias="yardsToGoType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by yards to go category

touchdown class-attribute instance-attribute

touchdown: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

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

rush10_plus_yards class-attribute instance-attribute

rush10_plus_yards: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="rush10PlusYards"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for rushing plays of 10+ yards

fumble_lost class-attribute instance-attribute

fumble_lost: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="fumbleLost"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for plays with fumbles lost

fumble class-attribute instance-attribute

fumble: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for plays with fumbles

qb_alignment class-attribute instance-attribute

qb_alignment: Annotated[
    Optional[List[QbAlignment]],
    Field(alias="qbAlignment"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by quarterback alignment

redzone class-attribute instance-attribute

redzone: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for red zone plays

goal_to_go class-attribute instance-attribute

goal_to_go: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="goalToGo"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for goal-to-go situations

pass_play class-attribute instance-attribute

pass_play: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="passPlay"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for passing plays

run_play class-attribute instance-attribute

run_play: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="runPlay"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for running plays

play_type class-attribute instance-attribute

play_type: Annotated[
    Optional[List[PlayTypeEnum]],
    Field(alias="playType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific play types

attempt class-attribute instance-attribute

attempt: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for passing attempts

completion class-attribute instance-attribute

completion: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for completed passes

interception class-attribute instance-attribute

interception: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for interceptions

reception class-attribute instance-attribute

reception: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for receptions

sack class-attribute instance-attribute

sack: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for sacks

rec_motion class-attribute instance-attribute

rec_motion: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by receiver motion

target_location class-attribute instance-attribute

target_location: Annotated[
    Optional[List[TargetLocation]],
    Field(alias="targetLocation"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by target location on field

air_yard_type class-attribute instance-attribute

air_yard_type: Annotated[
    Optional[List[AirYardType]],
    Field(alias="airYardType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by air yards category

dropback_time_type class-attribute instance-attribute

dropback_time_type: Annotated[
    Optional[List[DropbackTimeType]],
    Field(alias="dropbackTimeType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by dropback time

pressure class-attribute instance-attribute

pressure: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by quarterback pressure

blitz class-attribute instance-attribute

blitz: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by defensive blitz

play_action class-attribute instance-attribute

play_action: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="playAction"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by play action usage

rush_direction class-attribute instance-attribute

rush_direction: Annotated[
    Optional[List[RushDirection]],
    Field(alias="rushDirection"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by rush direction

run_stuff class-attribute instance-attribute

run_stuff: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="runStuff"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for stuffed runs

receiver_alignment class-attribute instance-attribute

receiver_alignment: Annotated[
    Optional[List[ReceiverAlignment]],
    Field(alias="receiverAlignment"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by receiver alignment

separation_type class-attribute instance-attribute

separation_type: Annotated[
    Optional[List[SeparationType]],
    Field(alias="separationType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by receiver separation

personnel class-attribute instance-attribute

personnel: Annotated[
    Optional[List[Personnel]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by defensive personnel package

defenders_in_the_box_type class-attribute instance-attribute

defenders_in_the_box_type: Annotated[
    Optional[List[DefendersInTheBoxType]],
    Field(alias="defendersInTheBoxType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by defenders in the box

def_coverage_type class-attribute instance-attribute

def_coverage_type: Annotated[
    Optional[List[DefCoverageType]],
    Field(alias="def_coverageType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by defensive coverage type

GetFilmroomPlaysRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetFilmroomPlaysRequestTypedDict[GetFilmroomPlaysRequestTypedDict]

              

              click griddy.nfl.models.GetFilmroomPlaysRequestTypedDict href "" "griddy.nfl.models.GetFilmroomPlaysRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: NotRequired[List[str]]

Filter by specific game IDs (supports multiple values)

week_slug instance-attribute

week_slug: NotRequired[List[WeekSlugEnum]]

Filter by week identifier (supports multiple values)

season instance-attribute

season: NotRequired[List[int]]

Filter by season year (supports multiple values)

season_type instance-attribute

season_type: NotRequired[List[SeasonTypeEnum]]

Filter by season type

nfl_id instance-attribute

nfl_id: NotRequired[List[str]]

Filter by player NFL ID

quarter instance-attribute

quarter: NotRequired[List[int]]

Filter by quarter

down instance-attribute

down: NotRequired[List[int]]

Filter by down

yards_to_go_type instance-attribute

yards_to_go_type: NotRequired[List[YardsToGoType]]

Filter by yards to go category

touchdown instance-attribute

touchdown: NotRequired[List[BinaryFlagEnum]]

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

rush10_plus_yards instance-attribute

rush10_plus_yards: NotRequired[List[BinaryFlagEnum]]

Filter for rushing plays of 10+ yards

fumble_lost instance-attribute

fumble_lost: NotRequired[List[BinaryFlagEnum]]

Filter for plays with fumbles lost

fumble instance-attribute

fumble: NotRequired[List[BinaryFlagEnum]]

Filter for plays with fumbles

qb_alignment instance-attribute

qb_alignment: NotRequired[List[QbAlignment]]

Filter by quarterback alignment

redzone instance-attribute

redzone: NotRequired[List[BinaryFlagEnum]]

Filter for red zone plays

goal_to_go instance-attribute

goal_to_go: NotRequired[List[BinaryFlagEnum]]

Filter for goal-to-go situations

pass_play instance-attribute

pass_play: NotRequired[List[BinaryFlagEnum]]

Filter for passing plays

run_play instance-attribute

run_play: NotRequired[List[BinaryFlagEnum]]

Filter for running plays

play_type instance-attribute

play_type: NotRequired[List[PlayTypeEnum]]

Filter by specific play types

attempt instance-attribute

attempt: NotRequired[List[BinaryFlagEnum]]

Filter for passing attempts

completion instance-attribute

completion: NotRequired[List[BinaryFlagEnum]]

Filter for completed passes

interception instance-attribute

interception: NotRequired[List[BinaryFlagEnum]]

Filter for interceptions

reception instance-attribute

reception: NotRequired[List[BinaryFlagEnum]]

Filter for receptions

sack instance-attribute

sack: NotRequired[List[BinaryFlagEnum]]

Filter for sacks

rec_motion instance-attribute

rec_motion: NotRequired[List[BinaryFlagEnum]]

Filter by receiver motion

target_location instance-attribute

target_location: NotRequired[List[TargetLocation]]

Filter by target location on field

air_yard_type instance-attribute

air_yard_type: NotRequired[List[AirYardType]]

Filter by air yards category

dropback_time_type instance-attribute

dropback_time_type: NotRequired[List[DropbackTimeType]]

Filter by dropback time

pressure instance-attribute

pressure: NotRequired[List[BinaryFlagEnum]]

Filter by quarterback pressure

blitz instance-attribute

blitz: NotRequired[List[BinaryFlagEnum]]

Filter by defensive blitz

play_action instance-attribute

play_action: NotRequired[List[BinaryFlagEnum]]

Filter by play action usage

rush_direction instance-attribute

rush_direction: NotRequired[List[RushDirection]]

Filter by rush direction

run_stuff instance-attribute

run_stuff: NotRequired[List[BinaryFlagEnum]]

Filter for stuffed runs

receiver_alignment instance-attribute

receiver_alignment: NotRequired[List[ReceiverAlignment]]

Filter by receiver alignment

separation_type instance-attribute

separation_type: NotRequired[List[SeparationType]]

Filter by receiver separation

personnel instance-attribute

personnel: NotRequired[List[Personnel]]

Filter by defensive personnel package

defenders_in_the_box_type instance-attribute

defenders_in_the_box_type: NotRequired[
    List[DefendersInTheBoxType]
]

Filter by defenders in the box

def_coverage_type instance-attribute

def_coverage_type: NotRequired[List[DefCoverageType]]

Filter by defensive coverage type

GetFootballBoxScoreRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetFootballBoxScoreRequest[GetFootballBoxScoreRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetFootballBoxScoreRequest
                


              click griddy.nfl.models.GetFootballBoxScoreRequest href "" "griddy.nfl.models.GetFootballBoxScoreRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[
    str,
    Field(alias="gameId"),
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Game identifier (UUID)

GetFootballBoxScoreRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetFootballBoxScoreRequestTypedDict[GetFootballBoxScoreRequestTypedDict]

              

              click griddy.nfl.models.GetFootballBoxScoreRequestTypedDict href "" "griddy.nfl.models.GetFootballBoxScoreRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: str

Game identifier (UUID)

GetFootballGamesRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetFootballGamesRequest[GetFootballGamesRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetFootballGamesRequest
                


              click griddy.nfl.models.GetFootballGamesRequest href "" "griddy.nfl.models.GetFootballGamesRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Type of season

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Week number

with_external_ids class-attribute instance-attribute

with_external_ids: Annotated[
    Optional[bool],
    Field(alias="withExternalIds"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Include external IDs in response

GetFootballGamesRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetFootballGamesRequestTypedDict[GetFootballGamesRequestTypedDict]

              

              click griddy.nfl.models.GetFootballGamesRequestTypedDict href "" "griddy.nfl.models.GetFootballGamesRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: int

Week number

with_external_ids instance-attribute

with_external_ids: NotRequired[bool]

Include external IDs in response

GetFootballRostersRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetFootballRostersRequest[GetFootballRostersRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetFootballRostersRequest
                


              click griddy.nfl.models.GetFootballRostersRequest href "" "griddy.nfl.models.GetFootballRostersRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Maximum number of teams to fetch

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Season year

GetFootballRostersRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetFootballRostersRequestTypedDict[GetFootballRostersRequestTypedDict]

              

              click griddy.nfl.models.GetFootballRostersRequestTypedDict href "" "griddy.nfl.models.GetFootballRostersRequestTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of teams to fetch

season instance-attribute

season: int

Which season to fetch the teams for

GetFootballTeamsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetFootballTeamsRequest[GetFootballTeamsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetFootballTeamsRequest
                


              click griddy.nfl.models.GetFootballTeamsRequest href "" "griddy.nfl.models.GetFootballTeamsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Maximum number of teams to fetch

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Season year

GetFootballTeamsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetFootballTeamsRequestTypedDict[GetFootballTeamsRequestTypedDict]

              

              click griddy.nfl.models.GetFootballTeamsRequestTypedDict href "" "griddy.nfl.models.GetFootballTeamsRequestTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of teams to fetch

season instance-attribute

season: int

Which season to fetch the teams for

GetGamecenterRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetGamecenterRequest[GetGamecenterRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetGamecenterRequest
                


              click griddy.nfl.models.GetGamecenterRequest href "" "griddy.nfl.models.GetGamecenterRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[
    str,
    Field(alias="gameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Game identifier

GetGamecenterRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetGamecenterRequestTypedDict[GetGamecenterRequestTypedDict]

              

              click griddy.nfl.models.GetGamecenterRequestTypedDict href "" "griddy.nfl.models.GetGamecenterRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: str

Game identifier

GetGameInsightsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetGameInsightsRequest[GetGameInsightsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetGameInsightsRequest
                


              click griddy.nfl.models.GetGameInsightsRequest href "" "griddy.nfl.models.GetGameInsightsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

fapi_game_id instance-attribute

fapi_game_id: Annotated[
    str,
    Field(alias="fapiGameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

FAPI Game identifier (UUID)

away_team_id instance-attribute

away_team_id: Annotated[
    str,
    Field(alias="awayTeamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Away team identifier

home_team_id instance-attribute

home_team_id: Annotated[
    str,
    Field(alias="homeTeamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Home team identifier

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Maximum number of insights to return

tags class-attribute instance-attribute

tags: Annotated[
    Optional[str],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Comma-separated list of tags to filter by

exclude_tags class-attribute instance-attribute

exclude_tags: Annotated[
    Optional[str],
    Field(alias="excludeTags"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Comma-separated list of tags to exclude

GetGameInsightsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetGameInsightsRequestTypedDict[GetGameInsightsRequestTypedDict]

              

              click griddy.nfl.models.GetGameInsightsRequestTypedDict href "" "griddy.nfl.models.GetGameInsightsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

fapi_game_id instance-attribute

fapi_game_id: str

FAPI Game identifier (UUID)

away_team_id instance-attribute

away_team_id: str

Away team identifier

home_team_id instance-attribute

home_team_id: str

Home team identifier

limit instance-attribute

limit: NotRequired[int]

Maximum number of insights to return

tags instance-attribute

tags: NotRequired[str]

Comma-separated list of tags to filter by

exclude_tags instance-attribute

exclude_tags: NotRequired[str]

Comma-separated list of tags to exclude

GetGameMatchupRankingsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetGameMatchupRankingsRequest[GetGameMatchupRankingsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetGameMatchupRankingsRequest
                


              click griddy.nfl.models.GetGameMatchupRankingsRequest href "" "griddy.nfl.models.GetGameMatchupRankingsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[
    str,
    Field(alias="gameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Game identifier (10-digit format YYYYMMDDNN)

GetGameMatchupRankingsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetGameMatchupRankingsRequestTypedDict[GetGameMatchupRankingsRequestTypedDict]

              

              click griddy.nfl.models.GetGameMatchupRankingsRequestTypedDict href "" "griddy.nfl.models.GetGameMatchupRankingsRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: str

Game identifier (10-digit format YYYYMMDDNN)

GetGamePreviewRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetGamePreviewRequest[GetGamePreviewRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetGamePreviewRequest
                


              click griddy.nfl.models.GetGamePreviewRequest href "" "griddy.nfl.models.GetGamePreviewRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

visitor_display_name instance-attribute

visitor_display_name: Annotated[
    str,
    Field(alias="visitorDisplayName"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Visiting team display name

home_display_name instance-attribute

home_display_name: Annotated[
    str,
    Field(alias="homeDisplayName"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Home team display name

GetGamePreviewRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetGamePreviewRequestTypedDict[GetGamePreviewRequestTypedDict]

              

              click griddy.nfl.models.GetGamePreviewRequestTypedDict href "" "griddy.nfl.models.GetGamePreviewRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: int

Week number

visitor_display_name instance-attribute

visitor_display_name: str

Visiting team display name

home_display_name instance-attribute

home_display_name: str

Home team display name

GetGameTeamRankingsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetGameTeamRankingsRequest[GetGameTeamRankingsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetGameTeamRankingsRequest
                


              click griddy.nfl.models.GetGameTeamRankingsRequest href "" "griddy.nfl.models.GetGameTeamRankingsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

away_team_id instance-attribute

away_team_id: Annotated[
    str,
    Field(alias="awayTeamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Away team UUID

home_team_id instance-attribute

home_team_id: Annotated[
    str,
    Field(alias="homeTeamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Home team UUID

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

GetGameTeamRankingsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetGameTeamRankingsRequestTypedDict[GetGameTeamRankingsRequestTypedDict]

              

              click griddy.nfl.models.GetGameTeamRankingsRequestTypedDict href "" "griddy.nfl.models.GetGameTeamRankingsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

away_team_id instance-attribute

away_team_id: str

Away team UUID

home_team_id instance-attribute

home_team_id: str

Home team UUID

week instance-attribute

week: int

Week number

GetInjuryReportsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetInjuryReportsRequest[GetInjuryReportsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetInjuryReportsRequest
                


              click griddy.nfl.models.GetInjuryReportsRequest href "" "griddy.nfl.models.GetInjuryReportsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

team_id class-attribute instance-attribute

team_id: Annotated[
    Optional[str],
    Field(alias="teamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team

GetInjuryReportsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetInjuryReportsRequestTypedDict[GetInjuryReportsRequestTypedDict]

              

              click griddy.nfl.models.GetInjuryReportsRequestTypedDict href "" "griddy.nfl.models.GetInjuryReportsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

week instance-attribute

week: int

Week number

team_id instance-attribute

team_id: NotRequired[str]

Filter by specific team

GetLiveGameScoresRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetLiveGameScoresRequest[GetLiveGameScoresRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetLiveGameScoresRequest
                


              click griddy.nfl.models.GetLiveGameScoresRequest href "" "griddy.nfl.models.GetLiveGameScoresRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

GetLiveGameScoresRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetLiveGameScoresRequestTypedDict[GetLiveGameScoresRequestTypedDict]

              

              click griddy.nfl.models.GetLiveGameScoresRequestTypedDict href "" "griddy.nfl.models.GetLiveGameScoresRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: int

Week number

GetLiveGameStatsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetLiveGameStatsRequest[GetLiveGameStatsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetLiveGameStatsRequest
                


              click griddy.nfl.models.GetLiveGameStatsRequest href "" "griddy.nfl.models.GetLiveGameStatsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

GetLiveGameStatsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetLiveGameStatsRequestTypedDict[GetLiveGameStatsRequestTypedDict]

              

              click griddy.nfl.models.GetLiveGameStatsRequestTypedDict href "" "griddy.nfl.models.GetLiveGameStatsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: int

Week number

GetMultipleRankingsAllTeamsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetMultipleRankingsAllTeamsRequest[GetMultipleRankingsAllTeamsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetMultipleRankingsAllTeamsRequest
                


              click griddy.nfl.models.GetMultipleRankingsAllTeamsRequest href "" "griddy.nfl.models.GetMultipleRankingsAllTeamsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

stat0 instance-attribute

stat0: Annotated[
    str,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

First statistical category

stat1 class-attribute instance-attribute

stat1: Annotated[
    Optional[str],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Second statistical category

stat2 class-attribute instance-attribute

stat2: Annotated[
    Optional[str],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Third statistical category

stat3 class-attribute instance-attribute

stat3: Annotated[
    Optional[str],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Fourth statistical category

stat4 class-attribute instance-attribute

stat4: Annotated[
    Optional[str],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Fifth statistical category

GetMultipleRankingsAllTeamsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetMultipleRankingsAllTeamsRequestTypedDict[GetMultipleRankingsAllTeamsRequestTypedDict]

              

              click griddy.nfl.models.GetMultipleRankingsAllTeamsRequestTypedDict href "" "griddy.nfl.models.GetMultipleRankingsAllTeamsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

stat0 instance-attribute

stat0: str

First statistical category

stat1 instance-attribute

stat1: NotRequired[str]

Second statistical category

stat2 instance-attribute

stat2: NotRequired[str]

Third statistical category

stat3 instance-attribute

stat3: NotRequired[str]

Fourth statistical category

stat4 instance-attribute

stat4: NotRequired[str]

Fifth statistical category

GetNgsChartsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsChartsRequest[GetNgsChartsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsChartsRequest
                


              click griddy.nfl.models.GetNgsChartsRequest href "" "griddy.nfl.models.GetNgsChartsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS charts.

GetNgsChartsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsChartsRequestTypedDict[GetNgsChartsRequestTypedDict]

              

              click griddy.nfl.models.GetNgsChartsRequestTypedDict href "" "griddy.nfl.models.GetNgsChartsRequestTypedDict"
            

Request parameters for getting NGS charts.

GetNgsHighlightsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsHighlightsRequest[GetNgsHighlightsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsHighlightsRequest
                


              click griddy.nfl.models.GetNgsHighlightsRequest href "" "griddy.nfl.models.GetNgsHighlightsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS highlights.

GetNgsHighlightsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsHighlightsRequestTypedDict[GetNgsHighlightsRequestTypedDict]

              

              click griddy.nfl.models.GetNgsHighlightsRequestTypedDict href "" "griddy.nfl.models.GetNgsHighlightsRequestTypedDict"
            

Request parameters for getting NGS highlights.

GetNgsCurrentScheduleRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsCurrentScheduleRequest[GetNgsCurrentScheduleRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsCurrentScheduleRequest
                


              click griddy.nfl.models.GetNgsCurrentScheduleRequest href "" "griddy.nfl.models.GetNgsCurrentScheduleRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting the current NGS schedule.

This endpoint takes no parameters.

GetNgsCurrentScheduleRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsCurrentScheduleRequestTypedDict[GetNgsCurrentScheduleRequestTypedDict]

              

              click griddy.nfl.models.GetNgsCurrentScheduleRequestTypedDict href "" "griddy.nfl.models.GetNgsCurrentScheduleRequestTypedDict"
            

Request parameters for getting the current NGS schedule.

This endpoint takes no parameters.

GetNgsGameOverviewRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsGameOverviewRequest[GetNgsGameOverviewRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsGameOverviewRequest
                


              click griddy.nfl.models.GetNgsGameOverviewRequest href "" "griddy.nfl.models.GetNgsGameOverviewRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS game overview.

Attributes

game_id instance-attribute

game_id: Annotated[
    int,
    Field(alias="gameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Unique game identifier (e.g., 2025112700)

GetNgsGameOverviewRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsGameOverviewRequestTypedDict[GetNgsGameOverviewRequestTypedDict]

              

              click griddy.nfl.models.GetNgsGameOverviewRequestTypedDict href "" "griddy.nfl.models.GetNgsGameOverviewRequestTypedDict"
            

Request parameters for getting NGS game overview.

Attributes

game_id instance-attribute

game_id: int

Unique game identifier (e.g., 2025112700)

GetNgsLeadersRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsLeadersRequest[GetNgsLeadersRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsLeadersRequest
                


              click griddy.nfl.models.GetNgsLeadersRequest href "" "griddy.nfl.models.GetNgsLeadersRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

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

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year (e.g., 2025)

season_type instance-attribute

season_type: Annotated[
    str,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season type (REG, PRE, POST)

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Number of results to return (default: 20)

week class-attribute instance-attribute

week: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Optional week filter

GetNgsLeadersRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsLeadersRequestTypedDict[GetNgsLeadersRequestTypedDict]

              

              click griddy.nfl.models.GetNgsLeadersRequestTypedDict href "" "griddy.nfl.models.GetNgsLeadersRequestTypedDict"
            

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

Attributes

season instance-attribute

season: int

Season year (e.g., 2025)

season_type instance-attribute

season_type: str

Season type (REG, PRE, POST)

limit instance-attribute

limit: NotRequired[int]

Number of results to return (default: 20)

week instance-attribute

week: NotRequired[int]

Optional week filter

GetNgsSeasonLeadersRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsSeasonLeadersRequest[GetNgsSeasonLeadersRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsSeasonLeadersRequest
                


              click griddy.nfl.models.GetNgsSeasonLeadersRequest href "" "griddy.nfl.models.GetNgsSeasonLeadersRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

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

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year (e.g., 2025)

season_type instance-attribute

season_type: Annotated[
    str,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season type (REG, PRE, POST)

GetNgsSeasonLeadersRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsSeasonLeadersRequestTypedDict[GetNgsSeasonLeadersRequestTypedDict]

              

              click griddy.nfl.models.GetNgsSeasonLeadersRequestTypedDict href "" "griddy.nfl.models.GetNgsSeasonLeadersRequestTypedDict"
            

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

Attributes

season instance-attribute

season: int

Season year (e.g., 2025)

season_type instance-attribute

season_type: str

Season type (REG, PRE, POST)

GetNgsLiveScoresRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsLiveScoresRequest[GetNgsLiveScoresRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsLiveScoresRequest
                


              click griddy.nfl.models.GetNgsLiveScoresRequest href "" "griddy.nfl.models.GetNgsLiveScoresRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS live scores.

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year (e.g., 2025)

season_type instance-attribute

season_type: Annotated[
    str,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season type (REG, PRE, POST)

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

GetNgsLiveScoresRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsLiveScoresRequestTypedDict[GetNgsLiveScoresRequestTypedDict]

              

              click griddy.nfl.models.GetNgsLiveScoresRequestTypedDict href "" "griddy.nfl.models.GetNgsLiveScoresRequestTypedDict"
            

Request parameters for getting NGS live scores.

Attributes

season instance-attribute

season: int

Season year (e.g., 2025)

season_type instance-attribute

season_type: str

Season type (REG, PRE, POST)

week instance-attribute

week: int

Week number

GetNgsArticlesRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsArticlesRequest[GetNgsArticlesRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsArticlesRequest
                


              click griddy.nfl.models.GetNgsArticlesRequest href "" "griddy.nfl.models.GetNgsArticlesRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS articles.

GetNgsArticlesRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsArticlesRequestTypedDict[GetNgsArticlesRequestTypedDict]

              

              click griddy.nfl.models.GetNgsArticlesRequestTypedDict href "" "griddy.nfl.models.GetNgsArticlesRequestTypedDict"
            

Request parameters for getting NGS articles.

GetNgsMixedContentRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsMixedContentRequest[GetNgsMixedContentRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsMixedContentRequest
                


              click griddy.nfl.models.GetNgsMixedContentRequest href "" "griddy.nfl.models.GetNgsMixedContentRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS mixed content.

GetNgsMixedContentRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsMixedContentRequestTypedDict[GetNgsMixedContentRequestTypedDict]

              

              click griddy.nfl.models.GetNgsMixedContentRequestTypedDict href "" "griddy.nfl.models.GetNgsMixedContentRequestTypedDict"
            

Request parameters for getting NGS mixed content.

GetNgsVideoClipsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsVideoClipsRequest[GetNgsVideoClipsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsVideoClipsRequest
                


              click griddy.nfl.models.GetNgsVideoClipsRequest href "" "griddy.nfl.models.GetNgsVideoClipsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS video clips.

GetNgsVideoClipsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsVideoClipsRequestTypedDict[GetNgsVideoClipsRequestTypedDict]

              

              click griddy.nfl.models.GetNgsVideoClipsRequestTypedDict href "" "griddy.nfl.models.GetNgsVideoClipsRequestTypedDict"
            

Request parameters for getting NGS video clips.

GetNgsPassingStatsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsPassingStatsRequest[GetNgsPassingStatsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsPassingStatsRequest
                


              click griddy.nfl.models.GetNgsPassingStatsRequest href "" "griddy.nfl.models.GetNgsPassingStatsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS passing stats.

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year (e.g., 2025)

season_type instance-attribute

season_type: Annotated[
    str,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season type (REG, PRE, POST)

week class-attribute instance-attribute

week: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Optional week filter

GetNgsPassingStatsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsPassingStatsRequestTypedDict[GetNgsPassingStatsRequestTypedDict]

              

              click griddy.nfl.models.GetNgsPassingStatsRequestTypedDict href "" "griddy.nfl.models.GetNgsPassingStatsRequestTypedDict"
            

Request parameters for getting NGS passing stats.

Attributes

season instance-attribute

season: int

Season year (e.g., 2025)

season_type instance-attribute

season_type: str

Season type (REG, PRE, POST)

week instance-attribute

week: NotRequired[int]

Optional week filter

GetNgsReceivingStatsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsReceivingStatsRequest[GetNgsReceivingStatsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsReceivingStatsRequest
                


              click griddy.nfl.models.GetNgsReceivingStatsRequest href "" "griddy.nfl.models.GetNgsReceivingStatsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS receiving stats.

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year (e.g., 2025)

season_type instance-attribute

season_type: Annotated[
    str,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season type (REG, PRE, POST)

week class-attribute instance-attribute

week: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Optional week filter

GetNgsReceivingStatsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsReceivingStatsRequestTypedDict[GetNgsReceivingStatsRequestTypedDict]

              

              click griddy.nfl.models.GetNgsReceivingStatsRequestTypedDict href "" "griddy.nfl.models.GetNgsReceivingStatsRequestTypedDict"
            

Request parameters for getting NGS receiving stats.

Attributes

season instance-attribute

season: int

Season year (e.g., 2025)

season_type instance-attribute

season_type: str

Season type (REG, PRE, POST)

week instance-attribute

week: NotRequired[int]

Optional week filter

GetNgsRushingStatsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsRushingStatsRequest[GetNgsRushingStatsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsRushingStatsRequest
                


              click griddy.nfl.models.GetNgsRushingStatsRequest href "" "griddy.nfl.models.GetNgsRushingStatsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS rushing stats.

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year (e.g., 2025)

season_type instance-attribute

season_type: Annotated[
    str,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season type (REG, PRE, POST)

week class-attribute instance-attribute

week: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Optional week filter

GetNgsRushingStatsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsRushingStatsRequestTypedDict[GetNgsRushingStatsRequestTypedDict]

              

              click griddy.nfl.models.GetNgsRushingStatsRequestTypedDict href "" "griddy.nfl.models.GetNgsRushingStatsRequestTypedDict"
            

Request parameters for getting NGS rushing stats.

Attributes

season instance-attribute

season: int

Season year (e.g., 2025)

season_type instance-attribute

season_type: str

Season type (REG, PRE, POST)

week instance-attribute

week: NotRequired[int]

Optional week filter

GetNgsScheduleRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsScheduleRequest[GetNgsScheduleRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsScheduleRequest
                


              click griddy.nfl.models.GetNgsScheduleRequest href "" "griddy.nfl.models.GetNgsScheduleRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting the full NGS schedule.

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year (e.g., 2025)

GetNgsScheduleRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsScheduleRequestTypedDict[GetNgsScheduleRequestTypedDict]

              

              click griddy.nfl.models.GetNgsScheduleRequestTypedDict href "" "griddy.nfl.models.GetNgsScheduleRequestTypedDict"
            

Request parameters for getting the full NGS schedule.

Attributes

season instance-attribute

season: int

Season year (e.g., 2025)

GetNgsTeamsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetNgsTeamsRequest[GetNgsTeamsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetNgsTeamsRequest
                


              click griddy.nfl.models.GetNgsTeamsRequest href "" "griddy.nfl.models.GetNgsTeamsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Request model for getting NGS teams.

This endpoint takes no parameters.

GetNgsTeamsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetNgsTeamsRequestTypedDict[GetNgsTeamsRequestTypedDict]

              

              click griddy.nfl.models.GetNgsTeamsRequestTypedDict href "" "griddy.nfl.models.GetNgsTeamsRequestTypedDict"
            

Request parameters for getting NGS teams.

This endpoint takes no parameters.

GetPlayByPlayRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayByPlayRequest[GetPlayByPlayRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayByPlayRequest
                


              click griddy.nfl.models.GetPlayByPlayRequest href "" "griddy.nfl.models.GetPlayByPlayRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[
    str,
    Field(alias="gameId"),
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Game identifier (UUID)

include_penalties class-attribute instance-attribute

include_penalties: Annotated[
    Optional[bool],
    Field(alias="includePenalties"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = True

Include penalty details

include_formations class-attribute instance-attribute

include_formations: Annotated[
    Optional[bool],
    Field(alias="includeFormations"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Include offensive/defensive formations

GetPlayByPlayRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayByPlayRequestTypedDict[GetPlayByPlayRequestTypedDict]

              

              click griddy.nfl.models.GetPlayByPlayRequestTypedDict href "" "griddy.nfl.models.GetPlayByPlayRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: str

Game identifier (UUID)

include_penalties instance-attribute

include_penalties: NotRequired[bool]

Include penalty details

include_formations instance-attribute

include_formations: NotRequired[bool]

Include offensive/defensive formations

GetPlayListRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayListRequest[GetPlayListRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayListRequest
                


              click griddy.nfl.models.GetPlayListRequest href "" "griddy.nfl.models.GetPlayListRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[
    GameID,
    Field(alias=gameId),
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

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

GetPlayListRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayListRequestTypedDict[GetPlayListRequestTypedDict]

              

              click griddy.nfl.models.GetPlayListRequestTypedDict href "" "griddy.nfl.models.GetPlayListRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: GameIDTypedDict

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

GetPlayerDetailsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayerDetailsRequest[GetPlayerDetailsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayerDetailsRequest
                


              click griddy.nfl.models.GetPlayerDetailsRequest href "" "griddy.nfl.models.GetPlayerDetailsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

player_id instance-attribute

player_id: Annotated[
    str,
    Field(alias="playerId"),
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Player identifier

season class-attribute instance-attribute

season: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Season for statistics (defaults to current)

GetPlayerDetailsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayerDetailsRequestTypedDict[GetPlayerDetailsRequestTypedDict]

              

              click griddy.nfl.models.GetPlayerDetailsRequestTypedDict href "" "griddy.nfl.models.GetPlayerDetailsRequestTypedDict"
            

Attributes

player_id instance-attribute

player_id: str

Player identifier

season instance-attribute

season: NotRequired[int]

Season for statistics (defaults to current)

GetPlayerRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayerRequest[GetPlayerRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayerRequest
                


              click griddy.nfl.models.GetPlayerRequest href "" "griddy.nfl.models.GetPlayerRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

nfl_id instance-attribute

nfl_id: Annotated[
    int,
    Field(alias="nflId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

NFL player identifier

GetPlayerRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayerRequestTypedDict[GetPlayerRequestTypedDict]

              

              click griddy.nfl.models.GetPlayerRequestTypedDict href "" "griddy.nfl.models.GetPlayerRequestTypedDict"
            

Attributes

nfl_id instance-attribute

nfl_id: int

NFL player identifier

GetPlayerPassingStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayerPassingStatsBySeasonRequest[GetPlayerPassingStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayerPassingStatsBySeasonRequest
                


              click griddy.nfl.models.GetPlayerPassingStatsBySeasonRequest href "" "griddy.nfl.models.GetPlayerPassingStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[PassingStatsCategoryEnum],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_passer class-attribute instance-attribute

qualified_passer: Annotated[
    Optional[bool],
    Field(alias="qualifiedPasser"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = True

Filter to only qualified passers (minimum attempts threshold)

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[List[str]],
    Field(alias="teamOffense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team IDs (supports multiple teams)

GetPlayerPassingStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayerPassingStatsBySeasonRequestTypedDict[GetPlayerPassingStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetPlayerPassingStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetPlayerPassingStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[PassingStatsCategoryEnum]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_passer instance-attribute

qualified_passer: NotRequired[bool]

Filter to only qualified passers (minimum attempts threshold)

team_offense instance-attribute

team_offense: NotRequired[List[str]]

Filter by specific team IDs (supports multiple teams)

GetPlayerPassingStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayerPassingStatsByWeekRequest[GetPlayerPassingStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayerPassingStatsByWeekRequest
                


              click griddy.nfl.models.GetPlayerPassingStatsByWeekRequest href "" "griddy.nfl.models.GetPlayerPassingStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week identifier

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 50

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[PassingStatsCategoryEnum],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_passer class-attribute instance-attribute

qualified_passer: Annotated[
    Optional[bool],
    Field(alias="qualifiedPasser"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified passers (minimum attempts threshold)

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[List[str]],
    Field(alias="teamOffense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team IDs (supports multiple teams)

GetPlayerPassingStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayerPassingStatsByWeekRequestTypedDict[GetPlayerPassingStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetPlayerPassingStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetPlayerPassingStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week identifier

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[PassingStatsCategoryEnum]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_passer instance-attribute

qualified_passer: NotRequired[bool]

Filter to only qualified passers (minimum attempts threshold)

team_offense instance-attribute

team_offense: NotRequired[List[str]]

Filter by specific team IDs (supports multiple teams)

GetPlayerReceivingStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayerReceivingStatsBySeasonRequest[GetPlayerReceivingStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayerReceivingStatsBySeasonRequest
                


              click griddy.nfl.models.GetPlayerReceivingStatsBySeasonRequest href "" "griddy.nfl.models.GetPlayerReceivingStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[ReceivingStatsCategoryEnum],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_receiver class-attribute instance-attribute

qualified_receiver: Annotated[
    Optional[bool],
    Field(alias="qualifiedReceiver"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified receivers (minimum target threshold)

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[List[str]],
    Field(alias="teamOffense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team IDs (supports multiple teams)

GetPlayerReceivingStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayerReceivingStatsBySeasonRequestTypedDict[GetPlayerReceivingStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetPlayerReceivingStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetPlayerReceivingStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[ReceivingStatsCategoryEnum]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_receiver instance-attribute

qualified_receiver: NotRequired[bool]

Filter to only qualified receivers (minimum target threshold)

team_offense instance-attribute

team_offense: NotRequired[List[str]]

Filter by specific team IDs (supports multiple teams)

GetPlayerReceivingStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayerReceivingStatsByWeekRequest[GetPlayerReceivingStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayerReceivingStatsByWeekRequest
                


              click griddy.nfl.models.GetPlayerReceivingStatsByWeekRequest href "" "griddy.nfl.models.GetPlayerReceivingStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week identifier

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 50

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[ReceivingStatsCategoryEnum],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_receiver class-attribute instance-attribute

qualified_receiver: Annotated[
    Optional[bool],
    Field(alias="qualifiedReceiver"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified receivers (minimum target threshold)

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[List[str]],
    Field(alias="teamOffense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team IDs (supports multiple teams)

GetPlayerReceivingStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayerReceivingStatsByWeekRequestTypedDict[GetPlayerReceivingStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetPlayerReceivingStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetPlayerReceivingStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week identifier

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[ReceivingStatsCategoryEnum]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_receiver instance-attribute

qualified_receiver: NotRequired[bool]

Filter to only qualified receivers (minimum target threshold)

team_offense instance-attribute

team_offense: NotRequired[List[str]]

Filter by specific team IDs (supports multiple teams)

GetPlayerRushingStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayerRushingStatsBySeasonRequest[GetPlayerRushingStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayerRushingStatsBySeasonRequest
                


              click griddy.nfl.models.GetPlayerRushingStatsBySeasonRequest href "" "griddy.nfl.models.GetPlayerRushingStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetPlayerRushingStatsBySeasonSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "yds"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_rusher class-attribute instance-attribute

qualified_rusher: Annotated[
    Optional[bool],
    Field(alias="qualifiedRusher"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified rushers (minimum attempts threshold)

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[List[str]],
    Field(alias="teamOffense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team IDs (supports multiple teams)

GetPlayerRushingStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayerRushingStatsBySeasonRequestTypedDict[GetPlayerRushingStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetPlayerRushingStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetPlayerRushingStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetPlayerRushingStatsBySeasonSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_rusher instance-attribute

qualified_rusher: NotRequired[bool]

Filter to only qualified rushers (minimum attempts threshold)

team_offense instance-attribute

team_offense: NotRequired[List[str]]

Filter by specific team IDs (supports multiple teams)

GetPlayerRushingStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayerRushingStatsByWeekRequest[GetPlayerRushingStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayerRushingStatsByWeekRequest
                


              click griddy.nfl.models.GetPlayerRushingStatsByWeekRequest href "" "griddy.nfl.models.GetPlayerRushingStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week identifier

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 50

Maximum number of players to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetPlayerRushingStatsByWeekSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "yds"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

qualified_rusher class-attribute instance-attribute

qualified_rusher: Annotated[
    Optional[bool],
    Field(alias="qualifiedRusher"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified rushers (minimum attempts threshold)

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[List[str]],
    Field(alias="teamOffense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team IDs (supports multiple teams)

GetPlayerRushingStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayerRushingStatsByWeekRequestTypedDict[GetPlayerRushingStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetPlayerRushingStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetPlayerRushingStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week identifier

limit instance-attribute

limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetPlayerRushingStatsByWeekSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_rusher instance-attribute

qualified_rusher: NotRequired[bool]

Filter to only qualified rushers (minimum attempts threshold)

team_offense instance-attribute

team_offense: NotRequired[List[str]]

Filter by specific team IDs (supports multiple teams)

GetPlayersTeamRosterRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlayersTeamRosterRequest[GetPlayersTeamRosterRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlayersTeamRosterRequest
                


              click griddy.nfl.models.GetPlayersTeamRosterRequest href "" "griddy.nfl.models.GetPlayersTeamRosterRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

team_id instance-attribute

team_id: Annotated[
    str,
    Field(alias="teamId"),
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Team identifier (UUID)

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

include_stats class-attribute instance-attribute

include_stats: Annotated[
    Optional[bool],
    Field(alias="includeStats"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Include current season statistics

GetPlayersTeamRosterRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlayersTeamRosterRequestTypedDict[GetPlayersTeamRosterRequestTypedDict]

              

              click griddy.nfl.models.GetPlayersTeamRosterRequestTypedDict href "" "griddy.nfl.models.GetPlayersTeamRosterRequestTypedDict"
            

Attributes

team_id instance-attribute

team_id: str

Team identifier (UUID)

season instance-attribute

season: int

Season year

include_stats instance-attribute

include_stats: NotRequired[bool]

Include current season statistics

GetPlaysWinProbabilityRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetPlaysWinProbabilityRequest[GetPlaysWinProbabilityRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetPlaysWinProbabilityRequest
                


              click griddy.nfl.models.GetPlaysWinProbabilityRequest href "" "griddy.nfl.models.GetPlaysWinProbabilityRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[
    GameID,
    Field(alias="gameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

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

GetPlaysWinProbabilityRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetPlaysWinProbabilityRequestTypedDict[GetPlaysWinProbabilityRequestTypedDict]

              

              click griddy.nfl.models.GetPlaysWinProbabilityRequestTypedDict href "" "griddy.nfl.models.GetPlaysWinProbabilityRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: GameIDTypedDict

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

GetProjectedStatsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetProjectedStatsRequest[GetProjectedStatsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetProjectedStatsRequest
                


              click griddy.nfl.models.GetProjectedStatsRequest href "" "griddy.nfl.models.GetProjectedStatsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number within the season

filter_nfl_team_id class-attribute instance-attribute

filter_nfl_team_id: Annotated[
    Optional[str],
    Field(alias="filter[nflTeamId]"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by NFL team ID (UUID format)

page_size class-attribute instance-attribute

page_size: Annotated[
    Optional[int],
    Field(alias="page[size]"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Number of results per page

GetProjectedStatsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetProjectedStatsRequestTypedDict[GetProjectedStatsRequestTypedDict]

              

              click griddy.nfl.models.GetProjectedStatsRequestTypedDict href "" "griddy.nfl.models.GetProjectedStatsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

week instance-attribute

week: int

Week number within the season

filter_nfl_team_id instance-attribute

filter_nfl_team_id: NotRequired[str]

Filter by NFL team ID (UUID format)

page_size instance-attribute

page_size: NotRequired[int]

Number of results per page

GetScheduleSeasonWeeksRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetScheduleSeasonWeeksRequest[GetScheduleSeasonWeeksRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetScheduleSeasonWeeksRequest
                


              click griddy.nfl.models.GetScheduleSeasonWeeksRequest href "" "griddy.nfl.models.GetScheduleSeasonWeeksRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

GetScheduleSeasonWeeksRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetScheduleSeasonWeeksRequestTypedDict[GetScheduleSeasonWeeksRequestTypedDict]

              

              click griddy.nfl.models.GetScheduleSeasonWeeksRequestTypedDict href "" "griddy.nfl.models.GetScheduleSeasonWeeksRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

GetScheduledGameRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetScheduledGameRequest[GetScheduledGameRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetScheduledGameRequest
                


              click griddy.nfl.models.GetScheduledGameRequest href "" "griddy.nfl.models.GetScheduledGameRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[
    str,
    Field(alias="gameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Game identifier (UUID format)

GetScheduledGameRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetScheduledGameRequestTypedDict[GetScheduledGameRequestTypedDict]

              

              click griddy.nfl.models.GetScheduledGameRequestTypedDict href "" "griddy.nfl.models.GetScheduledGameRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: str

Game identifier (UUID format)

GetScheduledGamesRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetScheduledGamesRequest[GetScheduledGamesRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetScheduledGamesRequest
                


              click griddy.nfl.models.GetScheduledGamesRequest href "" "griddy.nfl.models.GetScheduledGamesRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number within the season

GetScheduledGamesRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetScheduledGamesRequestTypedDict[GetScheduledGamesRequestTypedDict]

              

              click griddy.nfl.models.GetScheduledGamesRequestTypedDict href "" "griddy.nfl.models.GetScheduledGamesRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: int

Week number within the season

GetSeasonContentInsightsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetSeasonContentInsightsRequest[GetSeasonContentInsightsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetSeasonContentInsightsRequest
                


              click griddy.nfl.models.GetSeasonContentInsightsRequest href "" "griddy.nfl.models.GetSeasonContentInsightsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Maximum number of insights to return

tags class-attribute instance-attribute

tags: Annotated[
    Optional[List[Tag]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

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

team_id class-attribute instance-attribute

team_id: Annotated[
    Optional[str],
    Field(alias="teamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team identifier

nfl_id class-attribute instance-attribute

nfl_id: Annotated[
    Optional[str],
    Field(alias="nflId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific player NFL identifier

GetSeasonContentInsightsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetSeasonContentInsightsRequestTypedDict[GetSeasonContentInsightsRequestTypedDict]

              

              click griddy.nfl.models.GetSeasonContentInsightsRequestTypedDict href "" "griddy.nfl.models.GetSeasonContentInsightsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

limit instance-attribute

limit: NotRequired[int]

Maximum number of insights to return

tags instance-attribute

tags: NotRequired[List[Tag]]

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

team_id instance-attribute

team_id: NotRequired[str]

Filter by specific team identifier

nfl_id instance-attribute

nfl_id: NotRequired[str]

Filter by specific player NFL identifier

GetSeasonPlayerStatsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetSeasonPlayerStatsRequest[GetSeasonPlayerStatsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetSeasonPlayerStatsRequest
                


              click griddy.nfl.models.GetSeasonPlayerStatsRequest href "" "griddy.nfl.models.GetSeasonPlayerStatsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

position class-attribute instance-attribute

position: Annotated[
    Optional[GetSeasonPlayerStatsPosition],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by position group

team_id class-attribute instance-attribute

team_id: Annotated[
    Optional[str],
    Field(alias="teamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by team

stat_category class-attribute instance-attribute

stat_category: Annotated[
    Optional[StatCategory],
    Field(alias="statCategory"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Statistical category to retrieve

sort class-attribute instance-attribute

sort: Annotated[
    Optional[str],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort field and order

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 50

Maximum number of results

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Offset for pagination

GetSeasonPlayerStatsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetSeasonPlayerStatsRequestTypedDict[GetSeasonPlayerStatsRequestTypedDict]

              

              click griddy.nfl.models.GetSeasonPlayerStatsRequestTypedDict href "" "griddy.nfl.models.GetSeasonPlayerStatsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

position instance-attribute

position: NotRequired[GetSeasonPlayerStatsPosition]

Filter by position group

team_id instance-attribute

team_id: NotRequired[str]

Filter by team

stat_category instance-attribute

stat_category: NotRequired[StatCategory]

Statistical category to retrieve

sort instance-attribute

sort: NotRequired[str]

Sort field and order

limit instance-attribute

limit: NotRequired[int]

Maximum number of results

offset instance-attribute

offset: NotRequired[int]

Offset for pagination

GetSeasonWeeksRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetSeasonWeeksRequest[GetSeasonWeeksRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetSeasonWeeksRequest
                


              click griddy.nfl.models.GetSeasonWeeksRequest href "" "griddy.nfl.models.GetSeasonWeeksRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Season year

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Maximum number of weeks to return

GetSeasonWeeksRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetSeasonWeeksRequestTypedDict[GetSeasonWeeksRequestTypedDict]

              

              click griddy.nfl.models.GetSeasonWeeksRequestTypedDict href "" "griddy.nfl.models.GetSeasonWeeksRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

limit instance-attribute

limit: NotRequired[int]

Maximum number of weeks to return

GetStandingsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetStandingsRequest[GetStandingsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetStandingsRequest
                


              click griddy.nfl.models.GetStandingsRequest href "" "griddy.nfl.models.GetStandingsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Maximum number of results to return

GetStandingsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetStandingsRequestTypedDict[GetStandingsRequestTypedDict]

              

              click griddy.nfl.models.GetStandingsRequestTypedDict href "" "griddy.nfl.models.GetStandingsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: int

Week number

limit instance-attribute

limit: NotRequired[int]

Maximum number of results to return

GetStatsBoxscoreRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetStatsBoxscoreRequest[GetStatsBoxscoreRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetStatsBoxscoreRequest
                


              click griddy.nfl.models.GetStatsBoxscoreRequest href "" "griddy.nfl.models.GetStatsBoxscoreRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[
    str,
    Field(alias="gameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Game identifier (10-digit format YYYYMMDDNN)

GetStatsBoxscoreRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetStatsBoxscoreRequestTypedDict[GetStatsBoxscoreRequestTypedDict]

              

              click griddy.nfl.models.GetStatsBoxscoreRequestTypedDict href "" "griddy.nfl.models.GetStatsBoxscoreRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: str

Game identifier (10-digit format YYYYMMDDNN)

GetSummaryPlayRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetSummaryPlayRequest[GetSummaryPlayRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetSummaryPlayRequest
                


              click griddy.nfl.models.GetSummaryPlayRequest href "" "griddy.nfl.models.GetSummaryPlayRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[
    str,
    Field(alias="gameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Game identifier (UUID format)

play_id instance-attribute

play_id: Annotated[
    int,
    Field(alias="playId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Play identifier within the game

GetSummaryPlayRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetSummaryPlayRequestTypedDict[GetSummaryPlayRequestTypedDict]

              

              click griddy.nfl.models.GetSummaryPlayRequestTypedDict href "" "griddy.nfl.models.GetSummaryPlayRequestTypedDict"
            

Attributes

game_id instance-attribute

game_id: str

Game identifier (UUID format)

play_id instance-attribute

play_id: int

Play identifier within the game

GetTeamDefensePassStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamDefensePassStatsBySeasonRequest[GetTeamDefensePassStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamDefensePassStatsBySeasonRequest
                


              click griddy.nfl.models.GetTeamDefensePassStatsBySeasonRequest href "" "griddy.nfl.models.GetTeamDefensePassStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamDefensePassStatsBySeasonSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "passYpg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

GetTeamDefensePassStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamDefensePassStatsBySeasonRequestTypedDict[GetTeamDefensePassStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetTeamDefensePassStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetTeamDefensePassStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[
    GetTeamDefensePassStatsBySeasonSortKey
]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

GetTeamDefensePassStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamDefensePassStatsByWeekRequest[GetTeamDefensePassStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamDefensePassStatsByWeekRequest
                


              click griddy.nfl.models.GetTeamDefensePassStatsByWeekRequest href "" "griddy.nfl.models.GetTeamDefensePassStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamDefensePassStatsByWeekSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "passYpg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

GetTeamDefensePassStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamDefensePassStatsByWeekRequestTypedDict[GetTeamDefensePassStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetTeamDefensePassStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetTeamDefensePassStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week number

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetTeamDefensePassStatsByWeekSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

GetTeamDefenseRushStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamDefenseRushStatsBySeasonRequest[GetTeamDefenseRushStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamDefenseRushStatsBySeasonRequest
                


              click griddy.nfl.models.GetTeamDefenseRushStatsBySeasonRequest href "" "griddy.nfl.models.GetTeamDefenseRushStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamDefenseRushStatsBySeasonSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "rushYpg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

GetTeamDefenseRushStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamDefenseRushStatsBySeasonRequestTypedDict[GetTeamDefenseRushStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetTeamDefenseRushStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetTeamDefenseRushStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[
    GetTeamDefenseRushStatsBySeasonSortKey
]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

GetTeamDefenseRushStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamDefenseRushStatsByWeekRequest[GetTeamDefenseRushStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamDefenseRushStatsByWeekRequest
                


              click griddy.nfl.models.GetTeamDefenseRushStatsByWeekRequest href "" "griddy.nfl.models.GetTeamDefenseRushStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamDefenseRushStatsByWeekSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "rushYpg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

GetTeamDefenseRushStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamDefenseRushStatsByWeekRequestTypedDict[GetTeamDefenseRushStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetTeamDefenseRushStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetTeamDefenseRushStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week number

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetTeamDefenseRushStatsByWeekSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

GetTeamDefenseStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamDefenseStatsBySeasonRequest[GetTeamDefenseStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamDefenseStatsBySeasonRequest
                


              click griddy.nfl.models.GetTeamDefenseStatsBySeasonRequest href "" "griddy.nfl.models.GetTeamDefenseStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamDefenseStatsBySeasonSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "ypg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

split class-attribute instance-attribute

split: Annotated[
    Optional[List[GetTeamDefenseStatsBySeasonSplit]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Defensive situation splits to filter by (supports multiple values)

GetTeamDefenseStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamDefenseStatsBySeasonRequestTypedDict[GetTeamDefenseStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetTeamDefenseStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetTeamDefenseStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetTeamDefenseStatsBySeasonSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

split instance-attribute

split: NotRequired[List[GetTeamDefenseStatsBySeasonSplit]]

Defensive situation splits to filter by (supports multiple values)

GetTeamDefenseStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamDefenseStatsByWeekRequest[GetTeamDefenseStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamDefenseStatsByWeekRequest
                


              click griddy.nfl.models.GetTeamDefenseStatsByWeekRequest href "" "griddy.nfl.models.GetTeamDefenseStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamDefenseStatsByWeekSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "ypg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

split class-attribute instance-attribute

split: Annotated[
    Optional[List[GetTeamDefenseStatsByWeekSplit]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Defensive situation splits to filter by (supports multiple values)

GetTeamDefenseStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamDefenseStatsByWeekRequestTypedDict[GetTeamDefenseStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetTeamDefenseStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetTeamDefenseStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week number

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetTeamDefenseStatsByWeekSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

split instance-attribute

split: NotRequired[List[GetTeamDefenseStatsByWeekSplit]]

Defensive situation splits to filter by (supports multiple values)

GetTeamInjuriesRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamInjuriesRequest[GetTeamInjuriesRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamInjuriesRequest
                


              click griddy.nfl.models.GetTeamInjuriesRequest href "" "griddy.nfl.models.GetTeamInjuriesRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

team_id instance-attribute

team_id: Annotated[
    str,
    Field(alias="teamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Team identifier (UUID format)

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number within the season

GetTeamInjuriesRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamInjuriesRequestTypedDict[GetTeamInjuriesRequestTypedDict]

              

              click griddy.nfl.models.GetTeamInjuriesRequestTypedDict href "" "griddy.nfl.models.GetTeamInjuriesRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

team_id instance-attribute

team_id: str

Team identifier (UUID format)

week instance-attribute

week: int

Week number within the season

GetTeamNeedsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamNeedsRequest[GetTeamNeedsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamNeedsRequest
                


              click griddy.nfl.models.GetTeamNeedsRequest href "" "griddy.nfl.models.GetTeamNeedsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

year instance-attribute

year: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Draft year

GetTeamNeedsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamNeedsRequestTypedDict[GetTeamNeedsRequestTypedDict]

              

              click griddy.nfl.models.GetTeamNeedsRequestTypedDict href "" "griddy.nfl.models.GetTeamNeedsRequestTypedDict"
            

Attributes

year instance-attribute

year: int

Draft year

limit instance-attribute

limit: NotRequired[int]

Maximum picks to return

GetTeamOffenseStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamOffenseStatsBySeasonRequest[GetTeamOffenseStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamOffenseStatsBySeasonRequest
                


              click griddy.nfl.models.GetTeamOffenseStatsBySeasonRequest href "" "griddy.nfl.models.GetTeamOffenseStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamOffenseStatsBySeasonSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "ypg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

team_defense class-attribute instance-attribute

team_defense: Annotated[
    Optional[str],
    Field(alias="teamDefense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team identifier

split class-attribute instance-attribute

split: Annotated[
    Optional[List[GetTeamOffenseStatsBySeasonSplit]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Offensive situation splits to filter by (supports multiple values)

GetTeamOffenseStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamOffenseStatsBySeasonRequestTypedDict[GetTeamOffenseStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetTeamOffenseStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetTeamOffenseStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetTeamOffenseStatsBySeasonSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

team_defense instance-attribute

team_defense: NotRequired[str]

Filter by specific team identifier

split instance-attribute

split: NotRequired[List[GetTeamOffenseStatsBySeasonSplit]]

Offensive situation splits to filter by (supports multiple values)

GetTeamOffenseStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamOffenseStatsByWeekRequest[GetTeamOffenseStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamOffenseStatsByWeekRequest
                


              click griddy.nfl.models.GetTeamOffenseStatsByWeekRequest href "" "griddy.nfl.models.GetTeamOffenseStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week identifier

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamOffenseStatsByWeekSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "ypg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

team_defense class-attribute instance-attribute

team_defense: Annotated[
    Optional[str],
    Field(alias="teamDefense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team identifier

split class-attribute instance-attribute

split: Annotated[
    Optional[List[GetTeamOffenseStatsByWeekSplit]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Offensive situation splits to filter by (supports multiple values)

GetTeamOffenseStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamOffenseStatsByWeekRequestTypedDict[GetTeamOffenseStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetTeamOffenseStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetTeamOffenseStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week identifier

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetTeamOffenseStatsByWeekSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

team_defense instance-attribute

team_defense: NotRequired[str]

Filter by specific team identifier

split instance-attribute

split: NotRequired[List[GetTeamOffenseStatsByWeekSplit]]

Offensive situation splits to filter by (supports multiple values)

GetTeamOffensePassStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamOffensePassStatsBySeasonRequest[GetTeamOffensePassStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamOffensePassStatsBySeasonRequest
                


              click griddy.nfl.models.GetTeamOffensePassStatsBySeasonRequest href "" "griddy.nfl.models.GetTeamOffensePassStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamOffensePassStatsBySeasonSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "passYpg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

team_defense class-attribute instance-attribute

team_defense: Annotated[
    Optional[str],
    Field(alias="teamDefense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team ID

GetTeamOffensePassStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamOffensePassStatsBySeasonRequestTypedDict[GetTeamOffensePassStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetTeamOffensePassStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetTeamOffensePassStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[
    GetTeamOffensePassStatsBySeasonSortKey
]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

team_defense instance-attribute

team_defense: NotRequired[str]

Filter by specific team ID

GetTeamOffensePassStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamOffensePassStatsByWeekRequest[GetTeamOffensePassStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamOffensePassStatsByWeekRequest
                


              click griddy.nfl.models.GetTeamOffensePassStatsByWeekRequest href "" "griddy.nfl.models.GetTeamOffensePassStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week identifier

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamOffensePassStatsByWeekSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "passYpg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias="sortValue"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort direction

team_defense class-attribute instance-attribute

team_defense: Annotated[
    Optional[str],
    Field(alias="teamDefense"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific team ID

GetTeamOffensePassStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamOffensePassStatsByWeekRequestTypedDict[GetTeamOffensePassStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetTeamOffensePassStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetTeamOffensePassStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week identifier

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetTeamOffensePassStatsByWeekSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

team_defense instance-attribute

team_defense: NotRequired[str]

Filter by specific team ID

GetTeamOffenseRushStatsBySeasonRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamOffenseRushStatsBySeasonRequest[GetTeamOffenseRushStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamOffenseRushStatsBySeasonRequest
                


              click griddy.nfl.models.GetTeamOffenseRushStatsBySeasonRequest href "" "griddy.nfl.models.GetTeamOffenseRushStatsBySeasonRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias=seasonType),
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Type of season

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamOffenseRushStatsBySeasonSortKey],
    Field(alias=sortKey),
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = "passYpg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias=sortValue),
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = None

Sort direction

GetTeamOffenseRushStatsBySeasonRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamOffenseRushStatsBySeasonRequestTypedDict[GetTeamOffenseRushStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.GetTeamOffenseRushStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.GetTeamOffenseRushStatsBySeasonRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[
    GetTeamOffenseRushStatsBySeasonSortKey
]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

GetTeamOffenseRushStatsByWeekRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamOffenseRushStatsByWeekRequest[GetTeamOffenseRushStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamOffenseRushStatsByWeekRequest
                


              click griddy.nfl.models.GetTeamOffenseRushStatsByWeekRequest href "" "griddy.nfl.models.GetTeamOffenseRushStatsByWeekRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias=seasonType),
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
]

Week identifier

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = 35

Maximum number of teams to return

offset class-attribute instance-attribute

offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = 0

Number of records to skip for pagination

page class-attribute instance-attribute

page: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = 1

Page number for pagination

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[GetTeamOffenseRushStatsByWeekSortKey],
    Field(alias=sortKey),
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = "passYpg"

Field to sort by

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum],
    Field(alias=sortValue),
    FieldMetadata(
        query=QueryParamMetadata(style=form, explode=True)
    ),
] = None

Sort direction

GetTeamOffenseRushStatsByWeekRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamOffenseRushStatsByWeekRequestTypedDict[GetTeamOffenseRushStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.GetTeamOffenseRushStatsByWeekRequestTypedDict href "" "griddy.nfl.models.GetTeamOffenseRushStatsByWeekRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: WeekSlugEnum

Week identifier

limit instance-attribute

limit: NotRequired[int]

Maximum number of teams to return

offset instance-attribute

offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute

page: NotRequired[int]

Page number for pagination

sort_key instance-attribute

sort_key: NotRequired[GetTeamOffenseRushStatsByWeekSortKey]

Field to sort by

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction

GetTeamRosterRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamRosterRequest[GetTeamRosterRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamRosterRequest
                


              click griddy.nfl.models.GetTeamRosterRequest href "" "griddy.nfl.models.GetTeamRosterRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

team_id instance-attribute

team_id: Annotated[
    str,
    Field(alias="teamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Team identifier (4-digit string)

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

GetTeamRosterRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamRosterRequestTypedDict[GetTeamRosterRequestTypedDict]

              

              click griddy.nfl.models.GetTeamRosterRequestTypedDict href "" "griddy.nfl.models.GetTeamRosterRequestTypedDict"
            

Attributes

team_id instance-attribute

team_id: str

Team identifier (4-digit string)

season instance-attribute

season: int

Season year

GetTeamScheduleRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamScheduleRequest[GetTeamScheduleRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamScheduleRequest
                


              click griddy.nfl.models.GetTeamScheduleRequest href "" "griddy.nfl.models.GetTeamScheduleRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

team_id instance-attribute

team_id: Annotated[
    str,
    Field(alias="teamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Team identifier (4-digit string)

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

GetTeamScheduleRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamScheduleRequestTypedDict[GetTeamScheduleRequestTypedDict]

              

              click griddy.nfl.models.GetTeamScheduleRequestTypedDict href "" "griddy.nfl.models.GetTeamScheduleRequestTypedDict"
            

Attributes

team_id instance-attribute

team_id: str

Team identifier (4-digit string)

season instance-attribute

season: int

Season year

GetTeamStandingsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTeamStandingsRequest[GetTeamStandingsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTeamStandingsRequest
                


              click griddy.nfl.models.GetTeamStandingsRequest href "" "griddy.nfl.models.GetTeamStandingsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number within the season

GetTeamStandingsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTeamStandingsRequestTypedDict[GetTeamStandingsRequestTypedDict]

              

              click griddy.nfl.models.GetTeamStandingsRequestTypedDict href "" "griddy.nfl.models.GetTeamStandingsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: int

Week number within the season

GetTransactionsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetTransactionsRequest[GetTransactionsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetTransactionsRequest
                


              click griddy.nfl.models.GetTransactionsRequest href "" "griddy.nfl.models.GetTransactionsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

month instance-attribute

month: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Month (number) to fetch transactions for

year instance-attribute

year: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

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

team_id instance-attribute

team_id: Annotated[
    str,
    Field(alias="teamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Team UUID string

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Maximum number of results

GetTransactionsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetTransactionsRequestTypedDict[GetTransactionsRequestTypedDict]

              

              click griddy.nfl.models.GetTransactionsRequestTypedDict href "" "griddy.nfl.models.GetTransactionsRequestTypedDict"
            

Attributes

month instance-attribute

month: int

Month (number) to fetch transactions for

year instance-attribute

year: int

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

team_id instance-attribute

team_id: str

Team UUID string

limit instance-attribute

limit: NotRequired[int]

Maximum number of results

GetVenuesRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetVenuesRequest[GetVenuesRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetVenuesRequest
                


              click griddy.nfl.models.GetVenuesRequest href "" "griddy.nfl.models.GetVenuesRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

limit class-attribute instance-attribute

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Maximum number of venues to return

GetVenuesRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetVenuesRequestTypedDict[GetVenuesRequestTypedDict]

              

              click griddy.nfl.models.GetVenuesRequestTypedDict href "" "griddy.nfl.models.GetVenuesRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

limit instance-attribute

limit: NotRequired[int]

Maximum number of venues to return

GetWeekOfDateRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetWeekOfDateRequest[GetWeekOfDateRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetWeekOfDateRequest
                


              click griddy.nfl.models.GetWeekOfDateRequest href "" "griddy.nfl.models.GetWeekOfDateRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

date instance-attribute

date: Annotated[
    str,
    FieldMetadata(
        path=PathParamMetadata(style=simple, explode=False)
    ),
]

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

GetWeekOfDateRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetWeekOfDateRequestTypedDict[GetWeekOfDateRequestTypedDict]

              

              click griddy.nfl.models.GetWeekOfDateRequestTypedDict href "" "griddy.nfl.models.GetWeekOfDateRequestTypedDict"
            

Attributes

date instance-attribute

date: str

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

GetWeeklyBettingOddsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetWeeklyBettingOddsRequest[GetWeeklyBettingOddsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetWeeklyBettingOddsRequest
                


              click griddy.nfl.models.GetWeeklyBettingOddsRequest href "" "griddy.nfl.models.GetWeeklyBettingOddsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number within the season

GetWeeklyBettingOddsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetWeeklyBettingOddsRequestTypedDict[GetWeeklyBettingOddsRequestTypedDict]

              

              click griddy.nfl.models.GetWeeklyBettingOddsRequestTypedDict href "" "griddy.nfl.models.GetWeeklyBettingOddsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: int

Week number within the season

GetWeeklyGameDetailsRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetWeeklyGameDetailsRequest[GetWeeklyGameDetailsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetWeeklyGameDetailsRequest
                


              click griddy.nfl.models.GetWeeklyGameDetailsRequest href "" "griddy.nfl.models.GetWeeklyGameDetailsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

type instance-attribute

type: Annotated[
    SeasonTypeEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season type

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

include_drive_chart class-attribute instance-attribute

include_drive_chart: Annotated[
    Optional[bool],
    Field(alias="includeDriveChart"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Include drive chart data

include_replays class-attribute instance-attribute

include_replays: Annotated[
    Optional[bool],
    Field(alias="includeReplays"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Include replay videos

include_standings class-attribute instance-attribute

include_standings: Annotated[
    Optional[bool],
    Field(alias="includeStandings"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Include team standings

include_tagged_videos class-attribute instance-attribute

include_tagged_videos: Annotated[
    Optional[bool],
    Field(alias="includeTaggedVideos"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Include tagged video content

GetWeeklyGameDetailsRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetWeeklyGameDetailsRequestTypedDict[GetWeeklyGameDetailsRequestTypedDict]

              

              click griddy.nfl.models.GetWeeklyGameDetailsRequestTypedDict href "" "griddy.nfl.models.GetWeeklyGameDetailsRequestTypedDict"
            

Attributes

season instance-attribute

season: int

Season year

type instance-attribute

type: SeasonTypeEnum

Season type

week instance-attribute

week: int

Week number

include_drive_chart instance-attribute

include_drive_chart: NotRequired[bool]

Include drive chart data

include_replays instance-attribute

include_replays: NotRequired[bool]

Include replay videos

include_standings instance-attribute

include_standings: NotRequired[bool]

Include team standings

include_tagged_videos instance-attribute

include_tagged_videos: NotRequired[bool]

Include tagged video content

GetWeeklyTeamRosterRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetWeeklyTeamRosterRequest[GetWeeklyTeamRosterRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetWeeklyTeamRosterRequest
                


              click griddy.nfl.models.GetWeeklyTeamRosterRequest href "" "griddy.nfl.models.GetWeeklyTeamRosterRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

team_id instance-attribute

team_id: Annotated[
    str,
    Field(alias="teamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Team identifier (4-digit string)

season instance-attribute

season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

week instance-attribute

week: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number within the season

GetWeeklyTeamRosterRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetWeeklyTeamRosterRequestTypedDict[GetWeeklyTeamRosterRequestTypedDict]

              

              click griddy.nfl.models.GetWeeklyTeamRosterRequestTypedDict href "" "griddy.nfl.models.GetWeeklyTeamRosterRequestTypedDict"
            

Attributes

team_id instance-attribute

team_id: str

Team identifier (4-digit string)

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

week instance-attribute

week: int

Week number within the season

GetWinProbabilityMinRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GetWinProbabilityMinRequest[GetWinProbabilityMinRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GetWinProbabilityMinRequest
                


              click griddy.nfl.models.GetWinProbabilityMinRequest href "" "griddy.nfl.models.GetWinProbabilityMinRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

fapi_game_id instance-attribute

fapi_game_id: Annotated[
    List[str],
    Field(alias="fapiGameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

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

GetWinProbabilityMinRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GetWinProbabilityMinRequestTypedDict[GetWinProbabilityMinRequestTypedDict]

              

              click griddy.nfl.models.GetWinProbabilityMinRequestTypedDict href "" "griddy.nfl.models.GetWinProbabilityMinRequestTypedDict"
            

Attributes

fapi_game_id instance-attribute

fapi_game_id: List[str]

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

RefreshTokenRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.RefreshTokenRequest[RefreshTokenRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.RefreshTokenRequest
                


              click griddy.nfl.models.RefreshTokenRequest href "" "griddy.nfl.models.RefreshTokenRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

client_key instance-attribute

client_key: Annotated[str, Field(alias='clientKey')]

Client application identifier key

client_secret instance-attribute

client_secret: Annotated[str, Field(alias='clientSecret')]

Client application secret for authentication

device_id instance-attribute

device_id: Annotated[str, Field(alias='deviceId')]

Unique device identifier (UUID format)

device_info instance-attribute

device_info: Annotated[str, Field(alias='deviceInfo')]

Base64-encoded JSON containing device information such as:

network_type instance-attribute

network_type: Annotated[
    RefreshTokenRequestNetworkType,
    Field(alias="networkType"),
]

Type of network connection

refresh_token instance-attribute

refresh_token: Annotated[str, Field(alias='refreshToken')]

Valid refresh token from previous authentication

signature_timestamp instance-attribute

signature_timestamp: Annotated[
    str, Field(alias="signatureTimestamp")
]

Unix timestamp for signature verification

uid instance-attribute

uid: str

User identifier hash

uid_signature instance-attribute

uid_signature: Annotated[str, Field(alias='uidSignature')]

HMAC signature for request verification

RefreshTokenRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.RefreshTokenRequestTypedDict[RefreshTokenRequestTypedDict]

              

              click griddy.nfl.models.RefreshTokenRequestTypedDict href "" "griddy.nfl.models.RefreshTokenRequestTypedDict"
            

Attributes

client_key instance-attribute

client_key: str

Client application identifier key

client_secret instance-attribute

client_secret: str

Client application secret for authentication

device_id instance-attribute

device_id: str

Unique device identifier (UUID format)

device_info instance-attribute

device_info: str

Base64-encoded JSON containing device information such as:

network_type instance-attribute

network_type: RefreshTokenRequestNetworkType

Type of network connection

refresh_token instance-attribute

refresh_token: str

Valid refresh token from previous authentication

signature_timestamp instance-attribute

signature_timestamp: str

Unix timestamp for signature verification

uid instance-attribute

uid: str

User identifier hash

uid_signature instance-attribute

uid_signature: str

HMAC signature for request verification

TokenRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TokenRequest[TokenRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TokenRequest
                


              click griddy.nfl.models.TokenRequest href "" "griddy.nfl.models.TokenRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

client_key instance-attribute

client_key: Annotated[str, Field(alias='clientKey')]

Client application identifier key

client_secret instance-attribute

client_secret: Annotated[str, Field(alias='clientSecret')]

Client application secret for authentication

device_id instance-attribute

device_id: Annotated[str, Field(alias='deviceId')]

Unique device identifier (UUID format)

device_info instance-attribute

device_info: Annotated[str, Field(alias='deviceInfo')]

Base64-encoded JSON containing device information such as:

network_type instance-attribute

network_type: Annotated[
    TokenRequestNetworkType, Field(alias="networkType")
]

Type of network connection

TokenRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TokenRequestTypedDict[TokenRequestTypedDict]

              

              click griddy.nfl.models.TokenRequestTypedDict href "" "griddy.nfl.models.TokenRequestTypedDict"
            

Attributes

client_key instance-attribute

client_key: str

Client application identifier key

client_secret instance-attribute

client_secret: str

Client application secret for authentication

device_id instance-attribute

device_id: str

Unique device identifier (UUID format)

device_info instance-attribute

device_info: str

Base64-encoded JSON containing device information such as:

network_type instance-attribute

network_type: TokenRequestNetworkType

Type of network connection

BoxscoreResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.BoxscoreResponse[BoxscoreResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.BoxscoreResponse
                


              click griddy.nfl.models.BoxscoreResponse href "" "griddy.nfl.models.BoxscoreResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id class-attribute instance-attribute

game_id: Annotated[
    Optional[str],
    Field(alias="gameId"),
    BeforeValidator(int_to_str),
] = None

Game identifier

BoxscoreResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.BoxscoreResponseTypedDict[BoxscoreResponseTypedDict]

              

              click griddy.nfl.models.BoxscoreResponseTypedDict href "" "griddy.nfl.models.BoxscoreResponseTypedDict"
            

Attributes

game_id instance-attribute

game_id: NotRequired[str]

Game identifier

CombineProfilesResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.CombineProfilesResponse[CombineProfilesResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.CombineProfilesResponse
                


              click griddy.nfl.models.CombineProfilesResponse href "" "griddy.nfl.models.CombineProfilesResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

combine_profiles instance-attribute

combine_profiles: Annotated[
    List[CombineProfile], Field(alias=combineProfiles)
]

List of CombineProfile objects

pagination instance-attribute

pagination: Pagination

Pagination information object

CombineProfilesResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.CombineProfilesResponseTypedDict[CombineProfilesResponseTypedDict]

              

              click griddy.nfl.models.CombineProfilesResponseTypedDict href "" "griddy.nfl.models.CombineProfilesResponseTypedDict"
            

Attributes

combine_profiles instance-attribute

combine_profiles: List[CombineProfileTypedDict]

List of combine profiles

pagination instance-attribute

pagination: PaginationTypedDict

Pagination information

CombineRankingsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.CombineRankingsResponse[CombineRankingsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.CombineRankingsResponse
                


              click griddy.nfl.models.CombineRankingsResponse href "" "griddy.nfl.models.CombineRankingsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

combine_profiles instance-attribute

combine_profiles: Annotated[
    List[CombineProfile], Field(alias=combineProfiles)
]

List of CombineProfile objects

pagination instance-attribute

pagination: Pagination

Pagination information object

CombineRankingsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.CombineRankingsResponseTypedDict[CombineRankingsResponseTypedDict]

              

              click griddy.nfl.models.CombineRankingsResponseTypedDict href "" "griddy.nfl.models.CombineRankingsResponseTypedDict"
            

Attributes

combine_profiles instance-attribute

combine_profiles: List[CombineProfileTypedDict]

List of combine profiles

pagination instance-attribute

pagination: PaginationTypedDict

Pagination information

CurrentGamesResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.CurrentGamesResponse[CurrentGamesResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.CurrentGamesResponse
                


              click griddy.nfl.models.CurrentGamesResponse href "" "griddy.nfl.models.CurrentGamesResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

games_played_smart_ids class-attribute instance-attribute

games_played_smart_ids: Annotated[
    Optional[List[str]], Field(alias="gamesPlayedSmartIds")
] = None

Smart IDs of games already played

number_of_games class-attribute instance-attribute

number_of_games: Annotated[
    Optional[int], Field(alias="numberOfGames")
] = None

Total number of games in the week

number_of_games_played class-attribute instance-attribute

number_of_games_played: Annotated[
    Optional[int], Field(alias="numberOfGamesPlayed")
] = None

Number of games already played

season class-attribute instance-attribute

season: Optional[int] = None

Current season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

week class-attribute instance-attribute

week: Optional[int] = None

Current week number

CurrentGamesResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.CurrentGamesResponseTypedDict[CurrentGamesResponseTypedDict]

              

              click griddy.nfl.models.CurrentGamesResponseTypedDict href "" "griddy.nfl.models.CurrentGamesResponseTypedDict"
            

Attributes

games_played_smart_ids instance-attribute

games_played_smart_ids: NotRequired[List[str]]

Smart IDs of games already played

number_of_games instance-attribute

number_of_games: NotRequired[int]

Total number of games in the week

number_of_games_played instance-attribute

number_of_games_played: NotRequired[int]

Number of games already played

season instance-attribute

season: NotRequired[int]

Current season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

week instance-attribute

week: NotRequired[int]

Current week number

DefensiveOverviewStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.DefensiveOverviewStatsResponse[DefensiveOverviewStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.DefensiveOverviewStatsResponse
                


              click griddy.nfl.models.DefensiveOverviewStatsResponse href "" "griddy.nfl.models.DefensiveOverviewStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_defender class-attribute instance-attribute

qualified_defender: Annotated[
    Optional[bool], Field(alias="qualifiedDefender")
] = None

Whether results are filtered to qualified defenders only

team_defense class-attribute instance-attribute

team_defense: Annotated[
    Optional[str], Field(alias="teamDefense")
] = None

Team filter applied (if any)

DefensiveOverviewStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.DefensiveOverviewStatsResponseTypedDict[DefensiveOverviewStatsResponseTypedDict]

              

              click griddy.nfl.models.DefensiveOverviewStatsResponseTypedDict href "" "griddy.nfl.models.DefensiveOverviewStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_defender instance-attribute

qualified_defender: NotRequired[bool]

Whether results are filtered to qualified defenders only

team_defense instance-attribute

team_defense: NotRequired[str]

Team filter applied (if any)

FantasyStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.FantasyStatsResponse[FantasyStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.FantasyStatsResponse
                


              click griddy.nfl.models.FantasyStatsResponse href "" "griddy.nfl.models.FantasyStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

last_n_weeks class-attribute instance-attribute

last_n_weeks: Annotated[
    Optional[int], Field(alias="lastNWeeks")
] = None

Number of recent weeks analyzed (if applied)

min_offensive_snaps class-attribute instance-attribute

min_offensive_snaps: Annotated[
    Optional[int], Field(alias="minOffensiveSnaps")
] = None

Minimum offensive snaps filter applied

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[List[str]], Field(alias="positionGroup")
] = None

Position groups included in results

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[str], Field(alias="teamOffense")
] = None

Offensive team filter applied (if any)

week class-attribute instance-attribute

week: Optional[List[str]] = None

Specific weeks included in analysis

FantasyStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.FantasyStatsResponseTypedDict[FantasyStatsResponseTypedDict]

              

              click griddy.nfl.models.FantasyStatsResponseTypedDict href "" "griddy.nfl.models.FantasyStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

last_n_weeks instance-attribute

last_n_weeks: NotRequired[int]

Number of recent weeks analyzed (if applied)

min_offensive_snaps instance-attribute

min_offensive_snaps: NotRequired[int]

Minimum offensive snaps filter applied

position_group instance-attribute

position_group: NotRequired[List[str]]

Position groups included in results

team_offense instance-attribute

team_offense: NotRequired[str]

Offensive team filter applied (if any)

week instance-attribute

week: NotRequired[List[str]]

Specific weeks included in analysis

FilmroomPlaysResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.FilmroomPlaysResponse[FilmroomPlaysResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.FilmroomPlaysResponse
                


              click griddy.nfl.models.FilmroomPlaysResponse href "" "griddy.nfl.models.FilmroomPlaysResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

count instance-attribute

count: int

Total number of plays matching the filter criteria

plays instance-attribute

plays: List[FilmroomPlay]

Array of play data matching the filter criteria

FilmroomPlaysResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.FilmroomPlaysResponseTypedDict[FilmroomPlaysResponseTypedDict]

              

              click griddy.nfl.models.FilmroomPlaysResponseTypedDict href "" "griddy.nfl.models.FilmroomPlaysResponseTypedDict"
            

Attributes

count instance-attribute

count: int

Total number of plays matching the filter criteria

plays instance-attribute

plays: List[FilmroomPlayTypedDict]

Array of play data matching the filter criteria

FootballTeamsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.FootballTeamsResponseTypedDict[FootballTeamsResponseTypedDict]

              

              click griddy.nfl.models.FootballTeamsResponseTypedDict href "" "griddy.nfl.models.FootballTeamsResponseTypedDict"
            

Attributes

teams instance-attribute

teams: List[TeamTypedDict]

List of teams

pagination instance-attribute

pagination: PaginationTypedDict

Pagination information

GamePreviewResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GamePreviewResponse[GamePreviewResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GamePreviewResponse
                


              click griddy.nfl.models.GamePreviewResponse href "" "griddy.nfl.models.GamePreviewResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

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

Attributes

preview class-attribute instance-attribute

preview: OptionalNullable[Preview] = UNSET

Preview content and analysis

GamePreviewResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GamePreviewResponseTypedDict[GamePreviewResponseTypedDict]

              

              click griddy.nfl.models.GamePreviewResponseTypedDict href "" "griddy.nfl.models.GamePreviewResponseTypedDict"
            

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

Attributes

preview instance-attribute

preview: NotRequired[Nullable[PreviewTypedDict]]

Preview content and analysis

Preview

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Preview[Preview]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Preview
                


              click griddy.nfl.models.Preview href "" "griddy.nfl.models.Preview"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Preview content and analysis

PreviewTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PreviewTypedDict[PreviewTypedDict]

              

              click griddy.nfl.models.PreviewTypedDict href "" "griddy.nfl.models.PreviewTypedDict"
            

Preview content and analysis

GameStatsResponseData

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GameStatsResponseData[GameStatsResponseData]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GameStatsResponseData
                


              click griddy.nfl.models.GameStatsResponseData href "" "griddy.nfl.models.GameStatsResponseData"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Game statistics data

GameStatsResponseDataTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GameStatsResponseDataTypedDict[GameStatsResponseDataTypedDict]

              

              click griddy.nfl.models.GameStatsResponseDataTypedDict href "" "griddy.nfl.models.GameStatsResponseDataTypedDict"
            

Game statistics data

GamesResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GamesResponse[GamesResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GamesResponse
                


              click griddy.nfl.models.GamesResponse href "" "griddy.nfl.models.GamesResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season class-attribute instance-attribute

season: Optional[str] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

week class-attribute instance-attribute

week: Optional[str] = None

Week number

GamesResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GamesResponseTypedDict[GamesResponseTypedDict]

              

              click griddy.nfl.models.GamesResponseTypedDict href "" "griddy.nfl.models.GamesResponseTypedDict"
            

Attributes

season instance-attribute

season: NotRequired[str]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

week instance-attribute

week: NotRequired[str]

Week number

HomeFilmCardsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.HomeFilmCardsResponse[HomeFilmCardsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.HomeFilmCardsResponse
                


              click griddy.nfl.models.HomeFilmCardsResponse href "" "griddy.nfl.models.HomeFilmCardsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

title instance-attribute

title: str

Title of the film card collection

HomeFilmCardsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.HomeFilmCardsResponseTypedDict[HomeFilmCardsResponseTypedDict]

              

              click griddy.nfl.models.HomeFilmCardsResponseTypedDict href "" "griddy.nfl.models.HomeFilmCardsResponseTypedDict"
            

Attributes

title instance-attribute

title: str

Title of the film card collection

LiveScoresResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.LiveScoresResponse[LiveScoresResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.LiveScoresResponse
                


              click griddy.nfl.models.LiveScoresResponse href "" "griddy.nfl.models.LiveScoresResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

games instance-attribute

games: List[LiveGame]

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

season instance-attribute

season: str

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

week instance-attribute

week: str

Week number

LiveScoresResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.LiveScoresResponseTypedDict[LiveScoresResponseTypedDict]

              

              click griddy.nfl.models.LiveScoresResponseTypedDict href "" "griddy.nfl.models.LiveScoresResponseTypedDict"
            

Attributes

games instance-attribute

games: List[LiveGameTypedDict]

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

season instance-attribute

season: str

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

week instance-attribute

week: str

Week number

MatchupRankingsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.MatchupRankingsResponse[MatchupRankingsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.MatchupRankingsResponse
                


              click griddy.nfl.models.MatchupRankingsResponse href "" "griddy.nfl.models.MatchupRankingsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

home_team_matchup_rankings class-attribute instance-attribute

home_team_matchup_rankings: Annotated[
    Optional[TeamMatchupRankings],
    Field(alias="homeTeamMatchupRankings"),
] = None

Comprehensive team rankings across multiple statistical categories

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

visitor_team_matchup_rankings class-attribute instance-attribute

visitor_team_matchup_rankings: Annotated[
    Optional[TeamMatchupRankings],
    Field(alias="visitorTeamMatchupRankings"),
] = None

Comprehensive team rankings across multiple statistical categories

MatchupRankingsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.MatchupRankingsResponseTypedDict[MatchupRankingsResponseTypedDict]

              

              click griddy.nfl.models.MatchupRankingsResponseTypedDict href "" "griddy.nfl.models.MatchupRankingsResponseTypedDict"
            

Attributes

home_team_matchup_rankings instance-attribute

home_team_matchup_rankings: NotRequired[
    TeamMatchupRankingsTypedDict
]

Comprehensive team rankings across multiple statistical categories

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

visitor_team_matchup_rankings instance-attribute

visitor_team_matchup_rankings: NotRequired[
    TeamMatchupRankingsTypedDict
]

Comprehensive team rankings across multiple statistical categories

NearestDefenderStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NearestDefenderStatsResponse[NearestDefenderStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NearestDefenderStatsResponse
                


              click griddy.nfl.models.NearestDefenderStatsResponse href "" "griddy.nfl.models.NearestDefenderStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_defender class-attribute instance-attribute

qualified_defender: Annotated[
    Optional[bool], Field(alias="qualifiedDefender")
] = None

Whether results are filtered to qualified defenders only

NearestDefenderStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NearestDefenderStatsResponseTypedDict[NearestDefenderStatsResponseTypedDict]

              

              click griddy.nfl.models.NearestDefenderStatsResponseTypedDict href "" "griddy.nfl.models.NearestDefenderStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_defender instance-attribute

qualified_defender: NotRequired[bool]

Whether results are filtered to qualified defenders only

NgsChartPlayersResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsChartPlayersResponse[NgsChartPlayersResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsChartPlayersResponse
                


              click griddy.nfl.models.NgsChartPlayersResponse href "" "griddy.nfl.models.NgsChartPlayersResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS chart players endpoint.

NgsChartPlayersResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsChartPlayersResponseTypedDict[NgsChartPlayersResponseTypedDict]

              

              click griddy.nfl.models.NgsChartPlayersResponseTypedDict href "" "griddy.nfl.models.NgsChartPlayersResponseTypedDict"
            

Response from the NGS chart players endpoint.

NgsChartsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsChartsResponse[NgsChartsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsChartsResponse
                


              click griddy.nfl.models.NgsChartsResponse href "" "griddy.nfl.models.NgsChartsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS charts endpoint.

NgsChartsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsChartsResponseTypedDict[NgsChartsResponseTypedDict]

              

              click griddy.nfl.models.NgsChartsResponseTypedDict href "" "griddy.nfl.models.NgsChartsResponseTypedDict"
            

Response from the NGS charts endpoint.

NgsHighlightsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsHighlightsResponse[NgsHighlightsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsHighlightsResponse
                


              click griddy.nfl.models.NgsHighlightsResponse href "" "griddy.nfl.models.NgsHighlightsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS highlights endpoint.

NgsHighlightsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsHighlightsResponseTypedDict[NgsHighlightsResponseTypedDict]

              

              click griddy.nfl.models.NgsHighlightsResponseTypedDict href "" "griddy.nfl.models.NgsHighlightsResponseTypedDict"
            

Response from the NGS highlights endpoint.

NgsCurrentScheduleResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsCurrentScheduleResponse[NgsCurrentScheduleResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsCurrentScheduleResponse
                


              click griddy.nfl.models.NgsCurrentScheduleResponse href "" "griddy.nfl.models.NgsCurrentScheduleResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS current schedule endpoint.

Attributes

season class-attribute instance-attribute

season: Optional[int] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[str], Field(alias="seasonType")
] = None

Season type (REG, PRE, POST)

week class-attribute instance-attribute

week: Optional[int] = None

Current week number

games class-attribute instance-attribute

games: Optional[List[GameSchedule]] = None

List of games in the current week

NgsCurrentScheduleResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsCurrentScheduleResponseTypedDict[NgsCurrentScheduleResponseTypedDict]

              

              click griddy.nfl.models.NgsCurrentScheduleResponseTypedDict href "" "griddy.nfl.models.NgsCurrentScheduleResponseTypedDict"
            

Response from the NGS current schedule endpoint.

Attributes

season instance-attribute

season: NotRequired[int]

Season year

season_type instance-attribute

season_type: NotRequired[str]

Season type (REG, PRE, POST)

week instance-attribute

week: NotRequired[int]

Current week number

games instance-attribute

games: NotRequired[List[GameScheduleTypedDict]]

List of games in the current week

NgsGameCenterOverviewResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsGameCenterOverviewResponse[NgsGameCenterOverviewResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsGameCenterOverviewResponse
                


              click griddy.nfl.models.NgsGameCenterOverviewResponse href "" "griddy.nfl.models.NgsGameCenterOverviewResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS game center overview endpoint.

NgsGameCenterOverviewResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsGameCenterOverviewResponseTypedDict[NgsGameCenterOverviewResponseTypedDict]

              

              click griddy.nfl.models.NgsGameCenterOverviewResponseTypedDict href "" "griddy.nfl.models.NgsGameCenterOverviewResponseTypedDict"
            

Response from the NGS game center overview endpoint.

NgsCompletionLeadersResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsCompletionLeadersResponse[NgsCompletionLeadersResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsCompletionLeadersResponse
                


              click griddy.nfl.models.NgsCompletionLeadersResponse href "" "griddy.nfl.models.NgsCompletionLeadersResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS improbable completions endpoint.

NgsCompletionLeadersResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsCompletionLeadersResponseTypedDict[NgsCompletionLeadersResponseTypedDict]

              

              click griddy.nfl.models.NgsCompletionLeadersResponseTypedDict href "" "griddy.nfl.models.NgsCompletionLeadersResponseTypedDict"
            

Response from the NGS improbable completions endpoint.

NgsDistanceLeadersResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsDistanceLeadersResponse[NgsDistanceLeadersResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsDistanceLeadersResponse
                


              click griddy.nfl.models.NgsDistanceLeadersResponse href "" "griddy.nfl.models.NgsDistanceLeadersResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS longest plays endpoint.

NgsDistanceLeadersResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsDistanceLeadersResponseTypedDict[NgsDistanceLeadersResponseTypedDict]

              

              click griddy.nfl.models.NgsDistanceLeadersResponseTypedDict href "" "griddy.nfl.models.NgsDistanceLeadersResponseTypedDict"
            

Response from the NGS longest plays endpoint.

NgsERYLeadersResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsERYLeadersResponse[NgsERYLeadersResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsERYLeadersResponse
                


              click griddy.nfl.models.NgsERYLeadersResponse href "" "griddy.nfl.models.NgsERYLeadersResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS remarkable rushes endpoint.

NgsERYLeadersResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsERYLeadersResponseTypedDict[NgsERYLeadersResponseTypedDict]

              

              click griddy.nfl.models.NgsERYLeadersResponseTypedDict href "" "griddy.nfl.models.NgsERYLeadersResponseTypedDict"
            

Response from the NGS remarkable rushes endpoint.

NgsSackLeadersResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsSackLeadersResponse[NgsSackLeadersResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsSackLeadersResponse
                


              click griddy.nfl.models.NgsSackLeadersResponse href "" "griddy.nfl.models.NgsSackLeadersResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS fastest sacks endpoint.

NgsSackLeadersResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsSackLeadersResponseTypedDict[NgsSackLeadersResponseTypedDict]

              

              click griddy.nfl.models.NgsSackLeadersResponseTypedDict href "" "griddy.nfl.models.NgsSackLeadersResponseTypedDict"
            

Response from the NGS fastest sacks endpoint.

NgsSpeedLeadersResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsSpeedLeadersResponse[NgsSpeedLeadersResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsSpeedLeadersResponse
                


              click griddy.nfl.models.NgsSpeedLeadersResponse href "" "griddy.nfl.models.NgsSpeedLeadersResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS fastest ball carriers endpoint.

NgsSpeedLeadersResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsSpeedLeadersResponseTypedDict[NgsSpeedLeadersResponseTypedDict]

              

              click griddy.nfl.models.NgsSpeedLeadersResponseTypedDict href "" "griddy.nfl.models.NgsSpeedLeadersResponseTypedDict"
            

Response from the NGS fastest ball carriers endpoint.

NgsTackleLeadersResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsTackleLeadersResponse[NgsTackleLeadersResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsTackleLeadersResponse
                


              click griddy.nfl.models.NgsTackleLeadersResponse href "" "griddy.nfl.models.NgsTackleLeadersResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS longest tackles endpoint.

NgsTackleLeadersResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsTackleLeadersResponseTypedDict[NgsTackleLeadersResponseTypedDict]

              

              click griddy.nfl.models.NgsTackleLeadersResponseTypedDict href "" "griddy.nfl.models.NgsTackleLeadersResponseTypedDict"
            

Response from the NGS longest tackles endpoint.

NgsYACLeadersResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsYACLeadersResponse[NgsYACLeadersResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsYACLeadersResponse
                


              click griddy.nfl.models.NgsYACLeadersResponse href "" "griddy.nfl.models.NgsYACLeadersResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS incredible YAC endpoint.

NgsYACLeadersResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsYACLeadersResponseTypedDict[NgsYACLeadersResponseTypedDict]

              

              click griddy.nfl.models.NgsYACLeadersResponseTypedDict href "" "griddy.nfl.models.NgsYACLeadersResponseTypedDict"
            

Response from the NGS incredible YAC endpoint.

NgsGameScoreDetail

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsGameScoreDetail[NgsGameScoreDetail]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsGameScoreDetail
                


              click griddy.nfl.models.NgsGameScoreDetail href "" "griddy.nfl.models.NgsGameScoreDetail"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Detailed score information for a game.

NgsGameScoreDetailTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsGameScoreDetailTypedDict[NgsGameScoreDetailTypedDict]

              

              click griddy.nfl.models.NgsGameScoreDetailTypedDict href "" "griddy.nfl.models.NgsGameScoreDetailTypedDict"
            

Detailed score information for a game.

NgsLiveGameScore

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsLiveGameScore[NgsLiveGameScore]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsLiveGameScore
                


              click griddy.nfl.models.NgsLiveGameScore href "" "griddy.nfl.models.NgsLiveGameScore"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

A single game score entry in the live scores response.

NgsLiveGameScoreTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsLiveGameScoreTypedDict[NgsLiveGameScoreTypedDict]

              

              click griddy.nfl.models.NgsLiveGameScoreTypedDict href "" "griddy.nfl.models.NgsLiveGameScoreTypedDict"
            

A single game score entry in the live scores response.

NgsLiveScoresResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsLiveScoresResponse[NgsLiveScoresResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsLiveScoresResponse
                


              click griddy.nfl.models.NgsLiveScoresResponse href "" "griddy.nfl.models.NgsLiveScoresResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS live scores endpoint.

NgsLiveScoresResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsLiveScoresResponseTypedDict[NgsLiveScoresResponseTypedDict]

              

              click griddy.nfl.models.NgsLiveScoresResponseTypedDict href "" "griddy.nfl.models.NgsLiveScoresResponseTypedDict"
            

Response from the NGS live scores endpoint.

NgsTeamInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsTeamInfo[NgsTeamInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsTeamInfo
                


              click griddy.nfl.models.NgsTeamInfo href "" "griddy.nfl.models.NgsTeamInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Team information in NGS responses.

NgsTeamInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsTeamInfoTypedDict[NgsTeamInfoTypedDict]

              

              click griddy.nfl.models.NgsTeamInfoTypedDict href "" "griddy.nfl.models.NgsTeamInfoTypedDict"
            

Team information in NGS responses.

NgsTeamScore

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsTeamScore[NgsTeamScore]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsTeamScore
                


              click griddy.nfl.models.NgsTeamScore href "" "griddy.nfl.models.NgsTeamScore"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Score breakdown by quarter for a team.

NgsTeamScoreTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsTeamScoreTypedDict[NgsTeamScoreTypedDict]

              

              click griddy.nfl.models.NgsTeamScoreTypedDict href "" "griddy.nfl.models.NgsTeamScoreTypedDict"
            

Score breakdown by quarter for a team.

NgsArticlesResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsArticlesResponse[NgsArticlesResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsArticlesResponse
                


              click griddy.nfl.models.NgsArticlesResponse href "" "griddy.nfl.models.NgsArticlesResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS articles endpoint.

NgsArticlesResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsArticlesResponseTypedDict[NgsArticlesResponseTypedDict]

              

              click griddy.nfl.models.NgsArticlesResponseTypedDict href "" "griddy.nfl.models.NgsArticlesResponseTypedDict"
            

Response from the NGS articles endpoint.

NgsMixedContentResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsMixedContentResponse[NgsMixedContentResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsMixedContentResponse
                


              click griddy.nfl.models.NgsMixedContentResponse href "" "griddy.nfl.models.NgsMixedContentResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS mixed content endpoint.

NgsMixedContentResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsMixedContentResponseTypedDict[NgsMixedContentResponseTypedDict]

              

              click griddy.nfl.models.NgsMixedContentResponseTypedDict href "" "griddy.nfl.models.NgsMixedContentResponseTypedDict"
            

Response from the NGS mixed content endpoint.

NgsVideosResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsVideosResponse[NgsVideosResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsVideosResponse
                


              click griddy.nfl.models.NgsVideosResponse href "" "griddy.nfl.models.NgsVideosResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS videos endpoint.

NgsVideosResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsVideosResponseTypedDict[NgsVideosResponseTypedDict]

              

              click griddy.nfl.models.NgsVideosResponseTypedDict href "" "griddy.nfl.models.NgsVideosResponseTypedDict"
            

Response from the NGS videos endpoint.

NgsPassingStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsPassingStatsResponse[NgsPassingStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsPassingStatsResponse
                


              click griddy.nfl.models.NgsPassingStatsResponse href "" "griddy.nfl.models.NgsPassingStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS passing stats endpoint.

NgsPassingStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsPassingStatsResponseTypedDict[NgsPassingStatsResponseTypedDict]

              

              click griddy.nfl.models.NgsPassingStatsResponseTypedDict href "" "griddy.nfl.models.NgsPassingStatsResponseTypedDict"
            

Response from the NGS passing stats endpoint.

NgsReceivingStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsReceivingStatsResponse[NgsReceivingStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsReceivingStatsResponse
                


              click griddy.nfl.models.NgsReceivingStatsResponse href "" "griddy.nfl.models.NgsReceivingStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS receiving stats endpoint.

NgsReceivingStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsReceivingStatsResponseTypedDict[NgsReceivingStatsResponseTypedDict]

              

              click griddy.nfl.models.NgsReceivingStatsResponseTypedDict href "" "griddy.nfl.models.NgsReceivingStatsResponseTypedDict"
            

Response from the NGS receiving stats endpoint.

NgsRushingStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.NgsRushingStatsResponse[NgsRushingStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.NgsRushingStatsResponse
                


              click griddy.nfl.models.NgsRushingStatsResponse href "" "griddy.nfl.models.NgsRushingStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Response from the NGS rushing stats endpoint.

NgsRushingStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.NgsRushingStatsResponseTypedDict[NgsRushingStatsResponseTypedDict]

              

              click griddy.nfl.models.NgsRushingStatsResponseTypedDict href "" "griddy.nfl.models.NgsRushingStatsResponseTypedDict"
            

Response from the NGS rushing stats endpoint.

PassRushStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PassRushStatsResponse[PassRushStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PassRushStatsResponse
                


              click griddy.nfl.models.PassRushStatsResponse href "" "griddy.nfl.models.PassRushStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_defender class-attribute instance-attribute

qualified_defender: Annotated[
    Optional[bool], Field(alias="qualifiedDefender")
] = None

Whether results are filtered to qualified defenders only

PassRushStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PassRushStatsResponseTypedDict[PassRushStatsResponseTypedDict]

              

              click griddy.nfl.models.PassRushStatsResponseTypedDict href "" "griddy.nfl.models.PassRushStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_defender instance-attribute

qualified_defender: NotRequired[bool]

Whether results are filtered to qualified defenders only

PassingStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PassingStatsResponse[PassingStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PassingStatsResponse
                


              click griddy.nfl.models.PassingStatsResponse href "" "griddy.nfl.models.PassingStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_passer class-attribute instance-attribute

qualified_passer: Annotated[
    Optional[bool], Field(alias="qualifiedPasser")
] = None

Whether results are filtered to qualified passers only

PassingStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PassingStatsResponseTypedDict[PassingStatsResponseTypedDict]

              

              click griddy.nfl.models.PassingStatsResponseTypedDict href "" "griddy.nfl.models.PassingStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_passer instance-attribute

qualified_passer: NotRequired[bool]

Whether results are filtered to qualified passers only

PlaySummaryResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlaySummaryResponse[PlaySummaryResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlaySummaryResponse
                


              click griddy.nfl.models.PlaySummaryResponse href "" "griddy.nfl.models.PlaySummaryResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[int, Field(alias='gameId')]

Game identifier in integer format

play_id instance-attribute

play_id: Annotated[int, Field(alias='playId')]

Play identifier

away class-attribute instance-attribute

away: Optional[List[PlayPlayer]] = None

Away team players involved in the play

game_key class-attribute instance-attribute

game_key: Annotated[
    Optional[int], Field(alias="gameKey")
] = None

Unique game key

gsis_play_id class-attribute instance-attribute

gsis_play_id: Annotated[
    Optional[int], Field(alias="gsisPlayId")
] = None

GSIS play identifier

home class-attribute instance-attribute

home: Optional[List[PlayPlayer]] = None

Home team players involved in the play

home_is_offense class-attribute instance-attribute

home_is_offense: Annotated[
    Optional[bool], Field(alias="homeIsOffense")
] = None

Whether home team has offensive possession

PlaySummaryResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlaySummaryResponseTypedDict[PlaySummaryResponseTypedDict]

              

              click griddy.nfl.models.PlaySummaryResponseTypedDict href "" "griddy.nfl.models.PlaySummaryResponseTypedDict"
            

Attributes

game_id instance-attribute

game_id: int

Game identifier in integer format

play_id instance-attribute

play_id: int

Play identifier

away instance-attribute

away: NotRequired[List[PlayPlayerTypedDict]]

Away team players involved in the play

game_key instance-attribute

game_key: NotRequired[int]

Unique game key

gsis_play_id instance-attribute

gsis_play_id: NotRequired[int]

GSIS play identifier

home instance-attribute

home: NotRequired[List[PlayPlayerTypedDict]]

Home team players involved in the play

home_is_offense instance-attribute

home_is_offense: NotRequired[bool]

Whether home team has offensive possession

PlayWinProbabilityResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayWinProbabilityResponseTypedDict[PlayWinProbabilityResponseTypedDict]

              

              click griddy.nfl.models.PlayWinProbabilityResponseTypedDict href "" "griddy.nfl.models.PlayWinProbabilityResponseTypedDict"
            

Attributes

game_id instance-attribute

game_id: str

Ten digit game ID

game_key instance-attribute

game_key: int

Another ID looking value, not sure what it is.

pregame_away_team_win_probability instance-attribute

pregame_away_team_win_probability: float

As determined before kickoff, the probability (0 < p < 1), the away team wins

pregame_home_team_wint_probability instance-attribute

pregame_home_team_wint_probability: float

As determined before kickoff, the probability (0 < p < 1), the home team wins

PlayerSearchResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerSearchResponse[PlayerSearchResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerSearchResponse
                


              click griddy.nfl.models.PlayerSearchResponse href "" "griddy.nfl.models.PlayerSearchResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

players instance-attribute

players: List[PlayerSearchResult]

Array of players matching search criteria

term instance-attribute

term: str

Search term used

PlayerSearchResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerSearchResponseTypedDict[PlayerSearchResponseTypedDict]

              

              click griddy.nfl.models.PlayerSearchResponseTypedDict href "" "griddy.nfl.models.PlayerSearchResponseTypedDict"
            

Attributes

players instance-attribute

players: List[PlayerSearchResultTypedDict]

Array of players matching search criteria

term instance-attribute

term: str

Search term used

PlayerStatsResponsePlayer

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerStatsResponsePlayer[PlayerStatsResponsePlayer]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerStatsResponsePlayer
                


              click griddy.nfl.models.PlayerStatsResponsePlayer href "" "griddy.nfl.models.PlayerStatsResponsePlayer"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

stats class-attribute instance-attribute

stats: Optional[PlayerStatsResponseStats] = None

Statistics object varies by category

PlayerStatsResponsePlayerTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerStatsResponsePlayerTypedDict[PlayerStatsResponsePlayerTypedDict]

              

              click griddy.nfl.models.PlayerStatsResponsePlayerTypedDict href "" "griddy.nfl.models.PlayerStatsResponsePlayerTypedDict"
            

Attributes

stats instance-attribute

stats: NotRequired[PlayerStatsResponseStatsTypedDict]

Statistics object varies by category

PlayerStatsResponseStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerStatsResponseStats[PlayerStatsResponseStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerStatsResponseStats
                


              click griddy.nfl.models.PlayerStatsResponseStats href "" "griddy.nfl.models.PlayerStatsResponseStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Statistics object varies by category

PlayerStatsResponseStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerStatsResponseStatsTypedDict[PlayerStatsResponseStatsTypedDict]

              

              click griddy.nfl.models.PlayerStatsResponseStatsTypedDict href "" "griddy.nfl.models.PlayerStatsResponseStatsTypedDict"
            

Statistics object varies by category

PlaylistResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlaylistResponseTypedDict[PlaylistResponseTypedDict]

              

              click griddy.nfl.models.PlaylistResponseTypedDict href "" "griddy.nfl.models.PlaylistResponseTypedDict"
            

Attributes

game_id instance-attribute

game_id: str

Ten digit game ID

game_key instance-attribute

game_key: int

Another ID looking value, not sure what it is.

Page

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Page[Page]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Page
                


              click griddy.nfl.models.Page href "" "griddy.nfl.models.Page"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

number class-attribute instance-attribute

number: Optional[int] = None

Current page number

size class-attribute instance-attribute

size: Optional[int] = None

Page size

PageTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PageTypedDict[PageTypedDict]

              

              click griddy.nfl.models.PageTypedDict href "" "griddy.nfl.models.PageTypedDict"
            

Attributes

number instance-attribute

number: NotRequired[int]

Current page number

size instance-attribute

size: NotRequired[int]

Page size

ProjectedStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ProjectedStatsResponse[ProjectedStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ProjectedStatsResponse
                


              click griddy.nfl.models.ProjectedStatsResponse href "" "griddy.nfl.models.ProjectedStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

JSON:API formatted response for projected statistics

Attributes

data instance-attribute

data: List[PlayerProjection]

Primary player data with relationships

included instance-attribute

included: List[Included]

Related data included in response

ProjectedStatsResponsePagination

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ProjectedStatsResponsePagination[ProjectedStatsResponsePagination]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ProjectedStatsResponsePagination
                


              click griddy.nfl.models.ProjectedStatsResponsePagination href "" "griddy.nfl.models.ProjectedStatsResponsePagination"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

token class-attribute instance-attribute

token: Optional[str] = None

Token for next page of results

ProjectedStatsResponsePaginationTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ProjectedStatsResponsePaginationTypedDict[ProjectedStatsResponsePaginationTypedDict]

              

              click griddy.nfl.models.ProjectedStatsResponsePaginationTypedDict href "" "griddy.nfl.models.ProjectedStatsResponsePaginationTypedDict"
            

Attributes

token instance-attribute

token: NotRequired[str]

Token for next page of results

ProjectedStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ProjectedStatsResponseTypedDict[ProjectedStatsResponseTypedDict]

              

              click griddy.nfl.models.ProjectedStatsResponseTypedDict href "" "griddy.nfl.models.ProjectedStatsResponseTypedDict"
            

JSON:API formatted response for projected statistics

Attributes

data instance-attribute

data: List[PlayerProjectionTypedDict]

Primary player data with relationships

included instance-attribute

included: List[IncludedTypedDict]

Related data included in response

ReceivingStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ReceivingStatsResponse[ReceivingStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ReceivingStatsResponse
                


              click griddy.nfl.models.ReceivingStatsResponse href "" "griddy.nfl.models.ReceivingStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_receiver class-attribute instance-attribute

qualified_receiver: Annotated[
    Optional[bool], Field(alias="qualifiedReceiver")
] = None

Whether results are filtered to qualified receivers only

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[str], Field(alias="teamOffense")
] = None

Team filter applied (if any)

week class-attribute instance-attribute

week: Optional[str] = None

Week identifier

ReceivingStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ReceivingStatsResponseTypedDict[ReceivingStatsResponseTypedDict]

              

              click griddy.nfl.models.ReceivingStatsResponseTypedDict href "" "griddy.nfl.models.ReceivingStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_receiver instance-attribute

qualified_receiver: NotRequired[bool]

Whether results are filtered to qualified receivers only

team_offense instance-attribute

team_offense: NotRequired[str]

Team filter applied (if any)

week instance-attribute

week: NotRequired[str]

Week identifier

RushingStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.RushingStatsResponse[RushingStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.RushingStatsResponse
                


              click griddy.nfl.models.RushingStatsResponse href "" "griddy.nfl.models.RushingStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_rusher class-attribute instance-attribute

qualified_rusher: Annotated[
    Optional[bool], Field(alias="qualifiedRusher")
] = None

Whether results are filtered to qualified rushers only

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[str], Field(alias="teamOffense")
] = None

Team filter applied (if any)

RushingStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.RushingStatsResponseTypedDict[RushingStatsResponseTypedDict]

              

              click griddy.nfl.models.RushingStatsResponseTypedDict href "" "griddy.nfl.models.RushingStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

qualified_rusher instance-attribute

qualified_rusher: NotRequired[bool]

Whether results are filtered to qualified rushers only

team_offense instance-attribute

team_offense: NotRequired[str]

Team filter applied (if any)

SeasonWeeksResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.SeasonWeeksResponse[SeasonWeeksResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.SeasonWeeksResponse
                


              click griddy.nfl.models.SeasonWeeksResponse href "" "griddy.nfl.models.SeasonWeeksResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season class-attribute instance-attribute

season: Optional[str] = None

Season year

SeasonWeeksResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.SeasonWeeksResponseTypedDict[SeasonWeeksResponseTypedDict]

              

              click griddy.nfl.models.SeasonWeeksResponseTypedDict href "" "griddy.nfl.models.SeasonWeeksResponseTypedDict"
            

Attributes

season instance-attribute

season: NotRequired[str]

Season year

StandingsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.StandingsResponse[StandingsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.StandingsResponse
                


              click griddy.nfl.models.StandingsResponse href "" "griddy.nfl.models.StandingsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

week class-attribute instance-attribute

week: Optional[int] = None

Current week for standings

StandingsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.StandingsResponseTypedDict[StandingsResponseTypedDict]

              

              click griddy.nfl.models.StandingsResponseTypedDict href "" "griddy.nfl.models.StandingsResponseTypedDict"
            

Attributes

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

week instance-attribute

week: NotRequired[int]

Current week for standings

TeamDefensePassStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamDefensePassStatsResponse[TeamDefensePassStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamDefensePassStatsResponse
                


              click griddy.nfl.models.TeamDefensePassStatsResponse href "" "griddy.nfl.models.TeamDefensePassStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of teams matching the criteria

TeamDefensePassStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamDefensePassStatsResponseTypedDict[TeamDefensePassStatsResponseTypedDict]

              

              click griddy.nfl.models.TeamDefensePassStatsResponseTypedDict href "" "griddy.nfl.models.TeamDefensePassStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of teams matching the criteria

TeamDefenseRushStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamDefenseRushStatsResponse[TeamDefenseRushStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamDefenseRushStatsResponse
                


              click griddy.nfl.models.TeamDefenseRushStatsResponse href "" "griddy.nfl.models.TeamDefenseRushStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of teams matching the criteria

TeamDefenseRushStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamDefenseRushStatsResponseTypedDict[TeamDefenseRushStatsResponseTypedDict]

              

              click griddy.nfl.models.TeamDefenseRushStatsResponseTypedDict href "" "griddy.nfl.models.TeamDefenseRushStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of teams matching the criteria

TeamDefenseStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamDefenseStatsResponse[TeamDefenseStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamDefenseStatsResponse
                


              click griddy.nfl.models.TeamDefenseStatsResponse href "" "griddy.nfl.models.TeamDefenseStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of teams matching the criteria

split class-attribute instance-attribute

split: Optional[List[str]] = None

Applied defensive situation splits

TeamDefenseStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamDefenseStatsResponseTypedDict[TeamDefenseStatsResponseTypedDict]

              

              click griddy.nfl.models.TeamDefenseStatsResponseTypedDict href "" "griddy.nfl.models.TeamDefenseStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of teams matching the criteria

split instance-attribute

split: NotRequired[List[str]]

Applied defensive situation splits

TeamNeedsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamNeedsResponse[TeamNeedsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamNeedsResponse
                


              click griddy.nfl.models.TeamNeedsResponse href "" "griddy.nfl.models.TeamNeedsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

teams instance-attribute

teams: List[TeamNeeds]

List of teams along with their needs analysis

pagination instance-attribute

pagination: Optional[Pagination]

Pagination information

TeamNeedsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamNeedsResponseTypedDict[TeamNeedsResponseTypedDict]

              

              click griddy.nfl.models.TeamNeedsResponseTypedDict href "" "griddy.nfl.models.TeamNeedsResponseTypedDict"
            

Attributes

teams instance-attribute

teams: List[TeamNeedsTypedDict]

List of teams along with their needs analysis

pagination instance-attribute

pagination: NotRequired[PaginationTypedDict]

Pagination information

TeamOffenseStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamOffenseStatsResponse[TeamOffenseStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamOffenseStatsResponse
                


              click griddy.nfl.models.TeamOffenseStatsResponse href "" "griddy.nfl.models.TeamOffenseStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of teams matching the criteria

split class-attribute instance-attribute

split: Optional[List[str]] = None

Applied offensive situation splits

team_defense class-attribute instance-attribute

team_defense: Annotated[
    Optional[str], Field(alias="teamDefense")
] = None

Team filter applied (if any)

TeamOffenseStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamOffenseStatsResponseTypedDict[TeamOffenseStatsResponseTypedDict]

              

              click griddy.nfl.models.TeamOffenseStatsResponseTypedDict href "" "griddy.nfl.models.TeamOffenseStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of teams matching the criteria

split instance-attribute

split: NotRequired[List[str]]

Applied offensive situation splits

team_defense instance-attribute

team_defense: NotRequired[str]

Team filter applied (if any)

TeamOffensePassStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamOffensePassStatsResponse[TeamOffensePassStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamOffensePassStatsResponse
                


              click griddy.nfl.models.TeamOffensePassStatsResponse href "" "griddy.nfl.models.TeamOffensePassStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of teams matching the criteria

team_defense class-attribute instance-attribute

team_defense: Annotated[
    Optional[str], Field(alias="teamDefense")
] = None

Applied team filter (if any)

TeamOffensePassStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamOffensePassStatsResponseTypedDict[TeamOffensePassStatsResponseTypedDict]

              

              click griddy.nfl.models.TeamOffensePassStatsResponseTypedDict href "" "griddy.nfl.models.TeamOffensePassStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of teams matching the criteria

team_defense instance-attribute

team_defense: NotRequired[str]

Applied team filter (if any)

TeamOffenseRushStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamOffenseRushStatsResponse[TeamOffenseRushStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamOffenseRushStatsResponse
                


              click griddy.nfl.models.TeamOffenseRushStatsResponse href "" "griddy.nfl.models.TeamOffenseRushStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used to sort results

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for results

total instance-attribute

total: int

Number of records matching criteria

TeamOffenseRushStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamOffenseRushStatsResponseTypedDict[TeamOffenseRushStatsResponseTypedDict]

              

              click griddy.nfl.models.TeamOffenseRushStatsResponseTypedDict href "" "griddy.nfl.models.TeamOffenseRushStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used to sort results

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for results

total instance-attribute

total: int

Number of records matching criteria

TeamRosterResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamRosterResponse[TeamRosterResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamRosterResponse
                


              click griddy.nfl.models.TeamRosterResponse href "" "griddy.nfl.models.TeamRosterResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season class-attribute instance-attribute

season: Optional[int] = None

Season year

team class-attribute instance-attribute

team: Optional[TeamInfo] = None

Basic team information included in roster responses

TeamRosterResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamRosterResponseTypedDict[TeamRosterResponseTypedDict]

              

              click griddy.nfl.models.TeamRosterResponseTypedDict href "" "griddy.nfl.models.TeamRosterResponseTypedDict"
            

Attributes

season instance-attribute

season: NotRequired[int]

Season year

team instance-attribute

team: NotRequired[TeamInfoTypedDict]

Basic team information included in roster responses

TokenResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TokenResponse[TokenResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TokenResponse
                


              click griddy.nfl.models.TokenResponse href "" "griddy.nfl.models.TokenResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

access_token instance-attribute

access_token: Annotated[str, Field(alias='accessToken')]

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: Annotated[int, Field(alias='expiresIn')]

Unix timestamp when the access token expires

refresh_token instance-attribute

refresh_token: Annotated[str, Field(alias='refreshToken')]

New refresh token for future token refresh requests

TokenResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TokenResponseTypedDict[TokenResponseTypedDict]

              

              click griddy.nfl.models.TokenResponseTypedDict href "" "griddy.nfl.models.TokenResponseTypedDict"
            

Attributes

access_token instance-attribute

access_token: str

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: int

Unix timestamp when the access token expires

refresh_token instance-attribute

refresh_token: str

New refresh token for future token refresh requests

WeeklyOddsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WeeklyOddsResponse[WeeklyOddsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WeeklyOddsResponse
                


              click griddy.nfl.models.WeeklyOddsResponse href "" "griddy.nfl.models.WeeklyOddsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season class-attribute instance-attribute

season: Optional[str] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

week class-attribute instance-attribute

week: Optional[str] = None

Week number

WeeklyOddsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeeklyOddsResponseTypedDict[WeeklyOddsResponseTypedDict]

              

              click griddy.nfl.models.WeeklyOddsResponseTypedDict href "" "griddy.nfl.models.WeeklyOddsResponseTypedDict"
            

Attributes

season instance-attribute

season: NotRequired[str]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

week instance-attribute

week: NotRequired[str]

Week number

WeeklyPassingStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WeeklyPassingStatsResponse[WeeklyPassingStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WeeklyPassingStatsResponse
                


              click griddy.nfl.models.WeeklyPassingStatsResponse href "" "griddy.nfl.models.WeeklyPassingStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

week instance-attribute

week: str

Week identifier

qualified_passer class-attribute instance-attribute

qualified_passer: Annotated[
    Optional[bool], Field(alias="qualifiedPasser")
] = None

Whether results are filtered to qualified passers only

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[str], Field(alias="teamOffense")
] = None

Team filter applied (if any)

WeeklyPassingStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeeklyPassingStatsResponseTypedDict[WeeklyPassingStatsResponseTypedDict]

              

              click griddy.nfl.models.WeeklyPassingStatsResponseTypedDict href "" "griddy.nfl.models.WeeklyPassingStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

week instance-attribute

week: str

Week identifier

qualified_passer instance-attribute

qualified_passer: NotRequired[bool]

Whether results are filtered to qualified passers only

team_offense instance-attribute

team_offense: NotRequired[str]

Team filter applied (if any)

WeeklyRosterResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WeeklyRosterResponse[WeeklyRosterResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WeeklyRosterResponse
                


              click griddy.nfl.models.WeeklyRosterResponse href "" "griddy.nfl.models.WeeklyRosterResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season class-attribute instance-attribute

season: Optional[int] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

team class-attribute instance-attribute

team: Optional[TeamInfo] = None

Basic team information included in roster responses

week class-attribute instance-attribute

week: Optional[int] = None

Week number

WeeklyRosterResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeeklyRosterResponseTypedDict[WeeklyRosterResponseTypedDict]

              

              click griddy.nfl.models.WeeklyRosterResponseTypedDict href "" "griddy.nfl.models.WeeklyRosterResponseTypedDict"
            

Attributes

season instance-attribute

season: NotRequired[int]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

team instance-attribute

team: NotRequired[TeamInfoTypedDict]

Basic team information included in roster responses

week instance-attribute

week: NotRequired[int]

Week number

WeeklyRushingStatsResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WeeklyRushingStatsResponse[WeeklyRushingStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WeeklyRushingStatsResponse
                


              click griddy.nfl.models.WeeklyRushingStatsResponse href "" "griddy.nfl.models.WeeklyRushingStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key class-attribute instance-attribute

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value class-attribute instance-attribute

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

week instance-attribute

week: str

Week identifier

qualified_rusher class-attribute instance-attribute

qualified_rusher: Annotated[
    Optional[bool], Field(alias="qualifiedRusher")
] = None

Whether results are filtered to qualified rushers only

team_offense class-attribute instance-attribute

team_offense: Annotated[
    Optional[str], Field(alias="teamOffense")
] = None

Team filter applied (if any)

WeeklyRushingStatsResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeeklyRushingStatsResponseTypedDict[WeeklyRushingStatsResponseTypedDict]

              

              click griddy.nfl.models.WeeklyRushingStatsResponseTypedDict href "" "griddy.nfl.models.WeeklyRushingStatsResponseTypedDict"
            

Attributes

limit instance-attribute

limit: int

Maximum number of results returned

offset instance-attribute

offset: int

Number of records skipped

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sort_key instance-attribute

sort_key: NotRequired[str]

Field used for sorting

sort_value instance-attribute

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total instance-attribute

total: int

Total number of players matching the criteria

week instance-attribute

week: str

Week identifier

qualified_rusher instance-attribute

qualified_rusher: NotRequired[bool]

Whether results are filtered to qualified rushers only

team_offense instance-attribute

team_offense: NotRequired[str]

Team filter applied (if any)

WinProbabilityResponse

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WinProbabilityResponse[WinProbabilityResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WinProbabilityResponse
                


              click griddy.nfl.models.WinProbabilityResponse href "" "griddy.nfl.models.WinProbabilityResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id instance-attribute

game_id: Annotated[int, Field(alias='gameId')]

Game identifier (10-digit format YYYYMMDDNN)

game_key instance-attribute

game_key: Annotated[int, Field(alias='gameKey')]

Unique game key identifier

plays instance-attribute

plays: List[PlayWinProbability]

Chronological list of all plays with win probability data

pregame_away_team_win_probability instance-attribute

pregame_away_team_win_probability: Annotated[
    float, Field(alias="pregameAwayTeamWinProbability")
]

Away team's win probability before the game started

pregame_home_team_win_probability instance-attribute

pregame_home_team_win_probability: Annotated[
    float, Field(alias="pregameHomeTeamWinProbability")
]

Home team's win probability before the game started

WinProbabilityResponseTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WinProbabilityResponseTypedDict[WinProbabilityResponseTypedDict]

              

              click griddy.nfl.models.WinProbabilityResponseTypedDict href "" "griddy.nfl.models.WinProbabilityResponseTypedDict"
            

Attributes

game_id instance-attribute

game_id: int

Game identifier (10-digit format YYYYMMDDNN)

game_key instance-attribute

game_key: int

Unique game key identifier

plays instance-attribute

plays: List[PlayWinProbabilityTypedDict]

Chronological list of all plays with win probability data

pregame_away_team_win_probability instance-attribute

pregame_away_team_win_probability: float

Away team's win probability before the game started

pregame_home_team_win_probability instance-attribute

pregame_home_team_win_probability: float

Home team's win probability before the game started

BoxscoreSchedule

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.BoxscoreSchedule[BoxscoreSchedule]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.BoxscoreSchedule
                


              click griddy.nfl.models.BoxscoreSchedule href "" "griddy.nfl.models.BoxscoreSchedule"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_type class-attribute instance-attribute

game_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="gameType")
] = None

Type of NFL season

iso_time class-attribute instance-attribute

iso_time: Annotated[
    Optional[int], Field(alias="isoTime")
] = None

Unix timestamp in milliseconds

ngs_game class-attribute instance-attribute

ngs_game: Annotated[
    Optional[bool], Field(alias="ngsGame")
] = None

Whether Next Gen Stats are available

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

BoxscoreScheduleTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.BoxscoreScheduleTypedDict[BoxscoreScheduleTypedDict]

              

              click griddy.nfl.models.BoxscoreScheduleTypedDict href "" "griddy.nfl.models.BoxscoreScheduleTypedDict"
            

Attributes

game_type instance-attribute

game_type: NotRequired[SeasonTypeEnum]

Type of NFL season

iso_time instance-attribute

iso_time: NotRequired[int]

Unix timestamp in milliseconds

ngs_game instance-attribute

ngs_game: NotRequired[bool]

Whether Next Gen Stats are available

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

BoxscoreScore

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.BoxscoreScore[BoxscoreScore]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.BoxscoreScore
                


              click griddy.nfl.models.BoxscoreScore href "" "griddy.nfl.models.BoxscoreScore"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

phase class-attribute instance-attribute

phase: Optional[str] = None

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

BoxscoreScoreTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.BoxscoreScoreTypedDict[BoxscoreScoreTypedDict]

              

              click griddy.nfl.models.BoxscoreScoreTypedDict href "" "griddy.nfl.models.BoxscoreScoreTypedDict"
            

Attributes

phase instance-attribute

phase: NotRequired[str]

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

BoxscoreTeam

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.BoxscoreTeam[BoxscoreTeam]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.BoxscoreTeam
                


              click griddy.nfl.models.BoxscoreTeam href "" "griddy.nfl.models.BoxscoreTeam"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

conference_abbr class-attribute instance-attribute

conference_abbr: Annotated[
    Optional[ConferenceEnum], Field(alias="conferenceAbbr")
] = None

NFL conference

team_type class-attribute instance-attribute

team_type: Annotated[
    Optional[TeamTypeEnum], Field(alias="teamType")
] = None

Team type classification

BoxscoreTeamTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.BoxscoreTeamTypedDict[BoxscoreTeamTypedDict]

              

              click griddy.nfl.models.BoxscoreTeamTypedDict href "" "griddy.nfl.models.BoxscoreTeamTypedDict"
            

Attributes

conference_abbr instance-attribute

conference_abbr: NotRequired[ConferenceEnum]

NFL conference

team_type instance-attribute

team_type: NotRequired[TeamTypeEnum]

Team type classification

BroadcastInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.BroadcastInfo[BroadcastInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.BroadcastInfo
                


              click griddy.nfl.models.BroadcastInfo href "" "griddy.nfl.models.BroadcastInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

away_network_channels class-attribute instance-attribute

away_network_channels: Annotated[
    Optional[List[str]], Field(alias="awayNetworkChannels")
] = None

Networks broadcasting in away market

home_network_channels class-attribute instance-attribute

home_network_channels: Annotated[
    Optional[List[str]], Field(alias="homeNetworkChannels")
] = None

Networks broadcasting in home market

international_watch_options class-attribute instance-attribute

international_watch_options: Annotated[
    Optional[List[InternationalWatchOption]],
    Field(alias="internationalWatchOptions"),
] = None

International viewing options

territory class-attribute instance-attribute

territory: Optional[Territory] = None

Broadcast territory scope

BroadcastInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.BroadcastInfoTypedDict[BroadcastInfoTypedDict]

              

              click griddy.nfl.models.BroadcastInfoTypedDict href "" "griddy.nfl.models.BroadcastInfoTypedDict"
            

Attributes

away_network_channels instance-attribute

away_network_channels: NotRequired[List[str]]

Networks broadcasting in away market

home_network_channels instance-attribute

home_network_channels: NotRequired[List[str]]

Networks broadcasting in home market

international_watch_options instance-attribute

international_watch_options: NotRequired[
    List[InternationalWatchOptionTypedDict]
]

International viewing options

territory instance-attribute

territory: NotRequired[Territory]

Broadcast territory scope

StreamingNetwork

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.StreamingNetwork[StreamingNetwork]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.StreamingNetwork
                


              click griddy.nfl.models.StreamingNetwork href "" "griddy.nfl.models.StreamingNetwork"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

host_network class-attribute instance-attribute

host_network: Annotated[
    Optional[str], Field(alias="hostNetwork")
] = None

Primary streaming network

networks class-attribute instance-attribute

networks: Optional[List[str]] = None

Available streaming networks

StreamingNetworkTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.StreamingNetworkTypedDict[StreamingNetworkTypedDict]

              

              click griddy.nfl.models.StreamingNetworkTypedDict href "" "griddy.nfl.models.StreamingNetworkTypedDict"
            

Attributes

host_network instance-attribute

host_network: NotRequired[str]

Primary streaming network

networks instance-attribute

networks: NotRequired[List[str]]

Available streaming networks

Clinched

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Clinched[Clinched]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Clinched
                


              click griddy.nfl.models.Clinched href "" "griddy.nfl.models.Clinched"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

bye class-attribute instance-attribute

bye: Optional[bool] = None

Clinched first-round bye

division class-attribute instance-attribute

division: Optional[bool] = None

Clinched division title

eliminated class-attribute instance-attribute

eliminated: Optional[bool] = None

Eliminated from playoff contention

home_field class-attribute instance-attribute

home_field: Annotated[
    Optional[bool], Field(alias="homeField")
] = None

Clinched home field advantage

playoff class-attribute instance-attribute

playoff: Optional[bool] = None

Clinched playoff berth

wild_card class-attribute instance-attribute

wild_card: Annotated[
    Optional[bool], Field(alias="wildCard")
] = None

Clinched wild card berth

ClinchedTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ClinchedTypedDict[ClinchedTypedDict]

              

              click griddy.nfl.models.ClinchedTypedDict href "" "griddy.nfl.models.ClinchedTypedDict"
            

Attributes

bye instance-attribute

bye: NotRequired[bool]

Clinched first-round bye

division instance-attribute

division: NotRequired[bool]

Clinched division title

eliminated instance-attribute

eliminated: NotRequired[bool]

Eliminated from playoff contention

home_field instance-attribute

home_field: NotRequired[bool]

Clinched home field advantage

playoff instance-attribute

playoff: NotRequired[bool]

Clinched playoff berth

wild_card instance-attribute

wild_card: NotRequired[bool]

Clinched wild card berth

Background

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Background[Background]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Background
                


              click griddy.nfl.models.Background href "" "griddy.nfl.models.Background"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Background configuration

BackgroundTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.BackgroundTypedDict[BackgroundTypedDict]

              

              click griddy.nfl.models.BackgroundTypedDict href "" "griddy.nfl.models.BackgroundTypedDict"
            

Background configuration

CoachesFilmVideo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.CoachesFilmVideo[CoachesFilmVideo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.CoachesFilmVideo
                


              click griddy.nfl.models.CoachesFilmVideo href "" "griddy.nfl.models.CoachesFilmVideo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

camera_source instance-attribute

camera_source: Annotated[
    CameraSource, Field(alias="cameraSource")
]

Camera angle/source for the video

description instance-attribute

description: str

Play description

duration instance-attribute

duration: str

Video duration in seconds

external_id instance-attribute

external_id: Annotated[str, Field(alias='externalId')]

External video identifier

title instance-attribute

title: str

Video title

type instance-attribute

type: CoachesFilmVideoType

Content type (always \"video\")

advertiser_id class-attribute instance-attribute

advertiser_id: Annotated[
    OptionalNullable[str], Field(alias="advertiserId")
] = UNSET

Associated advertiser ID

author class-attribute instance-attribute

author: OptionalNullable[str] = UNSET

Content author

authorizations class-attribute instance-attribute

authorizations: Optional[VideoAuthorizations] = None

Authorization requirements for video access

background class-attribute instance-attribute

background: Optional[Background] = None

Background configuration

clip_type class-attribute instance-attribute

clip_type: Annotated[
    OptionalNullable[str], Field(alias="clipType")
] = UNSET

Type of video clip

cta_link class-attribute instance-attribute

cta_link: Annotated[
    OptionalNullable[str], Field(alias="ctaLink")
] = UNSET

Call-to-action link

cta_target class-attribute instance-attribute

cta_target: Annotated[
    OptionalNullable[str], Field(alias="ctaTarget")
] = UNSET

Call-to-action target

cta_text class-attribute instance-attribute

cta_text: Annotated[
    OptionalNullable[str], Field(alias="ctaText")
] = UNSET

Call-to-action text

ctas class-attribute instance-attribute

ctas: Optional[List[Cta]] = None

Call-to-action elements

display_title class-attribute instance-attribute

display_title: Annotated[
    OptionalNullable[str], Field(alias="displayTitle")
] = UNSET

Display title override

end_date class-attribute instance-attribute

end_date: Annotated[
    OptionalNullable[datetime], Field(alias="endDate")
] = UNSET

Content end date

entitlement class-attribute instance-attribute

entitlement: OptionalNullable[str] = UNSET

Entitlement information

episode_number class-attribute instance-attribute

episode_number: Annotated[
    OptionalNullable[int], Field(alias="episodeNumber")
] = UNSET

Episode number if part of series

expiration_date class-attribute instance-attribute

expiration_date: Annotated[
    Optional[datetime], Field(alias="expirationDate")
] = None

Content expiration date

fantasy_link class-attribute instance-attribute

fantasy_link: Annotated[
    OptionalNullable[str], Field(alias="fantasyLink")
] = UNSET

Related fantasy content link

host_network class-attribute instance-attribute

host_network: Annotated[
    OptionalNullable[str], Field(alias="hostNetwork")
] = UNSET

Broadcasting network

id class-attribute instance-attribute

id: OptionalNullable[str] = UNSET

Internal content ID

images class-attribute instance-attribute

images: Optional[List[Image]] = None

Associated images

intended_audience class-attribute instance-attribute

intended_audience: Annotated[
    OptionalNullable[str], Field(alias="intendedAudience")
] = UNSET

Target audience

intro_end class-attribute instance-attribute

intro_end: Annotated[
    OptionalNullable[str], Field(alias="introEnd")
] = UNSET

Introduction end timestamp

language class-attribute instance-attribute

language: OptionalNullable[str] = UNSET

Content language

last_updated class-attribute instance-attribute

last_updated: Annotated[
    OptionalNullable[datetime], Field(alias="lastUpdated")
] = UNSET

Last update timestamp

mcp_playback_id class-attribute instance-attribute

mcp_playback_id: Annotated[
    Optional[str], Field(alias="mcpPlaybackId")
] = None

Media control platform playback ID

mobile_link class-attribute instance-attribute

mobile_link: Annotated[
    OptionalNullable[str], Field(alias="mobileLink")
] = UNSET

Mobile-specific link

mobile_title class-attribute instance-attribute

mobile_title: Annotated[
    OptionalNullable[str], Field(alias="mobileTitle")
] = UNSET

Mobile-specific title

original_air_date class-attribute instance-attribute

original_air_date: Annotated[
    Optional[datetime], Field(alias="originalAirDate")
] = None

Original broadcast air date

outro_start class-attribute instance-attribute

outro_start: Annotated[
    OptionalNullable[str], Field(alias="outroStart")
] = UNSET

Outro start timestamp

play_ids class-attribute instance-attribute

play_ids: Annotated[
    Optional[List[str]], Field(alias="playIds")
] = None

Play identifiers associated with this video

pre_roll_disabled class-attribute instance-attribute

pre_roll_disabled: Annotated[
    Optional[bool], Field(alias="preRollDisabled")
] = False

Whether pre-roll ads are disabled

promo_assets class-attribute instance-attribute

promo_assets: Annotated[
    Optional[List[PromoAsset]], Field(alias="promoAssets")
] = None

Promotional assets

promo_link class-attribute instance-attribute

promo_link: Annotated[
    OptionalNullable[str], Field(alias="promoLink")
] = UNSET

Promotional link

promo_target class-attribute instance-attribute

promo_target: Annotated[
    Optional[str], Field(alias="promoTarget")
] = "_self"

Promotional link target

promo_text class-attribute instance-attribute

promo_text: Annotated[
    OptionalNullable[str], Field(alias="promoText")
] = UNSET

Promotional text

publish_date class-attribute instance-attribute

publish_date: Annotated[
    Optional[datetime], Field(alias="publishDate")
] = None

Content publish date

radio_station class-attribute instance-attribute

radio_station: Annotated[
    OptionalNullable[str], Field(alias="radioStation")
] = UNSET

Associated radio station

series class-attribute instance-attribute

series: OptionalNullable[str] = UNSET

Series information

series_season class-attribute instance-attribute

series_season: Annotated[
    OptionalNullable[str], Field(alias="seriesSeason")
] = UNSET

Series season if applicable

series_title class-attribute instance-attribute

series_title: Annotated[
    OptionalNullable[str], Field(alias="seriesTitle")
] = UNSET

Series title if part of series

slug class-attribute instance-attribute

slug: OptionalNullable[str] = UNSET

URL slug

start_date class-attribute instance-attribute

start_date: Annotated[
    OptionalNullable[datetime], Field(alias="startDate")
] = UNSET

Content start date

sub_type class-attribute instance-attribute

sub_type: Annotated[
    Optional[SubType], Field(alias="subType")
] = None

Video subtype classification

summary class-attribute instance-attribute

summary: OptionalNullable[str] = UNSET

Content summary

tags class-attribute instance-attribute

tags: Optional[List[VideoTag]] = None

Content tags and metadata

videos class-attribute instance-attribute

videos: Optional[List[Video]] = None

Additional video information

web_link class-attribute instance-attribute

web_link: Annotated[
    OptionalNullable[str], Field(alias="webLink")
] = UNSET

Web-specific link

CoachesFilmVideoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.CoachesFilmVideoTypedDict[CoachesFilmVideoTypedDict]

              

              click griddy.nfl.models.CoachesFilmVideoTypedDict href "" "griddy.nfl.models.CoachesFilmVideoTypedDict"
            

Attributes

camera_source instance-attribute

camera_source: CameraSource

Camera angle/source for the video

description instance-attribute

description: str

Play description

duration instance-attribute

duration: str

Video duration in seconds

external_id instance-attribute

external_id: str

External video identifier

title instance-attribute

title: str

Video title

type instance-attribute

type: CoachesFilmVideoType

Content type (always \"video\")

advertiser_id instance-attribute

advertiser_id: NotRequired[Nullable[str]]

Associated advertiser ID

author instance-attribute

author: NotRequired[Nullable[str]]

Content author

authorizations instance-attribute

authorizations: NotRequired[VideoAuthorizationsTypedDict]

Authorization requirements for video access

background instance-attribute

background: NotRequired[BackgroundTypedDict]

Background configuration

clip_type instance-attribute

clip_type: NotRequired[Nullable[str]]

Type of video clip

cta_link instance-attribute

cta_link: NotRequired[Nullable[str]]

Call-to-action link

cta_target instance-attribute

cta_target: NotRequired[Nullable[str]]

Call-to-action target

cta_text instance-attribute

cta_text: NotRequired[Nullable[str]]

Call-to-action text

ctas instance-attribute

ctas: NotRequired[List[CtaTypedDict]]

Call-to-action elements

display_title instance-attribute

display_title: NotRequired[Nullable[str]]

Display title override

end_date instance-attribute

end_date: NotRequired[Nullable[datetime]]

Content end date

entitlement instance-attribute

entitlement: NotRequired[Nullable[str]]

Entitlement information

episode_number instance-attribute

episode_number: NotRequired[Nullable[int]]

Episode number if part of series

expiration_date instance-attribute

expiration_date: NotRequired[datetime]

Content expiration date

fantasy_link instance-attribute

fantasy_link: NotRequired[Nullable[str]]

Related fantasy content link

host_network instance-attribute

host_network: NotRequired[Nullable[str]]

Broadcasting network

id instance-attribute

id: NotRequired[Nullable[str]]

Internal content ID

images instance-attribute

images: NotRequired[List[ImageTypedDict]]

Associated images

intended_audience instance-attribute

intended_audience: NotRequired[Nullable[str]]

Target audience

intro_end instance-attribute

intro_end: NotRequired[Nullable[str]]

Introduction end timestamp

language instance-attribute

language: NotRequired[Nullable[str]]

Content language

last_updated instance-attribute

last_updated: NotRequired[Nullable[datetime]]

Last update timestamp

mcp_playback_id instance-attribute

mcp_playback_id: NotRequired[str]

Media control platform playback ID

mobile_link instance-attribute

mobile_link: NotRequired[Nullable[str]]

Mobile-specific link

mobile_title instance-attribute

mobile_title: NotRequired[Nullable[str]]

Mobile-specific title

original_air_date instance-attribute

original_air_date: NotRequired[datetime]

Original broadcast air date

outro_start instance-attribute

outro_start: NotRequired[Nullable[str]]

Outro start timestamp

play_ids instance-attribute

play_ids: NotRequired[List[str]]

Play identifiers associated with this video

pre_roll_disabled instance-attribute

pre_roll_disabled: NotRequired[bool]

Whether pre-roll ads are disabled

promo_assets instance-attribute

promo_assets: NotRequired[List[PromoAssetTypedDict]]

Promotional assets

promo_link instance-attribute

promo_link: NotRequired[Nullable[str]]

Promotional link

promo_target instance-attribute

promo_target: NotRequired[str]

Promotional link target

promo_text instance-attribute

promo_text: NotRequired[Nullable[str]]

Promotional text

publish_date instance-attribute

publish_date: NotRequired[datetime]

Content publish date

radio_station instance-attribute

radio_station: NotRequired[Nullable[str]]

Associated radio station

series instance-attribute

series: NotRequired[Nullable[str]]

Series information

series_season instance-attribute

series_season: NotRequired[Nullable[str]]

Series season if applicable

series_title instance-attribute

series_title: NotRequired[Nullable[str]]

Series title if part of series

slug instance-attribute

slug: NotRequired[Nullable[str]]

URL slug

start_date instance-attribute

start_date: NotRequired[Nullable[datetime]]

Content start date

sub_type instance-attribute

sub_type: NotRequired[SubType]

Video subtype classification

summary instance-attribute

summary: NotRequired[Nullable[str]]

Content summary

tags instance-attribute

tags: NotRequired[List[VideoTagTypedDict]]

Content tags and metadata

videos instance-attribute

videos: NotRequired[List[VideoTypedDict]]

Additional video information

web_link instance-attribute

web_link: NotRequired[Nullable[str]]

Web-specific link

Conference

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Conference[Conference]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Conference
                


              click griddy.nfl.models.Conference href "" "griddy.nfl.models.Conference"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

abbr class-attribute instance-attribute

abbr: Optional[ConferenceEnum] = None

NFL conference

full_name class-attribute instance-attribute

full_name: Annotated[
    Optional[str], Field(alias="fullName")
] = None

Full conference name

id class-attribute instance-attribute

id: Optional[str] = None

Conference identifier

ConferenceTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ConferenceTypedDict[ConferenceTypedDict]

              

              click griddy.nfl.models.ConferenceTypedDict href "" "griddy.nfl.models.ConferenceTypedDict"
            

Attributes

abbr instance-attribute

abbr: NotRequired[ConferenceEnum]

NFL conference

full_name instance-attribute

full_name: NotRequired[str]

Full conference name

id instance-attribute

id: NotRequired[str]

Conference identifier

ContractInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ContractInfo[ContractInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ContractInfo
                


              click griddy.nfl.models.ContractInfo href "" "griddy.nfl.models.ContractInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

expiration_year class-attribute instance-attribute

expiration_year: Annotated[
    Optional[int], Field(alias="expirationYear")
] = None

Contract expiration year

guaranteed class-attribute instance-attribute

guaranteed: Optional[float] = None

Guaranteed money

signing_bonus class-attribute instance-attribute

signing_bonus: Annotated[
    Optional[float], Field(alias="signingBonus")
] = None

Signing bonus

total_value class-attribute instance-attribute

total_value: Annotated[
    Optional[float], Field(alias="totalValue")
] = None

Total contract value

years class-attribute instance-attribute

years: Optional[int] = None

Contract length in years

ContractInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ContractInfoTypedDict[ContractInfoTypedDict]

              

              click griddy.nfl.models.ContractInfoTypedDict href "" "griddy.nfl.models.ContractInfoTypedDict"
            

Attributes

expiration_year instance-attribute

expiration_year: NotRequired[int]

Contract expiration year

guaranteed instance-attribute

guaranteed: NotRequired[float]

Guaranteed money

signing_bonus instance-attribute

signing_bonus: NotRequired[float]

Signing bonus

total_value instance-attribute

total_value: NotRequired[float]

Total contract value

years instance-attribute

years: NotRequired[int]

Contract length in years

CurrentGame

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.CurrentGame[CurrentGame]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.CurrentGame
                


              click griddy.nfl.models.CurrentGame href "" "griddy.nfl.models.CurrentGame"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

date_ class-attribute instance-attribute

date_: Annotated[Optional[date], Field(alias="date")] = None

Game date (YYYY-MM-DD)

date_am_pm class-attribute instance-attribute

date_am_pm: Annotated[
    Optional[MeridiemEnum], Field(alias="dateAmPm")
] = None

Time of day indicator

date_day class-attribute instance-attribute

date_day: Annotated[
    Optional[str], Field(alias="dateDay")
] = None

Day of week (full)

date_day_month class-attribute instance-attribute

date_day_month: Annotated[
    Optional[str], Field(alias="dateDayMonth")
] = None

Date in M/D format

date_day_short class-attribute instance-attribute

date_day_short: Annotated[
    Optional[str], Field(alias="dateDayShort")
] = None

Day of week (abbreviated)

date_time class-attribute instance-attribute

date_time: Annotated[
    Optional[str], Field(alias="dateTime")
] = None

Time without AM/PM

date_time_am_pm class-attribute instance-attribute

date_time_am_pm: Annotated[
    Optional[str], Field(alias="dateTimeAmPm")
] = None

Time with AM/PM

game_type class-attribute instance-attribute

game_type: Annotated[
    Optional[str], Field(alias="gameType")
] = None

Type of game

id class-attribute instance-attribute

id: Optional[str] = None

Unique game identifier

international class-attribute instance-attribute

international: Optional[bool] = None

Whether game is played internationally

neutral_site class-attribute instance-attribute

neutral_site: Annotated[
    Optional[bool], Field(alias="neutralSite")
] = None

Whether game is at neutral venue

phase class-attribute instance-attribute

phase: Optional[str] = None

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

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

status class-attribute instance-attribute

status: Optional[GameStatusEnum] = None

Game status

time class-attribute instance-attribute

time: Optional[datetime] = None

Game time in UTC

CurrentGameTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.CurrentGameTypedDict[CurrentGameTypedDict]

              

              click griddy.nfl.models.CurrentGameTypedDict href "" "griddy.nfl.models.CurrentGameTypedDict"
            

Attributes

date_ instance-attribute

date_: NotRequired[date]

Game date (YYYY-MM-DD)

date_am_pm instance-attribute

date_am_pm: NotRequired[MeridiemEnum]

Time of day indicator

date_day instance-attribute

date_day: NotRequired[str]

Day of week (full)

date_day_month instance-attribute

date_day_month: NotRequired[str]

Date in M/D format

date_day_short instance-attribute

date_day_short: NotRequired[str]

Day of week (abbreviated)

date_time instance-attribute

date_time: NotRequired[str]

Time without AM/PM

date_time_am_pm instance-attribute

date_time_am_pm: NotRequired[str]

Time with AM/PM

game_type instance-attribute

game_type: NotRequired[str]

Type of game

id instance-attribute

id: NotRequired[str]

Unique game identifier

international instance-attribute

international: NotRequired[bool]

Whether game is played internationally

neutral_site instance-attribute

neutral_site: NotRequired[bool]

Whether game is at neutral venue

phase instance-attribute

phase: NotRequired[str]

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

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

status instance-attribute

status: NotRequired[GameStatusEnum]

Game status

time instance-attribute

time: NotRequired[datetime]

Game time in UTC

DefensiveNearestDefenderStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.DefensiveNearestDefenderStats[DefensiveNearestDefenderStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.DefensiveNearestDefenderStats
                


              click griddy.nfl.models.DefensiveNearestDefenderStats href "" "griddy.nfl.models.DefensiveNearestDefenderStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

cov instance-attribute

cov: int

Total coverage snaps

cov_nd instance-attribute

cov_nd: Annotated[int, Field(alias='covNd')]

Coverage snaps (no data excluded)

display_name instance-attribute

display_name: Annotated[str, Field(alias='displayName')]

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: Annotated[str, Field(alias='nflId')]

NFL player identifier

position instance-attribute

position: DefensePositionEnum

Player position

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

bh_pct class-attribute instance-attribute

bh_pct: Annotated[Optional[float], Field(alias="bhPct")] = (
    None
)

Burn percentage (deep completions allowed rate)

catch_nd class-attribute instance-attribute

catch_nd: Annotated[
    Optional[float], Field(alias="catchNd")
] = None

Catch rate allowed (0-1)

croe_nd class-attribute instance-attribute

croe_nd: Annotated[
    Optional[float], Field(alias="croeNd")
] = None

Completion Rate Over Expected allowed

game_snap class-attribute instance-attribute

game_snap: Annotated[
    Optional[int], Field(alias="gameSnap")
] = None

Defensive snaps played

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image (contains formatInstructions placeholder)

int_ class-attribute instance-attribute

int_: Annotated[Optional[int], Field(alias='int')] = None

Interceptions

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    Optional[DefenseNGSPositionEnum],
    Field(alias="ngsPosition"),
] = None

Next Gen Stats position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    Optional[DefensePositionGroupEnum],
    Field(alias="ngsPositionGroup"),
] = None

Defensive position group

pass_rating_nd class-attribute instance-attribute

pass_rating_nd: Annotated[
    Optional[float], Field(alias="passRatingNd")
] = None

Passer rating allowed when targeted

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[DefensePositionGroupEnum],
    Field(alias="positionGroup"),
] = None

Defensive position group

qd class-attribute instance-attribute

qd: Optional[bool] = None

Qualified defender status

rec_nd class-attribute instance-attribute

rec_nd: Annotated[Optional[int], Field(alias="recNd")] = (
    None
)

Receptions allowed

rec_td_nd class-attribute instance-attribute

rec_td_nd: Annotated[
    Optional[int], Field(alias="recTdNd")
] = None

Receiving touchdowns allowed

rec_yds_nd class-attribute instance-attribute

rec_yds_nd: Annotated[
    Optional[int], Field(alias="recYdsNd")
] = None

Receiving yards allowed

sep class-attribute instance-attribute

sep: Optional[float] = None

Average separation allowed at target (yards)

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Abbreviated player name

team_snap class-attribute instance-attribute

team_snap: Annotated[
    Optional[int], Field(alias="teamSnap")
] = None

Total team defensive snaps

tg class-attribute instance-attribute

tg: Optional[int] = None

Team games for player

tgt_epa_nd class-attribute instance-attribute

tgt_epa_nd: Annotated[
    Optional[float], Field(alias="tgtEpaNd")
] = None

Target EPA (Expected Points Added) allowed

tgt_nd class-attribute instance-attribute

tgt_nd: Annotated[Optional[int], Field(alias="tgtNd")] = (
    None
)

Times targeted in coverage

tgt_r_nd class-attribute instance-attribute

tgt_r_nd: Annotated[
    Optional[float], Field(alias="tgtRNd")
] = None

Target rate (targets per coverage snap)

total_tg class-attribute instance-attribute

total_tg: Annotated[
    Optional[int], Field(alias="totalTg")
] = None

Total team games in period

twf_pct class-attribute instance-attribute

twf_pct: Annotated[
    Optional[float], Field(alias="twfPct")
] = None

Tight window frequency (percentage of targets in tight windows)

yacpr_nd class-attribute instance-attribute

yacpr_nd: Annotated[
    Optional[float], Field(alias="yacprNd")
] = None

Yards After Catch allowed per reception

DefensiveNearestDefenderStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.DefensiveNearestDefenderStatsTypedDict[DefensiveNearestDefenderStatsTypedDict]

              

              click griddy.nfl.models.DefensiveNearestDefenderStatsTypedDict href "" "griddy.nfl.models.DefensiveNearestDefenderStatsTypedDict"
            

Attributes

cov instance-attribute

cov: int

Total coverage snaps

cov_nd instance-attribute

cov_nd: int

Coverage snaps (no data excluded)

display_name instance-attribute

display_name: str

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: str

NFL player identifier

position instance-attribute

position: DefensePositionEnum

Player position

team_id instance-attribute

team_id: str

Team identifier

bh_pct instance-attribute

bh_pct: NotRequired[float]

Burn percentage (deep completions allowed rate)

catch_nd instance-attribute

catch_nd: NotRequired[float]

Catch rate allowed (0-1)

croe_nd instance-attribute

croe_nd: NotRequired[float]

Completion Rate Over Expected allowed

game_snap instance-attribute

game_snap: NotRequired[int]

Defensive snaps played

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image (contains formatInstructions placeholder)

int_ instance-attribute

int_: NotRequired[int]

Interceptions

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

ngs_position instance-attribute

ngs_position: NotRequired[DefenseNGSPositionEnum]

Next Gen Stats position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[DefenseNGSPositionGroupEnum]

Defensive position group

pass_rating_nd instance-attribute

pass_rating_nd: NotRequired[float]

Passer rating allowed when targeted

position_group instance-attribute

position_group: NotRequired[DefensePositionGroupEnum]

Defensive position group

qd instance-attribute

qd: NotRequired[bool]

Qualified defender status

rec_nd instance-attribute

rec_nd: NotRequired[int]

Receptions allowed

rec_td_nd instance-attribute

rec_td_nd: NotRequired[int]

Receiving touchdowns allowed

rec_yds_nd instance-attribute

rec_yds_nd: NotRequired[int]

Receiving yards allowed

sep instance-attribute

sep: NotRequired[float]

Average separation allowed at target (yards)

short_name instance-attribute

short_name: NotRequired[str]

Abbreviated player name

team_snap instance-attribute

team_snap: NotRequired[int]

Total team defensive snaps

tg instance-attribute

tg: NotRequired[int]

Team games for player

tgt_epa_nd instance-attribute

tgt_epa_nd: NotRequired[float]

Target EPA (Expected Points Added) allowed

tgt_nd instance-attribute

tgt_nd: NotRequired[int]

Times targeted in coverage

tgt_r_nd instance-attribute

tgt_r_nd: NotRequired[float]

Target rate (targets per coverage snap)

total_tg instance-attribute

total_tg: NotRequired[int]

Total team games in period

twf_pct instance-attribute

twf_pct: NotRequired[float]

Tight window frequency (percentage of targets in tight windows)

yacpr_nd instance-attribute

yacpr_nd: NotRequired[float]

Yards After Catch allowed per reception

DefensivePassRushStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.DefensivePassRushStats[DefensivePassRushStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.DefensivePassRushStats
                


              click griddy.nfl.models.DefensivePassRushStats href "" "griddy.nfl.models.DefensivePassRushStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

display_name instance-attribute

display_name: Annotated[str, Field(alias='displayName')]

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: Annotated[str, Field(alias='nflId')]

NFL player identifier

position instance-attribute

position: DefensePositionEnum

Player position

pr instance-attribute

pr: int

Pass rush grade/rating

pr_r instance-attribute

pr_r: Annotated[float, Field(alias='prR')]

Pass rush rate (0-1)

qbp instance-attribute

qbp: int

Quarterback pressures

qbp_r instance-attribute

qbp_r: Annotated[float, Field(alias='qbpR')]

Quarterback pressure rate (0-1)

sack instance-attribute

sack: float

Sacks (can be fractional for shared sacks)

sack_r instance-attribute

sack_r: Annotated[float, Field(alias='sackR')]

Sack rate (0-1)

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

game_snap class-attribute instance-attribute

game_snap: Annotated[
    Optional[int], Field(alias="gameSnap")
] = None

Defensive snaps played

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image (contains formatInstructions placeholder)

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    Optional[DefenseNGSPositionEnum],
    Field(alias="ngsPosition"),
] = None

Next Gen Stats position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    Optional[DefenseNGSPositionGroupEnum],
    Field(alias="ngsPositionGroup"),
] = None

Defensive position group

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[DefensePositionGroupEnum],
    Field(alias="positionGroup"),
] = None

Defensive position group

pr_go class-attribute instance-attribute

pr_go: Annotated[Optional[float], Field(alias="prGo")] = (
    None
)

Pass rush get-off metric

qd class-attribute instance-attribute

qd: Optional[bool] = None

Qualified defender status

qp class-attribute instance-attribute

qp: Optional[int] = None

Quarterback hits

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Abbreviated player name

team_snap class-attribute instance-attribute

team_snap: Annotated[
    Optional[int], Field(alias="teamSnap")
] = None

Total team defensive snaps

tg class-attribute instance-attribute

tg: Optional[int] = None

Team games for player

total_tg class-attribute instance-attribute

total_tg: Annotated[
    Optional[int], Field(alias="totalTg")
] = None

Total team games in period

ttp class-attribute instance-attribute

ttp: Optional[float] = None

Time to pressure (seconds)

tts class-attribute instance-attribute

tts: Optional[float] = None

Time to sack (seconds)

turn_qbp class-attribute instance-attribute

turn_qbp: Annotated[
    Optional[int], Field(alias="turnQbp")
] = None

Quarterback pressures that resulted in turnovers

DefensivePassRushStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.DefensivePassRushStatsTypedDict[DefensivePassRushStatsTypedDict]

              

              click griddy.nfl.models.DefensivePassRushStatsTypedDict href "" "griddy.nfl.models.DefensivePassRushStatsTypedDict"
            

Attributes

display_name instance-attribute

display_name: str

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: str

NFL player identifier

position instance-attribute

position: DefensePositionEnum

Player position

pr instance-attribute

pr: int

Pass rush grade/rating

pr_r instance-attribute

pr_r: float

Pass rush rate (0-1)

qbp instance-attribute

qbp: int

Quarterback pressures

qbp_r instance-attribute

qbp_r: float

Quarterback pressure rate (0-1)

sack instance-attribute

sack: float

Sacks (can be fractional for shared sacks)

sack_r instance-attribute

sack_r: float

Sack rate (0-1)

team_id instance-attribute

team_id: str

Team identifier

game_snap instance-attribute

game_snap: NotRequired[int]

Defensive snaps played

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image (contains formatInstructions placeholder)

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

ngs_position instance-attribute

ngs_position: NotRequired[DefenseNGSPositionEnum]

Next Gen Stats position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[DefenseNGSPositionGroupEnum]

Defensive position group

position_group instance-attribute

position_group: NotRequired[DefensePositionGroupEnum]

Defensive position group

pr_go instance-attribute

pr_go: NotRequired[float]

Pass rush get-off metric

qd instance-attribute

qd: NotRequired[bool]

Qualified defender status

qp instance-attribute

qp: NotRequired[int]

Quarterback hits

short_name instance-attribute

short_name: NotRequired[str]

Abbreviated player name

team_snap instance-attribute

team_snap: NotRequired[int]

Total team defensive snaps

tg instance-attribute

tg: NotRequired[int]

Team games for player

total_tg instance-attribute

total_tg: NotRequired[int]

Total team games in period

ttp instance-attribute

ttp: NotRequired[float]

Time to pressure (seconds)

tts instance-attribute

tts: NotRequired[float]

Time to sack (seconds)

turn_qbp instance-attribute

turn_qbp: NotRequired[int]

Quarterback pressures that resulted in turnovers

DefensivePlayerOverviewStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.DefensivePlayerOverviewStats[DefensivePlayerOverviewStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.DefensivePlayerOverviewStats
                


              click griddy.nfl.models.DefensivePlayerOverviewStats href "" "griddy.nfl.models.DefensivePlayerOverviewStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

display_name instance-attribute

display_name: Annotated[str, Field(alias='displayName')]

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: Annotated[str, Field(alias='nflId')]

NFL player identifier

position instance-attribute

position: DefensePositionEnum

Player position

snap instance-attribute

snap: int

Total defensive snaps played

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

game_snap class-attribute instance-attribute

game_snap: Annotated[
    Optional[int], Field(alias="gameSnap")
] = None

Defensive snaps played in games

h_stop class-attribute instance-attribute

h_stop: Annotated[Optional[int], Field(alias="hStop")] = (
    None
)

Hard stops (tackles for loss or no gain)

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image (contains formatInstructions placeholder)

int_ class-attribute instance-attribute

int_: Annotated[Optional[int], Field(alias='int')] = None

Interceptions

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    Optional[DefenseNGSPositionEnum],
    Field(alias="ngsPosition"),
] = None

Next Gen Stats position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    Optional[DefenseNGSPositionGroupEnum],
    Field(alias="ngsPositionGroup"),
] = None

Defensive position group

pass_rating_nd class-attribute instance-attribute

pass_rating_nd: Annotated[
    Optional[float], Field(alias="passRatingNd")
] = None

Passer rating allowed when targeted (no data excluded)

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[DefensePositionGroupEnum],
    Field(alias="positionGroup"),
] = None

Defensive position group

pr class-attribute instance-attribute

pr: Optional[int] = None

Pass rush snaps

qbp class-attribute instance-attribute

qbp: Optional[int] = None

Quarterback pressures

qbp_r class-attribute instance-attribute

qbp_r: Annotated[Optional[float], Field(alias="qbpR")] = (
    None
)

Quarterback pressure rate (0-1)

qd class-attribute instance-attribute

qd: Optional[bool] = None

Qualified defender status

rd class-attribute instance-attribute

rd: Optional[int] = None

Run defense snaps

rec_nd class-attribute instance-attribute

rec_nd: Annotated[Optional[int], Field(alias="recNd")] = (
    None
)

Receptions allowed (no data excluded)

rec_td_nd class-attribute instance-attribute

rec_td_nd: Annotated[
    Optional[int], Field(alias="recTdNd")
] = None

Receiving touchdowns allowed (no data excluded)

rec_yds_nd class-attribute instance-attribute

rec_yds_nd: Annotated[
    Optional[int], Field(alias="recYdsNd")
] = None

Receiving yards allowed (no data excluded)

sack class-attribute instance-attribute

sack: Optional[float] = None

Sacks

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Abbreviated player name

snap_pct class-attribute instance-attribute

snap_pct: Annotated[
    Optional[float], Field(alias="snapPct")
] = None

Percentage of team snaps played (0-1)

t_stop class-attribute instance-attribute

t_stop: Annotated[Optional[int], Field(alias="tStop")] = (
    None
)

Tackle stops (successful tackles)

tck class-attribute instance-attribute

tck: Optional[int] = None

Total tackles

team_snap class-attribute instance-attribute

team_snap: Annotated[
    Optional[int], Field(alias="teamSnap")
] = None

Total team defensive snaps

tg class-attribute instance-attribute

tg: Optional[int] = None

Team games for player

tgt_nd class-attribute instance-attribute

tgt_nd: Annotated[Optional[int], Field(alias="tgtNd")] = (
    None
)

Times targeted in coverage (no data excluded)

total_tg class-attribute instance-attribute

total_tg: Annotated[
    Optional[int], Field(alias="totalTg")
] = None

Total team games in period

DefensivePlayerOverviewStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.DefensivePlayerOverviewStatsTypedDict[DefensivePlayerOverviewStatsTypedDict]

              

              click griddy.nfl.models.DefensivePlayerOverviewStatsTypedDict href "" "griddy.nfl.models.DefensivePlayerOverviewStatsTypedDict"
            

Attributes

display_name instance-attribute

display_name: str

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: str

NFL player identifier

position instance-attribute

position: DefensePositionEnum

Player position

snap instance-attribute

snap: int

Total defensive snaps played

team_id instance-attribute

team_id: str

Team identifier

game_snap instance-attribute

game_snap: NotRequired[int]

Defensive snaps played in games

h_stop instance-attribute

h_stop: NotRequired[int]

Hard stops (tackles for loss or no gain)

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image (contains formatInstructions placeholder)

int_ instance-attribute

int_: NotRequired[int]

Interceptions

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

ngs_position instance-attribute

ngs_position: NotRequired[DefenseNGSPositionEnum]

Next Gen Stats position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[DefenseNGSPositionGroupEnum]

Defensive position group

pass_rating_nd instance-attribute

pass_rating_nd: NotRequired[float]

Passer rating allowed when targeted (no data excluded)

position_group instance-attribute

position_group: NotRequired[DefensePositionGroupEnum]

Defensive position group

pr instance-attribute

pr: NotRequired[int]

Pass rush snaps

qbp instance-attribute

qbp: NotRequired[int]

Quarterback pressures

qbp_r instance-attribute

qbp_r: NotRequired[float]

Quarterback pressure rate (0-1)

qd instance-attribute

qd: NotRequired[bool]

Qualified defender status

rd instance-attribute

rd: NotRequired[int]

Run defense snaps

rec_nd instance-attribute

rec_nd: NotRequired[int]

Receptions allowed (no data excluded)

rec_td_nd instance-attribute

rec_td_nd: NotRequired[int]

Receiving touchdowns allowed (no data excluded)

rec_yds_nd instance-attribute

rec_yds_nd: NotRequired[int]

Receiving yards allowed (no data excluded)

sack instance-attribute

sack: NotRequired[float]

Sacks

short_name instance-attribute

short_name: NotRequired[str]

Abbreviated player name

snap_pct instance-attribute

snap_pct: NotRequired[float]

Percentage of team snaps played (0-1)

t_stop instance-attribute

t_stop: NotRequired[int]

Tackle stops (successful tackles)

tck instance-attribute

tck: NotRequired[int]

Total tackles

team_snap instance-attribute

team_snap: NotRequired[int]

Total team defensive snaps

tg instance-attribute

tg: NotRequired[int]

Team games for player

tgt_nd instance-attribute

tgt_nd: NotRequired[int]

Times targeted in coverage (no data excluded)

total_tg instance-attribute

total_tg: NotRequired[int]

Total team games in period

Division

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Division[Division]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Division
                


              click griddy.nfl.models.Division href "" "griddy.nfl.models.Division"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

abbr class-attribute instance-attribute

abbr: Optional[str] = None

Division abbreviation

full_name class-attribute instance-attribute

full_name: Annotated[
    Optional[str], Field(alias="fullName")
] = None

Full division name

id class-attribute instance-attribute

id: Optional[str] = None

Division identifier

DivisionTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.DivisionTypedDict[DivisionTypedDict]

              

              click griddy.nfl.models.DivisionTypedDict href "" "griddy.nfl.models.DivisionTypedDict"
            

Attributes

abbr instance-attribute

abbr: NotRequired[str]

Division abbreviation

full_name instance-attribute

full_name: NotRequired[str]

Full division name

id instance-attribute

id: NotRequired[str]

Division identifier

Drive

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Drive[Drive]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Drive
                


              click griddy.nfl.models.Drive href "" "griddy.nfl.models.Drive"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

end_time class-attribute instance-attribute

end_time: Annotated[
    Optional[str], Field(alias="endTime")
] = None

Game clock at drive end

end_yard_line class-attribute instance-attribute

end_yard_line: Annotated[
    Optional[str], Field(alias="endYardLine")
] = None

Ending field position

start_time class-attribute instance-attribute

start_time: Annotated[
    Optional[str], Field(alias="startTime")
] = None

Game clock at drive start

start_yard_line class-attribute instance-attribute

start_yard_line: Annotated[
    Optional[str], Field(alias="startYardLine")
] = None

Starting field position

time_of_possession class-attribute instance-attribute

time_of_possession: Annotated[
    Optional[str], Field(alias="timeOfPossession")
] = None

Drive duration (MM:SS)

DriveTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.DriveTypedDict[DriveTypedDict]

              

              click griddy.nfl.models.DriveTypedDict href "" "griddy.nfl.models.DriveTypedDict"
            

Attributes

end_time instance-attribute

end_time: NotRequired[str]

Game clock at drive end

end_yard_line instance-attribute

end_yard_line: NotRequired[str]

Ending field position

start_time instance-attribute

start_time: NotRequired[str]

Game clock at drive start

start_yard_line instance-attribute

start_yard_line: NotRequired[str]

Starting field position

time_of_possession instance-attribute

time_of_possession: NotRequired[str]

Drive duration (MM:SS)

ExternalID

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ExternalID[ExternalID]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ExternalID
                


              click griddy.nfl.models.ExternalID href "" "griddy.nfl.models.ExternalID"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID in external system

source class-attribute instance-attribute

source: Optional[str] = None

External system name

ExternalIDTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ExternalIDTypedDict[ExternalIDTypedDict]

              

              click griddy.nfl.models.ExternalIDTypedDict href "" "griddy.nfl.models.ExternalIDTypedDict"
            

Attributes

id instance-attribute

id: NotRequired[str]

ID in external system

source instance-attribute

source: NotRequired[str]

External system name

FantasyPlayerStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.FantasyPlayerStats[FantasyPlayerStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.FantasyPlayerStats
                


              click griddy.nfl.models.FantasyPlayerStats href "" "griddy.nfl.models.FantasyPlayerStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

display_name instance-attribute

display_name: Annotated[str, Field(alias='displayName')]

Player's full name

fp_std instance-attribute

fp_std: Annotated[float, Field(alias='fpStd')]

Fantasy points (standard scoring)

gp instance-attribute

gp: int

Games played

nfl_id instance-attribute

nfl_id: Annotated[str, Field(alias='nflId')]

NFL player identifier

position instance-attribute

position: FantasyPlayerStatsPosition

Player position

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

fp_half_ppr class-attribute instance-attribute

fp_half_ppr: Annotated[
    Optional[float], Field(alias="fpHalfPpr")
] = None

Fantasy points (half-PPR scoring)

fp_ppr class-attribute instance-attribute

fp_ppr: Annotated[Optional[float], Field(alias="fpPpr")] = (
    None
)

Fantasy points (PPR scoring)

fp_ppr_pg class-attribute instance-attribute

fp_ppr_pg: Annotated[
    Optional[float], Field(alias="fpPprPG")
] = None

Fantasy points per game (PPR)

fp_std_pg class-attribute instance-attribute

fp_std_pg: Annotated[
    Optional[float], Field(alias="fpStdPG")
] = None

Fantasy points per game (standard)

gs class-attribute instance-attribute

gs: Optional[int] = None

Games started

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

pass_int class-attribute instance-attribute

pass_int: Annotated[
    Optional[int], Field(alias="passInt")
] = None

Passing interceptions

pass_td class-attribute instance-attribute

pass_td: Annotated[Optional[int], Field(alias="passTd")] = (
    None
)

Passing touchdowns

pass_yds class-attribute instance-attribute

pass_yds: Annotated[
    Optional[int], Field(alias="passYds")
] = None

Passing yards

pass_yds_pg class-attribute instance-attribute

pass_yds_pg: Annotated[
    Optional[float], Field(alias="passYdsPG")
] = None

Passing yards per game

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[PositionGroup], Field(alias="positionGroup")
] = None

Position group

rec class-attribute instance-attribute

rec: Optional[int] = None

Receptions

rec_pg class-attribute instance-attribute

rec_pg: Annotated[Optional[float], Field(alias="recPG")] = (
    None
)

Receptions per game

rec_td class-attribute instance-attribute

rec_td: Annotated[Optional[int], Field(alias="recTd")] = (
    None
)

Receiving touchdowns

rec_yds class-attribute instance-attribute

rec_yds: Annotated[Optional[int], Field(alias="recYds")] = (
    None
)

Receiving yards

red_zone_targets class-attribute instance-attribute

red_zone_targets: Annotated[
    Optional[int], Field(alias="redZoneTargets")
] = None

Targets inside the red zone

rush_td class-attribute instance-attribute

rush_td: Annotated[Optional[int], Field(alias="rushTd")] = (
    None
)

Rushing touchdowns

rush_yds class-attribute instance-attribute

rush_yds: Annotated[
    Optional[int], Field(alias="rushYds")
] = None

Rushing yards

rush_yds_pg class-attribute instance-attribute

rush_yds_pg: Annotated[
    Optional[float], Field(alias="rushYdsPG")
] = None

Rushing yards per game

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Abbreviated player name

snap_pct class-attribute instance-attribute

snap_pct: Annotated[
    Optional[float], Field(alias="snapPct")
] = None

Percentage of offensive snaps played (0-1)

target_share class-attribute instance-attribute

target_share: Annotated[
    Optional[float], Field(alias="targetShare")
] = None

Percentage of team targets (0-1)

tgt class-attribute instance-attribute

tgt: Optional[int] = None

Targets

FantasyPlayerStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.FantasyPlayerStatsTypedDict[FantasyPlayerStatsTypedDict]

              

              click griddy.nfl.models.FantasyPlayerStatsTypedDict href "" "griddy.nfl.models.FantasyPlayerStatsTypedDict"
            

Attributes

display_name instance-attribute

display_name: str

Player's full name

fp_std instance-attribute

fp_std: float

Fantasy points (standard scoring)

gp instance-attribute

gp: int

Games played

nfl_id instance-attribute

nfl_id: str

NFL player identifier

position instance-attribute

position: FantasyPlayerStatsPosition

Player position

team_id instance-attribute

team_id: str

Team identifier

fp_half_ppr instance-attribute

fp_half_ppr: NotRequired[float]

Fantasy points (half-PPR scoring)

fp_ppr instance-attribute

fp_ppr: NotRequired[float]

Fantasy points (PPR scoring)

fp_ppr_pg instance-attribute

fp_ppr_pg: NotRequired[float]

Fantasy points per game (PPR)

fp_std_pg instance-attribute

fp_std_pg: NotRequired[float]

Fantasy points per game (standard)

gs instance-attribute

gs: NotRequired[int]

Games started

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

pass_int instance-attribute

pass_int: NotRequired[int]

Passing interceptions

pass_td instance-attribute

pass_td: NotRequired[int]

Passing touchdowns

pass_yds instance-attribute

pass_yds: NotRequired[int]

Passing yards

pass_yds_pg instance-attribute

pass_yds_pg: NotRequired[float]

Passing yards per game

position_group instance-attribute

position_group: NotRequired[PositionGroup]

Position group

rec instance-attribute

rec: NotRequired[int]

Receptions

rec_pg instance-attribute

rec_pg: NotRequired[float]

Receptions per game

rec_td instance-attribute

rec_td: NotRequired[int]

Receiving touchdowns

rec_yds instance-attribute

rec_yds: NotRequired[int]

Receiving yards

red_zone_targets instance-attribute

red_zone_targets: NotRequired[int]

Targets inside the red zone

rush_td instance-attribute

rush_td: NotRequired[int]

Rushing touchdowns

rush_yds instance-attribute

rush_yds: NotRequired[int]

Rushing yards

rush_yds_pg instance-attribute

rush_yds_pg: NotRequired[float]

Rushing yards per game

short_name instance-attribute

short_name: NotRequired[str]

Abbreviated player name

snap_pct instance-attribute

snap_pct: NotRequired[float]

Percentage of offensive snaps played (0-1)

target_share instance-attribute

target_share: NotRequired[float]

Percentage of team targets (0-1)

tgt instance-attribute

tgt: NotRequired[int]

Targets

FilmCard

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.FilmCard[FilmCard]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.FilmCard
                


              click griddy.nfl.models.FilmCard href "" "griddy.nfl.models.FilmCard"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

link_params instance-attribute

link_params: Annotated[
    LinkParams, Field(alias="linkParams")
]

Parameters for constructing film room link

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

title instance-attribute

title: str

Title of the film content

FilmCardTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.FilmCardTypedDict[FilmCardTypedDict]

              

              click griddy.nfl.models.FilmCardTypedDict href "" "griddy.nfl.models.FilmCardTypedDict"
            

Attributes

link_params instance-attribute

link_params: LinkParamsTypedDict

Parameters for constructing film room link

team_id instance-attribute

team_id: str

Team identifier

title instance-attribute

title: str

Title of the film content

LinkParams

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.LinkParams[LinkParams]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.LinkParams
                


              click griddy.nfl.models.LinkParams href "" "griddy.nfl.models.LinkParams"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Parameters for constructing film room link

Attributes

dropback class-attribute instance-attribute

dropback: Optional[int] = None

Dropback indicator (1 for yes)

nfl_id class-attribute instance-attribute

nfl_id: Annotated[Optional[str], Field(alias="nflId")] = (
    None
)

NFL player identifier

passer_id class-attribute instance-attribute

passer_id: Annotated[
    Optional[str], Field(alias="passerId")
] = None

Passer ID for QB film

rusher_id class-attribute instance-attribute

rusher_id: Annotated[
    Optional[str], Field(alias="rusherId")
] = None

Rusher ID for RB film

season class-attribute instance-attribute

season: Optional[str] = None

Season year

target_id class-attribute instance-attribute

target_id: Annotated[
    Optional[str], Field(alias="targetId")
] = None

Target ID for receiver film

week_slug class-attribute instance-attribute

week_slug: Annotated[
    Optional[str], Field(alias="weekSlug")
] = None

Week identifier

LinkParamsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.LinkParamsTypedDict[LinkParamsTypedDict]

              

              click griddy.nfl.models.LinkParamsTypedDict href "" "griddy.nfl.models.LinkParamsTypedDict"
            

Parameters for constructing film room link

Attributes

dropback instance-attribute

dropback: NotRequired[int]

Dropback indicator (1 for yes)

nfl_id instance-attribute

nfl_id: NotRequired[str]

NFL player identifier

passer_id instance-attribute

passer_id: NotRequired[str]

Passer ID for QB film

rusher_id instance-attribute

rusher_id: NotRequired[str]

Rusher ID for RB film

season instance-attribute

season: NotRequired[str]

Season year

target_id instance-attribute

target_id: NotRequired[str]

Target ID for receiver film

week_slug instance-attribute

week_slug: NotRequired[str]

Week identifier

FilmroomPlay

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.FilmroomPlay[FilmroomPlay]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.FilmroomPlay
                


              click griddy.nfl.models.FilmroomPlay href "" "griddy.nfl.models.FilmroomPlay"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

defense_team_id instance-attribute

defense_team_id: Annotated[
    str, Field(alias="defenseTeamId")
]

Defensive team identifier

down instance-attribute

down: int

Down number

fapi_game_id instance-attribute

fapi_game_id: Annotated[str, Field(alias='fapiGameId')]

Football API game identifier

game_clock instance-attribute

game_clock: Annotated[str, Field(alias='gameClock')]

Game clock time when play occurred

game_id instance-attribute

game_id: Annotated[int, Field(alias='gameId')]

Game identifier (10-digit format YYYYMMDDNN)

home_team_abbr instance-attribute

home_team_abbr: Annotated[str, Field(alias='homeTeamAbbr')]

Home team abbreviation

home_team_id instance-attribute

home_team_id: Annotated[str, Field(alias='homeTeamId')]

Home team identifier

play_description instance-attribute

play_description: Annotated[
    str, Field(alias="playDescription")
]

Detailed description of the play

play_id instance-attribute

play_id: Annotated[int, Field(alias='playId')]

Unique play identifier within the game

play_type instance-attribute

play_type: Annotated[PlayTypeEnum, Field(alias='playType')]

Enumeration of all possible play types

possession_team_id instance-attribute

possession_team_id: Annotated[
    str, Field(alias="possessionTeamId")
]

Team with possession of the ball

quarter instance-attribute

quarter: int

Quarter of the play

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sequence instance-attribute

sequence: int

Play sequence number

visitor_team_abbr instance-attribute

visitor_team_abbr: Annotated[
    str, Field(alias="visitorTeamAbbr")
]

Visiting team abbreviation

visitor_team_id instance-attribute

visitor_team_id: Annotated[
    str, Field(alias="visitorTeamId")
]

Visiting team identifier

week instance-attribute

week: int

Week number

week_slug instance-attribute

week_slug: Annotated[str, Field(alias='weekSlug')]

Week identifier slug

yardline instance-attribute

yardline: str

Field position where play occurred

yards_to_go instance-attribute

yards_to_go: Annotated[int, Field(alias='yardsToGo')]

Yards needed for first down

selected_param_values class-attribute instance-attribute

selected_param_values: Annotated[
    Optional[Dict[str, Any]],
    Field(alias="selectedParamValues"),
] = None

Selected parameter values for the play filter

FilmroomPlayTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.FilmroomPlayTypedDict[FilmroomPlayTypedDict]

              

              click griddy.nfl.models.FilmroomPlayTypedDict href "" "griddy.nfl.models.FilmroomPlayTypedDict"
            

Attributes

defense_team_id instance-attribute

defense_team_id: str

Defensive team identifier

down instance-attribute

down: int

Down number

fapi_game_id instance-attribute

fapi_game_id: str

Football API game identifier

game_clock instance-attribute

game_clock: str

Game clock time when play occurred

game_id instance-attribute

game_id: int

Game identifier (10-digit format YYYYMMDDNN)

home_team_abbr instance-attribute

home_team_abbr: str

Home team abbreviation

home_team_id instance-attribute

home_team_id: str

Home team identifier

play_description instance-attribute

play_description: str

Detailed description of the play

play_id instance-attribute

play_id: int

Unique play identifier within the game

play_type instance-attribute

play_type: PlayTypeEnum

Enumeration of all possible play types

possession_team_id instance-attribute

possession_team_id: str

Team with possession of the ball

quarter instance-attribute

quarter: int

Quarter of the play

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sequence instance-attribute

sequence: int

Play sequence number

visitor_team_abbr instance-attribute

visitor_team_abbr: str

Visiting team abbreviation

visitor_team_id instance-attribute

visitor_team_id: str

Visiting team identifier

week instance-attribute

week: int

Week number

week_slug instance-attribute

week_slug: str

Week identifier slug

yardline instance-attribute

yardline: str

Field position where play occurred

yards_to_go instance-attribute

yards_to_go: int

Yards needed for first down

selected_param_values instance-attribute

selected_param_values: NotRequired[Dict[str, Any]]

Selected parameter values for the play filter

Fixture

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Fixture[Fixture]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Fixture
                


              click griddy.nfl.models.Fixture href "" "griddy.nfl.models.Fixture"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Associated fixture information

FixtureTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.FixtureTypedDict[FixtureTypedDict]

              

              click griddy.nfl.models.FixtureTypedDict href "" "griddy.nfl.models.FixtureTypedDict"
            

Associated fixture information

FuturesMarket

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.FuturesMarket[FuturesMarket]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.FuturesMarket
                


              click griddy.nfl.models.FuturesMarket href "" "griddy.nfl.models.FuturesMarket"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

fixture class-attribute instance-attribute

fixture: OptionalNullable[Fixture] = UNSET

Associated fixture information

fixture_id class-attribute instance-attribute

fixture_id: Annotated[
    OptionalNullable[str], Field(alias="fixtureId")
] = UNSET

Associated fixture ID if applicable

hierarchy class-attribute instance-attribute

hierarchy: Optional[str] = None

Full betting hierarchy path

is_available class-attribute instance-attribute

is_available: Annotated[
    Optional[bool], Field(alias="isAvailable")
] = None

Whether market is currently available

is_suspended class-attribute instance-attribute

is_suspended: Annotated[
    Optional[bool], Field(alias="isSuspended")
] = None

Whether market is currently suspended

name class-attribute instance-attribute

name: Optional[str] = None

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

source_id class-attribute instance-attribute

source_id: Annotated[
    Optional[str], Field(alias="sourceId")
] = None

Source identifier for the market

FuturesMarketTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.FuturesMarketTypedDict[FuturesMarketTypedDict]

              

              click griddy.nfl.models.FuturesMarketTypedDict href "" "griddy.nfl.models.FuturesMarketTypedDict"
            

Attributes

fixture instance-attribute

fixture: NotRequired[Nullable[FixtureTypedDict]]

Associated fixture information

fixture_id instance-attribute

fixture_id: NotRequired[Nullable[str]]

Associated fixture ID if applicable

hierarchy instance-attribute

hierarchy: NotRequired[str]

Full betting hierarchy path

is_available instance-attribute

is_available: NotRequired[bool]

Whether market is currently available

is_suspended instance-attribute

is_suspended: NotRequired[bool]

Whether market is currently suspended

name instance-attribute

name: NotRequired[str]

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

source_id instance-attribute

source_id: NotRequired[str]

Source identifier for the market

Game

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Game[Game]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Game
                


              click griddy.nfl.models.Game href "" "griddy.nfl.models.Game"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

date_ class-attribute instance-attribute

date_: Annotated[Optional[date], Field(alias="date")] = None

Game date (YYYY-MM-DD)

date_am_pm class-attribute instance-attribute

date_am_pm: Annotated[
    Optional[MeridiemEnum], Field(alias="dateAmPm")
] = None

Time of day indicator

date_day class-attribute instance-attribute

date_day: Annotated[
    Optional[str], Field(alias="dateDay")
] = None

Day of week (full)

date_day_month class-attribute instance-attribute

date_day_month: Annotated[
    Optional[str], Field(alias="dateDayMonth")
] = None

Date in M/D format

date_day_short class-attribute instance-attribute

date_day_short: Annotated[
    Optional[str], Field(alias="dateDayShort")
] = None

Day of week (abbreviated)

date_time class-attribute instance-attribute

date_time: Annotated[
    Optional[str], Field(alias="dateTime")
] = None

Time without AM/PM

date_time_am_pm class-attribute instance-attribute

date_time_am_pm: Annotated[
    Optional[str], Field(alias="dateTimeAmPm")
] = None

Time with AM/PM

extensions class-attribute instance-attribute

extensions: Optional[List[GameExtension]] = None

Additional game data extensions

game_type class-attribute instance-attribute

game_type: Annotated[
    Optional[str], Field(alias="gameType")
] = None

Type of game

id class-attribute instance-attribute

id: Optional[str] = None

Unique game identifier

international class-attribute instance-attribute

international: Optional[bool] = None

Whether game is played internationally

neutral_site class-attribute instance-attribute

neutral_site: Annotated[
    Optional[bool], Field(alias="neutralSite")
] = None

Whether game is at neutral venue

phase class-attribute instance-attribute

phase: Optional[str] = None

Game phase

season class-attribute instance-attribute

season: Optional[int] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

status class-attribute instance-attribute

status: Optional[GameStatus] = None

Game status

ticket_url class-attribute instance-attribute

ticket_url: Annotated[
    OptionalNullable[str], Field(alias="ticketUrl")
] = UNSET

Primary ticket purchase URL

time class-attribute instance-attribute

time: Optional[datetime] = None

Game time in UTC

version class-attribute instance-attribute

version: Optional[int] = None

Data version number

week class-attribute instance-attribute

week: Optional[int] = None

Week number

week_type class-attribute instance-attribute

week_type: Annotated[
    Optional[str], Field(alias="weekType")
] = None

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

GameTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GameTypedDict[GameTypedDict]

              

              click griddy.nfl.models.GameTypedDict href "" "griddy.nfl.models.GameTypedDict"
            

Attributes

date_ instance-attribute

date_: NotRequired[date]

Game date (YYYY-MM-DD)

date_am_pm instance-attribute

date_am_pm: NotRequired[MeridiemEnum]

Time of day indicator

date_day instance-attribute

date_day: NotRequired[str]

Day of week (full)

date_day_month instance-attribute

date_day_month: NotRequired[str]

Date in M/D format

date_day_short instance-attribute

date_day_short: NotRequired[str]

Day of week (abbreviated)

date_time instance-attribute

date_time: NotRequired[str]

Time without AM/PM

date_time_am_pm instance-attribute

date_time_am_pm: NotRequired[str]

Time with AM/PM

extensions instance-attribute

extensions: NotRequired[List[GameExtensionTypedDict]]

Additional game data extensions

game_type instance-attribute

game_type: NotRequired[str]

Type of game

id instance-attribute

id: NotRequired[str]

Unique game identifier

international instance-attribute

international: NotRequired[bool]

Whether game is played internationally

neutral_site instance-attribute

neutral_site: NotRequired[bool]

Whether game is at neutral venue

phase instance-attribute

phase: NotRequired[str]

Game phase

season instance-attribute

season: NotRequired[int]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

status instance-attribute

status: NotRequired[GameStatus]

Game status

ticket_url instance-attribute

ticket_url: NotRequired[Nullable[str]]

Primary ticket purchase URL

time instance-attribute

time: NotRequired[datetime]

Game time in UTC

version instance-attribute

version: NotRequired[int]

Data version number

week instance-attribute

week: NotRequired[int]

Week number

week_type instance-attribute

week_type: NotRequired[str]

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

GameDetail

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GameDetail[GameDetail]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GameDetail
                


              click griddy.nfl.models.GameDetail href "" "griddy.nfl.models.GameDetail"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_type class-attribute instance-attribute

game_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="gameType")
] = None

Type of NFL season

home_team class-attribute instance-attribute

home_team: Annotated[
    Optional[TeamInfo], Field(alias="homeTeam")
] = None

Basic team information included in roster responses

iso_time class-attribute instance-attribute

iso_time: Annotated[
    Optional[int], Field(alias="isoTime")
] = None

Unix timestamp in milliseconds

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

visitor_team class-attribute instance-attribute

visitor_team: Annotated[
    Optional[TeamInfo], Field(alias="visitorTeam")
] = None

Basic team information included in roster responses

GameDetailTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GameDetailTypedDict[GameDetailTypedDict]

              

              click griddy.nfl.models.GameDetailTypedDict href "" "griddy.nfl.models.GameDetailTypedDict"
            

Attributes

game_type instance-attribute

game_type: NotRequired[SeasonTypeEnum]

Type of NFL season

home_team instance-attribute

home_team: NotRequired[TeamInfoTypedDict]

Basic team information included in roster responses

iso_time instance-attribute

iso_time: NotRequired[int]

Unix timestamp in milliseconds

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

visitor_team instance-attribute

visitor_team: NotRequired[TeamInfoTypedDict]

Basic team information included in roster responses

Content

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Content[Content]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Content
                


              click griddy.nfl.models.Content href "" "griddy.nfl.models.Content"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Insight content and analysis

ContentTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ContentTypedDict[ContentTypedDict]

              

              click griddy.nfl.models.ContentTypedDict href "" "griddy.nfl.models.ContentTypedDict"
            

Insight content and analysis

GameInsight

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GameInsight[GameInsight]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GameInsight
                


              click griddy.nfl.models.GameInsight href "" "griddy.nfl.models.GameInsight"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Game-specific analytical insight

Attributes

content class-attribute instance-attribute

content: Optional[Content] = None

Insight content and analysis

game_id class-attribute instance-attribute

game_id: Annotated[Optional[str], Field(alias="gameId")] = (
    None
)

Game identifier

id class-attribute instance-attribute

id: Optional[str] = None

Insight identifier

type class-attribute instance-attribute

type: Optional[str] = None

Type of insight

GameInsightTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GameInsightTypedDict[GameInsightTypedDict]

              

              click griddy.nfl.models.GameInsightTypedDict href "" "griddy.nfl.models.GameInsightTypedDict"
            

Game-specific analytical insight

Attributes

content instance-attribute

content: NotRequired[ContentTypedDict]

Insight content and analysis

game_id instance-attribute

game_id: NotRequired[str]

Game identifier

id instance-attribute

id: NotRequired[str]

Insight identifier

type instance-attribute

type: NotRequired[str]

Type of insight

GameOdds

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GameOdds[GameOdds]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GameOdds
                


              click griddy.nfl.models.GameOdds href "" "griddy.nfl.models.GameOdds"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_id class-attribute instance-attribute

game_id: Annotated[Optional[int], Field(alias="gameId")] = (
    None
)

Game identifier (10-digit format YYYYMMDDNN)

game_key class-attribute instance-attribute

game_key: Annotated[
    Optional[int], Field(alias="gameKey")
] = None

Unique game key identifier

home_team_abbr class-attribute instance-attribute

home_team_abbr: Annotated[
    Optional[str], Field(alias="homeTeamAbbr")
] = None

Home team abbreviation

home_team_id class-attribute instance-attribute

home_team_id: Annotated[
    Optional[str], Field(alias="homeTeamId")
] = None

Home team identifier

moneyline class-attribute instance-attribute

moneyline: Optional[MoneyLine] = None

Money line betting odds

spread class-attribute instance-attribute

spread: Optional[PointSpread] = None

Point spread betting odds

totals class-attribute instance-attribute

totals: Optional[Totals] = None

Over/Under (totals) betting odds

updated_at class-attribute instance-attribute

updated_at: Annotated[
    Optional[datetime], Field(alias="updatedAt")
] = None

Timestamp of last odds update

visitor_team_abbr class-attribute instance-attribute

visitor_team_abbr: Annotated[
    Optional[str], Field(alias="visitorTeamAbbr")
] = None

Visitor team abbreviation

visitor_team_id class-attribute instance-attribute

visitor_team_id: Annotated[
    Optional[str], Field(alias="visitorTeamId")
] = None

Visitor team identifier

GameOddsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GameOddsTypedDict[GameOddsTypedDict]

              

              click griddy.nfl.models.GameOddsTypedDict href "" "griddy.nfl.models.GameOddsTypedDict"
            

Attributes

game_id instance-attribute

game_id: NotRequired[int]

Game identifier (10-digit format YYYYMMDDNN)

game_key instance-attribute

game_key: NotRequired[int]

Unique game key identifier

home_team_abbr instance-attribute

home_team_abbr: NotRequired[str]

Home team abbreviation

home_team_id instance-attribute

home_team_id: NotRequired[str]

Home team identifier

moneyline instance-attribute

moneyline: NotRequired[MoneyLineTypedDict]

Money line betting odds

spread instance-attribute

spread: NotRequired[PointSpreadTypedDict]

Point spread betting odds

totals instance-attribute

totals: NotRequired[TotalsTypedDict]

Over/Under (totals) betting odds

updated_at instance-attribute

updated_at: NotRequired[datetime]

Timestamp of last odds update

visitor_team_abbr instance-attribute

visitor_team_abbr: NotRequired[str]

Visitor team abbreviation

visitor_team_id instance-attribute

visitor_team_id: NotRequired[str]

Visitor team identifier

GameSchedule

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GameSchedule[GameSchedule]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GameSchedule
                


              click griddy.nfl.models.GameSchedule href "" "griddy.nfl.models.GameSchedule"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_date class-attribute instance-attribute

game_date: Annotated[
    Optional[str], Field(alias="gameDate")
] = None

Game date MM/DD/YYYY

game_time_eastern class-attribute instance-attribute

game_time_eastern: Annotated[
    Optional[str], Field(alias="gameTimeEastern")
] = None

Eastern time

game_type class-attribute instance-attribute

game_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="gameType")
] = None

Type of NFL season

home_team class-attribute instance-attribute

home_team: Annotated[
    Optional[TeamInfo], Field(alias="homeTeam")
] = None

Basic team information included in roster responses

iso_time class-attribute instance-attribute

iso_time: Annotated[
    Optional[int], Field(alias="isoTime")
] = None

ISO timestamp in milliseconds

network_channel class-attribute instance-attribute

network_channel: Annotated[
    Optional[str], Field(alias="networkChannel")
] = None

Broadcast network

ngs_game class-attribute instance-attribute

ngs_game: Annotated[
    Optional[bool], Field(alias="ngsGame")
] = None

Next Gen Stats available

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

visitor_team class-attribute instance-attribute

visitor_team: Annotated[
    Optional[TeamInfo], Field(alias="visitorTeam")
] = None

Basic team information included in roster responses

GameScheduleTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GameScheduleTypedDict[GameScheduleTypedDict]

              

              click griddy.nfl.models.GameScheduleTypedDict href "" "griddy.nfl.models.GameScheduleTypedDict"
            

Attributes

game_date instance-attribute

game_date: NotRequired[str]

Game date MM/DD/YYYY

game_time_eastern instance-attribute

game_time_eastern: NotRequired[str]

Eastern time

game_type instance-attribute

game_type: NotRequired[SeasonTypeEnum]

Type of NFL season

home_team instance-attribute

home_team: NotRequired[TeamInfoTypedDict]

Basic team information included in roster responses

iso_time instance-attribute

iso_time: NotRequired[int]

ISO timestamp in milliseconds

network_channel instance-attribute

network_channel: NotRequired[str]

Broadcast network

ngs_game instance-attribute

ngs_game: NotRequired[bool]

Next Gen Stats available

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

visitor_team instance-attribute

visitor_team: NotRequired[TeamInfoTypedDict]

Basic team information included in roster responses

GameScore

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GameScore[GameScore]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GameScore
                


              click griddy.nfl.models.GameScore href "" "griddy.nfl.models.GameScore"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

away_score class-attribute instance-attribute

away_score: Annotated[
    Optional[int], Field(alias="awayScore")
] = None

Away team current score

home_score class-attribute instance-attribute

home_score: Annotated[
    Optional[int], Field(alias="homeScore")
] = None

Home team current score

phase class-attribute instance-attribute

phase: Optional[GamePhaseEnum] = None

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

time class-attribute instance-attribute

time: Optional[str] = None

Game clock time or status

GameScoreTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GameScoreTypedDict[GameScoreTypedDict]

              

              click griddy.nfl.models.GameScoreTypedDict href "" "griddy.nfl.models.GameScoreTypedDict"
            

Attributes

away_score instance-attribute

away_score: NotRequired[int]

Away team current score

home_score instance-attribute

home_score: NotRequired[int]

Home team current score

phase instance-attribute

phase: NotRequired[GamePhaseEnum]

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

time instance-attribute

time: NotRequired[str]

Game clock time or status

GameSite

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GameSite[GameSite]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GameSite
                


              click griddy.nfl.models.GameSite href "" "griddy.nfl.models.GameSite"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

site_full_name class-attribute instance-attribute

site_full_name: Annotated[
    Optional[str], Field(alias="siteFullName")
] = None

Stadium name

GameSiteTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GameSiteTypedDict[GameSiteTypedDict]

              

              click griddy.nfl.models.GameSiteTypedDict href "" "griddy.nfl.models.GameSiteTypedDict"
            

Attributes

site_full_name instance-attribute

site_full_name: NotRequired[str]

Stadium name

GameTeam

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.GameTeam[GameTeam]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.GameTeam
                


              click griddy.nfl.models.GameTeam href "" "griddy.nfl.models.GameTeam"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

current_logo class-attribute instance-attribute

current_logo: Annotated[
    Optional[str], Field(alias="currentLogo")
] = None

URL to team logo (may contain formatInstructions placeholder)

GameTeamTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.GameTeamTypedDict[GameTeamTypedDict]

              

              click griddy.nfl.models.GameTeamTypedDict href "" "griddy.nfl.models.GameTeamTypedDict"
            

Attributes

current_logo instance-attribute

current_logo: NotRequired[str]

URL to team logo (may contain formatInstructions placeholder)

Score

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Score[Score]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Score
                


              click griddy.nfl.models.Score href "" "griddy.nfl.models.Score"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

total class-attribute instance-attribute

total: Optional[str] = None

Total score (empty string for future games)

ScoreTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ScoreTypedDict[ScoreTypedDict]

              

              click griddy.nfl.models.ScoreTypedDict href "" "griddy.nfl.models.ScoreTypedDict"
            

Attributes

total instance-attribute

total: NotRequired[str]

Total score (empty string for future games)

InjuryEntry

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.InjuryEntry[InjuryEntry]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.InjuryEntry
                


              click griddy.nfl.models.InjuryEntry href "" "griddy.nfl.models.InjuryEntry"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_status class-attribute instance-attribute

game_status: Annotated[
    Optional[InjuryEntryGameStatus],
    Field(alias="gameStatus"),
] = None

Game status designation

injury class-attribute instance-attribute

injury: Optional[str] = None

Injury description

InjuryEntryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.InjuryEntryTypedDict[InjuryEntryTypedDict]

              

              click griddy.nfl.models.InjuryEntryTypedDict href "" "griddy.nfl.models.InjuryEntryTypedDict"
            

Attributes

game_status instance-attribute

game_status: NotRequired[InjuryEntryGameStatus]

Game status designation

injury instance-attribute

injury: NotRequired[str]

Injury description

PracticeStatus

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PracticeStatus[PracticeStatus]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PracticeStatus
                


              click griddy.nfl.models.PracticeStatus href "" "griddy.nfl.models.PracticeStatus"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

friday class-attribute instance-attribute

friday: Optional[PracticeStatusEnum] = None

Player practice participation status

thursday class-attribute instance-attribute

thursday: Optional[PracticeStatusEnum] = None

Player practice participation status

wednesday class-attribute instance-attribute

wednesday: Optional[PracticeStatusEnum] = None

Player practice participation status

PracticeStatusTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PracticeStatusTypedDict[PracticeStatusTypedDict]

              

              click griddy.nfl.models.PracticeStatusTypedDict href "" "griddy.nfl.models.PracticeStatusTypedDict"
            

Attributes

friday instance-attribute

friday: NotRequired[PracticeStatusEnum]

Player practice participation status

thursday instance-attribute

thursday: NotRequired[PracticeStatusEnum]

Player practice participation status

wednesday instance-attribute

wednesday: NotRequired[PracticeStatusEnum]

Player practice participation status

Insight

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Insight[Insight]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Insight
                


              click griddy.nfl.models.Insight href "" "griddy.nfl.models.Insight"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

created_at instance-attribute

created_at: Annotated[datetime, Field(alias='createdAt')]

Content creation timestamp

created_by instance-attribute

created_by: Annotated[str, Field(alias='createdBy')]

Content creator identifier

date_ instance-attribute

date_: Annotated[date, Field(alias='date')]

Content publication date

id instance-attribute

id: str

Unique content identifier

nfl_id class-attribute instance-attribute

nfl_id: Annotated[Optional[int], Field(alias="nflId")] = (
    None
)

NFL player identifier

player_name class-attribute instance-attribute

player_name: Annotated[
    Optional[str], Field(alias="playerName")
] = None

Player's full name

position class-attribute instance-attribute

position: Optional[InsightPosition] = None

Player position

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

tags instance-attribute

tags: List[str]

Content classification tags

team_abbr instance-attribute

team_abbr: Annotated[str, Field(alias='teamAbbr')]

Player's team abbreviation

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Player's team identifier

title instance-attribute

title: str

Main insight headline or title

updated_at instance-attribute

updated_at: Annotated[datetime, Field(alias='updatedAt')]

Last update timestamp

updated_by instance-attribute

updated_by: Annotated[str, Field(alias='updatedBy')]

Last editor identifier

week instance-attribute

week: int

Week number (if applicable)

esb_id class-attribute instance-attribute

esb_id: Annotated[Optional[str], Field(alias="esbId")] = (
    None
)

ESB player identifier

evergreen class-attribute instance-attribute

evergreen: Optional[bool] = False

Whether content is evergreen (timeless) or time-sensitive

game_id class-attribute instance-attribute

game_id: Annotated[
    OptionalNullable[int], Field(alias="gameId")
] = UNSET

Game identifier (10-digit format YYYYMMDDNN)

gsis_id class-attribute instance-attribute

gsis_id: Annotated[Optional[str], Field(alias="gsisId")] = (
    None
)

GSIS player identifier

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image (contains formatInstructions placeholder)

image_url class-attribute instance-attribute

image_url: Annotated[
    OptionalNullable[str], Field(alias="imageUrl")
] = UNSET

Associated image or chart URL (optional)

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

second_team_abbr class-attribute instance-attribute

second_team_abbr: Annotated[
    OptionalNullable[str], Field(alias="secondTeamAbbr")
] = UNSET

Opponent or related team abbreviation

second_team_id class-attribute instance-attribute

second_team_id: Annotated[
    OptionalNullable[str], Field(alias="secondTeamId")
] = UNSET

Opponent or related team identifier

second_team_type class-attribute instance-attribute

second_team_type: Annotated[
    OptionalNullable[SecondTeamType],
    Field(alias="secondTeamType"),
] = UNSET

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

smart_id class-attribute instance-attribute

smart_id: Annotated[
    Optional[str], Field(alias="smartId")
] = None

Smart player identifier

sub_note1 class-attribute instance-attribute

sub_note1: Annotated[
    Optional[str], Field(alias="subNote1")
] = None

Detailed insight content and analysis

InsightTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.InsightTypedDict[InsightTypedDict]

              

              click griddy.nfl.models.InsightTypedDict href "" "griddy.nfl.models.InsightTypedDict"
            

Attributes

created_at instance-attribute

created_at: datetime

Content creation timestamp

created_by instance-attribute

created_by: str

Content creator identifier

date_ instance-attribute

date_: date

Content publication date

id instance-attribute

id: str

Unique content identifier

nfl_id instance-attribute

nfl_id: int

NFL player identifier

player_name instance-attribute

player_name: str

Player's full name

position instance-attribute

position: InsightPosition

Player position

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

tags instance-attribute

tags: List[str]

Content classification tags

team_abbr instance-attribute

team_abbr: str

Player's team abbreviation

team_id instance-attribute

team_id: str

Player's team identifier

title instance-attribute

title: str

Main insight headline or title

updated_at instance-attribute

updated_at: datetime

Last update timestamp

updated_by instance-attribute

updated_by: str

Last editor identifier

week instance-attribute

week: int

Week number (if applicable)

esb_id instance-attribute

esb_id: NotRequired[str]

ESB player identifier

evergreen instance-attribute

evergreen: NotRequired[bool]

Whether content is evergreen (timeless) or time-sensitive

game_id instance-attribute

game_id: NotRequired[Nullable[int]]

Game identifier (10-digit format YYYYMMDDNN)

gsis_id instance-attribute

gsis_id: NotRequired[str]

GSIS player identifier

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image (contains formatInstructions placeholder)

image_url instance-attribute

image_url: NotRequired[Nullable[str]]

Associated image or chart URL (optional)

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

second_team_abbr instance-attribute

second_team_abbr: NotRequired[Nullable[str]]

Opponent or related team abbreviation

second_team_id instance-attribute

second_team_id: NotRequired[Nullable[str]]

Opponent or related team identifier

second_team_type instance-attribute

second_team_type: NotRequired[Nullable[SecondTeamType]]

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

smart_id instance-attribute

smart_id: NotRequired[str]

Smart player identifier

sub_note1 instance-attribute

sub_note1: NotRequired[str]

Detailed insight content and analysis

LiveGame

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.LiveGame[LiveGame]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.LiveGame
                


              click griddy.nfl.models.LiveGame href "" "griddy.nfl.models.LiveGame"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Live game scoring and status information

Attributes

game_id class-attribute instance-attribute

game_id: Annotated[Optional[str], Field(alias="gameId")] = (
    None
)

Game identifier

last_play class-attribute instance-attribute

last_play: Annotated[
    Optional[str], Field(alias="lastPlay")
] = None

Description of last play

possession class-attribute instance-attribute

possession: Optional[str] = None

Team abbreviation with current possession

quarter class-attribute instance-attribute

quarter: Optional[str] = None

Current quarter/period

red_zone class-attribute instance-attribute

red_zone: Annotated[
    Optional[bool], Field(alias="redZone")
] = None

Whether team is in red zone

time_remaining class-attribute instance-attribute

time_remaining: Annotated[
    Optional[str], Field(alias="timeRemaining")
] = None

Time remaining in current period

LiveGameTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.LiveGameTypedDict[LiveGameTypedDict]

              

              click griddy.nfl.models.LiveGameTypedDict href "" "griddy.nfl.models.LiveGameTypedDict"
            

Live game scoring and status information

Attributes

game_id instance-attribute

game_id: NotRequired[str]

Game identifier

last_play instance-attribute

last_play: NotRequired[str]

Description of last play

possession instance-attribute

possession: NotRequired[str]

Team abbreviation with current possession

quarter instance-attribute

quarter: NotRequired[str]

Current quarter/period

red_zone instance-attribute

red_zone: NotRequired[bool]

Whether team is in red zone

time_remaining instance-attribute

time_remaining: NotRequired[str]

Time remaining in current period

MoneyLine

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.MoneyLine[MoneyLine]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.MoneyLine
                


              click griddy.nfl.models.MoneyLine href "" "griddy.nfl.models.MoneyLine"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Money line betting odds

Attributes

away_price class-attribute instance-attribute

away_price: Annotated[
    Optional[str], Field(alias="awayPrice")
] = None

Away team money line odds (American format)

home_price class-attribute instance-attribute

home_price: Annotated[
    Optional[str], Field(alias="homePrice")
] = None

Home team money line odds (American format)

MoneyLineTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.MoneyLineTypedDict[MoneyLineTypedDict]

              

              click griddy.nfl.models.MoneyLineTypedDict href "" "griddy.nfl.models.MoneyLineTypedDict"
            

Money line betting odds

Attributes

away_price instance-attribute

away_price: NotRequired[str]

Away team money line odds (American format)

home_price instance-attribute

home_price: NotRequired[str]

Home team money line odds (American format)

MultipleRankingsCategory

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.MultipleRankingsCategory[MultipleRankingsCategory]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.MultipleRankingsCategory
                


              click griddy.nfl.models.MultipleRankingsCategory href "" "griddy.nfl.models.MultipleRankingsCategory"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

stat_category class-attribute instance-attribute

stat_category: Annotated[
    Optional[str], Field(alias="statCategory")
] = None

Category of statistic

stat_name class-attribute instance-attribute

stat_name: Annotated[
    Optional[str], Field(alias="statName")
] = None

Name of specific statistic

MultipleRankingsCategoryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.MultipleRankingsCategoryTypedDict[MultipleRankingsCategoryTypedDict]

              

              click griddy.nfl.models.MultipleRankingsCategoryTypedDict href "" "griddy.nfl.models.MultipleRankingsCategoryTypedDict"
            

Attributes

stat_category instance-attribute

stat_category: NotRequired[str]

Category of statistic

stat_name instance-attribute

stat_name: NotRequired[str]

Name of specific statistic

OddsSelection

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.OddsSelection[OddsSelection]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.OddsSelection
                


              click griddy.nfl.models.OddsSelection href "" "griddy.nfl.models.OddsSelection"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

decimal class-attribute instance-attribute

decimal: Optional[float] = None

Decimal odds for this selection

is_available class-attribute instance-attribute

is_available: Annotated[
    Optional[bool], Field(alias="isAvailable")
] = None

Whether this selection is currently available for betting

name class-attribute instance-attribute

name: Optional[str] = None

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

OddsSelectionTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.OddsSelectionTypedDict[OddsSelectionTypedDict]

              

              click griddy.nfl.models.OddsSelectionTypedDict href "" "griddy.nfl.models.OddsSelectionTypedDict"
            

Attributes

decimal instance-attribute

decimal: NotRequired[float]

Decimal odds for this selection

is_available instance-attribute

is_available: NotRequired[bool]

Whether this selection is currently available for betting

name instance-attribute

name: NotRequired[str]

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

OverallRecord

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.OverallRecord[OverallRecord]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.OverallRecord
                


              click griddy.nfl.models.OverallRecord href "" "griddy.nfl.models.OverallRecord"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

games class-attribute instance-attribute

games: Optional[int] = None

Total games played

OverallRecordTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.OverallRecordTypedDict[OverallRecordTypedDict]

              

              click griddy.nfl.models.OverallRecordTypedDict href "" "griddy.nfl.models.OverallRecordTypedDict"
            

Attributes

games instance-attribute

games: NotRequired[int]

Total games played

Streak

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Streak[Streak]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Streak
                


              click griddy.nfl.models.Streak href "" "griddy.nfl.models.Streak"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

length class-attribute instance-attribute

length: Optional[int] = None

Length of current streak

type class-attribute instance-attribute

type: Optional[OverallRecordType] = None

Type of current streak

StreakTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.StreakTypedDict[StreakTypedDict]

              

              click griddy.nfl.models.StreakTypedDict href "" "griddy.nfl.models.StreakTypedDict"
            

Attributes

length instance-attribute

length: NotRequired[int]

Length of current streak

type instance-attribute

type: NotRequired[OverallRecordType]

Type of current streak

Pagination

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Pagination[Pagination]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Pagination
                


              click griddy.nfl.models.Pagination href "" "griddy.nfl.models.Pagination"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

limit class-attribute instance-attribute

limit: Optional[int] = None

Maximum items per page

token class-attribute instance-attribute

token: OptionalNullable[str] = UNSET

Token for next page of results

PaginationTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PaginationTypedDict[PaginationTypedDict]

              

              click griddy.nfl.models.PaginationTypedDict href "" "griddy.nfl.models.PaginationTypedDict"
            

Attributes

limit instance-attribute

limit: NotRequired[int]

Maximum items per page

token instance-attribute

token: NotRequired[Nullable[str]]

Token for next page of results

PlayDetail

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayDetail[PlayDetail]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayDetail
                


              click griddy.nfl.models.PlayDetail href "" "griddy.nfl.models.PlayDetail"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

absolute_yardline_number class-attribute instance-attribute

absolute_yardline_number: Annotated[
    Optional[int], Field(alias="absoluteYardlineNumber")
] = None

Absolute position on 100-yard field

down class-attribute instance-attribute

down: Optional[int] = None

Current down (0 for kickoff)

end_game_clock class-attribute instance-attribute

end_game_clock: Annotated[
    Optional[str], Field(alias="endGameClock")
] = None

Game clock at play end

expected_points class-attribute instance-attribute

expected_points: Annotated[
    Optional[float], Field(alias="expectedPoints")
] = None

Expected points value

expected_points_added class-attribute instance-attribute

expected_points_added: Annotated[
    Optional[float], Field(alias="expectedPointsAdded")
] = None

Expected points added on this play

game_clock class-attribute instance-attribute

game_clock: Annotated[
    Optional[str], Field(alias="gameClock")
] = None

Time on game clock

home_timeouts_left class-attribute instance-attribute

home_timeouts_left: Annotated[
    Optional[int], Field(alias="homeTimeoutsLeft")
] = None

Home team timeouts remaining

is_st_play class-attribute instance-attribute

is_st_play: Annotated[
    Optional[bool], Field(alias="isSTPlay")
] = None

Special teams play

play_description class-attribute instance-attribute

play_description: Annotated[
    Optional[str], Field(alias="playDescription")
] = None

Play description without jersey numbers

play_description_with_jersey_numbers class-attribute instance-attribute

play_description_with_jersey_numbers: Annotated[
    Optional[str],
    Field(alias="playDescriptionWithJerseyNumbers"),
] = None

Play description including jersey numbers

play_direction class-attribute instance-attribute

play_direction: Annotated[
    Optional[PlayDirection], Field(alias="playDirection")
] = None

Direction of play

play_state class-attribute instance-attribute

play_state: Annotated[
    Optional[PlayState], Field(alias="playState")
] = None

Review state of play

play_stats class-attribute instance-attribute

play_stats: Annotated[
    Optional[List[PlayStat]], Field(alias="playStats")
] = None

Individual player statistics for this play

play_type class-attribute instance-attribute

play_type: Annotated[
    Optional[str], Field(alias="playType")
] = None

Type of play

play_type_code class-attribute instance-attribute

play_type_code: Annotated[
    Optional[int], Field(alias="playTypeCode")
] = None

Numeric code for play type

possession_team_id class-attribute instance-attribute

possession_team_id: Annotated[
    Optional[str], Field(alias="possessionTeamId")
] = None

Team ID with possession

post_play_home_team_win_probability class-attribute instance-attribute

post_play_home_team_win_probability: Annotated[
    Optional[float],
    Field(alias="postPlayHomeTeamWinProbability"),
] = None

Home team win probability after play

post_play_visitor_team_win_probability class-attribute instance-attribute

post_play_visitor_team_win_probability: Annotated[
    Optional[float],
    Field(alias="postPlayVisitorTeamWinProbability"),
] = None

Visitor team win probability after play

pre_snap_home_team_win_probability class-attribute instance-attribute

pre_snap_home_team_win_probability: Annotated[
    Optional[float],
    Field(alias="preSnapHomeTeamWinProbability"),
] = None

Home team win probability before play

pre_snap_visitor_team_win_probability class-attribute instance-attribute

pre_snap_visitor_team_win_probability: Annotated[
    Optional[float],
    Field(alias="preSnapVisitorTeamWinProbability"),
] = None

Visitor team win probability before play

quarter class-attribute instance-attribute

quarter: Optional[int] = None

Current quarter

sequence class-attribute instance-attribute

sequence: Optional[int] = None

Play sequence number

start_game_clock class-attribute instance-attribute

start_game_clock: Annotated[
    Optional[str], Field(alias="startGameClock")
] = None

Game clock at play start

time_of_day_utc class-attribute instance-attribute

time_of_day_utc: Annotated[
    Optional[datetime], Field(alias="timeOfDayUTC")
] = None

UTC timestamp of play

visitor_timeouts_left class-attribute instance-attribute

visitor_timeouts_left: Annotated[
    Optional[int], Field(alias="visitorTimeoutsLeft")
] = None

Visitor team timeouts remaining

yardline class-attribute instance-attribute

yardline: Optional[str] = None

Field position

yardline_number class-attribute instance-attribute

yardline_number: Annotated[
    Optional[int], Field(alias="yardlineNumber")
] = None

Yard line number

yardline_side class-attribute instance-attribute

yardline_side: Annotated[
    Optional[str], Field(alias="yardlineSide")
] = None

Side of field

yards_to_go class-attribute instance-attribute

yards_to_go: Annotated[
    Optional[int], Field(alias="yardsToGo")
] = None

Yards needed for first down

PlayDetailTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayDetailTypedDict[PlayDetailTypedDict]

              

              click griddy.nfl.models.PlayDetailTypedDict href "" "griddy.nfl.models.PlayDetailTypedDict"
            

Attributes

absolute_yardline_number instance-attribute

absolute_yardline_number: NotRequired[int]

Absolute position on 100-yard field

down instance-attribute

down: NotRequired[int]

Current down (0 for kickoff)

end_game_clock instance-attribute

end_game_clock: NotRequired[str]

Game clock at play end

expected_points instance-attribute

expected_points: NotRequired[float]

Expected points value

expected_points_added instance-attribute

expected_points_added: NotRequired[float]

Expected points added on this play

game_clock instance-attribute

game_clock: NotRequired[str]

Time on game clock

home_timeouts_left instance-attribute

home_timeouts_left: NotRequired[int]

Home team timeouts remaining

is_st_play instance-attribute

is_st_play: NotRequired[bool]

Special teams play

play_description instance-attribute

play_description: NotRequired[str]

Play description without jersey numbers

play_description_with_jersey_numbers instance-attribute

play_description_with_jersey_numbers: NotRequired[str]

Play description including jersey numbers

play_direction instance-attribute

play_direction: NotRequired[PlayDirection]

Direction of play

play_state instance-attribute

play_state: NotRequired[PlayState]

Review state of play

play_stats instance-attribute

play_stats: NotRequired[List[PlayStatTypedDict]]

Individual player statistics for this play

play_type instance-attribute

play_type: NotRequired[str]

Type of play

play_type_code instance-attribute

play_type_code: NotRequired[int]

Numeric code for play type

possession_team_id instance-attribute

possession_team_id: NotRequired[str]

Team ID with possession

post_play_home_team_win_probability instance-attribute

post_play_home_team_win_probability: NotRequired[float]

Home team win probability after play

post_play_visitor_team_win_probability instance-attribute

post_play_visitor_team_win_probability: NotRequired[float]

Visitor team win probability after play

pre_snap_home_team_win_probability instance-attribute

pre_snap_home_team_win_probability: NotRequired[float]

Home team win probability before play

pre_snap_visitor_team_win_probability instance-attribute

pre_snap_visitor_team_win_probability: NotRequired[float]

Visitor team win probability before play

quarter instance-attribute

quarter: NotRequired[int]

Current quarter

sequence instance-attribute

sequence: NotRequired[int]

Play sequence number

start_game_clock instance-attribute

start_game_clock: NotRequired[str]

Game clock at play start

time_of_day_utc instance-attribute

time_of_day_utc: NotRequired[datetime]

UTC timestamp of play

visitor_timeouts_left instance-attribute

visitor_timeouts_left: NotRequired[int]

Visitor team timeouts remaining

yardline instance-attribute

yardline: NotRequired[str]

Field position

yardline_number instance-attribute

yardline_number: NotRequired[int]

Yard line number

yardline_side instance-attribute

yardline_side: NotRequired[str]

Side of field

yards_to_go instance-attribute

yards_to_go: NotRequired[int]

Yards needed for first down

PlayParticipant

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayParticipant[PlayParticipant]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayParticipant
                


              click griddy.nfl.models.PlayParticipant href "" "griddy.nfl.models.PlayParticipant"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

stats class-attribute instance-attribute

stats: Optional[PlayParticipantStats] = None

Play-specific statistics

PlayParticipantStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayParticipantStats[PlayParticipantStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayParticipantStats
                


              click griddy.nfl.models.PlayParticipantStats href "" "griddy.nfl.models.PlayParticipantStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Play-specific statistics

PlayParticipantStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayParticipantStatsTypedDict[PlayParticipantStatsTypedDict]

              

              click griddy.nfl.models.PlayParticipantStatsTypedDict href "" "griddy.nfl.models.PlayParticipantStatsTypedDict"
            

Play-specific statistics

PlayParticipantTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayParticipantTypedDict[PlayParticipantTypedDict]

              

              click griddy.nfl.models.PlayParticipantTypedDict href "" "griddy.nfl.models.PlayParticipantTypedDict"
            

Attributes

stats instance-attribute

stats: NotRequired[PlayParticipantStatsTypedDict]

Play-specific statistics

PlayPlayer

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayPlayer[PlayPlayer]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayPlayer
                


              click griddy.nfl.models.PlayPlayer href "" "griddy.nfl.models.PlayPlayer"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

gsis_id instance-attribute

gsis_id: Annotated[str, Field(alias='gsisId')]

GSIS player ID

nfl_id instance-attribute

nfl_id: Annotated[int, Field(alias='nflId')]

NFL player ID

player_name instance-attribute

player_name: Annotated[str, Field(alias='playerName')]

Full player name

position instance-attribute

position: str

Player position

position_group instance-attribute

position_group: Annotated[str, Field(alias="positionGroup")]

Position group

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team ID

uniform_number class-attribute instance-attribute

uniform_number: Annotated[
    Optional[str], Field(alias="uniformNumber")
] = None

Jersey number

PlayPlayerTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayPlayerTypedDict[PlayPlayerTypedDict]

              

              click griddy.nfl.models.PlayPlayerTypedDict href "" "griddy.nfl.models.PlayPlayerTypedDict"
            

Attributes

gsis_id instance-attribute

gsis_id: str

GSIS player ID

nfl_id instance-attribute

nfl_id: int

NFL player ID

player_name instance-attribute

player_name: str

Full player name

position instance-attribute

position: str

Player position

position_group instance-attribute

position_group: str

Position group

team_id instance-attribute

team_id: str

Team ID

uniform_number instance-attribute

uniform_number: NotRequired[str]

Jersey number

PlayStat

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayStat[PlayStat]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayStat
                


              click griddy.nfl.models.PlayStat href "" "griddy.nfl.models.PlayStat"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

club_code instance-attribute

club_code: Annotated[str, Field(alias='clubCode')]

Team abbreviation

gsis_id instance-attribute

gsis_id: Annotated[str, Field(alias='gsisId')]

Player GSIS ID

player_name instance-attribute

player_name: Annotated[str, Field(alias='playerName')]

Player name

stat_id instance-attribute

stat_id: Annotated[int, Field(alias='statId')]

Type of statistic

yards instance-attribute

yards: int

Yards gained/lost

PlayStatTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayStatTypedDict[PlayStatTypedDict]

              

              click griddy.nfl.models.PlayStatTypedDict href "" "griddy.nfl.models.PlayStatTypedDict"
            

Attributes

club_code instance-attribute

club_code: str

Team abbreviation

gsis_id instance-attribute

gsis_id: str

Player GSIS ID

player_name instance-attribute

player_name: str

Player name

stat_id instance-attribute

stat_id: int

Type of statistic

yards instance-attribute

yards: int

Yards gained/lost

PlayWinProbability

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayWinProbability[PlayWinProbability]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayWinProbability
                


              click griddy.nfl.models.PlayWinProbability href "" "griddy.nfl.models.PlayWinProbability"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

down instance-attribute

down: int

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

home_score instance-attribute

home_score: Annotated[int, Field(alias='homeScore')]

Home team score after the play

home_timeouts_left class-attribute instance-attribute

home_timeouts_left: Annotated[
    OptionalNullable[int], Field(alias="homeTimeoutsLeft")
] = None

Number of timeouts remaining for home team

play_description instance-attribute

play_description: Annotated[
    str, Field(alias="playDescription")
]

Detailed description of the play or game event

play_id instance-attribute

play_id: Annotated[int, Field(alias='playId')]

Unique play identifier

possession_team_id instance-attribute

possession_team_id: Annotated[
    str, Field(alias="possessionTeamId")
]

Team ID with possession (4-digit string)

pre_snap_home_score instance-attribute

pre_snap_home_score: Annotated[
    int, Field(alias="preSnapHomeScore")
]

Home team score before the play

pre_snap_visitor_score instance-attribute

pre_snap_visitor_score: Annotated[
    int, Field(alias="preSnapVisitorScore")
]

Visitor team score before the play

quarter instance-attribute

quarter: int

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

sequence instance-attribute

sequence: float

Play sequence number (can be decimal for special plays)

visitor_score instance-attribute

visitor_score: Annotated[int, Field(alias='visitorScore')]

Visitor team score after the play

visitor_timeouts_left class-attribute instance-attribute

visitor_timeouts_left: Annotated[
    OptionalNullable[int],
    Field(alias="visitorTimeoutsLeft"),
] = None

Number of timeouts remaining for visitor team

yards_to_go instance-attribute

yards_to_go: Annotated[int, Field(alias='yardsToGo')]

Yards needed for first down

home_team_win_probability_added class-attribute instance-attribute

home_team_win_probability_added: Annotated[
    OptionalNullable[float],
    Field(alias="homeTeamWinProbabilityAdded"),
] = 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: Annotated[
    OptionalNullable[float],
    Field(alias="postPlayHomeTeamWinProbability"),
] = 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: Annotated[
    OptionalNullable[float],
    Field(alias="postPlayVisitorTeamWinProbability"),
] = 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: Annotated[
    OptionalNullable[float],
    Field(alias="preSnapHomeTeamWinProbability"),
] = 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: Annotated[
    OptionalNullable[float],
    Field(alias="preSnapVisitorTeamWinProbability"),
] = 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: Annotated[
    OptionalNullable[float],
    Field(alias="visitorTeamWinProbabilityAdded"),
] = UNSET

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

yardline class-attribute instance-attribute

yardline: Optional[str] = None

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

yardline_number class-attribute instance-attribute

yardline_number: Annotated[
    OptionalNullable[int], Field(alias="yardlineNumber")
] = UNSET

Yard line number (null for special plays)

yardline_side class-attribute instance-attribute

yardline_side: Annotated[
    OptionalNullable[str], Field(alias="yardlineSide")
] = UNSET

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

PlayWinProbabilityTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayWinProbabilityTypedDict[PlayWinProbabilityTypedDict]

              

              click griddy.nfl.models.PlayWinProbabilityTypedDict href "" "griddy.nfl.models.PlayWinProbabilityTypedDict"
            

Attributes

down instance-attribute

down: int

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

home_score instance-attribute

home_score: int

Home team score after the play

home_timeouts_left instance-attribute

home_timeouts_left: NotRequired[int]

Number of timeouts remaining for home team

play_description instance-attribute

play_description: str

Detailed description of the play or game event

play_id instance-attribute

play_id: int

Unique play identifier

possession_team_id instance-attribute

possession_team_id: str

Team ID with possession (4-digit string)

pre_snap_home_score instance-attribute

pre_snap_home_score: int

Home team score before the play

pre_snap_visitor_score instance-attribute

pre_snap_visitor_score: int

Visitor team score before the play

quarter instance-attribute

quarter: int

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

sequence instance-attribute

sequence: float

Play sequence number (can be decimal for special plays)

visitor_score instance-attribute

visitor_score: int

Visitor team score after the play

visitor_timeouts_left instance-attribute

visitor_timeouts_left: NotRequired[int]

Number of timeouts remaining for visitor team

yards_to_go instance-attribute

yards_to_go: int

Yards needed for first down

home_team_win_probability_added instance-attribute

home_team_win_probability_added: NotRequired[
    Nullable[float]
]

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

post_play_home_team_win_probability instance-attribute

post_play_home_team_win_probability: NotRequired[
    Nullable[float]
]

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

post_play_visitor_team_win_probability instance-attribute

post_play_visitor_team_win_probability: NotRequired[
    Nullable[float]
]

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

pre_snap_home_team_win_probability instance-attribute

pre_snap_home_team_win_probability: NotRequired[
    Nullable[float]
]

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

pre_snap_visitor_team_win_probability instance-attribute

pre_snap_visitor_team_win_probability: NotRequired[
    Nullable[float]
]

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

visitor_team_win_probability_added instance-attribute

visitor_team_win_probability_added: NotRequired[
    Nullable[float]
]

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

yardline instance-attribute

yardline: NotRequired[str]

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

yardline_number instance-attribute

yardline_number: NotRequired[Nullable[int]]

Yard line number (null for special plays)

yardline_side instance-attribute

yardline_side: NotRequired[Nullable[str]]

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

Player

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Player[Player]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Player
                


              click griddy.nfl.models.Player href "" "griddy.nfl.models.Player"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

birth_date class-attribute instance-attribute

birth_date: Annotated[
    Optional[date], Field(alias=birthDate)
] = None

Player's birth date

college_conference class-attribute instance-attribute

college_conference: Annotated[
    Optional[str], Field(alias=collegeConference)
] = None

Player's college conference

college_name class-attribute instance-attribute

college_name: Annotated[
    Optional[str], Field(alias=collegeName)
] = None

Player's college

current_team_id class-attribute instance-attribute

current_team_id: Annotated[
    Optional[str], Field(alias=currentTeamId)
] = None

Current team identifier

display_name class-attribute instance-attribute

display_name: Annotated[
    Optional[str], Field(alias=displayName)
] = None

Player's display name

draft_club class-attribute instance-attribute

draft_club: Annotated[
    OptionalNullable[str], Field(alias=draftClub)
] = UNSET

Team that drafted the player

draft_number class-attribute instance-attribute

draft_number: Annotated[
    OptionalNullable[int], Field(alias=draftNumber)
] = UNSET

Overall draft pick number

draftround class-attribute instance-attribute

draftround: OptionalNullable[int] = UNSET

Draft round

entry_year class-attribute instance-attribute

entry_year: Annotated[
    Optional[int], Field(alias=entryYear)
] = None

Year player entered the league

esb_id class-attribute instance-attribute

esb_id: Annotated[Optional[str], Field(alias=esbId)] = None

ESB identifier

first_name class-attribute instance-attribute

first_name: Annotated[
    Optional[str], Field(alias=firstName)
] = None

Player's first name

football_name class-attribute instance-attribute

football_name: Annotated[
    Optional[str], Field(alias=footballName)
] = None

Player's football name (nickname)

gsis_id class-attribute instance-attribute

gsis_id: Annotated[Optional[str], Field(alias=gsisId)] = (
    None
)

GSIS identifier

gsis_it_id class-attribute instance-attribute

gsis_it_id: Annotated[
    Optional[int], Field(alias=gsisItId)
] = None

GSIS IT identifier

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image

height class-attribute instance-attribute

height: Optional[str] = None

Player height (format is feet-inches)

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias=jerseyNumber)
] = None

Player's jersey number

last_name class-attribute instance-attribute

last_name: Annotated[
    Optional[str], Field(alias=lastName)
] = None

Player's last name

nfl_id class-attribute instance-attribute

nfl_id: Annotated[Optional[int], Field(alias=nflId)] = None

NFL player identifier

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    OptionalNullable[str], Field(alias=ngsPosition)
] = UNSET

Next Gen Stats position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    OptionalNullable[str], Field(alias=ngsPositionGroup)
] = UNSET

Next Gen Stats position group

position class-attribute instance-attribute

position: Optional[str] = None

Player's position

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[str], Field(alias=positionGroup)
] = None

Player's position group

rookie_year class-attribute instance-attribute

rookie_year: Annotated[
    Optional[int], Field(alias=rookieYear)
] = None

Player's rookie year

season class-attribute instance-attribute

season: Optional[int] = None

Current season

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias=shortName)
] = None

Shortened player name

smart_id class-attribute instance-attribute

smart_id: Annotated[Optional[str], Field(alias=smartId)] = (
    None
)

Smart identifier for the player

status class-attribute instance-attribute

status: Optional[str] = None

Player status code

status_description_abbr class-attribute instance-attribute

status_description_abbr: Annotated[
    Optional[str], Field(alias=statusDescriptionAbbr)
] = None

Abbreviated status description

status_short_description class-attribute instance-attribute

status_short_description: Annotated[
    Optional[str], Field(alias=statusShortDescription)
] = None

Short status description

team_abbr class-attribute instance-attribute

team_abbr: Annotated[
    Optional[str], Field(alias=teamAbbr)
] = None

Current team abbreviation

uniform_number class-attribute instance-attribute

uniform_number: Annotated[
    Optional[str], Field(alias=uniformNumber)
] = None

Player's uniform number (formatted)

weight class-attribute instance-attribute

weight: Optional[int] = None

Player weight in pounds

years_of_experience class-attribute instance-attribute

years_of_experience: Annotated[
    Optional[int], Field(alias=yearsOfExperience)
] = None

Years of NFL experience

PlayerTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerTypedDict[PlayerTypedDict]

              

              click griddy.nfl.models.PlayerTypedDict href "" "griddy.nfl.models.PlayerTypedDict"
            

Attributes

birth_date instance-attribute

birth_date: NotRequired[date]

Player's birth date

college_conference instance-attribute

college_conference: NotRequired[str]

Player's college conference

college_name instance-attribute

college_name: NotRequired[str]

Player's college

current_team_id instance-attribute

current_team_id: NotRequired[str]

Current team identifier

display_name instance-attribute

display_name: NotRequired[str]

Player's display name

draft_club instance-attribute

draft_club: NotRequired[Nullable[str]]

Team that drafted the player

draft_number instance-attribute

draft_number: NotRequired[Nullable[int]]

Overall draft pick number

draftround instance-attribute

draftround: NotRequired[Nullable[int]]

Draft round

entry_year instance-attribute

entry_year: NotRequired[int]

Year player entered the league

esb_id instance-attribute

esb_id: NotRequired[str]

ESB identifier

first_name instance-attribute

first_name: NotRequired[str]

Player's first name

football_name instance-attribute

football_name: NotRequired[str]

Player's football name (nickname)

gsis_id instance-attribute

gsis_id: NotRequired[str]

GSIS identifier

gsis_it_id instance-attribute

gsis_it_id: NotRequired[int]

GSIS IT identifier

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image

height instance-attribute

height: NotRequired[str]

Player height (format is feet-inches)

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

last_name instance-attribute

last_name: NotRequired[str]

Player's last name

nfl_id instance-attribute

nfl_id: NotRequired[int]

NFL player identifier

ngs_position instance-attribute

ngs_position: NotRequired[Nullable[str]]

Next Gen Stats position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[Nullable[str]]

Next Gen Stats position group

position instance-attribute

position: NotRequired[str]

Player's position

position_group instance-attribute

position_group: NotRequired[str]

Player's position group

rookie_year instance-attribute

rookie_year: NotRequired[int]

Player's rookie year

season instance-attribute

season: NotRequired[int]

Current season

short_name instance-attribute

short_name: NotRequired[str]

Shortened player name

smart_id instance-attribute

smart_id: NotRequired[str]

Smart identifier for the player

status instance-attribute

status: NotRequired[str]

Player status code

status_description_abbr instance-attribute

status_description_abbr: NotRequired[str]

Abbreviated status description

status_short_description instance-attribute

status_short_description: NotRequired[str]

Short status description

team_abbr instance-attribute

team_abbr: NotRequired[str]

Current team abbreviation

uniform_number instance-attribute

uniform_number: NotRequired[str]

Player's uniform number (formatted)

weight instance-attribute

weight: NotRequired[int]

Player weight in pounds

years_of_experience instance-attribute

years_of_experience: NotRequired[int]

Years of NFL experience

PlayerDetail

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerDetail[PlayerDetail]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerDetail
                


              click griddy.nfl.models.PlayerDetail href "" "griddy.nfl.models.PlayerDetail"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

birth_date class-attribute instance-attribute

birth_date: Annotated[
    Optional[date], Field(alias=birthDate)
] = None

Player's birth date

college_conference class-attribute instance-attribute

college_conference: Annotated[
    Optional[str], Field(alias=collegeConference)
] = None

Player's college conference

college_name class-attribute instance-attribute

college_name: Annotated[
    Optional[str], Field(alias=collegeName)
] = None

Player's college

current_team_id class-attribute instance-attribute

current_team_id: Annotated[
    Optional[str], Field(alias=currentTeamId)
] = None

Current team identifier

display_name class-attribute instance-attribute

display_name: Annotated[
    Optional[str], Field(alias=displayName)
] = None

Player's display name

draft_club class-attribute instance-attribute

draft_club: Annotated[
    OptionalNullable[str], Field(alias=draftClub)
] = UNSET

Team that drafted the player

draft_number class-attribute instance-attribute

draft_number: Annotated[
    OptionalNullable[int], Field(alias=draftNumber)
] = UNSET

Overall draft pick number

draftround class-attribute instance-attribute

draftround: OptionalNullable[int] = UNSET

Draft round

entry_year class-attribute instance-attribute

entry_year: Annotated[
    Optional[int], Field(alias=entryYear)
] = None

Year player entered the league

esb_id class-attribute instance-attribute

esb_id: Annotated[Optional[str], Field(alias=esbId)] = None

ESB identifier

first_name class-attribute instance-attribute

first_name: Annotated[
    Optional[str], Field(alias=firstName)
] = None

Player's first name

football_name class-attribute instance-attribute

football_name: Annotated[
    Optional[str], Field(alias=footballName)
] = None

Player's football name (nickname)

gsis_id class-attribute instance-attribute

gsis_id: Annotated[Optional[str], Field(alias=gsisId)] = (
    None
)

GSIS identifier

gsis_it_id class-attribute instance-attribute

gsis_it_id: Annotated[
    Optional[int], Field(alias=gsisItId)
] = None

GSIS IT identifier

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image

height class-attribute instance-attribute

height: Optional[str] = None

Player height (format is feet-inches)

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias=jerseyNumber)
] = None

Player's jersey number

last_name class-attribute instance-attribute

last_name: Annotated[
    Optional[str], Field(alias=lastName)
] = None

Player's last name

nfl_id class-attribute instance-attribute

nfl_id: Annotated[Optional[int], Field(alias=nflId)] = None

NFL player identifier

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    OptionalNullable[str], Field(alias=ngsPosition)
] = UNSET

Next Gen Stats position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    OptionalNullable[str], Field(alias=ngsPositionGroup)
] = UNSET

Next Gen Stats position group

position class-attribute instance-attribute

position: Optional[str] = None

Player's position

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[str], Field(alias=positionGroup)
] = None

Player's position group

rookie_year class-attribute instance-attribute

rookie_year: Annotated[
    Optional[int], Field(alias=rookieYear)
] = None

Player's rookie year

season class-attribute instance-attribute

season: Optional[int] = None

Current season

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias=shortName)
] = None

Shortened player name

smart_id class-attribute instance-attribute

smart_id: Annotated[Optional[str], Field(alias=smartId)] = (
    None
)

Smart identifier for the player

status class-attribute instance-attribute

status: Optional[str] = None

Player status code

status_description_abbr class-attribute instance-attribute

status_description_abbr: Annotated[
    Optional[str], Field(alias=statusDescriptionAbbr)
] = None

Abbreviated status description

status_short_description class-attribute instance-attribute

status_short_description: Annotated[
    Optional[str], Field(alias=statusShortDescription)
] = None

Short status description

team_abbr class-attribute instance-attribute

team_abbr: Annotated[
    Optional[str], Field(alias=teamAbbr)
] = None

Current team abbreviation

uniform_number class-attribute instance-attribute

uniform_number: Annotated[
    Optional[str], Field(alias=uniformNumber)
] = None

Player's uniform number (formatted)

weight class-attribute instance-attribute

weight: Optional[int] = None

Player weight in pounds

years_of_experience class-attribute instance-attribute

years_of_experience: Annotated[
    Optional[int], Field(alias=yearsOfExperience)
] = None

Years of NFL experience

biography class-attribute instance-attribute

biography: Optional[str] = None

Player biography

PlayerDetailTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerDetailTypedDict[PlayerDetailTypedDict]

              

              click griddy.nfl.models.PlayerDetailTypedDict href "" "griddy.nfl.models.PlayerDetailTypedDict"
            

Attributes

birth_date instance-attribute

birth_date: NotRequired[date]

Player's birth date

college_conference instance-attribute

college_conference: NotRequired[str]

Player's college conference

college_name instance-attribute

college_name: NotRequired[str]

Player's college

current_team_id instance-attribute

current_team_id: NotRequired[str]

Current team identifier

display_name instance-attribute

display_name: NotRequired[str]

Player's display name

draft_club instance-attribute

draft_club: NotRequired[Nullable[str]]

Team that drafted the player

draft_number instance-attribute

draft_number: NotRequired[Nullable[int]]

Overall draft pick number

draftround instance-attribute

draftround: NotRequired[Nullable[int]]

Draft round

entry_year instance-attribute

entry_year: NotRequired[int]

Year player entered the league

esb_id instance-attribute

esb_id: NotRequired[str]

ESB identifier

first_name instance-attribute

first_name: NotRequired[str]

Player's first name

football_name instance-attribute

football_name: NotRequired[str]

Player's football name (nickname)

gsis_id instance-attribute

gsis_id: NotRequired[str]

GSIS identifier

gsis_it_id instance-attribute

gsis_it_id: NotRequired[int]

GSIS IT identifier

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image

height instance-attribute

height: NotRequired[str]

Player height (format is feet-inches)

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

last_name instance-attribute

last_name: NotRequired[str]

Player's last name

nfl_id instance-attribute

nfl_id: NotRequired[int]

NFL player identifier

ngs_position instance-attribute

ngs_position: NotRequired[Nullable[str]]

Next Gen Stats position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[Nullable[str]]

Next Gen Stats position group

position instance-attribute

position: NotRequired[str]

Player's position

position_group instance-attribute

position_group: NotRequired[str]

Player's position group

rookie_year instance-attribute

rookie_year: NotRequired[int]

Player's rookie year

season instance-attribute

season: NotRequired[int]

Current season

short_name instance-attribute

short_name: NotRequired[str]

Shortened player name

smart_id instance-attribute

smart_id: NotRequired[str]

Smart identifier for the player

status instance-attribute

status: NotRequired[str]

Player status code

status_description_abbr instance-attribute

status_description_abbr: NotRequired[str]

Abbreviated status description

status_short_description instance-attribute

status_short_description: NotRequired[str]

Short status description

team_abbr instance-attribute

team_abbr: NotRequired[str]

Current team abbreviation

uniform_number instance-attribute

uniform_number: NotRequired[str]

Player's uniform number (formatted)

weight instance-attribute

weight: NotRequired[int]

Player weight in pounds

years_of_experience instance-attribute

years_of_experience: NotRequired[int]

Years of NFL experience

biography instance-attribute

biography: NotRequired[str]

Player biography

PlayerPassingStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerPassingStats[PlayerPassingStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerPassingStats
                


              click griddy.nfl.models.PlayerPassingStats href "" "griddy.nfl.models.PlayerPassingStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

display_name instance-attribute

display_name: Annotated[str, Field(alias='displayName')]

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: Annotated[str, Field(alias='nflId')]

NFL player identifier

position instance-attribute

position: str

Player position

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

att class-attribute instance-attribute

att: Optional[int] = None

Attempts

att_pg class-attribute instance-attribute

att_pg: Annotated[Optional[float], Field(alias="attPG")] = (
    None
)

Attempts per game

avg_sep class-attribute instance-attribute

avg_sep: Annotated[
    Optional[float], Field(alias="avgSep")
] = None

Average receiver separation at target (yards)

avg_ttp class-attribute instance-attribute

avg_ttp: Annotated[
    Optional[float], Field(alias="avgTTP")
] = None

Average time to pass (seconds)

avg_tts class-attribute instance-attribute

avg_tts: Annotated[
    Optional[float], Field(alias="avgTTS")
] = None

Average time to sack (seconds)

avg_ttt class-attribute instance-attribute

avg_ttt: Annotated[
    Optional[float], Field(alias="avgTTT")
] = None

Average time to throw (seconds)

ay class-attribute instance-attribute

ay: Optional[float] = None

Air yards

ay_att class-attribute instance-attribute

ay_att: Annotated[Optional[float], Field(alias="ayAtt")] = (
    None
)

Air yards per attempt

blitz_r class-attribute instance-attribute

blitz_r: Annotated[
    Optional[float], Field(alias="blitzR")
] = None

Blitz rate faced

cmp class-attribute instance-attribute

cmp: Optional[int] = None

Completions

cmp_pg class-attribute instance-attribute

cmp_pg: Annotated[Optional[float], Field(alias="cmpPG")] = (
    None
)

Completions per game

cmp_pct class-attribute instance-attribute

cmp_pct: Annotated[
    Optional[float], Field(alias="cmpPct")
] = None

Completion percentage (0-1)

cpoe class-attribute instance-attribute

cpoe: Optional[float] = None

Completion percentage over expected

db class-attribute instance-attribute

db: Optional[int] = None

Dropbacks

db_pg class-attribute instance-attribute

db_pg: Annotated[Optional[float], Field(alias="dbPG")] = (
    None
)

Dropbacks per game

deep_att_pct class-attribute instance-attribute

deep_att_pct: Annotated[
    Optional[float], Field(alias="deepAttPct")
] = None

Deep attempt percentage (20+ air yards)

drop class-attribute instance-attribute

drop: Optional[int] = None

Dropped passes by receivers

drop_pg class-attribute instance-attribute

drop_pg: Annotated[
    Optional[float], Field(alias="dropPG")
] = None

Drops per game

drop_r class-attribute instance-attribute

drop_r: Annotated[Optional[float], Field(alias="dropR")] = (
    None
)

Drop rate

epa class-attribute instance-attribute

epa: Optional[float] = None

Expected Points Added

epa_db class-attribute instance-attribute

epa_db: Annotated[Optional[float], Field(alias="epaDb")] = (
    None
)

EPA per dropback

epa_pg class-attribute instance-attribute

epa_pg: Annotated[Optional[float], Field(alias="epaPG")] = (
    None
)

EPA per game

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image (contains formatInstructions placeholder)

int_ class-attribute instance-attribute

int_: Annotated[Optional[int], Field(alias='int')] = None

Interceptions

int_pg class-attribute instance-attribute

int_pg: Annotated[Optional[float], Field(alias="intPG")] = (
    None
)

Interceptions per game

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    Optional[str], Field(alias="ngsPosition")
] = None

Next Gen Stats position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    Optional[str], Field(alias="ngsPositionGroup")
] = None

Next Gen Stats position group

pa_db_pct class-attribute instance-attribute

pa_db_pct: Annotated[
    Optional[float], Field(alias="paDbPct")
] = None

Play action dropback percentage

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[str], Field(alias="positionGroup")
] = None

Position group

qbp class-attribute instance-attribute

qbp: Optional[int] = None

Times under QB pressure

qbp_pg class-attribute instance-attribute

qbp_pg: Annotated[Optional[float], Field(alias="qbpPG")] = (
    None
)

QB pressure per game

qbp_r class-attribute instance-attribute

qbp_r: Annotated[Optional[float], Field(alias="qbpR")] = (
    None
)

QB pressure rate

qp class-attribute instance-attribute

qp: Optional[bool] = None

Qualified passer status

rating class-attribute instance-attribute

rating: Optional[float] = None

Passer rating

sack class-attribute instance-attribute

sack: Optional[int] = None

Times sacked

sack_pg class-attribute instance-attribute

sack_pg: Annotated[
    Optional[float], Field(alias="sackPG")
] = None

Sacks per game

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Abbreviated player name

td class-attribute instance-attribute

td: Optional[int] = None

Touchdown passes

td_pg class-attribute instance-attribute

td_pg: Annotated[Optional[float], Field(alias="tdPG")] = (
    None
)

Touchdowns per game

tg class-attribute instance-attribute

tg: Optional[int] = None

Team games for player

total_tg class-attribute instance-attribute

total_tg: Annotated[
    Optional[int], Field(alias="totalTg")
] = None

Total team games in period

tw_att_pg class-attribute instance-attribute

tw_att_pg: Annotated[
    Optional[float], Field(alias="twAttPG")
] = None

Two-minute attempts per game

tw_att_pct class-attribute instance-attribute

tw_att_pct: Annotated[
    Optional[float], Field(alias="twAttPct")
] = None

Two-minute drill attempt percentage

x_cmp class-attribute instance-attribute

x_cmp: Annotated[Optional[float], Field(alias="xCmp")] = (
    None
)

Expected completion percentage

x_yac class-attribute instance-attribute

x_yac: Annotated[Optional[float], Field(alias="xYac")] = (
    None
)

Expected yards after catch

yac class-attribute instance-attribute

yac: Optional[float] = None

Yards after catch

yac_pct class-attribute instance-attribute

yac_pct: Annotated[
    Optional[float], Field(alias="yacPct")
] = None

YAC percentage of total yards

yds class-attribute instance-attribute

yds: Optional[int] = None

Passing yards

yds_pg class-attribute instance-attribute

yds_pg: Annotated[Optional[float], Field(alias="ydsPG")] = (
    None
)

Yards per game

ypa class-attribute instance-attribute

ypa: Optional[float] = None

Yards per attempt

PlayerPassingStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerPassingStatsTypedDict[PlayerPassingStatsTypedDict]

              

              click griddy.nfl.models.PlayerPassingStatsTypedDict href "" "griddy.nfl.models.PlayerPassingStatsTypedDict"
            

Attributes

display_name instance-attribute

display_name: str

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: str

NFL player identifier

position instance-attribute

position: str

Player position

team_id instance-attribute

team_id: str

Team identifier

att instance-attribute

att: NotRequired[int]

Attempts

att_pg instance-attribute

att_pg: NotRequired[float]

Attempts per game

avg_sep instance-attribute

avg_sep: NotRequired[float]

Average receiver separation at target (yards)

avg_ttp instance-attribute

avg_ttp: NotRequired[float]

Average time to pass (seconds)

avg_tts instance-attribute

avg_tts: NotRequired[float]

Average time to sack (seconds)

avg_ttt instance-attribute

avg_ttt: NotRequired[float]

Average time to throw (seconds)

ay instance-attribute

ay: NotRequired[float]

Air yards

ay_att instance-attribute

ay_att: NotRequired[float]

Air yards per attempt

blitz_r instance-attribute

blitz_r: NotRequired[float]

Blitz rate faced

cmp instance-attribute

cmp: NotRequired[int]

Completions

cmp_pg instance-attribute

cmp_pg: NotRequired[float]

Completions per game

cmp_pct instance-attribute

cmp_pct: NotRequired[float]

Completion percentage (0-1)

cpoe instance-attribute

cpoe: NotRequired[float]

Completion percentage over expected

db instance-attribute

db: NotRequired[int]

Dropbacks

db_pg instance-attribute

db_pg: NotRequired[float]

Dropbacks per game

deep_att_pct instance-attribute

deep_att_pct: NotRequired[float]

Deep attempt percentage (20+ air yards)

drop instance-attribute

drop: NotRequired[int]

Dropped passes by receivers

drop_pg instance-attribute

drop_pg: NotRequired[float]

Drops per game

drop_r instance-attribute

drop_r: NotRequired[float]

Drop rate

epa instance-attribute

epa: NotRequired[float]

Expected Points Added

epa_db instance-attribute

epa_db: NotRequired[float]

EPA per dropback

epa_pg instance-attribute

epa_pg: NotRequired[float]

EPA per game

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image (contains formatInstructions placeholder)

int_ instance-attribute

int_: NotRequired[int]

Interceptions

int_pg instance-attribute

int_pg: NotRequired[float]

Interceptions per game

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

ngs_position instance-attribute

ngs_position: NotRequired[str]

Next Gen Stats position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[str]

Next Gen Stats position group

pa_db_pct instance-attribute

pa_db_pct: NotRequired[float]

Play action dropback percentage

position_group instance-attribute

position_group: NotRequired[str]

Position group

qbp instance-attribute

qbp: NotRequired[int]

Times under QB pressure

qbp_pg instance-attribute

qbp_pg: NotRequired[float]

QB pressure per game

qbp_r instance-attribute

qbp_r: NotRequired[float]

QB pressure rate

qp instance-attribute

qp: NotRequired[bool]

Qualified passer status

rating instance-attribute

rating: NotRequired[float]

Passer rating

sack instance-attribute

sack: NotRequired[int]

Times sacked

sack_pg instance-attribute

sack_pg: NotRequired[float]

Sacks per game

short_name instance-attribute

short_name: NotRequired[str]

Abbreviated player name

td instance-attribute

td: NotRequired[int]

Touchdown passes

td_pg instance-attribute

td_pg: NotRequired[float]

Touchdowns per game

tg instance-attribute

tg: NotRequired[int]

Team games for player

total_tg instance-attribute

total_tg: NotRequired[int]

Total team games in period

tw_att_pg instance-attribute

tw_att_pg: NotRequired[float]

Two-minute attempts per game

tw_att_pct instance-attribute

tw_att_pct: NotRequired[float]

Two-minute drill attempt percentage

x_cmp instance-attribute

x_cmp: NotRequired[float]

Expected completion percentage

x_yac instance-attribute

x_yac: NotRequired[float]

Expected yards after catch

yac instance-attribute

yac: NotRequired[float]

Yards after catch

yac_pct instance-attribute

yac_pct: NotRequired[float]

YAC percentage of total yards

yds instance-attribute

yds: NotRequired[int]

Passing yards

yds_pg instance-attribute

yds_pg: NotRequired[float]

Yards per game

ypa instance-attribute

ypa: NotRequired[float]

Yards per attempt

PlayerProjection

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerProjection[PlayerProjection]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerProjection
                


              click griddy.nfl.models.PlayerProjection href "" "griddy.nfl.models.PlayerProjection"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

id instance-attribute

id: str

Player SMART ID

type instance-attribute

type: TypePlayer

Resource type

PlayerProjectionTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerProjectionTypedDict[PlayerProjectionTypedDict]

              

              click griddy.nfl.models.PlayerProjectionTypedDict href "" "griddy.nfl.models.PlayerProjectionTypedDict"
            

Attributes

id instance-attribute

id: str

Player SMART ID

type instance-attribute

type: TypePlayer

Resource type

WeekPoint

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WeekPoint[WeekPoint]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WeekPoint
                


              click griddy.nfl.models.WeekPoint href "" "griddy.nfl.models.WeekPoint"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Reference to projected points

WeekPointTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeekPointTypedDict[WeekPointTypedDict]

              

              click griddy.nfl.models.WeekPointTypedDict href "" "griddy.nfl.models.WeekPointTypedDict"
            

Attributes

id instance-attribute

id: NotRequired[str]

Reference to projected points

WeekStat

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WeekStat[WeekStat]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WeekStat
                


              click griddy.nfl.models.WeekStat href "" "griddy.nfl.models.WeekStat"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Reference to projected stats

WeekStatTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeekStatTypedDict[WeekStatTypedDict]

              

              click griddy.nfl.models.WeekStatTypedDict href "" "griddy.nfl.models.WeekStatTypedDict"
            

Attributes

id instance-attribute

id: NotRequired[str]

Reference to projected stats

PlayerReceivingStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerReceivingStats[PlayerReceivingStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerReceivingStats
                


              click griddy.nfl.models.PlayerReceivingStats href "" "griddy.nfl.models.PlayerReceivingStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

display_name instance-attribute

display_name: Annotated[str, Field(alias='displayName')]

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: Annotated[str, Field(alias='nflId')]

NFL player identifier

position instance-attribute

position: OffensivePlayerPositionEnum

Offensive skill position (excluding QB)

rec instance-attribute

rec: int

Receptions

rt instance-attribute

rt: int

Routes run

td instance-attribute

td: int

Touchdown receptions

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

tgt instance-attribute

tgt: int

Targets

yds instance-attribute

yds: int

Receiving yards

avg_rt_dep class-attribute instance-attribute

avg_rt_dep: Annotated[
    Optional[float], Field(alias="avgRtDep")
] = None

Average route depth (yards)

avg_sep class-attribute instance-attribute

avg_sep: Annotated[
    Optional[float], Field(alias="avgSep")
] = None

Average receiver separation at target (yards)

ay class-attribute instance-attribute

ay: Optional[float] = None

Air yards

ay_pg class-attribute instance-attribute

ay_pg: Annotated[Optional[float], Field(alias="ayPG")] = (
    None
)

Air yards per game

ay_tgt class-attribute instance-attribute

ay_tgt: Annotated[Optional[float], Field(alias="ayTgt")] = (
    None
)

Air yards per target

catch class-attribute instance-attribute

catch: Optional[float] = None

Catch rate (0-1)

croe class-attribute instance-attribute

croe: Optional[float] = None

Catch Rate Over Expected

deep_tgt_pct class-attribute instance-attribute

deep_tgt_pct: Annotated[
    Optional[float], Field(alias="deepTgtPct")
] = None

Deep target percentage (20+ air yards)

drop class-attribute instance-attribute

drop: Optional[int] = None

Dropped passes

drop_pg class-attribute instance-attribute

drop_pg: Annotated[
    Optional[float], Field(alias="dropPG")
] = None

Drops per game

drop_tgt class-attribute instance-attribute

drop_tgt: Annotated[
    Optional[float], Field(alias="dropTgt")
] = None

Drop rate (0-1)

epa class-attribute instance-attribute

epa: Optional[float] = None

Expected Points Added

epa_pg class-attribute instance-attribute

epa_pg: Annotated[Optional[float], Field(alias="epaPG")] = (
    None
)

EPA per game

epa_rt class-attribute instance-attribute

epa_rt: Annotated[Optional[float], Field(alias="epaRt")] = (
    None
)

EPA per route run

epa_tgt class-attribute instance-attribute

epa_tgt: Annotated[
    Optional[float], Field(alias="epaTgt")
] = None

EPA per target

ez_rec class-attribute instance-attribute

ez_rec: Annotated[Optional[int], Field(alias="ezRec")] = (
    None
)

End zone receptions

ez_rec_pg class-attribute instance-attribute

ez_rec_pg: Annotated[
    Optional[float], Field(alias="ezRecPG")
] = None

End zone receptions per game

ez_tgt class-attribute instance-attribute

ez_tgt: Annotated[Optional[int], Field(alias="ezTgt")] = (
    None
)

End zone targets

ez_tgt_pg class-attribute instance-attribute

ez_tgt_pg: Annotated[
    Optional[float], Field(alias="ezTgtPG")
] = None

End zone targets per game

fapi_game_id class-attribute instance-attribute

fapi_game_id: Annotated[
    Optional[str], Field(alias="fapiGameId")
] = None

Football API game identifier

final_score class-attribute instance-attribute

final_score: Annotated[
    Optional[str], Field(alias="finalScore")
] = None

Final score of the game

game_id class-attribute instance-attribute

game_id: Annotated[Optional[int], Field(alias="gameId")] = (
    None
)

Game identifier (10-digit format YYYYMMDDNN)

game_result class-attribute instance-attribute

game_result: Annotated[
    Optional[GameResultEnum], Field(alias="gameResult")
] = None

Game result (Win/Loss/Tie)

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image (contains formatInstructions placeholder)

int_ class-attribute instance-attribute

int_: Annotated[Optional[int], Field(alias='int')] = None

Interceptions thrown on targets to this receiver

int_pg class-attribute instance-attribute

int_pg: Annotated[Optional[float], Field(alias="intPG")] = (
    None
)

Interceptions per game

is_home class-attribute instance-attribute

is_home: Annotated[
    Optional[bool], Field(alias="isHome")
] = None

Whether player's team was at home

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    Optional[OffensivePlayerPositionEnum],
    Field(alias="ngsPosition"),
] = None

Offensive skill position (excluding QB)

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    Optional[OffensivePlayerPositionEnum],
    Field(alias="ngsPositionGroup"),
] = None

Offensive skill position (excluding QB)

opponent_team_id class-attribute instance-attribute

opponent_team_id: Annotated[
    Optional[str], Field(alias="opponentTeamId")
] = None

Opponent team identifier

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[OffensivePlayerPositionEnum],
    Field(alias="positionGroup"),
] = None

Offensive skill position (excluding QB)

qr class-attribute instance-attribute

qr: Optional[bool] = None

Qualified receiver status

rating class-attribute instance-attribute

rating: Optional[float] = None

Passer rating when targeting this receiver

rec_pg class-attribute instance-attribute

rec_pg: Annotated[Optional[float], Field(alias="recPG")] = (
    None
)

Receptions per game

rt_pg class-attribute instance-attribute

rt_pg: Annotated[Optional[float], Field(alias="rtPG")] = (
    None
)

Routes per game

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Abbreviated player name

td_pg class-attribute instance-attribute

td_pg: Annotated[Optional[float], Field(alias="tdPG")] = (
    None
)

Touchdowns per game

tg class-attribute instance-attribute

tg: Optional[int] = None

Team games for player

tgt_pg class-attribute instance-attribute

tgt_pg: Annotated[Optional[float], Field(alias="tgtPG")] = (
    None
)

Targets per game

tgt_rt class-attribute instance-attribute

tgt_rt: Annotated[Optional[float], Field(alias="tgtRt")] = (
    None
)

Target rate (targets per route run)

total_tg class-attribute instance-attribute

total_tg: Annotated[
    Optional[int], Field(alias="totalTg")
] = None

Total team games in period

tw_pct class-attribute instance-attribute

tw_pct: Annotated[Optional[float], Field(alias="twPct")] = (
    None
)

Tight window percentage

week_slug class-attribute instance-attribute

week_slug: Annotated[
    Optional[str], Field(alias="weekSlug")
] = None

Week identifier slug

x_catch class-attribute instance-attribute

x_catch: Annotated[
    Optional[float], Field(alias="xCatch")
] = None

Expected catch rate (0-1)

x_yac class-attribute instance-attribute

x_yac: Annotated[Optional[float], Field(alias="xYac")] = (
    None
)

Expected yards after catch

x_yac_pg class-attribute instance-attribute

x_yac_pg: Annotated[
    Optional[float], Field(alias="xYacPG")
] = None

Expected YAC per game

yac class-attribute instance-attribute

yac: Optional[float] = None

Yards after catch

yac_pg class-attribute instance-attribute

yac_pg: Annotated[Optional[float], Field(alias="yacPG")] = (
    None
)

YAC per game

yac_rec class-attribute instance-attribute

yac_rec: Annotated[
    Optional[float], Field(alias="yacRec")
] = None

YAC per reception

yacoe class-attribute instance-attribute

yacoe: Optional[float] = None

Yards after catch over expected

yacoe_pg class-attribute instance-attribute

yacoe_pg: Annotated[
    Optional[float], Field(alias="yacoePG")
] = None

YACOE per game

yds_pg class-attribute instance-attribute

yds_pg: Annotated[Optional[float], Field(alias="ydsPG")] = (
    None
)

Yards per game

yds_rec class-attribute instance-attribute

yds_rec: Annotated[
    Optional[float], Field(alias="ydsRec")
] = None

Yards per reception

yds_rt class-attribute instance-attribute

yds_rt: Annotated[Optional[float], Field(alias="ydsRt")] = (
    None
)

Yards per route run

PlayerReceivingStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerReceivingStatsTypedDict[PlayerReceivingStatsTypedDict]

              

              click griddy.nfl.models.PlayerReceivingStatsTypedDict href "" "griddy.nfl.models.PlayerReceivingStatsTypedDict"
            

Attributes

display_name instance-attribute

display_name: str

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: str

NFL player identifier

position instance-attribute

position: OffensivePlayerPositionEnum

Offensive skill position (excluding QB)

rec instance-attribute

rec: int

Receptions

rt instance-attribute

rt: int

Routes run

td instance-attribute

td: int

Touchdown receptions

team_id instance-attribute

team_id: str

Team identifier

tgt instance-attribute

tgt: int

Targets

yds instance-attribute

yds: int

Receiving yards

avg_rt_dep instance-attribute

avg_rt_dep: NotRequired[float]

Average route depth (yards)

avg_sep instance-attribute

avg_sep: NotRequired[float]

Average receiver separation at target (yards)

ay instance-attribute

ay: NotRequired[float]

Air yards

ay_pg instance-attribute

ay_pg: NotRequired[float]

Air yards per game

ay_tgt instance-attribute

ay_tgt: NotRequired[float]

Air yards per target

catch instance-attribute

catch: NotRequired[float]

Catch rate (0-1)

croe instance-attribute

croe: NotRequired[float]

Catch Rate Over Expected

deep_tgt_pct instance-attribute

deep_tgt_pct: NotRequired[float]

Deep target percentage (20+ air yards)

drop instance-attribute

drop: NotRequired[int]

Dropped passes

drop_pg instance-attribute

drop_pg: NotRequired[float]

Drops per game

drop_tgt instance-attribute

drop_tgt: NotRequired[float]

Drop rate (0-1)

epa instance-attribute

epa: NotRequired[float]

Expected Points Added

epa_pg instance-attribute

epa_pg: NotRequired[float]

EPA per game

epa_rt instance-attribute

epa_rt: NotRequired[float]

EPA per route run

epa_tgt instance-attribute

epa_tgt: NotRequired[float]

EPA per target

ez_rec instance-attribute

ez_rec: NotRequired[int]

End zone receptions

ez_rec_pg instance-attribute

ez_rec_pg: NotRequired[float]

End zone receptions per game

ez_tgt instance-attribute

ez_tgt: NotRequired[int]

End zone targets

ez_tgt_pg instance-attribute

ez_tgt_pg: NotRequired[float]

End zone targets per game

fapi_game_id instance-attribute

fapi_game_id: NotRequired[str]

Football API game identifier

final_score instance-attribute

final_score: NotRequired[str]

Final score of the game

game_id instance-attribute

game_id: NotRequired[int]

Game identifier (10-digit format YYYYMMDDNN)

game_result instance-attribute

game_result: NotRequired[GameResultEnum]

Game result (Win/Loss/Tie)

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image (contains formatInstructions placeholder)

int_ instance-attribute

int_: NotRequired[int]

Interceptions thrown on targets to this receiver

int_pg instance-attribute

int_pg: NotRequired[float]

Interceptions per game

is_home instance-attribute

is_home: NotRequired[bool]

Whether player's team was at home

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

ngs_position instance-attribute

ngs_position: NotRequired[OffensivePlayerPositionEnum]

Offensive skill position (excluding QB)

ngs_position_group instance-attribute

ngs_position_group: NotRequired[OffensivePlayerPositionEnum]

Offensive skill position (excluding QB)

opponent_team_id instance-attribute

opponent_team_id: NotRequired[str]

Opponent team identifier

position_group instance-attribute

position_group: NotRequired[OffensivePlayerPositionEnum]

Offensive skill position (excluding QB)

qr instance-attribute

qr: NotRequired[bool]

Qualified receiver status

rating instance-attribute

rating: NotRequired[float]

Passer rating when targeting this receiver

rec_pg instance-attribute

rec_pg: NotRequired[float]

Receptions per game

rt_pg instance-attribute

rt_pg: NotRequired[float]

Routes per game

short_name instance-attribute

short_name: NotRequired[str]

Abbreviated player name

td_pg instance-attribute

td_pg: NotRequired[float]

Touchdowns per game

tg instance-attribute

tg: NotRequired[int]

Team games for player

tgt_pg instance-attribute

tgt_pg: NotRequired[float]

Targets per game

tgt_rt instance-attribute

tgt_rt: NotRequired[float]

Target rate (targets per route run)

total_tg instance-attribute

total_tg: NotRequired[int]

Total team games in period

tw_pct instance-attribute

tw_pct: NotRequired[float]

Tight window percentage

week_slug instance-attribute

week_slug: NotRequired[str]

Week identifier slug

x_catch instance-attribute

x_catch: NotRequired[float]

Expected catch rate (0-1)

x_yac instance-attribute

x_yac: NotRequired[float]

Expected yards after catch

x_yac_pg instance-attribute

x_yac_pg: NotRequired[float]

Expected YAC per game

yac instance-attribute

yac: NotRequired[float]

Yards after catch

yac_pg instance-attribute

yac_pg: NotRequired[float]

YAC per game

yac_rec instance-attribute

yac_rec: NotRequired[float]

YAC per reception

yacoe instance-attribute

yacoe: NotRequired[float]

Yards after catch over expected

yacoe_pg instance-attribute

yacoe_pg: NotRequired[float]

YACOE per game

yds_pg instance-attribute

yds_pg: NotRequired[float]

Yards per game

yds_rec instance-attribute

yds_rec: NotRequired[float]

Yards per reception

yds_rt instance-attribute

yds_rt: NotRequired[float]

Yards per route run

PlayerRushingStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerRushingStats[PlayerRushingStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerRushingStats
                


              click griddy.nfl.models.PlayerRushingStats href "" "griddy.nfl.models.PlayerRushingStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

att instance-attribute

att: int

Rushing attempts

display_name instance-attribute

display_name: Annotated[str, Field(alias='displayName')]

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: Annotated[str, Field(alias='nflId')]

NFL player identifier

position instance-attribute

position: OffensivePlayerPositionEnum

Offensive player position

td instance-attribute

td: int

Rushing touchdowns

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

yds instance-attribute

yds: int

Rushing yards

ypc instance-attribute

ypc: float

Yards per carry

att_pg class-attribute instance-attribute

att_pg: Annotated[Optional[float], Field(alias="attPG")] = (
    None
)

Attempts per game

eff class-attribute instance-attribute

eff: Optional[float] = None

Efficiency rating

epa class-attribute instance-attribute

epa: Optional[float] = None

Expected Points Added

epa_att class-attribute instance-attribute

epa_att: Annotated[
    Optional[float], Field(alias="epaAtt")
] = None

EPA per attempt

epa_pg class-attribute instance-attribute

epa_pg: Annotated[Optional[float], Field(alias="epaPG")] = (
    None
)

EPA per game

fum class-attribute instance-attribute

fum: Optional[int] = None

Fumbles

fum_pg class-attribute instance-attribute

fum_pg: Annotated[Optional[float], Field(alias="fumPG")] = (
    None
)

Fumbles per game

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image (contains formatInstructions placeholder)

in_t_pct class-attribute instance-attribute

in_t_pct: Annotated[
    Optional[float], Field(alias="inTPct")
] = None

Inside tackles percentage (0-1)

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

lost class-attribute instance-attribute

lost: Optional[int] = None

Fumbles lost

lost_pg class-attribute instance-attribute

lost_pg: Annotated[
    Optional[float], Field(alias="lostPG")
] = None

Fumbles lost per game

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    Optional[OffensivePlayerPositionEnum],
    Field(alias="ngsPosition"),
] = None

Offensive player position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    Optional[OffensivePlayerPositionEnum],
    Field(alias="ngsPositionGroup"),
] = None

Offensive player position

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[OffensivePlayerPositionEnum],
    Field(alias="positionGroup"),
] = None

Offensive player position

qr class-attribute instance-attribute

qr: Optional[bool] = None

Qualified rusher status

rush10_p_yds class-attribute instance-attribute

rush10_p_yds: Annotated[
    Optional[int], Field(alias="rush10PYds")
] = None

Rushes of 10+ yards

rush10_p_yds_pg class-attribute instance-attribute

rush10_p_yds_pg: Annotated[
    Optional[float], Field(alias="rush10PYdsPG")
] = None

10+ yard rushes per game

rush15_p_mph class-attribute instance-attribute

rush15_p_mph: Annotated[
    Optional[int], Field(alias="rush15PMph")
] = None

Rushes of 15+ mph

rush15_p_mph_pg class-attribute instance-attribute

rush15_p_mph_pg: Annotated[
    Optional[float], Field(alias="rush15PMphPG")
] = None

15+ mph rushes per game

rush20_p_mph class-attribute instance-attribute

rush20_p_mph: Annotated[
    Optional[int], Field(alias="rush20PMph")
] = None

Rushes of 20+ mph

rush20_p_mph_pg class-attribute instance-attribute

rush20_p_mph_pg: Annotated[
    Optional[float], Field(alias="rush20PMphPG")
] = None

20+ mph rushes per game

ryoe class-attribute instance-attribute

ryoe: Optional[float] = None

Rush Yards Over Expected

ryoe_att class-attribute instance-attribute

ryoe_att: Annotated[
    Optional[float], Field(alias="ryoeAtt")
] = None

RYOE per attempt

ryoe_pg class-attribute instance-attribute

ryoe_pg: Annotated[
    Optional[float], Field(alias="ryoePG")
] = None

RYOE per game

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Abbreviated player name

st_box_pct class-attribute instance-attribute

st_box_pct: Annotated[
    Optional[float], Field(alias="stBoxPct")
] = None

Stacked box percentage (0-1)

success class-attribute instance-attribute

success: Optional[float] = None

Success rate (0-1)

td_pg class-attribute instance-attribute

td_pg: Annotated[Optional[float], Field(alias="tdPG")] = (
    None
)

Touchdowns per game

tg class-attribute instance-attribute

tg: Optional[int] = None

Team games for player

total_tg class-attribute instance-attribute

total_tg: Annotated[
    Optional[int], Field(alias="totalTg")
] = None

Total team games in period

under_pct class-attribute instance-attribute

under_pct: Annotated[
    Optional[float], Field(alias="underPct")
] = None

Under center percentage (0-1)

x_ry class-attribute instance-attribute

x_ry: Annotated[Optional[float], Field(alias='xRy')] = None

Expected rushing yards

x_ry_pg class-attribute instance-attribute

x_ry_pg: Annotated[
    Optional[float], Field(alias="xRyPG")
] = None

Expected rushing yards per game

x_ypc class-attribute instance-attribute

x_ypc: Annotated[Optional[float], Field(alias="xYpc")] = (
    None
)

Expected yards per carry

yaco class-attribute instance-attribute

yaco: Optional[float] = None

Yards after contact

yaco_att class-attribute instance-attribute

yaco_att: Annotated[
    Optional[float], Field(alias="yacoAtt")
] = None

Yards after contact per attempt

yaco_pg class-attribute instance-attribute

yaco_pg: Annotated[
    Optional[float], Field(alias="yacoPG")
] = None

Yards after contact per game

ybco class-attribute instance-attribute

ybco: Optional[float] = None

Yards before contact

ybco_pg class-attribute instance-attribute

ybco_pg: Annotated[
    Optional[float], Field(alias="ybcoPG")
] = None

Yards before contact per game

yds_pg class-attribute instance-attribute

yds_pg: Annotated[Optional[float], Field(alias="ydsPG")] = (
    None
)

Yards per game

PlayerRushingStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerRushingStatsTypedDict[PlayerRushingStatsTypedDict]

              

              click griddy.nfl.models.PlayerRushingStatsTypedDict href "" "griddy.nfl.models.PlayerRushingStatsTypedDict"
            

Attributes

att instance-attribute

att: int

Rushing attempts

display_name instance-attribute

display_name: str

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: str

NFL player identifier

position instance-attribute

position: OffensivePlayerPositionEnum

Offensive player position

td instance-attribute

td: int

Rushing touchdowns

team_id instance-attribute

team_id: str

Team identifier

yds instance-attribute

yds: int

Rushing yards

ypc instance-attribute

ypc: float

Yards per carry

att_pg instance-attribute

att_pg: NotRequired[float]

Attempts per game

eff instance-attribute

eff: NotRequired[float]

Efficiency rating

epa instance-attribute

epa: NotRequired[float]

Expected Points Added

epa_att instance-attribute

epa_att: NotRequired[float]

EPA per attempt

epa_pg instance-attribute

epa_pg: NotRequired[float]

EPA per game

fum instance-attribute

fum: NotRequired[int]

Fumbles

fum_pg instance-attribute

fum_pg: NotRequired[float]

Fumbles per game

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image (contains formatInstructions placeholder)

in_t_pct instance-attribute

in_t_pct: NotRequired[float]

Inside tackles percentage (0-1)

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

lost instance-attribute

lost: NotRequired[int]

Fumbles lost

lost_pg instance-attribute

lost_pg: NotRequired[float]

Fumbles lost per game

ngs_position instance-attribute

ngs_position: NotRequired[OffensivePlayerPositionEnum]

Offensive player position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[OffensivePlayerPositionEnum]

Offensive player position

position_group instance-attribute

position_group: NotRequired[OffensivePlayerPositionEnum]

Offensive player position

qr instance-attribute

qr: NotRequired[bool]

Qualified rusher status

rush10_p_yds instance-attribute

rush10_p_yds: NotRequired[int]

Rushes of 10+ yards

rush10_p_yds_pg instance-attribute

rush10_p_yds_pg: NotRequired[float]

10+ yard rushes per game

rush15_p_mph instance-attribute

rush15_p_mph: NotRequired[int]

Rushes of 15+ mph

rush15_p_mph_pg instance-attribute

rush15_p_mph_pg: NotRequired[float]

15+ mph rushes per game

rush20_p_mph instance-attribute

rush20_p_mph: NotRequired[int]

Rushes of 20+ mph

rush20_p_mph_pg instance-attribute

rush20_p_mph_pg: NotRequired[float]

20+ mph rushes per game

ryoe instance-attribute

ryoe: NotRequired[float]

Rush Yards Over Expected

ryoe_att instance-attribute

ryoe_att: NotRequired[float]

RYOE per attempt

ryoe_pg instance-attribute

ryoe_pg: NotRequired[float]

RYOE per game

short_name instance-attribute

short_name: NotRequired[str]

Abbreviated player name

st_box_pct instance-attribute

st_box_pct: NotRequired[float]

Stacked box percentage (0-1)

success instance-attribute

success: NotRequired[float]

Success rate (0-1)

td_pg instance-attribute

td_pg: NotRequired[float]

Touchdowns per game

tg instance-attribute

tg: NotRequired[int]

Team games for player

total_tg instance-attribute

total_tg: NotRequired[int]

Total team games in period

under_pct instance-attribute

under_pct: NotRequired[float]

Under center percentage (0-1)

x_ry instance-attribute

x_ry: NotRequired[float]

Expected rushing yards

x_ry_pg instance-attribute

x_ry_pg: NotRequired[float]

Expected rushing yards per game

x_ypc instance-attribute

x_ypc: NotRequired[float]

Expected yards per carry

yaco instance-attribute

yaco: NotRequired[float]

Yards after contact

yaco_att instance-attribute

yaco_att: NotRequired[float]

Yards after contact per attempt

yaco_pg instance-attribute

yaco_pg: NotRequired[float]

Yards after contact per game

ybco instance-attribute

ybco: NotRequired[float]

Yards before contact

ybco_pg instance-attribute

ybco_pg: NotRequired[float]

Yards before contact per game

yds_pg instance-attribute

yds_pg: NotRequired[float]

Yards per game

PlayerSearchResult

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerSearchResult[PlayerSearchResult]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerSearchResult
                


              click griddy.nfl.models.PlayerSearchResult href "" "griddy.nfl.models.PlayerSearchResult"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

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

Attributes

birth_date class-attribute instance-attribute

birth_date: Annotated[
    Optional[date], Field(alias="birthDate")
] = None

Player's birth date

college_conference class-attribute instance-attribute

college_conference: Annotated[
    Optional[str], Field(alias="collegeConference")
] = None

Player's college conference

college_name class-attribute instance-attribute

college_name: Annotated[
    Optional[str], Field(alias="collegeName")
] = None

Player's college

current_team_id class-attribute instance-attribute

current_team_id: Annotated[
    Optional[str], Field(alias="currentTeamId")
] = None

Current team identifier

display_name class-attribute instance-attribute

display_name: Annotated[
    Optional[str], Field(alias="displayName")
] = None

Player's display name

draft_club class-attribute instance-attribute

draft_club: Annotated[
    OptionalNullable[str], Field(alias="draftClub")
] = UNSET

Team that drafted the player

draft_number class-attribute instance-attribute

draft_number: Annotated[
    OptionalNullable[int], Field(alias="draftNumber")
] = UNSET

Overall draft pick number

draftround class-attribute instance-attribute

draftround: OptionalNullable[int] = UNSET

Draft round

entry_year class-attribute instance-attribute

entry_year: Annotated[
    Optional[int], Field(alias="entryYear")
] = None

Year player entered the league

esb_id class-attribute instance-attribute

esb_id: Annotated[Optional[str], Field(alias="esbId")] = (
    None
)

ESB identifier

first_name class-attribute instance-attribute

first_name: Annotated[
    Optional[str], Field(alias="firstName")
] = None

Player's first name

football_name class-attribute instance-attribute

football_name: Annotated[
    Optional[str], Field(alias="footballName")
] = None

Player's football name (nickname)

gsis_id class-attribute instance-attribute

gsis_id: Annotated[Optional[str], Field(alias="gsisId")] = (
    None
)

GSIS identifier

gsis_it_id class-attribute instance-attribute

gsis_it_id: Annotated[
    Optional[int], Field(alias="gsisItId")
] = None

GSIS IT identifier

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image

height class-attribute instance-attribute

height: Optional[str] = None

Player height (format is feet-inches)

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

last_name class-attribute instance-attribute

last_name: Annotated[
    Optional[str], Field(alias="lastName")
] = None

Player's last name

nfl_id class-attribute instance-attribute

nfl_id: Annotated[Optional[int], Field(alias="nflId")] = (
    None
)

NFL player identifier

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    OptionalNullable[str], Field(alias="ngsPosition")
] = UNSET

Next Gen Stats position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    OptionalNullable[str], Field(alias="ngsPositionGroup")
] = UNSET

Next Gen Stats position group

position class-attribute instance-attribute

position: Optional[str] = None

Player's position

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[str], Field(alias="positionGroup")
] = None

Player's position group

rookie_year class-attribute instance-attribute

rookie_year: Annotated[
    Optional[int], Field(alias="rookieYear")
] = None

Player's rookie year

season class-attribute instance-attribute

season: Optional[int] = None

Current season

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Shortened player name

smart_id class-attribute instance-attribute

smart_id: Annotated[
    Optional[str], Field(alias="smartId")
] = None

Smart identifier for the player

status class-attribute instance-attribute

status: Optional[str] = None

Player status code

status_description_abbr class-attribute instance-attribute

status_description_abbr: Annotated[
    Optional[str], Field(alias="statusDescriptionAbbr")
] = None

Abbreviated status description

status_short_description class-attribute instance-attribute

status_short_description: Annotated[
    Optional[str], Field(alias="statusShortDescription")
] = None

Short status description

team_abbr class-attribute instance-attribute

team_abbr: Annotated[
    Optional[str], Field(alias="teamAbbr")
] = None

Current team abbreviation

uniform_number class-attribute instance-attribute

uniform_number: Annotated[
    Optional[str], Field(alias="uniformNumber")
] = None

Player's uniform number (formatted)

weight class-attribute instance-attribute

weight: Optional[int] = None

Player weight in pounds

years_of_experience class-attribute instance-attribute

years_of_experience: Annotated[
    Optional[int], Field(alias="yearsOfExperience")
] = None

Years of NFL experience

biography class-attribute instance-attribute

biography: Optional[str] = None

Player biography

PlayerSearchResultTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerSearchResultTypedDict[PlayerSearchResultTypedDict]

              

              click griddy.nfl.models.PlayerSearchResultTypedDict href "" "griddy.nfl.models.PlayerSearchResultTypedDict"
            

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

Attributes

birth_date instance-attribute

birth_date: NotRequired[date]

Player's birth date

college_conference instance-attribute

college_conference: NotRequired[str]

Player's college conference

college_name instance-attribute

college_name: NotRequired[str]

Player's college

current_team_id instance-attribute

current_team_id: NotRequired[str]

Current team identifier

display_name instance-attribute

display_name: NotRequired[str]

Player's display name

draft_club instance-attribute

draft_club: NotRequired[Nullable[str]]

Team that drafted the player

draft_number instance-attribute

draft_number: NotRequired[Nullable[int]]

Overall draft pick number

draftround instance-attribute

draftround: NotRequired[Nullable[int]]

Draft round

entry_year instance-attribute

entry_year: NotRequired[int]

Year player entered the league

esb_id instance-attribute

esb_id: NotRequired[str]

ESB identifier

first_name instance-attribute

first_name: NotRequired[str]

Player's first name

football_name instance-attribute

football_name: NotRequired[str]

Player's football name (nickname)

gsis_id instance-attribute

gsis_id: NotRequired[str]

GSIS identifier

gsis_it_id instance-attribute

gsis_it_id: NotRequired[int]

GSIS IT identifier

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image

height instance-attribute

height: NotRequired[str]

Player height (format is feet-inches)

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

last_name instance-attribute

last_name: NotRequired[str]

Player's last name

nfl_id instance-attribute

nfl_id: NotRequired[int]

NFL player identifier

ngs_position instance-attribute

ngs_position: NotRequired[Nullable[str]]

Next Gen Stats position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[Nullable[str]]

Next Gen Stats position group

position instance-attribute

position: NotRequired[str]

Player's position

position_group instance-attribute

position_group: NotRequired[str]

Player's position group

rookie_year instance-attribute

rookie_year: NotRequired[int]

Player's rookie year

season instance-attribute

season: NotRequired[int]

Current season

short_name instance-attribute

short_name: NotRequired[str]

Shortened player name

smart_id instance-attribute

smart_id: NotRequired[str]

Smart identifier for the player

status instance-attribute

status: NotRequired[str]

Player status code

status_description_abbr instance-attribute

status_description_abbr: NotRequired[str]

Abbreviated status description

status_short_description instance-attribute

status_short_description: NotRequired[str]

Short status description

team_abbr instance-attribute

team_abbr: NotRequired[str]

Current team abbreviation

uniform_number instance-attribute

uniform_number: NotRequired[str]

Player's uniform number (formatted)

weight instance-attribute

weight: NotRequired[int]

Player weight in pounds

years_of_experience instance-attribute

years_of_experience: NotRequired[int]

Years of NFL experience

biography instance-attribute

biography: NotRequired[str]

Player biography

PlayerWeekProjectedPoints

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerWeekProjectedPoints[PlayerWeekProjectedPoints]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerWeekProjectedPoints
                


              click griddy.nfl.models.PlayerWeekProjectedPoints href "" "griddy.nfl.models.PlayerWeekProjectedPoints"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

id instance-attribute

id: str

Unique identifier for this projection

PlayerWeekProjectedPointsAttributes

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerWeekProjectedPointsAttributes[PlayerWeekProjectedPointsAttributes]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerWeekProjectedPointsAttributes
                


              click griddy.nfl.models.PlayerWeekProjectedPointsAttributes href "" "griddy.nfl.models.PlayerWeekProjectedPointsAttributes"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

player_id instance-attribute

player_id: Annotated[str, Field(alias='playerId')]

Player SMART ID

season instance-attribute

season: int

Season year

settings_code instance-attribute

settings_code: Annotated[str, Field(alias='settingsCode')]

Fantasy settings code

week instance-attribute

week: int

Week number

points class-attribute instance-attribute

points: OptionalNullable[float] = UNSET

Projected fantasy points

PlayerWeekProjectedPointsAttributesTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerWeekProjectedPointsAttributesTypedDict[PlayerWeekProjectedPointsAttributesTypedDict]

              

              click griddy.nfl.models.PlayerWeekProjectedPointsAttributesTypedDict href "" "griddy.nfl.models.PlayerWeekProjectedPointsAttributesTypedDict"
            

Attributes

player_id instance-attribute

player_id: str

Player SMART ID

season instance-attribute

season: int

Season year

settings_code instance-attribute

settings_code: str

Fantasy settings code

week instance-attribute

week: int

Week number

points instance-attribute

points: NotRequired[Nullable[float]]

Projected fantasy points

PlayerWeekProjectedPointsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerWeekProjectedPointsTypedDict[PlayerWeekProjectedPointsTypedDict]

              

              click griddy.nfl.models.PlayerWeekProjectedPointsTypedDict href "" "griddy.nfl.models.PlayerWeekProjectedPointsTypedDict"
            

Attributes

id instance-attribute

id: str

Unique identifier for this projection

PlayerWeekProjectedStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PlayerWeekProjectedStats[PlayerWeekProjectedStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PlayerWeekProjectedStats
                


              click griddy.nfl.models.PlayerWeekProjectedStats href "" "griddy.nfl.models.PlayerWeekProjectedStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

id instance-attribute

id: str

Unique identifier for these stats

PlayerWeekProjectedStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PlayerWeekProjectedStatsTypedDict[PlayerWeekProjectedStatsTypedDict]

              

              click griddy.nfl.models.PlayerWeekProjectedStatsTypedDict href "" "griddy.nfl.models.PlayerWeekProjectedStatsTypedDict"
            

Attributes

id instance-attribute

id: str

Unique identifier for these stats

PointSpread

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.PointSpread[PointSpread]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.PointSpread
                


              click griddy.nfl.models.PointSpread href "" "griddy.nfl.models.PointSpread"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Point spread betting odds

Attributes

away_handicap class-attribute instance-attribute

away_handicap: Annotated[
    Optional[str], Field(alias="awayHandicap")
] = None

Away team point spread

away_price class-attribute instance-attribute

away_price: Annotated[
    Optional[str], Field(alias="awayPrice")
] = None

Away team spread odds (American format)

home_handicap class-attribute instance-attribute

home_handicap: Annotated[
    Optional[str], Field(alias="homeHandicap")
] = None

Home team point spread

home_price class-attribute instance-attribute

home_price: Annotated[
    Optional[str], Field(alias="homePrice")
] = None

Home team spread odds (American format)

PointSpreadTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.PointSpreadTypedDict[PointSpreadTypedDict]

              

              click griddy.nfl.models.PointSpreadTypedDict href "" "griddy.nfl.models.PointSpreadTypedDict"
            

Point spread betting odds

Attributes

away_handicap instance-attribute

away_handicap: NotRequired[str]

Away team point spread

away_price instance-attribute

away_price: NotRequired[str]

Away team spread odds (American format)

home_handicap instance-attribute

home_handicap: NotRequired[str]

Home team point spread

home_price instance-attribute

home_price: NotRequired[str]

Home team spread odds (American format)

ProGame

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ProGame[ProGame]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ProGame
                


              click griddy.nfl.models.ProGame href "" "griddy.nfl.models.ProGame"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

date_ class-attribute instance-attribute

date_: Annotated[Optional[date], Field(alias="date")] = None

Game date (YYYY-MM-DD)

date_am_pm class-attribute instance-attribute

date_am_pm: Annotated[
    Optional[MeridiemEnum], Field(alias="dateAmPm")
] = None

Time of day indicator

date_day class-attribute instance-attribute

date_day: Annotated[
    Optional[str], Field(alias="dateDay")
] = None

Day of week (full)

date_day_month class-attribute instance-attribute

date_day_month: Annotated[
    Optional[str], Field(alias="dateDayMonth")
] = None

Date in M/D format

date_day_short class-attribute instance-attribute

date_day_short: Annotated[
    Optional[str], Field(alias="dateDayShort")
] = None

Day of week (abbreviated)

date_time class-attribute instance-attribute

date_time: Annotated[
    Optional[str], Field(alias="dateTime")
] = None

Time without AM/PM

date_time_am_pm class-attribute instance-attribute

date_time_am_pm: Annotated[
    Optional[str], Field(alias="dateTimeAmPm")
] = None

Time with AM/PM

extensions class-attribute instance-attribute

extensions: Optional[List[ProGameExtension]] = None

Additional game data extensions

game_type class-attribute instance-attribute

game_type: Annotated[
    Optional[str], Field(alias="gameType")
] = None

Type of game

id class-attribute instance-attribute

id: Optional[str] = None

Unique game identifier

international class-attribute instance-attribute

international: Optional[bool] = None

Whether game is played internationally

neutral_site class-attribute instance-attribute

neutral_site: Annotated[
    Optional[bool], Field(alias="neutralSite")
] = None

Whether game is at neutral venue

phase class-attribute instance-attribute

phase: Optional[str] = None

Game phase

season class-attribute instance-attribute

season: Optional[int] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

status class-attribute instance-attribute

status: Optional[ProGameStatus] = None

Game status

ticket_url class-attribute instance-attribute

ticket_url: Annotated[
    OptionalNullable[str], Field(alias="ticketUrl")
] = UNSET

Primary ticket purchase URL

time class-attribute instance-attribute

time: Optional[datetime] = None

Game time in UTC

version class-attribute instance-attribute

version: Optional[int] = None

Data version number

week class-attribute instance-attribute

week: Optional[int] = None

Week number

week_type class-attribute instance-attribute

week_type: Annotated[
    Optional[str], Field(alias="weekType")
] = None

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

ProGameTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ProGameTypedDict[ProGameTypedDict]

              

              click griddy.nfl.models.ProGameTypedDict href "" "griddy.nfl.models.ProGameTypedDict"
            

Attributes

date_ instance-attribute

date_: NotRequired[date]

Game date (YYYY-MM-DD)

date_am_pm instance-attribute

date_am_pm: NotRequired[MeridiemEnum]

Time of day indicator

date_day instance-attribute

date_day: NotRequired[str]

Day of week (full)

date_day_month instance-attribute

date_day_month: NotRequired[str]

Date in M/D format

date_day_short instance-attribute

date_day_short: NotRequired[str]

Day of week (abbreviated)

date_time instance-attribute

date_time: NotRequired[str]

Time without AM/PM

date_time_am_pm instance-attribute

date_time_am_pm: NotRequired[str]

Time with AM/PM

extensions instance-attribute

extensions: NotRequired[List[ProGameExtensionTypedDict]]

Additional game data extensions

game_type instance-attribute

game_type: NotRequired[str]

Type of game

id instance-attribute

id: NotRequired[str]

Unique game identifier

international instance-attribute

international: NotRequired[bool]

Whether game is played internationally

neutral_site instance-attribute

neutral_site: NotRequired[bool]

Whether game is at neutral venue

phase instance-attribute

phase: NotRequired[str]

Game phase

season instance-attribute

season: NotRequired[int]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

status instance-attribute

status: NotRequired[ProGameStatus]

Game status

ticket_url instance-attribute

ticket_url: NotRequired[Nullable[str]]

Primary ticket purchase URL

time instance-attribute

time: NotRequired[datetime]

Game time in UTC

version instance-attribute

version: NotRequired[int]

Data version number

week instance-attribute

week: NotRequired[int]

Week number

week_type instance-attribute

week_type: NotRequired[str]

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

ProTeam

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ProTeam[ProTeam]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ProTeam
                


              click griddy.nfl.models.ProTeam href "" "griddy.nfl.models.ProTeam"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

abbr class-attribute instance-attribute

abbr: Optional[str] = None

Three-letter team abbreviation

alt_color class-attribute instance-attribute

alt_color: Annotated[
    Optional[str], Field(alias="altColor")
] = None

Alternate team color in hex format

city class-attribute instance-attribute

city: Optional[str] = None

Team city/location

city_state class-attribute instance-attribute

city_state: Annotated[
    Optional[str], Field(alias="cityState")
] = None

Team city and state

conference_abbr class-attribute instance-attribute

conference_abbr: Annotated[
    Optional[ProTeamConferenceAbbr],
    Field(alias="conferenceAbbr"),
] = None

Conference abbreviation

dark_color class-attribute instance-attribute

dark_color: Annotated[
    Optional[str], Field(alias="darkColor")
] = None

Dark team color in hex format

domain class-attribute instance-attribute

domain: Optional[str] = None

Team website domain prefix

full_name class-attribute instance-attribute

full_name: Annotated[
    Optional[str], Field(alias="fullName")
] = None

Full team name

is_pro_bowl class-attribute instance-attribute

is_pro_bowl: Annotated[
    Optional[bool], Field(alias="isProBowl")
] = False

Whether this is a Pro Bowl team

logo class-attribute instance-attribute

logo: Optional[str] = None

URL to team logo (may contain formatInstructions placeholder)

name class-attribute instance-attribute

name: Optional[str] = None

Team name

nick class-attribute instance-attribute

nick: Optional[str] = None

Team nickname (short form)

nickname class-attribute instance-attribute

nickname: Optional[str] = None

Team nickname

primary_color class-attribute instance-attribute

primary_color: Annotated[
    Optional[str], Field(alias="primaryColor")
] = None

Primary team color in hex format

season class-attribute instance-attribute

season: Optional[int] = None

Current season year

secondary_color class-attribute instance-attribute

secondary_color: Annotated[
    Optional[str], Field(alias="secondaryColor")
] = None

Secondary team color in hex format

slug class-attribute instance-attribute

slug: Optional[str] = None

URL-friendly team identifier

smart_id class-attribute instance-attribute

smart_id: Annotated[
    Optional[str], Field(alias="smartId")
] = None

Unique smart identifier for the team

stadium_name class-attribute instance-attribute

stadium_name: Annotated[
    Optional[str], Field(alias="stadiumName")
] = None

Name of the team's home stadium

team_id class-attribute instance-attribute

team_id: Annotated[Optional[str], Field(alias="teamId")] = (
    None
)

Team identifier (4-digit string)

team_site_ticket_url class-attribute instance-attribute

team_site_ticket_url: Annotated[
    OptionalNullable[str], Field(alias="teamSiteTicketUrl")
] = UNSET

URL to team's ticket purchase page

team_site_url class-attribute instance-attribute

team_site_url: Annotated[
    OptionalNullable[str], Field(alias="teamSiteUrl")
] = UNSET

Team's official website URL

team_type class-attribute instance-attribute

team_type: Annotated[
    Optional[ProTeamTeamType], Field(alias="teamType")
] = None

Type of team (regular or Pro Bowl)

tertiary_color class-attribute instance-attribute

tertiary_color: Annotated[
    Optional[str], Field(alias="tertiaryColor")
] = None

Tertiary team color in hex format

ticket_phone_number class-attribute instance-attribute

ticket_phone_number: Annotated[
    OptionalNullable[str], Field(alias="ticketPhoneNumber")
] = UNSET

Phone number for ticket purchases

year_found class-attribute instance-attribute

year_found: Annotated[
    Optional[int], Field(alias="yearFound")
] = None

Year the team was founded

ProTeamTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ProTeamTypedDict[ProTeamTypedDict]

              

              click griddy.nfl.models.ProTeamTypedDict href "" "griddy.nfl.models.ProTeamTypedDict"
            

Attributes

abbr instance-attribute

abbr: NotRequired[str]

Three-letter team abbreviation

alt_color instance-attribute

alt_color: NotRequired[str]

Alternate team color in hex format

city instance-attribute

city: NotRequired[str]

Team city/location

city_state instance-attribute

city_state: NotRequired[str]

Team city and state

conference_abbr instance-attribute

conference_abbr: NotRequired[ProTeamConferenceAbbr]

Conference abbreviation

dark_color instance-attribute

dark_color: NotRequired[str]

Dark team color in hex format

domain instance-attribute

domain: NotRequired[str]

Team website domain prefix

full_name instance-attribute

full_name: NotRequired[str]

Full team name

is_pro_bowl instance-attribute

is_pro_bowl: NotRequired[bool]

Whether this is a Pro Bowl team

logo instance-attribute

logo: NotRequired[str]

URL to team logo (may contain formatInstructions placeholder)

name instance-attribute

name: NotRequired[str]

Team name

nick instance-attribute

nick: NotRequired[str]

Team nickname (short form)

nickname instance-attribute

nickname: NotRequired[str]

Team nickname

primary_color instance-attribute

primary_color: NotRequired[str]

Primary team color in hex format

season instance-attribute

season: NotRequired[int]

Current season year

secondary_color instance-attribute

secondary_color: NotRequired[str]

Secondary team color in hex format

slug instance-attribute

slug: NotRequired[str]

URL-friendly team identifier

smart_id instance-attribute

smart_id: NotRequired[str]

Unique smart identifier for the team

stadium_name instance-attribute

stadium_name: NotRequired[str]

Name of the team's home stadium

team_id instance-attribute

team_id: NotRequired[str]

Team identifier (4-digit string)

team_site_ticket_url instance-attribute

team_site_ticket_url: NotRequired[Nullable[str]]

URL to team's ticket purchase page

team_site_url instance-attribute

team_site_url: NotRequired[Nullable[str]]

Team's official website URL

team_type instance-attribute

team_type: NotRequired[ProTeamTeamType]

Type of team (regular or Pro Bowl)

tertiary_color instance-attribute

tertiary_color: NotRequired[str]

Tertiary team color in hex format

ticket_phone_number instance-attribute

ticket_phone_number: NotRequired[Nullable[str]]

Phone number for ticket purchases

year_found instance-attribute

year_found: NotRequired[int]

Year the team was founded

ProWeek

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ProWeek[ProWeek]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ProWeek
                


              click griddy.nfl.models.ProWeek href "" "griddy.nfl.models.ProWeek"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

bye_teams class-attribute instance-attribute

bye_teams: Annotated[
    Optional[List[Team]], Field(alias="byeTeams")
] = None

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

date_begin class-attribute instance-attribute

date_begin: Annotated[
    Optional[date], Field(alias="dateBegin")
] = None

First day of the week

date_end class-attribute instance-attribute

date_end: Annotated[
    Optional[date], Field(alias="dateEnd")
] = None

Last day of the week

season class-attribute instance-attribute

season: Optional[int] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

season_type_week class-attribute instance-attribute

season_type_week: Annotated[
    Optional[str], Field(alias="seasonTypeWeek")
] = None

Combined season type and week identifier

text class-attribute instance-attribute

text: Optional[str] = None

Human-readable week description

week class-attribute instance-attribute

week: Optional[int] = None

Week number (0 for Hall of Fame game)

week_slug class-attribute instance-attribute

week_slug: Annotated[
    Optional[str], Field(alias="weekSlug")
] = None

Week identifier slug

week_type class-attribute instance-attribute

week_type: Annotated[
    Optional[ProWeekWeekType], Field(alias="weekType")
] = None

Type of week

ProWeekTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ProWeekTypedDict[ProWeekTypedDict]

              

              click griddy.nfl.models.ProWeekTypedDict href "" "griddy.nfl.models.ProWeekTypedDict"
            

Attributes

bye_teams instance-attribute

bye_teams: NotRequired[List[TeamTypedDict]]

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

date_begin instance-attribute

date_begin: NotRequired[date]

First day of the week

date_end instance-attribute

date_end: NotRequired[date]

Last day of the week

season instance-attribute

season: NotRequired[int]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

season_type_week instance-attribute

season_type_week: NotRequired[str]

Combined season type and week identifier

text instance-attribute

text: NotRequired[str]

Human-readable week description

week instance-attribute

week: NotRequired[int]

Week number (0 for Hall of Fame game)

week_slug instance-attribute

week_slug: NotRequired[str]

Week identifier slug

week_type instance-attribute

week_type: NotRequired[ProWeekWeekType]

Type of week

ResponseMetadata

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ResponseMetadata[ResponseMetadata]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ResponseMetadata
                


              click griddy.nfl.models.ResponseMetadata href "" "griddy.nfl.models.ResponseMetadata"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

generated_at instance-attribute

generated_at: Annotated[
    datetime, Field(alias="generatedAt")
]

Response generation timestamp

ResponseMetadataTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ResponseMetadataTypedDict[ResponseMetadataTypedDict]

              

              click griddy.nfl.models.ResponseMetadataTypedDict href "" "griddy.nfl.models.ResponseMetadataTypedDict"
            

Attributes

generated_at instance-attribute

generated_at: datetime

Response generation timestamp

ScheduleTeam

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ScheduleTeam[ScheduleTeam]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ScheduleTeam
                


              click griddy.nfl.models.ScheduleTeam href "" "griddy.nfl.models.ScheduleTeam"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

conference_abbr class-attribute instance-attribute

conference_abbr: Annotated[
    Optional[ConferenceEnum], Field(alias="conferenceAbbr")
] = None

NFL conference

team_type class-attribute instance-attribute

team_type: Annotated[
    Optional[TeamTypeEnum], Field(alias="teamType")
] = None

Team type classification

ScheduleTeamTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ScheduleTeamTypedDict[ScheduleTeamTypedDict]

              

              click griddy.nfl.models.ScheduleTeamTypedDict href "" "griddy.nfl.models.ScheduleTeamTypedDict"
            

Attributes

conference_abbr instance-attribute

conference_abbr: NotRequired[ConferenceEnum]

NFL conference

team_type instance-attribute

team_type: NotRequired[TeamTypeEnum]

Team type classification

ScheduledGame

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.ScheduledGame[ScheduledGame]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.ScheduledGame
                


              click griddy.nfl.models.ScheduledGame href "" "griddy.nfl.models.ScheduledGame"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

game_date class-attribute instance-attribute

game_date: Annotated[
    OptionalNullable[date], Field(alias="gameDate")
] = UNSET

Game date (YYYY-MM-DD format)

game_id class-attribute instance-attribute

game_id: Annotated[Optional[int], Field(alias="gameId")] = (
    None
)

Game identifier (format is YYYYMMDDNN)

game_key class-attribute instance-attribute

game_key: Annotated[
    Optional[int], Field(alias="gameKey")
] = None

Unique game key

game_time class-attribute instance-attribute

game_time: Annotated[
    OptionalNullable[datetime], Field(alias="gameTime")
] = UNSET

Game time in UTC

game_time_eastern class-attribute instance-attribute

game_time_eastern: Annotated[
    OptionalNullable[str], Field(alias="gameTimeEastern")
] = UNSET

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

game_type class-attribute instance-attribute

game_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="gameType")
] = None

Type of NFL season

home_display_name class-attribute instance-attribute

home_display_name: Annotated[
    Optional[str], Field(alias="homeDisplayName")
] = None

Home team display name

home_nickname class-attribute instance-attribute

home_nickname: Annotated[
    Optional[str], Field(alias="homeNickname")
] = None

Home team nickname

home_team_abbr class-attribute instance-attribute

home_team_abbr: Annotated[
    Optional[str], Field(alias="homeTeamAbbr")
] = None

Home team abbreviation

home_team_id class-attribute instance-attribute

home_team_id: Annotated[
    Optional[str], Field(alias="homeTeamId")
] = None

Home team identifier

iso_time class-attribute instance-attribute

iso_time: Annotated[
    OptionalNullable[int], Field(alias="isoTime")
] = UNSET

Unix timestamp in milliseconds

network_channel class-attribute instance-attribute

network_channel: Annotated[
    OptionalNullable[str], Field(alias="networkChannel")
] = UNSET

Broadcast network

ngs_game class-attribute instance-attribute

ngs_game: Annotated[
    Optional[bool], Field(alias="ngsGame")
] = None

Whether Next Gen Stats are available

released_to_clubs class-attribute instance-attribute

released_to_clubs: Annotated[
    Optional[bool], Field(alias="releasedToClubs")
] = None

Whether game info is released to clubs

season class-attribute instance-attribute

season: Optional[int] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

smart_id class-attribute instance-attribute

smart_id: Annotated[
    Optional[str], Field(alias="smartId")
] = None

Smart identifier for the game

validated class-attribute instance-attribute

validated: Optional[bool] = None

Whether game info is validated

visitor_display_name class-attribute instance-attribute

visitor_display_name: Annotated[
    Optional[str], Field(alias="visitorDisplayName")
] = None

Visitor team display name

visitor_nickname class-attribute instance-attribute

visitor_nickname: Annotated[
    Optional[str], Field(alias="visitorNickname")
] = None

Visitor team nickname

visitor_team_abbr class-attribute instance-attribute

visitor_team_abbr: Annotated[
    Optional[str], Field(alias="visitorTeamAbbr")
] = None

Visitor team abbreviation

visitor_team_id class-attribute instance-attribute

visitor_team_id: Annotated[
    Optional[str], Field(alias="visitorTeamId")
] = None

Visitor team identifier

week class-attribute instance-attribute

week: Optional[int] = None

Week number

week_name_abbr class-attribute instance-attribute

week_name_abbr: Annotated[
    Optional[str], Field(alias="weekNameAbbr")
] = None

Week name abbreviation

ScheduledGameTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.ScheduledGameTypedDict[ScheduledGameTypedDict]

              

              click griddy.nfl.models.ScheduledGameTypedDict href "" "griddy.nfl.models.ScheduledGameTypedDict"
            

Attributes

game_date instance-attribute

game_date: NotRequired[Nullable[date]]

Game date (YYYY-MM-DD format)

game_id instance-attribute

game_id: NotRequired[int]

Game identifier (format is YYYYMMDDNN)

game_key instance-attribute

game_key: NotRequired[int]

Unique game key

game_time instance-attribute

game_time: NotRequired[Nullable[datetime]]

Game time in UTC

game_time_eastern instance-attribute

game_time_eastern: NotRequired[Nullable[str]]

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

game_type instance-attribute

game_type: NotRequired[SeasonTypeEnum]

Type of NFL season

home_display_name instance-attribute

home_display_name: NotRequired[str]

Home team display name

home_nickname instance-attribute

home_nickname: NotRequired[str]

Home team nickname

home_team_abbr instance-attribute

home_team_abbr: NotRequired[str]

Home team abbreviation

home_team_id instance-attribute

home_team_id: NotRequired[str]

Home team identifier

iso_time instance-attribute

iso_time: NotRequired[Nullable[int]]

Unix timestamp in milliseconds

network_channel instance-attribute

network_channel: NotRequired[Nullable[str]]

Broadcast network

ngs_game instance-attribute

ngs_game: NotRequired[bool]

Whether Next Gen Stats are available

released_to_clubs instance-attribute

released_to_clubs: NotRequired[bool]

Whether game info is released to clubs

season instance-attribute

season: NotRequired[int]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

smart_id instance-attribute

smart_id: NotRequired[str]

Smart identifier for the game

validated instance-attribute

validated: NotRequired[bool]

Whether game info is validated

visitor_display_name instance-attribute

visitor_display_name: NotRequired[str]

Visitor team display name

visitor_nickname instance-attribute

visitor_nickname: NotRequired[str]

Visitor team nickname

visitor_team_abbr instance-attribute

visitor_team_abbr: NotRequired[str]

Visitor team abbreviation

visitor_team_id instance-attribute

visitor_team_id: NotRequired[str]

Visitor team identifier

week instance-attribute

week: NotRequired[int]

Week number

week_name_abbr instance-attribute

week_name_abbr: NotRequired[str]

Week name abbreviation

SearchPlayersRequest

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.SearchPlayersRequest[SearchPlayersRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.SearchPlayersRequest
                


              click griddy.nfl.models.SearchPlayersRequest href "" "griddy.nfl.models.SearchPlayersRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

term instance-attribute

term: Annotated[
    str,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Search term for player name (first or last name)

SearchPlayersRequestTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.SearchPlayersRequestTypedDict[SearchPlayersRequestTypedDict]

              

              click griddy.nfl.models.SearchPlayersRequestTypedDict href "" "griddy.nfl.models.SearchPlayersRequestTypedDict"
            

Attributes

term instance-attribute

term: str

Search term for player name (first or last name)

SeasonStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.SeasonStats[SeasonStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.SeasonStats
                


              click griddy.nfl.models.SeasonStats href "" "griddy.nfl.models.SeasonStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

SeasonStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.SeasonStatsTypedDict[SeasonStatsTypedDict]

              

              click griddy.nfl.models.SeasonStatsTypedDict href "" "griddy.nfl.models.SeasonStatsTypedDict"
            

Attributes

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

SocialMedia

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.SocialMedia[SocialMedia]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.SocialMedia
                


              click griddy.nfl.models.SocialMedia href "" "griddy.nfl.models.SocialMedia"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

link class-attribute instance-attribute

link: Optional[str] = None

URL to social media profile

platform class-attribute instance-attribute

platform: Optional[str] = None

Social media platform name

SocialMediaTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.SocialMediaTypedDict[SocialMediaTypedDict]

              

              click griddy.nfl.models.SocialMediaTypedDict href "" "griddy.nfl.models.SocialMediaTypedDict"
            

Attributes

link instance-attribute

link: NotRequired[str]

URL to social media profile

platform instance-attribute

platform: NotRequired[str]

Social media platform name

StandingsRecord

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.StandingsRecord[StandingsRecord]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.StandingsRecord
                


              click griddy.nfl.models.StandingsRecord href "" "griddy.nfl.models.StandingsRecord"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

rank class-attribute instance-attribute

rank: Optional[int] = None

Ranking within group

win_pct class-attribute instance-attribute

win_pct: Annotated[
    Optional[float], Field(alias="winPct")
] = None

Win percentage

StandingsRecordPoints

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.StandingsRecordPoints[StandingsRecordPoints]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.StandingsRecordPoints
                


              click griddy.nfl.models.StandingsRecordPoints href "" "griddy.nfl.models.StandingsRecordPoints"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

against class-attribute instance-attribute

against: Optional[int] = None

Points allowed

for_ class-attribute instance-attribute

for_: Annotated[Optional[int], Field(alias='for')] = None

Points scored

StandingsRecordPointsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.StandingsRecordPointsTypedDict[StandingsRecordPointsTypedDict]

              

              click griddy.nfl.models.StandingsRecordPointsTypedDict href "" "griddy.nfl.models.StandingsRecordPointsTypedDict"
            

Attributes

against instance-attribute

against: NotRequired[int]

Points allowed

for_ instance-attribute

for_: NotRequired[int]

Points scored

StandingsRecordTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.StandingsRecordTypedDict[StandingsRecordTypedDict]

              

              click griddy.nfl.models.StandingsRecordTypedDict href "" "griddy.nfl.models.StandingsRecordTypedDict"
            

Attributes

rank instance-attribute

rank: NotRequired[int]

Ranking within group

win_pct instance-attribute

win_pct: NotRequired[float]

Win percentage

Statistic

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Statistic[Statistic]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Statistic
                


              click griddy.nfl.models.Statistic href "" "griddy.nfl.models.Statistic"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

type class-attribute instance-attribute

type: Optional[str] = None

Statistical category name

value class-attribute instance-attribute

value: Optional[float] = None

Statistical value

StatisticRanking

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.StatisticRanking[StatisticRanking]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.StatisticRanking
                


              click griddy.nfl.models.StatisticRanking href "" "griddy.nfl.models.StatisticRanking"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

rank class-attribute instance-attribute

rank: Optional[int] = None

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

StatisticRankingTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.StatisticRankingTypedDict[StatisticRankingTypedDict]

              

              click griddy.nfl.models.StatisticRankingTypedDict href "" "griddy.nfl.models.StatisticRankingTypedDict"
            

Attributes

rank instance-attribute

rank: NotRequired[int]

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

StatisticTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.StatisticTypedDict[StatisticTypedDict]

              

              click griddy.nfl.models.StatisticTypedDict href "" "griddy.nfl.models.StatisticTypedDict"
            

Attributes

type instance-attribute

type: NotRequired[str]

Statistical category name

value instance-attribute

value: NotRequired[float]

Statistical value

Team

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Team[Team]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Team
                


              click griddy.nfl.models.Team href "" "griddy.nfl.models.Team"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

abbreviation class-attribute instance-attribute

abbreviation: Optional[str] = None

Three-letter team abbreviation

conference_abbr class-attribute instance-attribute

conference_abbr: Annotated[
    Optional[TeamConferenceAbbr],
    Field(alias="conferenceAbbr"),
] = None

Conference abbreviation

conference_full_name class-attribute instance-attribute

conference_full_name: Annotated[
    Optional[str], Field(alias="conferenceFullName")
] = None

Full conference name

current_logo class-attribute instance-attribute

current_logo: Annotated[
    Optional[str], Field(alias="currentLogo")
] = None

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

division_full_name class-attribute instance-attribute

division_full_name: Annotated[
    Optional[str], Field(alias="divisionFullName")
] = None

Full division name

full_name class-attribute instance-attribute

full_name: Annotated[
    Optional[str], Field(alias="fullName")
] = None

Full team name

id class-attribute instance-attribute

id: Optional[str] = None

Unique team identifier

league class-attribute instance-attribute

league: Optional[str] = None

League name

location class-attribute instance-attribute

location: Optional[str] = None

Team location/city

nfl_shop_url class-attribute instance-attribute

nfl_shop_url: Annotated[
    OptionalNullable[str], Field(alias="nflShopUrl")
] = UNSET

URL to team's NFL shop

nick_name class-attribute instance-attribute

nick_name: Annotated[
    Optional[str], Field(alias="nickName")
] = None

Team nickname

official_website_url class-attribute instance-attribute

official_website_url: Annotated[
    OptionalNullable[str], Field(alias="officialWebsiteUrl")
] = UNSET

Team's official website

owners class-attribute instance-attribute

owners: OptionalNullable[str] = UNSET

Team ownership information

primary_color class-attribute instance-attribute

primary_color: Annotated[
    Optional[str], Field(alias="primaryColor")
] = None

Primary team color (hex)

season class-attribute instance-attribute

season: Optional[str] = None

Current season

secondary_color class-attribute instance-attribute

secondary_color: Annotated[
    Optional[str], Field(alias="secondaryColor")
] = None

Secondary team color (hex)

team_type class-attribute instance-attribute

team_type: Annotated[
    Optional[TeamTeamType], Field(alias="teamType")
] = None

Type of team (regular or Pro Bowl)

year_established class-attribute instance-attribute

year_established: Annotated[
    Optional[int], Field(alias="yearEstablished")
] = None

Year team was established

TeamTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamTypedDict[TeamTypedDict]

              

              click griddy.nfl.models.TeamTypedDict href "" "griddy.nfl.models.TeamTypedDict"
            

Attributes

abbreviation instance-attribute

abbreviation: NotRequired[str]

Three-letter team abbreviation

conference_abbr instance-attribute

conference_abbr: NotRequired[TeamConferenceAbbr]

Conference abbreviation

conference_full_name instance-attribute

conference_full_name: NotRequired[str]

Full conference name

current_logo instance-attribute

current_logo: NotRequired[str]

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

division_full_name instance-attribute

division_full_name: NotRequired[str]

Full division name

full_name instance-attribute

full_name: NotRequired[str]

Full team name

id instance-attribute

id: NotRequired[str]

Unique team identifier

league instance-attribute

league: NotRequired[str]

League name

location instance-attribute

location: NotRequired[str]

Team location/city

nfl_shop_url instance-attribute

nfl_shop_url: NotRequired[Nullable[str]]

URL to team's NFL shop

nick_name instance-attribute

nick_name: NotRequired[str]

Team nickname

official_website_url instance-attribute

official_website_url: NotRequired[Nullable[str]]

Team's official website

owners instance-attribute

owners: NotRequired[Nullable[str]]

Team ownership information

primary_color instance-attribute

primary_color: NotRequired[str]

Primary team color (hex)

season instance-attribute

season: NotRequired[str]

Current season

secondary_color instance-attribute

secondary_color: NotRequired[str]

Secondary team color (hex)

team_type instance-attribute

team_type: NotRequired[TeamTeamType]

Type of team (regular or Pro Bowl)

year_established instance-attribute

year_established: NotRequired[int]

Year team was established

TeamDefensePassStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamDefensePassStats[TeamDefensePassStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamDefensePassStats
                


              click griddy.nfl.models.TeamDefensePassStats href "" "griddy.nfl.models.TeamDefensePassStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

gp instance-attribute

gp: int

Games played

pass_ instance-attribute

pass_: Annotated[int, Field(alias='pass')]

Pass attempts faced

pass_pct instance-attribute

pass_pct: Annotated[float, Field(alias='passPct')]

Percentage of plays that were passes (0-1)

pass_yds instance-attribute

pass_yds: Annotated[int, Field(alias='passYds')]

Passing yards allowed

pass_ypp instance-attribute

pass_ypp: Annotated[float, Field(alias='passYpp')]

Passing yards allowed per pass attempt

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

total instance-attribute

total: int

Total defensive plays

blitz_pct class-attribute instance-attribute

blitz_pct: Annotated[
    Optional[float], Field(alias="blitzPct")
] = None

Blitz percentage (0-1)

epa_pass class-attribute instance-attribute

epa_pass: Annotated[
    Optional[float], Field(alias="epaPass")
] = None

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

epa_pass_pp class-attribute instance-attribute

epa_pass_pp: Annotated[
    Optional[float], Field(alias="epaPassPP")
] = None

EPA allowed per pass play

go class-attribute instance-attribute

go: Optional[float] = None

Get-off metric (coverage disruption)

pass_td class-attribute instance-attribute

pass_td: Annotated[Optional[int], Field(alias="passTd")] = (
    None
)

Passing touchdowns allowed

pass_ypg class-attribute instance-attribute

pass_ypg: Annotated[
    Optional[float], Field(alias="passYpg")
] = None

Pass yards allowed per game

qbp class-attribute instance-attribute

qbp: Optional[int] = None

Quarterback pressures generated

qbp_pct class-attribute instance-attribute

qbp_pct: Annotated[
    Optional[float], Field(alias="qbpPct")
] = None

Quarterback pressure rate (0-1)

sack class-attribute instance-attribute

sack: Optional[int] = None

Sacks

sack_pct class-attribute instance-attribute

sack_pct: Annotated[
    Optional[float], Field(alias="sackPct")
] = None

Sack rate (0-1)

sacked_yds class-attribute instance-attribute

sacked_yds: Annotated[
    Optional[int], Field(alias="sackedYds")
] = None

Sack yards generated

sacked_ypg class-attribute instance-attribute

sacked_ypg: Annotated[
    Optional[float], Field(alias="sackedYpg")
] = None

Sack yards generated per game

sep class-attribute instance-attribute

sep: Optional[float] = None

Average receiver separation allowed at target (yards)

ttp class-attribute instance-attribute

ttp: Optional[float] = None

Time to pressure (seconds)

ttt class-attribute instance-attribute

ttt: Optional[float] = None

Average time to throw allowed (seconds)

yac class-attribute instance-attribute

yac: Optional[int] = None

Yards after catch allowed

yacoe class-attribute instance-attribute

yacoe: Optional[int] = None

Yards after catch over expected allowed (negative is better)

TeamDefensePassStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamDefensePassStatsTypedDict[TeamDefensePassStatsTypedDict]

              

              click griddy.nfl.models.TeamDefensePassStatsTypedDict href "" "griddy.nfl.models.TeamDefensePassStatsTypedDict"
            

Attributes

gp instance-attribute

gp: int

Games played

pass_ instance-attribute

pass_: int

Pass attempts faced

pass_pct instance-attribute

pass_pct: float

Percentage of plays that were passes (0-1)

pass_yds instance-attribute

pass_yds: int

Passing yards allowed

pass_ypp instance-attribute

pass_ypp: float

Passing yards allowed per pass attempt

team_id instance-attribute

team_id: str

Team identifier

total instance-attribute

total: int

Total defensive plays

blitz_pct instance-attribute

blitz_pct: NotRequired[float]

Blitz percentage (0-1)

epa_pass instance-attribute

epa_pass: NotRequired[float]

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

epa_pass_pp instance-attribute

epa_pass_pp: NotRequired[float]

EPA allowed per pass play

go instance-attribute

go: NotRequired[float]

Get-off metric (coverage disruption)

pass_td instance-attribute

pass_td: NotRequired[int]

Passing touchdowns allowed

pass_ypg instance-attribute

pass_ypg: NotRequired[float]

Pass yards allowed per game

qbp instance-attribute

qbp: NotRequired[int]

Quarterback pressures generated

qbp_pct instance-attribute

qbp_pct: NotRequired[float]

Quarterback pressure rate (0-1)

sack instance-attribute

sack: NotRequired[int]

Sacks

sack_pct instance-attribute

sack_pct: NotRequired[float]

Sack rate (0-1)

sacked_yds instance-attribute

sacked_yds: NotRequired[int]

Sack yards generated

sacked_ypg instance-attribute

sacked_ypg: NotRequired[float]

Sack yards generated per game

sep instance-attribute

sep: NotRequired[float]

Average receiver separation allowed at target (yards)

ttp instance-attribute

ttp: NotRequired[float]

Time to pressure (seconds)

ttt instance-attribute

ttt: NotRequired[float]

Average time to throw allowed (seconds)

yac instance-attribute

yac: NotRequired[int]

Yards after catch allowed

yacoe instance-attribute

yacoe: NotRequired[int]

Yards after catch over expected allowed (negative is better)

TeamDefenseRushStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamDefenseRushStats[TeamDefenseRushStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamDefenseRushStats
                


              click griddy.nfl.models.TeamDefenseRushStats href "" "griddy.nfl.models.TeamDefenseRushStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

gp instance-attribute

gp: int

Games played

run instance-attribute

run: int

Rush attempts faced

run_pct instance-attribute

run_pct: Annotated[float, Field(alias='runPct')]

Percentage of plays that were rushes (0-1)

rush_yds instance-attribute

rush_yds: Annotated[int, Field(alias='rushYds')]

Rushing yards allowed

rush_ypp instance-attribute

rush_ypp: Annotated[float, Field(alias='rushYpp')]

Rushing yards allowed per rush attempt

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

total instance-attribute

total: int

Total defensive plays

epa_rush class-attribute instance-attribute

epa_rush: Annotated[
    Optional[float], Field(alias="epaRush")
] = None

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

epa_rush_pp class-attribute instance-attribute

epa_rush_pp: Annotated[
    Optional[float], Field(alias="epaRushPP")
] = None

EPA allowed per rush play

in_pct class-attribute instance-attribute

in_pct: Annotated[Optional[float], Field(alias="inPct")] = (
    None
)

Percentage of rushes between tackles (inside)

light_pct class-attribute instance-attribute

light_pct: Annotated[
    Optional[float], Field(alias="lightPct")
] = None

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

out_pct class-attribute instance-attribute

out_pct: Annotated[
    Optional[float], Field(alias="outPct")
] = None

Percentage of rushes outside tackles

rush10_p_yds class-attribute instance-attribute

rush10_p_yds: Annotated[
    Optional[int], Field(alias="rush10PYds")
] = None

Rush attempts of 10+ yards allowed

rush_td class-attribute instance-attribute

rush_td: Annotated[Optional[int], Field(alias="rushTd")] = (
    None
)

Rushing touchdowns allowed

rush_ypg class-attribute instance-attribute

rush_ypg: Annotated[
    Optional[float], Field(alias="rushYpg")
] = None

Rush yards allowed per game

ryoe class-attribute instance-attribute

ryoe: Optional[float] = None

Rush Yards Over Expected allowed (negative is better)

ryoe_att class-attribute instance-attribute

ryoe_att: Annotated[
    Optional[float], Field(alias="ryoeAtt")
] = None

RYOE per rush attempt

stacked_pct class-attribute instance-attribute

stacked_pct: Annotated[
    Optional[float], Field(alias="stackedPct")
] = None

Percentage of rushes against stacked box (8+ defenders)

stuff_pct class-attribute instance-attribute

stuff_pct: Annotated[
    Optional[float], Field(alias="stuffPct")
] = None

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

yaco_att class-attribute instance-attribute

yaco_att: Annotated[
    Optional[float], Field(alias="yacoAtt")
] = None

Yards after contact per attempt allowed

ybco_att class-attribute instance-attribute

ybco_att: Annotated[
    Optional[float], Field(alias="ybcoAtt")
] = None

Yards before contact per attempt allowed

TeamDefenseRushStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamDefenseRushStatsTypedDict[TeamDefenseRushStatsTypedDict]

              

              click griddy.nfl.models.TeamDefenseRushStatsTypedDict href "" "griddy.nfl.models.TeamDefenseRushStatsTypedDict"
            

Attributes

gp instance-attribute

gp: int

Games played

run instance-attribute

run: int

Rush attempts faced

run_pct instance-attribute

run_pct: float

Percentage of plays that were rushes (0-1)

rush_yds instance-attribute

rush_yds: int

Rushing yards allowed

rush_ypp instance-attribute

rush_ypp: float

Rushing yards allowed per rush attempt

team_id instance-attribute

team_id: str

Team identifier

total instance-attribute

total: int

Total defensive plays

epa_rush instance-attribute

epa_rush: NotRequired[float]

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

epa_rush_pp instance-attribute

epa_rush_pp: NotRequired[float]

EPA allowed per rush play

in_pct instance-attribute

in_pct: NotRequired[float]

Percentage of rushes between tackles (inside)

light_pct instance-attribute

light_pct: NotRequired[float]

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

out_pct instance-attribute

out_pct: NotRequired[float]

Percentage of rushes outside tackles

rush10_p_yds instance-attribute

rush10_p_yds: NotRequired[int]

Rush attempts of 10+ yards allowed

rush_td instance-attribute

rush_td: NotRequired[int]

Rushing touchdowns allowed

rush_ypg instance-attribute

rush_ypg: NotRequired[float]

Rush yards allowed per game

ryoe instance-attribute

ryoe: NotRequired[float]

Rush Yards Over Expected allowed (negative is better)

ryoe_att instance-attribute

ryoe_att: NotRequired[float]

RYOE per rush attempt

stacked_pct instance-attribute

stacked_pct: NotRequired[float]

Percentage of rushes against stacked box (8+ defenders)

stuff_pct instance-attribute

stuff_pct: NotRequired[float]

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

yaco_att instance-attribute

yaco_att: NotRequired[float]

Yards after contact per attempt allowed

ybco_att instance-attribute

ybco_att: NotRequired[float]

Yards before contact per attempt allowed

TeamDefenseStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamDefenseStats[TeamDefenseStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamDefenseStats
                


              click griddy.nfl.models.TeamDefenseStats href "" "griddy.nfl.models.TeamDefenseStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

gp instance-attribute

gp: int

Games played

pass_ instance-attribute

pass_: Annotated[int, Field(alias='pass')]

Pass attempts faced

run instance-attribute

run: int

Rush attempts faced

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

total instance-attribute

total: int

Total defensive plays

yds instance-attribute

yds: int

Total yards allowed

defensive_touchdown class-attribute instance-attribute

defensive_touchdown: Annotated[
    Optional[int], Field(alias="defensiveTouchdown")
] = None

Defensive touchdowns scored

epa class-attribute instance-attribute

epa: Optional[float] = None

Total EPA allowed (negative is better for defense)

epa_pp class-attribute instance-attribute

epa_pp: Annotated[Optional[float], Field(alias="epaPP")] = (
    None
)

EPA allowed per play

epa_pass class-attribute instance-attribute

epa_pass: Annotated[
    Optional[float], Field(alias="epaPass")
] = None

EPA allowed on passing plays

epa_pass_pp class-attribute instance-attribute

epa_pass_pp: Annotated[
    Optional[float], Field(alias="epaPassPP")
] = None

EPA allowed per pass play

epa_rush class-attribute instance-attribute

epa_rush: Annotated[
    Optional[float], Field(alias="epaRush")
] = None

EPA allowed on rushing plays

epa_rush_pp class-attribute instance-attribute

epa_rush_pp: Annotated[
    Optional[float], Field(alias="epaRushPP")
] = None

EPA allowed per rush play

forced_fumble class-attribute instance-attribute

forced_fumble: Annotated[
    Optional[int], Field(alias="forcedFumble")
] = None

Forced fumbles

fumble_recovered class-attribute instance-attribute

fumble_recovered: Annotated[
    Optional[int], Field(alias="fumbleRecovered")
] = None

Fumble recoveries

interception class-attribute instance-attribute

interception: Optional[int] = None

Interceptions

pass_pct class-attribute instance-attribute

pass_pct: Annotated[
    Optional[float], Field(alias="passPct")
] = None

Percentage of plays that were passes (0-1)

pass_td class-attribute instance-attribute

pass_td: Annotated[Optional[int], Field(alias="passTd")] = (
    None
)

Passing touchdowns allowed

pass_yds class-attribute instance-attribute

pass_yds: Annotated[
    Optional[int], Field(alias="passYds")
] = None

Passing yards allowed

pass_ypg class-attribute instance-attribute

pass_ypg: Annotated[
    Optional[float], Field(alias="passYpg")
] = None

Pass yards allowed per game

pass_ypp class-attribute instance-attribute

pass_ypp: Annotated[
    Optional[float], Field(alias="passYpp")
] = None

Passing yards allowed per pass attempt

ppg class-attribute instance-attribute

ppg: Optional[float] = None

Points allowed per game

qbp class-attribute instance-attribute

qbp: Optional[int] = None

Quarterback pressures generated

qbp_pct class-attribute instance-attribute

qbp_pct: Annotated[
    Optional[float], Field(alias="qbpPct")
] = None

Quarterback pressure rate (0-1)

rush_td class-attribute instance-attribute

rush_td: Annotated[Optional[int], Field(alias="rushTd")] = (
    None
)

Rushing touchdowns allowed

rush_yds class-attribute instance-attribute

rush_yds: Annotated[
    Optional[int], Field(alias="rushYds")
] = None

Rushing yards allowed

rush_ypg class-attribute instance-attribute

rush_ypg: Annotated[
    Optional[float], Field(alias="rushYpg")
] = None

Rush yards allowed per game

rush_ypp class-attribute instance-attribute

rush_ypp: Annotated[
    Optional[float], Field(alias="rushYpp")
] = None

Rushing yards allowed per rush attempt

ryoe class-attribute instance-attribute

ryoe: Optional[float] = None

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

sacked_yds class-attribute instance-attribute

sacked_yds: Annotated[
    Optional[int], Field(alias="sackedYds")
] = None

Sack yards generated

sacked_ypg class-attribute instance-attribute

sacked_ypg: Annotated[
    Optional[float], Field(alias="sackedYpg")
] = None

Sack yards generated per game

td class-attribute instance-attribute

td: Optional[int] = None

Total touchdowns allowed

total_takeaways class-attribute instance-attribute

total_takeaways: Annotated[
    Optional[int], Field(alias="totalTakeaways")
] = None

Total takeaways (interceptions + fumble recoveries)

ttt class-attribute instance-attribute

ttt: Optional[float] = None

Average time to throw allowed (seconds)

ypg class-attribute instance-attribute

ypg: Optional[float] = None

Yards allowed per game

ypp class-attribute instance-attribute

ypp: Optional[float] = None

Yards allowed per play

TeamDefenseStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamDefenseStatsTypedDict[TeamDefenseStatsTypedDict]

              

              click griddy.nfl.models.TeamDefenseStatsTypedDict href "" "griddy.nfl.models.TeamDefenseStatsTypedDict"
            

Attributes

gp instance-attribute

gp: int

Games played

pass_ instance-attribute

pass_: int

Pass attempts faced

run instance-attribute

run: int

Rush attempts faced

team_id instance-attribute

team_id: str

Team identifier

total instance-attribute

total: int

Total defensive plays

yds instance-attribute

yds: int

Total yards allowed

defensive_touchdown instance-attribute

defensive_touchdown: NotRequired[int]

Defensive touchdowns scored

epa instance-attribute

epa: NotRequired[float]

Total EPA allowed (negative is better for defense)

epa_pp instance-attribute

epa_pp: NotRequired[float]

EPA allowed per play

epa_pass instance-attribute

epa_pass: NotRequired[float]

EPA allowed on passing plays

epa_pass_pp instance-attribute

epa_pass_pp: NotRequired[float]

EPA allowed per pass play

epa_rush instance-attribute

epa_rush: NotRequired[float]

EPA allowed on rushing plays

epa_rush_pp instance-attribute

epa_rush_pp: NotRequired[float]

EPA allowed per rush play

forced_fumble instance-attribute

forced_fumble: NotRequired[int]

Forced fumbles

fumble_recovered instance-attribute

fumble_recovered: NotRequired[int]

Fumble recoveries

interception instance-attribute

interception: NotRequired[int]

Interceptions

pass_pct instance-attribute

pass_pct: NotRequired[float]

Percentage of plays that were passes (0-1)

pass_td instance-attribute

pass_td: NotRequired[int]

Passing touchdowns allowed

pass_yds instance-attribute

pass_yds: NotRequired[int]

Passing yards allowed

pass_ypg instance-attribute

pass_ypg: NotRequired[float]

Pass yards allowed per game

pass_ypp instance-attribute

pass_ypp: NotRequired[float]

Passing yards allowed per pass attempt

ppg instance-attribute

ppg: NotRequired[float]

Points allowed per game

qbp instance-attribute

qbp: NotRequired[int]

Quarterback pressures generated

qbp_pct instance-attribute

qbp_pct: NotRequired[float]

Quarterback pressure rate (0-1)

rush_td instance-attribute

rush_td: NotRequired[int]

Rushing touchdowns allowed

rush_yds instance-attribute

rush_yds: NotRequired[int]

Rushing yards allowed

rush_ypg instance-attribute

rush_ypg: NotRequired[float]

Rush yards allowed per game

rush_ypp instance-attribute

rush_ypp: NotRequired[float]

Rushing yards allowed per rush attempt

ryoe instance-attribute

ryoe: NotRequired[float]

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

sacked_yds instance-attribute

sacked_yds: NotRequired[int]

Sack yards generated

sacked_ypg instance-attribute

sacked_ypg: NotRequired[float]

Sack yards generated per game

td instance-attribute

td: NotRequired[int]

Total touchdowns allowed

total_takeaways instance-attribute

total_takeaways: NotRequired[int]

Total takeaways (interceptions + fumble recoveries)

ttt instance-attribute

ttt: NotRequired[float]

Average time to throw allowed (seconds)

ypg instance-attribute

ypg: NotRequired[float]

Yards allowed per game

ypp instance-attribute

ypp: NotRequired[float]

Yards allowed per play

TeamInfo

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamInfo[TeamInfo]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamInfo
                


              click griddy.nfl.models.TeamInfo href "" "griddy.nfl.models.TeamInfo"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Basic team information included in roster responses

Attributes

conference_abbr class-attribute instance-attribute

conference_abbr: Annotated[
    Optional[ConferenceEnum], Field(alias="conferenceAbbr")
] = None

NFL conference

team_type class-attribute instance-attribute

team_type: Annotated[
    Optional[TeamTypeEnum], Field(alias="teamType")
] = None

Team type classification

TeamInfoTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamInfoTypedDict[TeamInfoTypedDict]

              

              click griddy.nfl.models.TeamInfoTypedDict href "" "griddy.nfl.models.TeamInfoTypedDict"
            

Basic team information included in roster responses

Attributes

conference_abbr instance-attribute

conference_abbr: NotRequired[ConferenceEnum]

NFL conference

team_type instance-attribute

team_type: NotRequired[TeamTypeEnum]

Team type classification

TeamMatchupRankings

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamMatchupRankings[TeamMatchupRankings]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamMatchupRankings
                


              click griddy.nfl.models.TeamMatchupRankings href "" "griddy.nfl.models.TeamMatchupRankings"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Comprehensive team rankings across multiple statistical categories

Attributes

passing_overall_advantage class-attribute instance-attribute

passing_overall_advantage: Annotated[
    Optional[str], Field(alias="passingOverallAdvantage")
] = None

Advantage rating (-4 to 4)

passing_overall_z_diff class-attribute instance-attribute

passing_overall_z_diff: Annotated[
    Optional[float], Field(alias="passingOverallZDiff")
] = None

Z-score differential for passing offense vs defense

team_passing_overall_rank class-attribute instance-attribute

team_passing_overall_rank: Annotated[
    Optional[int], Field(alias="teamPassingOverallRank")
] = None

Overall passing offense rank (1-32)

team_passing_overall_z class-attribute instance-attribute

team_passing_overall_z: Annotated[
    Optional[float], Field(alias="teamPassingOverallZ")
] = None

Z-score for passing offense

TeamMatchupRankingsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamMatchupRankingsTypedDict[TeamMatchupRankingsTypedDict]

              

              click griddy.nfl.models.TeamMatchupRankingsTypedDict href "" "griddy.nfl.models.TeamMatchupRankingsTypedDict"
            

Comprehensive team rankings across multiple statistical categories

Attributes

passing_overall_advantage instance-attribute

passing_overall_advantage: NotRequired[str]

Advantage rating (-4 to 4)

passing_overall_z_diff instance-attribute

passing_overall_z_diff: NotRequired[float]

Z-score differential for passing offense vs defense

team_passing_overall_rank instance-attribute

team_passing_overall_rank: NotRequired[int]

Overall passing offense rank (1-32)

team_passing_overall_z instance-attribute

team_passing_overall_z: NotRequired[float]

Z-score for passing offense

TeamOffenseStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamOffenseStats[TeamOffenseStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamOffenseStats
                


              click griddy.nfl.models.TeamOffenseStats href "" "griddy.nfl.models.TeamOffenseStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

gp instance-attribute

gp: int

Games played

pass_ instance-attribute

pass_: Annotated[int, Field(alias='pass')]

Pass attempts (including sacks)

run instance-attribute

run: int

Rush attempts

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

total instance-attribute

total: int

Total offensive plays

yds instance-attribute

yds: int

Total offensive yards

epa class-attribute instance-attribute

epa: Optional[float] = None

Total EPA (positive is better for offense)

epa_pp class-attribute instance-attribute

epa_pp: Annotated[Optional[float], Field(alias="epaPP")] = (
    None
)

EPA per play

epa_pass class-attribute instance-attribute

epa_pass: Annotated[
    Optional[float], Field(alias="epaPass")
] = None

EPA on passing plays

epa_pass_pp class-attribute instance-attribute

epa_pass_pp: Annotated[
    Optional[float], Field(alias="epaPassPP")
] = None

EPA per pass play

epa_rush class-attribute instance-attribute

epa_rush: Annotated[
    Optional[float], Field(alias="epaRush")
] = None

EPA on rushing plays

epa_rush_pp class-attribute instance-attribute

epa_rush_pp: Annotated[
    Optional[float], Field(alias="epaRushPP")
] = None

EPA per rush play

pass_pct class-attribute instance-attribute

pass_pct: Annotated[
    Optional[float], Field(alias="passPct")
] = None

Percentage of plays that were passes (0-1)

pass_td class-attribute instance-attribute

pass_td: Annotated[Optional[int], Field(alias="passTd")] = (
    None
)

Passing touchdowns

pass_yds class-attribute instance-attribute

pass_yds: Annotated[
    Optional[int], Field(alias="passYds")
] = None

Passing yards

pass_ypg class-attribute instance-attribute

pass_ypg: Annotated[
    Optional[float], Field(alias="passYpg")
] = None

Pass yards per game

pass_ypp class-attribute instance-attribute

pass_ypp: Annotated[
    Optional[float], Field(alias="passYpp")
] = None

Passing yards per pass attempt

ppg class-attribute instance-attribute

ppg: Optional[float] = None

Points per game

red_zone_pct class-attribute instance-attribute

red_zone_pct: Annotated[
    Optional[float], Field(alias="redZonePct")
] = None

Red zone touchdown percentage (0-1)

rush_td class-attribute instance-attribute

rush_td: Annotated[Optional[int], Field(alias="rushTd")] = (
    None
)

Rushing touchdowns

rush_yds class-attribute instance-attribute

rush_yds: Annotated[
    Optional[int], Field(alias="rushYds")
] = None

Rushing yards

rush_ypg class-attribute instance-attribute

rush_ypg: Annotated[
    Optional[float], Field(alias="rushYpg")
] = None

Rush yards per game

rush_ypp class-attribute instance-attribute

rush_ypp: Annotated[
    Optional[float], Field(alias="rushYpp")
] = None

Rushing yards per rush attempt

td class-attribute instance-attribute

td: Optional[int] = None

Total touchdowns

third_down_pct class-attribute instance-attribute

third_down_pct: Annotated[
    Optional[float], Field(alias="thirdDownPct")
] = None

Third down conversion percentage (0-1)

to class-attribute instance-attribute

to: Optional[int] = None

Turnovers

ypg class-attribute instance-attribute

ypg: Optional[float] = None

Yards per game

ypp class-attribute instance-attribute

ypp: Optional[float] = None

Yards per play

TeamOffenseStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamOffenseStatsTypedDict[TeamOffenseStatsTypedDict]

              

              click griddy.nfl.models.TeamOffenseStatsTypedDict href "" "griddy.nfl.models.TeamOffenseStatsTypedDict"
            

Attributes

gp instance-attribute

gp: int

Games played

pass_ instance-attribute

pass_: int

Pass attempts (including sacks)

run instance-attribute

run: int

Rush attempts

team_id instance-attribute

team_id: str

Team identifier

total instance-attribute

total: int

Total offensive plays

yds instance-attribute

yds: int

Total offensive yards

epa instance-attribute

epa: NotRequired[float]

Total EPA (positive is better for offense)

epa_pp instance-attribute

epa_pp: NotRequired[float]

EPA per play

epa_pass instance-attribute

epa_pass: NotRequired[float]

EPA on passing plays

epa_pass_pp instance-attribute

epa_pass_pp: NotRequired[float]

EPA per pass play

epa_rush instance-attribute

epa_rush: NotRequired[float]

EPA on rushing plays

epa_rush_pp instance-attribute

epa_rush_pp: NotRequired[float]

EPA per rush play

pass_pct instance-attribute

pass_pct: NotRequired[float]

Percentage of plays that were passes (0-1)

pass_td instance-attribute

pass_td: NotRequired[int]

Passing touchdowns

pass_yds instance-attribute

pass_yds: NotRequired[int]

Passing yards

pass_ypg instance-attribute

pass_ypg: NotRequired[float]

Pass yards per game

pass_ypp instance-attribute

pass_ypp: NotRequired[float]

Passing yards per pass attempt

ppg instance-attribute

ppg: NotRequired[float]

Points per game

red_zone_pct instance-attribute

red_zone_pct: NotRequired[float]

Red zone touchdown percentage (0-1)

rush_td instance-attribute

rush_td: NotRequired[int]

Rushing touchdowns

rush_yds instance-attribute

rush_yds: NotRequired[int]

Rushing yards

rush_ypg instance-attribute

rush_ypg: NotRequired[float]

Rush yards per game

rush_ypp instance-attribute

rush_ypp: NotRequired[float]

Rushing yards per rush attempt

td instance-attribute

td: NotRequired[int]

Total touchdowns

third_down_pct instance-attribute

third_down_pct: NotRequired[float]

Third down conversion percentage (0-1)

to instance-attribute

to: NotRequired[int]

Turnovers

ypg instance-attribute

ypg: NotRequired[float]

Yards per game

ypp instance-attribute

ypp: NotRequired[float]

Yards per play

TeamOffensePassStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamOffensePassStats[TeamOffensePassStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamOffensePassStats
                


              click griddy.nfl.models.TeamOffensePassStats href "" "griddy.nfl.models.TeamOffensePassStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

gp instance-attribute

gp: int

Games played

pass_ instance-attribute

pass_: Annotated[int, Field(alias='pass')]

Pass attempts (including sacks)

pass_pct instance-attribute

pass_pct: Annotated[float, Field(alias='passPct')]

Percentage of plays that were passes (0-1)

pass_yds instance-attribute

pass_yds: Annotated[int, Field(alias='passYds')]

Passing yards

pass_ypp instance-attribute

pass_ypp: Annotated[float, Field(alias='passYpp')]

Passing yards per pass attempt

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

total instance-attribute

total: int

Total offensive plays

att class-attribute instance-attribute

att: Optional[int] = None

Pass attempts (not including sacks)

blitz_pct class-attribute instance-attribute

blitz_pct: Annotated[
    Optional[float], Field(alias="blitzPct")
] = None

Blitz percentage faced (0-1)

epa_pass class-attribute instance-attribute

epa_pass: Annotated[
    Optional[float], Field(alias="epaPass")
] = None

EPA on passing plays (positive is better for offense)

epa_pass_pp class-attribute instance-attribute

epa_pass_pp: Annotated[
    Optional[float], Field(alias="epaPassPP")
] = None

EPA per pass play

pa_pct class-attribute instance-attribute

pa_pct: Annotated[Optional[float], Field(alias="paPct")] = (
    None
)

Play action percentage (0-1)

pass_td class-attribute instance-attribute

pass_td: Annotated[Optional[int], Field(alias="passTd")] = (
    None
)

Passing touchdowns

pass_ypg class-attribute instance-attribute

pass_ypg: Annotated[
    Optional[float], Field(alias="passYpg")
] = None

Pass yards per game

qbp class-attribute instance-attribute

qbp: Optional[int] = None

Times quarterback was pressured

qbp_pct class-attribute instance-attribute

qbp_pct: Annotated[
    Optional[float], Field(alias="qbpPct")
] = None

Quarterback pressure rate (0-1)

sack class-attribute instance-attribute

sack: Optional[int] = None

Sacks taken

sack_pct class-attribute instance-attribute

sack_pct: Annotated[
    Optional[float], Field(alias="sackPct")
] = None

Sack rate (0-1)

sacked_yds class-attribute instance-attribute

sacked_yds: Annotated[
    Optional[int], Field(alias="sackedYds")
] = None

Sack yards lost

sacked_ypg class-attribute instance-attribute

sacked_ypg: Annotated[
    Optional[float], Field(alias="sackedYpg")
] = None

Sack yards lost per game

sep class-attribute instance-attribute

sep: Optional[float] = None

Average receiver separation at target (yards)

ttp class-attribute instance-attribute

ttp: Optional[float] = None

Time to pressure (seconds)

ttt class-attribute instance-attribute

ttt: Optional[float] = None

Average time to throw (seconds)

yac class-attribute instance-attribute

yac: Optional[int] = None

Yards after catch

yacoe class-attribute instance-attribute

yacoe: Optional[int] = None

Yards after catch over expected (positive is better)

TeamOffensePassStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamOffensePassStatsTypedDict[TeamOffensePassStatsTypedDict]

              

              click griddy.nfl.models.TeamOffensePassStatsTypedDict href "" "griddy.nfl.models.TeamOffensePassStatsTypedDict"
            

Attributes

gp instance-attribute

gp: int

Games played

pass_ instance-attribute

pass_: int

Pass attempts (including sacks)

pass_pct instance-attribute

pass_pct: float

Percentage of plays that were passes (0-1)

pass_yds instance-attribute

pass_yds: int

Passing yards

pass_ypp instance-attribute

pass_ypp: float

Passing yards per pass attempt

team_id instance-attribute

team_id: str

Team identifier

total instance-attribute

total: int

Total offensive plays

att instance-attribute

att: NotRequired[int]

Pass attempts (not including sacks)

blitz_pct instance-attribute

blitz_pct: NotRequired[float]

Blitz percentage faced (0-1)

epa_pass instance-attribute

epa_pass: NotRequired[float]

EPA on passing plays (positive is better for offense)

epa_pass_pp instance-attribute

epa_pass_pp: NotRequired[float]

EPA per pass play

pa_pct instance-attribute

pa_pct: NotRequired[float]

Play action percentage (0-1)

pass_td instance-attribute

pass_td: NotRequired[int]

Passing touchdowns

pass_ypg instance-attribute

pass_ypg: NotRequired[float]

Pass yards per game

qbp instance-attribute

qbp: NotRequired[int]

Times quarterback was pressured

qbp_pct instance-attribute

qbp_pct: NotRequired[float]

Quarterback pressure rate (0-1)

sack instance-attribute

sack: NotRequired[int]

Sacks taken

sack_pct instance-attribute

sack_pct: NotRequired[float]

Sack rate (0-1)

sacked_yds instance-attribute

sacked_yds: NotRequired[int]

Sack yards lost

sacked_ypg instance-attribute

sacked_ypg: NotRequired[float]

Sack yards lost per game

sep instance-attribute

sep: NotRequired[float]

Average receiver separation at target (yards)

ttp instance-attribute

ttp: NotRequired[float]

Time to pressure (seconds)

ttt instance-attribute

ttt: NotRequired[float]

Average time to throw (seconds)

yac instance-attribute

yac: NotRequired[int]

Yards after catch

yacoe instance-attribute

yacoe: NotRequired[int]

Yards after catch over expected (positive is better)

TeamRankingEntry

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamRankingEntry[TeamRankingEntry]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamRankingEntry
                


              click griddy.nfl.models.TeamRankingEntry href "" "griddy.nfl.models.TeamRankingEntry"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

rank class-attribute instance-attribute

rank: Optional[int] = None

Team's rank (1-32)

stats class-attribute instance-attribute

stats: Optional[float] = None

Statistical value

TeamRankingEntryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamRankingEntryTypedDict[TeamRankingEntryTypedDict]

              

              click griddy.nfl.models.TeamRankingEntryTypedDict href "" "griddy.nfl.models.TeamRankingEntryTypedDict"
            

Attributes

rank instance-attribute

rank: NotRequired[int]

Team's rank (1-32)

stats instance-attribute

stats: NotRequired[float]

Statistical value

TeamRankings

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamRankings[TeamRankings]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamRankings
                


              click griddy.nfl.models.TeamRankings href "" "griddy.nfl.models.TeamRankings"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

TeamRankingsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamRankingsTypedDict[TeamRankingsTypedDict]

              

              click griddy.nfl.models.TeamRankingsTypedDict href "" "griddy.nfl.models.TeamRankingsTypedDict"
            

Attributes

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

TeamScore

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamScore[TeamScore]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamScore
                


              click griddy.nfl.models.TeamScore href "" "griddy.nfl.models.TeamScore"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

point_ot class-attribute instance-attribute

point_ot: Annotated[
    Optional[int], Field(alias="pointOT")
] = None

Overtime points

point_q1 class-attribute instance-attribute

point_q1: Annotated[
    Optional[int], Field(alias="pointQ1")
] = None

First quarter points

point_q2 class-attribute instance-attribute

point_q2: Annotated[
    Optional[int], Field(alias="pointQ2")
] = None

Second quarter points

point_q3 class-attribute instance-attribute

point_q3: Annotated[
    Optional[int], Field(alias="pointQ3")
] = None

Third quarter points

point_q4 class-attribute instance-attribute

point_q4: Annotated[
    Optional[int], Field(alias="pointQ4")
] = None

Fourth quarter points

point_total class-attribute instance-attribute

point_total: Annotated[
    Optional[int], Field(alias="pointTotal")
] = None

Total points scored

timeouts_remaining class-attribute instance-attribute

timeouts_remaining: Annotated[
    Optional[int], Field(alias="timeoutsRemaining")
] = None

Timeouts left

TeamScoreTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamScoreTypedDict[TeamScoreTypedDict]

              

              click griddy.nfl.models.TeamScoreTypedDict href "" "griddy.nfl.models.TeamScoreTypedDict"
            

Attributes

point_ot instance-attribute

point_ot: NotRequired[int]

Overtime points

point_q1 instance-attribute

point_q1: NotRequired[int]

First quarter points

point_q2 instance-attribute

point_q2: NotRequired[int]

Second quarter points

point_q3 instance-attribute

point_q3: NotRequired[int]

Third quarter points

point_q4 instance-attribute

point_q4: NotRequired[int]

Fourth quarter points

point_total instance-attribute

point_total: NotRequired[int]

Total points scored

timeouts_remaining instance-attribute

timeouts_remaining: NotRequired[int]

Timeouts left

TeamVenue

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TeamVenue[TeamVenue]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TeamVenue
                


              click griddy.nfl.models.TeamVenue href "" "griddy.nfl.models.TeamVenue"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

city class-attribute instance-attribute

city: Optional[str] = None

Venue city

country class-attribute instance-attribute

country: Optional[str] = None

Venue country

id class-attribute instance-attribute

id: Optional[str] = None

Venue identifier

name class-attribute instance-attribute

name: Optional[str] = None

Venue name

TeamVenueTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TeamVenueTypedDict[TeamVenueTypedDict]

              

              click griddy.nfl.models.TeamVenueTypedDict href "" "griddy.nfl.models.TeamVenueTypedDict"
            

Attributes

city instance-attribute

city: NotRequired[str]

Venue city

country instance-attribute

country: NotRequired[str]

Venue country

id instance-attribute

id: NotRequired[str]

Venue identifier

name instance-attribute

name: NotRequired[str]

Venue name

TicketVendor

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TicketVendor[TicketVendor]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TicketVendor
                


              click griddy.nfl.models.TicketVendor href "" "griddy.nfl.models.TicketVendor"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

ticket_url class-attribute instance-attribute

ticket_url: Annotated[
    Optional[str], Field(alias="ticketUrl")
] = None

Vendor-specific ticket URL

vendor_name class-attribute instance-attribute

vendor_name: Annotated[
    Optional[str], Field(alias="vendorName")
] = None

Vendor identifier

TicketVendorTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TicketVendorTypedDict[TicketVendorTypedDict]

              

              click griddy.nfl.models.TicketVendorTypedDict href "" "griddy.nfl.models.TicketVendorTypedDict"
            

Attributes

ticket_url instance-attribute

ticket_url: NotRequired[str]

Vendor-specific ticket URL

vendor_name instance-attribute

vendor_name: NotRequired[str]

Vendor identifier

Totals

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Totals[Totals]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Totals
                


              click griddy.nfl.models.Totals href "" "griddy.nfl.models.Totals"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Over/Under (totals) betting odds

Attributes

over_handicap class-attribute instance-attribute

over_handicap: Annotated[
    Optional[float], Field(alias="overHandicap")
] = None

Total points line for over

over_price class-attribute instance-attribute

over_price: Annotated[
    Optional[int], Field(alias="overPrice")
] = None

Over odds (American format)

under_handicap class-attribute instance-attribute

under_handicap: Annotated[
    Optional[float], Field(alias="underHandicap")
] = None

Total points line for under

under_price class-attribute instance-attribute

under_price: Annotated[
    Optional[int], Field(alias="underPrice")
] = None

Under odds (American format)

TotalsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TotalsTypedDict[TotalsTypedDict]

              

              click griddy.nfl.models.TotalsTypedDict href "" "griddy.nfl.models.TotalsTypedDict"
            

Over/Under (totals) betting odds

Attributes

over_handicap instance-attribute

over_handicap: NotRequired[float]

Total points line for over

over_price instance-attribute

over_price: NotRequired[int]

Over odds (American format)

under_handicap instance-attribute

under_handicap: NotRequired[float]

Total points line for under

under_price instance-attribute

under_price: NotRequired[int]

Under odds (American format)

Transaction

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Transaction[Transaction]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Transaction
                


              click griddy.nfl.models.Transaction href "" "griddy.nfl.models.Transaction"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

compensation_details class-attribute instance-attribute

compensation_details: Annotated[
    Optional[str], Field(alias="compensationDetails")
] = None

Trade compensation or contract details

details class-attribute instance-attribute

details: Optional[str] = None

Transaction details

TransactionTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TransactionTypedDict[TransactionTypedDict]

              

              click griddy.nfl.models.TransactionTypedDict href "" "griddy.nfl.models.TransactionTypedDict"
            

Attributes

compensation_details instance-attribute

compensation_details: NotRequired[str]

Trade compensation or contract details

details instance-attribute

details: NotRequired[str]

Transaction details

Venue

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Venue[Venue]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Venue
                


              click griddy.nfl.models.Venue href "" "griddy.nfl.models.Venue"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

address class-attribute instance-attribute

address: OptionalNullable[str] = UNSET

Street address

city class-attribute instance-attribute

city: Optional[str] = None

City name

country class-attribute instance-attribute

country: Optional[str] = None

Country name

id class-attribute instance-attribute

id: Optional[str] = None

Unique venue identifier

name class-attribute instance-attribute

name: Optional[str] = None

Venue name

postal_code class-attribute instance-attribute

postal_code: Annotated[
    OptionalNullable[str], Field(alias="postalCode")
] = UNSET

Postal/ZIP code

territory class-attribute instance-attribute

territory: OptionalNullable[str] = UNSET

State or territory code

VenueTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.VenueTypedDict[VenueTypedDict]

              

              click griddy.nfl.models.VenueTypedDict href "" "griddy.nfl.models.VenueTypedDict"
            

Attributes

address instance-attribute

address: NotRequired[Nullable[str]]

Street address

city instance-attribute

city: NotRequired[str]

City name

country instance-attribute

country: NotRequired[str]

Country name

id instance-attribute

id: NotRequired[str]

Unique venue identifier

name instance-attribute

name: NotRequired[str]

Venue name

postal_code instance-attribute

postal_code: NotRequired[Nullable[str]]

Postal/ZIP code

territory instance-attribute

territory: NotRequired[Nullable[str]]

State or territory code

VideoAuthorizations

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.VideoAuthorizations[VideoAuthorizations]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.VideoAuthorizations
                


              click griddy.nfl.models.VideoAuthorizations href "" "griddy.nfl.models.VideoAuthorizations"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Authorization requirements for video access

VideoAuthorizationsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.VideoAuthorizationsTypedDict[VideoAuthorizationsTypedDict]

              

              click griddy.nfl.models.VideoAuthorizationsTypedDict href "" "griddy.nfl.models.VideoAuthorizationsTypedDict"
            

Authorization requirements for video access

VideoGamePlayIds

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.VideoGamePlayIds[VideoGamePlayIds]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.VideoGamePlayIds
                


              click griddy.nfl.models.VideoGamePlayIds href "" "griddy.nfl.models.VideoGamePlayIds"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

away_team_id instance-attribute

away_team_id: Annotated[str, Field(alias='awayTeamId')]

Away team UUID

game_id instance-attribute

game_id: Annotated[str, Field(alias='gameId')]

Game UUID

home_team_id instance-attribute

home_team_id: Annotated[str, Field(alias='homeTeamId')]

Home team UUID

play_id instance-attribute

play_id: Annotated[str, Field(alias='playId')]

Play identifier

VideoGamePlayIdsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.VideoGamePlayIdsTypedDict[VideoGamePlayIdsTypedDict]

              

              click griddy.nfl.models.VideoGamePlayIdsTypedDict href "" "griddy.nfl.models.VideoGamePlayIdsTypedDict"
            

Attributes

away_team_id instance-attribute

away_team_id: str

Away team UUID

game_id instance-attribute

game_id: str

Game UUID

home_team_id instance-attribute

home_team_id: str

Home team UUID

play_id instance-attribute

play_id: str

Play identifier

VideoTag

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.VideoTag[VideoTag]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.VideoTag
                


              click griddy.nfl.models.VideoTag href "" "griddy.nfl.models.VideoTag"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Video tag information

Attributes

game_id class-attribute instance-attribute

game_id: Annotated[Optional[str], Field(alias="gameId")] = (
    None
)

Game identifier (for game tags)

person_id class-attribute instance-attribute

person_id: Annotated[
    Optional[str], Field(alias="personId")
] = None

Person identifier (for player tags)

season class-attribute instance-attribute

season: Optional[str] = None

Season year (for game tags)

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

slug class-attribute instance-attribute

slug: Optional[str] = None

URL-friendly tag identifier

team_id class-attribute instance-attribute

team_id: Annotated[Optional[str], Field(alias="teamId")] = (
    None
)

Team identifier (for team tags)

title class-attribute instance-attribute

title: Optional[str] = None

Tag title

week class-attribute instance-attribute

week: Optional[str] = None

Week number (for game tags)

VideoTagTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.VideoTagTypedDict[VideoTagTypedDict]

              

              click griddy.nfl.models.VideoTagTypedDict href "" "griddy.nfl.models.VideoTagTypedDict"
            

Video tag information

Attributes

game_id instance-attribute

game_id: NotRequired[str]

Game identifier (for game tags)

person_id instance-attribute

person_id: NotRequired[str]

Person identifier (for player tags)

season instance-attribute

season: NotRequired[str]

Season year (for game tags)

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

slug instance-attribute

slug: NotRequired[str]

URL-friendly tag identifier

team_id instance-attribute

team_id: NotRequired[str]

Team identifier (for team tags)

title instance-attribute

title: NotRequired[str]

Tag title

week instance-attribute

week: NotRequired[str]

Week number (for game tags)

VideoThumbnail

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.VideoThumbnail[VideoThumbnail]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.VideoThumbnail
                


              click griddy.nfl.models.VideoThumbnail href "" "griddy.nfl.models.VideoThumbnail"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

thumbnail_url instance-attribute

thumbnail_url: Annotated[str, Field(alias='thumbnailUrl')]

Video thumbnail image URL

VideoThumbnailTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.VideoThumbnailTypedDict[VideoThumbnailTypedDict]

              

              click griddy.nfl.models.VideoThumbnailTypedDict href "" "griddy.nfl.models.VideoThumbnailTypedDict"
            

Attributes

thumbnail_url instance-attribute

thumbnail_url: str

Video thumbnail image URL

Week

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Week[Week]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Week
                


              click griddy.nfl.models.Week href "" "griddy.nfl.models.Week"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

bye_teams class-attribute instance-attribute

bye_teams: Annotated[
    Optional[List[ProTeam]], Field(alias="byeTeams")
] = None

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

date_begin class-attribute instance-attribute

date_begin: Annotated[
    Optional[date], Field(alias="dateBegin")
] = None

First day of the week

date_end class-attribute instance-attribute

date_end: Annotated[
    Optional[date], Field(alias="dateEnd")
] = None

Last day of the week

season class-attribute instance-attribute

season: Optional[int] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

season_type_week class-attribute instance-attribute

season_type_week: Annotated[
    Optional[str], Field(alias="seasonTypeWeek")
] = None

Combined season type and week identifier

text class-attribute instance-attribute

text: Optional[str] = None

Human-readable week description

week class-attribute instance-attribute

week: Optional[int] = None

Week number (0 for Hall of Fame game)

week_slug class-attribute instance-attribute

week_slug: Annotated[
    Optional[str], Field(alias="weekSlug")
] = None

Week identifier slug

week_type class-attribute instance-attribute

week_type: Annotated[
    Optional[WeekWeekType], Field(alias="weekType")
] = None

Type of week

WeekTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeekTypedDict[WeekTypedDict]

              

              click griddy.nfl.models.WeekTypedDict href "" "griddy.nfl.models.WeekTypedDict"
            

Attributes

bye_teams instance-attribute

bye_teams: NotRequired[List[ProTeamTypedDict]]

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

date_begin instance-attribute

date_begin: NotRequired[date]

First day of the week

date_end instance-attribute

date_end: NotRequired[date]

Last day of the week

season instance-attribute

season: NotRequired[int]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

season_type_week instance-attribute

season_type_week: NotRequired[str]

Combined season type and week identifier

text instance-attribute

text: NotRequired[str]

Human-readable week description

week instance-attribute

week: NotRequired[int]

Week number (0 for Hall of Fame game)

week_slug instance-attribute

week_slug: NotRequired[str]

Week identifier slug

week_type instance-attribute

week_type: NotRequired[WeekWeekType]

Type of week

DriveChart

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.DriveChart[DriveChart]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.DriveChart
                


              click griddy.nfl.models.DriveChart href "" "griddy.nfl.models.DriveChart"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Drive-by-drive data

DriveChartTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.DriveChartTypedDict[DriveChartTypedDict]

              

              click griddy.nfl.models.DriveChartTypedDict href "" "griddy.nfl.models.DriveChartTypedDict"
            

Drive-by-drive data

Summary

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.Summary[Summary]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.Summary
                


              click griddy.nfl.models.Summary href "" "griddy.nfl.models.Summary"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Game summary information

SummaryTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.SummaryTypedDict[SummaryTypedDict]

              

              click griddy.nfl.models.SummaryTypedDict href "" "griddy.nfl.models.SummaryTypedDict"
            

Game summary information

TaggedVideos

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.TaggedVideos[TaggedVideos]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.TaggedVideos
                


              click griddy.nfl.models.TaggedVideos href "" "griddy.nfl.models.TaggedVideos"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Tagged video content

TaggedVideosTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.TaggedVideosTypedDict[TaggedVideosTypedDict]

              

              click griddy.nfl.models.TaggedVideosTypedDict href "" "griddy.nfl.models.TaggedVideosTypedDict"
            

Tagged video content

WeeklyGameDetail

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WeeklyGameDetail[WeeklyGameDetail]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WeeklyGameDetail
                


              click griddy.nfl.models.WeeklyGameDetail href "" "griddy.nfl.models.WeeklyGameDetail"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

date_ class-attribute instance-attribute

date_: Annotated[Optional[str], Field(alias='date')] = None

Game date (YYYY-MM-DD)

date_am_pm class-attribute instance-attribute

date_am_pm: Annotated[
    Optional[MeridiemEnum], Field(alias="dateAmPm")
] = None

Time of day indicator

date_day class-attribute instance-attribute

date_day: Annotated[
    Optional[str], Field(alias="dateDay")
] = None

Day of week (full)

date_day_month class-attribute instance-attribute

date_day_month: Annotated[
    Optional[str], Field(alias="dateDayMonth")
] = None

Date in M/D format

date_day_short class-attribute instance-attribute

date_day_short: Annotated[
    Optional[str], Field(alias="dateDayShort")
] = None

Day of week (abbreviated)

date_time class-attribute instance-attribute

date_time: Annotated[
    Optional[str], Field(alias="dateTime")
] = None

Time without AM/PM

date_time_am_pm class-attribute instance-attribute

date_time_am_pm: Annotated[
    Optional[str], Field(alias="dateTimeAmPm")
] = None

Time with AM/PM

extensions class-attribute instance-attribute

extensions: Optional[List[WeeklyGameDetailExtension]] = None

Additional game data extensions

game_type class-attribute instance-attribute

game_type: Annotated[
    Optional[str], Field(alias="gameType")
] = None

Type of game

id class-attribute instance-attribute

id: Optional[str] = None

Unique game identifier

international class-attribute instance-attribute

international: Optional[bool] = None

Whether game is played internationally

neutral_site class-attribute instance-attribute

neutral_site: Annotated[
    Optional[bool], Field(alias="neutralSite")
] = None

Whether game is at neutral venue

phase class-attribute instance-attribute

phase: Optional[str] = None

Game phase

season class-attribute instance-attribute

season: Optional[int] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

status class-attribute instance-attribute

status: Optional[WeeklyGameDetailStatus] = None

Game status

ticket_url class-attribute instance-attribute

ticket_url: Annotated[
    Optional[str], Field(alias="ticketUrl")
] = None

Primary ticket purchase URL

time class-attribute instance-attribute

time: Optional[str] = None

Game time in UTC

version class-attribute instance-attribute

version: Optional[int] = None

Data version number

week class-attribute instance-attribute

week: Optional[int] = None

Week number

week_type class-attribute instance-attribute

week_type: Annotated[
    Optional[str], Field(alias="weekType")
] = None

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

drive_chart class-attribute instance-attribute

drive_chart: Annotated[
    Optional[DriveChart], Field(alias="driveChart")
] = None

Drive-by-drive data

replays class-attribute instance-attribute

replays: Optional[List[Replay]] = None

Replay video links

summary class-attribute instance-attribute

summary: Optional[Summary] = None

Game summary information

tagged_videos class-attribute instance-attribute

tagged_videos: Annotated[
    Optional[List[TaggedVideos]],
    Field(alias="taggedVideos"),
] = None

Tagged video content

WeeklyGameDetailTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeeklyGameDetailTypedDict[WeeklyGameDetailTypedDict]

              

              click griddy.nfl.models.WeeklyGameDetailTypedDict href "" "griddy.nfl.models.WeeklyGameDetailTypedDict"
            

Attributes

date_ instance-attribute

date_: NotRequired[date]

Game date (YYYY-MM-DD)

date_am_pm instance-attribute

date_am_pm: NotRequired[MeridiemEnum]

Time of day indicator

date_day instance-attribute

date_day: NotRequired[str]

Day of week (full)

date_day_month instance-attribute

date_day_month: NotRequired[str]

Date in M/D format

date_day_short instance-attribute

date_day_short: NotRequired[str]

Day of week (abbreviated)

date_time instance-attribute

date_time: NotRequired[str]

Time without AM/PM

date_time_am_pm instance-attribute

date_time_am_pm: NotRequired[str]

Time with AM/PM

extensions instance-attribute

extensions: NotRequired[
    List[WeeklyGameDetailExtensionTypedDict]
]

Additional game data extensions

game_type instance-attribute

game_type: NotRequired[str]

Type of game

id instance-attribute

id: NotRequired[str]

Unique game identifier

international instance-attribute

international: NotRequired[bool]

Whether game is played internationally

neutral_site instance-attribute

neutral_site: NotRequired[bool]

Whether game is at neutral venue

phase instance-attribute

phase: NotRequired[str]

Game phase

season instance-attribute

season: NotRequired[int]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

status instance-attribute

status: NotRequired[WeeklyGameDetailStatus]

Game status

ticket_url instance-attribute

ticket_url: NotRequired[Nullable[str]]

Primary ticket purchase URL

time instance-attribute

time: NotRequired[datetime]

Game time in UTC

version instance-attribute

version: NotRequired[int]

Data version number

week instance-attribute

week: NotRequired[int]

Week number

week_type instance-attribute

week_type: NotRequired[str]

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

drive_chart instance-attribute

drive_chart: NotRequired[Nullable[DriveChartTypedDict]]

Drive-by-drive data

replays instance-attribute

replays: NotRequired[List[ReplayTypedDict]]

Replay video links

summary instance-attribute

summary: NotRequired[Nullable[SummaryTypedDict]]

Game summary information

tagged_videos instance-attribute

tagged_videos: NotRequired[
    Nullable[List[TaggedVideosTypedDict]]
]

Tagged video content

WeeklyPlayer

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WeeklyPlayer[WeeklyPlayer]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WeeklyPlayer
                


              click griddy.nfl.models.WeeklyPlayer href "" "griddy.nfl.models.WeeklyPlayer"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Player information with weekly status

Attributes

birth_date class-attribute instance-attribute

birth_date: Annotated[
    Optional[date], Field(alias="birthDate")
] = None

Player's birth date

college_conference class-attribute instance-attribute

college_conference: Annotated[
    Optional[str], Field(alias="collegeConference")
] = None

Player's college conference

college_name class-attribute instance-attribute

college_name: Annotated[
    Optional[str], Field(alias="collegeName")
] = None

Player's college

current_team_id class-attribute instance-attribute

current_team_id: Annotated[
    Optional[str], Field(alias="currentTeamId")
] = None

Current team identifier

display_name class-attribute instance-attribute

display_name: Annotated[
    Optional[str], Field(alias="displayName")
] = None

Player's display name

draft_club class-attribute instance-attribute

draft_club: Annotated[
    OptionalNullable[str], Field(alias="draftClub")
] = UNSET

Team that drafted the player

draft_number class-attribute instance-attribute

draft_number: Annotated[
    OptionalNullable[int], Field(alias="draftNumber")
] = UNSET

Overall draft pick number

draftround class-attribute instance-attribute

draftround: OptionalNullable[int] = UNSET

Draft round

entry_year class-attribute instance-attribute

entry_year: Annotated[
    Optional[int], Field(alias="entryYear")
] = None

Year player entered the league

esb_id class-attribute instance-attribute

esb_id: Annotated[Optional[str], Field(alias="esbId")] = (
    None
)

ESB identifier

first_name class-attribute instance-attribute

first_name: Annotated[
    Optional[str], Field(alias="firstName")
] = None

Player's first name

football_name class-attribute instance-attribute

football_name: Annotated[
    Optional[str], Field(alias="footballName")
] = None

Player's football name (nickname)

gsis_id class-attribute instance-attribute

gsis_id: Annotated[Optional[str], Field(alias="gsisId")] = (
    None
)

GSIS identifier

gsis_it_id class-attribute instance-attribute

gsis_it_id: Annotated[
    Optional[int], Field(alias="gsisItId")
] = None

GSIS IT identifier

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image

height class-attribute instance-attribute

height: Optional[str] = None

Player height (format is feet-inches)

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

last_name class-attribute instance-attribute

last_name: Annotated[
    Optional[str], Field(alias="lastName")
] = None

Player's last name

nfl_id class-attribute instance-attribute

nfl_id: Annotated[Optional[int], Field(alias="nflId")] = (
    None
)

NFL player identifier

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    OptionalNullable[str], Field(alias="ngsPosition")
] = UNSET

Next Gen Stats position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    OptionalNullable[str], Field(alias="ngsPositionGroup")
] = UNSET

Next Gen Stats position group

position class-attribute instance-attribute

position: Optional[str] = None

Player's position

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[str], Field(alias="positionGroup")
] = None

Player's position group

rookie_year class-attribute instance-attribute

rookie_year: Annotated[
    Optional[int], Field(alias="rookieYear")
] = None

Player's rookie year

season class-attribute instance-attribute

season: Optional[int] = None

Current season

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Shortened player name

smart_id class-attribute instance-attribute

smart_id: Annotated[
    Optional[str], Field(alias="smartId")
] = None

Smart identifier for the player

status class-attribute instance-attribute

status: Optional[str] = None

Player status code

status_description_abbr class-attribute instance-attribute

status_description_abbr: Annotated[
    Optional[str], Field(alias="statusDescriptionAbbr")
] = None

Abbreviated status description

status_short_description class-attribute instance-attribute

status_short_description: Annotated[
    Optional[str], Field(alias="statusShortDescription")
] = None

Short status description

team_abbr class-attribute instance-attribute

team_abbr: Annotated[
    Optional[str], Field(alias="teamAbbr")
] = None

Current team abbreviation

uniform_number class-attribute instance-attribute

uniform_number: Annotated[
    Optional[str], Field(alias="uniformNumber")
] = None

Player's uniform number (formatted)

weight class-attribute instance-attribute

weight: Optional[int] = None

Player weight in pounds

years_of_experience class-attribute instance-attribute

years_of_experience: Annotated[
    Optional[int], Field(alias="yearsOfExperience")
] = None

Years of NFL experience

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

week class-attribute instance-attribute

week: Optional[int] = None

Week number

WeeklyPlayerTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeeklyPlayerTypedDict[WeeklyPlayerTypedDict]

              

              click griddy.nfl.models.WeeklyPlayerTypedDict href "" "griddy.nfl.models.WeeklyPlayerTypedDict"
            

Player information with weekly status

Attributes

birth_date instance-attribute

birth_date: NotRequired[date]

Player's birth date

college_conference instance-attribute

college_conference: NotRequired[str]

Player's college conference

college_name instance-attribute

college_name: NotRequired[str]

Player's college

current_team_id instance-attribute

current_team_id: NotRequired[str]

Current team identifier

display_name instance-attribute

display_name: NotRequired[str]

Player's display name

draft_club instance-attribute

draft_club: NotRequired[Nullable[str]]

Team that drafted the player

draft_number instance-attribute

draft_number: NotRequired[Nullable[int]]

Overall draft pick number

draftround instance-attribute

draftround: NotRequired[Nullable[int]]

Draft round

entry_year instance-attribute

entry_year: NotRequired[int]

Year player entered the league

esb_id instance-attribute

esb_id: NotRequired[str]

ESB identifier

first_name instance-attribute

first_name: NotRequired[str]

Player's first name

football_name instance-attribute

football_name: NotRequired[str]

Player's football name (nickname)

gsis_id instance-attribute

gsis_id: NotRequired[str]

GSIS identifier

gsis_it_id instance-attribute

gsis_it_id: NotRequired[int]

GSIS IT identifier

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image

height instance-attribute

height: NotRequired[str]

Player height (format is feet-inches)

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

last_name instance-attribute

last_name: NotRequired[str]

Player's last name

nfl_id instance-attribute

nfl_id: NotRequired[int]

NFL player identifier

ngs_position instance-attribute

ngs_position: NotRequired[Nullable[str]]

Next Gen Stats position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[Nullable[str]]

Next Gen Stats position group

position instance-attribute

position: NotRequired[str]

Player's position

position_group instance-attribute

position_group: NotRequired[str]

Player's position group

rookie_year instance-attribute

rookie_year: NotRequired[int]

Player's rookie year

season instance-attribute

season: NotRequired[int]

Current season

short_name instance-attribute

short_name: NotRequired[str]

Shortened player name

smart_id instance-attribute

smart_id: NotRequired[str]

Smart identifier for the player

status instance-attribute

status: NotRequired[str]

Player status code

status_description_abbr instance-attribute

status_description_abbr: NotRequired[str]

Abbreviated status description

status_short_description instance-attribute

status_short_description: NotRequired[str]

Short status description

team_abbr instance-attribute

team_abbr: NotRequired[str]

Current team abbreviation

uniform_number instance-attribute

uniform_number: NotRequired[str]

Player's uniform number (formatted)

weight instance-attribute

weight: NotRequired[int]

Player weight in pounds

years_of_experience instance-attribute

years_of_experience: NotRequired[int]

Years of NFL experience

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

week instance-attribute

week: NotRequired[int]

Week number

WeeklyPlayerPassingStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WeeklyPlayerPassingStats[WeeklyPlayerPassingStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WeeklyPlayerPassingStats
                


              click griddy.nfl.models.WeeklyPlayerPassingStats href "" "griddy.nfl.models.WeeklyPlayerPassingStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

att instance-attribute

att: int

Attempts

cmp instance-attribute

cmp: int

Completions

display_name instance-attribute

display_name: Annotated[str, Field(alias='displayName')]

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

int_ instance-attribute

int_: Annotated[int, Field(alias='int')]

Interceptions

nfl_id instance-attribute

nfl_id: Annotated[str, Field(alias='nflId')]

NFL player identifier

position instance-attribute

position: str

Player position

td instance-attribute

td: int

Touchdown passes

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

yds instance-attribute

yds: int

Passing yards

att_pg class-attribute instance-attribute

att_pg: Annotated[Optional[float], Field(alias="attPG")] = (
    None
)

Attempts per game

avg_sep class-attribute instance-attribute

avg_sep: Annotated[
    Optional[float], Field(alias="avgSep")
] = None

Average receiver separation at target (yards)

avg_ttp class-attribute instance-attribute

avg_ttp: Annotated[
    Optional[float], Field(alias="avgTTP")
] = None

Average time to pass (seconds)

avg_tts class-attribute instance-attribute

avg_tts: Annotated[
    Optional[float], Field(alias="avgTTS")
] = None

Average time to sack (seconds)

avg_ttt class-attribute instance-attribute

avg_ttt: Annotated[
    Optional[float], Field(alias="avgTTT")
] = None

Average time to throw (seconds)

ay class-attribute instance-attribute

ay: Optional[float] = None

Air yards

ay_att class-attribute instance-attribute

ay_att: Annotated[Optional[float], Field(alias="ayAtt")] = (
    None
)

Air yards per attempt

blitz_r class-attribute instance-attribute

blitz_r: Annotated[
    Optional[float], Field(alias="blitzR")
] = None

Blitz rate faced (0-1)

cmp_pg class-attribute instance-attribute

cmp_pg: Annotated[Optional[float], Field(alias="cmpPG")] = (
    None
)

Completions per game

cmp_pct class-attribute instance-attribute

cmp_pct: Annotated[
    Optional[float], Field(alias="cmpPct")
] = None

Completion percentage (0-1)

cpoe class-attribute instance-attribute

cpoe: Optional[float] = None

Completion percentage over expected

db class-attribute instance-attribute

db: Optional[int] = None

Dropbacks

db_pg class-attribute instance-attribute

db_pg: Annotated[Optional[float], Field(alias="dbPG")] = (
    None
)

Dropbacks per game

deep_att_pct class-attribute instance-attribute

deep_att_pct: Annotated[
    Optional[float], Field(alias="deepAttPct")
] = None

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

drop class-attribute instance-attribute

drop: Optional[int] = None

Dropped passes by receivers

drop_pg class-attribute instance-attribute

drop_pg: Annotated[
    Optional[float], Field(alias="dropPG")
] = None

Drops per game

drop_r class-attribute instance-attribute

drop_r: Annotated[Optional[float], Field(alias="dropR")] = (
    None
)

Drop rate (0-1)

epa class-attribute instance-attribute

epa: Optional[float] = None

Expected Points Added

epa_db class-attribute instance-attribute

epa_db: Annotated[Optional[float], Field(alias="epaDb")] = (
    None
)

EPA per dropback

epa_pg class-attribute instance-attribute

epa_pg: Annotated[Optional[float], Field(alias="epaPG")] = (
    None
)

EPA per game

fapi_game_id class-attribute instance-attribute

fapi_game_id: Annotated[
    Optional[str], Field(alias="fapiGameId")
] = None

Football API game identifier

final_score class-attribute instance-attribute

final_score: Annotated[
    Optional[str], Field(alias="finalScore")
] = None

Final score of the game

game_id class-attribute instance-attribute

game_id: Annotated[Optional[int], Field(alias="gameId")] = (
    None
)

Game identifier (10-digit format YYYYMMDDNN)

game_result class-attribute instance-attribute

game_result: Annotated[
    Optional[GameResultEnum], Field(alias="gameResult")
] = None

Game result (Win/Loss/Tie)

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image (contains formatInstructions placeholder)

int_pg class-attribute instance-attribute

int_pg: Annotated[Optional[float], Field(alias="intPG")] = (
    None
)

Interceptions per game

is_home class-attribute instance-attribute

is_home: Annotated[
    Optional[bool], Field(alias="isHome")
] = None

Whether player's team was at home

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    Optional[str], Field(alias="ngsPosition")
] = None

Next Gen Stats position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    Optional[str], Field(alias="ngsPositionGroup")
] = None

Next Gen Stats position group

opponent_team_id class-attribute instance-attribute

opponent_team_id: Annotated[
    Optional[str], Field(alias="opponentTeamId")
] = None

Opponent team identifier

pa_db_pct class-attribute instance-attribute

pa_db_pct: Annotated[
    Optional[float], Field(alias="paDbPct")
] = None

Play action dropback percentage (0-1)

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[str], Field(alias="positionGroup")
] = None

Position group

qbp class-attribute instance-attribute

qbp: Optional[int] = None

Times under QB pressure

qbp_pg class-attribute instance-attribute

qbp_pg: Annotated[Optional[float], Field(alias="qbpPG")] = (
    None
)

QB pressure per game

qbp_r class-attribute instance-attribute

qbp_r: Annotated[Optional[float], Field(alias="qbpR")] = (
    None
)

QB pressure rate (0-1)

qp class-attribute instance-attribute

qp: Optional[bool] = None

Qualified passer status

rating class-attribute instance-attribute

rating: Optional[float] = None

Passer rating

sack class-attribute instance-attribute

sack: Optional[int] = None

Times sacked

sack_pg class-attribute instance-attribute

sack_pg: Annotated[
    Optional[float], Field(alias="sackPG")
] = None

Sacks per game

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Abbreviated player name

td_pg class-attribute instance-attribute

td_pg: Annotated[Optional[float], Field(alias="tdPG")] = (
    None
)

Touchdowns per game

tg class-attribute instance-attribute

tg: Optional[int] = None

Team games for player

total_tg class-attribute instance-attribute

total_tg: Annotated[
    Optional[int], Field(alias="totalTg")
] = None

Total team games in period

tw_att_pg class-attribute instance-attribute

tw_att_pg: Annotated[
    Optional[float], Field(alias="twAttPG")
] = None

Two-minute attempts per game

tw_att_pct class-attribute instance-attribute

tw_att_pct: Annotated[
    Optional[float], Field(alias="twAttPct")
] = None

Two-minute drill attempt percentage (0-1)

week_slug class-attribute instance-attribute

week_slug: Annotated[
    Optional[str], Field(alias="weekSlug")
] = None

Week identifier slug

x_cmp class-attribute instance-attribute

x_cmp: Annotated[Optional[float], Field(alias="xCmp")] = (
    None
)

Expected completion percentage (0-1)

x_yac class-attribute instance-attribute

x_yac: Annotated[Optional[float], Field(alias="xYac")] = (
    None
)

Expected yards after catch

yac class-attribute instance-attribute

yac: Optional[float] = None

Yards after catch

yac_pct class-attribute instance-attribute

yac_pct: Annotated[
    Optional[float], Field(alias="yacPct")
] = None

YAC percentage of total yards (0-1)

yds_pg class-attribute instance-attribute

yds_pg: Annotated[Optional[float], Field(alias="ydsPG")] = (
    None
)

Yards per game

ypa class-attribute instance-attribute

ypa: Optional[float] = None

Yards per attempt

WeeklyPlayerPassingStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeeklyPlayerPassingStatsTypedDict[WeeklyPlayerPassingStatsTypedDict]

              

              click griddy.nfl.models.WeeklyPlayerPassingStatsTypedDict href "" "griddy.nfl.models.WeeklyPlayerPassingStatsTypedDict"
            

Attributes

att instance-attribute

att: int

Attempts

cmp instance-attribute

cmp: int

Completions

display_name instance-attribute

display_name: str

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

int_ instance-attribute

int_: int

Interceptions

nfl_id instance-attribute

nfl_id: str

NFL player identifier

position instance-attribute

position: str

Player position

td instance-attribute

td: int

Touchdown passes

team_id instance-attribute

team_id: str

Team identifier

yds instance-attribute

yds: int

Passing yards

att_pg instance-attribute

att_pg: NotRequired[float]

Attempts per game

avg_sep instance-attribute

avg_sep: NotRequired[float]

Average receiver separation at target (yards)

avg_ttp instance-attribute

avg_ttp: NotRequired[float]

Average time to pass (seconds)

avg_tts instance-attribute

avg_tts: NotRequired[float]

Average time to sack (seconds)

avg_ttt instance-attribute

avg_ttt: NotRequired[float]

Average time to throw (seconds)

ay instance-attribute

ay: NotRequired[float]

Air yards

ay_att instance-attribute

ay_att: NotRequired[float]

Air yards per attempt

blitz_r instance-attribute

blitz_r: NotRequired[float]

Blitz rate faced (0-1)

cmp_pg instance-attribute

cmp_pg: NotRequired[float]

Completions per game

cmp_pct instance-attribute

cmp_pct: NotRequired[float]

Completion percentage (0-1)

cpoe instance-attribute

cpoe: NotRequired[float]

Completion percentage over expected

db instance-attribute

db: NotRequired[int]

Dropbacks

db_pg instance-attribute

db_pg: NotRequired[float]

Dropbacks per game

deep_att_pct instance-attribute

deep_att_pct: NotRequired[float]

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

drop instance-attribute

drop: NotRequired[int]

Dropped passes by receivers

drop_pg instance-attribute

drop_pg: NotRequired[float]

Drops per game

drop_r instance-attribute

drop_r: NotRequired[float]

Drop rate (0-1)

epa instance-attribute

epa: NotRequired[float]

Expected Points Added

epa_db instance-attribute

epa_db: NotRequired[float]

EPA per dropback

epa_pg instance-attribute

epa_pg: NotRequired[float]

EPA per game

fapi_game_id instance-attribute

fapi_game_id: NotRequired[str]

Football API game identifier

final_score instance-attribute

final_score: NotRequired[str]

Final score of the game

game_id instance-attribute

game_id: NotRequired[int]

Game identifier (10-digit format YYYYMMDDNN)

game_result instance-attribute

game_result: NotRequired[GameResultEnum]

Game result (Win/Loss/Tie)

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image (contains formatInstructions placeholder)

int_pg instance-attribute

int_pg: NotRequired[float]

Interceptions per game

is_home instance-attribute

is_home: NotRequired[bool]

Whether player's team was at home

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

ngs_position instance-attribute

ngs_position: NotRequired[str]

Next Gen Stats position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[str]

Next Gen Stats position group

opponent_team_id instance-attribute

opponent_team_id: NotRequired[str]

Opponent team identifier

pa_db_pct instance-attribute

pa_db_pct: NotRequired[float]

Play action dropback percentage (0-1)

position_group instance-attribute

position_group: NotRequired[str]

Position group

qbp instance-attribute

qbp: NotRequired[int]

Times under QB pressure

qbp_pg instance-attribute

qbp_pg: NotRequired[float]

QB pressure per game

qbp_r instance-attribute

qbp_r: NotRequired[float]

QB pressure rate (0-1)

qp instance-attribute

qp: NotRequired[bool]

Qualified passer status

rating instance-attribute

rating: NotRequired[float]

Passer rating

sack instance-attribute

sack: NotRequired[int]

Times sacked

sack_pg instance-attribute

sack_pg: NotRequired[float]

Sacks per game

short_name instance-attribute

short_name: NotRequired[str]

Abbreviated player name

td_pg instance-attribute

td_pg: NotRequired[float]

Touchdowns per game

tg instance-attribute

tg: NotRequired[int]

Team games for player

total_tg instance-attribute

total_tg: NotRequired[int]

Total team games in period

tw_att_pg instance-attribute

tw_att_pg: NotRequired[float]

Two-minute attempts per game

tw_att_pct instance-attribute

tw_att_pct: NotRequired[float]

Two-minute drill attempt percentage (0-1)

week_slug instance-attribute

week_slug: NotRequired[str]

Week identifier slug

x_cmp instance-attribute

x_cmp: NotRequired[float]

Expected completion percentage (0-1)

x_yac instance-attribute

x_yac: NotRequired[float]

Expected yards after catch

yac instance-attribute

yac: NotRequired[float]

Yards after catch

yac_pct instance-attribute

yac_pct: NotRequired[float]

YAC percentage of total yards (0-1)

yds_pg instance-attribute

yds_pg: NotRequired[float]

Yards per game

ypa instance-attribute

ypa: NotRequired[float]

Yards per attempt

WeeklyPlayerRushingStats

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.WeeklyPlayerRushingStats[WeeklyPlayerRushingStats]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.WeeklyPlayerRushingStats
                


              click griddy.nfl.models.WeeklyPlayerRushingStats href "" "griddy.nfl.models.WeeklyPlayerRushingStats"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

att instance-attribute

att: int

Rushing attempts

display_name instance-attribute

display_name: Annotated[str, Field(alias='displayName')]

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: Annotated[str, Field(alias='nflId')]

NFL player identifier

position instance-attribute

position: OffensivePlayerPositionEnum

Offensive player position

td instance-attribute

td: int

Rushing touchdowns

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Team identifier

yds instance-attribute

yds: int

Rushing yards

ypc instance-attribute

ypc: float

Yards per carry

att_pg class-attribute instance-attribute

att_pg: Annotated[Optional[float], Field(alias="attPG")] = (
    None
)

Attempts per game

eff class-attribute instance-attribute

eff: Optional[float] = None

Efficiency rating

epa class-attribute instance-attribute

epa: Optional[float] = None

Expected Points Added

epa_att class-attribute instance-attribute

epa_att: Annotated[
    Optional[float], Field(alias="epaAtt")
] = None

EPA per attempt

epa_pg class-attribute instance-attribute

epa_pg: Annotated[Optional[float], Field(alias="epaPG")] = (
    None
)

EPA per game

fapi_game_id class-attribute instance-attribute

fapi_game_id: Annotated[
    Optional[str], Field(alias="fapiGameId")
] = None

Football API game identifier

final_score class-attribute instance-attribute

final_score: Annotated[
    Optional[str], Field(alias="finalScore")
] = None

Final score of the game

fum class-attribute instance-attribute

fum: Optional[int] = None

Fumbles

fum_pg class-attribute instance-attribute

fum_pg: Annotated[Optional[float], Field(alias="fumPG")] = (
    None
)

Fumbles per game

game_id class-attribute instance-attribute

game_id: Annotated[Optional[int], Field(alias="gameId")] = (
    None
)

Game identifier (10-digit format YYYYMMDDNN)

game_result class-attribute instance-attribute

game_result: Annotated[
    Optional[GameResultEnum], Field(alias="gameResult")
] = None

Game result (Win/Loss/Tie)

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image (contains formatInstructions placeholder)

in_t_pct class-attribute instance-attribute

in_t_pct: Annotated[
    Optional[float], Field(alias="inTPct")
] = None

Inside tackles percentage (0-1)

is_home class-attribute instance-attribute

is_home: Annotated[
    Optional[bool], Field(alias="isHome")
] = None

Whether player's team was at home

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

lost class-attribute instance-attribute

lost: Optional[int] = None

Fumbles lost

lost_pg class-attribute instance-attribute

lost_pg: Annotated[
    Optional[float], Field(alias="lostPG")
] = None

Fumbles lost per game

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    Optional[OffensivePlayerPositionEnum],
    Field(alias="ngsPosition"),
] = None

Offensive player position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    Optional[OffensivePlayerPositionEnum],
    Field(alias="ngsPositionGroup"),
] = None

Offensive player position

opponent_team_id class-attribute instance-attribute

opponent_team_id: Annotated[
    Optional[str], Field(alias="opponentTeamId")
] = None

Opponent team identifier

position_group class-attribute instance-attribute

position_group: Annotated[
    Optional[OffensivePlayerPositionEnum],
    Field(alias="positionGroup"),
] = None

Offensive player position

qr class-attribute instance-attribute

qr: Optional[bool] = None

Qualified rusher status

rush10_p_yds class-attribute instance-attribute

rush10_p_yds: Annotated[
    Optional[int], Field(alias="rush10PYds")
] = None

Rushes of 10+ yards

rush10_p_yds_pg class-attribute instance-attribute

rush10_p_yds_pg: Annotated[
    Optional[float], Field(alias="rush10PYdsPG")
] = None

10+ yard rushes per game

rush15_p_mph class-attribute instance-attribute

rush15_p_mph: Annotated[
    Optional[int], Field(alias="rush15PMph")
] = None

Rushes of 15+ mph

rush15_p_mph_pg class-attribute instance-attribute

rush15_p_mph_pg: Annotated[
    Optional[float], Field(alias="rush15PMphPG")
] = None

15+ mph rushes per game

rush20_p_mph class-attribute instance-attribute

rush20_p_mph: Annotated[
    Optional[int], Field(alias="rush20PMph")
] = None

Rushes of 20+ mph

rush20_p_mph_pg class-attribute instance-attribute

rush20_p_mph_pg: Annotated[
    Optional[float], Field(alias="rush20PMphPG")
] = None

20+ mph rushes per game

ryoe class-attribute instance-attribute

ryoe: Optional[float] = None

Rush Yards Over Expected

ryoe_att class-attribute instance-attribute

ryoe_att: Annotated[
    Optional[float], Field(alias="ryoeAtt")
] = None

RYOE per attempt

ryoe_pg class-attribute instance-attribute

ryoe_pg: Annotated[
    Optional[float], Field(alias="ryoePG")
] = None

RYOE per game

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias="shortName")
] = None

Abbreviated player name

st_box_pct class-attribute instance-attribute

st_box_pct: Annotated[
    Optional[float], Field(alias="stBoxPct")
] = None

Stacked box percentage (0-1)

success class-attribute instance-attribute

success: Optional[float] = None

Success rate (0-1)

td_pg class-attribute instance-attribute

td_pg: Annotated[Optional[float], Field(alias="tdPG")] = (
    None
)

Touchdowns per game

tg class-attribute instance-attribute

tg: Optional[int] = None

Team games for player

total_tg class-attribute instance-attribute

total_tg: Annotated[
    Optional[int], Field(alias="totalTg")
] = None

Total team games in period

under_pct class-attribute instance-attribute

under_pct: Annotated[
    Optional[float], Field(alias="underPct")
] = None

Under center percentage (0-1)

week_slug class-attribute instance-attribute

week_slug: Annotated[
    Optional[str], Field(alias="weekSlug")
] = None

Week identifier slug

x_ry class-attribute instance-attribute

x_ry: Annotated[Optional[float], Field(alias='xRy')] = None

Expected rushing yards

x_ry_pg class-attribute instance-attribute

x_ry_pg: Annotated[
    Optional[float], Field(alias="xRyPG")
] = None

Expected rushing yards per game

x_ypc class-attribute instance-attribute

x_ypc: Annotated[Optional[float], Field(alias="xYpc")] = (
    None
)

Expected yards per carry

yaco class-attribute instance-attribute

yaco: Optional[float] = None

Yards after contact

yaco_att class-attribute instance-attribute

yaco_att: Annotated[
    Optional[float], Field(alias="yacoAtt")
] = None

Yards after contact per attempt

yaco_pg class-attribute instance-attribute

yaco_pg: Annotated[
    Optional[float], Field(alias="yacoPG")
] = None

Yards after contact per game

ybco class-attribute instance-attribute

ybco: Optional[float] = None

Yards before contact

ybco_pg class-attribute instance-attribute

ybco_pg: Annotated[
    Optional[float], Field(alias="ybcoPG")
] = None

Yards before contact per game

yds_pg class-attribute instance-attribute

yds_pg: Annotated[Optional[float], Field(alias="ydsPG")] = (
    None
)

Yards per game

WeeklyPlayerRushingStatsTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.WeeklyPlayerRushingStatsTypedDict[WeeklyPlayerRushingStatsTypedDict]

              

              click griddy.nfl.models.WeeklyPlayerRushingStatsTypedDict href "" "griddy.nfl.models.WeeklyPlayerRushingStatsTypedDict"
            

Attributes

att instance-attribute

att: int

Rushing attempts

display_name instance-attribute

display_name: str

Player's full name

gp instance-attribute

gp: int

Games played

gs instance-attribute

gs: int

Games started

nfl_id instance-attribute

nfl_id: str

NFL player identifier

position instance-attribute

position: OffensivePlayerPositionEnum

Offensive player position

td instance-attribute

td: int

Rushing touchdowns

team_id instance-attribute

team_id: str

Team identifier

yds instance-attribute

yds: int

Rushing yards

ypc instance-attribute

ypc: float

Yards per carry

att_pg instance-attribute

att_pg: NotRequired[float]

Attempts per game

eff instance-attribute

eff: NotRequired[float]

Efficiency rating

epa instance-attribute

epa: NotRequired[float]

Expected Points Added

epa_att instance-attribute

epa_att: NotRequired[float]

EPA per attempt

epa_pg instance-attribute

epa_pg: NotRequired[float]

EPA per game

fapi_game_id instance-attribute

fapi_game_id: NotRequired[str]

Football API game identifier

final_score instance-attribute

final_score: NotRequired[str]

Final score of the game

fum instance-attribute

fum: NotRequired[int]

Fumbles

fum_pg instance-attribute

fum_pg: NotRequired[float]

Fumbles per game

game_id instance-attribute

game_id: NotRequired[int]

Game identifier (10-digit format YYYYMMDDNN)

game_result instance-attribute

game_result: NotRequired[GameResultEnum]

Game result (Win/Loss/Tie)

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image (contains formatInstructions placeholder)

in_t_pct instance-attribute

in_t_pct: NotRequired[float]

Inside tackles percentage (0-1)

is_home instance-attribute

is_home: NotRequired[bool]

Whether player's team was at home

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

lost instance-attribute

lost: NotRequired[int]

Fumbles lost

lost_pg instance-attribute

lost_pg: NotRequired[float]

Fumbles lost per game

ngs_position instance-attribute

ngs_position: NotRequired[OffensivePlayerPositionEnum]

Offensive player position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[OffensivePlayerPositionEnum]

Offensive player position

opponent_team_id instance-attribute

opponent_team_id: NotRequired[str]

Opponent team identifier

position_group instance-attribute

position_group: NotRequired[OffensivePlayerPositionEnum]

Offensive player position

qr instance-attribute

qr: NotRequired[bool]

Qualified rusher status

rush10_p_yds instance-attribute

rush10_p_yds: NotRequired[int]

Rushes of 10+ yards

rush10_p_yds_pg instance-attribute

rush10_p_yds_pg: NotRequired[float]

10+ yard rushes per game

rush15_p_mph instance-attribute

rush15_p_mph: NotRequired[int]

Rushes of 15+ mph

rush15_p_mph_pg instance-attribute

rush15_p_mph_pg: NotRequired[float]

15+ mph rushes per game

rush20_p_mph instance-attribute

rush20_p_mph: NotRequired[int]

Rushes of 20+ mph

rush20_p_mph_pg instance-attribute

rush20_p_mph_pg: NotRequired[float]

20+ mph rushes per game

ryoe instance-attribute

ryoe: NotRequired[float]

Rush Yards Over Expected

ryoe_att instance-attribute

ryoe_att: NotRequired[float]

RYOE per attempt

ryoe_pg instance-attribute

ryoe_pg: NotRequired[float]

RYOE per game

short_name instance-attribute

short_name: NotRequired[str]

Abbreviated player name

st_box_pct instance-attribute

st_box_pct: NotRequired[float]

Stacked box percentage (0-1)

success instance-attribute

success: NotRequired[float]

Success rate (0-1)

td_pg instance-attribute

td_pg: NotRequired[float]

Touchdowns per game

tg instance-attribute

tg: NotRequired[int]

Team games for player

total_tg instance-attribute

total_tg: NotRequired[int]

Total team games in period

under_pct instance-attribute

under_pct: NotRequired[float]

Under center percentage (0-1)

week_slug instance-attribute

week_slug: NotRequired[str]

Week identifier slug

x_ry instance-attribute

x_ry: NotRequired[float]

Expected rushing yards

x_ry_pg instance-attribute

x_ry_pg: NotRequired[float]

Expected rushing yards per game

x_ypc instance-attribute

x_ypc: NotRequired[float]

Expected yards per carry

yaco instance-attribute

yaco: NotRequired[float]

Yards after contact

yaco_att instance-attribute

yaco_att: NotRequired[float]

Yards after contact per attempt

yaco_pg instance-attribute

yaco_pg: NotRequired[float]

Yards after contact per game

ybco instance-attribute

ybco: NotRequired[float]

Yards before contact

ybco_pg instance-attribute

ybco_pg: NotRequired[float]

Yards before contact per game

yds_pg instance-attribute

yds_pg: NotRequired[float]

Yards per game

Functions