Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update league() api documentation #88

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update league() api documentation #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,12 +496,20 @@ $timeline = $match->timeline
League
------

The documentation for the League Api is not complete but it is fully functional.
The league API will view the available statistics of your current ranks, for Solo/Duo and Team 5v5/3v3. Calling `league()` will provide you the object, like the example below.

```php
$league = $api->league();
```

To make use of the league object, here's a way to grab the information, using the summoner id. Using a `true` statement in the 2nd argument will allow you to load only your own information instead of viewing a potential leaderboard, containing all of the other summoners that are in the same league you're in. The information of the other summoners will contain their league points, wins/losses, divions, series, etc.

```php
$leagues = $league->league(74602);
// or
$leagues = $league->league(74602, true);
```

Stat
----

Expand Down