Skip to content

Stats

griddy / nfl / endpoints / ngs / stats**

stats

NGS Stats endpoints for player statistics.

Classes

NgsStats

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

Bases: NgsBaseSDK


              flowchart TD
              griddy.nfl.endpoints.ngs.stats.NgsStats[NgsStats]
              griddy.nfl.endpoints.ngs.NgsBaseSDK[NgsBaseSDK]
              griddy.nfl.basesdk.BaseSDK[BaseSDK]

                              griddy.nfl.endpoints.ngs.NgsBaseSDK --> griddy.nfl.endpoints.ngs.stats.NgsStats
                                griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.ngs.NgsBaseSDK
                



              click griddy.nfl.endpoints.ngs.stats.NgsStats href "" "griddy.nfl.endpoints.ngs.stats.NgsStats"
              click griddy.nfl.endpoints.ngs.NgsBaseSDK href "" "griddy.nfl.endpoints.ngs.NgsBaseSDK"
              click griddy.nfl.basesdk.BaseSDK href "" "griddy.nfl.basesdk.BaseSDK"
            

NGS Stats endpoints for player statistics.

Provides access to: - Passing statistics (time to throw, air yards, completion probability, etc.) - Receiving statistics (separation, cushion, YAC, etc.) - Rushing statistics (time to LOS, rush yards over expected, etc.)

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_passing_stats
get_passing_stats(
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsPassingStatsResponse

Get NGS passing statistics.

Returns detailed passing statistics including time to throw, air yards, completion probability, and more.

PARAMETER DESCRIPTION
season

The season year (e.g., 2025)

TYPE: int

season_type

Season type (REG, PRE, POST)

TYPE: str

week

Optional week filter

TYPE: Optional[int] DEFAULT: None

retries

Override the default retry configuration

TYPE: OptionalNullable[RetryConfig] DEFAULT: UNSET

server_url

Override the default server URL

TYPE: Optional[str] DEFAULT: None

timeout_ms

Override the default timeout

TYPE: Optional[int] DEFAULT: None

http_headers

Additional headers to send

TYPE: Optional[Mapping[str, str]] DEFAULT: None

RETURNS DESCRIPTION
NgsPassingStatsResponse

Dict containing passing statistics

Source code in griddy/nfl/endpoints/ngs/stats.py
def get_passing_stats(
    self,
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsPassingStatsResponse:
    """Get NGS passing statistics.

    Returns detailed passing statistics including time to throw,
    air yards, completion probability, and more.

    Args:
        season: The season year (e.g., 2025)
        season_type: Season type (REG, PRE, POST)
        week: Optional week filter
        retries: Override the default retry configuration
        server_url: Override the default server URL
        timeout_ms: Override the default timeout
        http_headers: Additional headers to send

    Returns:
        Dict containing passing statistics
    """
    config = EndpointConfig(
        method="GET",
        path="/api/statboard/passing",
        operation_id="getNgsPassingStats",
        request=models.GetNgsPassingStatsRequest(
            season=season,
            season_type=season_type,
            week=week,
        ),
        response_type=models.NgsPassingStatsResponse,
        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_passing_stats_async async
get_passing_stats_async(
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsPassingStatsResponse

Get NGS passing statistics (async).

Source code in griddy/nfl/endpoints/ngs/stats.py
async def get_passing_stats_async(
    self,
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsPassingStatsResponse:
    """Get NGS passing statistics (async)."""
    config = EndpointConfig(
        method="GET",
        path="/api/statboard/passing",
        operation_id="getNgsPassingStats",
        request=models.GetNgsPassingStatsRequest(
            season=season,
            season_type=season_type,
            week=week,
        ),
        response_type=models.NgsPassingStatsResponse,
        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_receiving_stats
get_receiving_stats(
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsReceivingStatsResponse

Get NGS receiving statistics.

Returns detailed receiving statistics including separation, cushion, YAC over expectation, and more.

PARAMETER DESCRIPTION
season

The season year (e.g., 2025)

TYPE: int

season_type

Season type (REG, PRE, POST)

TYPE: str

week

Optional week filter

TYPE: Optional[int] DEFAULT: None

retries

Override the default retry configuration

TYPE: OptionalNullable[RetryConfig] DEFAULT: UNSET

server_url

Override the default server URL

TYPE: Optional[str] DEFAULT: None

timeout_ms

Override the default timeout

TYPE: Optional[int] DEFAULT: None

http_headers

Additional headers to send

TYPE: Optional[Mapping[str, str]] DEFAULT: None

RETURNS DESCRIPTION
NgsReceivingStatsResponse

NgsReceivingStatsResponse containing receiving statistics

Source code in griddy/nfl/endpoints/ngs/stats.py
def get_receiving_stats(
    self,
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsReceivingStatsResponse:
    """Get NGS receiving statistics.

    Returns detailed receiving statistics including separation,
    cushion, YAC over expectation, and more.

    Args:
        season: The season year (e.g., 2025)
        season_type: Season type (REG, PRE, POST)
        week: Optional week filter
        retries: Override the default retry configuration
        server_url: Override the default server URL
        timeout_ms: Override the default timeout
        http_headers: Additional headers to send

    Returns:
        NgsReceivingStatsResponse containing receiving statistics
    """
    config = EndpointConfig(
        method="GET",
        path="/api/statboard/receiving",
        operation_id="getNgsReceivingStats",
        request=models.GetNgsReceivingStatsRequest(
            season=season,
            season_type=season_type,
            week=week,
        ),
        response_type=models.NgsReceivingStatsResponse,
        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_receiving_stats_async async
get_receiving_stats_async(
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsReceivingStatsResponse

Get NGS receiving statistics (async).

Source code in griddy/nfl/endpoints/ngs/stats.py
async def get_receiving_stats_async(
    self,
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsReceivingStatsResponse:
    """Get NGS receiving statistics (async)."""
    config = EndpointConfig(
        method="GET",
        path="/api/statboard/receiving",
        operation_id="getNgsReceivingStats",
        request=models.GetNgsReceivingStatsRequest(
            season=season,
            season_type=season_type,
            week=week,
        ),
        response_type=models.NgsReceivingStatsResponse,
        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_rushing_stats
get_rushing_stats(
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsRushingStatsResponse

Get NGS rushing statistics.

Returns detailed rushing statistics including time to LOS, rush yards over expected, efficiency, and more.

PARAMETER DESCRIPTION
season

The season year (e.g., 2025)

TYPE: int

season_type

Season type (REG, PRE, POST)

TYPE: str

week

Optional week filter

TYPE: Optional[int] DEFAULT: None

retries

Override the default retry configuration

TYPE: OptionalNullable[RetryConfig] DEFAULT: UNSET

server_url

Override the default server URL

TYPE: Optional[str] DEFAULT: None

timeout_ms

Override the default timeout

TYPE: Optional[int] DEFAULT: None

http_headers

Additional headers to send

TYPE: Optional[Mapping[str, str]] DEFAULT: None

RETURNS DESCRIPTION
NgsRushingStatsResponse

NgsRushingStatsResponse containing rushing statistics

Source code in griddy/nfl/endpoints/ngs/stats.py
def get_rushing_stats(
    self,
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsRushingStatsResponse:
    """Get NGS rushing statistics.

    Returns detailed rushing statistics including time to LOS,
    rush yards over expected, efficiency, and more.

    Args:
        season: The season year (e.g., 2025)
        season_type: Season type (REG, PRE, POST)
        week: Optional week filter
        retries: Override the default retry configuration
        server_url: Override the default server URL
        timeout_ms: Override the default timeout
        http_headers: Additional headers to send

    Returns:
        NgsRushingStatsResponse containing rushing statistics
    """
    config = EndpointConfig(
        method="GET",
        path="/api/statboard/rushing",
        operation_id="getNgsRushingStats",
        request=models.GetNgsRushingStatsRequest(
            season=season,
            season_type=season_type,
            week=week,
        ),
        response_type=models.NgsRushingStatsResponse,
        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_rushing_stats_async async
get_rushing_stats_async(
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> NgsRushingStatsResponse

Get NGS rushing statistics (async).

Source code in griddy/nfl/endpoints/ngs/stats.py
async def get_rushing_stats_async(
    self,
    *,
    season: int,
    season_type: str,
    week: Optional[int] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsRushingStatsResponse:
    """Get NGS rushing statistics (async)."""
    config = EndpointConfig(
        method="GET",
        path="/api/statboard/rushing",
        operation_id="getNgsRushingStats",
        request=models.GetNgsRushingStatsRequest(
            season=season,
            season_type=season_type,
            week=week,
        ),
        response_type=models.NgsRushingStatsResponse,
        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)