@calebtan/hypixel-api-v2
TypeScript icon, indicating that this package has built-in type declarations

1.2.25 • Public • Published

hypixel-api-v2

npm functions branches lines statements

Features

  • TypeScript support.
  • Support for multiple API keys at once.
  • Automatic ratelimiting.
  • Configurable cache.
  • Full coverage of the Hypixel API.

Installation

First, install nodejs >= 14 from nodejs.org, then:

npm install hypixel-api-v2

Getting Started

"Hello world" example:

// ES6 import syntax
import { HypixelAPI } from 'hypixel-api-v2';

// CommonJS
// const { HypixelAPI } = require('hypixel-api-v2');

const hypixel = new HypixelAPI('your-key-here'); // or ['first-key-here', 'second-key-here', ...]

(async () => {
	const player = await hypixel.player('hypixel');

	console.log(`${player.displayname} has ${player.networkExp} experience.`);
})();

Documentation

View the documentation here.

Dependencies (3)

Dev Dependencies (6)

Package Sidebar

Install

npm i @calebtan/hypixel-api-v2

Weekly Downloads

0

Version

1.2.25

License

ISC

Unpacked Size

184 kB

Total Files

16

Last publish

Collaborators

  • calebtan