# hypixie

> A simplified interface for the Hypixel api.

Latest version **1.0.0** (published 2020-04-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install hypixie
pnpm add hypixie
yarn add hypixie
bun add hypixie
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-04-07 |
| First published | 2020-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 3 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Richie Bendall |
| Maintainers | richienb |
| Keywords | hypixel, api, wrapper, request, layer, simple, interface |

## Links

- npm: https://www.npmjs.com/package/hypixie
- Repository: https://github.com/Richienb/hypixie
- npm.io page: https://npm.io/package/hypixie

## Dependencies (3)

- [ky](https://npm.io/package/ky.md) ^0.19.0
- [is-uuid](https://npm.io/package/is-uuid.md) ^1.0.2
- [ky-universal](https://npm.io/package/ky-universal.md) ^0.5.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-04-07

## README

# hypixie [![Travis CI Build Status](https://img.shields.io/travis/com/Richienb/hypixie/master.svg?style=for-the-badge)](https://travis-ci.com/Richienb/hypixie)

A simplified interface for the Hypixel api.

[![NPM Badge](https://nodei.co/npm/hypixie.png)](https://npmjs.com/package/hypixie)

## Install

```sh
npm install hypixie
```

## Usage

```js
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](https://github.com/HypixelDev/PublicAPI/tree/master/Documentation/methods) 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.

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