Skip to content

Play Summary Response

griddy / nfl / models / responses / play_summary_response**

play_summary_response

Classes

PlaySummaryResponseTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.responses.play_summary_response.PlaySummaryResponseTypedDict[PlaySummaryResponseTypedDict]

              

              click griddy.nfl.models.responses.play_summary_response.PlaySummaryResponseTypedDict href "" "griddy.nfl.models.responses.play_summary_response.PlaySummaryResponseTypedDict"
Attributes
game_id instance-attribute 
game_id: int

Game identifier in integer format

play_id instance-attribute 
play_id: int

Play identifier

away instance-attribute 
away: NotRequired[List[PlayPlayerTypedDict]]

Away team players involved in the play

game_key instance-attribute 
game_key: NotRequired[int]

Unique game key

gsis_play_id instance-attribute 
gsis_play_id: NotRequired[int]

GSIS play identifier

home instance-attribute 
home: NotRequired[List[PlayPlayerTypedDict]]

Home team players involved in the play

home_is_offense instance-attribute 
home_is_offense: NotRequired[bool]

Whether home team has offensive possession

PlaySummaryResponse

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.responses.play_summary_response.PlaySummaryResponse[PlaySummaryResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.responses.play_summary_response.PlaySummaryResponse
                


              click griddy.nfl.models.responses.play_summary_response.PlaySummaryResponse href "" "griddy.nfl.models.responses.play_summary_response.PlaySummaryResponse"
              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 in integer format

play_id instance-attribute 
play_id: Annotated[int, Field(alias='playId')]

Play identifier

away class-attribute instance-attribute 
away: Optional[List[PlayPlayer]] = None

Away team players involved in the play

game_key class-attribute instance-attribute 
game_key: Annotated[
    Optional[int], Field(alias="gameKey")
] = None

Unique game key

gsis_play_id class-attribute instance-attribute 
gsis_play_id: Annotated[
    Optional[int], Field(alias="gsisPlayId")
] = None

GSIS play identifier

home class-attribute instance-attribute 
home: Optional[List[PlayPlayer]] = None

Home team players involved in the play

home_is_offense class-attribute instance-attribute 
home_is_offense: Annotated[
    Optional[bool], Field(alias="homeIsOffense")
] = None

Whether home team has offensive possession