Data API/Game Data - Revision history

GameReferenceSync at 22:56, 5 November 2026

2026-11-05T22:56:58Z

@@ Line 9: / Line 9: @@
    contentHash: string // SHA-256 of JSON.stringify(all fields except contentHash)
    items: Array&lt;ItemDefinition &amp; { presentation: ItemPresentation }&gt; // raster imageUrl
    icons: Record&lt;string, string&gt; // emoji/token -&gt; raster image URL
    values: Record&lt;string, {
@@ Line 21: / Line 22: @@
 <code><nowiki>ItemDefinition</nowiki></code> includes the <code><nowiki>misc/itemData</nowiki></code> fields below: identity, base worth (<code><nowiki>cost</nowiki></code>, BC), attributes/restrictions, recipe, reverse crafting uses, loot pools, and optional crop, food, weapon, cooldown and boost properties. All durations are milliseconds before display formatting. These are base definitions, not player inventory, player-adjusted outcomes, or market prices.
 <code><nowiki>presentation</nowiki></code> adds the player-independent derived information used by the Item modal. Raw item fields remain available. The game computes tiers, probabilities, odds and usage thresholds with its shared gameplay/display helpers; consumers should format these values rather than reimplement the calculations.

GameReferenceSync: Publish from docs/data-api.md

2026-11-04T13:52:08Z

Publish from docs/data-api.md

← Older revision		Revision as of 13:52, 4 November 2026
Line 7:		Line 7:
	<pre>{		<pre>{
	schemaVersion: 1		schemaVersion: 1
	contentHash: string // SHA-256 of JSON.stringify(~~{schemaVersion, items, values, tables}~~)		contentHash: string // SHA-256 of JSON.stringify(all fields except contentHash)
	items: Array<ItemDefinition & { presentation: ItemPresentation }> // raster imageUrl		items: Array<ItemDefinition & { presentation: ItemPresentation }> // raster imageUrl
			icons: Record<string, string> // emoji/token -> raster image URL
	values: Record<string, {		values: Record<string, {
	value: string \| number		value: string \| number
Line 30:		Line 31:
	label: string		label: string
	percent: number // 0..100, before display rounding		percent: number // 0..100, before display rounding
			emoji: string \| null // action symbol; containers use their item artwork
	}>		}>
	loot: Array<{		loot: Array<{
Line 51:		Line 53:

	Boost tiers are distinct from pet-food tiers. Usage thresholds identify the minimum bay number, purchase count, upgrade tier or level; research has no numeric threshold. Loot probabilities describe a draw within that pool, not the chance that an action triggers a rare drop or the number of draws when a container opens.		Boost tiers are distinct from pet-food tiers. Usage thresholds identify the minimum bay number, purchase count, upgrade tier or level; research has no numeric threshold. Loot probabilities describe a draw within that pool, not the chance that an action triggers a rare drop or the number of draws when a container opens.

			<code><nowiki>icons</nowiki></code> resolves usage and loot-source symbols, plus supplementary infobox symbols, to image URLs. Standard emoji use pinned Noto Emoji PNGs at 128px; custom game emoji retain their game artwork. Consumers can mirror these assets rather than depending on system emoji fonts or calculating image URLs themselves.

	Value keys are qualified manual paths, with <code><nowiki>/</nowiki></code> replaced by <code><nowiki>.</nowiki></code>, plus the placeholder name; for example <code><nowiki>farm.cropsDieTime</nowiki></code> and <code><nowiki>items.market.unlockRequirement</nowiki></code>. Markdown values are generated by the game and must be escaped/converted before embedding into another markup language. Tables currently include <code><nowiki>crops</nowiki></code>, <code><nowiki>fertilizers</nowiki></code>, <code><nowiki>poker</nowiki></code>, <code><nowiki>shop</nowiki></code>, <code><nowiki>perks</nowiki></code> and <code><nowiki>ranks</nowiki></code>.		Value keys are qualified manual paths, with <code><nowiki>/</nowiki></code> replaced by <code><nowiki>.</nowiki></code>, plus the placeholder name; for example <code><nowiki>farm.cropsDieTime</nowiki></code> and <code><nowiki>items.market.unlockRequirement</nowiki></code>. Markdown values are generated by the game and must be escaped/converted before embedding into another markup language. Tables currently include <code><nowiki>crops</nowiki></code>, <code><nowiki>fertilizers</nowiki></code>, <code><nowiki>poker</nowiki></code>, <code><nowiki>shop</nowiki></code>, <code><nowiki>perks</nowiki></code> and <code><nowiki>ranks</nowiki></code>.

GameReferenceSync: Publish from docs/data-api.md

2026-11-04T01:42:07Z

Publish from docs/data-api.md

@@ Line 8: / Line 8: @@
    schemaVersion: 1
    contentHash: string // SHA-256 of JSON.stringify({schemaVersion, items, values, tables})
-   items: Array&lt;ItemDefinition&gt; // same processed definitions as misc/itemData; raster imageUrl
+   items: Array&lt;ItemDefinition &amp; { presentation: ItemPresentation }&gt; // raster imageUrl
    values: Record&lt;string, {
      value: string | number
@@ Line 20: / Line 20: @@
 <code><nowiki>ItemDefinition</nowiki></code> includes the <code><nowiki>misc/itemData</nowiki></code> fields below: identity, base worth (<code><nowiki>cost</nowiki></code>, BC), attributes/restrictions, recipe, reverse crafting uses, loot pools, and optional crop, food, weapon, cooldown and boost properties. All durations are milliseconds before display formatting. These are base definitions, not player inventory, player-adjusted outcomes, or market prices.
 Value keys are qualified manual paths, with <code><nowiki>/</nowiki></code> replaced by <code><nowiki>.</nowiki></code>, plus the placeholder name; for example <code><nowiki>farm.cropsDieTime</nowiki></code> and <code><nowiki>items.market.unlockRequirement</nowiki></code>. Markdown values are generated by the game and must be escaped/converted before embedding into another markup language. Tables currently include <code><nowiki>crops</nowiki></code>, <code><nowiki>fertilizers</nowiki></code>, <code><nowiki>poker</nowiki></code>, <code><nowiki>shop</nowiki></code>, <code><nowiki>perks</nowiki></code> and <code><nowiki>ranks</nowiki></code>.

GameReferenceSync: Publish from docs/data-api.md

2026-11-03T21:42:16Z

Publish from docs/data-api.md

← Older revision		Revision as of 21:42, 3 November 2026
Line 1:		Line 1:
	<small>[[Data API\|Data API]] · [[Data API/Types\|Types]]</small>		<small>[[Data API\|Data API]] · [[Data API/Types\|Types]]</small>

			== <code><nowiki>GET /api/reference</nowiki></code> ==

			Public, read-only reference definitions from the running server. This is a plain <code><nowiki>GET</nowiki></code>, independent of <code><nowiki>POST /api/data</nowiki></code>, with no API key or player context.

			<pre>{
			schemaVersion: 1
			contentHash: string // SHA-256 of JSON.stringify({schemaVersion, items, values, tables})
			items: Array<ItemDefinition> // same processed definitions as misc/itemData; raster imageUrl
			values: Record<string, {
			value: string \| number
			format: "number" \| "text" \| "duration" \| "markdown"
			}>
			tables: Record<string, {
			columns: string[]
			rows: Array<Array<string \| number>>
			}>
			}</pre>

			<code><nowiki>ItemDefinition</nowiki></code> includes the <code><nowiki>misc/itemData</nowiki></code> fields below: identity, base worth (<code><nowiki>cost</nowiki></code>, BC), attributes/restrictions, recipe, reverse crafting uses, loot pools, and optional crop, food, weapon, cooldown and boost properties. All durations are milliseconds before display formatting. These are base definitions, not player inventory, player-adjusted outcomes, or market prices.

			Value keys are qualified manual paths, with <code><nowiki>/</nowiki></code> replaced by <code><nowiki>.</nowiki></code>, plus the placeholder name; for example <code><nowiki>farm.cropsDieTime</nowiki></code> and <code><nowiki>items.market.unlockRequirement</nowiki></code>. Markdown values are generated by the game and must be escaped/converted before embedding into another markup language. Tables currently include <code><nowiki>crops</nowiki></code>, <code><nowiki>fertilizers</nowiki></code>, <code><nowiki>poker</nowiki></code>, <code><nowiki>shop</nowiki></code>, <code><nowiki>perks</nowiki></code> and <code><nowiki>ranks</nowiki></code>.

			The response supplies an <code><nowiki>ETag</nowiki></code> and <code><nowiki>Cache-Control: public, max-age=300</nowiki></code>. <code><nowiki>If-None-Match</nowiki></code> supports <code><nowiki>304 Not Modified</nowiki></code>. The hash describes content, not a release number or publication time. Consumers must accept changed hashes in both directions, since a production rollback may restore an earlier snapshot.

	== <code><nowiki>misc/itemData</nowiki></code> ==		== <code><nowiki>misc/itemData</nowiki></code> ==

TheCarriedOne: Publish from docs/data-api.md

2026-11-02T12:19:59Z

Publish from docs/data-api.md

New page

[[Data API|Data API]] · [[Data API/Types|Types]]

== <code><nowiki>misc/itemData</nowiki></code> ==

Returns static data for all game items.

Request

<pre>{ "type": "misc/itemData" }</pre>

Response

<pre>Array<{
id: number
imageUrl: string
recipe: Array<[idName: string, amount: number]>
// plus all other item fields (name, emoji, idName, etc.)
}></pre>

== <code><nowiki>misc/gameState</nowiki></code> ==

Returns the current live game state including active bosses, the ball pit, global action boosts, and giveaways. Giveaways are included only for Main profiles; profiles without direct-transfer access receive an empty <code><nowiki>activeGiveaways</nowiki></code> array.

Request

<pre>{ "type": "misc/gameState" }</pre>

Response

<pre>{
globalActionBoosts: Array<{
type: "baseGlobalActionBoost" | "flexibleGlobalActionBoost"
user: User
action: "fish" | "hunt" | "explore" | "mine" | "work"
multiplier: number
duration: number // ms
endTime: number // Unix ms
}>
lastGlobalActionCooldownResetTime: number // Unix ms
activeBossStatus: {
lastUpdated: number
data: {
bossId: string
startTime: number
initialHealth: number
weaknessItemIds: number[]
numAttackingUsers: number
damageDealt: number
nextWeakpointRevealAt: number | null
}
} | null
ballPitStatus: {
type: "black" | "purple" | "blue" | "orange" | "yellow" | "green"
balls: number
}
activeGiveaways: Array<{
id: number
ownerBcId: number
message: string
endDate: string // ISO 8601
numWinners: number
entrantBcIds: number[]
flatInventory: Inventory
}>
}</pre>

== <code><nowiki>misc/userBallsOwned</nowiki></code> ==

Returns the number of balls the authenticated user (identified by the API key) currently has in the ball pit. No <code><nowiki>id</nowiki></code> parameter is accepted; the result is always for the key holder.

Request

<pre>{ "type": "misc/userBallsOwned" }</pre>

Response — <code><nowiki>number</nowiki></code> (non-negative integer)

== <code><nowiki>stats/questSeasons</nowiki></code> ==

Returns archived quest seasons. The live ongoing season is excluded.

Request

<pre>{ "type": "stats/questSeasons" }</pre>

Response

<pre>interface QuestSeasonsResponse {
endedSeasons: Array<{
id: number
name: string
emoji: string
endedAt: number // Unix ms
}>
}</pre>

== <code><nowiki>misc/bossFactionStats</nowiki></code> ==

Returns active faction combat contribution stats for the current boss fight. Returns <code><nowiki>null</nowiki></code> if no boss is active or the user is not in a faction.

Request

<pre>{ "type": "misc/bossFactionStats" }</pre>

Response

<pre>interface BossFactionStatsResponse {
factionPresenceMemberCount: number
factionMultiplier: number
} | null</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]]