Skip to content

Games

griddy / nfl / endpoints / regular / football / games**

games

Classes

Games 

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

Bases: BaseSDK


              flowchart TD
              griddy.nfl.endpoints.regular.football.games.Games[Games]
              griddy.nfl.basesdk.BaseSDK[BaseSDK]

                              griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.regular.football.games.Games
                


              click griddy.nfl.endpoints.regular.football.games.Games href "" "griddy.nfl.endpoints.regular.football.games.Games"
              click griddy.nfl.basesdk.BaseSDK href "" "griddy.nfl.basesdk.BaseSDK"
Source code in griddy/nfl/basesdk.py 
79
80
81
82
83
84
85
def __init__(
    self,
    sdk_config: SDKConfiguration,
    parent_ref: Optional[object] = None,
) -> None:
    self.sdk_configuration = sdk_config
    self.parent_ref = parent_ref
Functions
get_games 
get_games(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: int,
    with_external_ids: Optional[bool] = False,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> FootballGamesResponse

Get Games by Season, Type, and Week

Retrieves game information for a specific season, season type, and week from the Football API. This endpoint provides core game data with external IDs.

:param season: Season year :param season_type: Type of season :param week: Week number :param with_external_ids: Include external IDs in response :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/regular/football/games.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def get_games(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: int,
    with_external_ids: Optional[bool] = False,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.FootballGamesResponse:
    r"""Get Games by Season, Type, and Week

    Retrieves game information for a specific season, season type, and week from the Football API.
    This endpoint provides core game data with external IDs.


    :param season: Season year
    :param season_type: Type of season
    :param week: Week number
    :param with_external_ids: Include external IDs in response
    :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_games_config(
        season=season,
        season_type=season_type,
        week=week,
        with_external_ids=with_external_ids,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_games_async async 
get_games_async(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: int,
    with_external_ids: Optional[bool] = False,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> FootballGamesResponse

Get Games by Season, Type, and Week

Source code in griddy/nfl/endpoints/regular/football/games.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
async def get_games_async(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: int,
    with_external_ids: Optional[bool] = False,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.FootballGamesResponse:
    r"""Get Games by Season, Type, and Week"""
    config = self._get_games_config(
        season=season,
        season_type=season_type,
        week=week,
        with_external_ids=with_external_ids,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_box_score 
get_box_score(
    *,
    game_id: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> BoxScoreResponse2

Get Game Box Score (Football API)

Retrieves comprehensive box score data for a specific game including team statistics, individual player statistics, and scoring summary.

:param game_id: Game identifier (UUID) :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/regular/football/games.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
def get_box_score(
    self,
    *,
    game_id: str,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.BoxScoreResponse2:
    r"""Get Game Box Score (Football API)

    Retrieves comprehensive box score data for a specific game including
    team statistics, individual player statistics, and scoring summary.


    :param game_id: Game identifier (UUID)
    :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_box_score_config(
        game_id=game_id,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_box_score_async async 
get_box_score_async(
    *,
    game_id: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> BoxScoreResponse2

Get Game Box Score (Football API)

Source code in griddy/nfl/endpoints/regular/football/games.py 
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
async def get_box_score_async(
    self,
    *,
    game_id: str,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.BoxScoreResponse2:
    r"""Get Game Box Score (Football API)"""
    config = self._get_box_score_config(
        game_id=game_id,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_play_by_play 
get_play_by_play(
    *,
    game_id: str,
    include_penalties: Optional[bool] = True,
    include_formations: Optional[bool] = False,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlayByPlayResponse

Get Play-by-Play Data

Retrieves detailed play-by-play data for a specific game including all plays, drives, scoring events, and key statistics.

:param game_id: Game identifier (UUID) :param include_penalties: Include penalty details :param include_formations: Include offensive/defensive formations :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/regular/football/games.py 
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
def get_play_by_play(
    self,
    *,
    game_id: str,
    include_penalties: Optional[bool] = True,
    include_formations: Optional[bool] = False,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.PlayByPlayResponse:
    r"""Get Play-by-Play Data

    Retrieves detailed play-by-play data for a specific game including
    all plays, drives, scoring events, and key statistics.


    :param game_id: Game identifier (UUID)
    :param include_penalties: Include penalty details
    :param include_formations: Include offensive/defensive formations
    :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_play_by_play_config(
        game_id=game_id,
        include_penalties=include_penalties,
        include_formations=include_formations,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_play_by_play_async async 
get_play_by_play_async(
    *,
    game_id: str,
    include_penalties: Optional[bool] = True,
    include_formations: Optional[bool] = False,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlayByPlayResponse

Get Play-by-Play Data

Source code in griddy/nfl/endpoints/regular/football/games.py 
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
async def get_play_by_play_async(
    self,
    *,
    game_id: str,
    include_penalties: Optional[bool] = True,
    include_formations: Optional[bool] = False,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.PlayByPlayResponse:
    r"""Get Play-by-Play Data"""
    config = self._get_play_by_play_config(
        game_id=game_id,
        include_penalties=include_penalties,
        include_formations=include_formations,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_live_game_stats 
get_live_game_stats(
    *,
    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
) -> List[GameStatsResponseData]

Get Live Game Statistics

Retrieves live game statistics and summaries for games in progress or completed games. Provides real-time statistical data for specified season, type, and week.

:param season: Season year :param season_type: Type of season :param week: Week number :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/regular/football/games.py 
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
def get_live_game_stats(
    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,
) -> List[models.GameStatsResponseData]:
    r"""Get Live Game Statistics

    Retrieves live game statistics and summaries for games in progress or completed games.
    Provides real-time statistical data for specified season, type, and week.


    :param season: Season year
    :param season_type: Type of season
    :param week: Week number
    :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_live_game_stats_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_weekly_game_details 
get_weekly_game_details(
    *,
    season: int,
    type_: SeasonTypeEnum,
    week: int,
    include_drive_chart: Optional[bool] = False,
    include_replays: Optional[bool] = False,
    include_standings: Optional[bool] = False,
    include_tagged_videos: Optional[bool] = False,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> List[WeeklyGameDetail]

Get Weekly Game Details

Retrieves detailed game information for a specific week including team standings, drive charts, replays, and tagged videos.

:param season: Season year :param type_: Season type :param week: Week number :param include_drive_chart: Include drive chart data :param include_replays: Include replay videos :param include_standings: Include team standings :param include_tagged_videos: Include tagged video content :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/regular/football/games.py 
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
def get_weekly_game_details(
    self,
    *,
    season: int,
    type_: models.SeasonTypeEnum,
    week: int,
    include_drive_chart: Optional[bool] = False,
    include_replays: Optional[bool] = False,
    include_standings: Optional[bool] = False,
    include_tagged_videos: Optional[bool] = False,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.WeeklyGameDetail]:
    r"""Get Weekly Game Details

    Retrieves detailed game information for a specific week including team standings,
    drive charts, replays, and tagged videos.


    :param season: Season year
    :param type_: Season type
    :param week: Week number
    :param include_drive_chart: Include drive chart data
    :param include_replays: Include replay videos
    :param include_standings: Include team standings
    :param include_tagged_videos: Include tagged video content
    :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_weekly_game_details_config(
        season=season,
        type_=type_,
        week=week,
        include_drive_chart=include_drive_chart,
        include_replays=include_replays,
        include_standings=include_standings,
        include_tagged_videos=include_tagged_videos,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_weekly_game_details_async async 
get_weekly_game_details_async(
    *,
    season: int,
    type_: SeasonTypeEnum,
    week: int,
    include_drive_chart: Optional[bool] = False,
    include_replays: Optional[bool] = False,
    include_standings: Optional[bool] = False,
    include_tagged_videos: Optional[bool] = False,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> List[WeeklyGameDetail]

Get Weekly Game Details

Source code in griddy/nfl/endpoints/regular/football/games.py 
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
async def get_weekly_game_details_async(
    self,
    *,
    season: int,
    type_: models.SeasonTypeEnum,
    week: int,
    include_drive_chart: Optional[bool] = False,
    include_replays: Optional[bool] = False,
    include_standings: Optional[bool] = False,
    include_tagged_videos: Optional[bool] = False,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.WeeklyGameDetail]:
    r"""Get Weekly Game Details"""
    config = self._get_weekly_game_details_config(
        season=season,
        type_=type_,
        week=week,
        include_drive_chart=include_drive_chart,
        include_replays=include_replays,
        include_standings=include_standings,
        include_tagged_videos=include_tagged_videos,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)