Player

griddy / nfl / models / entities / player**

player

Classes

PlayerTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.entities.player.PlayerTypedDict[PlayerTypedDict]

              

              click griddy.nfl.models.entities.player.PlayerTypedDict href "" "griddy.nfl.models.entities.player.PlayerTypedDict"
            

Attributes

birth_date instance-attribute

birth_date: NotRequired[date]

Player's birth date

college_conference instance-attribute

college_conference: NotRequired[str]

Player's college conference

college_name instance-attribute

college_name: NotRequired[str]

Player's college

current_team_id instance-attribute

current_team_id: NotRequired[str]

Current team identifier

display_name instance-attribute

display_name: NotRequired[str]

Player's display name

draft_club instance-attribute

draft_club: NotRequired[Nullable[str]]

Team that drafted the player

draft_number instance-attribute

draft_number: NotRequired[Nullable[int]]

Overall draft pick number

draftround instance-attribute

draftround: NotRequired[Nullable[int]]

Draft round

entry_year instance-attribute

entry_year: NotRequired[int]

Year player entered the league

esb_id instance-attribute

esb_id: NotRequired[str]

ESB identifier

first_name instance-attribute

first_name: NotRequired[str]

Player's first name

football_name instance-attribute

football_name: NotRequired[str]

Player's football name (nickname)

gsis_id instance-attribute

gsis_id: NotRequired[str]

GSIS identifier

gsis_it_id instance-attribute

gsis_it_id: NotRequired[int]

GSIS IT identifier

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image

height instance-attribute

height: NotRequired[str]

Player height (format is feet-inches)

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

last_name instance-attribute

last_name: NotRequired[str]

Player's last name

nfl_id instance-attribute

nfl_id: NotRequired[int]

NFL player identifier

ngs_position instance-attribute

ngs_position: NotRequired[Nullable[str]]

Next Gen Stats position

ngs_position_group instance-attribute

ngs_position_group: NotRequired[Nullable[str]]

Next Gen Stats position group

position instance-attribute

position: NotRequired[str]

Player's position

position_group instance-attribute

position_group: NotRequired[str]

Player's position group

rookie_year instance-attribute

rookie_year: NotRequired[int]

Player's rookie year

season instance-attribute

season: NotRequired[int]

Current season

short_name instance-attribute

short_name: NotRequired[str]

Shortened player name

smart_id instance-attribute

smart_id: NotRequired[str]

Smart identifier for the player

status instance-attribute

status: NotRequired[str]

Player status code

status_description_abbr instance-attribute

status_description_abbr: NotRequired[str]

Abbreviated status description

status_short_description instance-attribute

status_short_description: NotRequired[str]

Short status description

team_abbr instance-attribute

team_abbr: NotRequired[str]

Current team abbreviation

uniform_number instance-attribute

uniform_number: NotRequired[str]

Player's uniform number (formatted)

weight instance-attribute

weight: NotRequired[int]

Player weight in pounds

years_of_experience instance-attribute

years_of_experience: NotRequired[int]

Years of NFL experience

Player

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.entities.player.Player[Player]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.player.Player
                


              click griddy.nfl.models.entities.player.Player href "" "griddy.nfl.models.entities.player.Player"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

birth_date class-attribute instance-attribute

birth_date: Annotated[
    Optional[date], Field(alias=birthDate)
] = None

Player's birth date

college_conference class-attribute instance-attribute

college_conference: Annotated[
    Optional[str], Field(alias=collegeConference)
] = None

Player's college conference

college_name class-attribute instance-attribute

college_name: Annotated[
    Optional[str], Field(alias=collegeName)
] = None

Player's college

current_team_id class-attribute instance-attribute

current_team_id: Annotated[
    Optional[str], Field(alias=currentTeamId)
] = None

Current team identifier

display_name class-attribute instance-attribute

display_name: Annotated[
    Optional[str], Field(alias=displayName)
] = None

Player's display name

draft_club class-attribute instance-attribute

draft_club: Annotated[
    OptionalNullable[str], Field(alias=draftClub)
] = UNSET

Team that drafted the player

draft_number class-attribute instance-attribute

draft_number: Annotated[
    OptionalNullable[int], Field(alias=draftNumber)
] = UNSET

Overall draft pick number

draftround class-attribute instance-attribute

draftround: OptionalNullable[int] = UNSET

Draft round

entry_year class-attribute instance-attribute

entry_year: Annotated[
    Optional[int], Field(alias=entryYear)
] = None

Year player entered the league

esb_id class-attribute instance-attribute

esb_id: Annotated[Optional[str], Field(alias=esbId)] = None

ESB identifier

first_name class-attribute instance-attribute

first_name: Annotated[
    Optional[str], Field(alias=firstName)
] = None

Player's first name

football_name class-attribute instance-attribute

football_name: Annotated[
    Optional[str], Field(alias=footballName)
] = None

Player's football name (nickname)

gsis_id class-attribute instance-attribute

gsis_id: Annotated[Optional[str], Field(alias=gsisId)] = (
    None
)

GSIS identifier

gsis_it_id class-attribute instance-attribute

gsis_it_id: Annotated[
    Optional[int], Field(alias=gsisItId)
] = None

GSIS IT identifier

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image

height class-attribute instance-attribute

height: Optional[str] = None

Player height (format is feet-inches)

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias=jerseyNumber)
] = None

Player's jersey number

last_name class-attribute instance-attribute

last_name: Annotated[
    Optional[str], Field(alias=lastName)
] = None

Player's last name

nfl_id class-attribute instance-attribute

nfl_id: Annotated[Optional[int], Field(alias=nflId)] = None

NFL player identifier

ngs_position class-attribute instance-attribute

ngs_position: Annotated[
    OptionalNullable[str], Field(alias=ngsPosition)
] = UNSET

Next Gen Stats position

ngs_position_group class-attribute instance-attribute

ngs_position_group: Annotated[
    OptionalNullable[str], Field(alias=ngsPositionGroup)
] = UNSET

Next Gen Stats position group

position class-attribute instance-attribute

position: Optional[str] = None

Player's position

position_group class-attribute instance-attribute

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

Player's position group

rookie_year class-attribute instance-attribute

rookie_year: Annotated[
    Optional[int], Field(alias=rookieYear)
] = None

Player's rookie year

season class-attribute instance-attribute

season: Optional[int] = None

Current season

short_name class-attribute instance-attribute

short_name: Annotated[
    Optional[str], Field(alias=shortName)
] = None

Shortened player name

smart_id class-attribute instance-attribute

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

Smart identifier for the player

status class-attribute instance-attribute

status: Optional[str] = None

Player status code

status_description_abbr class-attribute instance-attribute

status_description_abbr: Annotated[
    Optional[str], Field(alias=statusDescriptionAbbr)
] = None

Abbreviated status description

status_short_description class-attribute instance-attribute

status_short_description: Annotated[
    Optional[str], Field(alias=statusShortDescription)
] = None

Short status description

team_abbr class-attribute instance-attribute

team_abbr: Annotated[
    Optional[str], Field(alias=teamAbbr)
] = None

Current team abbreviation

uniform_number class-attribute instance-attribute

uniform_number: Annotated[
    Optional[str], Field(alias=uniformNumber)
] = None

Player's uniform number (formatted)

weight class-attribute instance-attribute

weight: Optional[int] = None

Player weight in pounds

years_of_experience class-attribute instance-attribute

years_of_experience: Annotated[
    Optional[int], Field(alias=yearsOfExperience)
] = None

Years of NFL experience