Editing Data API (section)

== Endpoints ==

Each endpoint page lists the request, the response and any limits. Shared shapes such as <code>User</code> and <code>Pet</code> are on [[Data API/Types|Types]].

{| class="wikitable"
|-
! Query
! Returns
|-
! colspan="2" | [[Data API/Profile|Profile]]
|-
| [[Data API/Profile#user/profile|<code><nowiki>user/profile</nowiki></code>]]
| Returns a single user's full public profile, enriched with inventory, faction, linked Discord info (if public), and BCS roles.
|-
| [[Data API/Profile#user/get|<code><nowiki>user/get</nowiki></code>]]
| Returns the core [[Data API/Types#User|<code><nowiki>User</nowiki></code>]] object.
|-
| [[Data API/Profile#user/lbPositions|<code><nowiki>user/lbPositions</nowiki></code>]]
| Returns a user's leaderboard positions, scoped to that profile's own type (main / ironman / hardcore rank among their own kind only).
|-
| [[Data API/Profile#user/inventory|<code><nowiki>user/inventory</nowiki></code>]]
| Returns the inventory of a user.
|-
| [[Data API/Profile#stats/user|<code><nowiki>stats/user</nowiki></code>]]
| Returns all tracked lifetime and periodic statistics for a user.
|-
| [[Data API/Profile#stats/trophies|<code><nowiki>stats/trophies</nowiki></code>]]
| Returns the trophy record for a user.
|-
| [[Data API/Profile#user/otherProfiles|<code><nowiki>user/otherProfiles</nowiki></code>]]
| Returns public summary information for other profiles belonging to the same account as the requested profile.
|-
| [[Data API/Profile#stats/userWindowed|<code><nowiki>stats/userWindowed</nowiki></code>]]
| Returns time-windowed statistics for a user across multiple aggregation buckets.
|-
| [[Data API/Profile#stats/burnOdds|<code><nowiki>stats/burnOdds</nowiki></code>]]
| Returns daily and weekly first-draw Burn odds for a user in their profile mode, using all eligible positive burns, with no leaderboard page cutoff.
|-
! colspan="2" | [[Data API/Pets|Pets]]
|-
| [[Data API/Pets#pets/pet|<code><nowiki>pets/pet</nowiki></code>]]
| Returns a single pet.
|-
| [[Data API/Pets#pets/egg|<code><nowiki>pets/egg</nowiki></code>]]
| Returns a single egg.
|-
| [[Data API/Pets#pets/userPetsAndEggs|<code><nowiki>pets/userPetsAndEggs</nowiki></code>]]
| Returns pets and eggs owned by a user.
|-
| [[Data API/Pets#pets/offspring|<code><nowiki>pets/offspring</nowiki></code>]]
| Returns all pets and eggs that have the specified pet as a parent.
|-
| [[Data API/Pets#pets/leaderboard|<code><nowiki>pets/leaderboard</nowiki></code>]]
| Returns a paginated page of the pets leaderboard (sorted by lifetime items found descending).
|-
! colspan="2" | [[Data API/Menagerie|Menagerie]]
|-
| [[Data API/Menagerie#menagerie/get|<code><nowiki>menagerie/get</nowiki></code>]]
| Returns a user's menagerie collection, unlocked variants, and active animal status.
|-
| [[Data API/Menagerie#menagerie/leaderboard|<code><nowiki>menagerie/leaderboard</nowiki></code>]]
| Returns a paginated page of the menagerie collection leaderboard.
|-
! colspan="2" | [[Data API/Factions|Factions]]
|-
| [[Data API/Factions#factions/get|<code><nowiki>factions/get</nowiki></code>]]
| Returns a single faction.
|-
| [[Data API/Factions#factions/members|<code><nowiki>factions/members</nowiki></code>]]
| Returns all users that belong to a faction.
|-
| [[Data API/Factions#factions/recruiting|<code><nowiki>factions/recruiting</nowiki></code>]]
| Returns recruiting factions of the viewer's profile type with an open member spot and at least one FP-funded active boost.
|-
| [[Data API/Factions#factions/joinRequests|<code><nowiki>factions/joinRequests</nowiki></code>]]
| Returns faction join requests filtered by either faction or user.
|-
| [[Data API/Factions#factions/leaderboard|<code><nowiki>factions/leaderboard</nowiki></code>]]
| Returns a paginated page of the faction leaderboard.
|-
! colspan="2" | [[Data API/Market|Market]]
|-
| [[Data API/Market#market/preview|<code><nowiki>market/preview</nowiki></code>]]
| Returns the current lowest listing price and price delta for every item.
|-
| [[Data API/Market#market/listings|<code><nowiki>market/listings</nowiki></code>]]
| Returns up to 50 active market listings for an item, sorted by price ascending.
|-
| [[Data API/Market#market/userListings|<code><nowiki>market/userListings</nowiki></code>]]
| Returns all active market listings created by a user.
|-
| [[Data API/Market#market/globalRecentActivity|<code><nowiki>market/globalRecentActivity</nowiki></code>]]
| Returns the last 20 market transactions (buys, listings, and delistings) across all items.
|-
| [[Data API/Market#market/recentTransactions|<code><nowiki>market/recentTransactions</nowiki></code>]]
| Returns the last 5 market transactions for a specific item.
|-
| [[Data API/Market#market/priceHistory|<code><nowiki>market/priceHistory</nowiki></code>]]
| Returns historical lowest-price snapshots for an item.
|-
| [[Data API/Market#market/volumeHistory|<code><nowiki>market/volumeHistory</nowiki></code>]]
| Returns aggregated trade volume history for an item.
|-
! colspan="2" | [[Data API/Leaderboards|Leaderboards]]
|-
| [[Data API/Leaderboards#stats/userLeaderboard|<code><nowiki>stats/userLeaderboard</nowiki></code>]]
| Returns a paginated page of the user leaderboard.
|-
| [[Data API/Leaderboards#stats/hoarderLeaderboard|<code><nowiki>stats/hoarderLeaderboard</nowiki></code>]]
| Returns players ranked by hoarder trophy size (count of item-collector trophies held).
|-
| [[Data API/Leaderboards#stats/itemCollectorLeaderboard|<code><nowiki>stats/itemCollectorLeaderboard</nowiki></code>]]
| Returns the current trophy holders for all collectible items.
|-
! colspan="2" | [[Data API/Logs|Logs]]
|-
| [[Data API/Logs#logs/byBcId|<code><nowiki>logs/byBcId</nowiki></code>]]
| Returns logs associated with a user.
|-
| [[Data API/Logs#logs/byIdType|<code><nowiki>logs/byIdType</nowiki></code>]]
| Returns logs associated with a faction or item.
|-
| [[Data API/Logs#logs/byLogType|<code><nowiki>logs/byLogType</nowiki></code>]]
| Returns logs filtered by event type.
|-
| [[Data API/Logs#misc/dailyInputs|<code><nowiki>misc/dailyInputs</nowiki></code>]]
| Returns all commands executed by a user on a specific date (UTC day).
|-
! colspan="2" | [[Data API/Game Data|Game Data]]
|-
| [[Data API/Game Data#GET /api/reference|<code><nowiki>GET /api/reference</nowiki></code>]]
| Public, read-only reference definitions from the running server.
|-
| [[Data API/Game Data#misc/itemData|<code><nowiki>misc/itemData</nowiki></code>]]
| Returns static data for all game items.
|-
| [[Data API/Game Data#misc/gameState|<code><nowiki>misc/gameState</nowiki></code>]]
| Returns the current live game state including active bosses, the ball pit, global action boosts, and giveaways.
|-
| [[Data API/Game Data#misc/userBallsOwned|<code><nowiki>misc/userBallsOwned</nowiki></code>]]
| Returns the number of balls the <strong>authenticated user</strong> (identified by the API key) currently has in the ball pit.
|-
| [[Data API/Game Data#stats/questSeasons|<code><nowiki>stats/questSeasons</nowiki></code>]]
| Returns archived quest seasons.
|-
| [[Data API/Game Data#misc/bossFactionStats|<code><nowiki>misc/bossFactionStats</nowiki></code>]]
| Returns active faction combat contribution stats for the current boss fight.
|-
! colspan="2" | [[Data API/Search|Search]]
|-
| [[Data API/Search#search/users|<code><nowiki>search/users</nowiki></code>]]
| Searches users by name.
|-
| [[Data API/Search#search/factions|<code><nowiki>search/factions</nowiki></code>]]
| Searches factions by name.
|-
| [[Data API/Search#search/pets|<code><nowiki>search/pets</nowiki></code>]]
| Searches pets by species, skin, aura, and/or name.
|-
! colspan="2" | [[Data API/Player Activity|Player Activity]]
|-
| [[Data API/Player Activity#playerActivity/online|<code><nowiki>playerActivity/online</nowiki></code>]]
| Returns game profiles with a connection, reported presence, or interaction signal in the past 90 minutes.
|-
! colspan="2" | [[Data API/Homepage feed|Homepage feed]]
|-
| [[Data API/Homepage feed#GET /api/eventsfeed|<code><nowiki>GET /api/eventsfeed</nowiki></code>]]
| A public endpoint with no API key, used by the homepage marquees.
|}

<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>

[[Category:Data API]]