Game API

List Leaderboards

GET

https://api.lootlocker.com/game/leaderboards

leaderboards

List all leaderboards from the game according to the provided pagination data

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.lootlocker.com/game/leaderboards?count=10' \
--header 'x-session-token;'

Response Example

200 - Example 1

{
  "pagination": {
    "previous_cursor": 0,
    "total": 0,
    "next_cursor": 0
  },
  "items": [
    {
      "created_at": "string",
      "updated_at": "string",
      "key": "string",
      "direction_method": "string",
      "name": "string",
      "type": "string",
      "id": 0,
      "ulid": "string",
      "game_id": 0,
      "enable_game_api_writes": true,
      "overwrite_score_on_submit": true,
      "has_metadata": true,
      "schedule": {
        "cron_expression": "string",
        "next_run": "string",
        "last_run": "string",
        "schedule": [
          "string"
        ]
      },
      "rewards": [
        {
          "reward_kind": "string",
          "predicates": [
            {
              "id": "string",
              "type": "string",
              "args": {
                "max": 0,
                "min": 0,
                "method": "string",
                "direction": "string"
              }
            }
          ],
          "currency": {
            "created_at": "string",
            "updated_at": "string",
            "amount": 0,
            "details": {
              "name": "string",
              "code": "string",
              "amount": 0,
              "id": "string"
            },
            "reward_id": "string",
            "currency_id": "string"
          },
          "progression_reset": {
            "created_at": "string",
            "updated_at": "string",
            "details": {
              "key": "string",
              "name": "string",
              "id": "string"
            },
            "progression_id": "string",
            "reward_id": "string"
          },
          "progression_points": {
            "created_at": "string",
            "updated_at": "string",
            "details": {
              "key": "string",
              "name": "string",
              "amount": 0,
              "id": "string"
            },
            "amount": 0,
            "progression_id": "string",
            "reward_id": "string"
          },
          "asset": {
            "created_at": "string",
            "updated_at": "string",
            "details": {
              "name": "string",
              "thumbnail": "string",
              "variation_name": "string",
              "rental_option_name": "string",
              "variation_id": 0,
              "rental_option_id": 0,
              "legacy_id": 0,
              "id": "string"
            },
            "asset_variation_id": 0,
            "asset_rental_option_id": 0,
            "asset_id": 0,
            "reward_id": "string",
            "asset_ulid": "string"
          },
          "group": {
            "created_at": "string",
            "name": "string",
            "description": "string",
            "associations": [
              {
                "reward_kind": "string",
                "currency": {
                  "created_at": "string",
                  "updated_at": "string",
                  "amount": 0,
                  "details": {
                    "name": "string",
                    "code": "string",
                    "amount": 0,
                    "id": "string"
                  },
                  "reward_id": "string",
                  "currency_id": "string"
                },
                "progression_reset": {
                  "created_at": "string",
                  "updated_at": "string",
                  "details": {
                    "key": "string",
                    "name": "string",
                    "id": "string"
                  },
                  "progression_id": "string",
                  "reward_id": "string"
                },
                "progression_points": {
                  "created_at": "string",
                  "updated_at": "string",
                  "details": {
                    "key": "string",
                    "name": "string",
                    "amount": 0,
                    "id": "string"
                  },
                  "amount": 0,
                  "progression_id": "string",
                  "reward_id": "string"
                },
                "asset": {
                  "created_at": "string",
                  "updated_at": "string",
                  "details": {
                    "name": "string",
                    "thumbnail": "string",
                    "variation_name": "string",
                    "rental_option_name": "string",
                    "variation_id": 0,
                    "rental_option_id": 0,
                    "legacy_id": 0,
                    "id": "string"
                  },
                  "asset_variation_id": 0,
                  "asset_rental_option_id": 0,
                  "asset_id": 0,
                  "reward_id": "string",
                  "asset_ulid": "string"
                }
              }
            ],
            "reward_id": "string"
          },
          "reward_id": "string"
        }
      ]
    }
  ]
}

Request

Query Params

count

number

required

How many leaderboards to retreive in this request

Example:

after

number

optional

Used when making subsequent requests to get count number of elements starting from number after

Example:

Header Params

x-session-token

string

required

Your session token will be an opaque string.

Default:

Responses

🟢200OK

application/json

Body

Response object holding details about the requested leaderboards

pagination

object

required

Pagination data for this request

previous_cursor

integer | null

required

A cursor pointing to the previous page according to the current page size (count) and cursor (after)

total

integer

required

The total number of elements available to paginate through

next_cursor

integer

required

A cursor pointing to the next page according to the current page size (count) and cursor (after)

items

array [object {14}]

required

A list of leaderboard information objects

created_at

string

required

When this leaderboard was created

updated_at

string

required

When this leaderboard was last updated

key

string

required

The key of this leaderboard (if any has been set)

direction_method

string

required

The direction of the Leaderboard (Ascending / Descending)

name

string

required

The name of the Leaderboard

type

string

required

The type of the Leaderboard (Player / Generic)

integer

required

The integer id of this leaderboard

ulid

string

required

The ulid for this leaderboard

game_id

integer

required

The id of the game that this leaderboard is on

enable_game_api_writes

boolean

required

Whether this leaderboard allows writes from the game api

overwrite_score_on_submit

boolean

required

Will the score be overwritten even if it was less than the original score

has_metadata

boolean

required

Does the Leaderboard have metadata

schedule

object | null

optional

Schedule of the Leaderboard

rewards

array [object {8}] | null

optional

A List of rewards tied to the Leaderboard

🟠403Forbidden

Modified at 2025-01-23 21:10:01

Get By List of Members

Get Leaderboard Details