Data API/Menagerie

Data API · Types

menagerie/get

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

Request

{ "type": "menagerie/get", "id": 1 }

Field	Type	Required	Notes
id	positive integer	yes	User BcID

Response

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[]
}

menagerie/leaderboard

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

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

Field	Type	Required	Notes
page	positive integer	yes	1-based
pageSize	positive integer	no	optional
search	string	no	optional player search query

Response — LeaderboardPage<MenagerieLeaderboardEntry>

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