Skip to content

Get Game Insights Op

griddy / nfl / models / requests / get_game_insights_op**

get_game_insights_op

Classes

GetGameInsightsRequestTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_game_insights_op.GetGameInsightsRequestTypedDict[GetGameInsightsRequestTypedDict]

              

              click griddy.nfl.models.requests.get_game_insights_op.GetGameInsightsRequestTypedDict href "" "griddy.nfl.models.requests.get_game_insights_op.GetGameInsightsRequestTypedDict"
Attributes
season instance-attribute 
season: int

Season year

fapi_game_id instance-attribute 
fapi_game_id: str

FAPI Game identifier (UUID)

away_team_id instance-attribute 
away_team_id: str

Away team identifier

home_team_id instance-attribute 
home_team_id: str

Home team identifier

limit instance-attribute 
limit: NotRequired[int]

Maximum number of insights to return

tags instance-attribute 
tags: NotRequired[str]

Comma-separated list of tags to filter by

exclude_tags instance-attribute 
exclude_tags: NotRequired[str]

Comma-separated list of tags to exclude

GetGameInsightsRequest

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_game_insights_op.GetGameInsightsRequest[GetGameInsightsRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_game_insights_op.GetGameInsightsRequest
                


              click griddy.nfl.models.requests.get_game_insights_op.GetGameInsightsRequest href "" "griddy.nfl.models.requests.get_game_insights_op.GetGameInsightsRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
Attributes
season instance-attribute 
season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

fapi_game_id instance-attribute 
fapi_game_id: Annotated[
    str,
    Field(alias="fapiGameId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

FAPI Game identifier (UUID)

away_team_id instance-attribute 
away_team_id: Annotated[
    str,
    Field(alias="awayTeamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Away team identifier

home_team_id instance-attribute 
home_team_id: Annotated[
    str,
    Field(alias="homeTeamId"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Home team identifier

limit class-attribute instance-attribute 
limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Maximum number of insights to return

tags class-attribute instance-attribute 
tags: Annotated[
    Optional[str],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Comma-separated list of tags to filter by

exclude_tags class-attribute instance-attribute 
exclude_tags: Annotated[
    Optional[str],
    Field(alias="excludeTags"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = None

Comma-separated list of tags to exclude