Skip to content

Weekly Game Detail

griddy / nfl / models / entities / weekly_game_detail**

weekly_game_detail

Attributes

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

Classes

DriveChartTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.entities.weekly_game_detail.DriveChartTypedDict[DriveChartTypedDict]

              

              click griddy.nfl.models.entities.weekly_game_detail.DriveChartTypedDict href "" "griddy.nfl.models.entities.weekly_game_detail.DriveChartTypedDict"
            

Drive-by-drive data

DriveChart

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.entities.weekly_game_detail.DriveChart[DriveChart]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.weekly_game_detail.DriveChart
                


              click griddy.nfl.models.entities.weekly_game_detail.DriveChart href "" "griddy.nfl.models.entities.weekly_game_detail.DriveChart"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Drive-by-drive data

SummaryTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.entities.weekly_game_detail.SummaryTypedDict[SummaryTypedDict]

              

              click griddy.nfl.models.entities.weekly_game_detail.SummaryTypedDict href "" "griddy.nfl.models.entities.weekly_game_detail.SummaryTypedDict"
            

Game summary information

Summary

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.entities.weekly_game_detail.Summary[Summary]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.weekly_game_detail.Summary
                


              click griddy.nfl.models.entities.weekly_game_detail.Summary href "" "griddy.nfl.models.entities.weekly_game_detail.Summary"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Game summary information

TaggedVideosTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.entities.weekly_game_detail.TaggedVideosTypedDict[TaggedVideosTypedDict]

              

              click griddy.nfl.models.entities.weekly_game_detail.TaggedVideosTypedDict href "" "griddy.nfl.models.entities.weekly_game_detail.TaggedVideosTypedDict"
            

Tagged video content

TaggedVideos

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.entities.weekly_game_detail.TaggedVideos[TaggedVideos]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.weekly_game_detail.TaggedVideos
                


              click griddy.nfl.models.entities.weekly_game_detail.TaggedVideos href "" "griddy.nfl.models.entities.weekly_game_detail.TaggedVideos"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Tagged video content

WeeklyGameDetailTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.entities.weekly_game_detail.WeeklyGameDetailTypedDict[WeeklyGameDetailTypedDict]

              

              click griddy.nfl.models.entities.weekly_game_detail.WeeklyGameDetailTypedDict href "" "griddy.nfl.models.entities.weekly_game_detail.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

WeeklyGameDetail

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.entities.weekly_game_detail.WeeklyGameDetail[WeeklyGameDetail]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.weekly_game_detail.WeeklyGameDetail
                


              click griddy.nfl.models.entities.weekly_game_detail.WeeklyGameDetail href "" "griddy.nfl.models.entities.weekly_game_detail.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