# spiget-api

> A client for Spiget that allows you to get the authors, resources and categories from spigotmc.org

Latest version **1.0.3** (published 2022-09-28) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-09-28 |
| First published | 2022-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 737.6 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | VeguiDev |
| Maintainers | veguidev |
| Keywords | spigot, spiget, api, client, cli, minecraft, download, plugins, resources, authors |

## Links

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

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [stream](https://npm.io/package/stream.md) ^0.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.0.3 (latest) — 2022-09-28
- 1.0.2 — 2022-09-28
- 1.0.1 — 2022-09-16
- 1.0.0 — 2022-09-12
- 0.0.1-pre2 — 2022-09-06
- 0.0.1-pre1 — 2022-09-06

## README

![SPIGET Logo](https://spiget.org/img/logo-plain-x64.png)

# Spiget API Client (Spigot API)
![NPM VERSION](https://img.shields.io/npm/v/spiget-api?style=flat)
![DOWNLOADS](https://img.shields.io/npm/dm/spiget-api.svg?style=flat)
![LICENSE](https://img.shields.io/npm/l/spiget-api)
![BUILD](https://img.shields.io/github/workflow/status/VeguiDev/spiget-api/Node.js%20CI)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/3476d11695cf45b38da2c7f556205df3)](https://www.codacy.com/gh/VeguiDev/spiget-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=VeguiDev/spiget-api&utm_campaign=Badge_Grade)
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/3476d11695cf45b38da2c7f556205df3)](https://www.codacy.com/gh/VeguiDev/spiget-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=VeguiDev/spiget-api&utm_campaign=Badge_Coverage)

This library allows you to interact with the Spigot API (Spiget), to obtain authors, categories and resources (Plugins).

**Table of Contents:**

- [Documentation](https://github.com/VeguiDev/spiget-api/wiki)
- [Contributing](#contributing)

## Quickstart

Installing the client librery...

```bash
npm install spiget-api
```

Import the library...

```js
import SpigetAPI from 'spiget-api';
// or
const SpigetAPI = require('spiget-api');

// Instance this

const api = new SpigetAPI("agent_name");
```

Or if you using in the browser

```html
<script src="https://unpkg.org/spiget-api@latest/dist/spiget-api.umd.min.js"></script>

<script>
    let api = new spigetapi("agent_name"); // To instance
</script>
```

Get array of resources...

```js
let resources = await api.getResources();
```
## Contributing

To contribute this is the [repository](https://github.com/VeguiDev/spiget-api) of this package.

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