SkyBlock API

The Hypixel SkyBlock API is an external resource used to access a vast array of SkyBlock-related data beyond the confines of the game itself. As an integral component of the official Hypixel Public API, it provides automated access to various essential features, including detailed information on auctions, Bazaar data, and comprehensive player profiles encompassing statistics, skills, collections, and inventories.
== Accessing the API ==
Accessing the Hypixel SkyBlock API is a straightforward process that grants users the ability to retrieve a wealth of SkyBlock-related information. To get started, the official API documentation can be accessed at https://api.hypixel.net/. This comprehensive resource provides detailed documentation on the available endpoints, parameters, and response formats, offering a solid foundation for utilizing the API effectively.
In order to access certain API endpoints and maximize the benefits of the API, acquiring an API key is recommended. An API key can be obtained by going to https://developer.hypixel.net/dashboard/ and clicking "Create API Key". By doing so, users can generate an API key that comes with a default rate limit of 300 requests per 5 minutes, but will expire in 72 hours (3 days). To obtain a permanent key, you must click "Create App" and select "Personal API Key", which will grant you a key that provides the same default rate limit, but will not expire on its own. This key serves as the gateway to unrestricted access to the API's vast array of features and data.
However, it's important to note that not all API endpoints require an API key. Several endpoints, such as those providing static or semi-static data like active auctions or Bazaar data, can be accessed without the need for an API key. This ensures that even users without an API key can still access valuable information and utilize it for their own purposes.
=== Converting Minecraft Username to UUID ===
Any parameter that represents a player or a SkyBlock profile should be filled with the UUID, not the player name. The official Mojang API can be used to convert a player name to the corresponding player UUID:
 https://api.mojang.com/users/profiles/minecraft/Player Name
=== Parsing Inventory Data ===
Inventory data in the SkyBlock API is provided in the form of GZip compressed NBT (Named Binary Tag) data, which is then base64 encoded. To work with this inventory data, there are numerous libraries available for most programming languages that simplify the process of handling NBT data. These libraries provide convenient methods and functions specifically designed for parsing, decoding, and manipulating NBT data structures.
== SkyBlock Resources Endpoints ==
The SkyBlock Resources Endpoints in the Hypixel Networth SkyBlock API can be accessed without requiring an API key. This means that users can retrieve valuable information about active auctions, Bazaar rates, and other static resources without the need for authentication using an API key. 
=== Collections ===
;Information regarding Collections in SkyBlock
 https://api.hypixel.net/resources/skyblock/collections
=== Skills ===
;Information regarding skills in SkyBlock
 https://api.hypixel.net/resources/skyblock/skills
=== Items ===
;Information regarding items in SkyBlock
 https://api.hypixel.net/resources/skyblock/items
=== Elections and Mayors ===
;Information regarding the current mayor and ongoing election in SkyBlock
 https://api.hypixel.net/resources/skyblock/election
=== Bingo ===
;Information regarding the current bingo event and its goals
 https://api.hypixel.net/resources/skyblock/bingo
=== Auctions ===
;Returns the currently active auctions sorted by last updated first and paginated
 https://api.hypixel.net/skyblock/auctions
;SkyBlock auctions which ended in the last 60 seconds
 https://api.hypixel.net/skyblock/auctions_ended
=== Bazaar ===
;Returns the list of products along with their sell summary, buy summary and quick status
 https://api.hypixel.net/skyblock/bazaar
=== Fire Sales ===
;Retrieve the currently active or upcoming Fire Sales for SkyBlock
 https://api.hypixel.net/skyblock/firesales
== Main SkyBlock Endpoints ==
The SkyBlock Endpoints in the Hypixel Networth SkyBlock API require authentication through an API key. This means that in order to access these endpoints and retrieve specific SkyBlock-related data such as player profiles, stats, collections, and inventories, users must provide a valid API key for authorization. 
=== Player Profiles ===
;SkyBlock profile data, such as stats, objectives etc. The data returned can differ depending on the players in-game API settings
 https://api.hypixel.net/skyblock/profiles?key=API_KEY&uuid=UUID
=== Profile by Profile ID ===
;SkyBlock profile data, such as stats, objectives etc. The data returned can differ depending on the players in-game API settings
 https://api.hypixel.net/skyblock/profile?key=API_KEY&profile=PROFILE_ID
=== Bingo Data ===
;Bingo data for participated events of the provided player
 https://api.hypixel.net/skyblock/bingo?key=API_KEY&uuid=UUID
=== Auctions by the auction UUID, player UUID, or profile UUID ===
;Information about auctions.
 https://api.hypixel.net/skyblock/auction?key=API_KEY&uuid=AUCTION_UUID
 https://api.hypixel.net/skyblock/auction?key=API_KEY&player=UUID
 https://api.hypixel.net/skyblock/auction?key=API_KEY&profile=PROFILE_ID
=== News ===
;Information regarding latest updates in SkyBlock
 https://api.hypixel.net/skyblock/news?key=API_KEY
=== Location ===
;The current online status and location of a specific player
 https://api.hypixel.net/status?key=API KEY&uuid=UUID
Category:Mechanics