Game API
HomeLootLocker
HomeLootLocker
LootLocker
  1. Leaderboards
  • Game API
  • Authentication
    • Guest Session
      POST
    • White Label Session
      POST
    • Steam Session
      POST
    • Epic Games Session
      POST
    • Apple Sign In Session
      POST
    • Apple Game Center Session
      POST
    • Google Session
      POST
    • Nintendo Switch Session
      POST
    • Xbox Session
      POST
    • Meta/Oculus Session
      POST
    • PSN Player Verification
      POST
    • Steam/PSN Session
      POST
    • End Session
      DELETE
    • Steam Player Verification
      POST
  • Unified Player Accounts
    • Connected Accounts
      • List Connected Accounts
      • Connect Google Account
      • Connect Twitch Account
      • Connect Apple Account
      • Attach Provider
      • Transfer Providers
      • Unlink Platform Provider
    • Begin Remote Session Login Lease
      POST
    • Begin Remote Session Link Lease
      POST
    • Poll Remote Session Lease
      POST
    • Refresh Remote Session
      POST
  • White Label Login
    • Sign Up
    • Sign In
    • Request Verification
    • Request Reset Password
    • Verify Session
  • Players
    • Files
    • Player Storage
      • Get Player Storage
      • Get Player Storage Single Item
      • Get Player Public Storage
      • Update Player Storage
      • Lookup Public Player Storage
      • Delete Player Storage Item
    • Get Info From Session
    • List Multiple Players Info
    • Lookup Player Names by IDS
    • Get Players Active Name
    • Set Player Name
    • Migrate DLCs
    • Get Migrated DLCs
    • Set Player Profile Private
    • Set Player Profile Public
    • Get Other Players Loadout for Default Character
    • Get Players Loadout for Default Character
    • Delete Player
    • Submit XP
    • Get Other Player Info
    • Get Player Info
    • Get Multiple Other Players XP And Level
  • Notifications
    • List Notifications
    • Read Notifications
    • Read All Notifications
  • Commerce
    • Currency
      • Get Currency By Code
      • List Currencies
      • List Denominations By Currency
    • Purchasing
      • Stores
        • Google Play Store
          • Google Play Player Product Purchase
          • Google Play Character Product Purchase
        • Apple App Store
          • Apple App Store - Player Purchase
          • Apple App Store - Character Purchase
        • Steam
          • Steam - Begin Purchase
          • Steam - Query Transaction
          • Steam - Finalise Transaction
      • Purchase - In Game Only
      • Get Player Balance
      • Purchase - Get Status
      • Get Order Details
      • Purchase - Soft Currency Spend
      • Purchase - Steam Hard Currency
      • Purchase - Android
      • Purchase - iOS
    • Balances
      • Credit Balance
      • Debit Balance
      • List Balances
      • Get Wallet
      • Get Wallet for Holder
      • Create New Wallet
    • Catalogs
      • List Catalogs For Game
      • List Catalog Items By Key
  • Entitlements
    • List Entitlements
    • Get Single Entitlement
  • Leaderboards
    • Get Score List
      GET
    • Submit Score
      POST
    • Get Member Rank
      GET
    • Get By List of Members
      POST
    • List Leaderboards
      GET
    • Get Leaderboard Details
      GET
    • List Historical Leaderboard Data
      GET
    • Get Historical Leaderboard Data
      GET
  • Characters & Heroes
    • Characters
      • List Equippable Contexts to Default Character
      • List Equippable Contexts to Character By ID
      • Update Character
      • List Character Types
      • List Characters
      • Create Character
      • Get Loadout For All Player Characters
      • Get Loadout For Player Characters By Platform ID
      • Equip Asset To Character
      • Unequip Asset To Character
      • Equip Asset To Default Character
      • Unequip Asset To Default Character
    • Heroes
      • Get Game Heroes
      • Create Player Hero
      • List Player Heroes
      • Get Player Hero
      • Update Player Hero
      • Delete Player Hero
      • List Player Hero Inventory
      • Get Default Player Hero By SteamID64
      • List Player Heroes By SteamID64
      • List Player Heros Loadout By ID
      • Get Player Hero Loadout
      • Equip Asset to Hero
      • Unequip Asset from Hero
  • Assets
    • Drop Tables
      • Compute and Lock Drop Table
      • Pick Drops
    • List Contexts
    • Get Assets Stream
    • Get Assets List
    • Get Assets List By Asset IDs
    • List Favourite Assets
    • Unfavourite Asset
    • Favourite Asset
  • Asset Instances
    • Storage
      • Stream All Instance Storage To Player
      • Get Key Value for Asset Instance and Key Value Pair ID
      • List Key Value Sets for Asset Instance
      • Create Key Value Pair
      • Update Item Storage By Keys
      • Update Item Storage By ID
      • Delete Item Storage By ID
    • Loot Box
      • Inspect Loot Box
      • Open Loot Box
    • List Universal Assets
    • List Player Inventory
    • Stream Player Inventory
    • Get Asset Grant Notifications
    • Activate Rental Asset
    • Delete asset from player's inventory
    • Grant asset to player
  • Triggers
    • Call
    • Execute Trigger
    • List Triggers For Player
  • Progressions
    • Tiers
      • Get Progression Tiers
      • Get Single Progression Tier By Step
    • Players
      • Get All Player Progressions
      • Get All Player Progressions By Player ULID
      • Get Player Progressions By Key
      • Get Player Progressions By Key and Player ULID
      • Add points to player progression
      • Subtract points from player progression
      • Reset player progression
      • Delete player progression
    • Characters
      • Get All Character Progressions
      • Get Character Progressions By Key
      • Add points to character progression
      • Subtract points from character progression
      • Reset character progression
      • Delete character progression
    • Asset Instances
      • Get All Asset Instance Progressions
      • Get Asset Instance Progressions By Key
      • Add points to an Asset Instance progression
      • Subtract points from an Asset Instance progression
      • Reset Asset Instance progression
      • Delete Asset Instance progression
    • Get All Progressions
    • Get Progression By Key
  • Messages
    • List Messages
  • Friends
    • Followers
      • List
      • Follow
      • Unfollow
    • List Friends
    • List Incoming Friend Requests
    • List Outgoing Friend Requests
    • Send Friend Request
    • Cancel Outgoing Friend Request
    • Accept Friend Request
    • Decline Friend Request
    • Delete Friend
    • List Blocked Players
    • Block Player
    • Unblock Player
  • Feedback
    • Category
      • List
    • Moderation Reporting
      • [Legacy] Report Player
      • [Legacy] Report Asset
      • [Legacy] Get Player Report Reasons
      • [Legacy] Get Asset Report Reasons
      • [Legacy] Get Asset Report Types
      • Get Removed UGC for Player
    • Create
  • Metadata
    • List Metadata
    • Metadata Operations
    • List Multisource Metadata
  • User Generated Content (UGC)
    • Asset Candidates
      • Get Asset Candidate
      • List Asset Candidates
      • Create Asset Candidate
      • Add File to Asset Candidate
      • Update Asset Candidate
      • Delete Asset Candidate
  • Game
    • Ping
  • Collectables
    • Collect Collectable Item
    • List Collectables
  • Missions
    • Get Mission
    • List Missions
    • Start Mission
    • Finish Mission
  • Broadcasts
  1. Leaderboards

List Leaderboards

GET
/game/leaderboards
leaderboards
List all leaderboards from the game according to the provided pagination data
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.lootlocker.com/game/leaderboards?count=10' \
--header 'x-session-token;'
Response 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

Authorization
API Key
Add parameter in header
x-session-token
Example:
x-session-token: ********************
Query Params
count
number 
required
How many leaderboards to retreive in this request
Example:
10
after
number 
optional
Used when making subsequent requests to get count number of elements starting from number after
Example:
0

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)
id
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
Previous
Get By List of Members
Next
Get Leaderboard Details
Built with