Skip to content

Game Content

griddy / nfl / endpoints / pro / mixins / game_content**

game_content

Classes

GameContentMixin

Mixin for game content-related endpoints.

Functions
get_game_preview
get_game_preview(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: int,
    visitor_display_name: str,
    home_display_name: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> GamePreviewResponse

Get Game Preview Content

Retrieves preview content and insights for a specific game based on teams and week. Returns preview information, matchup analysis, and key storylines.

:param season: Season year :param season_type: Type of season :param week: Week number :param visitor_display_name: Visiting team display name :param home_display_name: Home team display name :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param http_headers: Additional headers to set or replace on requests.

Source code in griddy/nfl/endpoints/pro/mixins/game_content.py
def get_game_preview(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: int,
    visitor_display_name: str,
    home_display_name: str,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.GamePreviewResponse:
    r"""Get Game Preview Content

    Retrieves preview content and insights for a specific game based on teams and week. Returns preview information, matchup analysis, and key storylines.

    :param season: Season year
    :param season_type: Type of season
    :param week: Week number
    :param visitor_display_name: Visiting team display name
    :param home_display_name: Home team display name
    :param retries: Override the default retry configuration for this method
    :param server_url: Override the default server URL for this method
    :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
    :param http_headers: Additional headers to set or replace on requests.
    """
    config = self._get_game_preview_config(
        season=season,
        season_type=season_type,
        week=week,
        visitor_display_name=visitor_display_name,
        home_display_name=home_display_name,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_game_preview_async async
get_game_preview_async(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: int,
    visitor_display_name: str,
    home_display_name: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> GamePreviewResponse

Get Game Preview Content

Retrieves preview content and insights for a specific game based on teams and week. Returns preview information, matchup analysis, and key storylines.

:param season: Season year :param season_type: Type of season :param week: Week number :param visitor_display_name: Visiting team display name :param home_display_name: Home team display name :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param http_headers: Additional headers to set or replace on requests.

Source code in griddy/nfl/endpoints/pro/mixins/game_content.py
async def get_game_preview_async(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: int,
    visitor_display_name: str,
    home_display_name: str,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.GamePreviewResponse:
    r"""Get Game Preview Content

    Retrieves preview content and insights for a specific game based on teams and week. Returns preview information, matchup analysis, and key storylines.

    :param season: Season year
    :param season_type: Type of season
    :param week: Week number
    :param visitor_display_name: Visiting team display name
    :param home_display_name: Home team display name
    :param retries: Override the default retry configuration for this method
    :param server_url: Override the default server URL for this method
    :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
    :param http_headers: Additional headers to set or replace on requests.
    """
    config = self._get_game_preview_config(
        season=season,
        season_type=season_type,
        week=week,
        visitor_display_name=visitor_display_name,
        home_display_name=home_display_name,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_game_insights
get_game_insights(
    *,
    season: int,
    fapi_game_id: str,
    away_team_id: str,
    home_team_id: str,
    limit: Optional[int] = 20,
    tags: Optional[str] = None,
    exclude_tags: Optional[str] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> List[GameInsight]

Get Game-Specific Insights

Retrieves analytical insights and advanced statistics for a specific game. Can filter by tags and exclude specific content types.

:param season: Season year :param fapi_game_id: FAPI Game identifier (UUID) :param away_team_id: Away team identifier :param home_team_id: Home team identifier :param limit: Maximum number of insights to return :param tags: Comma-separated list of tags to filter by :param exclude_tags: Comma-separated list of tags to exclude :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param http_headers: Additional headers to set or replace on requests.

Source code in griddy/nfl/endpoints/pro/mixins/game_content.py
def get_game_insights(
    self,
    *,
    season: int,
    fapi_game_id: str,
    away_team_id: str,
    home_team_id: str,
    limit: Optional[int] = 20,
    tags: Optional[str] = None,
    exclude_tags: Optional[str] = None,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.GameInsight]:
    r"""Get Game-Specific Insights

    Retrieves analytical insights and advanced statistics for a specific game.
    Can filter by tags and exclude specific content types.


    :param season: Season year
    :param fapi_game_id: FAPI Game identifier (UUID)
    :param away_team_id: Away team identifier
    :param home_team_id: Home team identifier
    :param limit: Maximum number of insights to return
    :param tags: Comma-separated list of tags to filter by
    :param exclude_tags: Comma-separated list of tags to exclude
    :param retries: Override the default retry configuration for this method
    :param server_url: Override the default server URL for this method
    :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
    :param http_headers: Additional headers to set or replace on requests.
    """
    config = self._get_game_insights_config(
        season=season,
        fapi_game_id=fapi_game_id,
        away_team_id=away_team_id,
        home_team_id=home_team_id,
        limit=limit,
        tags=tags,
        exclude_tags=exclude_tags,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_game_insights_async async
get_game_insights_async(
    *,
    season: int,
    fapi_game_id: str,
    away_team_id: str,
    home_team_id: str,
    limit: Optional[int] = 20,
    tags: Optional[str] = None,
    exclude_tags: Optional[str] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> List[GameInsight]

Get Game-Specific Insights

Retrieves analytical insights and advanced statistics for a specific game. Can filter by tags and exclude specific content types.

:param season: Season year :param fapi_game_id: FAPI Game identifier (UUID) :param away_team_id: Away team identifier :param home_team_id: Home team identifier :param limit: Maximum number of insights to return :param tags: Comma-separated list of tags to filter by :param exclude_tags: Comma-separated list of tags to exclude :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param http_headers: Additional headers to set or replace on requests.

Source code in griddy/nfl/endpoints/pro/mixins/game_content.py
async def get_game_insights_async(
    self,
    *,
    season: int,
    fapi_game_id: str,
    away_team_id: str,
    home_team_id: str,
    limit: Optional[int] = 20,
    tags: Optional[str] = None,
    exclude_tags: Optional[str] = None,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.GameInsight]:
    r"""Get Game-Specific Insights

    Retrieves analytical insights and advanced statistics for a specific game.
    Can filter by tags and exclude specific content types.


    :param season: Season year
    :param fapi_game_id: FAPI Game identifier (UUID)
    :param away_team_id: Away team identifier
    :param home_team_id: Home team identifier
    :param limit: Maximum number of insights to return
    :param tags: Comma-separated list of tags to filter by
    :param exclude_tags: Comma-separated list of tags to exclude
    :param retries: Override the default retry configuration for this method
    :param server_url: Override the default server URL for this method
    :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
    :param http_headers: Additional headers to set or replace on requests.
    """
    config = self._get_game_insights_config(
        season=season,
        fapi_game_id=fapi_game_id,
        away_team_id=away_team_id,
        home_team_id=home_team_id,
        limit=limit,
        tags=tags,
        exclude_tags=exclude_tags,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)