@mcsb/api / Exports / HypixelAPI

Class: HypixelAPI ​

Interface for requesting data from the Hypixel API.

Example

const hypixel = await HypixelAPI.create({
    apiKey: "98cb0f8d-b14d-4b29-ae84-0a4d2bf35039"
})

const boosters = await hypixel.getBoosters() // HypixelBooster[]

const hypixel = await HypixelAPI.create({
    apiKey: "98cb0f8d-b14d-4b29-ae84-0a4d2bf35039"
})

const boosters = await hypixel.getBoosters() // HypixelBooster[]

Hierarchy ​

• BaseAPI<HypixelAPIOptions>

  ↳ HypixelAPI

Table of contents ​

Properties ​

• options

Methods ​

• areBoostersActive
• destroy
• getBoosters
• getGuild
• getLeaderboards
• getPlayer
• getPlayerCounts
• getPunishmentStatistics
• getRecentGames
• getResources
• getSkyBlockAuctionById
• getSkyBlockAuctions
• getSkyBlockAuctionsByPlayer
• getSkyBlockAuctionsByProfile
• getSkyBlockBazaarProducts
• getSkyBlockBingoProfiles
• getSkyBlockEndedAuctions
• getSkyBlockFiresales
• getSkyBlockMuseums
• getSkyBlockNews
• getSkyBlockProfile
• getSkyBlockProfiles
• getStatus
• rawRequest
• request
• create

Properties ​

options ​

• Protected Readonly options: Readonly<{ apiKey: string ; deferPolicy: null | IDeferPolicy<Response> ; httpClient: HttpClient }>

The options provided to the constructor, parsed by parseOptions.

Inherited from ​

BaseAPI.options

Defined in ​

packages/api/src/BaseAPI.ts:127

Methods ​

areBoostersActive ​

▸ areBoostersActive(): Promise<boolean>

Check whether booster timers are currently counting down. Boosters are occasionally paused during maintenance or server-wide issues.

Returns ​

Promise<boolean>

A Promise that resolves to true if boosters are active, or false otherwise.

See

• getBoosters
• HypixelBooster
• https://api.hypixel.net/#tag/Other/paths/~1boosters/get

Throws

• Error if an invalid Hypixel API key was provided to the constructor.
• Error if the HTTP request to the Hypixel API failed
• Error if the Hypixel API rate limit has been reached. APIOptions.deferPolicy can help avoid this. Can occur if the API has an emergency global throttle applied as well.

Defined in ​

packages/api/src/HypixelAPI.ts:489

destroy ​

▸ destroy(): void

Destroy this API instance, primarily by shutting down the HttpClient. Failure to do so may leave your program hanging if you do not explicitly interrupt it.

Returns ​

void

Inherited from ​

BaseAPI.destroy

Defined in ​

packages/api/src/BaseAPI.ts:279

getBoosters ​

▸ getBoosters(raw?): Promise<{ _id: string ; amount?: null | number ; dateActivated?: null | UnixDate ; gameType?: null | number ; length?: null | number ; originalLength?: null | number ; purchaserUuid?: null | string ; stacked?: null | boolean | readonly string[] } & { getDateScheduled: (this: { _id: string ; amount?: null | number ; dateActivated?: null | UnixDate ; gameType?: null | number ; length?: null | number ; originalLength?: null | number ; purchaserUuid?: null | string ; stacked?: null | boolean | readonly string[] }) => null | Date ; stackedIterator: (this: { _id: string ; amount?: null | number ; dateActivated?: null | UnixDate ; gameType?: null | number ; length?: null | number ; originalLength?: null | number ; purchaserUuid?: null | string ; stacked?: null | boolean | readonly string[] }) => AsyncIterableIterator<undefined | null | Readonly<{ SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; selected?: boolean...>[] ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string } & { getGuild: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; selected?: boolean...>[] ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => Promise<undefined | null | Readonly<{ _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" } & { getLevel: (this: { _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" }) => number }>> ; getLevel: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; selected?: boolean...>[] ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => number ; getRecentGames: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; selected?: boolean...>[] ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => Promise<Readonly<{ date?: null | UnixDate ; ended?: null | UnixDate ; gameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; map?: null | string ; mode?: null | string }>[]> ; getSession: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; selected?: boolean...>[] ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => Promise<null | Readonly<{ gameType?: null | string ; map?: null | string ; mode?: null | string ; online?: null | boolean }>> }>> }[]>

Retrieve a list of active Hypixel Boosters from the Hypixel API via the /boosters endpoint.

Parameters ​

Returns ​

Promise<{ _id: string ; amount?: null | number ; dateActivated?: null | UnixDate ; gameType?: null | number ; length?: null | number ; originalLength?: null | number ; purchaserUuid?: null | string ; stacked?: null | boolean | readonly string[] } & { getDateScheduled: (this: { _id: string ; amount?: null | number ; dateActivated?: null | UnixDate ; gameType?: null | number ; length?: null | number ; originalLength?: null | number ; purchaserUuid?: null | string ; stacked?: null | boolean | readonly string[] }) => null | Date ; stackedIterator: (this: { _id: string ; amount?: null | number ; dateActivated?: null | UnixDate ; gameType?: null | number ; length?: null | number ; originalLength?: null | number ; purchaserUuid?: null | string ; stacked?: null | boolean | readonly string[] }) => AsyncIterableIterator<undefined | null | Readonly<{ SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; selected?: boolean...>[] ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string } & { getGuild: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; selected?: boolean...>[] ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => Promise<undefined | null | Readonly<{ _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" } & { getLevel: (this: { _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" }) => number }>> ; getLevel: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; selected?: boolean...>[] ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => number ; getRecentGames: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; selected?: boolean...>[] ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => Promise<Readonly<{ date?: null | UnixDate ; ended?: null | UnixDate ; gameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; map?: null | string ; mode?: null | string }>[]> ; getSession: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; selected?: boolean...>[] ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => Promise<null | Readonly<{ gameType?: null | string ; map?: null | string ; mode?: null | string ; online?: null | boolean }>> }>> }[]>

A Promise that resolves with an array of HypixelBooster objects, or an empty array if there are no active boosters.

See

https://api.hypixel.net/#tag/Other/paths/~1boosters/get

Throws

• Error if an invalid Hypixel API key was provided to the constructor.
• Error if the HTTP request to the Hypixel API failed
• Error if the Hypixel API rate limit has been reached. APIOptions.deferPolicy can help avoid this. Can occur if the API has an emergency global throttle applied as well.

Defined in ​

packages/api/src/HypixelAPI.ts:507

▸ getBoosters(raw?): Promise<RawResponse>

Retrieve a list of active Hypixel Boosters from the Hypixel API via the /boosters endpoint.

Parameters ​

Returns ​

Promise<RawResponse>

A Promise that resolves with a RawResponse containing the raw data fetched from the Hypixel API.

See

https://api.hypixel.net/#tag/Other/paths/~1boosters/get

Throws

• Error if an invalid Hypixel API key was provided to the constructor.
• Error if the HTTP request to the Hypixel API failed
• Error if the Hypixel API rate limit has been reached. APIOptions.deferPolicy can help avoid this. Can occur if the API has an emergency global throttle applied as well.

Defined in ​

packages/api/src/HypixelAPI.ts:520

getGuild ​

▸ getGuild(id, raw?): Promise<undefined | null | Readonly<{ _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" } & { getLevel: (this: { _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" }) => number }>>

Retrieve data about a Hypixel Guild from the Hypixel API via the /guild endpoint.

Parameters ​

Returns ​

Promise<undefined | null | Readonly<{ _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" } & { getLevel: (this: { _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" }) => number }>>

A Promise that resolves with a HypixelGuild object, or null if the guild does not exist.

See

• https://api.hypixel.net/#tag/Player-Data/paths/~1guild/get
• https://www.mongodb.com/docs/manual/reference/method/ObjectId/

Throws

• Error if an invalid Hypixel API key was provided to the constructor.
• Error if the HTTP request to the Hypixel API failed
• Error if the Hypixel API rate limit has been reached. APIOptions.deferPolicy can help avoid this. Can occur if the API has an emergency global throttle applied as well.

Defined in ​

packages/api/src/HypixelAPI.ts:387

▸ getGuild(name, raw?): Promise<undefined | null | Readonly<{ _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" } & { getLevel: (this: { _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" }) => number }>>

Retrieve data about a Hypixel Guild from the Hypixel API via the /guild endpoint.

Parameters ​

Returns ​

Promise<undefined | null | Readonly<{ _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" } & { getLevel: (this: { _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" }) => number }>>

A Promise that resolves with a HypixelGuild object, or null if the guild does not exist.

See

https://api.hypixel.net/#tag/Player-Data/paths/~1guild/get

Throws

• Error if an invalid Hypixel API key was provided to the constructor.
• Error if the HTTP request to the Hypixel API failed
• Error if the Hypixel API rate limit has been reached. APIOptions.deferPolicy can help avoid this. Can occur if the API has an emergency global throttle applied as well.

Defined in ​

packages/api/src/HypixelAPI.ts:401

▸ getGuild(playerUuid, raw?): Promise<undefined | null | Readonly<{ _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" } & { getLevel: (this: { _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" }) => number }>>

Retrieve data about a Hypixel Guild from the Hypixel API via the /guild endpoint.

Parameters ​

Returns ​

Promise<undefined | null | Readonly<{ _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" } & { getLevel: (this: { _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" }) => number }>>

A Promise that resolves with a HypixelGuild object, or null if the guild does not exist.

See

https://api.hypixel.net/#tag/Player-Data/paths/~1guild/get

Throws

• Error if an invalid Hypixel API key was provided to the constructor.
• Error if the HTTP request to the Hypixel API failed
• Error if the Hypixel API rate limit has been reached. APIOptions.deferPolicy can help avoid this. Can occur if the API has an emergency global throttle applied as well.

Defined in ​

packages/api/src/HypixelAPI.ts:416

▸ getGuild(id, raw?): Promise<RawResponse>

Retrieve data about a Hypixel Guild from the Hypixel API via the /guild endpoint.

Parameters ​

Returns ​

Promise<RawResponse>

A Promise that resolves with a RawResponse containing the raw data fetched from the Hypixel API.

See

• https://api.hypixel.net/#tag/Player-Data/paths/~1guild/get
• https://www.mongodb.com/docs/manual/reference/method/ObjectId/

Throws

• Error if an invalid Hypixel API key was provided to the constructor.
• Error if the HTTP request to the Hypixel API failed
• Error if the Hypixel API rate limit has been reached. APIOptions.deferPolicy can help avoid this. Can occur if the API has an emergency global throttle applied as well.

Defined in ​

packages/api/src/HypixelAPI.ts:431

▸ getGuild(name, raw?): Promise<RawResponse>

Retrieve data about a Hypixel Guild from the Hypixel API via the /guild endpoint.

Parameters ​

Returns ​

Promise<RawResponse>

A Promise that resolves with a RawResponse containing the raw data fetched from the Hypixel API.

See

https://api.hypixel.net/#tag/Player-Data/paths/~1guild/get

Throws

• Error if an invalid Hypixel API key was provided to the constructor.
• Error if the HTTP request to the Hypixel API failed
• Error if the Hypixel API rate limit has been reached. APIOptions.deferPolicy can help avoid this. Can occur if the API has an emergency global throttle applied as well.

Defined in ​

packages/api/src/HypixelAPI.ts:445

▸ getGuild(playerUuid, raw?): Promise<RawResponse>

Retrieve data about a Hypixel Guild from the Hypixel API via the /guild endpoint.

Parameters ​

Returns ​

Promise<RawResponse>

A Promise that resolves with a RawResponse containing the raw data fetched from the Hypixel API.

See

https://api.hypixel.net/#tag/Player-Data/paths/~1guild/get

Throws

• Error if an invalid Hypixel API key was provided to the constructor.
• Error if the HTTP request to the Hypixel API failed
• Error if the Hypixel API rate limit has been reached. APIOptions.deferPolicy can help avoid this. Can occur if the API has an emergency global throttle applied as well.

Defined in ​

packages/api/src/HypixelAPI.ts:460

getLeaderboards ​

▸ getLeaderboards(raw?): Promise<Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", readonly { count: number ; leaders: readonly string[] ; location: string ; path: string ; prefix: string ; title: string } & { [asyncIterator]: (this: { count: number ; leaders: readonly string[] ; location: string ; path: string ; prefix: string ; title: string }) => AsyncIterableIterator<undefined | null | Readonly<{ SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; ... ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string } & { getGuild: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; ... ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => Promise<undefined | null | Readonly<{ _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | ... 16 more ... | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" } & { getLevel: (this: { _id: string ; achievements: Readonly<Partial<Record<"EXPERIENCE_KINGS" | "WINNERS" | "ONLINE_PLAYERS", number>>> ; banner?: null | Readonly<{ Base: number; Patterns: readonly Readonly<{ Pattern: string; Color: string; }>[]; }> ; chatMute?: null | number ; coins?: null | number ; coinsEver?: null | number ; created?: null | UnixDate ; description?: null | string ; exp?: null | number ; guildExpByGameType: Readonly<Partial<Record<"QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD", number>>> ; joinable?: null | boolean ; legacyRanking?: null | number ; members: { uuid: string; rank: string; joined: UnixDate; expHistory: Readonly<Record<string, number>>; mutedTill?: UnixDate | null | undefined; questParticipation?: number | ... 1 more ... | undefined; }[] ; name?: null | string ; name_lower?: null | string ; preferredGames: readonly ("QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | ... 16 more ... | "GINGERBREAD")[] ; publiclyListed?: null | boolean ; ranks: { default: boolean; name: string; tag?: string | null | undefined; created?: UnixDate | null | undefined; priority?: number | null | undefined; }[] ; tag?: null | string ; tagColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" }) => number }>> ; getLevel: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; ... ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => number ; getRecentGames: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; ... ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => Promise<Readonly<{ date?: null | UnixDate ; ended?: null | UnixDate ; gameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; map?: null | string ; mode?: null | string }>[]> ; getSession: (this: { SANTA_FINISHED?: null | boolean ; SANTA_QUEST_STARTED?: null | boolean ; _id: string ; achievementPoints?: null | number ; achievementRewardsNew: Readonly<Record<string, UnixDate>> ; achievementSync?: null | Readonly<{ quake_tiered?: number | null | undefined; }> ; achievementTotem?: null | Readonly<{ unlockedParts: readonly string[]; selectedPart: Readonly<Partial<Record<`slot_${number}`, string>>>; unlockedColors: readonly string[]; selectedColors: Readonly<Partial<Record<`slotcolor_${number}`, string>>>; canCustomize?: boolean | ... 1 more ... | undefined; allowed_max_height?: number | ... 1 more ... | undef...> ; achievementTracking?: null | readonly string[] ; achievements: Readonly<Record<string, number>> ; achievementsOneTime: readonly string[] ; adsense_tokens?: null | number ; adventureTester?: null | boolean ; autoDetectLanguage?: null | boolean ; auto_spawn_pet?: null | boolean ; battlePassGlowStatus?: null | boolean ; challenges: Readonly<Record<string, Readonly<Record<string, number>>>> ; channel?: null | string ; chat?: null | boolean ; cooldowns?: null | Readonly<{ fun: Readonly<Record<string, number>>; }> ; currentClickEffect?: null | string ; currentGadget?: null | string ; currentPet?: null | string ; disguise?: null | string ; displayname?: null | string ; eugene?: null | Readonly<{ dailyTwoKExp?: UnixDate | null | undefined; weekly_booster?: UnixDate | null | undefined; }> ; eulaCoins?: null | boolean ; fireworkStorage?: null | readonly Readonly<{ flight_duration?: number | null | undefined; shape?: "BURST" | "STAR" | "BALL_LARGE" | "BALL" | "CREEPER" | null | undefined; trail?: boolean | null | undefined; twinkle?: boolean | null | undefined; colors?: string | ... 1 more ... | undefined; fade_colors?: string | ... 1 more ... | undefined; ... ; firstLogin?: null | UnixDate ; flashingNewsOpens?: null | number ; flashingNewsPoppedUp?: null | number ; flashingNewsPopup?: null | readonly number[] ; flashingSaleOpens?: null | number ; flashingSalePoppedUp?: null | number ; flashingSalePopup?: null | UnixDate ; fortuneBuff?: null | number ; gadget?: null | string ; giftingMeta?: null | Readonly<{ milestones: readonly string[]; rankgiftingmilestones: readonly string[]; giftsGiven?: number | null | undefined; bundlesGiven?: number | null | undefined; realBundlesGiven?: number | null | undefined; realBundlesReceivedInc?: number | ... 1 more ... | undefined; bundlesReceived?: number | ... 1 more ... | undefine...> ; guildNotifications?: null | boolean ; housingMeta?: null | Readonly<{ packages: readonly string[]; allowedBlocks: readonly string[]; selectedChannels_v3: readonly string[]; tutorialStep?: string | null | undefined; visibilityDisabled?: boolean | null | undefined; toggle_BORDER?: boolean | null | undefined; ... 4 more ...; plotSize?: string | ... 1 more ... | undefined; }> ; karma?: null | number ; lastAdsenseGenerateTime?: null | UnixDate ; lastClaimedReward?: null | UnixDate ; lastLogin?: null | UnixDate ; lastLogout?: null | UnixDate ; legacyGolem?: null | boolean ; leveling: { claimedRewards: readonly number[]; } ; monthlyPackageRank?: null | string ; monthlyRankColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; monthlycrates: Readonly<Record<string, { REGULAR?: boolean | null | undefined; VIP?: boolean | null | undefined; VIP_PLUS?: boolean | null | undefined; MVP?: boolean | null | undefined; MVP_PLUS?: boolean | null | undefined; }>> ; mostRecentGameType?: null | "QUAKECRAFT" | "SKYCLASH" | "BUILD_BATTLE" | "UHC" | "LEGACY" | "SKYBLOCK" | "HOUSING" | "MCGO" | "WOOL_GAMES" | "SURVIVAL_GAMES" | "BATTLEGROUND" | "MURDER_MYSTERY" | "ARCADE" | "ARENA" | "TNTGAMES" | "WALLS" | "SKYWARS" | "VAMPIREZ" | "PROTOTYPE" | "WALLS3" | "BEDWARS" | "PAINTBALL" | "SUPER_SMASH" | "SMP" | "REPLAY" | "TRUE_COMBAT" | "PIT" | "SPEED_UHC" | "DUELS" | "GINGERBREAD" ; mostRecentMinecraftVersion?: null | number ; mostRecentMonthlyPackageRank?: null | string ; mostRecentlyThanked?: null | string ; mostRecentlyThankedUuid?: null | string ; mostRecentlyTipped?: null | string ; mostRecentlyTippedUuid?: null | string ; networkExp?: null | number ; network_update_book?: null | string ; newPackageRank?: null | string ; notifications?: null | boolean ; onetime_achievement_menu_sort_completion_sort?: null | string ; packageRank?: null | string ; parkourCheckpointBests: Readonly<Record<string, Readonly<Record<number, number>>>> ; parkourCompletions?: null | Readonly<Record<string, Readonly<{ timeStart: UnixDate; timeTook: number; }>[]>> ; petConsumables: Readonly<Partial<Record<"CARROT_ITEM" | "BAKED_POTATO" | "FEATHER" | "ROTTEN_FLESH" | "SLIME_BALL" | "COOKED_BEEF" | "RAW_FISH" | "WATER_BUCKET" | "WOOD_SWORD" | "MILK_BUCKET" | "GOLD_RECORD" | "PORK" | "PUMPKIN_PIE" | "LEASH" | "LAVA_BUCKET" | "MAGMA_CREAM" | "WHEAT" | "HAY_BLOCK" | "BREAD" | "RED_ROSE" | "STICK" | "BONE" | "APPLE" | "MUSHROOM_SOUP" | "COOKIE" | "CAKE" | "MELON", number>>> ; petJourneyTimestamp?: null | UnixDate ; petStats: Readonly<Record<string, undefined | null | Readonly<{ THIRST?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | null | undefined; }> | null | undefined; HUNGER?: Readonly<{ value?: number | null | undefined; timestamp?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; EXERCISE?: Readonly<...> | ... 1 more ... | undefined; experience?:...>>> ; playername?: null | string ; plotResets?: null | Readonly<{ time?: UnixDate | null | undefined; uuid?: string | null | undefined; }> ; questSettings?: null | Readonly<{ autoActivate?: boolean | null | undefined; }> ; quests: Readonly<Record<string, { completions: readonly Readonly<{ time?: UnixDate | null | undefined; }>[]; active?: Readonly<{ objectives: Readonly<Record<string, number | boolean>>; started?: UnixDate | ... 1 more ... | undefined; }> | null | undefined; }>> ; rank?: null | string ; rankPlusColor?: null | "BLACK" | "DARK_BLUE" | "DARK_GREEN" | "DARK_AQUA" | "DARK_RED" | "DARK_PURPLE" | "GOLD" | "GRAY" | "DARK_GRAY" | "BLUE" | "GREEN" | "AQUA" | "RED" | "LIGHT_PURPLE" | "YELLOW" | "WHITE" | "OBFUSCATED" | "BOLD" | "STRIKE" | "UNDERLINE" | "ITALIC" | "RESET" ; rewardConsumed?: null | boolean ; rewardHighScore?: null | number ; rewardScore?: null | number ; rewardStreak?: null | number ; seasonal: Readonly<Record<string, any>> ; seeRequests?: null | boolean ; sendCerberusMessages?: null | boolean ; skyblock_free_cookie?: null | UnixDate ; socialMedia?: null | Readonly<{ links?: Readonly<{ TWITTER?: string | URL | null | undefined; YOUTUBE?: string | URL | null | undefined; INSTAGRAM?: string | URL | null | undefined; TWITCH?: string | URL | null | undefined; HYPIXEL?: string | ... 2 more ... | undefined; DISCORD?: string | ... 1 more ... | undefined; }> | null | undefined; prompt...> ; specialtyCooldowns: Readonly<Record<string, boolean>> ; spectators_invisible?: null | boolean ; stats?: any ; testPass?: null | boolean ; thanksReceived?: null | number ; thanksSent?: null | number ; timePlaying?: null | number ; totalDailyRewards?: null | number ; totalRewards?: null | number ; tournamentTokens?: null | number ; tourney?: null | Readonly<Readonly<{ first_join_lobby?: UnixDate | null | undefined; total_tributes?: number | null | undefined; }>> | Readonly<Record<string, undefined | null | Readonly<{ tributes_earned?: number | null | undefined; first_win?: UnixDate | null | undefined; playtime?: number | null | undefined; claimed_ranking_reward?: UnixDate | null | undefined; }>>> ; transformation?: null | string ; userLanguage?: null | string ; uuid: string ; vanityConvertedBoxToday?: null | number ; vanityFavorites?: null | string ; vanityFirstConvertedBox?: null | UnixDate ; vanityMeta?: null | Readonly<{ packages: readonly string[]; }> ; voting?: null | Readonly<Record<string, number>> ; wardrobe?: null | string }) => Promise<null | Readonly<{ gameType?: null | string ; map?: null | string ; mode?: null | string ; online?: null | boolean }>> }>> }[]>>>>