Skip to content

Get Standings Op

griddy / nfl / models / requests / get_standings_op**

get_standings_op

Attributes

Classes

GetStandingsRequestTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_standings_op.GetStandingsRequestTypedDict[GetStandingsRequestTypedDict]

              

              click griddy.nfl.models.requests.get_standings_op.GetStandingsRequestTypedDict href "" "griddy.nfl.models.requests.get_standings_op.GetStandingsRequestTypedDict"
Attributes
season instance-attribute 
season: int

Season year

season_type instance-attribute 
season_type: SeasonTypeEnum

Type of season

week instance-attribute 
week: int

Week number

limit instance-attribute 
limit: NotRequired[int]

Maximum number of results to return

GetStandingsRequest

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_standings_op.GetStandingsRequest[GetStandingsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_standings_op.GetStandingsRequest
                


              click griddy.nfl.models.requests.get_standings_op.GetStandingsRequest href "" "griddy.nfl.models.requests.get_standings_op.GetStandingsRequest"
              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[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Week number

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

Maximum number of results to return