Receiving Stats Response¶

griddy / nfl / models / responses / receiving_stats_response**

receiving_stats_response ¶

Attributes¶

Classes¶

ReceivingStatsResponseTypedDict ¶

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.responses.receiving_stats_response.ReceivingStatsResponseTypedDict[ReceivingStatsResponseTypedDict]

              

              click griddy.nfl.models.responses.receiving_stats_response.ReceivingStatsResponseTypedDict href "" "griddy.nfl.models.responses.receiving_stats_response.ReceivingStatsResponseTypedDict"

Attributes¶

limit `instance-attribute` ¶

limit: int

Maximum number of results returned

offset `instance-attribute` ¶

offset: int

Number of records skipped

season `instance-attribute` ¶

season: int

Season year

season_type `instance-attribute` ¶

season_type: SeasonTypeEnum

Type of NFL season

sort_key `instance-attribute` ¶

sort_key: NotRequired[str]

Field used for sorting

sort_value `instance-attribute` ¶

sort_value: NotRequired[SortOrderEnum]

Sort direction for ordered results

total `instance-attribute` ¶

total: int

Total number of players matching the criteria

qualified_receiver `instance-attribute` ¶

qualified_receiver: NotRequired[bool]

Whether results are filtered to qualified receivers only

team_offense `instance-attribute` ¶

team_offense: NotRequired[str]

Team filter applied (if any)

week `instance-attribute` ¶

week: NotRequired[str]

Week identifier

ReceivingStatsResponse ¶

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.responses.receiving_stats_response.ReceivingStatsResponse[ReceivingStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.responses.receiving_stats_response.ReceivingStatsResponse
                


              click griddy.nfl.models.responses.receiving_stats_response.ReceivingStatsResponse href "" "griddy.nfl.models.responses.receiving_stats_response.ReceivingStatsResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"

Attributes¶

limit `instance-attribute` ¶

limit: int

Maximum number of results returned

offset `instance-attribute` ¶

offset: int

Number of records skipped

season `instance-attribute` ¶

season: int

Season year

season_type `instance-attribute` ¶

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

sort_key `class-attribute` `instance-attribute` ¶

sort_key: Annotated[
    Optional[str], Field(alias="sortKey")
] = None

Field used for sorting

sort_value `class-attribute` `instance-attribute` ¶

sort_value: Annotated[
    Optional[SortOrderEnum], Field(alias="sortValue")
] = None

Sort direction for ordered results

total `instance-attribute` ¶

total: int

Total number of players matching the criteria

qualified_receiver `class-attribute` `instance-attribute` ¶

qualified_receiver: Annotated[
    Optional[bool], Field(alias="qualifiedReceiver")
] = None

Whether results are filtered to qualified receivers only

team_offense `class-attribute` `instance-attribute` ¶

team_offense: Annotated[
    Optional[str], Field(alias="teamOffense")
] = None

Team filter applied (if any)

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

week: Optional[str] = None

Week identifier

Receiving Stats Response¶