TheCarriedOne: Publish from docs/data-api.md

2026-11-02T12:19:57Z

Publish from docs/data-api.md

New page

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

== <code><nowiki>user/profile</nowiki></code> ==

Returns a single user's full public profile, enriched with inventory, faction, linked Discord info (if public), and BCS roles. Leaderboard positions are fetched separately via <code><nowiki>user/lbPositions</nowiki></code> (they are slow to compute and loaded lazily by the client).

Request

<pre>{ "type": "user/profile", "id": 1 }</pre>

Response — [[Data API/Types#User|<code><nowiki>User</nowiki></code>]] extended with:

<pre>{
// All User fields, plus:
bcsRoles: Array<"moderator" | "developer" | "inactiveModerator">
inventory: Inventory
faction?: Faction // present only if user is in a faction
displayStatValue?: number // value of the stat shown under Triumphs
presence?: { status: "online" | "idle" | "offline"; lastSeenAt?: Date | null }
discordOnline: boolean // linked account is in the latest Discord snapshot and publicDiscordProfile is enabled
discordId?: string | null // only present if user has set publicDiscordProfile
discordUsername?: string | null
discordAvatarHash?: string | null
}</pre>

The profile badge prioritizes game Online, then Idle, then Discord, then Offline. Discord requires a matching linked account in the latest server presence snapshot and the profile's Show Discord Profile setting. Cached Discord presence does not expire; a later profile response updates <code><nowiki>discordOnline</nowiki></code>. The last-activity tooltip continues to describe game activity.

== <code><nowiki>user/get</nowiki></code> ==

Returns the core [[Data API/Types#User|<code><nowiki>User</nowiki></code>]] object.

Request

<pre>{ "type": "user/get", "id": 1 }</pre>

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

== <code><nowiki>user/lbPositions</nowiki></code> ==

Returns a user's leaderboard positions, scoped to that profile's own type (main / ironman / hardcore rank among their own kind only). Split out from <code><nowiki>user/profile</nowiki></code> because computing it warms many leaderboard boards and is slow; the client fetches it lazily when the profile modal opens.

Request

<pre>{ "type": "user/lbPositions", "id": 1 }</pre>

Response

<pre>{
lbPositions: Record<string, number> // e.g. { "rank": 14, "questLevel": 2 }
}</pre>

== <code><nowiki>user/inventory</nowiki></code> ==

Returns the inventory of a user. Keys are item <code><nowiki>idName</nowiki></code> strings; values are positive integer quantities. Only items owned in non-zero amounts are included.

Request

<pre>{ "type": "user/inventory", "id": 1 }</pre>

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

<pre>{ "rocks": 500, "wood": 120 }</pre>

== <code><nowiki>stats/user</nowiki></code> ==

Returns all tracked lifetime and periodic statistics for a user.

Request

<pre>{ "type": "stats/user", "id": 1 }</pre>

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

== <code><nowiki>stats/trophies</nowiki></code> ==

Returns the trophy record for a user.

Request

<pre>{ "type": "stats/trophies", "id": 1 }</pre>

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

== <code><nowiki>user/otherProfiles</nowiki></code> ==

Returns public summary information for other profiles belonging to the same account as the requested profile.

Request

<pre>{ "type": "user/otherProfiles", "id": 1 }</pre>

{| class="wikitable"
|-
! Field
! Type
! Required
! Notes
|-
| <code><nowiki>id</nowiki></code>
| positive integer
| yes
| User BcID
|}

Response

<pre>interface OtherProfilesResponse {
profiles: Array<{
bcId: number
type: "main" | "ironman" | "hardcore"
trophyCount: number
titleEmoji: string
factionTag: string | null
title: string
name: string
}>
}</pre>

== <code><nowiki>stats/userWindowed</nowiki></code> ==

Returns time-windowed statistics for a user across multiple aggregation buckets.

Request

<pre>{ "type": "stats/userWindowed", "bcId": 1 }</pre>

{| class="wikitable"
|-
! Field
! Type
! Required
! Notes
|-
| <code><nowiki>bcId</nowiki></code>
| positive integer
| yes
| User BcID
|}

Response

<pre>type UserWindowedStats = Record<string, {
today: number
thisWeek: number
thisMonth: number
lastDay: number
lastWeek: number
lastMonth: number
total: number
}></pre>

== <code><nowiki>stats/burnOdds</nowiki></code> ==

Returns daily and weekly first-draw Burn odds for a user in their profile mode, using all eligible positive burns, with no leaderboard page cutoff.

Request

<pre>{ "type": "stats/burnOdds", "bcId": 1 }</pre>

Response

<pre>interface BurnDrawResponse {
daily: BurnDrawStanding
weekly: BurnDrawStanding
}
interface BurnDrawStanding {
burned: number
rank: number | null // null for a user without an eligible positive burn
chance: number // 0–1; sqrt(user burn) / sum(sqrt(eligible burns))
participants: number
}</pre>

Banned users are excluded. The two windows use the same database snapshot. These are first-draw odds, not the chance of winning at least one prize. Weekly Genesis Egg and Forbidden Modifier draws use different winners when at least two users qualify; other draws allow repeat wins. Odds change as players burn.

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/Profile - Revision history

TheCarriedOne: Publish from docs/data-api.md