Skip to content

Get Defensive Stats By Season Op

griddy / nfl / models / requests / get_defensive_stats_by_season_op**

get_defensive_stats_by_season_op

Attributes

GetDefensiveStatsBySeasonSortKey module-attribute

GetDefensiveStatsBySeasonSortKey = Literal[
    "cov",
    "covNd",
    "tgtNd",
    "recNd",
    "recYdsNd",
    "recTdNd",
    "int",
    "passRatingNd",
    "tgtEpaNd",
    "catchNd",
    "croeNd",
    "bhPct",
    "sep",
    "twfPct",
    "yacprNd",
    "tgtRNd",
]

Field to sort by

Classes

GetDefensiveStatsBySeasonRequestTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_defensive_stats_by_season_op.GetDefensiveStatsBySeasonRequestTypedDict[GetDefensiveStatsBySeasonRequestTypedDict]

              

              click griddy.nfl.models.requests.get_defensive_stats_by_season_op.GetDefensiveStatsBySeasonRequestTypedDict href "" "griddy.nfl.models.requests.get_defensive_stats_by_season_op.GetDefensiveStatsBySeasonRequestTypedDict"
            
Attributes
season instance-attribute
season: int

Season year

season_type instance-attribute
season_type: SeasonTypeEnum

Type of season

limit instance-attribute
limit: NotRequired[int]

Maximum number of players to return

offset instance-attribute
offset: NotRequired[int]

Number of records to skip for pagination

page instance-attribute
page: NotRequired[int]

Page number for pagination

sort_key instance-attribute
sort_key: NotRequired[GetDefensiveStatsBySeasonSortKey]

Field to sort by

sort_value instance-attribute
sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_defender instance-attribute
qualified_defender: NotRequired[bool]

Filter to only qualified defenders (minimum snap threshold)

team_defense instance-attribute
team_defense: NotRequired[List[str]]

Filter by specific team IDs (supports multiple teams)

GetDefensiveStatsBySeasonRequest

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_defensive_stats_by_season_op.GetDefensiveStatsBySeasonRequest[GetDefensiveStatsBySeasonRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_defensive_stats_by_season_op.GetDefensiveStatsBySeasonRequest
                


              click griddy.nfl.models.requests.get_defensive_stats_by_season_op.GetDefensiveStatsBySeasonRequest href "" "griddy.nfl.models.requests.get_defensive_stats_by_season_op.GetDefensiveStatsBySeasonRequest"
              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

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

Maximum number of players to return

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

Number of records to skip for pagination

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

Page number for pagination

sort_key class-attribute instance-attribute
sort_key: Annotated[
    Optional[GetDefensiveStatsBySeasonSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "cov"

Field to sort by

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

Sort direction

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

Filter to only qualified defenders (minimum snap threshold)

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

Filter by specific team IDs (supports multiple teams)