LoLClient

League of Legends Game Client
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
BasePath:/
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Abilities

ActivePlayer

All

AllPlayers

Builtin

Champions

Events

Game

Items

Runes

Scores

Units

Abilities

Up
get /liveclientdata/activeplayerabilities
Get Abilities for the active player (getLiveclientdataActiveplayerabilities)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

ActivePlayer

Up
get /liveclientdata/activeplayer
Get all data about the active player (getLiveclientdataActiveplayer)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /liveclientdata/activeplayerabilities
Get Abilities for the active player (getLiveclientdataActiveplayerabilities)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /liveclientdata/activeplayername
Returns the player name (getLiveclientdataActiveplayername)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response String

Up
get /liveclientdata/activeplayerrunes
Retrieve the full list of runes for the active player (getLiveclientdataActiveplayerrunes)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

All

Up
get /liveclientdata/allgamedata
Get all available data (getLiveclientdataAllgamedata)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

eventID (optional)
Query Parameter — ID of the next event you expect to see format: int32

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

AllPlayers

Up
get /liveclientdata/playeritems
Retrieve the list of items for the player (getLiveclientdataPlayeritems)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

summonerName (required)
Query Parameter — Summoner name of player

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /liveclientdata/playerlist
Retrieve the list of heroes in the game and their stats (getLiveclientdataPlayerlist)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

teamID (optional)
Query Parameter — Heroes team ID. Optional, returns all players on all teams if null.

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /liveclientdata/playermainrunes
Retrieve the basic runes of any player (getLiveclientdataPlayermainrunes)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

summonerName (required)
Query Parameter — Summoner name of player

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /liveclientdata/playerscores
Retrieve the list of the current scores for the player (getLiveclientdataPlayerscores)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

summonerName (required)
Query Parameter — Summoner name of player

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /liveclientdata/playersummonerspells
Retrieve the list of the summoner spells for the player (getLiveclientdataPlayersummonerspells)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

summonerName (required)
Query Parameter — Summoner name of player

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Builtin

Up
post /AsyncDelete
Cancels the asynchronous operation or removes its completion status. (asyncDelete)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

asyncToken (required)
Query Parameter — ID of the asynchronous operation to remove format: int32

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
post /AsyncResult
Retrieves the result of a completed asynchronous operation. (asyncResult)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

asyncToken (required)
Query Parameter — ID of the asynchronous operation to check format: int32

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
post /AsyncStatus
Retrieves details on the current state of an asynchronous operation. (asyncStatus)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

asyncToken (required)
Query Parameter — ID of the asynchronous operation to check format: int32

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
post /Cancel
Attempts to cancel an asynchronous operation (cancel)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

asyncToken (required)
Query Parameter — Operation to cancel format: int32

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
post /Exit
Closes the connection. (exit)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
post /Help
Returns information on available functions and types (help)
With no arguments, returns a list of all available functions and types along with a short description. If a function or type is specified, returns detailed information about it.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

target (optional)
Query Parameter — Name of the function or type to describe
format (optional)
Query Parameter — Format for returned information

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /swagger/v1/api-docs/{api}
Retrieves the API declaration for a supported API (httpApiDeclarationV1)

Path parameters

api (required)
Path Parameter — API to get a declaration for

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /swagger/v1/api-docs
Retrieves the API documentation resource listing (httpApiDocsV1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /swagger/v2/swagger.json
Retrieves the API documentation (httpApiDocsV2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /swagger/v3/openapi.json
Retrieves the API documentation (httpApiDocsV3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
delete /async/v1/status/{asyncToken}
Cancels the asynchronous operation or removes its completion status. (httpAsyncDelete)

Path parameters

asyncToken (required)
Path Parameter — ID of the asynchronous operation to remove format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /async/v1/result/{asyncToken}
Retrieves the result of a completed asynchronous operation. (httpAsyncResult)

Path parameters

asyncToken (required)
Path Parameter — ID of the asynchronous operation to check format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /async/v1/status/{asyncToken}
Retrieves details on the current state of an asynchronous operation. (httpAsyncStatus)

Path parameters

asyncToken (required)
Path Parameter — ID of the asynchronous operation to check format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
post /Subscribe
Subscribes to a given event (subscribe)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

eventName (required)
Query Parameter — Name of the event to subscribe to
format (optional)
Query Parameter — Desired format to receive events in. If unspecified, events will be sent in the active result format at the time.

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
post /Unsubscribe
Unsubscribes from a given event (unsubscribe)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

eventName (required)
Query Parameter — Name of the event to unsubscribe from

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Champions

Up
get /liveclientdata/activeplayer
Get all data about the active player (getLiveclientdataActiveplayer)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /liveclientdata/activeplayerabilities
Get Abilities for the active player (getLiveclientdataActiveplayerabilities)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /liveclientdata/eventdata
Get a list of events that have occurred in the game (getLiveclientdataEventdata)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

eventID (optional)
Query Parameter — ID of the next event you expect to see format: int32

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /liveclientdata/playerlist
Retrieve the list of heroes in the game and their stats (getLiveclientdataPlayerlist)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

teamID (optional)
Query Parameter — Heroes team ID. Optional, returns all players on all teams if null.

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Events

Up
get /liveclientdata/eventdata
Get a list of events that have occurred in the game (getLiveclientdataEventdata)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

eventID (optional)
Query Parameter — ID of the next event you expect to see format: int32

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Game

Up
get /liveclientdata/gamestats
Basic data about the game (getLiveclientdataGamestats)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Items

Up
get /liveclientdata/playeritems
Retrieve the list of items for the player (getLiveclientdataPlayeritems)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

summonerName (required)
Query Parameter — Summoner name of player

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Runes

Up
get /liveclientdata/activeplayerrunes
Retrieve the full list of runes for the active player (getLiveclientdataActiveplayerrunes)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Up
get /liveclientdata/playermainrunes
Retrieve the basic runes of any player (getLiveclientdataPlayermainrunes)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

summonerName (required)
Query Parameter — Summoner name of player

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Scores

Up
get /liveclientdata/playerscores
Retrieve the list of the current scores for the player (getLiveclientdataPlayerscores)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

summonerName (required)
Query Parameter — Summoner name of player

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Units

Up
get /liveclientdata/playerlist
Retrieve the list of heroes in the game and their stats (getLiveclientdataPlayerlist)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

teamID (optional)
Query Parameter — Heroes team ID. Optional, returns all players on all teams if null.

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response

Models

[ Jump to Methods ]

Table of Contents

  1. AbilityResource -
  2. BindingAsyncCancelEvent -
  3. BindingAsyncFailureEvent -
  4. BindingAsyncState -
  5. BindingCallbackEvent -
  6. BindingFullApiHelp -
  7. BindingFullArgumentHelp -
  8. BindingFullEnumValueHelp -
  9. BindingFullEventHelp -
  10. BindingFullFieldHelp -
  11. BindingFullFunctionHelp -
  12. BindingFullTypeHelp -
  13. BindingFullTypeIdentifier -
  14. BindingGenericAsyncEvent -
  15. BindingGenericEvent -
  16. BindingHelpFormat -
  17. Color -
  18. RemotingHelpFormat -
  19. RemotingPrivilege -
  20. RemotingSerializedFormat -
  21. TeamID -
  22. Vector2f -
  23. Vector3f -
  24. Vector4f -

AbilityResource - Up

Ability Resource

BindingAsyncCancelEvent - Up

Represents a cancelled asynchronous operation.
asyncToken (optional)
Integer Asynchronous operation token format: int32

BindingAsyncFailureEvent - Up

Represents a failed asynchronous operation.
asyncToken (optional)
Integer Asynchronous operation token format: int32
error (optional)
String Error message

BindingAsyncState - Up

Possible states of an asynchronous operation.

BindingCallbackEvent - Up

Represents the parameters of a call to a provided callback.
id (optional)
Integer ID of the callback being invoked format: int32
parameters (optional)
array[Object] Callback parameters

BindingFullApiHelp - Up

Describes the exposed native API.
events (optional)
functions (optional)
types (optional)

BindingFullArgumentHelp - Up

Describes a function parameter.
description (optional)
name (optional)
optional (optional)
type (optional)

BindingFullEnumValueHelp - Up

Describes an enumerator.
description (optional)
name (optional)
value (optional)
Integer format: int32

BindingFullEventHelp - Up

Describes an event.
description (optional)
name (optional)
nameSpace (optional)
tags (optional)
type (optional)

BindingFullFieldHelp - Up

Describes a member of a struct.
description (optional)
name (optional)
offset (optional)
Integer format: int32
optional (optional)
type (optional)

BindingFullFunctionHelp - Up

Describes a function.
arguments (optional)
async (optional)
description (optional)
help (optional)
name (optional)
nameSpace (optional)
returns (optional)
tags (optional)
threadSafe (optional)

BindingFullTypeHelp - Up

Describes a struct or enum type.
description (optional)
fields (optional)
name (optional)
nameSpace (optional)
size (optional)
Integer format: int32
tags (optional)
values (optional)

BindingFullTypeIdentifier - Up

Describes the type of a value.
elementType (optional)
type (optional)

BindingGenericAsyncEvent - Up

Represents generic data for an asynchronous event.
asyncToken (optional)
Integer Asynchronous operation token format: int32
data (optional)
Object Event data

BindingGenericEvent - Up

Represents generic data for an event.
data (optional)
Object Event data

BindingHelpFormat - Up

Help format for binding functions and types.

Color - Up

Color
a (optional)
b (optional)
g (optional)
r (optional)

RemotingHelpFormat - Up

Help format for remoting functions and types.

RemotingPrivilege - Up

Well-known privilege levels for bindable functions.

RemotingSerializedFormat - Up

Serialization format for remoting requests and results.

TeamID - Up

Team identification

Vector2f - Up

2D vector
x (optional)
Float format: float
y (optional)
Float format: float

Vector3f - Up

3D vector
x (optional)
Float format: float
y (optional)
Float format: float
z (optional)
Float format: float

Vector4f - Up

4D vector
w (optional)
Float format: float
x (optional)
Float format: float
y (optional)
Float format: float
z (optional)
Float format: float