@zikeji/hypixel

@zikeji/hypixel

With thorough IntelliSense support & 100% test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses (and an OpenAPI.yaml!), built-in rate-limit handling, flexible cache support, helper functions, and support for undocumented endpoints.

This library aims to replicate the API paths in it's method usage. As such, the general scheme would be to change the path of an API call by simply replacing the / with a ., and if the endpoint takes multiple parameters, those are added on the end. For example, api.hypixel.net/skyblock/profiles?uuid=1234 would simply become client.skyblock.profiles.uuid('1234'). Of course, with everything being fully typed if you are using an IDE that supports IntelliSense you should rarely need to reference documentation.

2.0 to 3.0 Migration

This library follows semver. As backwards incompatible changes were introduced while making this Deno compatible. Most likely nothing you use has changed, and you should be able to update without issue. The only breaking change is that the Client class no longer accepts agent as a parameter, as Deno does not support this.

Installation

NodeJS

Use npm to install this library.

npm i --save @zikeji/hypixel

Deno

As Deno does not require installation, you would simply follow their convention for imports.

import { Client as HypixelClient } from "https://deno.land/x/hypixel/v3.1.0/mod.ts";

Usage

const { Client } = require("@zikeji/hypixel");
const client = new Client("API_KEY");
(async () => {
  const status = await client.status.uuid("20934ef9488c465180a78f861586b4cf"); // Minikloon
  console.log(status);
  // {"online": false}
  const stats = await client.watchdogstats();
  console.log(stats);
  // {watchdog_lastMinute: 1, staff_rollingDaily: 2609, watchdog_total: 5591714, watchdog_rollingDaily: 4213, …}
})();

Helpers

This library adds multiple helpers to facilitate using the Hypixel API. You can find documentation on each helper here. If you would like to request a helper that doesn't exist, please open an issue. Otherwise if you would like to contribute one refer to the below section.

Contributing

If some API result isn't documented / typed out fully, please open an issue and I can see about adding it. However some data is too exhaustive to provide typings to in a reasonable manner, as exhibited here, where it isn't reasonable to add 19.5 thousand lines of code to document the entire dataset.

Otherwise, pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. All changes must ensure they pass eslint, tests, and that testing is updated to meet or exceed the previous coverage.

Licenses

This projected is licensed under the MIT license. For additional details see LICENSE.

This library contains derivative work based on classes from the hypixel-php library. Code that is derivative work of hypixel-php will be marked as such with a header comment. See LICENSE-HYPIXEL-PHP.md for additional details on the original license.

Changelog

4.0.0 (2024-09-11)

⚠ BREAKING CHANGES

• prepare 4.0.0 release

Features

• enhance collections typing (c038ee1), closes #437
• prepare 4.0.0 release (52d620c)
• refactor for v2 endpoints and swagger typing (378eb4d)
• update exports (c4a35a6), closes #437

Bug Fixes

• broken types (2917d0e), closes #437
• guild level helper typing (40e61fa), closes #437
• lint (4e50686), closes #437
• player helpers (f436bfa), closes #437
• resolve proper skills (60d0e6c), closes #437
• romanize (2740917), closes #437
• sky wars helper (952f6ba), closes #437
• skyblock item data transform (6939a4d), closes #437
• skyblock skills helper (1990a2e), closes #437
• typings and path on collections helper (74d095a), closes #437
• typo in skills endpoint (ef99d0b), closes #437
• URL constructor resulting in v1 endpoitns getting called (0bd3ecb), closes #437

Code Refactoring

• augment naming to fit nature (bb7f9d6), closes #437

Documentation

• update documentation generation (d2e4b8a)

Tests

• begin to fix tests (c2fe76b), closes #437
• omit client test (for now) (1875da7), closes #437
• resolve test failures (4b10d8d)
• update cache test, add test client mocking from data directory (9839f1b), closes #437
• update errors test (8c0608d), closes #437
• update helpers test (c6a4e1a)

3.1.1 (2021-03-30)

Bug Fixes

• add bigint check (8988723)

Miscellaneous Chores

• deps: update dependencies (5400617)
• deps docs: bump typedoc plugin (1f65240)
• deps docs: update documentation deps and update styles to fix issues (34988f2)
• docs: update CI action (f737eda)