Skip to content

Scheduled Game

griddy / nfl / models / entities / scheduled_game**

scheduled_game

Attributes

Classes

ScheduledGameTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.entities.scheduled_game.ScheduledGameTypedDict[ScheduledGameTypedDict]

              

              click griddy.nfl.models.entities.scheduled_game.ScheduledGameTypedDict href "" "griddy.nfl.models.entities.scheduled_game.ScheduledGameTypedDict"
            
Attributes
game_date instance-attribute
game_date: NotRequired[Nullable[date]]

Game date (YYYY-MM-DD format)

game_id instance-attribute
game_id: NotRequired[int]

Game identifier (format is YYYYMMDDNN)

game_key instance-attribute
game_key: NotRequired[int]

Unique game key

game_time instance-attribute
game_time: NotRequired[Nullable[datetime]]

Game time in UTC

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

Game time in Eastern timezone (HH:MM:SS)

game_type instance-attribute
game_type: NotRequired[SeasonTypeEnum]

Type of NFL season

home_display_name instance-attribute
home_display_name: NotRequired[str]

Home team display name

home_nickname instance-attribute
home_nickname: NotRequired[str]

Home team nickname

home_team_abbr instance-attribute
home_team_abbr: NotRequired[str]

Home team abbreviation

home_team_id instance-attribute
home_team_id: NotRequired[str]

Home team identifier

iso_time instance-attribute
iso_time: NotRequired[Nullable[int]]

Unix timestamp in milliseconds

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

Broadcast network

ngs_game instance-attribute
ngs_game: NotRequired[bool]

Whether Next Gen Stats are available

released_to_clubs instance-attribute
released_to_clubs: NotRequired[bool]

Whether game info is released to clubs

season instance-attribute
season: NotRequired[int]

Season year

season_type instance-attribute
season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

smart_id instance-attribute
smart_id: NotRequired[str]

Smart identifier for the game

validated instance-attribute
validated: NotRequired[bool]

Whether game info is validated

visitor_display_name instance-attribute
visitor_display_name: NotRequired[str]

Visitor team display name

visitor_nickname instance-attribute
visitor_nickname: NotRequired[str]

Visitor team nickname

visitor_team_abbr instance-attribute
visitor_team_abbr: NotRequired[str]

Visitor team abbreviation

visitor_team_id instance-attribute
visitor_team_id: NotRequired[str]

Visitor team identifier

week instance-attribute
week: NotRequired[int]

Week number

week_name_abbr instance-attribute
week_name_abbr: NotRequired[str]

Week name abbreviation

ScheduledGame

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.entities.scheduled_game.ScheduledGame[ScheduledGame]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.scheduled_game.ScheduledGame
                


              click griddy.nfl.models.entities.scheduled_game.ScheduledGame href "" "griddy.nfl.models.entities.scheduled_game.ScheduledGame"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            
Attributes
game_date class-attribute instance-attribute
game_date: Annotated[
    OptionalNullable[date], Field(alias="gameDate")
] = UNSET

Game date (YYYY-MM-DD format)

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

Game identifier (format is YYYYMMDDNN)

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

Unique game key

game_time class-attribute instance-attribute
game_time: Annotated[
    OptionalNullable[datetime], Field(alias="gameTime")
] = UNSET

Game time in UTC

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

Game time in Eastern timezone (HH:MM:SS)

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

Type of NFL season

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

Home team display name

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

Home team nickname

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

Home team abbreviation

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

Home team identifier

iso_time class-attribute instance-attribute
iso_time: Annotated[
    OptionalNullable[int], Field(alias="isoTime")
] = UNSET

Unix timestamp in milliseconds

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

Broadcast network

ngs_game class-attribute instance-attribute
ngs_game: Annotated[
    Optional[bool], Field(alias="ngsGame")
] = None

Whether Next Gen Stats are available

released_to_clubs class-attribute instance-attribute
released_to_clubs: Annotated[
    Optional[bool], Field(alias="releasedToClubs")
] = None

Whether game info is released to clubs

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

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

Smart identifier for the game

validated class-attribute instance-attribute
validated: Optional[bool] = None

Whether game info is validated

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

Visitor team display name

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

Visitor team nickname

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

Visitor team abbreviation

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

Visitor team identifier

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

Week number

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

Week name abbreviation