NBA.Stats.TeamHistoricalLeaders (nba_api_ex v0.1.0)

View Source

Provides functions to interact with the NBA stats API for TeamHistoricalLeaders.

See get/2 for parameter and usage details.

Summary

Functions

get(params \\ [LeagueID: "00", SeasonID: nil, TeamID: nil], opts \\ [])

(since 0.1.0)

Fetches TeamHistoricalLeaders data.

Parameters

  • params: A keyword list of parameters to filter the data.

    • SeasonID: (Required) The season ID (5-digit string, e.g. "22015").

    • TeamID: (Required) The team ID.

    • LeagueID: The league ID (2-digit string).

  • opts: A keyword list of additional options for the request, such as headers or timeout settings.

Returns

  • {:ok, data}: On success, returns the data from the API.
  • {:error, reason}: On failure, returns an error tuple with the reason.

Example

iex> NBA.Stats.TeamHistoricalLeaders.get(SeasonID: "22015", TeamID: 1610612744)
{:ok, %{"TeamHistoricalLeaders" => [%{...}, ...]}}

get!(params \\ [], opts \\ [])

(since 0.1.0)