Fantasy Stats Response¶

griddy / nfl / models / responses / fantasy_stats_response**

fantasy_stats_response ¶

Attributes¶

Classes¶

FantasyStatsResponseTypedDict ¶

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.responses.fantasy_stats_response.FantasyStatsResponseTypedDict[FantasyStatsResponseTypedDict]

              

              click griddy.nfl.models.responses.fantasy_stats_response.FantasyStatsResponseTypedDict href "" "griddy.nfl.models.responses.fantasy_stats_response.FantasyStatsResponseTypedDict"

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

last_n_weeks `instance-attribute` ¶

last_n_weeks: NotRequired[int]

Number of recent weeks analyzed (if applied)

min_offensive_snaps `instance-attribute` ¶

min_offensive_snaps: NotRequired[int]

Minimum offensive snaps filter applied

position_group `instance-attribute` ¶

position_group: NotRequired[List[str]]

Position groups included in results

team_offense `instance-attribute` ¶

team_offense: NotRequired[str]

Offensive team filter applied (if any)

week `instance-attribute` ¶

week: NotRequired[List[str]]

Specific weeks included in analysis

FantasyStatsResponse ¶

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.responses.fantasy_stats_response.FantasyStatsResponse[FantasyStatsResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.responses.fantasy_stats_response.FantasyStatsResponse
                


              click griddy.nfl.models.responses.fantasy_stats_response.FantasyStatsResponse href "" "griddy.nfl.models.responses.fantasy_stats_response.FantasyStatsResponse"
              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

last_n_weeks `class-attribute` `instance-attribute` ¶

last_n_weeks: Annotated[
    Optional[int], Field(alias="lastNWeeks")
] = None

Number of recent weeks analyzed (if applied)

min_offensive_snaps `class-attribute` `instance-attribute` ¶

min_offensive_snaps: Annotated[
    Optional[int], Field(alias="minOffensiveSnaps")
] = None

Minimum offensive snaps filter applied

position_group `class-attribute` `instance-attribute` ¶

position_group: Annotated[
    Optional[List[str]], Field(alias="positionGroup")
] = None

Position groups included in results

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

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

Offensive team filter applied (if any)

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

week: Optional[List[str]] = None

Specific weeks included in analysis

Fantasy Stats Response¶