Installation

Using NPM:

npm i -s hypixel-js

Dependencies

• node-fetch

Usage

Add to Project

const HypixelClient = require("hypixel-js");

const hypixel = new HypixelClient("your-api-key");

Functions

| | Args | |---------------------- |:----------------------------: | | getPlayer | uuid | username | | getGuild | searchParameter, query | | getWatchdogStats | withCommas | | getBoosters | | | getOnlinePlayers | withCommas | | getFriends | uuid | username | |getSkyblockProfiles| uuid | username | | getSkyblockProfile| id | | getSkyblockNews | | |getSkyblockAuctions| page | | getSkyblockAuction| searchParameter, query | | getBazaar | | | getBazaarProduct | product | | getStatus | uuid | username |

Examples

async () => {
        await HypixelClient.getPlayer("Hypixel").then(player => {
        console.log(player);
});

        let guild = await HypixelClient.getGuild("name", "The Sloths");
        console.log(guild);
}

How to obtain a Hypixel API key

You can obtain an API key by joining mc.hypixel.net with a valid Minecraft account and running the /api command. You will then be assigned a unique key that is to remain private.