Jump to content

Data API/Search

From Bconomy Wiki
Revision as of 12:19, 2 November 2026 by TheCarriedOne (talk | contribs) (Publish from docs/data-api.md)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Data API · Types

All search endpoints return at most 20 results.

search/users

[edit | edit source]

Searches users by name.

Request

{ "type": "search/users", "query": "alice" }

Response — User[]

search/factions

[edit | edit source]

Searches factions by name.

Request

{ "type": "search/factions", "query": "alpha" }

Response — Faction[]

search/pets

[edit | edit source]

Searches pets by species, skin, aura, and/or name. All fields are required; use "any skin", "any aura", "any species" to match any value, or "no skin" / "no aura" to match pets without one.

Request

{
  "type": "search/pets",
  "skin": "gamma",
  "aura": "any aura",
  "species": "goose",
  "rawNameQuery": "genesis"
}
Field Type Notes
skin PetSkin | "no skin" | "any skin"
aura PetAura | "no aura" | "any aura"
species PetSpecies | "any species"
rawNameQuery string empty string matches all names

Response — Pet[] (up to 20, sorted by tier then XP descending)

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