Jump to content
Main Menu
Main Menu
move to sidebar
hide
Navigation
Main page
Guide
Recent changes
Random page
Getting started
Bconomy
Ranks
Profile modes
Web Client
Gameplay
Actions
Items
Market
Farm
Pets
Relay Network
Prestige
Activities
Bosses
Factions
Museum
Fun House
Coinflip
Burn
Pyre
Bconomy Wiki
Search
Search
Appearance
Create account
Log in
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Editing
Data API/Types
Page
Discussion
English
Read
Edit
Edit source
View history
Tools
Tools
move to sidebar
hide
Actions
Read
Edit
Edit source
View history
General
What links here
Related changes
Page information
Appearance
move to sidebar
hide
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
<small>[[Data API|Data API]]</small> == Common types == These types appear across multiple endpoint responses. === User === <pre>interface User { id: number // BcID name: string registrationDate: string // ISO 8601 rank: number // current position in the rank lineup (1β60) tier: number bc: number // balance sp: number // store points kr: number // karma chips: number // Fun House chips buddyId: number | null factionId: number | null factionTag: string | null factionJoinDate: string // ISO 8601 factionDepositWeekly: number factionDepositTotal: number questLevel: number questLevelClaimed: number dailyClaimStreak: number petsBredDaily: number lastCaptchaDate: string // ISO 8601 farmPlots: Array<{ level: number status: { isPlanted: false } | { isPlanted: true; itemId: number; plantedTime: number } boost: { multiplier: number; endTime: number } isExtra: boolean }> generators: Array<{ level: number; isExtra: boolean }> quests: Array<{ itemId: number; amountRequired: number; amountFulfilled: number }> cooldowns: { fish: number; hunt: number; explore: number; mine: number; work: number daily: number; water: number; claimGenerators: number; setBuddy: number buddyBossAttack: number; resetPerks: number; eternalsnowflakeUse: number } // values are Unix ms expiry timestamps (0 = no cooldown) effects: Record<string, { endTime: number; modifier: object }> upgrades: { fish: number; fishExtra: number; hunt: number; huntExtra: number explore: number; exploreExtra: number; mine: number; mineExtra: number petsStable: number; petsStableExtra: number } augments: Array<{ lootAction: LootAction; itemId: number; expiry: number }> equippedFlatInventory: Inventory perks: Partial<Record<PrestigePerkId, number>> pinnedItemIds: number[] pinnedPetIds: number[] autosellLimits: Record<string, number> itemReserveAmounts: Record<string, number> settings: { profileShowStatId: StatKey | null title: { type: "trophy"; trophyId: TrophyId } | { type: "specificRank"; rankNum: number } | null syncDiscordName: boolean publicDiscordProfile: boolean petsBulkFeedFoundItemsFirst: boolean petsBulkFeedCravingsOnly: boolean aggregateBulkOutput: boolean } custom: { profileHideAvatar: boolean profileHideTitleName: boolean profileUseChatEmblemEmoji: boolean profileBackground: string | null chatEmblemEmoji: string | null chatUsernameColor: string | null chatUsernameStyle: string | null chatMessageBackgroundColor: string | null } blockedBcIds: number[] banExpiryDate: string // ISO 8601 premiumExpiryDate: string | null // ISO 8601 }</pre> === Pet === <pre>interface Pet { id: number ownerBcId: number | null // null for wild pets hatchDate: string // ISO 8601 name: string tier: number xp: number species: PetSpecies generation: number parentAId: number | null parentBId: number | null timesBred: number lastBred: string // ISO 8601 heldItemId: number | null unsyncedEnergy: number adventureType: "fish" | "hunt" | "explore" | "mine" | null adventureBoost: { multiplier: number; endTime: number } | null lastAdventureSync: string // ISO 8601 lifetimeItemsFound: number craving: { itemId: number; amount: number } skin: PetSkin | null aura: PetAura | null }</pre> === Egg === <pre>interface Egg { id: number ownerBcId: number | null parentAId: number parentBId: number parentAHeldItemId: number | null parentBHeldItemId: number | null }</pre> === Faction === <pre>interface Faction { id: number tag: string | null name: string ownerBcId: number rankOverrides: Record<string, number> isRecruiting: boolean isOpenRecruitment: boolean // Immediate joining while recruiting and below capacity about: string | null motd: string | null unsyncedFp: number lastFpSync: string // ISO 8601 boostSteps: { fish: { lastChange: number; amount: number } hunt: { lastChange: number; amount: number } explore: { lastChange: number; amount: number } mine: { lastChange: number; amount: number } } halls: number fpDepositedMonthly: number fpDepositedTotal: number customizationSettings: { emblemEmoji: string | null tagColor: string | null nameColor: string | null nameStyle: string | null } ownerPremiumExpiryDate: string | null // ISO 8601 memberCount: number pendingRequests: number }</pre> === Inventory === A JSON object where each key is an item's <code><nowiki>idName</nowiki></code> string (e.g. <code><nowiki>"rocks"</nowiki></code>, <code><nowiki>"lunarShard"</nowiki></code>) and each value is the owned quantity. Only items with a non-zero quantity are present. <pre>{ "rocks": 500, "wood": 120, "lunarShard": 3 }</pre> <span id="LeaderboardPage"></span> === LeaderboardPage<T> === Returned by all paginated leaderboard endpoints. <pre>interface LeaderboardPage<T> { data: T[] total: number // total entries across all pages pageSize: number lastUpdated: number // Unix ms timestamp of last cache refresh ownEntry?: (T & { rank: number }) | null // requesting user's entry; omitted for some lb types }</pre> === LeaderboardUser === The entry type <code><nowiki>T</nowiki></code> for user leaderboards. <pre>interface LeaderboardUser { id: number // BcID name: string custom: User["custom"] premiumExpiryDate: string | null lbValue: number // primary sort value (may exceed Number.MAX_SAFE_INTEGER) secondaryLbValue?: number }</pre> === GameLogResponse === Returned by all log endpoints. <pre>interface GameLogResponse { entries: GameLog[] refs: { profiles: Record<number, User> // keyed by BcID factions: Record<number, Faction> // keyed by faction ID pets: Record<number, Pet> // keyed by pet ID } total: number pageSize: number page: number }</pre> === GameLog === <pre>interface GameLog { id: number date: string // ISO 8601 senderBcId: number | null recipientBcId: number | null factionId: number | null itemId: number | null type: GameLogType data: { amount?: number ballPitType?: "black" | "purple" | "blue" | "orange" | "yellow" | "green" listingPrice?: number newFactionRank?: number action?: "fish" | "hunt" | "explore" | "mine" | "work" petId?: number eggId?: number special?: Special } }</pre> === MarketListing === <pre>interface MarketListing { id: number bcId: number // seller BcID itemId: number price: number amount: number }</pre> === MarketActivityEntry === <pre>interface MarketActivityEntry { itemId: number itemName: string itemEmoji: string type: "buy" | "list" | "delist" actorBcId: number actorName: string | null amount: number price: number date: string // ISO 8601 }</pre> === MarketPreviewItem === <pre>interface MarketPreviewItem { price?: number // current lowest listing price; absent if no active listings delta: { day: number | null // % change vs 24 h ago; null if no data week: number | null month: number | null } }</pre> === MarketPriceSnapshot === <pre>interface MarketPriceSnapshot { id: number snapshotTime: string // ISO 8601 itemId: number lowestPrice: number | null }</pre> === MarketVolumeSnapshot === <pre>interface MarketVolumeSnapshot { id: number granularity: "hour" | "day" | "month" windowStart: string // ISO 8601 windowEnd: string // ISO 8601 itemId: number unitsSold: number // may exceed MAX_SAFE_INTEGER for high-volume items totalRevenue: number // may exceed MAX_SAFE_INTEGER transactionCount: number }</pre> === FactionJoinRequest === <pre>interface FactionJoinRequest { id: number bcId: number factionId: number reason: string | null date: string // ISO 8601 }</pre> === UserStats === <pre>interface UserStats { bcId: number incomeDaily: number; incomeWeekly: number; incomeTotal: number timesFished: number; timesHunted: number; timesExplored: number timesMined: number; timesWorked: number itemsFound: number; rareItemsFound: number itemsCrafted: number; itemsHarvested: number; timesWatered: number bcEarnedFromGens: number petItemsFound: number; petItemsFed: number; petsBred: number questsCompleted: number; fpContributed: number timesPlayedCoinflip: number netCoinflipProfitDaily: number; netCoinflipProfitWeekly: number; netCoinflipProfitTotal: number bcBurnedDaily: number; bcBurnedWeekly: number; bcBurnedTotal: number bossDamage: number // may exceed MAX_SAFE_INTEGER marketListingsSold: number marketListingsRevenue: number // may exceed MAX_SAFE_INTEGER netBallPitProfit: number museumCollectiblesFound: number globalBoostsUsed: number; worthGivenAway: number }</pre> === UserTrophies === <pre>interface UserTrophies { bcId: number trophyRecord: Partial<Record<TrophyId, { count: number; timeFirstAchieved: number }>> }</pre> == Enumerations == === PetSpecies === Base: <code><nowiki>poodle</nowiki></code>, <code><nowiki>dog</nowiki></code>, <code><nowiki>bat</nowiki></code>, <code><nowiki>mustang</nowiki></code>, <code><nowiki>pig</nowiki></code>, <code><nowiki>eagle</nowiki></code>, <code><nowiki>otter</nowiki></code>, <code><nowiki>tiger</nowiki></code>, <code><nowiki>peacock</nowiki></code>, <code><nowiki>donkey</nowiki></code>, <code><nowiki>gorilla</nowiki></code>, <code><nowiki>ox</nowiki></code>, <code><nowiki>junglefowl</nowiki></code>, <code><nowiki>crocodile</nowiki></code>, <code><nowiki>goose</nowiki></code>, <code><nowiki>rat</nowiki></code>, <code><nowiki>seal</nowiki></code>, <code><nowiki>whale</nowiki></code>, <code><nowiki>rabbit</nowiki></code>, <code><nowiki>dove</nowiki></code>, <code><nowiki>kangaroo</nowiki></code>, <code><nowiki>snake</nowiki></code>, <code><nowiki>turtle</nowiki></code>, <code><nowiki>snail</nowiki></code>, <code><nowiki>dolphin</nowiki></code>, <code><nowiki>lizard</nowiki></code>, <code><nowiki>scorpion</nowiki></code>, <code><nowiki>owl</nowiki></code>, <code><nowiki>cockroach</nowiki></code> Supporter: <code><nowiki>dragon</nowiki></code>, <code><nowiki>phoenix</nowiki></code>, <code><nowiki>visitor</nowiki></code>, <code><nowiki>invader</nowiki></code>, <code><nowiki>sauropod</nowiki></code>, <code><nowiki>tyrannosaurus</nowiki></code>, <code><nowiki>jack</nowiki></code>, <code><nowiki>ghost</nowiki></code>, <code><nowiki>snowman</nowiki></code> === PetSkin === Base: <code><nowiki>alpha</nowiki></code>, <code><nowiki>beta</nowiki></code>, <code><nowiki>gamma</nowiki></code>, <code><nowiki>delta</nowiki></code>, <code><nowiki>epsilon</nowiki></code>, <code><nowiki>zeta</nowiki></code>, <code><nowiki>eta</nowiki></code> Unique: <code><nowiki>sunkissed</nowiki></code>, <code><nowiki>grayscale</nowiki></code>, <code><nowiki>whiteout</nowiki></code> === PetAura === <code><nowiki>green</nowiki></code>, <code><nowiki>purple</nowiki></code>, <code><nowiki>orange</nowiki></code>, <code><nowiki>cyan</nowiki></code>, <code><nowiki>red</nowiki></code>, <code><nowiki>pink</nowiki></code>, <code><nowiki>blue</nowiki></code>, <code><nowiki>yellow</nowiki></code>, <code><nowiki>black</nowiki></code> === LootAction === <code><nowiki>fish</nowiki></code>, <code><nowiki>hunt</nowiki></code>, <code><nowiki>explore</nowiki></code>, <code><nowiki>mine</nowiki></code> === GameLogType === <code><nowiki>itemFind</nowiki></code>, <code><nowiki>ballPitWin</nowiki></code>, <code><nowiki>marketItemTransaction</nowiki></code>, <code><nowiki>tradeItemTransaction</nowiki></code>, <code><nowiki>tradeBcTransaction</nowiki></code>, <code><nowiki>factionJoin</nowiki></code>, <code><nowiki>factionCreate</nowiki></code>, <code><nowiki>factionDelete</nowiki></code>, <code><nowiki>factionDemote</nowiki></code>, <code><nowiki>factionPromote</nowiki></code>, <code><nowiki>factionTransfer</nowiki></code>, <code><nowiki>factionVaultDeposit</nowiki></code>, <code><nowiki>factionVaultUpgrade</nowiki></code>, <code><nowiki>factionKick</nowiki></code>, <code><nowiki>factionLeave</nowiki></code>, <code><nowiki>factionIncreaseBoost</nowiki></code>, <code><nowiki>factionDecreaseBoost</nowiki></code>, <code><nowiki>lbReceiveItemReward</nowiki></code>, <code><nowiki>lbReceiveSpecialReward</nowiki></code>, <code><nowiki>bossReceiveItemReward</nowiki></code>, <code><nowiki>bossReceiveSpecialReward</nowiki></code>, <code><nowiki>eggCreate</nowiki></code>, <code><nowiki>eggAbandon</nowiki></code>, <code><nowiki>eggTransfer</nowiki></code>, <code><nowiki>eggLocate</nowiki></code>, <code><nowiki>eggHatch</nowiki></code>, <code><nowiki>petTransfer</nowiki></code>, <code><nowiki>petRelease</nowiki></code>, <code><nowiki>specialUse</nowiki></code>, <code><nowiki>specialFind</nowiki></code>, <code><nowiki>giveawayItemTransfer</nowiki></code>, <code><nowiki>supportGrantItem</nowiki></code>, <code><nowiki>marketListingCreated</nowiki></code>, <code><nowiki>marketListingDelisted</nowiki></code> === UserLeaderboardType === {| class="wikitable" |- ! <code><nowiki>lbType</nowiki></code> ! Description ! Required extra field |- | <code><nowiki>wallet</nowiki></code> | Richest by BC balance | β |- | <code><nowiki>inventoryWorth</nowiki></code> | Richest by inventory value | β |- | <code><nowiki>rank</nowiki></code> | Highest rank | β |- | <code><nowiki>questLevel</nowiki></code> | Highest quest level | β |- | <code><nowiki>streak</nowiki></code> | Longest daily claim streak | β |- | <code><nowiki>stat</nowiki></code> | Any tracked statistic | <code><nowiki>stat</nowiki></code> (a key of UserStats, excluding <code><nowiki>bcId</nowiki></code>) |- | <code><nowiki>item</nowiki></code> | Most of a specific item | <code><nowiki>itemId</nowiki></code> |- | <code><nowiki>trophy</nowiki></code> | Most of a specific trophy | <code><nowiki>trophyId</nowiki></code> |} === StatKey (for <code><nowiki>lbType: "stat"</nowiki></code>) === Any key of [[Data API/Types#UserStats|<code><nowiki>UserStats</nowiki></code>]] except <code><nowiki>bcId</nowiki></code>: <code><nowiki>incomeDaily</nowiki></code>, <code><nowiki>incomeWeekly</nowiki></code>, <code><nowiki>incomeTotal</nowiki></code>, <code><nowiki>timesFished</nowiki></code>, <code><nowiki>timesHunted</nowiki></code>, <code><nowiki>timesExplored</nowiki></code>, <code><nowiki>timesMined</nowiki></code>, <code><nowiki>timesWorked</nowiki></code>, <code><nowiki>itemsFound</nowiki></code>, <code><nowiki>rareItemsFound</nowiki></code>, <code><nowiki>itemsCrafted</nowiki></code>, <code><nowiki>itemsHarvested</nowiki></code>, <code><nowiki>timesWatered</nowiki></code>, <code><nowiki>bcEarnedFromGens</nowiki></code>, <code><nowiki>petItemsFound</nowiki></code>, <code><nowiki>petItemsFed</nowiki></code>, <code><nowiki>petsBred</nowiki></code>, <code><nowiki>questsCompleted</nowiki></code>, <code><nowiki>fpContributed</nowiki></code>, <code><nowiki>timesPlayedCoinflip</nowiki></code>, <code><nowiki>netCoinflipProfitDaily</nowiki></code>, <code><nowiki>netCoinflipProfitWeekly</nowiki></code>, <code><nowiki>netCoinflipProfitTotal</nowiki></code>, <code><nowiki>bcBurnedDaily</nowiki></code>, <code><nowiki>bcBurnedWeekly</nowiki></code>, <code><nowiki>bcBurnedTotal</nowiki></code>, <code><nowiki>bossDamage</nowiki></code>, <code><nowiki>marketListingsSold</nowiki></code>, <code><nowiki>marketListingsRevenue</nowiki></code>, <code><nowiki>netBallPitProfit</nowiki></code>, <code><nowiki>museumCollectiblesFound</nowiki></code>, <code><nowiki>globalBoostsUsed</nowiki></code>, <code><nowiki>worthGivenAway</nowiki></code> === TrophyId === <code><nowiki>bossKillingBlow</nowiki></code>, <code><nowiki>topDayIncome</nowiki></code>, <code><nowiki>topWeekIncome</nowiki></code>, <code><nowiki>topDayBurn</nowiki></code>, <code><nowiki>topWeekBurn</nowiki></code>, <code><nowiki>topDayBet</nowiki></code>, <code><nowiki>topWeekBet</nowiki></code>, <code><nowiki>topDayFunhouse</nowiki></code>, <code><nowiki>topWeekFunhouse</nowiki></code>, <code><nowiki>bottomDayFunhouse</nowiki></code>, <code><nowiki>bottomWeekFunhouse</nowiki></code>, <code><nowiki>dust</nowiki></code>, <code><nowiki>findSpecial</nowiki></code>, <code><nowiki>donor</nowiki></code>, <code><nowiki>lotwin</nowiki></code>, <code><nowiki>wewert</nowiki></code>, <code><nowiki>based</nowiki></code>, <code><nowiki>composer</nowiki></code>, <code><nowiki>bcbeta</nowiki></code>, <code><nowiki>summer2022Event</nowiki></code>, <code><nowiki>winter2024Lv125</nowiki></code>, <code><nowiki>winter2024Lv250</nowiki></code>, <code><nowiki>winter2024Lv375</nowiki></code>, <code><nowiki>winter2024Lv500</nowiki></code>, <code><nowiki>spring2025Lv250</nowiki></code>, <code><nowiki>spring2025Lv500</nowiki></code>, <code><nowiki>spring2025Lv750</nowiki></code>, <code><nowiki>spring2025Lv1000</nowiki></code>, <code><nowiki>topSeasonQuestLevel</nowiki></code>, <code><nowiki>top10SeasonQuestLevel</nowiki></code>, <code><nowiki>bconomySmp2025</nowiki></code>, <code><nowiki>summer2025Lv125</nowiki></code>, <code><nowiki>summer2025Lv250</nowiki></code>, <code><nowiki>summer2025Lv500</nowiki></code>, <code><nowiki>summer2025Lv1000</nowiki></code>, <code><nowiki>wewertTwo</nowiki></code>, <code><nowiki>fall2025Lv100</nowiki></code>, <code><nowiki>fall2025Lv250</nowiki></code>, <code><nowiki>fall2025Lv500</nowiki></code>, <code><nowiki>fall2025Lv1000</nowiki></code>, <code><nowiki>fall2025Lv2500</nowiki></code>, <code><nowiki>fall2025Lv5000</nowiki></code>, <code><nowiki>winter2025Lv100</nowiki></code>, <code><nowiki>winter2025Lv250</nowiki></code>, <code><nowiki>winter2025Lv500</nowiki></code>, <code><nowiki>winter2025Lv1000</nowiki></code>, <code><nowiki>winter2025Lv2500</nowiki></code>, <code><nowiki>winter2025Lv5000</nowiki></code>, <code><nowiki>dolphinCollector</nowiki></code>, <code><nowiki>otterCollector</nowiki></code>, <code><nowiki>gooseCollector</nowiki></code>, <code><nowiki>sealCollector</nowiki></code>, <code><nowiki>whaleCollector</nowiki></code>, <code><nowiki>turtleCollector</nowiki></code>, <code><nowiki>eagleCollector</nowiki></code>, <code><nowiki>tigerCollector</nowiki></code>, <code><nowiki>gorillaCollector</nowiki></code>, <code><nowiki>crocodileCollector</nowiki></code>, <code><nowiki>snakeCollector</nowiki></code>, <code><nowiki>poodleCollector</nowiki></code>, <code><nowiki>dogCollector</nowiki></code>, <code><nowiki>mustangCollector</nowiki></code>, <code><nowiki>pigCollector</nowiki></code>, <code><nowiki>peacockCollector</nowiki></code>, <code><nowiki>donkeyCollector</nowiki></code>, <code><nowiki>oxCollector</nowiki></code>, <code><nowiki>junglefowlCollector</nowiki></code>, <code><nowiki>rabbitCollector</nowiki></code>, <code><nowiki>doveCollector</nowiki></code>, <code><nowiki>kangarooCollector</nowiki></code>, <code><nowiki>batCollector</nowiki></code>, <code><nowiki>ratCollector</nowiki></code>, <code><nowiki>snailCollector</nowiki></code>, <code><nowiki>lizardCollector</nowiki></code>, <code><nowiki>dragonCollector</nowiki></code>, <code><nowiki>phoenixCollector</nowiki></code>, <code><nowiki>visitorCollector</nowiki></code>, <code><nowiki>invaderCollector</nowiki></code>, <code><nowiki>scorpionCollector</nowiki></code>, <code><nowiki>sauropodCollector</nowiki></code>, <code><nowiki>tyrannosaurusCollector</nowiki></code>, <code><nowiki>jackCollector</nowiki></code>, <code><nowiki>ghostCollector</nowiki></code>, <code><nowiki>owlCollector</nowiki></code>, <code><nowiki>snowmanCollector</nowiki></code>, <code><nowiki>cockroachCollector</nowiki></code>, <code><nowiki>eggstravagant</nowiki></code> === PrestigePerkId === <code><nowiki>raiseBurnItemReturn</nowiki></code>, <code><nowiki>raiseWorkBonusChance</nowiki></code>, <code><nowiki>lowerRankCost</nowiki></code>, <code><nowiki>lowerTierCost</nowiki></code>, <code><nowiki>raiseRareItemMultiplier</nowiki></code>, <code><nowiki>raiseCoinflipLimit</nowiki></code>, <code><nowiki>raisePetMaxTier</nowiki></code>, <code><nowiki>lowerWaterFarmCooldown</nowiki></code>, <code><nowiki>raiseMaxSameItemPlanted</nowiki></code>, <code><nowiki>raisePetSpace</nowiki></code>, <code><nowiki>lowerBuddySwapCooldown</nowiki></code>, <code><nowiki>raiseEquipSlots</nowiki></code>, <code><nowiki>raiseGeneratorIdleTime</nowiki></code>, <code><nowiki>raiseFarmCropsDieTime</nowiki></code>, <code><nowiki>raisePetCravingXpMultiplier</nowiki></code>, <code><nowiki>raiseChanceToIgnoreCooldownForAction</nowiki></code>, <code><nowiki>raisePetFeedAdditionalItemOutput</nowiki></code>, <code><nowiki>raiseFarmHarvestAdditionalItemOutput</nowiki></code>, <code><nowiki>lowerPetBreedCooldown</nowiki></code>, <code><nowiki>raisePetEnergyCapacity</nowiki></code>, <code><nowiki>lowerPetBreedCost</nowiki></code>, <code><nowiki>raiseToolAugmentationSlots</nowiki></code>, <code><nowiki>raiseFarmWaterByproducts</nowiki></code>, <code><nowiki>raiseMarketAccessLevel</nowiki></code>, <code><nowiki>raiseMaxDailyReward</nowiki></code>, <code><nowiki>reduceMarketTransactionFee</nowiki></code> <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]]
Summary:
Please note that all contributions to Bconomy Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
Bconomy Wiki:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Search
Search
Editing
Data API/Types
Add topic