Skip to content

Live Game

griddy / nfl / models / entities / live_game**

live_game

Classes

LiveGameTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.entities.live_game.LiveGameTypedDict[LiveGameTypedDict]

              

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

LiveGame

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.entities.live_game.LiveGame[LiveGame]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.live_game.LiveGame
                


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