Data API/Pets

`pets/pet`

Returns a single pet.

Request

{ "type": "pets/pet", "id": 1 }

Response — Pet

`pets/egg`

Returns a single egg.

Request

{ "type": "pets/egg", "id": 1 }

Response — Egg

`pets/userPetsAndEggs`

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

Request

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

Field	Type	Required	Notes
`id`	positive integer	yes	Target user's bcId
`page`	positive integer	no	1-based page for pets; when omitted, all pets are returned
`pageSize`	positive integer	no	Defaults to 20 when `page` is provided

Response

{
  pets: Pet[];
  eggs: Egg[];
  totalPets?: number;
  totalEggs?: number;
}

`pets/offspring`

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

Request

{ "type": "pets/offspring", "id": 1 }

Response

{ eggs: Egg[]; pets: Pet[] }

`pets/leaderboard`

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

Request

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

Field	Type	Required	Notes
`page`	positive integer	yes	1-based
`pageSize`	positive integer	no	defaults to server-configured value
`profileType`	`"main"` \| `"ironman"` \| `"hardcore"`	no	scopes rankings to pets owned by players of that profile mode

Response — LeaderboardPage<PetsLeaderboardEntry>

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

{
  id: number
  name: string
  species: PetSpecies
  skin: string | null
  aura: string | null
  ownerBcId: number | null
  lifetimeItemsFound: number
  ownerType?: "main" | "ironman" | "hardcore"
}

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