Data API/Leaderboards
stats/userLeaderboard
[edit | edit source]Returns a paginated page of the user leaderboard. The ownEntry field in the response reflects the requesting user's position on the board.
Request
{ "type": "stats/userLeaderboard", "lbType": "rank", "page": 1 }
| Field | Type | Required | Notes |
|---|---|---|---|
lbType
|
UserLeaderboardType
|
yes | see table below |
page
|
positive integer | yes | 1-based |
pageSize
|
positive integer | no | defaults to server-configured value |
stat
|
StatKey
|
if lbType is "stat"
|
which stat to rank by |
itemId
|
number | if lbType is "item"
|
which item to rank by |
trophyId
|
TrophyId
|
if lbType is "trophy"
|
which trophy to rank by |
lbType values:
| Value | Ranks by | Extra required field |
|---|---|---|
wallet
|
BC balance | — |
inventoryWorth
|
Inventory value | — |
rank
|
Rank number | — |
questLevel
|
Quest level | — |
streak
|
Daily claim streak | — |
stat
|
Any tracked stat | stat
|
item
|
Amount of a specific item | itemId
|
trophy
|
Count of a specific trophy | trophyId
|
Response — LeaderboardPage<LeaderboardUser>
stats/hoarderLeaderboard
[edit | edit source]Returns players ranked by hoarder trophy size (count of item-collector trophies held).
Request
{ "type": "stats/hoarderLeaderboard", "profileType": "main" }
| Field | Type | Required | Notes |
|---|---|---|---|
profileType
|
"all" | "main" | "ironman" | "hardcore"
|
no | Defaults to "all"
|
Response
interface HoarderLeaderboardResponse {
entries: Array<{
holder: AssociatedUser
count: number
heldSince: number // Unix ms
}>
}
stats/itemCollectorLeaderboard
[edit | edit source]Returns the current trophy holders for all collectible items.
Request
{ "type": "stats/itemCollectorLeaderboard", "profileType": "main" }
| Field | Type | Required | Notes |
|---|---|---|---|
profileType
|
"all" | "main" | "ironman" | "hardcore"
|
no | Defaults to "all"
|
Response
interface ItemCollectorLeaderboardResponse {
entries: Array<{
itemId: number
holder: AssociatedUser | null
amount: number | null
heldSince: number | null // Unix ms
}>
}
Generated from the Bconomy source documentation. Edits made on the wiki are overwritten on the next publish; ask the developers to change the source.