# @discordjs/rest

> The REST API for discord.js

Latest version **2.6.3** (published 2026-07-19) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @discordjs/rest
pnpm add @discordjs/rest
yarn add @discordjs/rest
bun add @discordjs/rest
```

## Health

**Score 80/100 (A)** — status: active.

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.6.3 |
| Published | 2026-07-19 |
| First published | 2021-06-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 9 |
| Unpacked size | 788.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 26822 |
| Maintainers | crawl, hydrabolt |
| Keywords | discord, api, rest, discordapp, discordjs |

## Links

- npm: https://www.npmjs.com/package/@discordjs/rest
- Repository: https://github.com/discordjs/discord.js
- Homepage: https://discord.js.org
- Issues: https://github.com/discordjs/discord.js/issues
- Funding: https://github.com/discordjs/discord.js?sponsor
- npm.io page: https://npm.io/package/@discordjs/rest

## Dependencies (9)

- [tslib](https://npm.io/package/tslib.md) ^2.6.3
- [undici](https://npm.io/package/undici.md) ^6.27.0
- [magic-bytes.js](https://npm.io/package/magic-bytes.js.md) ^1.13.0
- [@discordjs/util](https://npm.io/package/@discordjs/util.md) ^1.2.0
- [discord-api-types](https://npm.io/package/discord-api-types.md) ^0.38.50
- [@sapphire/snowflake](https://npm.io/package/@sapphire/snowflake.md) ^3.5.5
- [@discordjs/collection](https://npm.io/package/@discordjs/collection.md) ^2.1.1
- [@sapphire/async-queue](https://npm.io/package/@sapphire/async-queue.md) ^1.5.3
- [@vladfrangu/async_event_emitter](https://npm.io/package/@vladfrangu/async_event_emitter.md) ^2.4.6

## 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

- 2.6.3 (latest) — 2026-07-19
- 3.0.0-dev.1789257813-c626815bf (dev) — 2026-09-13
- 3.0.0-pr-11602.1789066132-275cd4b42 (pr-11602) — 2026-09-10
- 3.0.0-dev.1788912206-a4116036b — 2026-09-09
- 3.0.0-dev.1788696123-5f6cbf111 — 2026-09-06
- 3.0.0-dev.1788566584-096177189 — 2026-09-05
- 3.0.0-dev.1788538586-ecea9ed57 — 2026-09-04
- 3.0.0-dev.1788537163-f3a574779 — 2026-09-04
- 3.0.0-dev.1786968995-99af6d8be — 2026-08-17
- 3.0.0-dev.1786752260-c9855614c — 2026-08-15
- 3.0.0-dev.1786666336-905445ec9 — 2026-08-14
- 3.0.0-dev.1786233958-b1a77045f — 2026-08-09
- 3.0.0-dev.1785370677-4b3f1c166 — 2026-07-30
- 3.0.0-dev.1784593104-219ad7ba0 — 2026-07-21
- 3.0.0-dev.1784551164-2de90a767 — 2026-07-20
- … 1509 more at https://npm.io/package/@discordjs/rest/versions

## README

<div align="center">
	<br />
	<p>
		<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
	</p>
	<br />
	<p>
		<a href="https://discord.gg/djs"><img src="https://img.shields.io/badge/join_us-on_discord-5865F2?logo=discord&logoColor=white" alt="Discord server" /></a>
		<a href="https://www.npmjs.com/package/@discordjs/rest"><img src="https://img.shields.io/npm/v/@discordjs/rest.svg?maxAge=3600" alt="npm version" /></a>
		<a href="https://www.npmjs.com/package/@discordjs/rest"><img src="https://img.shields.io/npm/dt/@discordjs/rest.svg?maxAge=3600" alt="npm downloads" /></a>
		<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Tests status" /></a>
		<a href="https://github.com/discordjs/discord.js/commits/main/packages/rest"><img alt="Last commit." src="https://img.shields.io/github/last-commit/discordjs/discord.js?logo=github&logoColor=ffffff&path=packages%2Frest" /></a>
		<a href="https://opencollective.com/discordjs"><img src="https://img.shields.io/opencollective/backers/discordjs?maxAge=3600&logo=opencollective" alt="backers" /></a>
		<a href="https://codecov.io/gh/discordjs/discord.js"><img src="https://codecov.io/gh/discordjs/discord.js/branch/main/graph/badge.svg?precision=2&flag=rest" alt="Code coverage" /></a>
	</p>
	<p>
		<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
		<a href="https://www.cloudflare.com"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-workers.png" alt="Cloudflare Workers" height="44" /></a>
	</p>
</div>

## About

`@discordjs/rest` is a module that allows you to easily make REST requests to the Discord API.

## Installation

**Node.js 18 or newer is required.**

```sh
npm install @discordjs/rest
yarn add @discordjs/rest
pnpm add @discordjs/rest
bun add @discordjs/rest
```

## Examples

Install all required dependencies:

```sh
npm install @discordjs/rest discord-api-types
yarn add @discordjs/rest discord-api-types
pnpm add @discordjs/rest discord-api-types
bun add @discordjs/rest discord-api-types
```

Send a basic message:

```js
import { REST } from '@discordjs/rest';
import { Routes } from 'discord-api-types/v10';

const rest = new REST({ version: '10' }).setToken(TOKEN);

try {
	await rest.post(Routes.channelMessages(CHANNEL_ID), {
		body: {
			content: 'A message via REST!',
		},
	});
} catch (error) {
	console.error(error);
}
```

Create a thread from an existing message to be archived after 60 minutes of inactivity:

```js
import { REST } from '@discordjs/rest';
import { Routes } from 'discord-api-types/v10';

const rest = new REST({ version: '10' }).setToken(TOKEN);

try {
	await rest.post(Routes.threads(CHANNEL_ID, MESSAGE_ID), {
		body: {
			name: 'Thread',
			auto_archive_duration: 60,
		},
	});
} catch (error) {
	console.error(error);
}
```

Send a basic message in an edge environment:

```js
import { REST } from '@discordjs/rest';
import { Routes } from 'discord-api-types/v10';

const rest = new REST({ version: '10', makeRequest: fetch }).setToken(TOKEN);

try {
	await rest.post(Routes.channelMessages(CHANNEL_ID), {
		body: {
			content: 'A message via REST from the edge!',
		},
	});
} catch (error) {
	console.error(error);
}
```

## Links

- [Website][website] ([source][website-source])
- [Documentation][documentation]
- [Guide][guide] ([source][guide-source])
  Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord]
- [Discord Developers Discord server][discord-developers]
- [GitHub][source]
- [npm][npm]
- [Related libraries][related-libs]

## Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation][documentation].  
See [the contribution guide][contributing] if you'd like to submit a PR.

## Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].

[website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/docs/packages/rest/stable
[guide]: https://discordjs.guide
[guide-source]: https://github.com/discordjs/discord.js/tree/main/apps/guide
[guide-update]: https://discordjs.guide/legacy/additional-info/changes-in-v14
[discord]: https://discord.gg/djs
[discord-developers]: https://discord.gg/discord-developers
[source]: https://github.com/discordjs/discord.js/tree/main/packages/rest
[npm]: https://www.npmjs.com/package/@discordjs/rest
[related-libs]: https://docs.discord.com/developers/developer-tools/community-resources#libraries
[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md

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