Play Detail

griddy / nfl / models / entities / play_detail**

play_detail

Attributes

PlayDirection module-attribute

PlayDirection = Literal['left', 'right', 'middle']

Direction of play

PlayState module-attribute

PlayState = Literal['APPROVED', 'PENDING', 'REVIEWED']

Review state of play

Classes

PlayDetailTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.entities.play_detail.PlayDetailTypedDict[PlayDetailTypedDict]

              

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

PlayDetail

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.entities.play_detail.PlayDetail[PlayDetail]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.play_detail.PlayDetail
                


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