NBA.Stats.FranchiseLeaders (nba_api_ex v0.1.0)

View Source

Fetches franchise leaders data from the NBA stats API.

Summary

Functions

Fetches franchise leaders data for a specific team.

Functions

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

(since 0.1.0)

Fetches franchise leaders data for a specific team.

Parameters

  • params: A keyword list of parameters for the request.

    • TeamID: (Required) The team ID.

      • Type(s): Integer, String
      • Example: TeamID: 1610612739 (Los Angeles Lakers)
    • LeagueID: The league ID (default: "00" for NBA).

      • Type(s): String
      • Example: LeagueID: "00"
      • Default: "00"
      • Valueset:
        • "00" (NBA)
        • "01" (ABA)
        • "10" (WNBA)
        • "20" (G League)
  • opts: Additional options for the request, such as headers or timeout settings.

Returns

  • {:ok, response}: A map containing the franchise leaders data.
  • {:error, reason}: An error tuple with the reason for failure.

Example

iex> NBA.Stats.FranchiseLeaders.get(TeamID: 1610612739) {:ok, %{data: [%{"Leader" => "LeBron James", "Value" => 35000}]}}

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

(since 0.1.0)