Skip to content

Weekly Roster Response

griddy / nfl / models / responses / weekly_roster_response**

weekly_roster_response

Attributes

Classes

WeeklyRosterResponseTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.responses.weekly_roster_response.WeeklyRosterResponseTypedDict[WeeklyRosterResponseTypedDict]

              

              click griddy.nfl.models.responses.weekly_roster_response.WeeklyRosterResponseTypedDict href "" "griddy.nfl.models.responses.weekly_roster_response.WeeklyRosterResponseTypedDict"
            
Attributes
season instance-attribute
season: NotRequired[int]

Season year

season_type instance-attribute
season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

team instance-attribute
team: NotRequired[TeamInfoTypedDict]

Basic team information included in roster responses

week instance-attribute
week: NotRequired[int]

Week number

WeeklyRosterResponse

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.responses.weekly_roster_response.WeeklyRosterResponse[WeeklyRosterResponse]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.responses.weekly_roster_response.WeeklyRosterResponse
                


              click griddy.nfl.models.responses.weekly_roster_response.WeeklyRosterResponse href "" "griddy.nfl.models.responses.weekly_roster_response.WeeklyRosterResponse"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            
Attributes
season class-attribute instance-attribute
season: Optional[int] = None

Season year

season_type class-attribute instance-attribute
season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

team class-attribute instance-attribute
team: Optional[TeamInfo] = None

Basic team information included in roster responses

week class-attribute instance-attribute
week: Optional[int] = None

Week number