Package-level declarations

Types

Link copied to clipboard
@Serializable
data class AccessoryBagStorage(val tuning: Map<String, TuningSlot>? = null, val selectedPower: String? = null, val bagUpgradesPurchased: Int? = null, val unlockedPowers: List<String>? = null, val highestMagicalPower: Int? = null)
Link copied to clipboard
@Serializable
data class Attributes(val stacks: Map<String, Int>? = null)
Link copied to clipboard
@Serializable
data class Auction(val uuid: String? = null, val auctioneer: String? = null, val profileId: String? = null, val coop: List<String>? = null, val start: Long? = null, val end: Long? = null, val itemName: String? = null, val itemLore: String? = null, val extra: String? = null, val category: String? = null, val categories: List<String>? = null, val tier: String? = null, val startingBid: Long? = null, val itemBytes: String? = null, val claimed: Boolean? = null, val claimedBidders: List<String>? = null, val highestBidAmount: Long? = null, val lastUpdated: Long? = null, val bin: Boolean? = null, val bids: List<Bid>? = null, val itemUuid: String? = null)

Information about a specific auction.

Link copied to clipboard
@Serializable
data class AuctionsEndedResponse(val success: Boolean? = null, val cause: String? = null, val auctions: List<EndedAuction>? = null) : HypixelResponse

Information about the recently ended auctions.

Link copied to clipboard
@Serializable
data class AuctionsResponse(val success: Boolean? = null, val cause: String? = null, val page: Int? = null, val totalPages: Int? = null, val totalAuctions: Int? = null, val lastUpdated: Long? = null, val auctions: List<Auction>? = null) : HypixelResponse

Information about current auctions

Link copied to clipboard
@Serializable
data class Banking(val balance: Double? = null, val transactions: List<Transaction>? = null)
Link copied to clipboard
@Serializable
data class BazaarResponse(val success: Boolean? = null, val cause: String? = null, val lastUpdated: Long? = null, val products: Map<String, Product>? = null) : HypixelResponse

Information about the Bazaar

Link copied to clipboard
@Serializable
data class Bid(val auctionId: String? = null, val bidder: String? = null, val profileId: String? = null, val amount: Long? = null, val timestamp: Long? = null)

Information about a bid on an auction

Link copied to clipboard
@Serializable
data class BingoResponse(val success: Boolean? = null, val cause: String? = null, val lastUpdated: Long? = null, val id: Int? = null, val name: String? = null, val start: Long? = null, val end: Long? = null, val modifier: String? = null, val goals: List<Goal>? = null) : HypixelResponse

Information about the most recent Bingo.

Link copied to clipboard
@Serializable
data class Candidate(val key: String? = null, val name: String? = null, val perks: List<Perk>? = null, val votes: Int? = null)

Information about a candidate

Link copied to clipboard
@Serializable
data class CatacombsRequirement(val type: String? = null, val dungeonType: String? = null, val level: Int? = null)

Information about the catacombs requirements for an item

Link copied to clipboard
@Serializable
data class Collection(val name: String? = null, val items: Map<String, CollectionItem>? = null)

List of all collections.

Link copied to clipboard
@Serializable
data class CollectionItem(val name: String? = null, val maxTiers: Int? = null, val tiers: List<CollectionTier>? = null)

Information about a collection.

Link copied to clipboard
@Serializable
data class CollectionsResponse(val success: Boolean? = null, val cause: String? = null, val lastUpdated: Long? = null, val version: String? = null, val collections: Map<String, Collection>? = null) : HypixelResponse

Information about collections.

Link copied to clipboard
@Serializable
data class CollectionTier(val tier: Int? = null, val amountRequired: Int? = null, val unlocks: List<String>? = null)

Information about a collection item tier.

Link copied to clipboard
@Serializable
data class CommissionData(val visits: Map<Visitor, Int>? = null, val completed: Map<Visitor, Int>? = null, val totalCompleted: Int? = null, val uniqueVisitorsServed: Int? = null)

Information about visitor commissions.

Link copied to clipboard
@Serializable
data class CommunityUpgrades(val currentlyUpgrading: String? = null, val upgradeStates: List<UpgradeState>? = null)
Link copied to clipboard
@Serializable
data class ComposterData(val organicMatter: Double? = null, val fuel: Double? = null, val compostUnits: Int? = null, val compostItems: Int? = null, val conversionTicks: Int? = null, val lastSave: Long? = null, val upgrades: ComposterUpgrades? = null)

Information about the Garden's composter.

Link copied to clipboard
@Serializable
data class ComposterUpgrades(val speed: Int? = null, val multiDrop: Int? = null, val fuelCap: Int? = null, val organicMatterCap: Int? = null, val costReduction: Int? = null)

Upgrade levels for the composter.

Link copied to clipboard
@Serializable
data class Currencies(val coinPurse: Double? = null, val motesPurse: Double? = null, val essence: Map<String, EssenceInfo>? = null)
Link copied to clipboard
@Serializable
data class DungeonItemConversionCost(val essenceType: EssenceType? = null, val amount: Int? = null)

Information about to cost to convert an item to a dungeon item

Link copied to clipboard
@Serializable
data class Election(val year: Int? = null, val candidates: List<Candidate>? = null)

Information about an election.

Link copied to clipboard
@Serializable
data class ElectionResponse(val success: Boolean? = null, val cause: String? = null, val lastUpdated: Long? = null, val mayor: Mayor? = null, val current: Election? = null) : HypixelResponse

Information about the current election and next election.

Link copied to clipboard
@Serializable
data class EndedAuction(val auctionId: String? = null, val seller: String? = null, val sellerProfile: String? = null, val buyer: String? = null, val buyerProfile: String? = null, val timestamp: Long? = null, val price: Int? = null, val bin: Boolean? = null, val item: String? = null)

Information about an ended auction.

Link copied to clipboard
@Serializable
data class EssenceInfo(val current: Int? = null)
Link copied to clipboard
@Serializable
data class FairySoul(val fairyExchanges: Int? = null, val totalCollected: Int? = null, val unspentSouls: Int? = null)
Link copied to clipboard
@Serializable
data class FiresalesResponse(val success: Boolean? = null, val cause: String? = null, val sales: List<Sale>? = null) : HypixelResponse

Lists all current news entires. These are viewable through Jerry on the island.

Link copied to clipboard
@Serializable
data class ForagingCore(val dailyTreesCutDay: Int? = null, val dailyTreesCut: Int? = null, val dailyGifts: Int? = null, val dailyLogCutDay: Int? = null, val dailyLogCut: List<JsonElement>? = null, val forestWhispers: Long? = null, val forestWhispersSpent: Long? = null, val currentDailyEffect: String? = null, val currentDailyEffectLastChanged: Int? = null)
Link copied to clipboard
@Serializable
data class Forge(val forgeProcesses: Map<String, Map<String, JsonElement>>? = null)
Link copied to clipboard
@Serializable
data class Garden(val uuid: String? = null, val unlockedPlots: List<GardenPlot>? = null, val commissionData: CommissionData? = null, val resourcesCollected: Map<GardenResource, Long>? = null, val gardenExperience: Double? = null, val activeCommissions: List<JsonElement>? = null, val composterData: ComposterData? = null, val selectedBarnSkin: String? = null, val cropUpgradeLevels: Map<GardenResource, Int>? = null, val gardenUpgrades: Map<GardenUpgrade, Int>? = null, val unlockedBarnSkins: List<String>? = null, val greenhouseSlots: List<GreenhouseCoordinate>? = null, val lastGrowthStageTime: Long? = null)

Information about a player's Garden.

Link copied to clipboard
@Serializable
data class GardenPlayerData(val copper: Int? = null, val larvaConsumed: Int? = null, val analyzedGreenhouseCrops: List<String>? = null, val discoveredGreenhouseCrops: List<String>? = null)
Link copied to clipboard
@Serializable
data class GardenResponse(val success: Boolean? = null, val cause: String? = null, val garden: Garden? = null) : HypixelResponse

Information about a player's Garden.

Link copied to clipboard
@Serializable
data class GemstoneCost(val type: String? = null, val itemId: String? = null, val amount: Int? = null, val coins: Int? = null, val essenceType: EssenceType? = null)

Information about the cost for a gemstone slot

Link copied to clipboard
@Serializable
data class GemstoneRequirement(val type: String? = null, val dataKey: String? = null, val value: String? = null, val operator: String? = null)

Information about requirements to unlock a gemstone slot

Link copied to clipboard
@Serializable
data class GemstoneSlot(val slotType: String? = null, val costs: List<GemstoneCost>? = null, val requirements: List<GemstoneRequirement>? = null)

Information about the items gemstone slots

Link copied to clipboard
@Serializable
data class GlacitePlayerData(val fossilsDonated: List<String>? = null, val fossilDust: Double? = null, val corpsesLooted: Map<String, Int>? = null, val mineshaftsEntered: Int? = null)
Link copied to clipboard
@Serializable
data class Goal(val id: String? = null, val name: String? = null, val tiers: List<Int>? = null, val progress: Int? = null, val lore: String? = null, val fullLore: List<String>? = null, val requiredAmount: Int? = null)

Information about a Bingo goal.

Link copied to clipboard
@Serializable
data class GreenhouseCoordinate(val x: Int? = null, val y: Int? = null)
Link copied to clipboard
@Serializable
data class Item(val material: String? = null, val durability: Int? = null, val skin: Skin? = null, val name: String? = null, val category: String? = null, val tier: String? = null, val npcSellPrice: Int? = null, val id: String? = null, val salvages: List<Salvage>? = null, val raritySalvageable: Boolean? = null, val description: String? = null, val itemModel: String? = null, val stats: Map<StatType, Int>? = null, val unstackable: Boolean? = null, val dungeonItemConversionCost: DungeonItemConversionCost? = null, val upgradeCosts: List<List<UpgradeCost>>? = null, val museumData: MuseumData? = null, val requirements: List<Requirement>? = null, val color: String? = null, val soulbound: String? = null, val hasUuid: Boolean? = null, val canAuction: Boolean? = null, val gemstoneSlots: List<GemstoneSlot>? = null, val glowing: Boolean? = null, val canTrade: Boolean? = null, val canPlace: Boolean? = null, val museum: Boolean? = null, val generator: String? = null, val generatorTier: Int? = null, val furniture: String? = null, val itemSpecific: Map<String, JsonElement>? = null, val editioned: Boolean? = null, val gearScore: Int? = null, val dungeonItem: Boolean? = null, val catacombsRequirement: CatacombsRequirement? = null, val canHaveBooster: Boolean? = null, val hideFromApi: Boolean? = null, val canRecombobulate: Boolean? = null, val salvageableFromRecipe: Boolean? = null, val motesSellPrice: Int? = null, val doubleTapToDrop: Boolean? = null, val enchantments: Map<String, Int>? = null, val riftTransferrable: Boolean? = null, val origin: String? = null, val hideFromViewrecipeCommand: Boolean? = null, val forceWipeRecomb: Boolean? = null, val abilityDamageScaling: Int? = null, val tieredStats: Map<StatType, List<Int>>? = null, val crystal: String? = null, val canBurnInFurnace: Boolean? = null, val salvage: SalvageData? = null, val serializable: Boolean? = null, val canHaveAttributes: Boolean? = null, val canInteract: Boolean? = null, val canInteractRightClick: Boolean? = null, val privateIsland: String? = null, val canHavePowerScroll: Boolean? = null, val canInteractEntity: Boolean? = null, val miningFortune: Int? = null, val rarity: String? = null, val swordType: String? = null, val isUpgradeableWithoutSoulbinding: Boolean? = null, val recipes: List<Recipe>? = null, val cannotReforge: Boolean? = null, val loseMotesValueOnTransfer: Boolean? = null, val prestige: Prestige? = null)

Information about a Skyblock Item

Link copied to clipboard
@Serializable
data class ItemData(val soulflow: Int? = null, val favoriteArrow: String? = null)
Link copied to clipboard
@Serializable
data class ItemsResponse(val success: Boolean? = null, val cause: String? = null, val lastUpdated: Long? = null, val items: List<Item>? = null) : HypixelResponse

Information about Skyblock's items.

Link copied to clipboard
@Serializable
data class Level(val level: Int? = null, val totalExpRequired: Long? = null, val unlocks: List<String>? = null)

Information and rewards about a level

Link copied to clipboard
@Serializable
data class Leveling(val experience: Int? = null, val completions: Map<String, Int>? = null, val completedTasks: List<String>? = null, val highestPetScore: Int? = null, val miningFiestaOresMined: Int? = null, val migrated: Boolean? = null, val migratedCompletionsV2: Boolean? = null, val claimedTalisman: Boolean? = null, val bopBonus: String? = null, val emblemUnlocks: List<String>? = null, val categoryExpanded: Boolean? = null, val fishingFestivalSharksKilled: Int? = null, val taskSort: String? = null, val lastViewedTasks: List<String>? = null, val selectedSymbol: String? = null)
Link copied to clipboard
@Serializable
data class Mayor(val key: String? = null, val name: String? = null, val perks: List<Perk>? = null, val minister: Minister? = null, val election: Election? = null)

Information about the current Mayor.

Link copied to clipboard
@Serializable
data class MemberData(val rift: Rift? = null, val playerData: PlayerData? = null, val glacitePlayerData: GlacitePlayerData? = null, val profile: ProfileData? = null, val event: Event? = null, val gardenPlayerData: GardenPlayerData? = null, val skillTree: SkillTree? = null, val petsData: PetsData? = null, val accessoryBagStorage: AccessoryBagStorage? = null, val leveling: Leveling? = null, val itemData: ItemData? = null, val jacobsContent: JacobsContent? = null, val currencies: Currencies? = null, val foraging: Foraging? = null, val dungeons: Dungeons? = null, val playerId: String? = null, val crimsonIslePlayerData: CrimsonIslePlayerData? = null, val experimentation: Experimentation? = null, val foragingCore: ForagingCore? = null, val shards: Shards? = null, val miningCore: MiningCore? = null, val bestiary: Bestiary? = null, val quests: Quests? = null, val playerStats: PlayerStats? = null, val inventory: PlayerInventory? = null, val winterPlayerData: WinterPlayerData? = null, val forge: Forge? = null, val fairySoul: FairySoul? = null, val temples: Temples? = null, val sharedInventory: SharedInventory? = null, val attributes: Attributes? = null, val slayer: Slayer? = null, val trophyFish: Map<String, JsonElement>? = null, val objectives: List<Objective>? = null, val collection: Map<String, Long>? = null)
Link copied to clipboard
@Serializable
data class Minister(val key: String? = null, val name: String? = null, val perk: Perk? = null)

Information about the current Minister.

Link copied to clipboard
@Serializable
data class MuseumData(val category: String? = null, val parent: Map<MuseumItem, MuseumItem>? = null, val armorSetDonationXp: Map<MuseumItem, Int>? = null, val gameStage: String? = null, val donationXp: Int? = null)

Information about an items museum donation

Link copied to clipboard
@Serializable
data class MuseumItemData(val type: Int? = null, val data: String? = null)

Item data for a donated item.

Link copied to clipboard
@Serializable
data class MuseumItemInfo(val timeDonated: Long? = null, val featuredSlot: String? = null, val borrowing: Boolean? = null, val itemData: MuseumItemData? = null)

Information about a specific donatable item

Link copied to clipboard
@Serializable
data class MuseumMember(val value: Long? = null, val appraisal: Boolean? = null, val items: Map<MuseumItem, MuseumItemInfo>? = null, val special: List<SpecialItemInfo>? = null)

Information about a coop member's museum.

Link copied to clipboard
@Serializable
data class MuseumResponse(val success: Boolean? = null, val cause: String? = null, val members: Map<String, MuseumMember>? = null) : HypixelResponse

Information about a player's museum.

Link copied to clipboard
@Serializable
data class NewsItem(val title: String? = null, val text: String? = null, val link: String? = null, val item: NewsMaterial? = null)

Information about a news entry

Link copied to clipboard
@Serializable
data class NewsMaterial(val material: String? = null)

Material of the item.

Link copied to clipboard
@Serializable
data class NewsResponse(val success: Boolean? = null, val cause: String? = null, val news: List<NewsItem>? = null) : HypixelResponse

Lists all current news entires. These are viewable through Jerry on the island.

Link copied to clipboard
@Serializable
data class Objective(val status: String? = null, val progress: Double? = null, val completedAt: Long? = null, val data: Map<String, String> = emptyMap())
Link copied to clipboard
@Serializable
data class Perk(val name: String? = null, val description: String? = null, val minister: Boolean? = null)

Information about a mayor perk.

Link copied to clipboard
@Serializable
data class Prestige(val itemId: String? = null, val costs: List<GemstoneCost>? = null)

Information about Crimson Isle set upgrades

Link copied to clipboard
@Serializable
data class Product(val productId: String? = null, val sellSummary: List<Summary>? = null, val buySummary: List<Summary>? = null, val quickStatus: QuickStatus? = null)

Information about a bazaar product.

Link copied to clipboard
@Serializable
data class Profile(val profileId: String? = null, val communityUpgrades: CommunityUpgrades? = null, val members: Map<String, MemberData>? = null, val banking: Banking? = null)
Link copied to clipboard
@Serializable
data class ProfileData(val bankAccount: Double? = null, val firstJoin: Long? = null, val personalBankUpgrade: Int? = null, val cookieBuffActive: Boolean? = null)
Link copied to clipboard
@Serializable
data class ProfileResponse(val success: Boolean? = null, val cause: String? = null, val profile: Profile? = null) : HypixelResponse
Link copied to clipboard
@Serializable
data class ProfilesResponse(val success: Boolean? = null, val cause: String? = null, val profiles: List<Profile>? = null) : HypixelResponse

Information about a player's profiles

Link copied to clipboard
@Serializable
data class Quests(val trapperQuest: TrapperQuest? = null)
Link copied to clipboard
@Serializable
data class QuickStatus(val productId: String? = null, val sellPrice: Double? = null, val sellVolume: Long? = null, val sellMovingWeek: Long? = null, val sellOrders: Int? = null, val buyPrice: Double? = null, val buyVolume: Long? = null, val buyMovingWeek: Long? = null, val buyOrders: Int? = null)

General information about an item

Link copied to clipboard
@Serializable
data class Recipe(val output: RecipeOutput? = null, val ingredientSymbols: Map<String, String>? = null, val matrix: List<String?>? = null)

Information about a recipe to create the item

Link copied to clipboard
@Serializable
data class RecipeOutput(val itemId: String? = null)

Information about the item output

Link copied to clipboard
@Serializable
data class Requirement(val type: String? = null, val skill: SkillType? = null, val slayerBossType: String? = null, val level: Int? = null, val dungeonType: String? = null)

Information about item requirements

Link copied to clipboard
@Serializable
data class Sale(val itemId: String? = null, val start: Long? = null, val end: Long? = null, val amount: Int? = null, val price: Int? = null)

Information about a firesale

Link copied to clipboard
@Serializable
data class Salvage(val rewardType: String? = null, val essenceType: EssenceType? = null, val amount: Int? = null)

Rewards for salvaging the item

Link copied to clipboard
@Serializable
data class SalvageData(val itemId: String? = null, val amount: Int? = null)

Unknown. Used one time for an item with ID "NETHERITE_HELMET"

Link copied to clipboard
@Serializable
data class ShardOwned(val type: String? = null, val amountOwned: Int? = null, val captured: Long? = null)
Link copied to clipboard
@Serializable
data class Shards(val traps: Map<String, JsonElement>? = null, val shardSort: String? = null, val fusionResultSort: String? = null, val owned: List<ShardOwned>? = null)
Link copied to clipboard
@Serializable
data class SharedInventory(val carnivalMaskInventoryContents: InventoryObject? = null, val candyInventoryContents: InventoryObject? = null)
Link copied to clipboard
@Serializable
data class Skill(val name: String? = null, val description: String? = null, val maxLevel: Int? = null, val levels: List<Level>? = null)

Information about a skill

Link copied to clipboard
@Serializable
data class SkillsResponse(val success: Boolean? = null, val cause: String? = null, val lastUpdated: Long? = null, val version: String? = null, val skills: Map<SkillType, Skill>? = null) : HypixelResponse

Lists information about skills.

Link copied to clipboard
@Serializable
data class SkillTree(val nodes: Map<String, Map<String, JsonElement>>? = null)
Link copied to clipboard
@Serializable
data class Skin(val value: String? = null, val signature: String? = null)

Information about a player head

Link copied to clipboard
@Serializable
data class SpecialItemInfo(val timeDonated: Long? = null, val itemData: MuseumItemData? = null)

Information about an item donated to the special category

Link copied to clipboard
@Serializable
data class Summary(val amount: Int? = null, val pricePerUnit: Double? = null, val orders: Int? = null)

An order summary for a bazaar product

Link copied to clipboard
@Serializable
data class Temples(val unlockedTemples: List<String>? = null)
Link copied to clipboard
@Serializable
data class Transaction(val amount: Double? = null, val timestamp: Long? = null, val action: String? = null, val initiatorName: String? = null)
Link copied to clipboard
@Serializable
data class TrapperQuest(val lastTaskTime: Long? = null, val peltCount: Int? = null)
Link copied to clipboard
@Serializable
data class TuningSlot(val health: Int? = null, val defense: Int? = null, val walkSpeed: Int? = null, val strength: Int? = null, val criticalDamage: Int? = null, val criticalChance: Int? = null, val attackSpeed: Int? = null, val intelligence: Int? = null)
Link copied to clipboard
@Serializable
data class UpgradeCost(val type: String? = null, val essenceType: EssenceType? = null, val amount: Int? = null, val itemId: String? = null)

Information about an upgrade for a dungeon item

Link copied to clipboard
@Serializable
data class UpgradeState(val upgrade: String? = null, val tier: Int? = null, val startedMs: Long? = null, val startedBy: String? = null, val claimedBy: String? = null)
Link copied to clipboard
@Serializable
data class WinterPlayerData(val refinedJyrreUses: Int? = null)