# voxyl-api

> A Voxyl API Client for Node

Latest version **1.2.0** (published 2022-04-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install voxyl-api
pnpm add voxyl-api
yarn add voxyl-api
bun add voxyl-api
```

## 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.2.0 |
| Published | 2022-04-27 |
| First published | 2022-01-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | ObamaFootFungus |
| Maintainers | obamafootfungus |
| Keywords | voxyl, voxyl-api, api-client, client, api, minecraft |

## Links

- npm: https://www.npmjs.com/package/voxyl-api
- Repository: https://github.com/ObamaFootFungus/voxyl-api
- Homepage: https://github.com/ObamaFootFungus/voxyl-api#readme
- Issues: https://github.com/ObamaFootFungus/voxyl-api/issues
- npm.io page: https://npm.io/package/voxyl-api

## Dependencies (1)

- [centra](https://npm.io/package/centra.md) ^2.0.2

## 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.2.0 (latest) — 2022-04-27
- 1.1.0 — 2022-04-27
- 1.0.7 — 2022-01-20
- 1.0.6 — 2022-01-20
- 1.0.5 — 2022-01-20
- 1.0.4 — 2022-01-20
- 1.0.3 — 2022-01-15
- 1.0.2 — 2022-01-15
- 1.0.1 — 2022-01-15
- 1.0.0 — 2022-01-15

## README

## A Voxyl API Client for Node

[GitHub](https://github.com/ObamaFootFungus/voxyl-api) | [NPM](https://www.npmjs.com/package/voxyl-api)

## Installation

```shell
npm install --save voxyl-api
```

## Usage

### Getting player information

```javascript
const VoxylAPI = require('voxyl-api')

const client = new VoxylAPI('API-key')

client.getPlayerInfo('name', 'ObamaFootFungus').then((player) => {
	console.log(player)
}).catch((err) => {
	console.error('Error: ' + err)
})
```

### Getting overall player stats

```javascript
client.getPlayerOverallStats('name', 'ObamaFootFungus').then((player) => {
	console.log(player)
}).catch((err) => {
	console.error('Error: ' + err)
})
```

### Getting player game stats

```javascript
client.getPlayerGameStats('name', 'ObamaFootFungus').then((player) => {
	console.log(player)
}).catch((err) => {
	console.error('Error: ' + err)
})
```

### Getting info about a guild

```javascript
client.getGuildInfo('Guild-Tag').then((guild) => {
	console.log(guild)
}).catch((err) => {
	console.error('Error: ' + err)
})
```

### Getting the members of a guild

```javascript
client.getGuildMembers('Guild-Tag/ID').then((guild) => {
	console.log(guild)
}).catch((err) => {
	console.error('Error: ' + err)
})
```

### Getting the top guilds

```javascript
// number is the amount of guilds
client.getTopGuilds(number).then((guilds) => {
	console.log(guilds)
}).catch((err) => {
	console.error('Error: ' + err)
})
```

### Getting announcements

```javascript
client.getAnnouncements().then((announcements) => {
	console.log(announcements)
}).catch((err) => {
	console.error('Error: ' + err)
})
```

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