Skip to content

Get Player Rushing Stats By Week Op

griddy / nfl / models / requests / get_player_rushing_stats_by_week_op**

get_player_rushing_stats_by_week_op

Attributes

GetPlayerRushingStatsByWeekSortKey module-attribute

GetPlayerRushingStatsByWeekSortKey = Literal[
    "att",
    "yds",
    "td",
    "ypc",
    "epa",
    "epaAtt",
    "xRy",
    "xYpc",
    "ryoe",
    "ryoeAtt",
    "yaco",
    "yacoAtt",
    "ybco",
    "success",
    "fum",
    "lost",
    "rush10PYds",
    "rush15PMph",
    "rush20PMph",
    "eff",
    "inTPct",
    "stBoxPct",
    "underPct",
]

Field to sort by

Classes

GetPlayerRushingStatsByWeekRequestTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_player_rushing_stats_by_week_op.GetPlayerRushingStatsByWeekRequestTypedDict[GetPlayerRushingStatsByWeekRequestTypedDict]

              

              click griddy.nfl.models.requests.get_player_rushing_stats_by_week_op.GetPlayerRushingStatsByWeekRequestTypedDict href "" "griddy.nfl.models.requests.get_player_rushing_stats_by_week_op.GetPlayerRushingStatsByWeekRequestTypedDict"
            
Attributes
season instance-attribute
season: int

Season year

season_type instance-attribute
season_type: SeasonTypeEnum

Type of season

week instance-attribute

Week identifier

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[GetPlayerRushingStatsByWeekSortKey]

Field to sort by

sort_value instance-attribute
sort_value: NotRequired[SortOrderEnum]

Sort direction

qualified_rusher instance-attribute
qualified_rusher: NotRequired[bool]

Filter to only qualified rushers (minimum attempts threshold)

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

Filter by specific team IDs (supports multiple teams)

GetPlayerRushingStatsByWeekRequest

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_player_rushing_stats_by_week_op.GetPlayerRushingStatsByWeekRequest[GetPlayerRushingStatsByWeekRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_player_rushing_stats_by_week_op.GetPlayerRushingStatsByWeekRequest
                


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

week instance-attribute
week: Annotated[
    WeekSlugEnum,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week identifier

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

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[GetPlayerRushingStatsByWeekSortKey],
    Field(alias="sortKey"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = "yds"

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_rusher class-attribute instance-attribute
qualified_rusher: Annotated[
    Optional[bool],
    Field(alias="qualifiedRusher"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Filter to only qualified rushers (minimum attempts threshold)

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

Filter by specific team IDs (supports multiple teams)