JSPM

node-hypixel.js

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q12721F
  • License MIT

Simple node.js lib for using Hypixel's API, with 100% API coverage!

Package Exports

  • node-hypixel.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-hypixel.js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

NPM Install Info

NPM Version NPM Downloads Deps

node-hypixel.js

Simple node.js lib for using Hypixel's API, with 100% API coverage! Making it easy to fetch data about players, resources, skyblock and much more!

Installation npm install node-hypixel.js

Documentation

Comming soon! Plus pro dev's use the source code.

Example

// Create a new HypixelClient instance.
const { HypixelClient } = require('node-hypixel.js');
const client = new HypixelClient('API KEY');

// Get player by their display name.
client.getPlayerByDisplayname('iColtz')
  .then((player) => {
    // Console log the player.
    console.log(player);
  })
  .catch((error) => {	
    // Log the error if there is one.
    console.log(error);
  });

FAQ

  • How to obtain an API key? It's simple go on Minecraft Hypixel server, and type the command /api to obtain an api key.

  • How to get my UUID? Go to https://api.mojang.com/users/profiles/minecraft/DISPLAY_NAME_HERE and change the end of the url to use players display name.

Author

Author: iColtz