Content

griddy / nfl / endpoints / ngs / content**

content

NGS Content endpoints for charts and highlights.

Classes

NgsContent

NgsContent(
    sdk_config: SDKConfiguration,
    parent_ref: Optional[object] = None,
)

Bases: NgsBaseSDK

              flowchart TD
              griddy.nfl.endpoints.ngs.content.NgsContent[NgsContent]
              griddy.nfl.endpoints.ngs.NgsBaseSDK[NgsBaseSDK]
              griddy.nfl.basesdk.BaseSDK[BaseSDK]

                              griddy.nfl.endpoints.ngs.NgsBaseSDK --> griddy.nfl.endpoints.ngs.content.NgsContent
                                griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.ngs.NgsBaseSDK
                



              click griddy.nfl.endpoints.ngs.content.NgsContent href "" "griddy.nfl.endpoints.ngs.content.NgsContent"
              click griddy.nfl.endpoints.ngs.NgsBaseSDK href "" "griddy.nfl.endpoints.ngs.NgsBaseSDK"
              click griddy.nfl.basesdk.BaseSDK href "" "griddy.nfl.basesdk.BaseSDK"
            

NGS Content endpoints for charts and highlights.

Provides access to: - Player charts (route, pass, carry) - Chart players list - Play highlights

Source code in griddy/nfl/basesdk.py

def __init__(
    self,
    sdk_config: SDKConfiguration,
    parent_ref: Optional[object] = None,
) -> None:
    self.sdk_configuration = sdk_config
    self.parent_ref = parent_ref

Functions

get_charts

get_charts(
    *,
    season: int,
    count: int = 12,
    week: str = "all",
    chart_type: str = "all",
    team_id: str = "all",
    esb_id: str = "all",
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsChartsResponse

Get player charts (route, pass, carry).

PARAMETER	DESCRIPTION
season	Season year (e.g., 2025) TYPE: int
count	Number of charts to return (default: 12) TYPE: int DEFAULT: 12
week	Week filter or "all" (default: "all") TYPE: str DEFAULT: 'all'
chart_type	Chart type filter: "all", "route", "pass", "carry" TYPE: str DEFAULT: 'all'
team_id	Team ID filter or "all" TYPE: str DEFAULT: 'all'
esb_id	Player ESB ID filter or "all" TYPE: str DEFAULT: 'all'

Source code in griddy/nfl/endpoints/ngs/content.py

def get_charts(
    self,
    *,
    season: int,
    count: int = 12,
    week: str = "all",
    chart_type: str = "all",
    team_id: str = "all",
    esb_id: str = "all",
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsChartsResponse:
    """Get player charts (route, pass, carry).

    Args:
        season: Season year (e.g., 2025)
        count: Number of charts to return (default: 12)
        week: Week filter or "all" (default: "all")
        chart_type: Chart type filter: "all", "route", "pass", "carry"
        team_id: Team ID filter or "all"
        esb_id: Player ESB ID filter or "all"
    """
    config = EndpointConfig(
        method="GET",
        path="/api/content/microsite/chart",
        operation_id="getNgsCharts",
        request=models.GetNgsChartsRequest(
            season=season,
            count=count,
            week=week,
            chart_type=chart_type,
            team_id=team_id,
            esb_id=esb_id,
        ),
        response_type=models.NgsChartsResponse,
        error_status_codes=NGS_ERROR_CODES,
        request_has_query_params=True,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
        retries=retries,
        return_raw_json=False,
    )
    return self._execute_endpoint(config)

get_charts_async async

get_charts_async(
    *,
    season: int,
    count: int = 12,
    week: str = "all",
    chart_type: str = "all",
    team_id: str = "all",
    esb_id: str = "all",
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsChartsResponse

Get player charts (async).

Source code in griddy/nfl/endpoints/ngs/content.py

async def get_charts_async(
    self,
    *,
    season: int,
    count: int = 12,
    week: str = "all",
    chart_type: str = "all",
    team_id: str = "all",
    esb_id: str = "all",
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsChartsResponse:
    """Get player charts (async)."""
    config = EndpointConfig(
        method="GET",
        path="/api/content/microsite/chart",
        operation_id="getNgsCharts",
        request=models.GetNgsChartsRequest(
            season=season,
            count=count,
            week=week,
            chart_type=chart_type,
            team_id=team_id,
            esb_id=esb_id,
        ),
        response_type=models.NgsChartsResponse,
        error_status_codes=NGS_ERROR_CODES,
        request_has_query_params=True,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
        retries=retries,
        return_raw_json=False,
    )
    return await self._execute_endpoint_async(config)

get_players

get_players(
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsChartPlayersResponse

Get players available in the chart system.

Source code in griddy/nfl/endpoints/ngs/content.py

def get_players(
    self,
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsChartPlayersResponse:
    """Get players available in the chart system."""
    config = EndpointConfig(
        method="GET",
        path="/api/content/microsite/chart/players",
        operation_id="getNgsChartPlayers",
        request=models.GetNgsCurrentScheduleRequest(),  # No params needed
        response_type=models.NgsChartPlayersResponse,
        error_status_codes=NGS_ERROR_CODES,
        request_has_query_params=False,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
        retries=retries,
        return_raw_json=False,
    )
    return self._execute_endpoint(config)

get_players_async async

get_players_async(
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsChartPlayersResponse

Get players available in the chart system (async).

Source code in griddy/nfl/endpoints/ngs/content.py

async def get_players_async(
    self,
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsChartPlayersResponse:
    """Get players available in the chart system (async)."""
    config = EndpointConfig(
        method="GET",
        path="/api/content/microsite/players",
        operation_id="getNgsChartPlayers",
        request=models.GetNgsCurrentScheduleRequest(),
        response_type=models.NgsChartPlayersResponse,
        error_status_codes=NGS_ERROR_CODES,
        request_has_query_params=False,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
        retries=retries,
        return_raw_json=False,
    )
    return await self._execute_endpoint_async(config)

get_highlights

get_highlights(
    *,
    season: int,
    limit: int = 16,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsHighlightsResponse

Get play highlights.

PARAMETER	DESCRIPTION
season	Season year (e.g., 2025) TYPE: int
limit	Number of highlights to return (default: 16) TYPE: int DEFAULT: 16

Source code in griddy/nfl/endpoints/ngs/content.py

def get_highlights(
    self,
    *,
    season: int,
    limit: int = 16,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsHighlightsResponse:
    """Get play highlights.

    Args:
        season: Season year (e.g., 2025)
        limit: Number of highlights to return (default: 16)
    """
    config = EndpointConfig(
        method="GET",
        path="/api/plays/highlights",
        operation_id="getNgsHighlights",
        request=models.GetNgsHighlightsRequest(season=season, limit=limit),
        response_type=models.NgsHighlightsResponse,
        error_status_codes=NGS_ERROR_CODES,
        request_has_query_params=True,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
        retries=retries,
        return_raw_json=False,
    )
    return self._execute_endpoint(config)

get_highlights_async async

get_highlights_async(
    *,
    season: int,
    limit: int = 16,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsHighlightsResponse

Get play highlights (async).

Source code in griddy/nfl/endpoints/ngs/content.py

async def get_highlights_async(
    self,
    *,
    season: int,
    limit: int = 16,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsHighlightsResponse:
    """Get play highlights (async)."""
    config = EndpointConfig(
        method="GET",
        path="/api/plays/highlights",
        operation_id="getNgsHighlights",
        request=models.GetNgsHighlightsRequest(season=season, limit=limit),
        response_type=models.NgsHighlightsResponse,
        error_status_codes=NGS_ERROR_CODES,
        request_has_query_params=True,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
        retries=retries,
        return_raw_json=False,
    )
    return await self._execute_endpoint_async(config)