Skip to content

Receiving

griddy / nfl / endpoints / pro / stats / receiving**

receiving

Classes

PlayerReceivingStats 

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

Bases: ProSDK


              flowchart TD
              griddy.nfl.endpoints.pro.stats.receiving.PlayerReceivingStats[PlayerReceivingStats]
              griddy.nfl.endpoints.pro.ProSDK[ProSDK]
              griddy.nfl.basesdk.BaseSDK[BaseSDK]

                              griddy.nfl.endpoints.pro.ProSDK --> griddy.nfl.endpoints.pro.stats.receiving.PlayerReceivingStats
                                griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.pro.ProSDK
                



              click griddy.nfl.endpoints.pro.stats.receiving.PlayerReceivingStats href "" "griddy.nfl.endpoints.pro.stats.receiving.PlayerReceivingStats"
              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_season_summary 
get_season_summary(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    limit: Optional[int] = 35,
    offset: Optional[int] = 0,
    page: Optional[int] = 1,
    sort_key: Optional[ReceivingStatsCategoryEnum] = None,
    sort_value: Optional[SortOrderEnum] = None,
    qualified_receiver: Optional[bool] = False,
    team_offense: Optional[List[str]] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> ReceivingStatsResponse

Get Player Receiving Statistics by Season

Retrieves comprehensive receiving statistics for NFL players during a specified season.

:param season: Season year :param season_type: Type of season :param limit: Maximum number of players to return :param offset: Number of records to skip for pagination :param page: Page number for pagination :param sort_key: Field to sort by :param sort_value: Sort direction :param qualified_receiver: Filter to only qualified receivers :param team_offense: Filter by specific team IDs :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/stats/receiving.py 
 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
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def get_season_summary(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    limit: Optional[int] = 35,
    offset: Optional[int] = 0,
    page: Optional[int] = 1,
    sort_key: Optional[models.ReceivingStatsCategoryEnum] = None,
    sort_value: Optional[models.SortOrderEnum] = None,
    qualified_receiver: Optional[bool] = False,
    team_offense: Optional[List[str]] = None,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.ReceivingStatsResponse:
    r"""Get Player Receiving Statistics by Season

    Retrieves comprehensive receiving statistics for NFL players during a specified season.


    :param season: Season year
    :param season_type: Type of season
    :param limit: Maximum number of players to return
    :param offset: Number of records to skip for pagination
    :param page: Page number for pagination
    :param sort_key: Field to sort by
    :param sort_value: Sort direction
    :param qualified_receiver: Filter to only qualified receivers
    :param team_offense: Filter by specific team IDs
    :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_season_summary_config(
        season=season,
        season_type=season_type,
        limit=limit,
        offset=offset,
        page=page,
        sort_key=sort_key,
        sort_value=sort_value,
        qualified_receiver=qualified_receiver,
        team_offense=team_offense,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_season_summary_async async 
get_season_summary_async(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    limit: Optional[int] = 35,
    offset: Optional[int] = 0,
    page: Optional[int] = 1,
    sort_key: Optional[ReceivingStatsCategoryEnum] = None,
    sort_value: Optional[SortOrderEnum] = None,
    qualified_receiver: Optional[bool] = False,
    team_offense: Optional[List[str]] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> ReceivingStatsResponse

Get Player Receiving Statistics by Season

Retrieves comprehensive receiving statistics for NFL players during a specified season.

:param season: Season year :param season_type: Type of season :param limit: Maximum number of players to return :param offset: Number of records to skip for pagination :param page: Page number for pagination :param sort_key: Field to sort by :param sort_value: Sort direction :param qualified_receiver: Filter to only qualified receivers :param team_offense: Filter by specific team IDs :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/stats/receiving.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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
154
155
156
157
158
159
async def get_season_summary_async(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    limit: Optional[int] = 35,
    offset: Optional[int] = 0,
    page: Optional[int] = 1,
    sort_key: Optional[models.ReceivingStatsCategoryEnum] = None,
    sort_value: Optional[models.SortOrderEnum] = None,
    qualified_receiver: Optional[bool] = False,
    team_offense: Optional[List[str]] = None,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.ReceivingStatsResponse:
    r"""Get Player Receiving Statistics by Season

    Retrieves comprehensive receiving statistics for NFL players during a specified season.


    :param season: Season year
    :param season_type: Type of season
    :param limit: Maximum number of players to return
    :param offset: Number of records to skip for pagination
    :param page: Page number for pagination
    :param sort_key: Field to sort by
    :param sort_value: Sort direction
    :param qualified_receiver: Filter to only qualified receivers
    :param team_offense: Filter by specific team IDs
    :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_season_summary_config(
        season=season,
        season_type=season_type,
        limit=limit,
        offset=offset,
        page=page,
        sort_key=sort_key,
        sort_value=sort_value,
        qualified_receiver=qualified_receiver,
        team_offense=team_offense,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_weekly_summary 
get_weekly_summary(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: WeekSlugEnum,
    limit: Optional[int] = 50,
    offset: Optional[int] = 0,
    page: Optional[int] = 1,
    sort_key: Optional[ReceivingStatsCategoryEnum] = None,
    sort_value: Optional[SortOrderEnum] = None,
    qualified_receiver: Optional[bool] = False,
    team_offense: Optional[List[str]] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> ReceivingStatsResponse

Get Player Receiving Statistics by Week

Retrieves comprehensive receiving statistics for NFL players during a specified week.

:param season: Season year :param season_type: Type of season :param week: Week identifier :param limit: Maximum number of players to return :param offset: Number of records to skip for pagination :param page: Page number for pagination :param sort_key: Field to sort by :param sort_value: Sort direction :param qualified_receiver: Filter to only qualified receivers :param team_offense: Filter by specific team IDs :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/stats/receiving.py 
204
205
206
207
208
209
210
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
258
def get_weekly_summary(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: models.WeekSlugEnum,
    limit: Optional[int] = 50,
    offset: Optional[int] = 0,
    page: Optional[int] = 1,
    sort_key: Optional[models.ReceivingStatsCategoryEnum] = None,
    sort_value: Optional[models.SortOrderEnum] = None,
    qualified_receiver: Optional[bool] = False,
    team_offense: Optional[List[str]] = None,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.ReceivingStatsResponse:
    r"""Get Player Receiving Statistics by Week

    Retrieves comprehensive receiving statistics for NFL players during a specified week.


    :param season: Season year
    :param season_type: Type of season
    :param week: Week identifier
    :param limit: Maximum number of players to return
    :param offset: Number of records to skip for pagination
    :param page: Page number for pagination
    :param sort_key: Field to sort by
    :param sort_value: Sort direction
    :param qualified_receiver: Filter to only qualified receivers
    :param team_offense: Filter by specific team IDs
    :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_summary_config(
        season=season,
        season_type=season_type,
        week=week,
        limit=limit,
        offset=offset,
        page=page,
        sort_key=sort_key,
        sort_value=sort_value,
        qualified_receiver=qualified_receiver,
        team_offense=team_offense,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_weekly_summary_async async 
get_weekly_summary_async(
    *,
    season: int,
    season_type: SeasonTypeEnum,
    week: WeekSlugEnum,
    limit: Optional[int] = 50,
    offset: Optional[int] = 0,
    page: Optional[int] = 1,
    sort_key: Optional[ReceivingStatsCategoryEnum] = None,
    sort_value: Optional[SortOrderEnum] = None,
    qualified_receiver: Optional[bool] = False,
    team_offense: Optional[List[str]] = None,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> ReceivingStatsResponse

Get Player Receiving Statistics by Week

Retrieves comprehensive receiving statistics for NFL players during a specified week.

:param season: Season year :param season_type: Type of season :param week: Week identifier :param limit: Maximum number of players to return :param offset: Number of records to skip for pagination :param page: Page number for pagination :param sort_key: Field to sort by :param sort_value: Sort direction :param qualified_receiver: Filter to only qualified receivers :param team_offense: Filter by specific team IDs :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/stats/receiving.py 
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
async def get_weekly_summary_async(
    self,
    *,
    season: int,
    season_type: models.SeasonTypeEnum,
    week: models.WeekSlugEnum,
    limit: Optional[int] = 50,
    offset: Optional[int] = 0,
    page: Optional[int] = 1,
    sort_key: Optional[models.ReceivingStatsCategoryEnum] = None,
    sort_value: Optional[models.SortOrderEnum] = None,
    qualified_receiver: Optional[bool] = False,
    team_offense: Optional[List[str]] = None,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.ReceivingStatsResponse:
    r"""Get Player Receiving Statistics by Week

    Retrieves comprehensive receiving statistics for NFL players during a specified week.


    :param season: Season year
    :param season_type: Type of season
    :param week: Week identifier
    :param limit: Maximum number of players to return
    :param offset: Number of records to skip for pagination
    :param page: Page number for pagination
    :param sort_key: Field to sort by
    :param sort_value: Sort direction
    :param qualified_receiver: Filter to only qualified receivers
    :param team_offense: Filter by specific team IDs
    :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_summary_config(
        season=season,
        season_type=season_type,
        week=week,
        limit=limit,
        offset=offset,
        page=page,
        sort_key=sort_key,
        sort_value=sort_value,
        qualified_receiver=qualified_receiver,
        team_offense=team_offense,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)