Pro Team

griddy / nfl / models / entities / pro_team**

pro_team

Attributes

ProTeamConferenceAbbr module-attribute

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

Conference abbreviation

ProTeamTeamType module-attribute

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

Type of team (regular or Pro Bowl)

Classes

ProTeamTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.entities.pro_team.ProTeamTypedDict[ProTeamTypedDict]

              

              click griddy.nfl.models.entities.pro_team.ProTeamTypedDict href "" "griddy.nfl.models.entities.pro_team.ProTeamTypedDict"
            

Attributes

abbr instance-attribute

abbr: NotRequired[str]

Three-letter team abbreviation

alt_color instance-attribute

alt_color: NotRequired[str]

Alternate team color in hex format

city instance-attribute

city: NotRequired[str]

Team city/location

city_state instance-attribute

city_state: NotRequired[str]

Team city and state

conference_abbr instance-attribute

conference_abbr: NotRequired[ProTeamConferenceAbbr]

Conference abbreviation

dark_color instance-attribute

dark_color: NotRequired[str]

Dark team color in hex format

domain instance-attribute

domain: NotRequired[str]

Team website domain prefix

full_name instance-attribute

full_name: NotRequired[str]

Full team name

is_pro_bowl instance-attribute

is_pro_bowl: NotRequired[bool]

Whether this is a Pro Bowl team

logo instance-attribute

logo: NotRequired[str]

URL to team logo (may contain formatInstructions placeholder)

name instance-attribute

name: NotRequired[str]

Team name

nick instance-attribute

nick: NotRequired[str]

Team nickname (short form)

nickname instance-attribute

nickname: NotRequired[str]

Team nickname

primary_color instance-attribute

primary_color: NotRequired[str]

Primary team color in hex format

season instance-attribute

season: NotRequired[int]

Current season year

secondary_color instance-attribute

secondary_color: NotRequired[str]

Secondary team color in hex format

slug instance-attribute

slug: NotRequired[str]

URL-friendly team identifier

smart_id instance-attribute

smart_id: NotRequired[str]

Unique smart identifier for the team

stadium_name instance-attribute

stadium_name: NotRequired[str]

Name of the team's home stadium

team_id instance-attribute

team_id: NotRequired[str]

Team identifier (4-digit string)

team_site_ticket_url instance-attribute

team_site_ticket_url: NotRequired[Nullable[str]]

URL to team's ticket purchase page

team_site_url instance-attribute

team_site_url: NotRequired[Nullable[str]]

Team's official website URL

team_type instance-attribute

team_type: NotRequired[ProTeamTeamType]

Type of team (regular or Pro Bowl)

tertiary_color instance-attribute

tertiary_color: NotRequired[str]

Tertiary team color in hex format

ticket_phone_number instance-attribute

ticket_phone_number: NotRequired[Nullable[str]]

Phone number for ticket purchases

year_found instance-attribute

year_found: NotRequired[int]

Year the team was founded

ProTeam

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.entities.pro_team.ProTeam[ProTeam]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.pro_team.ProTeam
                


              click griddy.nfl.models.entities.pro_team.ProTeam href "" "griddy.nfl.models.entities.pro_team.ProTeam"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

abbr class-attribute instance-attribute

abbr: Optional[str] = None

Three-letter team abbreviation

alt_color class-attribute instance-attribute

alt_color: Annotated[
    Optional[str], Field(alias="altColor")
] = None

Alternate team color in hex format

city class-attribute instance-attribute

city: Optional[str] = None

Team city/location

city_state class-attribute instance-attribute

city_state: Annotated[
    Optional[str], Field(alias="cityState")
] = None

Team city and state

conference_abbr class-attribute instance-attribute

conference_abbr: Annotated[
    Optional[ProTeamConferenceAbbr],
    Field(alias="conferenceAbbr"),
] = None

Conference abbreviation

dark_color class-attribute instance-attribute

dark_color: Annotated[
    Optional[str], Field(alias="darkColor")
] = None

Dark team color in hex format

domain class-attribute instance-attribute

domain: Optional[str] = None

Team website domain prefix

full_name class-attribute instance-attribute

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

Full team name

is_pro_bowl class-attribute instance-attribute

is_pro_bowl: Annotated[
    Optional[bool], Field(alias="isProBowl")
] = False

Whether this is a Pro Bowl team

logo class-attribute instance-attribute

logo: Optional[str] = None

URL to team logo (may contain formatInstructions placeholder)

name class-attribute instance-attribute

name: Optional[str] = None

Team name

nick class-attribute instance-attribute

nick: Optional[str] = None

Team nickname (short form)

nickname class-attribute instance-attribute

nickname: Optional[str] = None

Team nickname

primary_color class-attribute instance-attribute

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

Primary team color in hex format

season class-attribute instance-attribute

season: Optional[int] = None

Current season year

secondary_color class-attribute instance-attribute

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

Secondary team color in hex format

slug class-attribute instance-attribute

slug: Optional[str] = None

URL-friendly team identifier

smart_id class-attribute instance-attribute

smart_id: Annotated[
    Optional[str], Field(alias="smartId")
] = None

Unique smart identifier for the team

stadium_name class-attribute instance-attribute

stadium_name: Annotated[
    Optional[str], Field(alias="stadiumName")
] = None

Name of the team's home stadium

team_id class-attribute instance-attribute

team_id: Annotated[Optional[str], Field(alias="teamId")] = (
    None
)

Team identifier (4-digit string)

team_site_ticket_url class-attribute instance-attribute

team_site_ticket_url: Annotated[
    OptionalNullable[str], Field(alias="teamSiteTicketUrl")
] = UNSET

URL to team's ticket purchase page

team_site_url class-attribute instance-attribute

team_site_url: Annotated[
    OptionalNullable[str], Field(alias="teamSiteUrl")
] = UNSET

Team's official website URL

team_type class-attribute instance-attribute

team_type: Annotated[
    Optional[ProTeamTeamType], Field(alias="teamType")
] = None

Type of team (regular or Pro Bowl)

tertiary_color class-attribute instance-attribute

tertiary_color: Annotated[
    Optional[str], Field(alias="tertiaryColor")
] = None

Tertiary team color in hex format

ticket_phone_number class-attribute instance-attribute

ticket_phone_number: Annotated[
    OptionalNullable[str], Field(alias="ticketPhoneNumber")
] = UNSET

Phone number for ticket purchases

year_found class-attribute instance-attribute

year_found: Annotated[
    Optional[int], Field(alias="yearFound")
] = None

Year the team was founded