Package Exports
- hypixel-api-reborn
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 (hypixel-api-reborn) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Hypixel API • Reborn
This is the only Hypixel API wrapper for Node.js with intellisense support
Documentation
GitHub Wiki
| Functions | Arguments | Returns |
|---|---|---|
| getPlayer | UUID / Nickname | Promise<Player> |
| getGuild | player / name / id | Guild ID / Name / Nickname | Promise<Guild> |
| getFriends | UUID / Nickname | Promise<Array<Friend>> |
| getBoosters | Promise<Array<Booster>> | |
| getOnline | Promise<Number> | |
| getWatchdogStats | Promise<WatchdogStats> | |
| getSkyblockProfiles | UUID / Nickname | Promise<Array<SkyblockProfile>> |
| getSkyblockAuctions | Number / null | Promise<Array<SkyblockAuction>> |
| getSkyblockAuctionsByPlayer | UUID / Nickname | Promise<Array<SkyblockAuction>> |
| getSkyblockBazaar | Promise<Array<SkyblockProduct>> | |
| getStatus | UUID / Nickname | Promise<Status> |
| getKeyInfo | Promise<KeyInfo> | |
| getLeaderboards | Wiki |
Setup
const Hypixel = require('hypixel-api-reborn');
/*
Parameters:
API Key (String)
options (Object)
options.cache (false by default) - Enables/Disables Request Caching
options.cacheTime (60 by default) - Amount of time in seconds to cache the request.
options.cacheSize (-1 by default) - The amount of how many results will be cached (set -1 for infinity)
*/
//Enables caching with a max age of 30 seconds and a limit of 5 cached results
const options = {
cache: true,
cacheTime: 30,
cacheSize: 5
};
const hypixel = new Hypixel.Client('API-KEY', options);