Skip to content

Game Results

griddy / nfl / endpoints / pro / mixins / game_results**

game_results

Classes

GameResultsDataMixin

Mixin for game results and play data endpoints.

Functions
get_stats_boxscore 
get_stats_boxscore(
    *,
    game_id: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> BoxscoreResponse

Get Game Boxscore (Stats API)

Retrieves comprehensive boxscore data for a specific game including team statistics, individual player statistics, and scoring summary. Returns empty arrays for future games.

:param game_id: Game identifier (10-digit format YYYYMMDDNN) :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/mixins/game_results.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def get_stats_boxscore(
    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.BoxscoreResponse:
    r"""Get Game Boxscore (Stats API)

    Retrieves comprehensive boxscore data for a specific game including team statistics,
    individual player statistics, and scoring summary. Returns empty arrays for future games.


    :param game_id: Game identifier (10-digit format YYYYMMDDNN)
    :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_stats_boxscore_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_playlist 
get_playlist(
    *,
    game_id: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlaylistResponse

:param game_id: Game identifier(s) in 10-digit format (YYYYMMDDNN). Can be a single game ID or multiple game IDs for batch retrieval. :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/mixins/game_results.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def get_playlist(
    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.PlaylistResponse:
    r"""
    :param game_id: Game identifier(s) in 10-digit format (YYYYMMDDNN).  Can be a single game ID or multiple game IDs for batch retrieval.
    :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_playlist_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_summary_play 
get_summary_play(
    *,
    game_id: str,
    play_id: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlaySummaryResponse

Get Play Summary

Retrieves detailed information about a specific play in a game including play description, statistics, involved players, win probability, and expected points.

:param game_id: Game identifier (UUID format) :param play_id: Play identifier within the game :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/mixins/game_results.py 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
def get_summary_play(
    self,
    *,
    game_id: str,
    play_id: int,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.PlaySummaryResponse:
    r"""Get Play Summary

    Retrieves detailed information about a specific play in a game including play description,
    statistics, involved players, win probability, and expected points.


    :param game_id: Game identifier (UUID format)
    :param play_id: Play identifier within the game
    :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_summary_play_config(
        game_id=game_id,
        play_id=play_id,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_summary_play_async async 
get_summary_play_async(
    *,
    game_id: str,
    play_id: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlaySummaryResponse

Get Play Summary

Retrieves detailed information about a specific play in a game including play description, statistics, involved players, win probability, and expected points.

:param game_id: Game identifier (UUID format) :param play_id: Play identifier within the game :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/mixins/game_results.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
async def get_summary_play_async(
    self,
    *,
    game_id: str,
    play_id: int,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.PlaySummaryResponse:
    r"""Get Play Summary

    Retrieves detailed information about a specific play in a game including play description,
    statistics, involved players, win probability, and expected points.


    :param game_id: Game identifier (UUID format)
    :param play_id: Play identifier within the game
    :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_summary_play_config(
        game_id=game_id,
        play_id=play_id,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_plays_win_probability 
get_plays_win_probability(
    *,
    game_id: Union[GameID, GameIDTypedDict],
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlayWinProbabilityResponse

Get Game Win Probability by Plays

Retrieves comprehensive win probability data for every play in specified games. Returns pre-game win probabilities and detailed play-by-play probability changes, including Win Probability Added (WPA) metrics for each play. This advanced analytics endpoint tracks how each play impacts the probability of each team winning the game. Supports querying multiple games simultaneously.

:param game_id: Game identifier(s) in 10-digit format (YYYYMMDDNN). Can be a single game ID or multiple game IDs for batch retrieval. :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/mixins/game_results.py 
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
def get_plays_win_probability(
    self,
    *,
    game_id: Union[models.GameID, models.GameIDTypedDict],
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.PlayWinProbabilityResponse:
    r"""Get Game Win Probability by Plays

    Retrieves comprehensive win probability data for every play in specified games.
    Returns pre-game win probabilities and detailed play-by-play probability changes,
    including Win Probability Added (WPA) metrics for each play. This advanced analytics
    endpoint tracks how each play impacts the probability of each team winning the game.
    Supports querying multiple games simultaneously.


    :param game_id: Game identifier(s) in 10-digit format (YYYYMMDDNN).  Can be a single game ID or multiple game IDs for batch retrieval.
    :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_plays_win_probability_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_plays_win_probability_async async 
get_plays_win_probability_async(
    *,
    game_id: Union[GameID, GameIDTypedDict],
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlayWinProbabilityResponse

Get Game Win Probability by Plays

Retrieves comprehensive win probability data for every play in specified games. Returns pre-game win probabilities and detailed play-by-play probability changes, including Win Probability Added (WPA) metrics for each play. This advanced analytics endpoint tracks how each play impacts the probability of each team winning the game. Supports querying multiple games simultaneously.

:param game_id: Game identifier(s) in 10-digit format (YYYYMMDDNN). Can be a single game ID or multiple game IDs for batch retrieval. :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/mixins/game_results.py 
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
async def get_plays_win_probability_async(
    self,
    *,
    game_id: Union[models.GameID, models.GameIDTypedDict],
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.PlayWinProbabilityResponse:
    r"""Get Game Win Probability by Plays

    Retrieves comprehensive win probability data for every play in specified games.
    Returns pre-game win probabilities and detailed play-by-play probability changes,
    including Win Probability Added (WPA) metrics for each play. This advanced analytics
    endpoint tracks how each play impacts the probability of each team winning the game.
    Supports querying multiple games simultaneously.


    :param game_id: Game identifier(s) in 10-digit format (YYYYMMDDNN).  Can be a single game ID or multiple game IDs for batch retrieval.
    :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_plays_win_probability_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_win_probability_min 
get_win_probability_min(
    *,
    fapi_game_id: List[str],
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> WinProbabilityResponse

Get Minimal Win Probability Data

Retrieves minimal win probability data for specified games, including pregame win probabilities and play-by-play probability changes throughout the game. This endpoint provides essential win probability metrics with optimized data structure for performance. Supports multiple games in a single request.

:param fapi_game_id: Football API game identifiers (UUID format). Supports multiple game IDs to retrieve win probability data for multiple games simultaneously. :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/mixins/game_results.py 
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
346
347
348
349
350
351
def get_win_probability_min(
    self,
    *,
    fapi_game_id: List[str],
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.WinProbabilityResponse:
    r"""Get Minimal Win Probability Data

    Retrieves minimal win probability data for specified games, including pregame
    win probabilities and play-by-play probability changes throughout the game.
    This endpoint provides essential win probability metrics with optimized data
    structure for performance. Supports multiple games in a single request.


    :param fapi_game_id: Football API game identifiers (UUID format). Supports multiple game IDs to retrieve win probability data for multiple games simultaneously.
    :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_win_probability_min_config(
        fapi_game_id=fapi_game_id,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_win_probability_min_async async 
get_win_probability_min_async(
    *,
    fapi_game_id: List[str],
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> WinProbabilityResponse

Get Minimal Win Probability Data

Retrieves minimal win probability data for specified games, including pregame win probabilities and play-by-play probability changes throughout the game. This endpoint provides essential win probability metrics with optimized data structure for performance. Supports multiple games in a single request.

:param fapi_game_id: Football API game identifiers (UUID format). Supports multiple game IDs to retrieve win probability data for multiple games simultaneously. :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/mixins/game_results.py 
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
async def get_win_probability_min_async(
    self,
    *,
    fapi_game_id: List[str],
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.WinProbabilityResponse:
    r"""Get Minimal Win Probability Data

    Retrieves minimal win probability data for specified games, including pregame
    win probabilities and play-by-play probability changes throughout the game.
    This endpoint provides essential win probability metrics with optimized data
    structure for performance. Supports multiple games in a single request.


    :param fapi_game_id: Football API game identifiers (UUID format). Supports multiple game IDs to retrieve win probability data for multiple games simultaneously.
    :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_win_probability_min_config(
        fapi_game_id=fapi_game_id,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)