Fetches league game finder data.

Parameters

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

  • Note: This endpoint also supports a wide range of advanced stat filters in the form of LtX, GtX, and EqX (e.g., LtPTS, GtAST, EqREB), where X is a stat name. These accept Integer or Float values and default to nil.

    • LtX: "Less than" filter for statistic X.

      • Type(s): Integer | Float

      • Example: LtPTS: 20
      • Default: nil
    • GtX: "Greater than" filter for statistic X.

      • Type(s): Integer | Float

      • Example: GtPTS: 30
      • Default: nil
    • EqX: "Equal to" filter for statistic X.

      • Type(s): Integer | Float

      • Example: EqPTS: 25
      • Default: nil

  • PlayerID: (Required) The NBA player ID.

    • Type(s): Integer | String

    • Example: PlayerID: 201939
    • Default: nil

  • Season: (Required) The season for which to fetch data.

    • Type(s): String
    • Example: Season: "2024-25"
    • Default: nil

  • ActiveStreaksOnly: Filter for active streaks only.

    • Type(s): String
    • Example: ActiveStreaksOnly: "Y"
    • Default: "N"
    • Valueset:
      • "Y" (Yes)
      • "N" (No)

  • Conference: The conference of the team.

    • Type(s): String
    • Example: Conference: "West"
    • Default: nil
    • Valueset:
      • "East"
      • "West"

  • DateFrom: Start date filter (format: "MM/DD/YYYY").

    • Type(s): String
    • Example: DateFrom: "01/01/2024"
    • Default: nil

  • DateTo: End date filter (format: "MM/DD/YYYY").

    • Type(s): String
    • Example: DateTo: "01/31/2024"
    • Default: nil

  • Division: The division of the team.

    • Type(s): String
    • Example: Division: "Pacific"
    • Default: nil
    • Valueset:
      • "Atlantic"
      • "Central"
      • "Southeast"
      • "Northwest"
      • "Pacific"
      • "Southwest"

  • DraftNumber: The draft number.

    • Type(s): Integer
    • Example: DraftNumber: 1
    • Default: nil

  • DraftRound: The draft round.

    • Type(s): Integer
    • Example: DraftRound: 1
    • Default: nil

  • DraftTeamID: The draft team ID.

    • Type(s): Integer | String

    • Example: DraftTeamID: 1610612747
    • Default: nil

  • DraftYear: The draft year of the player.

    • Type(s): Integer
    • Example: DraftYear: 2019
    • Default: nil

  • GameID: The NBA game ID.

    • Type(s): String
    • Example: GameID: "0022100001"
    • Default: nil

  • GameSegment: The segment of the game.

    • Type(s): String
    • Example: GameSegment: "First Half"
    • Default: nil
    • Valueset:
      • "First Half"
      • "Second Half"
      • "Overtime"

  • LeagueID: The league ID.

    • Type(s): String
    • Example: LeagueID: "00"
    • Default: "00"
    • Valueset:
      • "00" (NBA)
      • "01" (ABA)
      • "10" (WNBA)
      • "20" (G-League)

  • Location: Game location ("Home", "Away", or nil for all).

    • Type(s): String
    • Example: Location: "Home"
    • Default: nil
    • Valueset:
      • "Home"
      • "Away"

  • MinGames: Minimum number of games played.

    • Type(s): Integer
    • Example: MinGames: 5
    • Default: 0

  • Outcome: Game outcome ("W", "L", or nil for all).

    • Type(s): String
    • Example: Outcome: "W"
    • Default: nil
    • Valueset:
      • "W"
      • "L"

  • PORound: The playoff round (0 for regular season).

    • Type(s): Integer
    • Example: PORound: 0
    • Default: 0

  • RookieYear: The rookie year of the player.

    • Type(s): String
    • Example: RookieYear: "2019"
    • Default: nil

  • SeasonSegment: Season segment ("Post All-Star", "Pre All-Star", or nil).

    • Type(s): String
    • Example: SeasonSegment: "Post All-Star"
    • Default: nil
    • Valueset:
      • "Post All-Star"
      • "Pre All-Star"

  • SeasonType: The type of season.

    • Type(s): String
    • Example: SeasonType: "Regular Season"
    • Default: "Regular Season"
    • Valueset:
      • "Regular Season"
      • "Playoffs"
      • "Pre Season"
      • "All Star"

  • StarterBench: Whether the player is a starter or bench.

    • Type(s): String
    • Example: StarterBench: "Bench"
    • Default: nil
    • Valueset:
      • "Starter"
      • "Bench"

  • TeamID: Team ID (0 for all teams).

    • Type(s): Integer | String

    • Example: TeamID: 0
    • Default: 0

  • VsConference: Opponent conference filter ("East", "West", or nil).

    • Type(s): String
    • Example: VsConference: "West"
    • Default: nil
    • Valueset:
      • "East"
      • "West"

  • VsDivision: Opponent division filter (e.g., "Atlantic", "Central", etc., or nil).

    • Type(s): String
    • Example: VsDivision: "Central"
    • Default: nil
    • Valueset:
      • "Atlantic"
      • "Central"
      • "Southeast"
      • "Northwest"
      • "Pacific"
      • "Southwest"

  • VsTeamID: The opposing team ID.

    • Type(s): Integer | String

    • Example: VsTeamID: 1610612747
    • Default: nil

  • YearsExperience: Years of NBA experience.

    • Type(s): Integer
    • Example: YearsExperience: 5
    • Default: nil

• 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.LeagueGameFinder.get(LeagueID: "00", PlayerOrTeam: "P")
{:ok, %{"LeagueGameFinder" => [%{...}, ...]}}