Teams¶
griddy / nfl / endpoints / pro / teams**
teams
¶
Classes¶
Teams
¶
Bases: ProSDK
flowchart TD
griddy.nfl.endpoints.pro.teams.Teams[Teams]
griddy.nfl.endpoints.pro.ProSDK[ProSDK]
griddy.nfl.basesdk.BaseSDK[BaseSDK]
griddy.nfl.endpoints.pro.ProSDK --> griddy.nfl.endpoints.pro.teams.Teams
griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.pro.ProSDK
click griddy.nfl.endpoints.pro.teams.Teams href "" "griddy.nfl.endpoints.pro.teams.Teams"
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
Functions¶
get_all_teams
¶
get_all_teams(
*,
retries: OptionalNullable[RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None
) -> List[ProTeam]
Get All Teams
Retrieves information for all NFL teams including regular teams and Pro Bowl teams. Returns comprehensive team data including colors, logos, stadiums, and contact information.
: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/teams.py
get_all_teams_async
async
¶
get_all_teams_async(
*,
retries: OptionalNullable[RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None
) -> List[ProTeam]
Get All Teams
Retrieves information for all NFL teams including regular teams and Pro Bowl teams. Returns comprehensive team data including colors, logos, stadiums, and contact information.
: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/teams.py
get_team_roster
¶
get_team_roster(
*,
team_id: str,
season: int,
retries: OptionalNullable[RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None
) -> TeamRosterResponse
Get Team Roster
Retrieves the complete roster for a specific team and season. Returns detailed player information including physical attributes, college info, and experience.
:param team_id: Team identifier (4-digit string) :param season: Season year :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/teams.py
get_team_roster_async
async
¶
get_team_roster_async(
*,
team_id: str,
season: int,
retries: OptionalNullable[RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None
) -> TeamRosterResponse
Get Team Roster
Retrieves the complete roster for a specific team and season. Returns detailed player information including physical attributes, college info, and experience.
:param team_id: Team identifier (4-digit string) :param season: Season year :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/teams.py
get_weekly_team_roster
¶
get_weekly_team_roster(
*,
team_id: str,
season: int,
season_type: SeasonTypeEnum,
week: int,
retries: OptionalNullable[RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None
) -> WeeklyRosterResponse
Get Weekly Team Roster
Retrieves the roster for a specific team, season, season type, and week. Returns player information with weekly status and availability.
:param team_id: Team identifier (4-digit string) :param season: Season year :param season_type: Type of season :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/teams.py
get_weekly_team_roster_async
async
¶
get_weekly_team_roster_async(
*,
team_id: str,
season: int,
season_type: SeasonTypeEnum,
week: int,
retries: OptionalNullable[RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None
) -> WeeklyRosterResponse
Get Weekly Team Roster
Retrieves the roster for a specific team, season, season type, and week. Returns player information with weekly status and availability.
:param team_id: Team identifier (4-digit string) :param season: Season year :param season_type: Type of season :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/teams.py
get_team_schedule
¶
get_team_schedule(
*,
team_id: str,
season: int,
retries: OptionalNullable[RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None
) -> List[ScheduledGame]
Get Team Schedule
Retrieves the complete schedule for a specific team and season. Returns all games including preseason, regular season, and postseason with scores for completed games.
:param team_id: Team identifier (4-digit string) :param season: Season year :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/teams.py
get_team_schedule_async
async
¶
get_team_schedule_async(
*,
team_id: str,
season: int,
retries: OptionalNullable[RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None
) -> List[ScheduledGame]
Get Team Schedule
Retrieves the complete schedule for a specific team and season. Returns all games including preseason, regular season, and postseason with scores for completed games.
:param team_id: Team identifier (4-digit string) :param season: Season year :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/teams.py
get_multiple_rankings_all_teams
¶
get_multiple_rankings_all_teams(
*,
season: int,
season_type: SeasonTypeEnum,
stat0: str,
stat1: Optional[str] = None,
stat2: Optional[str] = None,
stat3: Optional[str] = None,
stat4: 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[MultipleRankingsCategory]
Get Multiple Rankings for All Teams
Retrieves rankings for all 32 NFL teams across multiple specified statistical categories. Allows comparison of teams across up to 5 different statistics simultaneously.
:param season: Season year :param season_type: Type of season :param stat0: First statistical category :param stat1: Second statistical category :param stat2: Third statistical category :param stat3: Fourth statistical category :param stat4: Fifth statistical category :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/teams.py
get_multiple_rankings_all_teams_async
async
¶
get_multiple_rankings_all_teams_async(
*,
season: int,
season_type: SeasonTypeEnum,
stat0: str,
stat1: Optional[str] = None,
stat2: Optional[str] = None,
stat3: Optional[str] = None,
stat4: 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[MultipleRankingsCategory]
Get Multiple Rankings for All Teams
Retrieves rankings for all 32 NFL teams across multiple specified statistical categories. Allows comparison of teams across up to 5 different statistics simultaneously.
:param season: Season year :param season_type: Type of season :param stat0: First statistical category :param stat1: Second statistical category :param stat2: Third statistical category :param stat3: Fourth statistical category :param stat4: Fifth statistical category :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.