hamburger.scarce09-apple.workers.dev Open in urlscan Pro
188.114.96.3  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Introduction
   * Limits
   * GameTypes
   * Notes
 * Authentication
 * Player Data
   * getData of a specific player, including game stats
   * getThe recently played games of a specific player
   * getThe current online status of a specific player
   * getRetrieve a Guild by a player, id, or name
 * Resources
   * getGame Information
   * getAchievements
   * getChallenges
   * getQuests
   * getGuild Achievements
   * getVanity Pets
   * getVanity Companions
 * SkyBlock
   * getCollections
   * getSkills
   * getItems
   * getElection and Mayor
   * getCurrent Bingo Event
   * getNews
   * getRequest auction(s) by the auction UUID, player UUID, or profile UUID.
   * getActive auctions
   * getRecently ended auctions
   * getBazaar
   * getProfile by UUID
   * getProfiles by player
   * getMuseum data by profile ID
   * getBingo data by player
   * getActive/Upcoming Fire Sales
 * Other
   * getActive Network Boosters
   * getCurrent Player Counts
   * getCurrent Leaderboards
   * getPunishment Statistics

Documentation Powered by ReDoc





HYPIXEL PUBLIC API (V2)

Download OpenAPI specification:Download

URL: https://developer.hypixel.net Terms of Service




INTRODUCTION

This is the official Hypixel API documentation. Hypixel Website - GitHub Repo -
API Help Forum

All use of the API must conform to the API policies, violation of these policies
may lead to applications being revoked or users banned from the API.


LIMITS

API keys are limited to a maximum amount of requests per 5 minute intervals.
These limits will depend on the type of application that the key is assigned to.

Endpoints which require the use of an API key will also respond with headers to
assist with managing the rate limit:

 * 'RateLimit-Limit' - The limit of requests per minute for the provided API
   key.
 * 'RateLimit-Remaining' - The remaining amount of requests allowed for the
   current minute.
 * 'RateLimit-Reset' - The amount of seconds until the next minute and the reset
   of the API key usages.


GAMETYPES

ID Type Name Database Name Clean Name 2 QUAKECRAFT Quake Quake 3 WALLS Walls
Walls 4 PAINTBALL Paintball Paintball 5 SURVIVAL_GAMES HungerGames Blitz
Survival Games 6 TNTGAMES TNTGames TNT Games 7 VAMPIREZ VampireZ VampireZ 13
WALLS3 Walls3 Mega Walls 14 ARCADE Arcade Arcade 17 ARENA Arena Arena 20 UHC UHC
UHC Champions 21 MCGO MCGO Cops and Crims 23 BATTLEGROUND Battleground Warlords
24 SUPER_SMASH SuperSmash Smash Heroes 25 GINGERBREAD GingerBread Turbo Kart
Racers 26 HOUSING Housing Housing 51 SKYWARS SkyWars SkyWars 52 TRUE_COMBAT
TrueCombat Crazy Walls 54 SPEED_UHC SpeedUHC Speed UHC 55 SKYCLASH SkyClash
SkyClash 56 LEGACY Legacy Classic Games 57 PROTOTYPE Prototype Prototype 58
BEDWARS Bedwars Bed Wars 59 MURDER_MYSTERY MurderMystery Murder Mystery 60
BUILD_BATTLE BuildBattle Build Battle 61 DUELS Duels Duels 63 SKYBLOCK SkyBlock
SkyBlock 64 PIT Pit Pit 65 REPLAY Replay Replay 67 SMP SMP SMP 68 WOOL_GAMES
WoolGames Wool Wars


STORAGE

Games store their respective stats and data in a Player's stats collection. The
game's specific data is held within a JSON object named after it's Database Name
(seen above.)


GAMETYPE NOTES

 * Clean names are what is displayed to the user when referencing the name.
 * Database names or IDs are used when the API references a specific GameType.


NOTES


DATE AND TIME

Generally dates are stored as a Unix Epoch times in milliseconds.


RESPONSE FORMAT

Responses are served in JSON format.


UUID PARAMETERS

All uuid parameters support both dashed and undashed versions.


SKYBLOCK ITEMS AND INVENTORIES

Items and inventory data are stored as a base64 encoded string containing
gzipped nbt data. If a method is missing important information about an item or
inventory, you should try checking this!

> Note: the base64 string may contain a unicode escape for non-alphabetical
> symbols, and some programming languages may have silent defects when
> interpreting the string.


AUTHENTICATION


APIKEY

Obtained via the Hypixel Developer Dashboard when creating an application. You
can also request higher limits for production applications in this dashboard.

Security Scheme Type API Key Header parameter name: API-Key


PLAYER DATA


DATA OF A SPECIFIC PLAYER, INCLUDING GAME STATS

AUTHORIZATIONS:

ApiKey

QUERY PARAMETERS

uuid
required
string



RESPONSES

200

Get player's data

400

Some data is missing, this is usually a field.

403

Access is forbidden, usually due to an invalid API key being used.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/player
https://api.hypixel.net/v2/player


RESPONSE SAMPLES

 * 200
 * 400
 * 403
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "player": {
    * "uuid": "3fa85f6457174562b3fc2c963f66afa6",
    * "displayname": "string",
    * "rank": "ADMIN",
    * "packageRank": "MVP_PLUS",
    * "newPackageRank": "MVP_PLUS",
    * "monthlyPackageRank": "SUPERSTAR",
    * "firstLogin": 0,
    * "lastLogin": 0,
    * "lastLogout": 0,
    * "stats": { }
   
   }

}





THE RECENTLY PLAYED GAMES OF A SPECIFIC PLAYER

AUTHORIZATIONS:

ApiKey

QUERY PARAMETERS

uuid
required
string



RESPONSES

200

Get player's recent game

400

Some data is missing, this is usually a field.

403

Access is forbidden, usually due to an invalid API key being used.

422

Some data provided is invalid.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/recentgames
https://api.hypixel.net/v2/recentgames


RESPONSE SAMPLES

 * 200
 * 400
 * 403
 * 422
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
 * "games": [
    * {
       * "date": 0,
       * "gameType": "string",
       * "mode": "string",
       * "map": "string",
       * "ended": 0
      
      }
   
   ]

}






THE CURRENT ONLINE STATUS OF A SPECIFIC PLAYER

AUTHORIZATIONS:

ApiKey

QUERY PARAMETERS

uuid
required
string



RESPONSES

200

Get player status

400

Some data is missing, this is usually a field.

403

Access is forbidden, usually due to an invalid API key being used.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/status
https://api.hypixel.net/v2/status


RESPONSE SAMPLES

 * 200
 * 400
 * 403
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "uuid": "ad8fefaa8351454bb739a4eaa872173f",
 * "session": {
    * "online": true,
    * "gameType": "string",
    * "mode": "string",
    * "map": "string"
   
   }

}





RETRIEVE A GUILD BY A PLAYER, ID, OR NAME

AUTHORIZATIONS:

ApiKey

QUERY PARAMETERS

id
string <objectid>

player
string <uuid>

name
string



RESPONSES

200

Get guild information

400

Some data is missing, this is usually a field.

403

Access is forbidden, usually due to an invalid API key being used.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/guild
https://api.hypixel.net/v2/guild


RESPONSE SAMPLES

 * 200
 * 400
 * 403
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "guild": { }

}





RESOURCES


GAME INFORMATION

Returns information about Hypixel Games. This endpoint is in early development
and we are working to add more information when possible
HypixelDev/PublicAPI#197


RESPONSES

200

A successful response

get/v2/resources/games
https://api.hypixel.net/v2/resources/games


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "games": {
    * "property1": {
       * "id": 58,
       * "name": "Bed Wars",
       * "databaseName": "Bedwars",
       * "modeNames": {
          * "BEDWARS_TWO_FOUR": "4v4",
          * "BEDWARS_EIGHT_ONE": "Solo"
         
         }
      
      },
    * "property2": {
       * "id": 58,
       * "name": "Bed Wars",
       * "databaseName": "Bedwars",
       * "modeNames": {
          * "BEDWARS_TWO_FOUR": "4v4",
          * "BEDWARS_EIGHT_ONE": "Solo"
         
         }
      
      }
   
   }

}


ACHIEVEMENTS


RESPONSES

200

A successful response

get/v2/resources/achievements
https://api.hypixel.net/v2/resources/achievements


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "achievements": { }

}


CHALLENGES


RESPONSES

200

A successful response

get/v2/resources/challenges
https://api.hypixel.net/v2/resources/challenges


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "challenges": { }

}


QUESTS


RESPONSES

200

A successful response

get/v2/resources/quests
https://api.hypixel.net/v2/resources/quests


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "quests": { }

}


GUILD ACHIEVEMENTS


RESPONSES

200

A successful response

get/v2/resources/guilds/achievements
https://api.hypixel.net/v2/resources/guilds/achievements


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "one_time": { },
 * "tiered": { }

}


VANITY PETS


RESPONSES

200

A successful response

get/v2/resources/vanity/pets
https://api.hypixel.net/v2/resources/vanity/pets


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "types": { },
 * "rarities": { }

}


VANITY COMPANIONS


RESPONSES

200

A successful response

get/v2/resources/vanity/companions
https://api.hypixel.net/v2/resources/vanity/companions


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "types": { },
 * "rarities": { }

}


SKYBLOCK


COLLECTIONS

Information regarding Collections in the SkyBlock game.


RESPONSES

200

A successful response

get/v2/resources/skyblock/collections
https://api.hypixel.net/v2/resources/skyblock/collections


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "version": "0.11.22",
 * "collections": { }

}


SKILLS

Information regarding skills in the SkyBlock game.


RESPONSES

200

A successful response

get/v2/resources/skyblock/skills
https://api.hypixel.net/v2/resources/skyblock/skills


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "version": "0.11.22",
 * "skills": { }

}


ITEMS

Information regarding items in the SkyBlock game.


RESPONSES

200

A successful response

get/v2/resources/skyblock/items
https://api.hypixel.net/v2/resources/skyblock/items


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "items": [
    * {
       * "material": "LEATHER_CHESTPLATE",
       * "color": "255,215,0",
       * "name": "Farm Armor Chestplate",
       * "category": "CHESTPLATE",
       * "tier": "RARE",
       * "stats": {
          * "DEFENSE": 75,
          * "HEALTH": 20
         
         },
       * "npc_sell_price": 5200,
       * "id": "FARM_ARMOR_CHESTPLATE"
      
      }
   
   ]

}


ELECTION AND MAYOR

Information regarding the current mayor and ongoing election in SkyBlock.


RESPONSES

200

A successful response

get/v2/resources/skyblock/election
https://api.hypixel.net/v2/resources/skyblock/election


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "mayor": { },
 * "current": { }

}


CURRENT BINGO EVENT

Information regarding the current bingo event and its goals.


RESPONSES

200

A successful response

get/v2/resources/skyblock/bingo
https://api.hypixel.net/v2/resources/skyblock/bingo


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 0,
 * "id": 27,
 * "name": "March 2024",
 * "start": 1709269200000,
 * "end": 1709874000000,
 * "modifier": "NORMAL",
 * "goals": [
    * {
       * "id": "string",
       * "name": "string",
       * "lore": "string",
       * "fullLore": [ ],
       * "tiers": [
          * 0
         
         ],
       * "progress": 0,
       * "requiredAmount": 0
      
      }
   
   ]

}


NEWS

AUTHORIZATIONS:

ApiKey


RESPONSES

200

A successful response

403

Access is forbidden, usually due to an invalid API key being used.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/skyblock/news
https://api.hypixel.net/v2/skyblock/news


RESPONSE SAMPLES

 * 200
 * 403
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "items": [
    * {
       * "item": {
          * "material": "DIAMOND"
         
         },
       * "link": "https://hypixel.net",
       * "title": "SkyBlock v0.11",
       * "text": "15th January 2021"
      
      }
   
   ]

}




REQUEST AUCTION(S) BY THE AUCTION UUID, PLAYER UUID, OR PROFILE UUID.

Returns the auctions selected by the provided query. Only one query parameter
can be used in a single request, and cannot be filtered by multiple.

AUTHORIZATIONS:

ApiKey

QUERY PARAMETERS

uuid
string

The auction UUID that you wish to request

player
string

The player UUID that you wish to request

profile
string

The profile UUID that you wish to request


RESPONSES

200

A successful response

400

Some data is missing, this is usually a field.

403

Access is forbidden, usually due to an invalid API key being used.

422

Some data provided is invalid.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/skyblock/auction
https://api.hypixel.net/v2/skyblock/auction


RESPONSE SAMPLES

 * 200
 * 400
 * 403
 * 422
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "auctions": [
    * {
       * "uuid": "409a1e0f261a49849493278d6cd9305a",
       * "auctioneer": "347ef6c1daac45ed9d1fa02818cf0fb6",
       * "profile_id": "347ef6c1daac45ed9d1fa02818cf0fb6",
       * "coop": [
          * "347ef6c1daac45ed9d1fa02818cf0fb6"
         
         ],
       * "start": 1573760802637,
       * "end": 1573761102637,
       * "item_name": "Azure Bluet",
       * "item_lore": "§f§lCOMMON",
       * "extra": "Azure Bluet Red Rose",
       * "category": "blocks",
       * "tier": "COMMON",
       * "starting_bid": 1,
       * "item_bytes": {
          * "type": 0,
          * "data":
            "H4sIAAAAAAAAAB2NQQqCQBhGv1ErHaKu0KoLtGtnarRIhTpA/OGfDIwZ4wxUF/IeHiyyto/3eBKIIJQEIDx4qsJaYJK07m6FhG+p9hEdVMV7TXU3Wh+JWaW6h6ZXhODYGg5/LeZDfxt6nZR5XhYhgoIaxmKE8dsZXu20YwuJZfa0hmJrjbo6y134f8pTll5O5TnbbgAP05Qaqhk+8AVIrd2eoAAAAA=="
         
         },
       * "claimed": true,
       * "claimed_bidders": [ ],
       * "highest_bid_amount": 7607533,
       * "bids": [
          * {
             * "auction_id": "409a1e0f261a49849493278d6cd9305a",
             * "bidder": "99748e629dee463892f68abf3a780094",
             * "profile_id": "99748e629dee463892f68abf3a780094",
             * "amount": 7607533,
             * "timestamp": 1573760824844
            
            }
         
         ]
      
      }
   
   ]

}






ACTIVE AUCTIONS

Returns the currently active auctions sorted by last updated first and
paginated.

QUERY PARAMETERS

page
number
Default: 0



RESPONSES

200

A successful response

404

The page provided does not exist.

422

The page provided is invalid.

503

The data is not yet populated and should be available shortly

get/v2/skyblock/auctions
https://api.hypixel.net/v2/skyblock/auctions


RESPONSE SAMPLES

 * 200
 * 404
 * 422
 * 503

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "page": 0,
 * "totalPages": 32,
 * "totalAuctions": 31267,
 * "lastUpdated": 1571065561345,
 * "auctions": [
    * {
       * "uuid": "409a1e0f261a49849493278d6cd9305a",
       * "auctioneer": "347ef6c1daac45ed9d1fa02818cf0fb6",
       * "profile_id": "347ef6c1daac45ed9d1fa02818cf0fb6",
       * "coop": [
          * "347ef6c1daac45ed9d1fa02818cf0fb6"
         
         ],
       * "start": 1573760802637,
       * "end": 1573761102637,
       * "item_name": "Azure Bluet",
       * "item_lore": "§f§lCOMMON",
       * "extra": "Azure Bluet Red Rose",
       * "category": "blocks",
       * "tier": "COMMON",
       * "starting_bid": 1,
       * "item_bytes": {
          * "type": 0,
          * "data":
            "H4sIAAAAAAAAAB2NQQqCQBhGv1ErHaKu0KoLtGtnarRIhTpA/OGfDIwZ4wxUF/IeHiyyto/3eBKIIJQEIDx4qsJaYJK07m6FhG+p9hEdVMV7TXU3Wh+JWaW6h6ZXhODYGg5/LeZDfxt6nZR5XhYhgoIaxmKE8dsZXu20YwuJZfa0hmJrjbo6y134f8pTll5O5TnbbgAP05Qaqhk+8AVIrd2eoAAAAA=="
         
         },
       * "claimed": true,
       * "claimed_bidders": [ ],
       * "highest_bid_amount": 7607533,
       * "bids": [
          * {
             * "auction_id": "409a1e0f261a49849493278d6cd9305a",
             * "bidder": "99748e629dee463892f68abf3a780094",
             * "profile_id": "99748e629dee463892f68abf3a780094",
             * "amount": 7607533,
             * "timestamp": 1573760824844
            
            }
         
         ]
      
      }
   
   ]

}





RECENTLY ENDED AUCTIONS

SkyBlock auctions which ended in the last 60 seconds.


RESPONSES

200

A successful response

get/v2/skyblock/auctions_ended
https://api.hypixel.net/v2/skyblock/auctions_ended


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 1607456463916,
 * "auctions": [
    * {
       * "auction_id": "015fe0c67e6041e69797bbe0c2725a21",
       * "seller": "fc76242bf64a4698ae0ebc136d900929",
       * "seller_profile": "85b96cd3e73e4580b8379162ec059141",
       * "buyer": "c1eff55de0d24ec6b44848799e9323ba",
       * "buyer_profile": "a3e1c076533a40a58085e7f43a598bf3",
       * "timestamp": 1607456400329,
       * "price": 190000,
       * "bin": true,
       * "item_bytes":
         "H4sIAAAAAAAAAEWR3W7TQBCFx2mBxKgtSH2ArUACZKL6L9jtndUYBdHQyGlV7qq1PXZX9U+03kB6yYNw7ffwo/AgiHEC4m7mmz1nz87qACPQhA4A2gAGItUGGjy5qNeV0nTYUzzX4PlNFUvkDzwuUNuD0Uyk+LHgeUOi3zo8S0WzKvjjCPYva4lDoofwsmu9KS95juesaxPDN+GY0FJJrHJ1v4PWxKTDAfGQy4rQB8M2WVKLqqHGy2RdsrKuGoWSPYiiaNjbS/yGBQ3RMo3+TF0Vj+/I5NXWj+2u7Acr0hCbmGbfbdWgd60/5xtmOBM4JPq5p9sofY43W4tfP3+wfyn/++Bfn+91nYJBxS0VlLQoMFGCIvYu6FnvXcenindtMQ++htMT8u11dPH1vWiYUFiyhFcsRiYxq2WO6Qm86NozUkRBFLLl7VU0HcL+F14iHNAg4rRuyYINgg5H4UZJHiglRbxW2AxhVEuRi+qa53CwnF0t7hY30cUsWIbD/jdBj4JP0zC6ozBkul4Teu34Tua7vj124tQduz73xtxOvbGVoZtMbN/xnIyMlSixUbxcwZFln/qn9DX2ue2wxRxgAE93q6b3wR9BYJa/RAIAAA=="
      
      }
   
   ]

}


BAZAAR

Returns the list of products along with their sell summary, buy summary and
quick status.


PRODUCT DESCRIPTION

The returned product info has 3 main fields:

 * buy_summary
 * sell_summary
 * quick_status

buy_summary and sell_summary are the current top 30 orders for each transaction
type (in-game example: Stock of Stonks).

quick_status is a computed summary of the live state of the product (used for
advanced mode view in the bazaar):

 * sellVolume and buyVolume are the sum of item amounts in all orders.
   * sellPrice and buyPrice are the weighted average of the top 2% of orders by
     volume.
   * movingWeek is the historic transacted volume from last 7d + live state.
   * sellOrders and buyOrders are the count of active orders.


RESPONSES

200

A successful response

503

The data is not yet populated and should be available shortly

get/v2/skyblock/bazaar
https://api.hypixel.net/v2/skyblock/bazaar


RESPONSE SAMPLES

 * 200
 * 503

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "lastUpdated": 1590854517479,
 * "products": {
    * "INK_SACK:3": {
       * "product_id": "INK_SACK:3",
       * "sell_summary": [
          * {
             * "amount": 20569,
             * "pricePerUnit": 4.2,
             * "orders": 1
            
            },
          * {
             * "amount": 140326,
             * "pricePerUnit": 3.8,
             * "orders": 2
            
            }
         
         ],
       * "buy_summary": [
          * {
             * "amount": 640,
             * "pricePerUnit": 4.8,
             * "orders": 1
            
            },
          * {
             * "amount": 640,
             * "pricePerUnit": 4.9,
             * "orders": 1
            
            },
          * {
             * "amount": 25957,
             * "pricePerUnit": 5,
             * "orders": 3
            
            }
         
         ],
       * "quick_status": {
          * "productId": "INK_SACK:3",
          * "sellPrice": 4.2,
          * "sellVolume": 409855,
          * "sellMovingWeek": 8301075,
          * "sellOrders": 11,
          * "buyPrice": 4.99260315136572,
          * "buyVolume": 1254854,
          * "buyMovingWeek": 5830656,
          * "buyOrders": 85
         
         }
      
      }
   
   }

}



PROFILE BY UUID

SkyBlock profile data, such as stats, objectives etc. The data returned can
differ depending on the players in-game API settings.

AUTHORIZATIONS:

ApiKey

QUERY PARAMETERS

profile
string <uuid>



RESPONSES

200

A successful response

400

Some data is missing, this is usually a field.

403

Access is forbidden, usually due to an invalid API key being used.

422

Some data provided is invalid.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/skyblock/profile
https://api.hypixel.net/v2/skyblock/profile


RESPONSE SAMPLES

 * 200
 * 400
 * 403
 * 422
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "profile": {
    * "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
    * "members": {
       * "player_id": "f8b23bf6-c56d-4f96-b79c-96d80504663d",
       * "profile": {
          * "deletion_notice": {
             * "timestamp": 0
            
            }
         
         }
      
      },
    * "cute_name": "string",
    * "selected": true,
    * "community_upgrades": { },
    * "banking": {
       * "balance": 0,
       * "transactions": [
          * {
             * "timestamp": 0,
             * "action": "DEPOSIT",
             * "initiator_name": "string",
             * "amount": 0
            
            }
         
         ]
      
      },
    * "game_mode": "ironman"
   
   }

}






PROFILES BY PLAYER

AUTHORIZATIONS:

ApiKey

QUERY PARAMETERS

uuid
string <uuid>



RESPONSES

200

A successful response

400

Some data is missing, this is usually a field.

403

Access is forbidden, usually due to an invalid API key being used.

422

Some data provided is invalid.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/skyblock/profiles
https://api.hypixel.net/v2/skyblock/profiles


RESPONSE SAMPLES

 * 200
 * 400
 * 403
 * 422
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "profiles": [
    * {
       * "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
       * "members": {
          * "player_id": "f8b23bf6-c56d-4f96-b79c-96d80504663d",
          * "profile": {
             * "deletion_notice": {
                * "timestamp": 0
               
               }
            
            }
         
         },
       * "cute_name": "string",
       * "selected": true,
       * "community_upgrades": { },
       * "banking": {
          * "balance": 0,
          * "transactions": [
             * {
                * "timestamp": 0,
                * "action": "DEPOSIT",
                * "initiator_name": "string",
                * "amount": 0
               
               }
            
            ]
         
         },
       * "game_mode": "ironman"
      
      }
   
   ]

}






MUSEUM DATA BY PROFILE ID

SkyBlock museum data for all members of the provided profile. The data returned
can differ depending on the players in-game API settings.

AUTHORIZATIONS:

ApiKey

QUERY PARAMETERS

profile
string <uuid>



RESPONSES

200

A successful response

403

Access is forbidden, usually due to an invalid API key being used.

422

Some data provided is invalid.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/skyblock/museum
https://api.hypixel.net/v2/skyblock/museum


RESPONSE SAMPLES

 * 200
 * 403
 * 422
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "profile": {
    * "value": 0,
    * "appraisal": true,
    * "items": { },
    * "special": [ ]
   
   }

}





BINGO DATA BY PLAYER

Bingo data for participated events of the provided player.

AUTHORIZATIONS:

ApiKey

QUERY PARAMETERS

uuid
string <uuid>



RESPONSES

200

A successful response

400

Some data is missing, this is usually a field.

403

Access is forbidden, usually due to an invalid API key being used.

404

No data could be found for the provided player uuid.

422

Some data provided is invalid.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/skyblock/bingo
https://api.hypixel.net/v2/skyblock/bingo


RESPONSE SAMPLES

 * 200
 * 400
 * 403
 * 404
 * 422
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "events": [
    * {
       * "key": 2,
       * "points": 117,
       * "completed_goals": [
          * [
             * "stat_walk_speed",
             * "KILL_TRAPPER_MOB"
            
            ]
         
         ]
      
      }
   
   ]

}







ACTIVE/UPCOMING FIRE SALES

Retrieve the currently active or upcoming Fire Sales for SkyBlock.


RESPONSES

200

A successful response

get/v2/skyblock/firesales
https://api.hypixel.net/v2/skyblock/firesales


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "sales": [
    * {
       * "item_id": "string",
       * "start": 0,
       * "end": 0,
       * "amount": 0,
       * "price": 0
      
      }
   
   ]

}


OTHER


ACTIVE NETWORK BOOSTERS

AUTHORIZATIONS:

ApiKey


RESPONSES

200

Get boosters list

403

Access is forbidden, usually due to an invalid API key being used.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/boosters
https://api.hypixel.net/v2/boosters


RESPONSE SAMPLES

 * 200
 * 403
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "boosters": [
    * {
       * "_id": "string",
       * "purchaserUuid": "ad8fefaa8351454bb739a4eaa872173f",
       * "amount": 0,
       * "originalLength": 0,
       * "length": 0,
       * "gameType": 0,
       * "dateActivated": 0,
       * "stacked": [
          * "ad8fefaa-8351-454b-b739-a4eaa872173f"
         
         ]
      
      }
   
   ],
 * "boosterState": {
    * "decrementing": true
   
   }

}




CURRENT PLAYER COUNTS

AUTHORIZATIONS:

ApiKey


RESPONSES

200

A successful response

403

Access is forbidden, usually due to an invalid API key being used.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

get/v2/counts
https://api.hypixel.net/v2/counts


RESPONSE SAMPLES

 * 200
 * 403
 * 429

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "playerCount": 0,
 * "games": {
    * "GAME_TYPE": {
       * "players": 2,
       * "modes": {
          * "mode_1": 1,
          * "mode_2": 1
         
         }
      
      }
   
   }

}




CURRENT LEADERBOARDS

AUTHORIZATIONS:

ApiKey


RESPONSES

200

A successful response

403

Access is forbidden, usually due to an invalid API key being used.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

503

The data is not yet populated and should be available shortly

get/v2/leaderboards
https://api.hypixel.net/v2/leaderboards


RESPONSE SAMPLES

 * 200
 * 403
 * 429
 * 503

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "leaderboards": { }

}





PUNISHMENT STATISTICS

AUTHORIZATIONS:

ApiKey


RESPONSES

200

A successful response

403

Access is forbidden, usually due to an invalid API key being used.

429

A request limit has been reached, usually this is due to the limit on the key
being reached but can also be triggered by a global throttle.

503

The data is not yet populated and should be available shortly

get/v2/punishmentstats
https://api.hypixel.net/v2/punishmentstats


RESPONSE SAMPLES

 * 200
 * 403
 * 429
 * 503

Content type
application/json
Copy
Expand all Collapse all
{
 * "success": true,
 * "watchdog_lastMinute": 0,
 * "staff_rollingDaily": 0,
 * "watchdog_total": 0,
 * "watchdog_rollingDaily": 0,
 * "staff_total": 0

}