Play Win Probability

griddy / nfl / models / entities / play_win_probability**

play_win_probability

Classes

PlayWinProbabilityTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.entities.play_win_probability.PlayWinProbabilityTypedDict[PlayWinProbabilityTypedDict]

              

              click griddy.nfl.models.entities.play_win_probability.PlayWinProbabilityTypedDict href "" "griddy.nfl.models.entities.play_win_probability.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)

PlayWinProbability

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.entities.play_win_probability.PlayWinProbability[PlayWinProbability]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.play_win_probability.PlayWinProbability
                


              click griddy.nfl.models.entities.play_win_probability.PlayWinProbability href "" "griddy.nfl.models.entities.play_win_probability.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)