blitzcrank
A Clojure implementation of the public League of Legends API. No access to tournament API yet.
Usage
Add the library to your project as below:
Leiningen/Boot
[blitzcrank "0.1.5"]
Gradle
compile "blitzcrank:blitzcrank:0.1.5"
Maven
<dependency>
<groupId>blitzcrank</groupId>
<artifactId>blitzcrank</artifactId>
<version>0.1.5</version>
</dependency>
API methods are located in the blitzcrank.endpoints
namespace.
Example
user=> (require '[blitzcrank.endpoints.summoner :as summoner])
=> nil
user=> (summoner/by-name "Instadrone" {:api-key "AVALIDKEY"})
Attempting to get https://euw1.api.riotgames.com/lol/summoner/v3/summoners/by-name/Instadrone
=>
{:id 44040660,
:accountId 37951631,
:name "Instadrone",
:profileIconId 1666,
:revisionDate 1497913390000,
:summonerLevel 30}
Feature parity
Feature | Status |
---|---|
champion-mastery-v3 | Implemented |
champion-v3 | Implemented |
league-v3 | Implemented |
static-data-v3 | Not yet implemented |
lol-status-v3 | Implemented |
masteries-v3 | Implemented |
match-v3 | Not yet implemented |
runes-v3 | Implemented |
spectator-v3 | Not yet implemented |
summoner-v3 | Implemented |
Config
Default configuration can be provided by supplying a config.edn
file within a resource-path
(the top-level resources
directory is provided) by default. Further paths can be adding by adding a :profile
map to
project.clj
as below:
:profiles {:prod {:resource-paths ["config/prod"]}
:dev {:resource-paths ["config/dev"]}}
Currently supported options are:
api-key
Primarily used for testing, but can also be used to simplify the application. Every call to an API method will attempt to read this value if no argument is passed.
Default: None, must be entered by user if desired.
region
Default region to use for API calls. As before, every call to an API method can be called with a region. Setting this to your largest projected userbase would be a sensible idea.
Default: euw1
locale
This is used by the lol-status
endpoint in order to attempt to get a localized version of a status message.
Default: en_GB
Development
Run in a REPL with lein repl
.
Documentation
API documentation is available online and offline,
generated using codox. Generate using lein codox
, which by default will output
the docs to docs
.
License
Copyright © 2017 Ellis Kenyő
Distributed under the BSD 3 Clause.