Hypixel & Mojang API for Node.js
JS wrapper for the Hypixel and Mojang APIs.
Installation
npm install hypixel-node
Initializing Classes
const Hypixel Mojang = ;const hypixel = HYPIXEL_API_KEY;const mojang = ;
Hypixel API
Example
const Hypixel = ;const hypixel = HYPIXEL_API_KEY; // With Callbackshypixel; // Promisifiedhypixel ;
Functions
Args | Returns | |
---|---|---|
getKeyInfo | record | |
getBoosters | boosters | |
getLeaderboards | leaderboards | |
getOnlinePlayers | playerCount | |
getWatchdogStats | [object] | |
getGuildByName | name | guild |
getGuildByPlayer | uuid | guild |
getGuild* | id/guildname/uuid/ign | guild |
getFriends | uuid | records |
getSession | uuid | session |
getPlayer | username/uuid | player |
*Note: If you use an "ign" with
getGuild
, it will use 3 api calls.
Methods
These methods are added to certain properties for added functionality.
Property | Method | Description | Type |
---|---|---|---|
player | getLevel | Returns the Hypixel level for the player. | Number |
getRank | Returns the rank of the player. | String | |
isOnline | Returns 'true' of the player is online. | Boolean | |
guild | getGuildLevel | Returns information about the guild's level. | Object |
Examples
async { let player = await hypixel; console // "[OWNER]" console // "OWNER" console // 223 console // false let guild = await hypixel; console /* { level: 4, totalExp: 1500000, expToNextLevel: 250000 } */}
Mojang API
Example
const Mojang = ;const mojang = ; // With Callbacksmojang; // Promisifiedmojang ;
Functions
Args | Returns | |
---|---|---|
getUUID | name | uuid |
getName | uuid | name |
getStatus | [object] | |
getNameHistory | name/uuid | [object] |