Skip to content

Rosters

griddy / nfl / endpoints / regular / football / rosters**

rosters

Classes

Rosters 

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

Bases: BaseSDK


              flowchart TD
              griddy.nfl.endpoints.regular.football.rosters.Rosters[Rosters]
              griddy.nfl.basesdk.BaseSDK[BaseSDK]

                              griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.regular.football.rosters.Rosters
                


              click griddy.nfl.endpoints.regular.football.rosters.Rosters href "" "griddy.nfl.endpoints.regular.football.rosters.Rosters"
              click griddy.nfl.basesdk.BaseSDK href "" "griddy.nfl.basesdk.BaseSDK"
Source code in griddy/nfl/basesdk.py 
79
80
81
82
83
84
85
def __init__(
    self,
    sdk_config: SDKConfiguration,
    parent_ref: Optional[object] = None,
) -> None:
    self.sdk_configuration = sdk_config
    self.parent_ref = parent_ref
Functions
get_rosters 
get_rosters(
    *,
    season: int,
    limit: Optional[int] = 20,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> FootballRostersResponse

Get Rosters

:param season: Season year :param limit: Maximum number of results to return :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param http_headers: Additional headers to set or replace on requests.

Source code in griddy/nfl/endpoints/regular/football/rosters.py 
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
69
70
def get_rosters(
    self,
    *,
    season: int,
    limit: 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,
) -> models.FootballRostersResponse:
    r"""Get Rosters

    :param season: Season year
    :param limit: Maximum number of results to return
    :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_rosters_config(
        season=season,
        limit=limit,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_rosters_async async 
get_rosters_async(
    *,
    season: int,
    limit: Optional[int] = 20,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> FootballRostersResponse

Get Rosters

Source code in griddy/nfl/endpoints/regular/football/rosters.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
async def get_rosters_async(
    self,
    *,
    season: int,
    limit: 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,
) -> models.FootballRostersResponse:
    r"""Get Rosters"""
    config = self._get_rosters_config(
        season=season,
        limit=limit,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)