Skip to content

Team

griddy / nfl / models / entities / team**

team

Attributes

TeamConferenceAbbr module-attribute

TeamConferenceAbbr = Literal['AFC', 'NFC']

Conference abbreviation

TeamTeamType module-attribute

TeamTeamType = Literal['TEAM', 'PRO']

Type of team (regular or Pro Bowl)

Classes

TeamTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.entities.team.TeamTypedDict[TeamTypedDict]

              

              click griddy.nfl.models.entities.team.TeamTypedDict href "" "griddy.nfl.models.entities.team.TeamTypedDict"
            
Attributes
abbreviation instance-attribute
abbreviation: NotRequired[str]

Three-letter team abbreviation

conference_abbr instance-attribute
conference_abbr: NotRequired[TeamConferenceAbbr]

Conference abbreviation

conference_full_name instance-attribute
conference_full_name: NotRequired[str]

Full conference name

current_logo: NotRequired[str]

URL to team logo (may contain {formatInstructions} placeholder)

division_full_name instance-attribute
division_full_name: NotRequired[str]

Full division name

full_name instance-attribute
full_name: NotRequired[str]

Full team name

id instance-attribute
id: NotRequired[str]

Unique team identifier

league instance-attribute
league: NotRequired[str]

League name

location instance-attribute
location: NotRequired[str]

Team location/city

nfl_shop_url instance-attribute
nfl_shop_url: NotRequired[Nullable[str]]

URL to team's NFL shop

nick_name instance-attribute
nick_name: NotRequired[str]

Team nickname

official_website_url instance-attribute
official_website_url: NotRequired[Nullable[str]]

Team's official website

owners instance-attribute
owners: NotRequired[Nullable[str]]

Team ownership information

primary_color instance-attribute
primary_color: NotRequired[str]

Primary team color (hex)

season instance-attribute
season: NotRequired[str]

Current season

secondary_color instance-attribute
secondary_color: NotRequired[str]

Secondary team color (hex)

team_type instance-attribute
team_type: NotRequired[TeamTeamType]

Type of team (regular or Pro Bowl)

year_established instance-attribute
year_established: NotRequired[int]

Year team was established

Team

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.entities.team.Team[Team]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.team.Team
                


              click griddy.nfl.models.entities.team.Team href "" "griddy.nfl.models.entities.team.Team"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            
Attributes
abbreviation class-attribute instance-attribute
abbreviation: Optional[str] = None

Three-letter team abbreviation

conference_abbr class-attribute instance-attribute
conference_abbr: Annotated[
    Optional[TeamConferenceAbbr],
    Field(alias="conferenceAbbr"),
] = None

Conference abbreviation

conference_full_name class-attribute instance-attribute
conference_full_name: Annotated[
    Optional[str], Field(alias="conferenceFullName")
] = None

Full conference name

current_logo: Annotated[
    Optional[str], Field(alias="currentLogo")
] = None

URL to team logo (may contain {formatInstructions} placeholder)

division_full_name class-attribute instance-attribute
division_full_name: Annotated[
    Optional[str], Field(alias="divisionFullName")
] = None

Full division name

full_name class-attribute instance-attribute
full_name: Annotated[
    Optional[str], Field(alias="fullName")
] = None

Full team name

id class-attribute instance-attribute
id: Optional[str] = None

Unique team identifier

league class-attribute instance-attribute
league: Optional[str] = None

League name

location class-attribute instance-attribute
location: Optional[str] = None

Team location/city

nfl_shop_url class-attribute instance-attribute
nfl_shop_url: Annotated[
    OptionalNullable[str], Field(alias="nflShopUrl")
] = UNSET

URL to team's NFL shop

nick_name class-attribute instance-attribute
nick_name: Annotated[
    Optional[str], Field(alias="nickName")
] = None

Team nickname

official_website_url class-attribute instance-attribute
official_website_url: Annotated[
    OptionalNullable[str], Field(alias="officialWebsiteUrl")
] = UNSET

Team's official website

owners class-attribute instance-attribute
owners: OptionalNullable[str] = UNSET

Team ownership information

primary_color class-attribute instance-attribute
primary_color: Annotated[
    Optional[str], Field(alias="primaryColor")
] = None

Primary team color (hex)

season class-attribute instance-attribute
season: Optional[str] = None

Current season

secondary_color class-attribute instance-attribute
secondary_color: Annotated[
    Optional[str], Field(alias="secondaryColor")
] = None

Secondary team color (hex)

team_type class-attribute instance-attribute
team_type: Annotated[
    Optional[TeamTeamType], Field(alias="teamType")
] = None

Type of team (regular or Pro Bowl)

year_established class-attribute instance-attribute
year_established: Annotated[
    Optional[int], Field(alias="yearEstablished")
] = None

Year team was established