Film Room Play

griddy / nfl / models / entities / film_room_play**

film_room_play

Attributes

Classes

FilmroomPlayTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.entities.film_room_play.FilmroomPlayTypedDict[FilmroomPlayTypedDict]

              

              click griddy.nfl.models.entities.film_room_play.FilmroomPlayTypedDict href "" "griddy.nfl.models.entities.film_room_play.FilmroomPlayTypedDict"
            

Attributes

defense_team_id instance-attribute

defense_team_id: str

Defensive team identifier

down instance-attribute

down: int

Down number

fapi_game_id instance-attribute

fapi_game_id: str

Football API game identifier

game_clock instance-attribute

game_clock: str

Game clock time when play occurred

game_id instance-attribute

game_id: int

Game identifier (10-digit format YYYYMMDDNN)

home_team_abbr instance-attribute

home_team_abbr: str

Home team abbreviation

home_team_id instance-attribute

home_team_id: str

Home team identifier

play_description instance-attribute

play_description: str

Detailed description of the play

play_id instance-attribute

play_id: int

Unique play identifier within the game

play_type instance-attribute

play_type: PlayTypeEnum

Enumeration of all possible play types

possession_team_id instance-attribute

possession_team_id: str

Team with possession of the ball

quarter instance-attribute

quarter: int

Quarter of the play

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

sequence instance-attribute

sequence: int

Play sequence number

visitor_team_abbr instance-attribute

visitor_team_abbr: str

Visiting team abbreviation

visitor_team_id instance-attribute

visitor_team_id: str

Visiting team identifier

week instance-attribute

week: int

Week number

week_slug instance-attribute

week_slug: str

Week identifier slug

yardline instance-attribute

yardline: str

Field position where play occurred

yards_to_go instance-attribute

yards_to_go: int

Yards needed for first down

selected_param_values instance-attribute

selected_param_values: NotRequired[Dict[str, Any]]

Selected parameter values for the play filter

FilmroomPlay

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.entities.film_room_play.FilmroomPlay[FilmroomPlay]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.film_room_play.FilmroomPlay
                


              click griddy.nfl.models.entities.film_room_play.FilmroomPlay href "" "griddy.nfl.models.entities.film_room_play.FilmroomPlay"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

defense_team_id instance-attribute

defense_team_id: Annotated[
    str, Field(alias="defenseTeamId")
]

Defensive team identifier

down instance-attribute

down: int

Down number

fapi_game_id instance-attribute

fapi_game_id: Annotated[str, Field(alias='fapiGameId')]

Football API game identifier

game_clock instance-attribute

game_clock: Annotated[str, Field(alias='gameClock')]

Game clock time when play occurred

game_id instance-attribute

game_id: Annotated[int, Field(alias='gameId')]

Game identifier (10-digit format YYYYMMDDNN)

home_team_abbr instance-attribute

home_team_abbr: Annotated[str, Field(alias='homeTeamAbbr')]

Home team abbreviation

home_team_id instance-attribute

home_team_id: Annotated[str, Field(alias='homeTeamId')]

Home team identifier

play_description instance-attribute

play_description: Annotated[
    str, Field(alias="playDescription")
]

Detailed description of the play

play_id instance-attribute

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

Unique play identifier within the game

play_type instance-attribute

play_type: Annotated[PlayTypeEnum, Field(alias='playType')]

Enumeration of all possible play types

possession_team_id instance-attribute

possession_team_id: Annotated[
    str, Field(alias="possessionTeamId")
]

Team with possession of the ball

quarter instance-attribute

quarter: int

Quarter of the play

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sequence instance-attribute

sequence: int

Play sequence number

visitor_team_abbr instance-attribute

visitor_team_abbr: Annotated[
    str, Field(alias="visitorTeamAbbr")
]

Visiting team abbreviation

visitor_team_id instance-attribute

visitor_team_id: Annotated[
    str, Field(alias="visitorTeamId")
]

Visiting team identifier

week instance-attribute

week: int

Week number

week_slug instance-attribute

week_slug: Annotated[str, Field(alias='weekSlug')]

Week identifier slug

yardline instance-attribute

yardline: str

Field position where play occurred

yards_to_go instance-attribute

yards_to_go: Annotated[int, Field(alias='yardsToGo')]

Yards needed for first down

selected_param_values class-attribute instance-attribute

selected_param_values: Annotated[
    Optional[Dict[str, Any]],
    Field(alias="selectedParamValues"),
] = None

Selected parameter values for the play filter