League

griddy / nfl / endpoints / ngs / league**

league

NGS League endpoints for schedules and team information.

Classes

NgsLeague

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

Bases: NgsBaseSDK

              flowchart TD
              griddy.nfl.endpoints.ngs.league.NgsLeague[NgsLeague]
              griddy.nfl.endpoints.ngs.NgsBaseSDK[NgsBaseSDK]
              griddy.nfl.basesdk.BaseSDK[BaseSDK]

                              griddy.nfl.endpoints.ngs.NgsBaseSDK --> griddy.nfl.endpoints.ngs.league.NgsLeague
                                griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.ngs.NgsBaseSDK
                



              click griddy.nfl.endpoints.ngs.league.NgsLeague href "" "griddy.nfl.endpoints.ngs.league.NgsLeague"
              click griddy.nfl.endpoints.ngs.NgsBaseSDK href "" "griddy.nfl.endpoints.ngs.NgsBaseSDK"
              click griddy.nfl.basesdk.BaseSDK href "" "griddy.nfl.basesdk.BaseSDK"
            

NGS League endpoints for schedules and team information.

Provides access to: - Current week schedule - Full season schedule - Team information

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_current_schedule

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

Get the current week's schedule.

Returns the schedule for the current week of the NFL season, including game times, teams, scores, and venue information.

PARAMETER	DESCRIPTION
retries	Override the default retry configuration for this request TYPE: OptionalNullable[RetryConfig] DEFAULT: UNSET
server_url	Override the default server URL for this request TYPE: Optional[str] DEFAULT: None
timeout_ms	Override the default timeout for this request TYPE: Optional[int] DEFAULT: None
http_headers	Additional headers to send with the request TYPE: Optional[Mapping[str, str]] DEFAULT: None

RETURNS	DESCRIPTION
NgsCurrentScheduleResponse	NgsCurrentScheduleResponse containing the current week's games

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

def get_current_schedule(
    self,
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsCurrentScheduleResponse:
    """Get the current week's schedule.

    Returns the schedule for the current week of the NFL season,
    including game times, teams, scores, and venue information.

    Args:
        retries: Override the default retry configuration for this request
        server_url: Override the default server URL for this request
        timeout_ms: Override the default timeout for this request
        http_headers: Additional headers to send with the request

    Returns:
        NgsCurrentScheduleResponse containing the current week's games
    """
    config = EndpointConfig(
        method="GET",
        path="/api/league/schedule/current",
        operation_id="getNgsCurrentSchedule",
        request=models.GetNgsCurrentScheduleRequest(),
        response_type=models.NgsCurrentScheduleResponse,
        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 self._execute_endpoint(config)

get_current_schedule_async async

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

Get the current week's schedule (async).

Returns the schedule for the current week of the NFL season, including game times, teams, scores, and venue information.

PARAMETER	DESCRIPTION
retries	Override the default retry configuration for this request TYPE: OptionalNullable[RetryConfig] DEFAULT: UNSET
server_url	Override the default server URL for this request TYPE: Optional[str] DEFAULT: None
timeout_ms	Override the default timeout for this request TYPE: Optional[int] DEFAULT: None
http_headers	Additional headers to send with the request TYPE: Optional[Mapping[str, str]] DEFAULT: None

RETURNS	DESCRIPTION
NgsCurrentScheduleResponse	NgsCurrentScheduleResponse containing the current week's games

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

async def get_current_schedule_async(
    self,
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.NgsCurrentScheduleResponse:
    """Get the current week's schedule (async).

    Returns the schedule for the current week of the NFL season,
    including game times, teams, scores, and venue information.

    Args:
        retries: Override the default retry configuration for this request
        server_url: Override the default server URL for this request
        timeout_ms: Override the default timeout for this request
        http_headers: Additional headers to send with the request

    Returns:
        NgsCurrentScheduleResponse containing the current week's games
    """
    config = EndpointConfig(
        method="GET",
        path="/api/league/schedule/current",
        operation_id="getNgsCurrentSchedule",
        request=models.GetNgsCurrentScheduleRequest(),
        response_type=models.NgsCurrentScheduleResponse,
        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 await self._execute_endpoint_async(config)

get_teams

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

Get all NFL teams.

Returns a list of all NFL teams with their details including conference, division, stadium, and contact information.

PARAMETER	DESCRIPTION
retries	Override the default retry configuration for this request TYPE: OptionalNullable[RetryConfig] DEFAULT: UNSET
server_url	Override the default server URL for this request TYPE: Optional[str] DEFAULT: None
timeout_ms	Override the default timeout for this request TYPE: Optional[int] DEFAULT: None
http_headers	Additional headers to send with the request TYPE: Optional[Mapping[str, str]] DEFAULT: None

RETURNS	DESCRIPTION
List[TeamInfo]	List of TeamInfo objects

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

def get_teams(
    self,
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.TeamInfo]:
    """Get all NFL teams.

    Returns a list of all NFL teams with their details including
    conference, division, stadium, and contact information.

    Args:
        retries: Override the default retry configuration for this request
        server_url: Override the default server URL for this request
        timeout_ms: Override the default timeout for this request
        http_headers: Additional headers to send with the request

    Returns:
        List of TeamInfo objects
    """
    config = EndpointConfig(
        method="GET",
        path="/api/league/teams",
        operation_id="getNgsTeams",
        request=models.GetNgsTeamsRequest(),
        response_type=List[models.TeamInfo],
        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 self._execute_endpoint(config)

get_teams_async async

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

Get all NFL teams (async).

Returns a list of all NFL teams with their details including conference, division, stadium, and contact information.

PARAMETER	DESCRIPTION
retries	Override the default retry configuration for this request TYPE: OptionalNullable[RetryConfig] DEFAULT: UNSET
server_url	Override the default server URL for this request TYPE: Optional[str] DEFAULT: None
timeout_ms	Override the default timeout for this request TYPE: Optional[int] DEFAULT: None
http_headers	Additional headers to send with the request TYPE: Optional[Mapping[str, str]] DEFAULT: None

RETURNS	DESCRIPTION
List[TeamInfo]	List of TeamInfo objects

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

async def get_teams_async(
    self,
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.TeamInfo]:
    """Get all NFL teams (async).

    Returns a list of all NFL teams with their details including
    conference, division, stadium, and contact information.

    Args:
        retries: Override the default retry configuration for this request
        server_url: Override the default server URL for this request
        timeout_ms: Override the default timeout for this request
        http_headers: Additional headers to send with the request

    Returns:
        List of TeamInfo objects
    """
    config = EndpointConfig(
        method="GET",
        path="/api/league/teams",
        operation_id="getNgsTeams",
        request=models.GetNgsTeamsRequest(),
        response_type=List[models.TeamInfo],
        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 await self._execute_endpoint_async(config)

get_schedule

get_schedule(
    *,
    season: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> List[GameSchedule]

Get the full season schedule.

Returns the complete schedule for a given season, including all games from preseason through postseason.

PARAMETER	DESCRIPTION
season	The season year (e.g., 2025) TYPE: int
retries	Override the default retry configuration for this request TYPE: OptionalNullable[RetryConfig] DEFAULT: UNSET
server_url	Override the default server URL for this request TYPE: Optional[str] DEFAULT: None
timeout_ms	Override the default timeout for this request TYPE: Optional[int] DEFAULT: None
http_headers	Additional headers to send with the request TYPE: Optional[Mapping[str, str]] DEFAULT: None

RETURNS	DESCRIPTION
List[GameSchedule]	List of GameSchedule objects for the entire season

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

def get_schedule(
    self,
    *,
    season: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.GameSchedule]:
    """Get the full season schedule.

    Returns the complete schedule for a given season, including
    all games from preseason through postseason.

    Args:
        season: The season year (e.g., 2025)
        retries: Override the default retry configuration for this request
        server_url: Override the default server URL for this request
        timeout_ms: Override the default timeout for this request
        http_headers: Additional headers to send with the request

    Returns:
        List of GameSchedule objects for the entire season
    """
    config = EndpointConfig(
        method="GET",
        path="/api/league/schedule",
        operation_id="getNgsSchedule",
        request=models.GetNgsScheduleRequest(season=season),
        response_type=List[models.GameSchedule],
        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 self._execute_endpoint(config)

get_schedule_async async

get_schedule_async(
    *,
    season: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> List[GameSchedule]

Get the full season schedule (async).

Returns the complete schedule for a given season, including all games from preseason through postseason.

PARAMETER	DESCRIPTION
season	The season year (e.g., 2025) TYPE: int
retries	Override the default retry configuration for this request TYPE: OptionalNullable[RetryConfig] DEFAULT: UNSET
server_url	Override the default server URL for this request TYPE: Optional[str] DEFAULT: None
timeout_ms	Override the default timeout for this request TYPE: Optional[int] DEFAULT: None
http_headers	Additional headers to send with the request TYPE: Optional[Mapping[str, str]] DEFAULT: None

RETURNS	DESCRIPTION
List[GameSchedule]	List of GameSchedule objects for the entire season

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

async def get_schedule_async(
    self,
    *,
    season: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.GameSchedule]:
    """Get the full season schedule (async).

    Returns the complete schedule for a given season, including
    all games from preseason through postseason.

    Args:
        season: The season year (e.g., 2025)
        retries: Override the default retry configuration for this request
        server_url: Override the default server URL for this request
        timeout_ms: Override the default timeout for this request
        http_headers: Additional headers to send with the request

    Returns:
        List of GameSchedule objects for the entire season
    """
    config = EndpointConfig(
        method="GET",
        path="/api/league/schedule",
        operation_id="getNgsSchedule",
        request=models.GetNgsScheduleRequest(season=season),
        response_type=List[models.GameSchedule],
        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 await self._execute_endpoint_async(config)