npm.io
1.0.0 • Published 6 years ago

hypixie

Licence
MIT
Version
1.0.0
Deps
3
Size
4 kB
Vulns
0
Weekly
0
Stars
1

hypixie Travis CI Build Status

A simplified interface for the Hypixel api.

NPM Badge

Install

npm install hypixie

Usage

const hypixie = require("hypixie");

(async () => {
	const { displayname } = await hypixie("player", {
		uuid: "56da43a4-088d-4a76-82b6-dd431535015e",
		key: "some api key"
	});

	console.log(displayname);
	//=> "Richienb"
})();

API

hypixie(endpoint, options)
endpoint

Type: string

The API endpoint to call.

options

Type: object

The options to pass to the API.

hypixie.HypixelError

Exposed for instanceof checks. This type of error is thrown when the API returns an error.

Keywords