Skip to main content
GET
/
val
/
console
/
ranked
/
v1
/
leaderboards
/
by-act
/
{actId}
Get Console Leaderboard
curl --request GET \
  --url https://{region}.api.riotgames.com/val/console/ranked/v1/leaderboards/by-act/{actId}
{
  "response": {}
}

​
Method Signature

await client.GET_getConsoleLeaderboard(actId, region, platformType, size=200, startIndex=0)

​
Parameters

​
actId
string
required
The act ID to retrieve the leaderboard for
​
region
string
required
The region to execute against. Valid regions: ap, br, esports, eu, kr, latam, na
​
platformType
string
required
The platform type to retrieve leaderboard for. Valid values:
  • playstation - PlayStation console
  • xbox - Xbox console
​
size
int
default:"200"
The amount of entries to retrieve. Valid values: 1 to 200
​
startIndex
int
default:"0"
The index to start from for pagination

​
Returns

​
response
Union[LeaderboardDto, Dict]
Returns a LeaderboardDto object containing the leaderboard data, or raw JSON dict if raw_data=True

​
Exceptions

  • InvalidRegion: If the provided region is invalid
  • InvalidPlatformType: If the provided platform type is invalid (must be “playstation” or “xbox”)
  • ValueError: If the size is not between 1 and 200
  • RiotAPIResponseError: If the API response indicates an error

​
Example

import asyncio
from valaw import Client

async def main():
    client = Client(token="YOUR_API_KEY", cluster="americas")
    
    # Get PlayStation leaderboard for a specific act
    ps_leaderboard = await client.GET_getConsoleLeaderboard(
        actId="52e9749a-41ae-4c84-8c88-b2b1f9e40d8c",
        region="na",
        platformType="playstation",
        size=200,
        startIndex=0
    )
    
    # Get Xbox leaderboard for the same act
    xbox_leaderboard = await client.GET_getConsoleLeaderboard(
        actId="52e9749a-41ae-4c84-8c88-b2b1f9e40d8c",
        region="na",
        platformType="xbox",
        size=100
    )
    
    # Get next page of results
    next_page = await client.GET_getConsoleLeaderboard(
        actId="52e9749a-41ae-4c84-8c88-b2b1f9e40d8c",
        region="na",
        platformType="playstation",
        size=200,
        startIndex=200
    )
    
    await client.close()

asyncio.run(main())
Console leaderboards are separate for each platform type. PlayStation and Xbox players have distinct leaderboards. For PC leaderboards, use GET_getLeaderboard.

Build docs developers (and LLMs) love

Get started for freeTalk to us