NBA.Stats.PlayerProfileV2 (nba_api_ex v0.1.0)

View Source

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

See get/2 for parameter and usage details.

Summary

Functions

get(params \\ [PerMode: "PerGame", PlayerID: nil, LeagueID: "00"], opts \\ [])

(since 0.1.0)

Fetches PlayerProfileV2 data.

Parameters

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

    • PlayerID: (Required) The player ID.

    • PerMode: The data aggregation mode.

      • Type(s): String
      • Example: PerMode: "PerGame"
      • Default: "PerGame"
      • Valueset:
        • "Totals"
        • "PerGame"
        • "Per36"
    • LeagueID: The league ID. Defaults to "00" (NBA). Not required.

      • Type(s): String
      • Example: LeagueID: "00"
      • Default: "00"
  • 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.PlayerProfileV2.get(PerMode: "PerGame", PlayerID: 201939)
{:ok, %{"PlayerProfileV2" => [%{...}, ...]}}

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

(since 0.1.0)