TheCarriedOne: Publish from docs/data-api.md

2026-11-02T12:19:58Z

Publish from docs/data-api.md

New page

[[Data API|Data API]] · [[Data API/Types|Types]]

== <code><nowiki>stats/userLeaderboard</nowiki></code> ==

Returns a paginated page of the user leaderboard. The <code><nowiki>ownEntry</nowiki></code> field in the response reflects the requesting user's position on the board.

Request

<pre>{ "type": "stats/userLeaderboard", "lbType": "rank", "page": 1 }</pre>

{| class="wikitable"
|-
! Field
! Type
! Required
! Notes
|-
| <code><nowiki>lbType</nowiki></code>
| [[Data API/Types#UserLeaderboardType|<code><nowiki>UserLeaderboardType</nowiki></code>]]
| yes
| see table below
|-
| <code><nowiki>page</nowiki></code>
| positive integer
| yes
| 1-based
|-
| <code><nowiki>pageSize</nowiki></code>
| positive integer
| no
| defaults to server-configured value
|-
| <code><nowiki>stat</nowiki></code>
| <code><nowiki>StatKey</nowiki></code>
| if <code><nowiki>lbType</nowiki></code> is <code><nowiki>"stat"</nowiki></code>
| which stat to rank by
|-
| <code><nowiki>itemId</nowiki></code>
| number
| if <code><nowiki>lbType</nowiki></code> is <code><nowiki>"item"</nowiki></code>
| which item to rank by
|-
| <code><nowiki>trophyId</nowiki></code>
| [[Data API/Types#TrophyId|<code><nowiki>TrophyId</nowiki></code>]]
| if <code><nowiki>lbType</nowiki></code> is <code><nowiki>"trophy"</nowiki></code>
| which trophy to rank by
|}

<code><nowiki>lbType</nowiki></code> values:

{| class="wikitable"
|-
! Value
! Ranks by
! Extra required field
|-
| <code><nowiki>wallet</nowiki></code>
| BC balance
| —
|-
| <code><nowiki>inventoryWorth</nowiki></code>
| Inventory value
| —
|-
| <code><nowiki>rank</nowiki></code>
| Rank number
| —
|-
| <code><nowiki>questLevel</nowiki></code>
| Quest level
| —
|-
| <code><nowiki>streak</nowiki></code>
| Daily claim streak
| —
|-
| <code><nowiki>stat</nowiki></code>
| Any tracked stat
| <code><nowiki>stat</nowiki></code>
|-
| <code><nowiki>item</nowiki></code>
| Amount of a specific item
| <code><nowiki>itemId</nowiki></code>
|-
| <code><nowiki>trophy</nowiki></code>
| Count of a specific trophy
| <code><nowiki>trophyId</nowiki></code>
|}

Response — [[Data API/Types#LeaderboardPage|<code><nowiki>LeaderboardPage<LeaderboardUser></nowiki></code>]]

== <code><nowiki>stats/hoarderLeaderboard</nowiki></code> ==

Returns players ranked by hoarder trophy size (count of item-collector trophies held).

Request

<pre>{ "type": "stats/hoarderLeaderboard", "profileType": "main" }</pre>

{| class="wikitable"
|-
! Field
! Type
! Required
! Notes
|-
| <code><nowiki>profileType</nowiki></code>
| <code><nowiki>"all" | "main" | "ironman" | "hardcore"</nowiki></code>
| no
| Defaults to <code><nowiki>"all"</nowiki></code>
|}

Response

<pre>interface HoarderLeaderboardResponse {
entries: Array<{
holder: AssociatedUser
count: number
heldSince: number // Unix ms
}>
}</pre>

== <code><nowiki>stats/itemCollectorLeaderboard</nowiki></code> ==

Returns the current trophy holders for all collectible items.

Request

<pre>{ "type": "stats/itemCollectorLeaderboard", "profileType": "main" }</pre>

{| class="wikitable"
|-
! Field
! Type
! Required
! Notes
|-
| <code><nowiki>profileType</nowiki></code>
| <code><nowiki>"all" | "main" | "ironman" | "hardcore"</nowiki></code>
| no
| Defaults to <code><nowiki>"all"</nowiki></code>
|}

Response

<pre>interface ItemCollectorLeaderboardResponse {
entries: Array<{
itemId: number
holder: AssociatedUser | null
amount: number | null
heldSince: number | null // Unix ms
}>
}</pre>

Generated from the Bconomy source documentation. Edits made on the wiki are overwritten on the next publish; ask the developers to change the source.

[[Category:Data API]]

Data API/Leaderboards - Revision history

TheCarriedOne: Publish from docs/data-api.md