Pro Game

griddy / nfl / models / entities / pro_game**

pro_game

Attributes

ProGameCategory module-attribute

ProGameCategory = Literal['MNF', 'SNF', 'TNF']

Prime time game designation

ProGameStatus module-attribute

ProGameStatus = Literal[
    "SCHEDULED",
    "IN_PROGRESS",
    "FINAL",
    "POSTPONED",
    "CANCELLED",
]

Game status

Classes

ProGameTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.entities.pro_game.ProGameTypedDict[ProGameTypedDict]

              

              click griddy.nfl.models.entities.pro_game.ProGameTypedDict href "" "griddy.nfl.models.entities.pro_game.ProGameTypedDict"
            

Attributes

date_ instance-attribute

date_: NotRequired[date]

Game date (YYYY-MM-DD)

date_am_pm instance-attribute

date_am_pm: NotRequired[MeridiemEnum]

Time of day indicator

date_day instance-attribute

date_day: NotRequired[str]

Day of week (full)

date_day_month instance-attribute

date_day_month: NotRequired[str]

Date in M/D format

date_day_short instance-attribute

date_day_short: NotRequired[str]

Day of week (abbreviated)

date_time instance-attribute

date_time: NotRequired[str]

Time without AM/PM

date_time_am_pm instance-attribute

date_time_am_pm: NotRequired[str]

Time with AM/PM

extensions instance-attribute

extensions: NotRequired[List[ProGameExtensionTypedDict]]

Additional game data extensions

game_type instance-attribute

game_type: NotRequired[str]

Type of game

id instance-attribute

id: NotRequired[str]

Unique game identifier

international instance-attribute

international: NotRequired[bool]

Whether game is played internationally

neutral_site instance-attribute

neutral_site: NotRequired[bool]

Whether game is at neutral venue

phase instance-attribute

phase: NotRequired[str]

Game phase

season instance-attribute

season: NotRequired[int]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

status instance-attribute

status: NotRequired[ProGameStatus]

Game status

ticket_url instance-attribute

ticket_url: NotRequired[Nullable[str]]

Primary ticket purchase URL

time instance-attribute

time: NotRequired[datetime]

Game time in UTC

version instance-attribute

version: NotRequired[int]

Data version number

week instance-attribute

week: NotRequired[int]

Week number

week_type instance-attribute

week_type: NotRequired[str]

Week type (e.g., REG, HOF)

ProGame

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.entities.pro_game.ProGame[ProGame]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.pro_game.ProGame
                


              click griddy.nfl.models.entities.pro_game.ProGame href "" "griddy.nfl.models.entities.pro_game.ProGame"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

date_ class-attribute instance-attribute

date_: Annotated[Optional[date], Field(alias="date")] = None

Game date (YYYY-MM-DD)

date_am_pm class-attribute instance-attribute

date_am_pm: Annotated[
    Optional[MeridiemEnum], Field(alias="dateAmPm")
] = None

Time of day indicator

date_day class-attribute instance-attribute

date_day: Annotated[
    Optional[str], Field(alias="dateDay")
] = None

Day of week (full)

date_day_month class-attribute instance-attribute

date_day_month: Annotated[
    Optional[str], Field(alias="dateDayMonth")
] = None

Date in M/D format

date_day_short class-attribute instance-attribute

date_day_short: Annotated[
    Optional[str], Field(alias="dateDayShort")
] = None

Day of week (abbreviated)

date_time class-attribute instance-attribute

date_time: Annotated[
    Optional[str], Field(alias="dateTime")
] = None

Time without AM/PM

date_time_am_pm class-attribute instance-attribute

date_time_am_pm: Annotated[
    Optional[str], Field(alias="dateTimeAmPm")
] = None

Time with AM/PM

extensions class-attribute instance-attribute

extensions: Optional[List[ProGameExtension]] = None

Additional game data extensions

game_type class-attribute instance-attribute

game_type: Annotated[
    Optional[str], Field(alias="gameType")
] = None

Type of game

id class-attribute instance-attribute

id: Optional[str] = None

Unique game identifier

international class-attribute instance-attribute

international: Optional[bool] = None

Whether game is played internationally

neutral_site class-attribute instance-attribute

neutral_site: Annotated[
    Optional[bool], Field(alias="neutralSite")
] = None

Whether game is at neutral venue

phase class-attribute instance-attribute

phase: Optional[str] = None

Game phase

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

status class-attribute instance-attribute

status: Optional[ProGameStatus] = None

Game status

ticket_url class-attribute instance-attribute

ticket_url: Annotated[
    OptionalNullable[str], Field(alias="ticketUrl")
] = UNSET

Primary ticket purchase URL

time class-attribute instance-attribute

time: Optional[datetime] = None

Game time in UTC

version class-attribute instance-attribute

version: Optional[int] = None

Data version number

week class-attribute instance-attribute

week: Optional[int] = None

Week number

week_type class-attribute instance-attribute

week_type: Annotated[
    Optional[str], Field(alias="weekType")
] = None

Week type (e.g., REG, HOF)