Skip to content

Get Season Player Stats Op

griddy / nfl / models / requests / get_season_player_stats_op**

get_season_player_stats_op

Attributes

GetSeasonPlayerStatsPosition module-attribute 

GetSeasonPlayerStatsPosition = Literal[
    "QB",
    "RB",
    "WR",
    "TE",
    "OL",
    "DL",
    "LB",
    "DB",
    "K",
    "P",
    "LS",
]

Filter by position group

StatCategory module-attribute 

StatCategory = Literal[
    "passing",
    "rushing",
    "receiving",
    "defense",
    "kicking",
    "punting",
    "returning",
]

Statistical category to retrieve

Classes

GetSeasonPlayerStatsRequestTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_season_player_stats_op.GetSeasonPlayerStatsRequestTypedDict[GetSeasonPlayerStatsRequestTypedDict]

              

              click griddy.nfl.models.requests.get_season_player_stats_op.GetSeasonPlayerStatsRequestTypedDict href "" "griddy.nfl.models.requests.get_season_player_stats_op.GetSeasonPlayerStatsRequestTypedDict"
Attributes
season instance-attribute 
season: int

Season year

season_type instance-attribute 
season_type: SeasonTypeEnum

Type of season

position instance-attribute 
position: NotRequired[GetSeasonPlayerStatsPosition]

Filter by position group

team_id instance-attribute 
team_id: NotRequired[str]

Filter by team

stat_category instance-attribute 
stat_category: NotRequired[StatCategory]

Statistical category to retrieve

sort instance-attribute 
sort: NotRequired[str]

Sort field and order

limit instance-attribute 
limit: NotRequired[int]

Maximum number of results

offset instance-attribute 
offset: NotRequired[int]

Offset for pagination

GetSeasonPlayerStatsRequest

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_season_player_stats_op.GetSeasonPlayerStatsRequest[GetSeasonPlayerStatsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_season_player_stats_op.GetSeasonPlayerStatsRequest
                


              click griddy.nfl.models.requests.get_season_player_stats_op.GetSeasonPlayerStatsRequest href "" "griddy.nfl.models.requests.get_season_player_stats_op.GetSeasonPlayerStatsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
Attributes
season instance-attribute 
season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

season_type instance-attribute 
season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Type of season

position class-attribute instance-attribute 
position: Annotated[
    Optional[GetSeasonPlayerStatsPosition],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by position group

team_id class-attribute instance-attribute 
team_id: Annotated[
    Optional[str],
    Field(alias="teamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Filter by team

stat_category class-attribute instance-attribute 
stat_category: Annotated[
    Optional[StatCategory],
    Field(alias="statCategory"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Statistical category to retrieve

sort class-attribute instance-attribute 
sort: Annotated[
    Optional[str],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Sort field and order

limit class-attribute instance-attribute 
limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 50

Maximum number of results

offset class-attribute instance-attribute 
offset: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 0

Offset for pagination