README.md

# ElixirNba
  https://hex.pm/packages/nba/


  Elixir implementation of bttmly/nba-client-template

  stats.nba.com uses a large number of undocumented JSON endpoints
  to provide the statistics tables and charts displayed therein.
  This library provides an Elixir client for interacting with many
  of those API endpoints.

  Currently, only the `stats` namespace is available via this library.
  `sportsVu` and `synergy` namespaces are on the todo list.

  ## Installation

  Add NBA to your mix.exs dependencies:

  ```elixir
  def deps do
    [{:nba, "~> 0.2.4"}]
  end
  ```

  ## Examples
  See what endpoints you can hit:

  ```elixir
  Nba.Stats.endpoints()
  #=> [:assist_tracker, :box_score, :player_info, ...]
  ```

  Each endpoint has two corresponding functions, one with an
  arity of 0 and one with an arity of 1. The 0-arity functions
  return a list of the available query parameters for
  its endpoint.

  ```elixir
  Nba.Stats.player_info()
  #=> ["PlayerID", "SeasonType", "LeagueID"]
  ```

  Now that you know what query params you can pass, let's make
  a call to the endpoint by passing in a map of query param
  key/values.

  ```elixir
  Nba.Stats.player_info(%{"PlayerID" => 1627742})
  ```

  If you need example values for a query param, use `Nba.Stats.param_values_for/1`.

  ```elixir
  Nba.Stats.param_values_for("AheadBehind")
  #=> ["Ahead or Behind", "Ahead or Tied", "Behind or Tied", ""]
  ```