# stoat-api

> Stoat API Library

Latest version **0.16.0** (published 2026-10-14) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.16.0 |
| Published | 2026-10-14 |
| First published | 2025-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 42 |
| Author | Paul Makles <insrt.uk> |
| Maintainers | stoatified |

## Links

- npm: https://www.npmjs.com/package/stoat-api
- Repository: https://github.com/stoatchat/javascript-client-api
- Homepage: https://developers.stoat.chat
- npm.io page: https://npm.io/package/stoat-api

## Dependencies (1)

- [json-with-bigint](https://npm.io/package/json-with-bigint.md) ^3.4.4

## Recent versions

- 0.16.0 (latest) — 2026-10-14
- 0.16.0-rc.0 — 2026-10-13
- 0.15.5 — 2026-09-12
- 0.15.4 — 2026-09-01
- 0.15.3 — 2026-08-27
- 0.15.2 — 2026-08-24
- 0.15.1 — 2026-08-09
- 0.14.3 — 2026-07-22
- 0.14.2 — 2026-07-18
- 0.14.1 — 2026-07-18
- 0.14.0 — 2026-07-15
- 0.13.7 — 2026-05-21
- 0.13.6 — 2026-05-18
- 0.13.5 — 2026-05-17
- 0.12.0 — 2026-04-06
- … 3 more at https://npm.io/package/stoat-api/versions

## README

# Revolt API

![revolt-api](https://img.shields.io/npm/v/revolt-api)

This package contains typings for objects in the [Revolt API](https://developers.revolt.chat/api/) and a fully typed API request builder.

### Example Usage

If you just need access to types:

```typescript
import type { User } from 'revolt-api';
```

If you want to send requests:

```typescript
import { API } from 'revolt-api';

// Initialise a new API client:
const client = new API();

// or with authentication:
const client = new API({ authentication: { revolt: 'bot-token' } });

// Make requests with ease:
client.get('/users/@me')
    // Fully typed responses!
    .then(user => user.username);

// No need to worry about the details:
let channel_id = "some channel id";
client.post(`/channels/${channel_id}/messages`, {
    // Parameters given are fully typed as well!
    content: "some content"
});
```

For more details on how this works, see the [README of @insertish/oapi](https://github.com/insertish/oapi#example).

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