Skip to content

Get Play By Play Op

griddy / nfl / models / requests / get_play_by_play_op**

get_play_by_play_op

Classes

GetPlayByPlayRequestTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_play_by_play_op.GetPlayByPlayRequestTypedDict[GetPlayByPlayRequestTypedDict]

              

              click griddy.nfl.models.requests.get_play_by_play_op.GetPlayByPlayRequestTypedDict href "" "griddy.nfl.models.requests.get_play_by_play_op.GetPlayByPlayRequestTypedDict"
Attributes
game_id instance-attribute 
game_id: str

Game identifier (UUID)

include_penalties instance-attribute 
include_penalties: NotRequired[bool]

Include penalty details

include_formations instance-attribute 
include_formations: NotRequired[bool]

Include offensive/defensive formations

GetPlayByPlayRequest

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_play_by_play_op.GetPlayByPlayRequest[GetPlayByPlayRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_play_by_play_op.GetPlayByPlayRequest
                


              click griddy.nfl.models.requests.get_play_by_play_op.GetPlayByPlayRequest href "" "griddy.nfl.models.requests.get_play_by_play_op.GetPlayByPlayRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
Attributes
game_id instance-attribute 
game_id: Annotated[
    str,
    Field(alias="gameId"),
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Game identifier (UUID)

include_penalties class-attribute instance-attribute 
include_penalties: Annotated[
    Optional[bool],
    Field(alias="includePenalties"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = True

Include penalty details

include_formations class-attribute instance-attribute 
include_formations: Annotated[
    Optional[bool],
    Field(alias="includeFormations"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Include offensive/defensive formations