Get Leaderboard

GET 
/leaderboard/v1/leaderboard/:leaderboard_id

Get a paged response for a leaderboard

Request

Path Parameters

leaderboard_id Leaderboard Idrequired

Query Parameters

cursor Cursorrequired

Possible values: non-empty

Cursor for which page of leaderboard data you would like to retrieve

page_size Page Sizerequired

Possible values: <= 50

The desired page size for the results

player_uuid any

UUID of the player whose leaderboard data is being retrieved. Required for friend leaderboards

Responses

200

Successful Response

application/json

Schema

Schema

leaderboard_id Leaderboard Id (string)required

Possible values: non-empty and <= 128 characters

Which leaderboard config is used for this leaderboard

cursor Cursor (string)required

Possible values: non-empty

The cursor for the next page of results. 0 means there are no more

entries

object[]

required

List of leaderboard entries

Array [

player_uuid uuidrequired

Unique ID for the player in this leaderboard entry

stat_value

object

Value for the stat of this leaderboard entry

anyOf

MOD1

number

position Position (integer)required

Possible values: >= 1

What position this entry is on the leaderboard

]

Example (from schema)

{
  "leaderboard_id": "string",
  "cursor": "string",
  "entries": [
    {
      "player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "stat_value": 0,
      "position": 0
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

404

Not Found

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...