Skip to content

Players

griddy / nfl / endpoints / pro / players**

players

Classes

Players 

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

Bases: ProSDK


              flowchart TD
              griddy.nfl.endpoints.pro.players.Players[Players]
              griddy.nfl.endpoints.pro.ProSDK[ProSDK]
              griddy.nfl.basesdk.BaseSDK[BaseSDK]

                              griddy.nfl.endpoints.pro.ProSDK --> griddy.nfl.endpoints.pro.players.Players
                                griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.pro.ProSDK
                



              click griddy.nfl.endpoints.pro.players.Players href "" "griddy.nfl.endpoints.pro.players.Players"
              click griddy.nfl.endpoints.pro.ProSDK href "" "griddy.nfl.endpoints.pro.ProSDK"
              click griddy.nfl.basesdk.BaseSDK href "" "griddy.nfl.basesdk.BaseSDK"
Source code in griddy/nfl/endpoints/pro/__init__.py 
 8
 9
10
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_player 
get_player(
    *,
    nfl_id: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlayerDetail

Get Player Details

Retrieves detailed information about a specific NFL player including physical attributes, team information, draft details, and current status.

:param nfl_id: NFL player identifier :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/players.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_player(
    self,
    *,
    nfl_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.PlayerDetail:
    r"""Get Player Details

    Retrieves detailed information about a specific NFL player including physical attributes,
    team information, draft details, and current status.


    :param nfl_id: NFL player identifier
    :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_player_config(
        nfl_id=nfl_id,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_player_async async 
get_player_async(
    *,
    nfl_id: int,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlayerDetail

Get Player Details

Retrieves detailed information about a specific NFL player including physical attributes, team information, draft details, and current status.

:param nfl_id: NFL player identifier :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/players.py 
66
67
68
69
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
async def get_player_async(
    self,
    *,
    nfl_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.PlayerDetail:
    r"""Get Player Details

    Retrieves detailed information about a specific NFL player including physical attributes,
    team information, draft details, and current status.


    :param nfl_id: NFL player identifier
    :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_player_config(
        nfl_id=nfl_id,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_projected_stats 
get_projected_stats(
    *,
    season: int,
    week: int,
    filter_nfl_team_id: Optional[str] = None,
    page_size: Optional[int] = 20,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> List[PlayerProjection]

Get Projected Player Statistics

Retrieves projected fantasy statistics for players based on team, season, and week. Returns data in JSON:API format with relationships between players and their projected stats.

:param season: Season year :param week: Week number within the season :param filter_nfl_team_id: Filter by NFL team ID (UUID format) :param page_size: Number of results per page :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/players.py 
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
154
155
156
157
158
159
160
161
162
163
164
def get_projected_stats(
    self,
    *,
    season: int,
    week: int,
    filter_nfl_team_id: Optional[str] = None,
    page_size: Optional[int] = 20,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.PlayerProjection]:
    r"""Get Projected Player Statistics

    Retrieves projected fantasy statistics for players based on team, season, and week.
    Returns data in JSON:API format with relationships between players and their projected stats.


    :param season: Season year
    :param week: Week number within the season
    :param filter_nfl_team_id: Filter by NFL team ID (UUID format)
    :param page_size: Number of results per page
    :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_projected_stats_config(
        season=season,
        week=week,
        filter_nfl_team_id=filter_nfl_team_id,
        page_size=page_size,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_projected_stats_async async 
get_projected_stats_async(
    *,
    season: int,
    week: int,
    filter_nfl_team_id: Optional[str] = None,
    page_size: Optional[int] = 20,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> List[PlayerProjection]

Get Projected Player Statistics

Retrieves projected fantasy statistics for players based on team, season, and week. Returns data in JSON:API format with relationships between players and their projected stats.

:param season: Season year :param week: Week number within the season :param filter_nfl_team_id: Filter by NFL team ID (UUID format) :param page_size: Number of results per page :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/players.py 
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
async def get_projected_stats_async(
    self,
    *,
    season: int,
    week: int,
    filter_nfl_team_id: Optional[str] = None,
    page_size: Optional[int] = 20,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> List[models.PlayerProjection]:
    r"""Get Projected Player Statistics

    Retrieves projected fantasy statistics for players based on team, season, and week.
    Returns data in JSON:API format with relationships between players and their projected stats.


    :param season: Season year
    :param week: Week number within the season
    :param filter_nfl_team_id: Filter by NFL team ID (UUID format)
    :param page_size: Number of results per page
    :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_projected_stats_config(
        season=season,
        week=week,
        filter_nfl_team_id=filter_nfl_team_id,
        page_size=page_size,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
search_players 
search_players(
    *,
    term: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlayerSearchResponse

Search Players

Searches for NFL players by name or term. Returns a list of players matching the search criteria including both active and retired players.

:param term: Search term for player name (first or last 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/players.py 
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
def search_players(
    self,
    *,
    term: str,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.PlayerSearchResponse:
    r"""Search Players

    Searches for NFL players by name or term. Returns a list of players matching the search criteria
    including both active and retired players.


    :param term: Search term for player name (first or last 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._search_players_config(
        term=term,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
search_players_async async 
search_players_async(
    *,
    term: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> PlayerSearchResponse

Search Players

Searches for NFL players by name or term. Returns a list of players matching the search criteria including both active and retired players.

:param term: Search term for player name (first or last 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/players.py 
258
259
260
261
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
async def search_players_async(
    self,
    *,
    term: str,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.PlayerSearchResponse:
    r"""Search Players

    Searches for NFL players by name or term. Returns a list of players matching the search criteria
    including both active and retired players.


    :param term: Search term for player name (first or last 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._search_players_config(
        term=term,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)