hynfo
v3.0.2
Published
Node.js Hypixel API wrapper!
Downloads
3
Maintainers
Readme
Hynfo
Multi-functional Hypixel API Wrapper for Node.JS!
This is an API wrapper package for Minecraft's most popular server, Hypixel!
const Hynfo = require('hynfo');
const client = new Hynfo({api_key: 'YOUR_HYPIXEL_API_KEY'})
// use '/api new' in-game to get your api key!
client.getPlayer('YaNuu_').then(async res => {
console.log(res)
})
Install
npm install hynfo
Features
Player
.getPlayer(IGN)
- Access player info.getFriends(IGN)
- Get Players friends.getRecentGames(IGN)
- Get recent games played by the user.IfOnline(IGN)
- Get a boolean whether the user is online or not.getSession(IGN)
- Get current player status (game, status, etc.)Guild
.getGuild(GUILDNAME)
- Access Guild info.findGuildByPlayer(IGN)
- Access Guild Info based on a userSkyblock
.getProfileFromName(IGN, CUTE_NAME)
- Get user profile by cute name (Watermelon/Grape/etc.).getSkyblockProfile(PROFILEID)
- Get skyblock profile by its IDMisc
.getKeyInfo(API_KEY)
- Get Info about an API key (owner, limits etc.).getNames(IGN)
- Get all past names and timestamps from Mojang (search by current name).getWatchdog()
- Get current watchdog statistics.getLBs()
- Get all Leaderboards.getLeaderBoard(GAME_MODE)
- Get Leaderboard for a specific game modeResources
.getAchievements()
- Get all Achievements.getGameAchievements(GAME_MODE)
- Get achievements for a specific game mode.getChallenges()
- Get all challenges.getGameChallenges(GAME_MODE)
- Get challenges for a specific game mode.getQuests()
- Get all quests.getGameQuests(GAME_MODE)
- Get Quests for a specific game mode.getGuildAchievements()
- Get all guild achievements.getGuildPermissions()
- Get all guild permissions
Useless events (cuz why not)
nameReceive
- Emitted whengetNames
data is receivedguildData
- Emitted whengetGuild
ORfindGuildByPlayer
ORgetGuildAchievements
ORgetGuildPermissions
data is receivedfriendsData
- Emitted whengetFriends
data is receivedrecentGamesReceive
- Emitted whengetRecentGames
data is receivedplayerData
- Emitted whengetPlayer
ORIfOnline
ORgetSession
data is receivedskyblockData
- Emitted whengetSkyblockProfile
ORgetProfileFromName
data is receivedAPIKeyData
- Emitted whengetKeyInfo
data is receivedachievementsData
- Emitted whengetAchievements
orgetGameAchievements
data is receivedquestsData
- Emitted whengetQuests
orgetGameQuests
data is receivedlbData
- Emitted whengetLBs
orgetLeaderboard
data is receivedGlobal Events
data
- Emitted when any data is received (all of the above events also emitdata
) (data is the only event that contains two params:type
anddata
)
resourceData
- Emitted when resource data is received (LBs, Guild/Normal Achievements, Guild Permissions, Watchdog, Quests, Challenges, Key Info)
skyblockData
- guess 😉 (Emitted when skyblock profile information is received)
Package used
License
MIT