Riot API Libraries

https://riot-api-libraries.readthedocs.io/en/latest/
Admin
A community-driven documentation providing guidance and resources for developers to effectively use...
Tokens:5,973
Snippets:38
Trust Score:8.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Create Custom Game Lobby using LCU API

Source: https://riot-api-libraries.readthedocs.io/en/latest/lcu

This POST request demonstrates how to create a custom game lobby in the League of Legends client using the LCU API. It allows customization of game mode, lobby name, and other settings. Ensure the LCU is running and you are logged in to use this endpoint.

```http
POST
/lol-lobby/v2/lobby
{
  "customGameLobby": {
    "configuration": {
      "gameMode": "PRACTICETOOL", "gameMutator": "", "gameServerRegion": "", "mapId": 11, "mutators": {"id": 1}, "spectatorPolicy": "AllAllowed", "teamSize": 5
    },
    "lobbyName": "Name",
    "lobbyPassword": null
  },
  "isCustom": true
}


```

--------------------------------

### Simple Role and Lane to Position Mapping

Source: https://riot-api-libraries.readthedocs.io/en/latest/roleid

This method provides a basic conversion from Riot API's Role and Lane data to a more usable 'Position' format. It's straightforward but offers lower accuracy, suitable for applications where minor inaccuracies are acceptable. It relies on predefined mappings for common combinations.

```python
from collections import defaultdict

# Riot API values for Role and Lane
# Role: DUO, DUO_CARRY, DUO_SUPPORT, NONE, SOLO
# Lane: TOP_LANE, MID_LANE, BOT_LANE, JUNGLE

# Target 'Position' values: TOP, MIDDLE, JUNGLE, BOTTOM, UTILITY, APEX, NONE

# Simple mapping based on Role and Lane
role_lane_to_position_mapping = {
    ('MID_LANE', 'SOLO'): 'MIDDLE',
    ('TOP_LANE', 'SOLO'): 'TOP',
    ('JUNGLE', 'NONE'): 'JUNGLE',
    ('BOT_LANE', 'DUO_CARRY'): 'BOTTOM',
    ('BOT_LANE', 'DUO_SUPPORT'): 'UTILITY'
}

def get_position_from_mapping(lane, role):
    """Calculates position using a simple mapping."""
    return role_lane_to_position_mapping.get((lane, role), None) # Returns None if no direct mapping found

# Example Usage:
# print(get_position_from_mapping('MID_LANE', 'SOLO')) # Output: MIDDLE
# print(get_position_from_mapping('BOT_LANE', 'DUO_CARRY')) # Output: BOTTOM
# print(get_position_from_mapping('TOP_LANE', 'DUO_SUPPORT')) # Output: None (no direct mapping for this specific combo)


```

--------------------------------

### Create Normal Game Mode Lobby

Source: https://riot-api-libraries.readthedocs.io/en/latest/lcu

This endpoint is used to create a lobby for a normal game mode by specifying the queue ID.

```APIDOC
## POST /lol-lobby/v2/lobby

### Description
Creates a lobby for a normal game mode by passing the queue ID.

### Method
POST

### Endpoint
/lol-lobby/v2/lobby

### Parameters
#### Request Body
- **queueId** (integer) - Required - The ID of the queue for the desired game mode (e.g., 430 for a normal game).

### Request Example
```json
{
  "queueId": 430
}
```

### Response
#### Success Response (200)
This endpoint typically returns a success status without a detailed response body upon successful lobby creation.
```

--------------------------------

### Create Custom Game Lobby

Source: https://riot-api-libraries.readthedocs.io/en/latest/lcu

This endpoint allows you to create a custom game lobby within the League Client. You can specify game mode, map, spectator policy, and lobby name.

```APIDOC
## POST /lol-lobby/v2/lobby

### Description
Creates a custom game lobby. Supports practice tool or classic game modes.

### Method
POST

### Endpoint
/lol-lobby/v2/lobby

### Parameters
#### Request Body
- **customGameLobby** (object) - Required - Configuration for the custom lobby.
  - **configuration** (object) - Required - Game configuration details.
    - **gameMode** (string) - Required - The game mode (e.g., "PRACTICETOOL", "CLASSIC").
    - **gameMutator** (string) - Optional - The game mutator.
    - **gameServerRegion** (string) - Optional - The game server region.
    - **mapId** (integer) - Required - The map ID (e.g., 11).
    - **mutators** (object) - Optional - Mutator settings.
      - **id** (integer) - Required - The mutator ID.
    - **spectatorPolicy** (string) - Required - Spectator policy (e.g., "AllAllowed").
    - **teamSize** (integer) - Required - The size of each team.
  - **lobbyName** (string) - Required - The name of the lobby.
  - **lobbyPassword** (string|null) - Optional - The password for the lobby, if any.
- **isCustom** (boolean) - Required - Flag indicating if this is a custom game.

### Request Example
```json
{
  "customGameLobby": {
    "configuration": {
      "gameMode": "PRACTICETOOL",
      "gameMutator": "",
      "gameServerRegion": "",
      "mapId": 11,
      "mutators": {"id": 1},
      "spectatorPolicy": "AllAllowed",
      "teamSize": 5
    },
    "lobbyName": "Name",
    "lobbyPassword": null
  },
  "isCustom": true
}
```

### Response
#### Success Response (200)
This endpoint typically returns a success status without a detailed response body upon successful lobby creation.
```
Tokens:
Raw