Get Film Room Plays Op¶

griddy / nfl / models / requests / get_film_room_plays_op**

get_film_room_plays_op ¶

Attributes¶

Classes¶

GetFilmroomPlaysRequestTypedDict ¶

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_film_room_plays_op.GetFilmroomPlaysRequestTypedDict[GetFilmroomPlaysRequestTypedDict]

              

              click griddy.nfl.models.requests.get_film_room_plays_op.GetFilmroomPlaysRequestTypedDict href "" "griddy.nfl.models.requests.get_film_room_plays_op.GetFilmroomPlaysRequestTypedDict"

Attributes¶

game_id `instance-attribute` ¶

game_id: NotRequired[List[str]]

Filter by specific game IDs (supports multiple values)

week_slug `instance-attribute` ¶

week_slug: NotRequired[List[WeekSlugEnum]]

Filter by week identifier (supports multiple values)

season `instance-attribute` ¶

season: NotRequired[List[int]]

Filter by season year (supports multiple values)

season_type `instance-attribute` ¶

season_type: NotRequired[List[SeasonTypeEnum]]

Filter by season type

nfl_id `instance-attribute` ¶

nfl_id: NotRequired[List[str]]

Filter by player NFL ID

quarter `instance-attribute` ¶

quarter: NotRequired[List[int]]

Filter by quarter

down `instance-attribute` ¶

down: NotRequired[List[int]]

Filter by down

yards_to_go_type `instance-attribute` ¶

yards_to_go_type: NotRequired[List[YardsToGoType]]

Filter by yards to go category

touchdown `instance-attribute` ¶

touchdown: NotRequired[List[BinaryFlagEnum]]

Filter for touchdown plays (1 = yes, 0 = no)

rush10_plus_yards `instance-attribute` ¶

rush10_plus_yards: NotRequired[List[BinaryFlagEnum]]

Filter for rushing plays of 10+ yards

fumble_lost `instance-attribute` ¶

fumble_lost: NotRequired[List[BinaryFlagEnum]]

Filter for plays with fumbles lost

fumble `instance-attribute` ¶

fumble: NotRequired[List[BinaryFlagEnum]]

Filter for plays with fumbles

qb_alignment `instance-attribute` ¶

qb_alignment: NotRequired[List[QbAlignment]]

Filter by quarterback alignment

redzone `instance-attribute` ¶

redzone: NotRequired[List[BinaryFlagEnum]]

Filter for red zone plays

goal_to_go `instance-attribute` ¶

goal_to_go: NotRequired[List[BinaryFlagEnum]]

Filter for goal-to-go situations

pass_play `instance-attribute` ¶

pass_play: NotRequired[List[BinaryFlagEnum]]

Filter for passing plays

run_play `instance-attribute` ¶

run_play: NotRequired[List[BinaryFlagEnum]]

Filter for running plays

play_type `instance-attribute` ¶

play_type: NotRequired[List[PlayTypeEnum]]

Filter by specific play types

attempt `instance-attribute` ¶

attempt: NotRequired[List[BinaryFlagEnum]]

Filter for passing attempts

completion `instance-attribute` ¶

completion: NotRequired[List[BinaryFlagEnum]]

Filter for completed passes

interception `instance-attribute` ¶

interception: NotRequired[List[BinaryFlagEnum]]

Filter for interceptions

reception `instance-attribute` ¶

reception: NotRequired[List[BinaryFlagEnum]]

Filter for receptions

sack `instance-attribute` ¶

sack: NotRequired[List[BinaryFlagEnum]]

Filter for sacks

rec_motion `instance-attribute` ¶

rec_motion: NotRequired[List[BinaryFlagEnum]]

Filter by receiver motion

target_location `instance-attribute` ¶

target_location: NotRequired[List[TargetLocation]]

Filter by target location on field

air_yard_type `instance-attribute` ¶

air_yard_type: NotRequired[List[AirYardType]]

Filter by air yards category

dropback_time_type `instance-attribute` ¶

dropback_time_type: NotRequired[List[DropbackTimeType]]

Filter by dropback time

pressure `instance-attribute` ¶

pressure: NotRequired[List[BinaryFlagEnum]]

Filter by quarterback pressure

blitz `instance-attribute` ¶

blitz: NotRequired[List[BinaryFlagEnum]]

Filter by defensive blitz

play_action `instance-attribute` ¶

play_action: NotRequired[List[BinaryFlagEnum]]

Filter by play action usage

rush_direction `instance-attribute` ¶

rush_direction: NotRequired[List[RushDirection]]

Filter by rush direction

run_stuff `instance-attribute` ¶

run_stuff: NotRequired[List[BinaryFlagEnum]]

Filter for stuffed runs

receiver_alignment `instance-attribute` ¶

receiver_alignment: NotRequired[List[ReceiverAlignment]]

Filter by receiver alignment

separation_type `instance-attribute` ¶

separation_type: NotRequired[List[SeparationType]]

Filter by receiver separation

personnel `instance-attribute` ¶

personnel: NotRequired[List[Personnel]]

Filter by defensive personnel package

defenders_in_the_box_type `instance-attribute` ¶

defenders_in_the_box_type: NotRequired[
    List[DefendersInTheBoxType]
]

Filter by defenders in the box

def_coverage_type `instance-attribute` ¶

def_coverage_type: NotRequired[List[DefCoverageType]]

Filter by defensive coverage type

GetFilmroomPlaysRequest ¶

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_film_room_plays_op.GetFilmroomPlaysRequest[GetFilmroomPlaysRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_film_room_plays_op.GetFilmroomPlaysRequest
                


              click griddy.nfl.models.requests.get_film_room_plays_op.GetFilmroomPlaysRequest href "" "griddy.nfl.models.requests.get_film_room_plays_op.GetFilmroomPlaysRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"

Attributes¶

game_id `class-attribute` `instance-attribute` ¶

game_id: Annotated[
    Optional[List[str]],
    Field(alias="gameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific game IDs (supports multiple values)

week_slug `class-attribute` `instance-attribute` ¶

week_slug: Annotated[
    Optional[List[WeekSlugEnum]],
    Field(alias="weekSlug"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by week identifier (supports multiple values)

season `class-attribute` `instance-attribute` ¶

season: Annotated[
    Optional[List[int]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by season year (supports multiple values)

season_type `class-attribute` `instance-attribute` ¶

season_type: Annotated[
    Optional[List[SeasonTypeEnum]],
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by season type

nfl_id `class-attribute` `instance-attribute` ¶

nfl_id: Annotated[
    Optional[List[str]],
    Field(alias="nflId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by player NFL ID

quarter `class-attribute` `instance-attribute` ¶

quarter: Annotated[
    Optional[List[int]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by quarter

down `class-attribute` `instance-attribute` ¶

down: Annotated[
    Optional[List[int]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by down

yards_to_go_type `class-attribute` `instance-attribute` ¶

yards_to_go_type: Annotated[
    Optional[List[YardsToGoType]],
    Field(alias="yardsToGoType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by yards to go category

touchdown `class-attribute` `instance-attribute` ¶

touchdown: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for touchdown plays (1 = yes, 0 = no)

rush10_plus_yards `class-attribute` `instance-attribute` ¶

rush10_plus_yards: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="rush10PlusYards"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for rushing plays of 10+ yards

fumble_lost `class-attribute` `instance-attribute` ¶

fumble_lost: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="fumbleLost"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for plays with fumbles lost

fumble `class-attribute` `instance-attribute` ¶

fumble: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for plays with fumbles

qb_alignment `class-attribute` `instance-attribute` ¶

qb_alignment: Annotated[
    Optional[List[QbAlignment]],
    Field(alias="qbAlignment"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by quarterback alignment

redzone `class-attribute` `instance-attribute` ¶

redzone: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for red zone plays

goal_to_go `class-attribute` `instance-attribute` ¶

goal_to_go: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="goalToGo"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for goal-to-go situations

pass_play `class-attribute` `instance-attribute` ¶

pass_play: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="passPlay"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for passing plays

run_play `class-attribute` `instance-attribute` ¶

run_play: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="runPlay"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for running plays

play_type `class-attribute` `instance-attribute` ¶

play_type: Annotated[
    Optional[List[PlayTypeEnum]],
    Field(alias="playType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by specific play types

attempt `class-attribute` `instance-attribute` ¶

attempt: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for passing attempts

completion `class-attribute` `instance-attribute` ¶

completion: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for completed passes

interception `class-attribute` `instance-attribute` ¶

interception: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for interceptions

reception `class-attribute` `instance-attribute` ¶

reception: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for receptions

sack `class-attribute` `instance-attribute` ¶

sack: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for sacks

rec_motion `class-attribute` `instance-attribute` ¶

rec_motion: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by receiver motion

target_location `class-attribute` `instance-attribute` ¶

target_location: Annotated[
    Optional[List[TargetLocation]],
    Field(alias="targetLocation"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by target location on field

air_yard_type `class-attribute` `instance-attribute` ¶

air_yard_type: Annotated[
    Optional[List[AirYardType]],
    Field(alias="airYardType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by air yards category

dropback_time_type `class-attribute` `instance-attribute` ¶

dropback_time_type: Annotated[
    Optional[List[DropbackTimeType]],
    Field(alias="dropbackTimeType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by dropback time

pressure `class-attribute` `instance-attribute` ¶

pressure: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by quarterback pressure

blitz `class-attribute` `instance-attribute` ¶

blitz: Annotated[
    Optional[List[BinaryFlagEnum]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by defensive blitz

play_action `class-attribute` `instance-attribute` ¶

play_action: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="playAction"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by play action usage

rush_direction `class-attribute` `instance-attribute` ¶

rush_direction: Annotated[
    Optional[List[RushDirection]],
    Field(alias="rushDirection"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by rush direction

run_stuff `class-attribute` `instance-attribute` ¶

run_stuff: Annotated[
    Optional[List[BinaryFlagEnum]],
    Field(alias="runStuff"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter for stuffed runs

receiver_alignment `class-attribute` `instance-attribute` ¶

receiver_alignment: Annotated[
    Optional[List[ReceiverAlignment]],
    Field(alias="receiverAlignment"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by receiver alignment

separation_type `class-attribute` `instance-attribute` ¶

separation_type: Annotated[
    Optional[List[SeparationType]],
    Field(alias="separationType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by receiver separation

personnel `class-attribute` `instance-attribute` ¶

personnel: Annotated[
    Optional[List[Personnel]],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by defensive personnel package

defenders_in_the_box_type `class-attribute` `instance-attribute` ¶

defenders_in_the_box_type: Annotated[
    Optional[List[DefendersInTheBoxType]],
    Field(alias="defendersInTheBoxType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by defenders in the box

def_coverage_type `class-attribute` `instance-attribute` ¶

def_coverage_type: Annotated[
    Optional[List[DefCoverageType]],
    Field(alias="def_coverageType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by defensive coverage type

Get Film Room Plays Op¶