Skip to content

Schedules

griddy / nfl / endpoints / pro / schedules**

schedules

Classes

Schedules

Schedules(
    sdk_config: SDKConfiguration,
    parent_ref: Optional[object],
)

Bases: ProSDK, GameScheduleMixin


              flowchart TD
              griddy.nfl.endpoints.pro.schedules.Schedules[Schedules]
              griddy.nfl.endpoints.pro.ProSDK[ProSDK]
              griddy.nfl.basesdk.BaseSDK[BaseSDK]
              griddy.nfl.endpoints.pro.mixins.game_schedule.GameScheduleMixin[GameScheduleMixin]

                              griddy.nfl.endpoints.pro.ProSDK --> griddy.nfl.endpoints.pro.schedules.Schedules
                                griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.pro.ProSDK
                

                griddy.nfl.endpoints.pro.mixins.game_schedule.GameScheduleMixin --> griddy.nfl.endpoints.pro.schedules.Schedules
                


              click griddy.nfl.endpoints.pro.schedules.Schedules href "" "griddy.nfl.endpoints.pro.schedules.Schedules"
              click griddy.nfl.endpoints.pro.ProSDK href "" "griddy.nfl.endpoints.pro.ProSDK"
              click griddy.nfl.basesdk.BaseSDK href "" "griddy.nfl.basesdk.BaseSDK"
              click griddy.nfl.endpoints.pro.mixins.game_schedule.GameScheduleMixin href "" "griddy.nfl.endpoints.pro.mixins.game_schedule.GameScheduleMixin"
            

Game schedules, matchup rankings, and injury reports

Source code in griddy/nfl/endpoints/pro/__init__.py
def __init__(self, sdk_config: SDKConfiguration, parent_ref: Optional[object]):
    super().__init__(sdk_config=sdk_config, parent_ref=parent_ref)
    self.sdk_configuration.server_type = "pro"
Functions
get_scheduled_games
get_scheduled_games(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> GamesResponse

Get Games by Week

Retrieves all games for a specific season, season type, and week. Returns comprehensive game data including teams, venues, broadcast information, and ticket details for all games in the specified week.

:param season: Season year :param season_type: Type of season :param week: Week number within the season :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/schedules.py
def get_scheduled_games(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: int,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.GamesResponse:
    r"""Get Games by Week

    Retrieves all games for a specific season, season type, and week.
    Returns comprehensive game data including teams, venues, broadcast information,
    and ticket details for all games in the specified week.


    :param season: Season year
    :param season_type: Type of season
    :param week: Week number within the season
    :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_scheduled_games_config(
        season=season,
        season_type=season_type,
        week=week,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_scheduled_games_async async
get_scheduled_games_async(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> GamesResponse

Get Games by Week

Retrieves all games for a specific season, season type, and week. Returns comprehensive game data including teams, venues, broadcast information, and ticket details for all games in the specified week.

:param season: Season year :param season_type: Type of season :param week: Week number within the season :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/schedules.py
async def get_scheduled_games_async(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: int,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.GamesResponse:
    r"""Get Games by Week

    Retrieves all games for a specific season, season type, and week.
    Returns comprehensive game data including teams, venues, broadcast information,
    and ticket details for all games in the specified week.


    :param season: Season year
    :param season_type: Type of season
    :param week: Week number within the season
    :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_scheduled_games_config(
        season=season,
        season_type=season_type,
        week=week,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_current_week_games
get_current_week_games(
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> CurrentGamesResponse

Get Current Week Games

Retrieves all games for the current week of the NFL season. Returns comprehensive game data including teams, venues, broadcast information, scores (for completed games), and ticket details. The endpoint automatically determines the current week based on the current date.

: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/schedules.py
def get_current_week_games(
    self,
    *,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.CurrentGamesResponse:
    r"""Get Current Week Games

    Retrieves all games for the current week of the NFL season.
    Returns comprehensive game data including teams, venues, broadcast information,
    scores (for completed games), and ticket details. The endpoint automatically
    determines the current week based on the current date.


    :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_current_week_games_config(
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_current_week_games_async async
get_current_week_games_async(
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> CurrentGamesResponse

Get Current Week Games

Retrieves all games for the current week of the NFL season. Returns comprehensive game data including teams, venues, broadcast information, scores (for completed games), and ticket details. The endpoint automatically determines the current week based on the current date.

: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/schedules.py
async def get_current_week_games_async(
    self,
    *,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.CurrentGamesResponse:
    r"""Get Current Week Games

    Retrieves all games for the current week of the NFL season.
    Returns comprehensive game data including teams, venues, broadcast information,
    scores (for completed games), and ticket details. The endpoint automatically
    determines the current week based on the current date.


    :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_current_week_games_config(
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_future_betting_odds
get_future_betting_odds(
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> FuturesOddsResponseData

Get Future Betting Odds

Retrieves comprehensive betting futures data including Super Bowl odds, conference championship odds, and division winner odds for all teams. Returns decimal odds for each selection along with availability status. This endpoint provides futures market data across multiple betting hierarchies.

: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/schedules.py
def get_future_betting_odds(
    self,
    *,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.FuturesOddsResponseData:
    r"""Get Future Betting Odds

    Retrieves comprehensive betting futures data including Super Bowl odds,
    conference championship odds, and division winner odds for all teams.
    Returns decimal odds for each selection along with availability status.
    This endpoint provides futures market data across multiple betting hierarchies.


    :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_future_betting_odds_config(
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_future_betting_odds_async async
get_future_betting_odds_async(
    *,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> FuturesOddsResponseData

Get Future Betting Odds

Retrieves comprehensive betting futures data including Super Bowl odds, conference championship odds, and division winner odds for all teams. Returns decimal odds for each selection along with availability status. This endpoint provides futures market data across multiple betting hierarchies.

: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/schedules.py
async def get_future_betting_odds_async(
    self,
    *,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.FuturesOddsResponseData:
    r"""Get Future Betting Odds

    Retrieves comprehensive betting futures data including Super Bowl odds,
    conference championship odds, and division winner odds for all teams.
    Returns decimal odds for each selection along with availability status.
    This endpoint provides futures market data across multiple betting hierarchies.


    :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_future_betting_odds_config(
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_team_standings
get_team_standings(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> StandingsResponse

Get Team Standings

Retrieves comprehensive team standings for a specific season, season type, and week. Returns detailed standings information including division, conference, home/away records, win percentages, points for/against, current streaks, and clinching scenarios. Standings are calculated through the specified week.

:param season: Season year :param season_type: Type of season :param week: Week number within the season :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/schedules.py
def get_team_standings(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: int,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.StandingsResponse:
    r"""Get Team Standings

    Retrieves comprehensive team standings for a specific season, season type, and week.
    Returns detailed standings information including division, conference, home/away records,
    win percentages, points for/against, current streaks, and clinching scenarios.
    Standings are calculated through the specified week.


    :param season: Season year
    :param season_type: Type of season
    :param week: Week number within the season
    :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_team_standings_config(
        season=season,
        season_type=season_type,
        week=week,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_team_standings_async async
get_team_standings_async(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> StandingsResponse

Get Team Standings

Retrieves comprehensive team standings for a specific season, season type, and week. Returns detailed standings information including division, conference, home/away records, win percentages, points for/against, current streaks, and clinching scenarios. Standings are calculated through the specified week.

:param season: Season year :param season_type: Type of season :param week: Week number within the season :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/schedules.py
async def get_team_standings_async(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: int,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.StandingsResponse:
    r"""Get Team Standings

    Retrieves comprehensive team standings for a specific season, season type, and week.
    Returns detailed standings information including division, conference, home/away records,
    win percentages, points for/against, current streaks, and clinching scenarios.
    Standings are calculated through the specified week.


    :param season: Season year
    :param season_type: Type of season
    :param week: Week number within the season
    :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_team_standings_config(
        season=season,
        season_type=season_type,
        week=week,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_schedule_season_weeks
get_schedule_season_weeks(
    *,
    season: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> SeasonWeeksResponse

Get Season Weeks

Retrieves all weeks for a specific season including preseason, regular season, and postseason weeks. Returns week dates, types, and teams on bye for each week. This endpoint provides a comprehensive season calendar with all scheduling information.

:param season: Season year :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/schedules.py
def get_schedule_season_weeks(
    self,
    *,
    season: int,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.SeasonWeeksResponse:
    r"""Get Season Weeks

    Retrieves all weeks for a specific season including preseason, regular season,
    and postseason weeks. Returns week dates, types, and teams on bye for each week.
    This endpoint provides a comprehensive season calendar with all scheduling information.


    :param season: Season year
    :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_schedule_season_weeks_config(
        season=season,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_schedule_season_weeks_async async
get_schedule_season_weeks_async(
    *,
    season: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> SeasonWeeksResponse

Get Season Weeks

Retrieves all weeks for a specific season including preseason, regular season, and postseason weeks. Returns week dates, types, and teams on bye for each week. This endpoint provides a comprehensive season calendar with all scheduling information.

:param season: Season year :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/schedules.py
async def get_schedule_season_weeks_async(
    self,
    *,
    season: int,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.SeasonWeeksResponse:
    r"""Get Season Weeks

    Retrieves all weeks for a specific season including preseason, regular season,
    and postseason weeks. Returns week dates, types, and teams on bye for each week.
    This endpoint provides a comprehensive season calendar with all scheduling information.


    :param season: Season year
    :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_schedule_season_weeks_config(
        season=season,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)