godfist v0.3.0 Godfist.League

Module to interact with the League endpoint.

Link to this section Summary

Functions

Get challenger tier League mapped to queues

Get a list of the players from a league of the given Summoner id

Get master tier League mapped to queues

Get League positions in all queues for a given Summoner ID

Link to this section Functions

Link to this function challenger(region, rank_queue)
challenger(atom, atom) :: {:ok, map} | {:error, String.t}

Get challenger tier League mapped to queues.

Queues are: flex_sr, flex_tt, solo_5

Example

iex> Godfist.League.challenger(:na, :solo_5)

iex> Godfist.League.challenger(:oce, :flex_tt)
Link to this function get_all(region, sumid)
get_all(atom, integer) :: {:ok, map} | {:error, String.t}

Get a list of the players from a league of the given Summoner id.

Example

iex> Godfist.League.get_all(:lan, 123)
Link to this function master(region, rank_queue)
master(atom, atom) :: {:ok, map} | {:error, String.t}

Get master tier League mapped to queues.

See challenger/2 for a list of queues.

Example

iex> Godfist.League.master(:eune, :flex_sr)
Link to this function positions(region, sumid)
positions(atom, integer) :: {:ok, map} | {:error, String.t}

Get League positions in all queues for a given Summoner ID.

Example

iex> Godfist.League.positions(:lan, 24244)