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>pets/pet</nowiki></code> ==

Returns a single pet.

Request

<pre>{ "type": "pets/pet", "id": 1 }</pre>

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

== <code><nowiki>pets/egg</nowiki></code> ==

Returns a single egg.

Request

<pre>{ "type": "pets/egg", "id": 1 }</pre>

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

== <code><nowiki>pets/userPetsAndEggs</nowiki></code> ==

Returns pets and eggs owned by a user. Supports optional pagination for pets.

Request

<pre>{ "type": "pets/userPetsAndEggs", "id": 1, "page": 1, "pageSize": 20 }</pre>

{| class="wikitable"
|-
! Field
! Type
! Required
! Notes
|-
| <code><nowiki>id</nowiki></code>
| positive integer
| yes
| Target user's bcId
|-
| <code><nowiki>page</nowiki></code>
| positive integer
| no
| 1-based page for pets; when omitted, all pets are returned
|-
| <code><nowiki>pageSize</nowiki></code>
| positive integer
| no
| Defaults to 20 when <code><nowiki>page</nowiki></code> is provided
|}

Response

<pre>{
pets: Pet[];
eggs: Egg[];
totalPets?: number;
totalEggs?: number;
}</pre>

== <code><nowiki>pets/offspring</nowiki></code> ==

Returns all pets and eggs that have the specified pet as a parent.

Request

<pre>{ "type": "pets/offspring", "id": 1 }</pre>

Response

<pre>{ eggs: Egg[]; pets: Pet[] }</pre>

== <code><nowiki>pets/leaderboard</nowiki></code> ==

Returns a paginated page of the pets leaderboard (sorted by lifetime items found descending).

Request

<pre>{ "type": "pets/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
| defaults to server-configured value
|-
| <code><nowiki>profileType</nowiki></code>
| <code><nowiki>"main"</nowiki></code> | <code><nowiki>"ironman"</nowiki></code> | <code><nowiki>"hardcore"</nowiki></code>
| no
| scopes rankings to pets owned by players of that profile mode
|}

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

Each entry is trimmed to summary display fields, ownership, lifetime items found, and owner profile type:

<pre>{
id: number
name: string
species: PetSpecies
skin: string | null
aura: string | null
ownerBcId: number | null
lifetimeItemsFound: number
ownerType?: "main" | "ironman" | "hardcore"
}</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/Pets - Revision history

TheCarriedOne: Publish from docs/data-api.md