NBA.Stats.PlayerFantasyProfile (nba_api_ex v0.1.0)
View SourceProvides functions to interact with the NBA stats API for PlayerFantasyProfile.
See get/2 for parameter and usage details.
Summary
Functions
Fetches PlayerFantasyProfile data.
Parameters
params: A keyword list of parameters to filter the data.PlayerID: (Required) The player ID.Season: (Required) The season.- Type(s):
String - Example:
Season: "2024-25" - Default:
nil
- Type(s):
MeasureType: The type of measure.- Type(s):
String - Example:
MeasureType: "Base" - Default:
"Base" - Valueset:
"Base"
- Type(s):
PaceAdjust: Whether to adjust for pace.- Type(s):
String - Example:
PaceAdjust: "N" - Default:
"N" - Valueset:
"N"
- Type(s):
PerMode: How to aggregate stats.- Type(s):
String - Example:
PerMode: "Totals" - Default:
"Totals" - Valueset:
"Totals""PerGame""Per36"
- Type(s):
PlusMinus: Whether to include plus/minus.- Type(s):
String - Example:
PlusMinus: "N" - Default:
"N" - Valueset:
"N"
- Type(s):
Rank: Whether to include rank.- Type(s):
String - Example:
Rank: "N" - Default:
"N" - Valueset:
"N"
- Type(s):
SeasonType: The type of season.- Type(s):
String - Example:
SeasonType: "Regular Season" - Default:
"Regular Season" - Valueset:
"Regular Season""Pre Season""Playoffs"
- Type(s):
LeagueID: The league ID.- Type(s):
String - Example:
LeagueID: "00" - Default:
nil - Valueset:
"00"(NBA)"01"(ABA)"10"(WNBA)"20"(G League)
- Type(s):
opts: A keyword list of additional options for the request, such as headers or timeout settings.- For a full list of options, see the Req documentation.
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.PlayerFantasyProfile.get(PlayerID: 201939, Season: "2024-25")
{:ok, %{"PlayerFantasyProfile" => [%{...}, ...]}}