Server API
HomeLootLocker
HomeLootLocker
LootLocker
  1. Leaderboards
  • Session
    • Session
      POST
    • Ping
      GET
  • Leaderboards
    • Schedules
      • Create
      • Delete
      • Get
    • Rewards
      • Create
      • Delete
    • Archives
      • Download
      • List
    • Get Leaderboard
      GET
    • Create Leaderboard
      POST
    • Update Leaderboard
      PUT
    • Delete Leaderboard
      DELETE
    • Submit Score
      POST
    • Get All Member Ranks
      GET
    • Get Score List
      GET
  • Assets
    • Get Assets
      GET
  • Asset Instances
    • Get All Storage To Asset Instance
      GET
    • Get Storage Pair by ID
      GET
    • Create Storage Pair on Asset Instance
      POST
    • Update Storage Pairs by Key on Instance
      PUT
    • Update Storage Pair by ID on Instance
      PUT
    • Delete Storage Pair by ID on Instance
      DELETE
  • Triggers
    • Invoke Trigger
      POST
  • Inventories
    • List Player Inventory
      GET
    • Get Character Inventory
      GET
    • Get Hero Inventory
      GET
    • Alter Player Inventory
      PATCH
    • Add Asset to Player Inventory
      POST
    • List Universal Assets
      GET
  • Loadouts
    • Get Player Loadout
    • Equip Asset for Player Loadout
    • Unequip Asset for Player Loadout
    • Get Character Loadout
    • Equip Asset for Character Loadout
    • Unequip Asset for Character Loadout
    • Get Hero Loadout
    • Equip Asset for Hero Loadout
    • Unequip Asset for Hero Loadout
  • Characters & Heroes
    • Get Player Characters
    • Get Player Heroes
  • Player Storage
    • Get Player Storage
    • Lookup keys for Multiple Players
    • Delete for Multiple Players
    • Set for Multiple Players
  • Player Files
    • List Files for Player
    • Get File By ID for Player
    • Delete File By ID for Player
    • Upload File For Player
  • Drop Tables
    • Compute and Lock Drop Table
    • Pick Drops
  • Loot Boxes
    • Inspect Loot Box
    • Open Loot Box
  • Player
    • Get Player Info By Game Session Tokens
    • Create Player
    • Lookup Player Names by IDs
  • Progressions
    • Tiers
      • Get Progression Tiers
      • Get Single Progression Tier By Step
    • Players
      • Get All Player Progressions
      • Get Player Progressions By ID
      • 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 ID
      • 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 ID
      • Add points to Asset Instance progression
      • Subtract points from Asset Instance progression
      • Reset Asset Instance progression
      • Delete Asset Instance progression
    • Get All Progressions
    • Get Progression By Key
  • Balances
    • Create Wallet Modifiers
    • Credit Balance
    • Debit Balance
    • List Balances
    • Create New Wallet
    • Get Wallet
    • Get Wallet for Holder
  • Currency
    • List Currencies
  • Friends
    • List Friends
  • Metadata
    • Metadata Actions
    • List Metadata
    • List Multisource Metadata
  • Catalogs
    • List Catalog Items By Key
  • Notifications
    • Send Notification to Player
  1. Leaderboards

Get Leaderboard

GET
/server/leaderboards/{leaderobard_id}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.lootlocker.io/server/leaderboards/' \
--header 'x-auth-token;'
Response Response Example
{
  "leaderboard": {
    "created_at": "2024-10-03T12:31:22Z",
    "updated_at": "2024-10-03T12:31:22Z",
    "key": "",
    "direction_method": "descending",
    "name": "mylb",
    "type": "player",
    "id": 7916,
    "game_id": 2,
    "enable_game_api_writes": false,
    "overwrite_score_on_submit": true,
    "has_metadata": false,
    "schedule": {
      "cron_expression": "0 0 * * 0",
      "next_run": "2024-10-05T22:00:00Z",
      "last_run": null,
      "schedule": [
        "2024-10-05T22:00:00Z",
        "2024-10-06T00:00:00Z",
        "2024-10-13T00:00:00Z",
        "2024-10-20T00:00:00Z",
        "2024-10-27T00:00:00Z"
      ]
    },
    "rewards": [],
    "ulid": "01J995T2QPQVX4SMVCPYT3EN9J"
  }
}

Request

Authorization
API Key
Add parameter in header
x-auth-token
Example:
x-auth-token: ********************
Path Params
leaderobard_id
string 
required

Responses

🟢200Success
application/json
Body
leaderboard
object 
required
created_at
string 
required
updated_at
string 
required
key
string 
required
direction_method
string 
required
name
string 
required
type
string 
required
id
integer 
required
game_id
integer 
required
enable_game_api_writes
boolean 
required
overwrite_score_on_submit
boolean 
required
has_metadata
boolean 
required
schedule
object 
required
rewards
array[string]
required
ulid
string 
required
Modified at 2025-04-15 11:34:10
Previous
List
Next
Create Leaderboard
Built with