About

hypixel.ts is a NodeJS wrapper for the Hypixel API which allows you to interact with it easily.

• Written in Typescript
• CommonJS, ESM support
• 100% coverage of Hypixel API

Installation

Node.js 14+ or newer is required

npm install hypixel.ts
yarn add hypixel.ts
pnpm add hypixel.ts

Example Usage

Get the info of a player:

import { Client } from 'hypixel.ts';

const client = new Client('API_KEY');

client.players.fetch('armc').then(console.log);

Get a skyblock profile:

import { Client } from 'hypixel.ts';

const client = new Client('API_KEY');

client.skyblock.getProfile('lifelong').then(console.log);

Links

• Documentation
• Discord Server
• Github
• npm

Help

If you're having issues with a method, or the wrapper isn't working as expected, you can join our Discord Server or contact FC#5104.

Contributors

FC 💻 🤔 🚧 📆

Christopher Nethercott 💻