# discord-api-types > Discord API typings that are kept up to date for use in bot library creation. Latest version **0.38.55** (published 2026-09-02) · MIT license · 0 weekly downloads ## Install ```sh npm install discord-api-types pnpm add discord-api-types yarn add discord-api-types bun add discord-api-types ``` ## Health **Score 65/100 (B)** — status: active. Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score. Warnings: low downloads; no types; pre 1.0. ## Facts | | | |---|---| | Version | 0.38.55 | | Published | 2026-09-02 | | First published | 2020-08-22 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM + CommonJS | | Dependencies | 0 | | Unpacked size | 3.2 MB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 619 | | Author | Vlad Frangu | | Maintainers | crawl, spaceeec, vladfrangu | | Keywords | discord, discord api, types, discordjs | ## Links - npm: https://www.npmjs.com/package/discord-api-types - Repository: https://github.com/discordjs/discord-api-types - Homepage: https://discord-api-types.dev - npm.io page: https://npm.io/package/discord-api-types ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads ## Recent versions - 0.38.55 (latest) — 2026-09-02 - 0.38.56-next.39127376.1789897814 (next) — 2026-09-20 - 0.38.0-next-1740095508888 (pr-1190) — 2025-02-20 - 0.38.56-next.be102d70.1789897608 — 2026-09-20 - 0.38.56-next.c103619d.1789897302 — 2026-09-20 - 0.38.56-next.8ad8cfd5.1789897193 — 2026-09-20 - 0.38.56-next.bde79141.1789746014 — 2026-09-18 - 0.38.56-next.1c5f68d5.1789709068 — 2026-09-18 - 0.38.56-next.7484c1de.1789242023 — 2026-09-12 - 0.38.56-next.8621013d.1789152632 — 2026-09-11 - 0.38.56-next.86b21fb7.1789105092 — 2026-09-11 - 0.38.56-next.50752c0c.1788769051 — 2026-09-07 - 0.38.56-next.dbde4eed.1788514564 — 2026-09-04 - 0.38.56-next.3a58ce85.1788496601 — 2026-09-04 - 0.38.56-next.0e83e982.1788424158 — 2026-09-03 - … 1300 more at https://npm.io/package/discord-api-types/versions ## README # Discord API Types [![discord-api-types](https://raw.githubusercontent.com/discordjs/discord-api-types/main/website/static/svgs/logo_long_blurple.svg)](https://github.com/discordjs/discord-api-types) [![GitHub](https://img.shields.io/github/license/discordjs/discord-api-types)](https://github.com/discordjs/discord-api-types/blob/main/LICENSE.md) [![npm](https://img.shields.io/npm/v/discord-api-types?color=crimson&logo=npm)](https://www.npmjs.com/package/discord-api-types) [![deno](https://img.shields.io/npm/v/discord-api-types?color=blue&label=deno&logo=deno)](https://deno.land/x/discord_api_types) [![Patreon Donate](https://img.shields.io/badge/patreon-donate-brightgreen.svg?label=Donate%20with%20Patreon&logo=patreon&colorB=F96854&link=https://www.patreon.com/vladfrangu)](https://www.patreon.com/vladfrangu) [![Ko-fi Donate](https://img.shields.io/badge/kofi-donate-brightgreen.svg?label=Donate%20with%20Ko-fi&logo=ko-fi&colorB=F16061&link=https://ko-fi.com/wolfgalvlad&logoColor=FFFFFF)](https://ko-fi.com/wolfgalvlad) [![GitHub Sponsors](https://img.shields.io/badge/patreon-donate-brightgreen.svg?label=Sponsor%20through%20GitHub&logo=github&colorB=F96854&link=https://github.com/sponsors/vladfrangu)](https://github.com/sponsors/vladfrangu) [![Powered by Vercel](https://raw.githubusercontent.com/discordjs/discord-api-types/main/website/static/powered-by-vercel.svg)](https://vercel.com?utm_source=discordjs&utm_campaign=oss) Simple type definitions for the [Discord API](https://discord.com/developers/docs/intro). ## Installation Install with [npm](https://www.npmjs.com/) / [pnpm](https://pnpm.io/) / [yarn](https://yarnpkg.com) / [bun](https://bun.sh): ```sh npm install discord-api-types pnpm add discord-api-types yarn add discord-api-types bun add discord-api-types ``` ### Usage You can only import this module by specifying the API version you want to target. Append `/v*` to the import path, where the `*` represents the API version. Below are some examples ```js const { APIUser } = require('discord-api-types/v10'); ``` ```ts // TypeScript/ES Module support import { APIUser } from 'discord-api-types/v10'; ``` You may also import just certain parts of the module that you need. The possible values are: `globals`, `gateway`, `gateway/v*`, `payloads`, `payloads/v*`, `rest`, `rest/v*`, `rpc`, `rpc/v*`, `utils`, `utils/v*`, `voice`, and `voice/v*`. Below are some examples ```js const { GatewayVersion } = require('discord-api-types/gateway/v10'); ``` ```ts // TypeScript/ES Module support import { GatewayVersion } from 'discord-api-types/gateway/v10'; ``` > _**Note:** The `v*` exports (`discord-api-types/v*`) include the appropriate version of `gateway`, `payloads`, `rest`, `rpc`, and `utils` you specified, alongside the `globals` exports_ ### Deno We also provide typings compatible with the [deno](https://deno.land/) runtime. You have 3 ways you can import them: 1. Directly from GitHub ```ts // Importing a specific API version import { APIUser } from 'https://raw.githubusercontent.com/discordjs/discord-api-types/main/deno/v10.ts'; ``` 2. From [deno.land/x](https://deno.land/x) ```ts // Importing a specific API version import { APIUser } from 'https://deno.land/x/discord_api_types/v10.ts'; ``` 3. From [skypack.dev](https://www.skypack.dev/) ```ts // Importing a specific API version import { APIUser } from 'https://cdn.skypack.dev/discord-api-types/v10?dts'; ``` ## Project Structure The exports of each API version is split into three main parts: - Everything exported with the `API` prefix represents a payload you may get from the REST API _or_ the Gateway. - Everything exported with the `Gateway` prefix represents data that ONLY comes from or is directly related to the Gateway. - Everything exported with the `REST` prefix represents data that ONLY comes from or is directly related to the REST API. - For endpoint options, they will follow the following structure: `REST` where the type represents what it will return. - For example, `RESTPostAPIChannelMessageJSONBody` or `RESTGetAPIGatewayBotInfoResult`. - Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of the fields. They will start with either `RESTOAuth2` or with something similar to `RESTOAuth2` - If a type ends with `Result`, then it represents the expected result by calling its accompanying route. - Types for a Result that will be a `204 No Content` will be typed as `undefined`. This does **not** account for errors - Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object). - There may be types exported that are identical for all versions. These will be exported as is and can be found in the `globals` file. They will still be prefixed accordingly as described above. **A note about how types are documented**: This package will add types only for known and documented properties that are present in Discord's [API Documentation repository](https://github.com/discord/discord-api-docs), that are mentioned in an open pull request, or known through other means _and have received the green light to be used_. Anything else will not be documented (for example client only types). With that aside, we may allow certain types that are not documented in the [API Documentation repository](https://github.com/discord/discord-api-docs) on a case by case basis. They will be documented with an `@unstable` tag and are not subject with the same versioning rules. --- _Source: https://npm.io/package/discord-api-types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._