NBA.Stats.AllTimeLeadersGrids (nba_api_ex v0.1.0)
View SourceHandles requests to the all-time leader grids endpoint.
Summary
Functions
Fetches all-time leader grids for the specified league and season type.
Functions
Fetches all-time leader grids for the specified league and season type.
Parameters
- params: A keyword list of parameters. Defaults to- @default.- LeagueID: The league ID.- Type: Numeric String
- Default: "00"(NBA)
- Example: LeagueID: "10"(for WNBA).
- Valueset:- "00"(NBA)
- "01"(ABA)
- "10"(WNBA)
- "20"(G-League)
 
 
- Type: Numeric 
- PerMode: The statistic mode.- Type: String
- Default: "Totals"
- Example: PerMode: "PerGame"for per-game statistics.
- Valueset:- "Totals"
- "PerGame"
 
 
- Type: 
- SeasonType: Type of season.- Type: String
- Default: "Regular Season"
- Example: SeasonType: "Playoffs"for playoff statistics.
- Valueset:- "Regular Season"
- "Playoffs"
 
 
- Type: 
- TopX: The number of top leaders to return.- Type: Integer
- Default: 10
- Example: TopX: 20to get the top 20 leaders.
 
- Type: 
 
- opts: A keyword list of additional options for the request, such as headers or timeout settings.- For a list of available options, see the Req documentation.
 
Example
iex> NBA.Stats.AllTimeLeadersGrids.get()
{:ok, %{"PTSLeaders" => [...], "ASTLeaders" => [...], ...}}Returns
- {:ok, response}: A tuple containing the status and parsed response body.
- {:error, reason}: An error tuple with the reason for failure.