hypixel.ts

A simple, easy to use wrapper for Hypixel API.

Usage no npm install needed!

<script type="module">
  import hypixelTs from 'https://cdn.skypack.dev/hypixel.ts';
</script>

README

banner

An easy to use Hypixel API wrapper.

npm version npm downloads

discord server

About

hypixel.ts is a NodeJS module which allows you to interact with the Hypixel API 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

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.