-
Notifications
You must be signed in to change notification settings - Fork 18
REST Service
This is an unofficial, uncomplete and (pretty sure) wrong documentation of the RESTful service which powers the League of Legends spectator mode.
This documentation is desgined to be community driven and should be extended by everyone. If you find things missing, add them please!
Riot's spectator mode works by requesting replay data via HTTP form a service. The data is split in chunks which usually contain about 30 seconds of gameplay. Additionally there are key frames which seem to contain more information then a single chunk. They seem to be used to support skipping back in time or for spectators that join the game later. This means that the key frames should contain every information about the state of a game at a given point in time. On the other hand, chunks may only contain changes to this state.
This leads to the following process for replaying a series of chunks:
- Read key frame thats prior to the targeted point in time
- Read chunk following this key frame
- apply the changes described in the chunk
- read next chunk
- repeat 3 + 4 until end of game or skip
The same procedure is known to work in many video and audio formats. It provides a fast and bandwidth saving way of deliviering all information fast while it also gives a good way to jump quickly to any point in time without the need to replay every chunk from the start to that moment.
Chunks and Keyframes are encrypted and compressed. The algorithm used for cryptography seems to be Blowfish in ECB mode. The decryption key is the observerEncryptionKey decrypted in Blowfish ECB using the gameId in ASCII as a key. Compression is done using gzip BEFORE the encryption. So to read a chunks data one needs to first decrypt then decompress the data.
Most of the REST URLs look like this:
http://<REST host:port>/observer-mode/rest/consumer/<method>/<platformId>/<gameID>/<parameter>/token
Parameters
- host:port: there are currently 9 REST services running for the different regions. A list of these servers exists at the end of this document.
- method: Name of the method you want to call. See "Methods".
- platformId: The platform ID maps to the observer host the game is hosted on. You can do a DNS lookup on the hosts (see list below) to get the IPs of the various hosts and then use the observer IP/port to lookup the correct platform ID for a given observer IP (using the table below for the mapping).
- gameID: Every game is uniquely (per platform ID) identified by this number.
- parameter: The methods first and single parameter (aside of gameid/platformId). If a method doesn't require an additional parameter this value is '1'
URL .../featured
Lists the 10 featured games for the regions supported by this server.
URL: .../version
Contains the current version for this Region.
URL: .../consumer/getGameMetaData/<platformId>/<gameID>/1/token
Returns information about the given game. This contains the games type and map, summoners involved, champions picked & banned, start time of the game and the encryption key required to read the replay data.
URL: .../consumer/getLastChunkInfo/<platformId>/<gameID>/1/token
Return some information about the last avaiable chunk:
- chunkId: ID of the last available chunk,
- availableSince: Number of ms this chunk is available (?),
- nextAvailableChunk: Number of ms until the next chunk is available (?),
- keyFrameId: key frame that belongs to this chunk,
- nextChunkId: chunk that directly follows this key frame,
- endStartupChunkId: chunk that determines the end of pick&ban phase,
- startGameChunkId: fist chunk of the actual game,
- endGameChunkId: last chunk of the actual game (or 0 if game still running),
- duration: Number of ms this chunks information represents
####getLastKeyFrameInfo(platformId, gameId) > JSON URL: .../consumer/getLastKeyFrameInfo/<platformId>/<gameId>/1/token
Returns some information about the last available key frame. It re-uses the last chunk datastructure, so some of the field names do not align with the actual contents.
- chunkId: ID of the last available key frame,
- availableSince: 0,
- nextAvailableChunk: 0,
- keyFrameId: 0,
- nextChunkId: chunk immediately following this key frame,
- endStartupChunkId: chunk that determines the end of pick&ban phase,
- startGameChunkId: 0,
- endGameChunkId: 0,
- duration: 0
URL: .../consumer/endOfGameStats/<platformId>/<gameID>/null (!)
Contains data used for the statistics screen after a game.
Example Content: http://pastebin.com/KB4TUPhs (thanks to Divi)
URL: .../consumer/getGameDataChunk/<platformId>/<gameID>/<chunkId>/token
Retrieves a chunk of data for the given game.
URL: .../consumer/getKeyFrame/<platformId>/<gameID>/<keyFrameId>/token
Retrieves a key frame for the given game.
| Name | PlatformID | Observer Host/Port | Time Zone |
|---|---|---|---|
| North America | NA1 | spectator.na.lol.riotgames.com:80 | Pacific |
| Europe West | EUW1 | spectator.euw1.lol.riotgames.com:8088 | UTC |
| Europe Nordic & East | EUN1 | spectator.eu.lol.riotgames.com:8088 | Pacific |
| Brazil | BR1 | spectator.br.lol.riotgames.com:80 | Pacific |
| Latin America North | LA1 | spectator.la1.lol.riotgames.com:80 | Pacific |
| Latin America South | LA2 | spectator.la2.lol.riotgames.com:80 | Pacific |
| Russia | RU | spectator.ru.lol.riotgames.com:80 | Pacific |
| Turkey | TR1 | spectator.tr.lol.riotgames.com:80 | Pacific |
| Oceania | OC1 | spectator.oc1.lol.riotgames.com:80 | Pacific |
| Korea | KR | QFKR1PROXY.kassad.in:8088 | Pacific |
| Taiwan | TW | QFTW1PROXY.kassad.in:8088 | China |
| Singapore | SG | qfsea1proxy.kassad.in:8088 | China |
| Public Beta Env. | PBE1 | spectator.pbe1.lol.riotgames.com:8088 | Pacific |
| XMPP/Lobby | Spectating | Data Structure |
|---|---|---|
| Chat - RTMPS Methods - REST Service | REST Service | Keyframe Specification - Chunk Specification |