From ef9108acf53c13a884ffd9e6ba82cf2bac364759 Mon Sep 17 00:00:00 2001 From: mdashlw Date: Sat, 30 May 2020 18:55:28 +0300 Subject: [PATCH 1/6] Update all examples --- Documentation/methods/boosters.md | 48 +++-- Documentation/methods/friends.md | 23 ++- Documentation/methods/gameCounts.md | 38 ++-- Documentation/methods/guild.md | 176 +++++++++--------- Documentation/methods/leaderboards.md | 36 ++-- Documentation/methods/playerCount.md | 14 +- Documentation/methods/recentGames.md | 59 +++--- Documentation/methods/skyblock/auction.md | 70 +++---- Documentation/methods/skyblock/auctions.md | 74 ++++---- Documentation/methods/skyblock/bazaar.md | 2 +- .../methods/skyblock/bazaar/product.md | 4 +- .../methods/skyblock/bazaar/products.md | 161 +--------------- Documentation/methods/skyblock/news.md | 30 ++- Documentation/methods/status.md | 14 +- Documentation/methods/watchdogstats.md | 20 +- 15 files changed, 336 insertions(+), 433 deletions(-) diff --git a/Documentation/methods/boosters.md b/Documentation/methods/boosters.md index 965b2f9e..12fa9da5 100644 --- a/Documentation/methods/boosters.md +++ b/Documentation/methods/boosters.md @@ -8,24 +8,36 @@ Returns list of boosters. - key ## Example Response -```php +```js { - "success": true, - "boosters": [ - { - "purchaserUuid": "", - "amount": 3, // multiplier - "originalLength": 3600, - "length": 2329, // length remaining - "gameType": 20, // GameType ID - "dateActivated": 1471657389139 // unix timestamp - "stacked": [ - "" // array of up to 10 UUIDs who have stacked the booster, or "true" if there are none - ] - } - ] - "boosterState": { - "decrementing": true // indicates whether booster duration is ticking down - } + "success": true, + "boosters": [ + { + "_id": "5c197fadc8f245280926413d", + "purchaserUuid": "978ddb705a8e43618e41749178c020b0", + "amount": 2, // Multiplier + "originalLength": 3600, + "length": 3595, // Length remaining + "gameType": 24, // GameType ID + "dateActivated": 1545244519133, + "stacked": true + }, + { + "_id": "5de1bf590cf2544cd01a7e04", + "purchaserUuid": "9e29fa1bedde445abb79526e22a7e051", + "amount": 2.2, + "originalLength": 3600, + "length": 2074, + "gameType": 13, + "dateActivated": 1590842991659, + "stacked": [ // Array of up to 10 UUIDs who have stacked the booster + "e8558c2a-935c-4eba-9a20-1e7eddeb2530", + "d33dbdc9-a65b-4090-ab20-d101452647fa" + ] + } + ], + "boosterState": { + "decrementing": true // Indicates whether booster duration is ticking down + } } ``` diff --git a/Documentation/methods/friends.md b/Documentation/methods/friends.md index e80f5f6d..9611d79f 100644 --- a/Documentation/methods/friends.md +++ b/Documentation/methods/friends.md @@ -1,4 +1,4 @@ -# friends +# friends ## Description Returns friendships for given player. @@ -8,13 +8,16 @@ Returns friendships for given player. - uuid ## Example Response -```php -[ +```js +{ + "success": true, + "records": [ { - "uuidSender": "", - "uuidReceiver": "", - "started": 1376865614794 // unix timestamp - }, - ... -] -``` \ No newline at end of file + "_id": "5eb97d170cf22f431e8d6170", + "uuidSender": "20934ef9488c465180a78f861586b4cf", + "uuidReceiver": "7486aa03aca5470e888dde8a43eb8c10", + "started": 1589214487454 + } + ] +} +``` diff --git a/Documentation/methods/gameCounts.md b/Documentation/methods/gameCounts.md index 1b32c117..ca3eddec 100644 --- a/Documentation/methods/gameCounts.md +++ b/Documentation/methods/gameCounts.md @@ -1,28 +1,34 @@ # gameCounts ## Description -Returns the current player count along with the player count of each public game + mode on the server. +Returns the current player count along with the player count of each public game + mode on the server. Due to the large amount of modes and that they can change at anytime we don't currently have a friendly list of mode keys to clean names. This may be added at a later date. - + ## Parameters - key ## Example Player Count - ```php +```js { - "games": { - "BUILD_BATTLE": { // The GameType Name - "modes": { - "BUILD_BATTLE_HALLOWEEN": 82, // The mode key along with the player count - "BUILD_BATTLE_GUESS_THE_BUILD": 177, - "BUILD_BATTLE_TEAMS_NORMAL": 512, - "BUILD_BATTLE_SOLO_NORMAL": 440, - "BUILD_BATTLE_SOLO_PRO": 114 - }, - "players": 1453 // Total players for the GameType - } - }, - "playerCount": 59715 + "success": true, + "games": { + "SKYBLOCK": { // The GameType Name + "players": 30522, // Total players for the GameType + "modes": { + "combat_1": 690, // The mode key along with the player count + "foraging_1": 1456, + "hub": 8049, + "mining_2": 1062, + "combat_2": 277, + "farming_2": 247, + "mining_1": 300, + "farming_1": 204, + "combat_3": 2350, + "dynamic": 15888 + } + } + }, + "playerCount": 77238 // Total players on the network } ``` diff --git a/Documentation/methods/guild.md b/Documentation/methods/guild.md index f5748700..32b1e4b3 100644 --- a/Documentation/methods/guild.md +++ b/Documentation/methods/guild.md @@ -12,94 +12,94 @@ See [`resources.md`](/Documentation/methods/resources.md) for a JSON list of Gui - name (Lookup by Guild name) ## Example -```php +```js { - "success": true, - "guild": { - "_id": "536ac9ceed5032e412eb2ae1", // Guild ID - "coins": 459178, // Number of coins this guild has - Deprecated - "coinsEver": 619178, // Number of coins this guild has ever earned - Deprecated - "created": 1399507406038, // Timestamp that this guild was created at - "members": [{ // Member list - "uuid": "e72660b18b88424ea23f2cdd3597c581", // This user's non-dashed UUID - "rank": "GUILDMASTER", // This user's rank in this guild - "joined": 1512200875108, // Timestamp the member joined - "dailyCoins-12-6-2018": 1560, // Guild coins earned by this user on any given day - Deprecated - "questParticipation": 4, // The number of challenges completed that count towards the current quest - "mutedTill":1532797185516, // Timestamp that this user will be unmuted at - "expHistory": { - "2019-10-17": 17260 // Last 7 days of exp earned for this member - } - }, { - "uuid": "6407035ace144175a731fac937d410cd", - "rank": "Co-Owner", - "joined": 1512074687198, - "last_rank_modification": { // Data for last changes to this users rank - "at": 1532715237290, // Timestamp the rank was changed - "uuid": "e72660b18b88424ea23f2cdd3597c581" // User the rank was changed by - }, - "expHistory": { - "2019-10-17": 15812 - } - } - // ... - ], - "name": "Froggy", // Name of this guild - "name_lower": "froggy" // Name of this guild in all lower case - "tagColor": "DARK_GREEN", // Color of this guild's guild tag, if set - "joinable": false, // Whether this guild can be joined using /g join - "legacyRanking": 10446, // Ranking in the number of guild coins owned in the legacy guild system (0-indexed) - "exp": 619178, // Total experience this guild has - "description": "This guild is cool \u0026 fun!", // Description of this guild that appears in the guild list and /g info - "achievements": { // Guild achievements earned and the current progress - "WINNERS": 803, - "EXPERIENCE_KINGS": 243576 - // ... - }, - "ranks": [{ - "name": "Member", // Display name - "permissions": [], // Array of the IDs of permissions this rank has - "default": true, // Whether this rank is the defualt rank a user gets when they join a guild - "tag": null, // Rank tag that appears in guild chat, or null if none - "created": 1532713597406, // Timestamp of rank creation - "priority": 1 // Rank priority - Higher number = higher up in the heirarchy - }, { - "name": "Co-Owner", - "permissions": [5, 6, 7, 8, 9, 10, 11], - "default": false, - "tag": "CO", - "created": 1532715059862, - "priority": 2 - } - // ... - ], - "banner": { // This guild's Minecraft banner - Displayed on the Hypixel forums page - // See https://minecraft.gamepedia.com/Banner/Patterns for pattern IDs - "Base": "0", // Base color - "Patterns": [ // Array of each layer on the banner pattern - { - "Pattern": "vhr", // Pattern ID for this layer - "Color": "15" // Color of this layer (16-color 0-indexed pallete) - }, { - "Pattern": "vh", - "Color": "15" - } - // ... - ] - }, - "guildExpByGameType": { // Amount of EXP earned for this guild by which game it was earned in - "SKYWARS": 173, - "PROTOTYPE": 3100, - "BUILD_BATTLE": 46095 - // ... - }, - "tag": "HYPIXL", // This guild's Guild tag - "preferredGames": ["ARCADE", "SPEED_UHC", "UHC"], // This guild's set preferred games - "chatThrottle": 10000, // Number of milliseconds users must wait between messages - "vipCount": 22, // The number of players in the guild with VIP or VIP+ (Unreliable) - "mvpCount": 39, // The number of players in the guild with MVP or higher (Unreliable) - "publiclyListed": false, // Whether the guild is listed in the Guild Finder or not - "chatMute": 1532797565473 // Timestamp that the entire guild chat will be unmuted at - } + "success": true, + "guild": { + "_id": "536ac9ceed5032e412eb2ae1", // Guild ID + "coins": 459178, // Number of coins this guild has - Deprecated + "coinsEver": 619178, // Number of coins this guild has ever earned - Deprecated + "created": 1399507406038, // Timestamp that this guild was created at + "members": [{ // Member list + "uuid": "e72660b18b88424ea23f2cdd3597c581", // This user's non-dashed UUID + "rank": "GUILDMASTER", // This user's rank in this guild + "joined": 1512200875108, // Timestamp the member joined + "dailyCoins-12-6-2018": 1560, // Guild coins earned by this user on any given day - Deprecated + "questParticipation": 4, // The number of challenges completed that count towards the current quest + "mutedTill":1532797185516, // Timestamp that this user will be unmuted at + "expHistory": { + "2019-10-17": 17260 // Last 7 days of exp earned for this member + } + }, { + "uuid": "6407035ace144175a731fac937d410cd", + "rank": "Co-Owner", + "joined": 1512074687198, + "last_rank_modification": { // Data for last changes to this users rank + "at": 1532715237290, // Timestamp the rank was changed + "uuid": "e72660b18b88424ea23f2cdd3597c581" // User the rank was changed by + }, + "expHistory": { + "2019-10-17": 15812 + } + } + // ... + ], + "name": "Froggy", // Name of this guild + "name_lower": "froggy" // Name of this guild in all lower case + "tagColor": "DARK_GREEN", // Color of this guild's guild tag, if set + "joinable": false, // Whether this guild can be joined using /g join + "legacyRanking": 10446, // Ranking in the number of guild coins owned in the legacy guild system (0-indexed) + "exp": 619178, // Total experience this guild has + "description": "This guild is cool \u0026 fun!", // Description of this guild that appears in the guild list and /g info + "achievements": { // Guild achievements earned and the current progress + "WINNERS": 803, + "EXPERIENCE_KINGS": 243576 + // ... + }, + "ranks": [{ + "name": "Member", // Display name + "permissions": [], // Array of the IDs of permissions this rank has + "default": true, // Whether this rank is the defualt rank a user gets when they join a guild + "tag": null, // Rank tag that appears in guild chat, or null if none + "created": 1532713597406, // Timestamp of rank creation + "priority": 1 // Rank priority - Higher number = higher up in the heirarchy + }, { + "name": "Co-Owner", + "permissions": [5, 6, 7, 8, 9, 10, 11], + "default": false, + "tag": "CO", + "created": 1532715059862, + "priority": 2 + } + // ... + ], + "banner": { // This guild's Minecraft banner - Displayed on the Hypixel forums page + // See https://minecraft.gamepedia.com/Banner/Patterns for pattern IDs + "Base": "0", // Base color + "Patterns": [ // Array of each layer on the banner pattern + { + "Pattern": "vhr", // Pattern ID for this layer + "Color": "15" // Color of this layer (16-color 0-indexed pallete) + }, { + "Pattern": "vh", + "Color": "15" + } + // ... + ] + }, + "guildExpByGameType": { // Amount of EXP earned for this guild by which game it was earned in + "SKYWARS": 173, + "PROTOTYPE": 3100, + "BUILD_BATTLE": 46095 + // ... + }, + "tag": "HYPIXL", // This guild's Guild tag + "preferredGames": ["ARCADE", "SPEED_UHC", "UHC"], // This guild's set preferred games + "chatThrottle": 10000, // Number of milliseconds users must wait between messages + "vipCount": 22, // The number of players in the guild with VIP or VIP+ (Unreliable) + "mvpCount": 39, // The number of players in the guild with MVP or higher (Unreliable) + "publiclyListed": false, // Whether the guild is listed in the Guild Finder or not + "chatMute": 1532797565473 // Timestamp that the entire guild chat will be unmuted at + } } ``` diff --git a/Documentation/methods/leaderboards.md b/Documentation/methods/leaderboards.md index a750ed1b..0d08a480 100644 --- a/Documentation/methods/leaderboards.md +++ b/Documentation/methods/leaderboards.md @@ -8,23 +8,25 @@ Returns a list of the official leaderboards and their current standings for game - key ## Example Leaderboard -```php +```js { - "TNTGAMES": [ - { - "path": "wins_tntrun", - "prefix": "Overall", - "count": 10, // Number of properties in "leaders" - "location": "-2554,57,715", // Coordinates of the board in the lobby - "leaders": [ - "494a5e4a-ecd1-4a16-b9ee-de37ef24820d", - "adc9fbdd-ede0-4ce9-8abf-42a97148bdbf", - "222c4837-a906-40ed-a1fb-5713a70c13db", - ... - ], - "title": "TNT Run Wins" - }, - ... - ] + "success": true, + "leaderboards": { + "SKYWARS": [ + { + "path": "wins", + "prefix": "Overall", + "title": "Wins", + "location": "-2556,55,712", // Coordinates of the board in the lobby + "count": 14, + "leaders": [ + "2afdb69c-c007-40cd-98b9-76a7554612d9", + "6951ccdb-9ca7-4c8a-883b-a8d3bb81c3d2", + "e61044cc-c42f-439b-9ad7-817c51ae7174", + ... + ] + } + ] + } } ``` diff --git a/Documentation/methods/playerCount.md b/Documentation/methods/playerCount.md index bc454f89..b0798d15 100644 --- a/Documentation/methods/playerCount.md +++ b/Documentation/methods/playerCount.md @@ -4,16 +4,14 @@ Returns current player count. This is also now included in the [`gameCounts`](/Documentation/methods/gameCounts.md) method. - + ## Parameters - key ## Example Player Count - ```php - [ - { - "playerCount":12345 // Current Player Count - }, - ... - ] +```js +{ + "success": true, + "playerCount": 75612 // Total players on the network +} ``` diff --git a/Documentation/methods/recentGames.md b/Documentation/methods/recentGames.md index 29ad5209..b35cf4d2 100644 --- a/Documentation/methods/recentGames.md +++ b/Documentation/methods/recentGames.md @@ -11,33 +11,38 @@ Players can disable this endpoint via in-game settings. When done so the API wil - uuid ## Example Response -```php +```js { - "games": [ - { - "date": 1583837333968, - "gameType": "BEDWARS", - "mode": "FOUR_FOUR", - "map": "Dreamgrove" - }, - { - "date": 1583835955288, - "gameType": "BEDWARS", - "mode": "FOUR_FOUR", - "map": "Ashore" - }, - { - "date": 1583832051787, - "gameType": "DUELS", - "mode": "SW_DUEL", - "map": "Agni Temple" - }, - { - "date": 1583831476897, - "gameType": "SKYWARS", - "mode": "solo_insane", - "map": "Hibiscus" - } - ] + "success": true, + "games": [ + { + "date": 1590850836485, + "gameType": "BEDWARS", + "mode": "FOUR_FOUR", + "map": "Dreamgrove", + "ended": 1590850919917 + }, + { + "date": 1590850404473, + "gameType": "SKYWARS", + "mode": "ranked_normal", + "map": "Meteor", + "ended": 1590850783962 + }, + { + "date": 1590850359562, + "gameType": "DUELS", + "mode": "SW_DUEL", + "map": "Agni Temple", + "ended": 1590850500815 + }, + { + "date": 1590850287155, + "gameType": "SKYWARS", + "mode": "solo_insane", + "map": "Mythic", + "ended": 1590850352734 + } + ] } ``` diff --git a/Documentation/methods/skyblock/auction.md b/Documentation/methods/skyblock/auction.md index 75665e64..89ea41db 100644 --- a/Documentation/methods/skyblock/auction.md +++ b/Documentation/methods/skyblock/auction.md @@ -10,39 +10,43 @@ Returns SkyBlock auctions by either player, profile or auction uuid. Only "activ - uuid ## Example Response -```php +```js { - "success": true, - "auctions": [ + "success": true, + "auctions": [ + { + "_id": "5dcdaf2244f4f4f350c02bf3", + "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": [ { - "uuid": "bc581ce675e94a0c88ac9deae06090f0", - "auctioneer": "96a7c06732f54c1382ab6a2515dbb960", - "profile_id": "96a7c06732f54c1382ab6a2515dbb960", - "coop": [ - "96a7c06732f54c1382ab6a2515dbb960" - ], - "start": 1571049581232, - "end": 1571071181232, - "item_name": "Magical Mushroom Soup", - "item_lore": "§7Consuming this Magical Mushroom\n§7Soup on your private island\n§7allows the player to fly for §a2\n§aminutes§7. Leaving the private\n§7island will remove the effect!\n\n§a§lUNCOMMON", - "extra": "Magical Mushroom Soup Mushroom Soup", - "category": "consumables", - "tier": "UNCOMMON", - "starting_bid": 256, - "item_bytes": "...", - "claimed": false, - "claimed_bidders": [], - "highest_bid_amount": 256, - "bids": [ - { - "auction_id": "bc581ce675e94a0c88ac9deae06090f0", - "bidder": "70aafcc6764b45ff80e60226193a0784", - "profile_id": "70aafcc6764b45ff80e60226193a0784", - "amount": 256, - "timestamp": 1571065921089 - } - ] + "auction_id": "409a1e0f261a49849493278d6cd9305a", + "bidder": "99748e629dee463892f68abf3a780094", + "profile_id": "99748e629dee463892f68abf3a780094", + "amount": 7607533, + "timestamp": 1573760824844 } - ] -} -``` \ No newline at end of file + ] + } + ] +} +``` diff --git a/Documentation/methods/skyblock/auctions.md b/Documentation/methods/skyblock/auctions.md index 42a390e0..16981858 100644 --- a/Documentation/methods/skyblock/auctions.md +++ b/Documentation/methods/skyblock/auctions.md @@ -8,43 +8,43 @@ Returns SkyBlock auctions that are currently active in the in-game Auction House - page (Zero indexed and defaults to 0) ## Example Response -```php +```js { - "success": true, - "page": 0, // The current page - "totalPages": 32, // Total amount of pages avaliable - "totalAuctions": 31267, // Total amount of results in the auction house - "lastUpdated": 1571065561345, // Unix timestamp in milliseconds of when the data last updated in the API - "auctions": [ // The auctions themselves + "success": true, + "page": 0, // The current page + "totalPages": 32, // Total amount of pages avaliable + "totalAuctions": 31267, // Total amount of results in the auction house + "lastUpdated": 1571065561345, // Unix timestamp in milliseconds of when the data last updated in the API + "auctions": [ // The auctions themselves + { + "uuid": "bc581ce675e94a0c88ac9deae06090f0", + "auctioneer": "96a7c06732f54c1382ab6a2515dbb960", + "profile_id": "96a7c06732f54c1382ab6a2515dbb960", + "coop": [ + "96a7c06732f54c1382ab6a2515dbb960" + ], + "start": 1571049581232, + "end": 1571071181232, + "item_name": "Magical Mushroom Soup", + "item_lore": "§7Consuming this Magical Mushroom\n§7Soup on your private island\n§7allows the player to fly for §a2\n§aminutes§7. Leaving the private\n§7island will remove the effect!\n\n§a§lUNCOMMON", + "extra": "Magical Mushroom Soup Mushroom Soup", + "category": "consumables", + "tier": "UNCOMMON", + "starting_bid": 256, + "item_bytes": "...", + "claimed": false, + "claimed_bidders": [], + "highest_bid_amount": 256, + "bids": [ { - "uuid": "bc581ce675e94a0c88ac9deae06090f0", - "auctioneer": "96a7c06732f54c1382ab6a2515dbb960", - "profile_id": "96a7c06732f54c1382ab6a2515dbb960", - "coop": [ - "96a7c06732f54c1382ab6a2515dbb960" - ], - "start": 1571049581232, - "end": 1571071181232, - "item_name": "Magical Mushroom Soup", - "item_lore": "§7Consuming this Magical Mushroom\n§7Soup on your private island\n§7allows the player to fly for §a2\n§aminutes§7. Leaving the private\n§7island will remove the effect!\n\n§a§lUNCOMMON", - "extra": "Magical Mushroom Soup Mushroom Soup", - "category": "consumables", - "tier": "UNCOMMON", - "starting_bid": 256, - "item_bytes": "...", - "claimed": false, - "claimed_bidders": [], - "highest_bid_amount": 256, - "bids": [ - { - "auction_id": "bc581ce675e94a0c88ac9deae06090f0", - "bidder": "70aafcc6764b45ff80e60226193a0784", - "profile_id": "70aafcc6764b45ff80e60226193a0784", - "amount": 256, - "timestamp": 1571065921089 - } - ] + "auction_id": "bc581ce675e94a0c88ac9deae06090f0", + "bidder": "70aafcc6764b45ff80e60226193a0784", + "profile_id": "70aafcc6764b45ff80e60226193a0784", + "amount": 256, + "timestamp": 1571065921089 } - ] -} -``` \ No newline at end of file + ] + } + ] +} +``` diff --git a/Documentation/methods/skyblock/bazaar.md b/Documentation/methods/skyblock/bazaar.md index 53a6f33d..4fca9af3 100644 --- a/Documentation/methods/skyblock/bazaar.md +++ b/Documentation/methods/skyblock/bazaar.md @@ -7,7 +7,7 @@ Returns the list of [products](#product-description) along with their sell summa - key ## Example Response -```php +```js { "success": true, "lastUpdated": 1587237498970, diff --git a/Documentation/methods/skyblock/bazaar/product.md b/Documentation/methods/skyblock/bazaar/product.md index 0bbd8927..a1e71099 100644 --- a/Documentation/methods/skyblock/bazaar/product.md +++ b/Documentation/methods/skyblock/bazaar/product.md @@ -2,7 +2,7 @@ **Note**: This method is deprecated and will be removed at a later date. ## Description -Returns information about a bazaar product by product id. +Returns information about a bazaar product by product id. Due to the way the data is stored in the backend, the "buy" and "sell" fields are all the wrong way round so these will need to be flipped. This is not the case on the new [skyblock/bazaar](https://github.com/HypixelDev/PublicAPI/blob/master/Documentation/methods/skyblock/bazaar.md) endpoint. @@ -34,7 +34,7 @@ You can compute the avg unit price of instant buy on a historic data point using - productId ## Example Response -```php +```js { "success": true, "product_info": { diff --git a/Documentation/methods/skyblock/bazaar/products.md b/Documentation/methods/skyblock/bazaar/products.md index a94cee9f..a570f6a0 100644 --- a/Documentation/methods/skyblock/bazaar/products.md +++ b/Documentation/methods/skyblock/bazaar/products.md @@ -10,178 +10,25 @@ You can cache a copy of the output for a long time, it rarely gets updated. - key ## Example Response -```php +```js { "success": true, "productIds": [ - "ENCHANTED_RAW_CHICKEN", "INK_SACK:3", "BROWN_MUSHROOM", - "ENCHANTED_WATER_LILY", "INK_SACK:4", "TARANTULA_WEB", "CARROT_ITEM", "ENCHANTED_POTATO", - "LOG:1", "ENCHANTED_SLIME_BALL", + "ENCHANTED_RED_MUSHROOM", "ENCHANTED_GOLDEN_CARROT", - "LOG:3", - "LOG:2", "ENCHANTED_RABBIT_HIDE", - "ENCHANTED_GLOWSTONE_DUST", - "ENCHANTED_INK_SACK", - "ENCHANTED_CACTUS", - "ENCHANTED_SUGAR_CANE", "ENCHANTED_BIRCH_LOG", "ENCHANTED_GUNPOWDER", "ENCHANTED_MELON", - "ENCHANTED_COOKED_SALMON", "ENCHANTED_SUGAR", - "LOG", - "CACTUS", - "ENCHANTED_BLAZE_ROD", - "GHAST_TEAR", - "ENCHANTED_CAKE", - "PUMPKIN", - "ENCHANTED_ENDER_PEARL", - "PURPLE_CANDY", - "WHEAT", - "ENCHANTED_FERMENTED_SPIDER_EYE", - "ENCHANTED_GOLD_BLOCK", - "ENCHANTED_RAW_SALMON", - "ENCHANTED_JUNGLE_LOG", - "ENCHANTED_FLINT", - "ENCHANTED_GLISTERING_MELON", - "IRON_INGOT", - "PRISMARINE_SHARD", - "ENCHANTED_EMERALD", - "ENCHANTED_SPIDER_EYE", - "ENCHANTED_EMERALD_BLOCK", - "RED_MUSHROOM", - "MUTTON", - "ENCHANTED_MELON_BLOCK", - "ENCHANTED_CLAY_BALL", - "DIAMOND", - "COBBLESTONE", - "SPIDER_EYE", - "RAW_FISH", - "ENCHANTED_PUFFERFISH", - "GLOWSTONE_DUST", - "GOLD_INGOT", - "REVENANT_VISCERA", - "TARANTULA_SILK", - "POTATO_ITEM", - "ENCHANTED_MUTTON", - "ENCHANTED_HUGE_MUSHROOM_1", - "SUPER_COMPACTOR_3000", - "ENCHANTED_IRON", - "STOCK_OF_STONKS", - "ENCHANTED_COBBLESTONE", - "ENCHANTED_BONE", - "ENCHANTED_PAPER", - "ENCHANTED_HUGE_MUSHROOM_2", - "PORK", - "ENCHANTED_DIAMOND_BLOCK", - "EMERALD", - "ENCHANTED_RABBIT_FOOT", - "PRISMARINE_CRYSTALS", - "HOT_POTATO_BOOK", - "ENCHANTED_ICE", - "ICE", - "CLAY_BALL", - "HUGE_MUSHROOM_1", - "HUGE_MUSHROOM_2", - "LOG_2:1", - "GREEN_GIFT", - "GOLDEN_TOOTH", - "STRING", - "PACKED_ICE", - "WATER_LILY", - "RABBIT_FOOT", - "LOG_2", - "REDSTONE", - "ENCHANTED_OBSIDIAN", - "ENCHANTED_COAL", - "COAL", - "ENCHANTED_QUARTZ", - "ENDER_PEARL", - "ENCHANTED_COAL_BLOCK", - "ENCHANTED_CACTUS_GREEN", - "ENCHANTED_PRISMARINE_CRYSTALS", - "ENCHANTED_CARROT_ON_A_STICK", - "ENCHANTED_ENDSTONE", - "ENCHANTED_LAPIS_LAZULI_BLOCK", - "ENCHANTED_COOKIE", - "ENCHANTED_STRING", - "SLIME_BALL", - "ENDER_STONE", - "ENCHANTED_RAW_FISH", - "ENCHANTED_ACACIA_LOG", - "ENCHANTED_EGG", - "QUARTZ", - "ENCHANTED_EYE_OF_ENDER", - "SAND", - "RAW_CHICKEN", - "MAGMA_CREAM", - "SUGAR_CANE", - "ENCHANTED_LAPIS_LAZULI", - "ENCHANTED_GHAST_TEAR", - "ENCHANTED_COCOA", - "RED_GIFT", - "ENCHANTED_RAW_BEEF", - "SEEDS", - "ENCHANTED_LEATHER", - "ENCHANTED_SPONGE", - "ENCHANTED_FEATHER", - "ENCHANTED_SLIME_BLOCK", - "ENCHANTED_OAK_LOG", - "RABBIT_HIDE", - "WHITE_GIFT", - "INK_SACK", - "FLINT", - "ENCHANTED_SPRUCE_LOG", - "WOLF_TOOTH", - "ENCHANTED_ROTTEN_FLESH", - "ENCHANTED_GRILLED_PORK", - "SULPHUR", - "NETHER_STALK", - "RABBIT", - "ENCHANTED_NETHER_STALK", - "ENCHANTED_REDSTONE_BLOCK", - "ENCHANTED_QUARTZ_BLOCK", - "ENCHANTED_CARROT", - "ENCHANTED_PUMPKIN", - "GREEN_CANDY", - "ENCHANTED_REDSTONE", - "ROTTEN_FLESH", - "ENCHANTED_COOKED_FISH", - "OBSIDIAN", - "ENCHANTED_MAGMA_CREAM", - "GRAVEL", - "MELON", - "RAW_FISH:3", - "ENCHANTED_PRISMARINE_SHARD", - "ENCHANTED_IRON_BLOCK", - "LEATHER", - "ENCHANTED_COOKED_MUTTON", - "BONE", - "RAW_FISH:1", - "REVENANT_FLESH", - "ENCHANTED_PORK", - "ENCHANTED_GLOWSTONE", - "ENCHANTED_BREAD", - "FEATHER", - "ENCHANTED_CHARCOAL", - "ENCHANTED_BLAZE_POWDER", - "NETHERRACK", - "SUMMONING_EYE", - "SPONGE", - "BLAZE_ROD", - "ENCHANTED_DARK_OAK_LOG", - "ENCHANTED_BAKED_POTATO", - "COMPACTOR", - "ENCHANTED_DIAMOND", - "ENCHANTED_GOLD" + ... ] } -``` \ No newline at end of file +``` diff --git a/Documentation/methods/skyblock/news.md b/Documentation/methods/skyblock/news.md index a63b8217..c6a44956 100644 --- a/Documentation/methods/skyblock/news.md +++ b/Documentation/methods/skyblock/news.md @@ -2,6 +2,32 @@ ## Description Returns SkyBlock news, including a title, description and a thread. - + ## Parameters -- key \ No newline at end of file +- key + +## Example Response +```js +{ + "success": true, + "items": [ + { + "item": { + "material": "MONSTER_EGG", + "data": 90 + }, + "link": "https://hypixel.net/threads/2852738/", + "text": "6th May 2020", + "title": "SkyBlock v0.7.8" + }, + { + "item": { + "material": "GOLD_NUGGET" + }, + "link": "https://hypixel.net/threads/2655146/", + "text": "9th March 2020", + "title": "SkyBlock v0.7.7" + } + ] +} +``` diff --git a/Documentation/methods/status.md b/Documentation/methods/status.md index 5cfce70e..da9a2e26 100644 --- a/Documentation/methods/status.md +++ b/Documentation/methods/status.md @@ -11,12 +11,14 @@ Players can disable this endpoint via in-game settings. When done so the API wil - uuid ## Example Response -```php +```js { - "session": { - "online": true, - "gameType": "SKYBLOCK", - "mode": "dynamic" - } + "success": true, + "session":{ + "online": true, + "gameType": "SKYWARS", + "mode": "ranked_normal", + "map": "Agni Temple" + } } ``` diff --git a/Documentation/methods/watchdogstats.md b/Documentation/methods/watchdogstats.md index 7a94cd94..c0fca31c 100644 --- a/Documentation/methods/watchdogstats.md +++ b/Documentation/methods/watchdogstats.md @@ -8,15 +8,13 @@ Returns some statistics about Watchdog & bans. - key ## Example Watchdog-Stats -```php -[ - { - "watchdog_lastMinute": "1", // Watchdog's bans in the last minute. - "staff_rollingDaily": 123, // Staff bans in the last day. - "watchdog_total": 1234567, // Total Watchdog bans, ever. - "watchdog_rollingDaily": 1234, // Watchdog bans in the last day. - "staff_total": 123456, // Total staff bans, ever. - }, - ... -] +```js +{ + "success": true, + "watchdog_lastMinute": 5, // Watchdog's bans in the last minute. + "staff_rollingDaily": 1356, // Staff bans in the last day. + "watchdog_total": 4924740, // Total Watchdog bans, ever. + "watchdog_rollingDaily": 7679, // Watchdog bans in the last day. + "staff_total": 1608360 // Total staff bans, ever. +} ``` From bafc55b079aee423f34ee066e600d9873893eae5 Mon Sep 17 00:00:00 2001 From: mdashlw Date: Sat, 30 May 2020 19:06:46 +0300 Subject: [PATCH 2/6] More examples --- Documentation/methods/findGuild.md | 10 ++++- Documentation/methods/gameCounts.md | 2 +- Documentation/methods/guild.md | 2 +- Documentation/methods/leaderboards.md | 2 +- Documentation/methods/playerCount.md | 2 +- Documentation/methods/skyblock/bazaar.md | 55 +++++++++++------------- Documentation/methods/watchdogstats.md | 2 +- 7 files changed, 38 insertions(+), 37 deletions(-) diff --git a/Documentation/methods/findGuild.md b/Documentation/methods/findGuild.md index 5f04c789..d7b0264a 100644 --- a/Documentation/methods/findGuild.md +++ b/Documentation/methods/findGuild.md @@ -5,5 +5,13 @@ Returns the id of the requested guild. ## Parameters - key -- byName _(Case sensitive, HTML encode spaces)_ +- byName - byUuid + +## Example Response +```js +{ + "success": true, + "guild": "553490650cf26f12ae5bac8f" +} +``` diff --git a/Documentation/methods/gameCounts.md b/Documentation/methods/gameCounts.md index ca3eddec..ca557931 100644 --- a/Documentation/methods/gameCounts.md +++ b/Documentation/methods/gameCounts.md @@ -8,7 +8,7 @@ Due to the large amount of modes and that they can change at anytime we don't cu ## Parameters - key -## Example Player Count +## Example Response ```js { "success": true, diff --git a/Documentation/methods/guild.md b/Documentation/methods/guild.md index 32b1e4b3..773ad5da 100644 --- a/Documentation/methods/guild.md +++ b/Documentation/methods/guild.md @@ -11,7 +11,7 @@ See [`resources.md`](/Documentation/methods/resources.md) for a JSON list of Gui - player (Lookup by Player UUID) - name (Lookup by Guild name) -## Example +## Example Response ```js { "success": true, diff --git a/Documentation/methods/leaderboards.md b/Documentation/methods/leaderboards.md index 0d08a480..4795ae65 100644 --- a/Documentation/methods/leaderboards.md +++ b/Documentation/methods/leaderboards.md @@ -7,7 +7,7 @@ Returns a list of the official leaderboards and their current standings for game ## Parameters - key -## Example Leaderboard +## Example Response ```js { "success": true, diff --git a/Documentation/methods/playerCount.md b/Documentation/methods/playerCount.md index b0798d15..302b2d19 100644 --- a/Documentation/methods/playerCount.md +++ b/Documentation/methods/playerCount.md @@ -8,7 +8,7 @@ This is also now included in the [`gameCounts`](/Documentation/methods/gameCount ## Parameters - key -## Example Player Count +## Example Response ```js { "success": true, diff --git a/Documentation/methods/skyblock/bazaar.md b/Documentation/methods/skyblock/bazaar.md index 4fca9af3..b6ab45b4 100644 --- a/Documentation/methods/skyblock/bazaar.md +++ b/Documentation/methods/skyblock/bazaar.md @@ -10,59 +10,52 @@ Returns the list of [products](#product-description) along with their sell summa ```js { "success": true, - "lastUpdated": 1587237498970, + "lastUpdated": 1590854517479, "products": { "INK_SACK:3": { "product_id": "INK_SACK:3", "sell_summary": [ { - "amount": 1730, - "pricePerUnit": 4.7, + "amount": 20569, + "pricePerUnit": 4.2, "orders": 1 }, { - "amount": 50381, - "pricePerUnit": 3.6, + "amount": 140326, + "pricePerUnit": 3.8, "orders": 2 - }, - { - "amount": 59380, - "pricePerUnit": 3.5, - "orders": 2 - }, - // ... + } ], "buy_summary": [ { - "amount": 66091, - "pricePerUnit": 6.1, + "amount": 640, + "pricePerUnit": 4.8, "orders": 1 }, { - "amount": 8594, - "pricePerUnit": 6.3, - "orders": 7 + "amount": 640, + "pricePerUnit": 4.9, + "orders": 1 }, { - "amount": 71680, - "pricePerUnit": 6.9, - "orders": 1 + "amount": 25957, + "pricePerUnit": 5, + "orders": 3 }, - // ... + ... ], "quick_status": { "productId": "INK_SACK:3", - "sellPrice": 3.636518201531347, - "sellVolume": 1777058, - "sellMovingWeek": 10469536, - "sellOrders": 66, - "buyPrice": 6.1, - "buyVolume": 432601, - "buyMovingWeek": 6663769, - "buyOrders": 125 + "sellPrice": 4.2, + "sellVolume": 409855, + "sellMovingWeek": 8301075, + "sellOrders": 11, + "buyPrice": 4.99260315136572, + "buyVolume": 1254854, + "buyMovingWeek": 5830656, + "buyOrders": 85 } - }, - // ... + } } } ``` diff --git a/Documentation/methods/watchdogstats.md b/Documentation/methods/watchdogstats.md index c0fca31c..bd55af6d 100644 --- a/Documentation/methods/watchdogstats.md +++ b/Documentation/methods/watchdogstats.md @@ -7,7 +7,7 @@ Returns some statistics about Watchdog & bans. ## Parameters - key -## Example Watchdog-Stats +## Example Response ```js { "success": true, From f593dc1787d6dca7aa1612c8e3b798e48cb81700 Mon Sep 17 00:00:00 2001 From: mdashlw Date: Sat, 30 May 2020 19:09:44 +0300 Subject: [PATCH 3/6] Remove ... --- Documentation/methods/skyblock/bazaar.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Documentation/methods/skyblock/bazaar.md b/Documentation/methods/skyblock/bazaar.md index b6ab45b4..19bf58eb 100644 --- a/Documentation/methods/skyblock/bazaar.md +++ b/Documentation/methods/skyblock/bazaar.md @@ -41,8 +41,7 @@ Returns the list of [products](#product-description) along with their sell summa "amount": 25957, "pricePerUnit": 5, "orders": 3 - }, - ... + } ], "quick_status": { "productId": "INK_SACK:3", From 7577e6bf9370728d82f00fdbf54c603f8e07e51c Mon Sep 17 00:00:00 2001 From: mdashlw Date: Sat, 30 May 2020 19:13:50 +0300 Subject: [PATCH 4/6] Update key example --- Documentation/methods/key.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/Documentation/methods/key.md b/Documentation/methods/key.md index b8a91f6d..19122d82 100644 --- a/Documentation/methods/key.md +++ b/Documentation/methods/key.md @@ -7,11 +7,15 @@ Returns information regarding given key. - key ## Example Response -```php +```js { - "key": "", - "ownerUuid": "", // not dashed - "totalQueries": 142028083, - "queriesInPastMin": 68 -} -``` \ No newline at end of file + "success": true, + "record": { + "key": "e1513542-f4c7-483d-bf1b-3b29d4e59903", + "owner": "8ffb79fa-620e-45fe-8d62-381abd5bc60f", + "limit": 120, + "queriesInPastMin": 0, + "totalQueries": 849 + } +} +``` From 32b5e309f874f529ebeb3e5ec2c7e1edd11f2465 Mon Sep 17 00:00:00 2001 From: mdashlw Date: Sat, 30 May 2020 20:00:38 +0300 Subject: [PATCH 5/6] Update guild example --- Documentation/methods/guild.md | 124 ++++++++++++++------------------- 1 file changed, 52 insertions(+), 72 deletions(-) diff --git a/Documentation/methods/guild.md b/Documentation/methods/guild.md index 773ad5da..1088b279 100644 --- a/Documentation/methods/guild.md +++ b/Documentation/methods/guild.md @@ -16,90 +16,70 @@ See [`resources.md`](/Documentation/methods/resources.md) for a JSON list of Gui { "success": true, "guild": { - "_id": "536ac9ceed5032e412eb2ae1", // Guild ID - "coins": 459178, // Number of coins this guild has - Deprecated - "coinsEver": 619178, // Number of coins this guild has ever earned - Deprecated - "created": 1399507406038, // Timestamp that this guild was created at - "members": [{ // Member list - "uuid": "e72660b18b88424ea23f2cdd3597c581", // This user's non-dashed UUID - "rank": "GUILDMASTER", // This user's rank in this guild - "joined": 1512200875108, // Timestamp the member joined - "dailyCoins-12-6-2018": 1560, // Guild coins earned by this user on any given day - Deprecated - "questParticipation": 4, // The number of challenges completed that count towards the current quest - "mutedTill":1532797185516, // Timestamp that this user will be unmuted at - "expHistory": { - "2019-10-17": 17260 // Last 7 days of exp earned for this member + "_id": "52e57a1c0cf2e250d1cd00f8", // Guild ID + "created": 1390770716373, // Timestamp this guild was created at + "name": "The Sloths", + "name_lower": "the sloths", + "description": "The sloths", // Description of this guild that appears in the guild list and /g info + "tag": "SLOTH", + "tagColor": "DARK_AQUA", // Color of this guild's tag, if set + "exp": 2238673, + "members": [ + { + "uuid": "f7c77d999f154a66a87dc4a51ef30d19", + "rank": "GUILDMASTER", + "joined": 1390770716373, // Timestamp this member joined at + "expHistory": { // Last 7 days of exp earned by this member + "2020-05-25": 108, + "2020-05-24": 404 + }, + "questParticipation": 4, // The number of challenges completed that count towards the current quest + "mutedTill": 1399507406038 // Timestamp this member will be unmuted at } - }, { - "uuid": "6407035ace144175a731fac937d410cd", - "rank": "Co-Owner", - "joined": 1512074687198, - "last_rank_modification": { // Data for last changes to this users rank - "at": 1532715237290, // Timestamp the rank was changed - "uuid": "e72660b18b88424ea23f2cdd3597c581" // User the rank was changed by - }, - "expHistory": { - "2019-10-17": 15812 + ], + "achievements": { // Guild achievements earned and the current progress + "ONLINE_PLAYERS": 4, + "EXPERIENCE_KINGS": 40062, + "WINNERS": 2 + }, + "ranks": [ + { + "name": "Member", + "default": true, // Whether this rank is the defualt rank a player gets when they join a guild + "created": 1, // Timestamp this rank was created at + "priority": 1, // Rank priority - Higher number = higher up in the heirarchy + "tag": "Member" // Rank tag that appears in guild chat, or null if none } - } - // ... - ], - "name": "Froggy", // Name of this guild - "name_lower": "froggy" // Name of this guild in all lower case - "tagColor": "DARK_GREEN", // Color of this guild's guild tag, if set - "joinable": false, // Whether this guild can be joined using /g join + ], + "joinable": true, // Whether this guild can be joined using /g join "legacyRanking": 10446, // Ranking in the number of guild coins owned in the legacy guild system (0-indexed) - "exp": 619178, // Total experience this guild has - "description": "This guild is cool \u0026 fun!", // Description of this guild that appears in the guild list and /g info - "achievements": { // Guild achievements earned and the current progress - "WINNERS": 803, - "EXPERIENCE_KINGS": 243576 - // ... + "publiclyListed": false, // Whether this guild is listed in the Guild Finder + "hideGmTag": true, // Whether guild master tag is hidden in guild chat + "preferredGames": [ // This guild's set preferred games + "ARCADE", + "SPEED_UHC", + "UHC" + ], + "chatMute": 1590703490783, // Timestamp guild chat will be unmuted at, or 0 if guild chat is not muted + "guildExpByGameType": { // Amount of EXP earned for this guild by which game it was earned in + "TNTGAMES": 1312, + "VAMPIREZ": 4495, + "ARCADE": 10285 }, - "ranks": [{ - "name": "Member", // Display name - "permissions": [], // Array of the IDs of permissions this rank has - "default": true, // Whether this rank is the defualt rank a user gets when they join a guild - "tag": null, // Rank tag that appears in guild chat, or null if none - "created": 1532713597406, // Timestamp of rank creation - "priority": 1 // Rank priority - Higher number = higher up in the heirarchy - }, { - "name": "Co-Owner", - "permissions": [5, 6, 7, 8, 9, 10, 11], - "default": false, - "tag": "CO", - "created": 1532715059862, - "priority": 2 - } - // ... - ], - "banner": { // This guild's Minecraft banner - Displayed on the Hypixel forums page - // See https://minecraft.gamepedia.com/Banner/Patterns for pattern IDs + "banner": { // This guild's Minecraft banner - Displayed on the Hypixel forums page + // See https://minecraft.gamepedia.com/Banner/Patterns for pattern IDs "Base": "0", // Base color "Patterns": [ // Array of each layer on the banner pattern { "Pattern": "vhr", // Pattern ID for this layer "Color": "15" // Color of this layer (16-color 0-indexed pallete) - }, { + }, + { "Pattern": "vh", "Color": "15" } - // ... - ] - }, - "guildExpByGameType": { // Amount of EXP earned for this guild by which game it was earned in - "SKYWARS": 173, - "PROTOTYPE": 3100, - "BUILD_BATTLE": 46095 - // ... - }, - "tag": "HYPIXL", // This guild's Guild tag - "preferredGames": ["ARCADE", "SPEED_UHC", "UHC"], // This guild's set preferred games - "chatThrottle": 10000, // Number of milliseconds users must wait between messages - "vipCount": 22, // The number of players in the guild with VIP or VIP+ (Unreliable) - "mvpCount": 39, // The number of players in the guild with MVP or higher (Unreliable) - "publiclyListed": false, // Whether the guild is listed in the Guild Finder or not - "chatMute": 1532797565473 // Timestamp that the entire guild chat will be unmuted at + ] + } } } ``` From 0a0336c5071511964d43d674a7102e74436a5e59 Mon Sep 17 00:00:00 2001 From: mdashlw Date: Sun, 31 May 2020 17:30:14 +0300 Subject: [PATCH 6/6] More explanation of recentGames and key --- Documentation/methods/key.md | 4 ++-- Documentation/methods/recentGames.md | 6 ++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/Documentation/methods/key.md b/Documentation/methods/key.md index 19122d82..daf9a368 100644 --- a/Documentation/methods/key.md +++ b/Documentation/methods/key.md @@ -13,8 +13,8 @@ Returns information regarding given key. "record": { "key": "e1513542-f4c7-483d-bf1b-3b29d4e59903", "owner": "8ffb79fa-620e-45fe-8d62-381abd5bc60f", - "limit": 120, - "queriesInPastMin": 0, + "limit": 120, // Limit of requests per minute + "queriesInPastMin": 0, // Does not include this query "totalQueries": 849 } } diff --git a/Documentation/methods/recentGames.md b/Documentation/methods/recentGames.md index b35cf4d2..917af7c5 100644 --- a/Documentation/methods/recentGames.md +++ b/Documentation/methods/recentGames.md @@ -15,6 +15,12 @@ Players can disable this endpoint via in-game settings. When done so the API wil { "success": true, "games": [ + { // No 'ended' means the game is still running + "date": 1590935247444, + "gameType": "SKYWARS", + "mode": "solo_normal", + "map": "Shire" + }, { "date": 1590850836485, "gameType": "BEDWARS",