Loyi API Reference
  1. Leaderboard
Loyi API Reference
  • Getting Started
  • Architecture
  • User
    • Users Overview
    • Create user
      POST
    • Get users
      GET
    • Get user
      GET
    • Update user
      PUT
    • Delete user
      DELETE
  • Reward
    • Rewards Overview
    • Create reward
      POST
    • Get rewards
      GET
    • Delete reward
      DELETE
    • Create entry pass code
      POST
    • Get entry pass code
      GET
    • Airdrop reward
      PUT
    • Award reward
      POST
    • Redeem rewards
      GET
  • Collection
    • Collection Overview
    • Create collection
      POST
    • Get collections
      GET
    • Get collection
      GET
    • Update collection
      PUT
    • Delete collection
      DELETE
    • Get rewards
      GET
  • Collectible
    • Claim collectible
    • Get collectibles
  • Quest
    • Quest Overview
    • Create quest
    • Get quests
    • Get quest
    • Update quest
    • Delete quest
    • Get participants
    • Accept quest
    • Submit answers
    • Get answers
  • Leaderboard
    • Leaderboard Overview
    • Get leaderboard
      GET
  • Leveling
    • Get leveling configuration
    • Configure leveling
    • Get milestone levels
    • Create milestone level
    • Get milestone level
    • Update milestone level
    • Delete milestone level
  1. Leaderboard

Get leaderboard

Staging
https://testserver.loyi.io/public/api
Staging
https://testserver.loyi.io/public/api
GET
/leaderboard
Leaderboard
Returns a list of users usernames and owned token amounts sorted by token amount.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Header Params
Origin
string 
required
The value must be one of the whitelisted domains. You can whitelist domain URLs on your Loyi dashboard.
Default:
<WHITELISTED_URL>
Example:
https://example.com

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://testserver.loyi.io/public/api/leaderboard' \
--header 'Origin;' \
--header 'x-api-key;'

Responses

🟢200OK
application/json
An array of users.
Body
A list of users and their token amounts.
array of:
id
string 
optional
ID of the user.
collectiblesCount
number 
optional
The amount of collectibles the user has.
Example
[
    {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "collectiblesCount": 14
    }
]
🟠401Unauthorized
Modified at 2025-06-19 21:23:41
Previous
Leaderboard Overview
Next
Get leveling configuration
Built with