Skip to content

Mixins

griddy / nfl / endpoints / pro / mixins**

Game-related mixin classes for Pro API endpoints.

Module Contents

Game-related mixin classes for Pro API endpoints.

Classes

GameContentMixin

Mixin for game content-related endpoints.

Functions

get_game_preview 
get_game_preview(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: int,
    visitor_display_name: str,
    home_display_name: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> GamePreviewResponse

Get Game Preview Content

Retrieves preview content and insights for a specific game based on teams and week. Returns preview information, matchup analysis, and key storylines.

:param season: Season year :param season_type: Type of season :param week: Week number :param visitor_display_name: Visiting team display name :param home_display_name: Home team display name :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_content.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
84
def get_game_preview(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: int,
    visitor_display_name: str,
    home_display_name: str,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.GamePreviewResponse:
    r"""Get Game Preview Content

    Retrieves preview content and insights for a specific game based on teams and week. Returns preview information, matchup analysis, and key storylines.

    :param season: Season year
    :param season_type: Type of season
    :param week: Week number
    :param visitor_display_name: Visiting team display name
    :param home_display_name: Home team display name
    :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_game_preview_config(
        season=season,
        season_type=season_type,
        week=week,
        visitor_display_name=visitor_display_name,
        home_display_name=home_display_name,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_game_preview_async async 
get_game_preview_async(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: int,
    visitor_display_name: str,
    home_display_name: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> GamePreviewResponse

Get Game Preview Content

Retrieves preview content and insights for a specific game based on teams and week. Returns preview information, matchup analysis, and key storylines.

:param season: Season year :param season_type: Type of season :param week: Week number :param visitor_display_name: Visiting team display name :param home_display_name: Home team display name :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_content.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
async def get_game_preview_async(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: int,
    visitor_display_name: str,
    home_display_name: str,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.GamePreviewResponse:
    r"""Get Game Preview Content

    Retrieves preview content and insights for a specific game based on teams and week. Returns preview information, matchup analysis, and key storylines.

    :param season: Season year
    :param season_type: Type of season
    :param week: Week number
    :param visitor_display_name: Visiting team display name
    :param home_display_name: Home team display name
    :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_game_preview_config(
        season=season,
        season_type=season_type,
        week=week,
        visitor_display_name=visitor_display_name,
        home_display_name=home_display_name,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_game_insights 
get_game_insights(
    *,
    season: int,
    fapi_game_id: str,
    away_team_id: str,
    home_team_id: str,
    limit: Optional[int] = 20,
    tags: Optional[str] = None,
    exclude_tags: Optional[str] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> List[GameInsight]

Get Game-Specific Insights

Retrieves analytical insights and advanced statistics for a specific game. Can filter by tags and exclude specific content types.

:param season: Season year :param fapi_game_id: FAPI Game identifier (UUID) :param away_team_id: Away team identifier :param home_team_id: Home team identifier :param limit: Maximum number of insights to return :param tags: Comma-separated list of tags to filter by :param exclude_tags: Comma-separated list of tags to exclude :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_content.py 
163
164
165
166
167
168
169
170
171
172
173
174
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
207
208
209
def get_game_insights(
    self,
    *,
    season: int,
    fapi_game_id: str,
    away_team_id: str,
    home_team_id: str,
    limit: Optional[int] = 20,
    tags: Optional[str] = None,
    exclude_tags: Optional[str] = None,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.GameInsight]:
    r"""Get Game-Specific Insights

    Retrieves analytical insights and advanced statistics for a specific game.
    Can filter by tags and exclude specific content types.


    :param season: Season year
    :param fapi_game_id: FAPI Game identifier (UUID)
    :param away_team_id: Away team identifier
    :param home_team_id: Home team identifier
    :param limit: Maximum number of insights to return
    :param tags: Comma-separated list of tags to filter by
    :param exclude_tags: Comma-separated list of tags to exclude
    :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_game_insights_config(
        season=season,
        fapi_game_id=fapi_game_id,
        away_team_id=away_team_id,
        home_team_id=home_team_id,
        limit=limit,
        tags=tags,
        exclude_tags=exclude_tags,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_game_insights_async async 
get_game_insights_async(
    *,
    season: int,
    fapi_game_id: str,
    away_team_id: str,
    home_team_id: str,
    limit: Optional[int] = 20,
    tags: Optional[str] = None,
    exclude_tags: Optional[str] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> List[GameInsight]

Get Game-Specific Insights

Retrieves analytical insights and advanced statistics for a specific game. Can filter by tags and exclude specific content types.

:param season: Season year :param fapi_game_id: FAPI Game identifier (UUID) :param away_team_id: Away team identifier :param home_team_id: Home team identifier :param limit: Maximum number of insights to return :param tags: Comma-separated list of tags to filter by :param exclude_tags: Comma-separated list of tags to exclude :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_content.py 
211
212
213
214
215
216
217
218
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
254
255
256
257
async def get_game_insights_async(
    self,
    *,
    season: int,
    fapi_game_id: str,
    away_team_id: str,
    home_team_id: str,
    limit: Optional[int] = 20,
    tags: Optional[str] = None,
    exclude_tags: Optional[str] = None,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.GameInsight]:
    r"""Get Game-Specific Insights

    Retrieves analytical insights and advanced statistics for a specific game.
    Can filter by tags and exclude specific content types.


    :param season: Season year
    :param fapi_game_id: FAPI Game identifier (UUID)
    :param away_team_id: Away team identifier
    :param home_team_id: Home team identifier
    :param limit: Maximum number of insights to return
    :param tags: Comma-separated list of tags to filter by
    :param exclude_tags: Comma-separated list of tags to exclude
    :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_game_insights_config(
        season=season,
        fapi_game_id=fapi_game_id,
        away_team_id=away_team_id,
        home_team_id=home_team_id,
        limit=limit,
        tags=tags,
        exclude_tags=exclude_tags,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)

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)

GameScheduleMixin

Mixin for game schedule-related endpoints.

These methods are designed to be mixed into classes that inherit from ProSDK/BaseSDK, which provides the helper methods (_resolve_base_url, _resolve_timeout, etc.).

Functions

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

Get Single Game Details

Retrieves detailed information for a specific game by its ID. Returns comprehensive game data including teams, score, venue, broadcast information, and current game status.

:param game_id: Game identifier (UUID format) :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_schedule.py 
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
65
66
67
68
def get_scheduled_game(
    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.GameDetail:
    r"""Get Single Game Details

    Retrieves detailed information for a specific game by its ID.
    Returns comprehensive game data including teams, score, venue, broadcast information,
    and current game status.


    :param game_id: Game identifier (UUID format)
    :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_game_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_scheduled_game_async async 
get_scheduled_game_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
) -> GameDetail

Get Single Game Details

Retrieves detailed information for a specific game by its ID. Returns comprehensive game data including teams, score, venue, broadcast information, and current game status.

:param game_id: Game identifier (UUID format) :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_schedule.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
async def get_scheduled_game_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.GameDetail:
    r"""Get Single Game Details

    Retrieves detailed information for a specific game by its ID.
    Returns comprehensive game data including teams, score, venue, broadcast information,
    and current game status.


    :param game_id: Game identifier (UUID format)
    :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_game_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_game_matchup_rankings 
get_game_matchup_rankings(
    *,
    game_id: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> MatchupRankingsResponse

Get Game Matchup Rankings

Retrieves comprehensive matchup rankings and statistical comparisons for both teams in a specific game. Returns offensive, defensive, and special teams rankings with Z-scores and advantage ratings for various statistical categories.

: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_schedule.py 
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
def get_game_matchup_rankings(
    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.MatchupRankingsResponse:
    r"""Get Game Matchup Rankings

    Retrieves comprehensive matchup rankings and statistical comparisons for both teams in a specific game.
    Returns offensive, defensive, and special teams rankings with Z-scores and advantage ratings
    for various statistical categories.


    :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_game_matchup_rankings_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_game_matchup_rankings_async async 
get_game_matchup_rankings_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
) -> MatchupRankingsResponse

Get Game Matchup Rankings

Retrieves comprehensive matchup rankings and statistical comparisons for both teams in a specific game. Returns offensive, defensive, and special teams rankings with Z-scores and advantage ratings for various statistical categories.

: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_schedule.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
async def get_game_matchup_rankings_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.MatchupRankingsResponse:
    r"""Get Game Matchup Rankings

    Retrieves comprehensive matchup rankings and statistical comparisons for both teams in a specific game.
    Returns offensive, defensive, and special teams rankings with Z-scores and advantage ratings
    for various statistical categories.


    :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_game_matchup_rankings_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_game_team_rankings 
get_game_team_rankings(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    away_team_id: str,
    home_team_id: str,
    week: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> TeamRankingsResponse

Get Team Rankings for Game

Retrieves comprehensive statistical rankings for both teams in a specific game. Returns 300+ statistical categories with rankings for offensive, defensive, and special teams performance.

:param season: Season year :param season_type: Type of season :param away_team_id: Away team UUID :param home_team_id: Home team UUID :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/pro/mixins/game_schedule.py 
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
254
255
256
257
258
259
260
def get_game_team_rankings(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    away_team_id: str,
    home_team_id: str,
    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.TeamRankingsResponse:
    r"""Get Team Rankings for Game

    Retrieves comprehensive statistical rankings for both teams in a specific game.
    Returns 300+ statistical categories with rankings for offensive, defensive, and special teams performance.


    :param season: Season year
    :param season_type: Type of season
    :param away_team_id: Away team UUID
    :param home_team_id: Home team UUID
    :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_game_team_rankings_config(
        season=season,
        season_type=season_type,
        away_team_id=away_team_id,
        home_team_id=home_team_id,
        week=week,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_game_team_rankings_async async 
get_game_team_rankings_async(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    away_team_id: str,
    home_team_id: str,
    week: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> TeamRankingsResponse

Get Team Rankings for Game

Retrieves comprehensive statistical rankings for both teams in a specific game. Returns 300+ statistical categories with rankings for offensive, defensive, and special teams performance.

:param season: Season year :param season_type: Type of season :param away_team_id: Away team UUID :param home_team_id: Home team UUID :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/pro/mixins/game_schedule.py 
262
263
264
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
297
298
299
300
301
302
async def get_game_team_rankings_async(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    away_team_id: str,
    home_team_id: str,
    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.TeamRankingsResponse:
    r"""Get Team Rankings for Game

    Retrieves comprehensive statistical rankings for both teams in a specific game.
    Returns 300+ statistical categories with rankings for offensive, defensive, and special teams performance.


    :param season: Season year
    :param season_type: Type of season
    :param away_team_id: Away team UUID
    :param home_team_id: Home team UUID
    :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_game_team_rankings_config(
        season=season,
        season_type=season_type,
        away_team_id=away_team_id,
        home_team_id=home_team_id,
        week=week,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_team_injuries 
get_team_injuries(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    team_id: str,
    week: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> InjuryReportResponse

Get Team Injuries for Game Week

Retrieves injury report information for a specific team in a given week. Returns player injury status and details for the specified team and week.

:param season: Season year :param season_type: Type of season :param team_id: Team identifier (UUID format) :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/mixins/game_schedule.py 
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
def get_team_injuries(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    team_id: str,
    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.InjuryReportResponse:
    r"""Get Team Injuries for Game Week

    Retrieves injury report information for a specific team in a given week.
    Returns player injury status and details for the specified team and week.


    :param season: Season year
    :param season_type: Type of season
    :param team_id: Team identifier (UUID format)
    :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_injuries_config(
        season=season,
        season_type=season_type,
        team_id=team_id,
        week=week,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_team_injuries_async async 
get_team_injuries_async(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    team_id: str,
    week: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> InjuryReportResponse

Get Team Injuries for Game Week

Retrieves injury report information for a specific team in a given week. Returns player injury status and details for the specified team and week.

:param season: Season year :param season_type: Type of season :param team_id: Team identifier (UUID format) :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/mixins/game_schedule.py 
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
async def get_team_injuries_async(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    team_id: str,
    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.InjuryReportResponse:
    r"""Get Team Injuries for Game Week

    Retrieves injury report information for a specific team in a given week.
    Returns player injury status and details for the specified team and week.


    :param season: Season year
    :param season_type: Type of season
    :param team_id: Team identifier (UUID format)
    :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_injuries_config(
        season=season,
        season_type=season_type,
        team_id=team_id,
        week=week,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)