# hypixel.ts

> A simple, easy to use wrapper for Hypixel API.

Latest version **2.1.0** (published 2025-02-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install hypixel.ts
pnpm add hypixel.ts
yarn add hypixel.ts
bun add hypixel.ts
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2025-02-25 |
| First published | 2022-01-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 617 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | FC5570 |
| Maintainers | fc5570 |
| Keywords | hypixel, hypixel-api, hypixel-api-wrapper, hypixel.js, hypixel.ts |

## Links

- npm: https://www.npmjs.com/package/hypixel.ts
- Repository: https://github.com/FC5570/hypixel.ts
- Homepage: https://hypixel.js.org/
- Issues: https://github.com/FC5570/hypixel.ts/issues
- npm.io page: https://npm.io/package/hypixel.ts

## Dependencies (1)

- [@sapphire/async-queue](https://npm.io/package/@sapphire/async-queue.md) ^1.5.5

## Recent versions

- 2.1.0 (latest) — 2025-02-25
- 2.0.1 — 2024-07-21
- 2.0.0 — 2024-05-03
- 1.1.4 — 2023-04-04
- 1.1.3 — 2022-12-30
- 1.1.2 — 2022-10-01
- 1.1.1 — 2022-04-23
- 1.1.0 — 2022-02-06
- 1.0.8 — 2022-01-20
- 1.0.7 — 2022-01-16
- 1.0.6 — 2022-01-16
- 1.0.5 — 2022-01-15
- 1.0.4 — 2022-01-15

## README

<div align="center">

![banner](https://raw.githubusercontent.com/hypixelts/assets/main/svg/full-nobg5232x945.svg)

## **An easy to use [Hypixel API](https://api.hypixel.net) wrapper.**

<p>
    <a href="https://www.npmjs.com/package/hypixel.ts"><img src="https://img.shields.io/npm/v/hypixel.ts.svg?maxAge=3600" alt="npm version" /></a>
    <a href="https://www.npmjs.com/package/hypixel.ts"><img src="https://img.shields.io/npm/dt/hypixel.ts.svg?maxAge=3600" alt="npm downloads" /></a>
    <br />
    <br />
    <a href="https://discord.gg/DDTmaeYUMF"><img src="https://discord.com/api/guilds/931071635119833089/embed.png?style=banner2" alt="discord server" /></a>
</p>
</div>

## About

hypixel.ts is a [NodeJS](https://nodejs.org) wrapper for the [Hypixel API](https://api.hypixel.net) 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**

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

## Example Usage

Get the info of a player:

```typescript
import { Client } from 'hypixel.ts';

const client = new Client('API_KEY');

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

Get a skyblock profile:

```typescript
import { Client } from 'hypixel.ts';

const client = new Client('API_KEY');

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

## Links

- [Documentation](https://hypixel.js.org/)
- [Discord Server](https://discord.gg/DDTmaeYUMF)
- [Github](https://github.com/FC5570/hypixel.ts)
- [npm](https://npmjs.com/package/hypixel.ts)

## Help

If you're having issues with a method, or the wrapper isn't working as expected, you can join our [Discord Server](https://discord.gg/DDTmaeYUMF) or contact FC#5104.

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://fc5570.me/"><img src="https://avatars.githubusercontent.com/u/68158483?v=4?s=100" width="100px;" alt="FC"/><br /><sub><b>FC</b></sub></a><br /><a href="https://github.com/hypixelts/hypixel.ts/commits?author=FC5570" title="Code">💻</a> <a href="#ideas-FC5570" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-FC5570" title="Maintenance">🚧</a> <a href="#projectManagement-FC5570" title="Project Management">📆</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/chriscn"><img src="https://avatars.githubusercontent.com/u/25829276?v=4?s=100" width="100px;" alt="Christopher Nethercott"/><br /><sub><b>Christopher Nethercott</b></sub></a><br /><a href="https://github.com/hypixelts/hypixel.ts/commits?author=chriscn" title="Code">💻</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

---
_Source: https://npm.io/package/hypixel.ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._