API Reference

Every export is a pure function: raw Hypixel JSON in, a readonly fully-typed object out. There is no client, no config, and no state. All names are re-exported from the package root.

Design principles

• Strict-raw. The parsers mirror the raw Hypixel API field-for-field and do zero computation. No ratios, no levels-from-xp, no derived totals, no aggregates. Computed and derived values belong in a wrapper layer built on top of this one.
• Full depth. Every field the API returns is typed, including the deep SkyBlock sub-trees and decoded item NBT.
• Decoded NBT. Base64 + gzipped item NBT is decoded and typed (see NBT Decoding) rather than left as an opaque blob.
• Safe defaults. Missing fields resolve to typed defaults: 0, "", false, null, [], or {}, never undefined. Game-mode blocks resolve to null when the player has never played them.
• No Record<string, unknown> in outputs, except the one deliberate decoded-NBT passthrough on item tags.

Endpoint to parser

Hypixel endpoint	Parser
/player	parsePlayer (aggregates all game modes)
/guild	parseGuild
/status	parseStatus
/recentgames	parseRecentGames
/skyblock/profile	parseSkyBlockProfile
/skyblock/profiles	parseSkyBlockProfiles
/skyblock/bazaar	parseBazaar
/skyblock/auction	parseAuction, parseAuctionList
/skyblock/auctions	parseAuctionsPage
/skyblock/auctions_ended	parseAuctionList
/skyblock/museum	parseMuseum
/skyblock/garden	parseGarden
/skyblock/news	parseSkyBlockNews
/skyblock/firesales	parseFireSales
/skyblock/bingo	parsePlayerBingo
/resources/skyblock/items	parseSkyBlockItems
/resources/skyblock/skills	parseSkyBlockSkills
/resources/skyblock/collections	parseSkyBlockCollections
/resources/skyblock/election	parseSkyBlockElection
/resources/skyblock/bingo	parseSkyBlockBingo
/resources/achievements	parseAchievements
/resources/challenges	parseChallenges
/resources/quests	parseQuests
/resources/guilds/achievements	parseGuildAchievements
/resources/games	parseGames
/resources/vanity/pets	parseVanityPets
/resources/vanity/companions	parseVanityCompanions
/counts	parseGameCounts
/leaderboards	parseLeaderboards
/boosters	parseBoosters
/punishmentstats	parseWatchdogStats
/housing/active, /housing/houses	parseHouses
/housing/house	parseHouse

By domain

Core

• parsePlayer and the full HypixelPlayer tree
• parseGuild, parseStatus, parseRecentGames

Game modes

parseBedWars · parseSkyWars · parseDuels · parseArcade · parseBuildBattle · parseMurderMystery · parseTNTGames · parsePit · parseMegaWalls · parseBlitz · parseUHC · parseSmashHeroes · parseCopsAndCrims · parsePaintball · parseQuakecraft · parseVampireZ · parseWalls · parseWarlords · parseTurboKartRacers · parseArenaBrawl

Each game-mode parser takes the player's stats block and returns the mode's typed stats, or null when the player has never played it. parseBedWars additionally takes the star level, which it passes through verbatim.

SkyBlock

• Profile: parseSkyBlockProfile, parseSkyBlockProfiles
• Bazaar & Auctions: parseBazaar, parseAuction, parseAuctionList, parseAuctionsPage
• Museum, Garden, News & Bingo: parseMuseum, parseGarden, parseSkyBlockNews, parseFireSales, parsePlayerBingo
• Items: parseSkyBlockItems
• Resources: parseSkyBlockSkills, parseSkyBlockCollections, parseSkyBlockElection, parseSkyBlockBingo

Resources, static & housing

• Resources: parseAchievements, parseChallenges, parseQuests, parseGuildAchievements, parseGames, parseVanityPets, parseVanityCompanions
• Static & Housing: parseBoosters, parseLeaderboards, parseGameCounts, parseWatchdogStats, parseHouse, parseHouses

Decoding & helpers

• NBT Decoding: decodeNbt, decodeItemBytes
• Helpers: num, str, bool, obj, date

Every type behind a parser (such as HypixelPlayer, BedWarsStats, or SkyBlockProfile) is exported from the package root too.