Skip to main content
GET
/
community
/
{id}
/
badge
/
{badgeId}
/
leaderboard
Get badge leaderboard
curl --request GET \
  --url https://api.op.xyz/v1/community/{id}/badge/{badgeId}/leaderboard \
  --header 'X-Api-Key: <api-key>'
[
  {
    "name": "<string>",
    "earnedAt": "2023-11-07T05:31:56Z",
    "claimedAt": "2023-11-07T05:31:56Z",
    "wallet": "<string>",
    "username": "<string>",
    "displayName": "<string>",
    "avatar": "<string>",
    "rewards": {},
    "metadata.[key]": {}
  }
]

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
string
required

Community ID

​
badgeId
string
required

Badge ID

Query Parameters

​
metric
enum<string>

Determines the leaderboard based on a badge metadata metric. If no metrics are available the leaderboard is returned based on ascending order the badge was earned.

Available options:
time,
score,
rank,
position,
points
​
metricDirection
enum<string>

Direction to sort the leaderboard by metric

Available options:
ASC,
DESC
​
perPage
any
​
page
any

Response

200 - application/json
​
name
string
required
​
earnedAt
string<date-time>
required
​
claimedAt
string<date-time>
required
​
wallet
string
required
​
username
string
required
​
displayName
string
required
​
avatar
string
required
​
rewards
object
required
​
metadata.[key]
object
required