Venues¶

griddy / nfl / endpoints / regular / football / venues**

venues ¶

Classes¶

Venues ¶

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

Bases: BaseSDK


              flowchart TD
              griddy.nfl.endpoints.regular.football.venues.Venues[Venues]
              griddy.nfl.basesdk.BaseSDK[BaseSDK]

                              griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.regular.football.venues.Venues
                


              click griddy.nfl.endpoints.regular.football.venues.Venues href "" "griddy.nfl.endpoints.regular.football.venues.Venues"
              click griddy.nfl.basesdk.BaseSDK href "" "griddy.nfl.basesdk.BaseSDK"

Source code in griddy/nfl/basesdk.py

def __init__(
    self,
    sdk_config: SDKConfiguration,
    parent_ref: Optional[object] = None,
) -> None:
    self.sdk_configuration = sdk_config
    self.parent_ref = parent_ref

Functions¶

get_venues ¶

get_venues(
    *,
    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
) -> VenuesResponse

Get NFL Venues

Retrieves information about all NFL stadiums and venues, including international venues. Provides venue details such as addresses, locations, and territories.

:param season: Season year :param limit: Maximum number of venues 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/venues.py

def get_venues(
    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.VenuesResponse:
    r"""Get NFL Venues

    Retrieves information about all NFL stadiums and venues, including international venues.
    Provides venue details such as addresses, locations, and territories.


    :param season: Season year
    :param limit: Maximum number of venues 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_venues_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_venues_async `async` ¶

get_venues_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
) -> VenuesResponse