https://wiki.bconomy.net/w/index.php?action=history&feed=atom&title=Data_API%2FSearch
Data API/Search - Revision history
2026-11-06T04:17:02Z
Revision history for this page on the wiki
MediaWiki 1.46.2
https://wiki.bconomy.net/w/index.php?title=Data_API/Search&diff=472&oldid=prev
TheCarriedOne: Publish from docs/data-api.md
2026-11-02T12:19:59Z
<p>Publish from docs/data-api.md</p>
<p><b>New page</b></p><div><small>[[Data API|Data API]] ยท [[Data API/Types|Types]]</small><br />
<br />
All search endpoints return at most 20 results.<br />
<br />
== <code><nowiki>search/users</nowiki></code> ==<br />
<br />
Searches users by name.<br />
<br />
<strong>Request</strong><br />
<br />
<pre>{ "type": "search/users", "query": "alice" }</pre><br />
<br />
<strong>Response</strong> โ [[Data API/Types#User|<code><nowiki>User[]</nowiki></code>]]<br />
<br />
== <code><nowiki>search/factions</nowiki></code> ==<br />
<br />
Searches factions by name.<br />
<br />
<strong>Request</strong><br />
<br />
<pre>{ "type": "search/factions", "query": "alpha" }</pre><br />
<br />
<strong>Response</strong> โ [[Data API/Types#Faction|<code><nowiki>Faction[]</nowiki></code>]]<br />
<br />
== <code><nowiki>search/pets</nowiki></code> ==<br />
<br />
Searches pets by species, skin, aura, and/or name. All fields are required; use <code><nowiki>"any skin"</nowiki></code>, <code><nowiki>"any aura"</nowiki></code>, <code><nowiki>"any species"</nowiki></code> to match any value, or <code><nowiki>"no skin"</nowiki></code> / <code><nowiki>"no aura"</nowiki></code> to match pets without one.<br />
<br />
<strong>Request</strong><br />
<br />
<pre>{<br />
"type": "search/pets",<br />
"skin": "gamma",<br />
"aura": "any aura",<br />
"species": "goose",<br />
"rawNameQuery": "genesis"<br />
}</pre><br />
<br />
{| class="wikitable"<br />
|-<br />
! Field<br />
! Type<br />
! Notes<br />
|-<br />
| <code><nowiki>skin</nowiki></code><br />
| [[Data API/Types#PetSkin|<code><nowiki>PetSkin</nowiki></code>]] &#124; <code><nowiki>"no skin"</nowiki></code> &#124; <code><nowiki>"any skin"</nowiki></code><br />
| <br />
|-<br />
| <code><nowiki>aura</nowiki></code><br />
| [[Data API/Types#PetAura|<code><nowiki>PetAura</nowiki></code>]] &#124; <code><nowiki>"no aura"</nowiki></code> &#124; <code><nowiki>"any aura"</nowiki></code><br />
| <br />
|-<br />
| <code><nowiki>species</nowiki></code><br />
| [[Data API/Types#PetSpecies|<code><nowiki>PetSpecies</nowiki></code>]] &#124; <code><nowiki>"any species"</nowiki></code><br />
| <br />
|-<br />
| <code><nowiki>rawNameQuery</nowiki></code><br />
| string<br />
| empty string matches all names<br />
|}<br />
<br />
<strong>Response</strong> โ [[Data API/Types#Pet|<code><nowiki>Pet[]</nowiki></code>]] (up to 20, sorted by tier then XP descending)<br />
<br />
<small>Generated from the Bconomy source documentation. Edits made on the wiki are overwritten on the next publish; ask the developers to change the source.</small><br />
<br />
[[Category:Data API]]</div>
TheCarriedOne