Get Ngs Leaders Op¶

griddy / nfl / models / requests / get_ngs_leaders_op**

get_ngs_leaders_op ¶

Request models for NGS leaders/top plays endpoints.

Classes¶

GetNgsLeadersRequestTypedDict ¶

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsLeadersRequestTypedDict[GetNgsLeadersRequestTypedDict]

              

              click griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsLeadersRequestTypedDict href "" "griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsLeadersRequestTypedDict"

Request parameters for NGS leaders endpoints with limit/week support.

Attributes¶

season `instance-attribute` ¶

season: int

Season year (e.g., 2025)

season_type `instance-attribute` ¶

season_type: str

Season type (REG, PRE, POST)

limit `instance-attribute` ¶

limit: NotRequired[int]

Number of results to return (default: 20)

week `instance-attribute` ¶

week: NotRequired[int]

Optional week filter

GetNgsLeadersRequest ¶

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsLeadersRequest[GetNgsLeadersRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsLeadersRequest
                


              click griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsLeadersRequest href "" "griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsLeadersRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"

Request model for NGS leaders endpoints with limit/week support.

Attributes¶

season `instance-attribute` ¶

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

Season year (e.g., 2025)

season_type `instance-attribute` ¶

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

Season type (REG, PRE, POST)

limit `class-attribute` `instance-attribute` ¶

limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Number of results to return (default: 20)

week `class-attribute` `instance-attribute` ¶

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

Optional week filter

GetNgsSeasonLeadersRequestTypedDict ¶

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsSeasonLeadersRequestTypedDict[GetNgsSeasonLeadersRequestTypedDict]

              

              click griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsSeasonLeadersRequestTypedDict href "" "griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsSeasonLeadersRequestTypedDict"

Request parameters for NGS season-aggregated leaders (no week/limit).

Attributes¶

season `instance-attribute` ¶

season: int

Season year (e.g., 2025)

season_type `instance-attribute` ¶

season_type: str

Season type (REG, PRE, POST)

GetNgsSeasonLeadersRequest ¶

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsSeasonLeadersRequest[GetNgsSeasonLeadersRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsSeasonLeadersRequest
                


              click griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsSeasonLeadersRequest href "" "griddy.nfl.models.requests.get_ngs_leaders_op.GetNgsSeasonLeadersRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"

Request model for NGS season-aggregated leaders (no week/limit).

Attributes¶

season `instance-attribute` ¶

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

Season year (e.g., 2025)

season_type `instance-attribute` ¶

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

Season type (REG, PRE, POST)

Get Ngs Leaders Op¶