Skip to content

Win Probability Response

griddy / nfl / models / responses / win_probability_response**

win_probability_response

Classes

WinProbabilityResponseTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.responses.win_probability_response.WinProbabilityResponseTypedDict[WinProbabilityResponseTypedDict]

              

              click griddy.nfl.models.responses.win_probability_response.WinProbabilityResponseTypedDict href "" "griddy.nfl.models.responses.win_probability_response.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

WinProbabilityResponse

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.responses.win_probability_response.WinProbabilityResponse[WinProbabilityResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.responses.win_probability_response.WinProbabilityResponse
                


              click griddy.nfl.models.responses.win_probability_response.WinProbabilityResponse href "" "griddy.nfl.models.responses.win_probability_response.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