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>menagerie/get</nowiki></code> ==

Returns a user's menagerie collection, unlocked variants, and active animal status.

Request

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

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

Response

<pre>interface MenagerieData {
owner: {
id: number
name: string
type: "main" | "ironman" | "hardcore"
custom: Record<string, unknown>
premiumExpiryDate: string | null
}
userId: number
isViewingSelf: boolean
unlocks: Array<{
id: number
species: string
kind: string
variant: string
firstUnlockedAt: string
sourceType: string
sourcePetId: number | null
}>
ownedKeys: string[]
}</pre>

== <code><nowiki>menagerie/leaderboard</nowiki></code> ==

Returns a paginated page of the menagerie collection leaderboard.

Progress uses the current main-track species and standard variants, including the seasonal species. Equal totals prefer the earliest recorded time of reaching that total. Recorded times take precedence over unknown times. Remaining ties favor more completed species, then lower BcID. Attainment timestamps are not included in leaderboard entries.

Request

<pre>{ "type": "menagerie/leaderboard", "page": 1, "pageSize": 50 }</pre>

{| class="wikitable"
|-
! Field
! Type
! Required
! Notes
|-
| <code><nowiki>page</nowiki></code>
| positive integer
| yes
| 1-based
|-
| <code><nowiki>pageSize</nowiki></code>
| positive integer
| no
| optional
|-
| <code><nowiki>search</nowiki></code>
| string
| no
| optional player search query
|}

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

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

TheCarriedOne: Publish from docs/data-api.md