Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 3.63 KB

README.md

File metadata and controls

90 lines (59 loc) · 3.63 KB
Raw

Since the October 1st 2014, a custom API is not fully allowed by the League of Legend's Terms of Use, only some API calls are allowed. More information : https://developer.riotgames.com

League of Legends PHP API

Unofficial RTMP API fully PHP and asynchronous for League of Legends.
With this API you can retrieve some data about summoners in real-time directly from Riot servers.

You can use the API client from this repository : https://github.com/EloGank/lol-php-api-client

Features

  • A ready-to-use API server
  • A ready-to-use Virtual Machine (no manual installation)
  • Use the powerful Symfony 2 framework components
  • Allow multi LoL account to improve the response speed
  • Fully aynschronous (with ZeroMQ & mutli process)
  • Multi region (EUW, NA, EUNE, BR, TR, RU, KR, LAN, LAS, OCE & PBE)
  • Anti-overload system (avoid temporary client ban when you make too many request)
  • Allow to use native RTMP API or custom API with our controllers
  • Fully logged in file, redis, and console (usefull for developpers)
  • Automatic restart when a server is busy
  • Periodic verification for client timeout
  • Automatic restart when a client timeout (due to network/server connection error for example)
  • Automatic update when client version is outdated
  • Allow mutliple output format (JSON, PHP native (serialized) and XML)
  • Allow concurrent connections (multiple connections at the same time, using ReactPHP)
  • Allow to bind the server to a specific IP address (allow-only)
  • Easy to override

Installation

How to install this API
Additional installation instructions for the production environment

Configuration

How to configure this API

How to use

How to use this API

Route list

The routing component

Documentation

The document is stored in the doc folder of this repository. Here, the main titles :

Important notes

Use a development account for your tests, and not your real live game account.
Be aware that only one API/person can be connected at the same time with the same account. If you have production server and development server, use two distinct accounts.

Related projects

Known issues

Reporting an issue or a feature request

Feel free to open an issue, fork this project or suggest an awesome new feature in the issue tracker.
When reporting an issue, please include your asynchronous configuration (enabled or not).

Credit

See the list of contributors.
The RTMP client class is a PHP partial rewrite of the awesome Gabriel Van Eyck's work.

Licence

Creative Commons Attribution-ShareAlike 3.0

League of Legends and Riot Games are trademarks or registered trademarks of Riot Games, Inc. League of Legends (c) Riot Games, Inc.