{"id":13454899,"url":"https://github.com/discordjs/discord-api-types","last_synced_at":"2026-04-02T17:07:12.235Z","repository":{"id":36993532,"uuid":"284494631","full_name":"discordjs/discord-api-types","owner":"discordjs","description":"Up to date Discord API Typings, versioned by the API version","archived":false,"fork":false,"pushed_at":"2026-03-30T23:29:35.000Z","size":70450,"stargazers_count":612,"open_issues_count":26,"forks_count":138,"subscribers_count":9,"default_branch":"main","last_synced_at":"2026-03-31T01:36:12.788Z","etag":null,"topics":["deno","discord","discord-api","discord-bot","discordjs","gateway","hacktoberfest","rest","typescript","typings"],"latest_commit_sha":null,"homepage":"https://discord-api-types.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/discordjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"discordjs","open_collective":"discordjs"}},"created_at":"2020-08-02T16:02:18.000Z","updated_at":"2026-03-30T23:29:38.000Z","dependencies_parsed_at":"2023-01-17T12:45:13.346Z","dependency_job_id":"2257ade7-51e8-4847-8990-6a70916fdcaa","html_url":"https://github.com/discordjs/discord-api-types","commit_stats":{"total_commits":947,"total_committers":80,"mean_commits":11.8375,"dds":0.8627243928194298,"last_synced_commit":"76b393a7e4970f97308d8e8b6df8263d6379f142"},"previous_names":[],"tags_count":228,"template":false,"template_full_name":null,"purl":"pkg:github/discordjs/discord-api-types","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/discordjs%2Fdiscord-api-types","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/discordjs%2Fdiscord-api-types/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/discordjs%2Fdiscord-api-types/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/discordjs%2Fdiscord-api-types/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/discordjs","download_url":"https://codeload.github.com/discordjs/discord-api-types/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/discordjs%2Fdiscord-api-types/sbom","scorecard":{"id":344606,"data":{"date":"2025-08-11","repo":{"name":"github.com/discordjs/discord-api-types","commit":"2a7c1d271f318d483360807ddfa7d961c97f527b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.6,"checks":[{"name":"Code-Review","score":3,"reason":"Found 9/23 approved changesets -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'contents' permission set to 'write': .github/workflows/create-pr-for-release-and-publish.yml:70","Info: jobLevel 'contents' permission set to 'read': .github/workflows/pr-automation.yml:9","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/validate-pull-request.yml:9","Warn: no topLevel permission defined: .github/workflows/cicd.yml:1","Warn: no topLevel permission defined: .github/workflows/create-pr-for-release-and-publish.yml:1","Warn: no topLevel permission defined: .github/workflows/documentation.yml:1","Warn: no topLevel permission defined: .github/workflows/labelsync.yml:1","Warn: no topLevel permission defined: .github/workflows/pr-automation.yml:1","Warn: no topLevel permission defined: .github/workflows/publish-next.yml:1","Warn: no topLevel permission defined: .github/workflows/validate-pull-request.yml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":1,"reason":"dependency not pinned by hash detected -- score normalized to 1","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cicd.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/cicd.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cicd.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/cicd.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-pr-for-release-and-publish.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/create-pr-for-release-and-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-pr-for-release-and-publish.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/create-pr-for-release-and-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-pr-for-release-and-publish.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/create-pr-for-release-and-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-pr-for-release-and-publish.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/create-pr-for-release-and-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/documentation.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/documentation.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/documentation.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/documentation.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/documentation.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/documentation.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/documentation.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/documentation.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/documentation.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/documentation.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/documentation.yml:88: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/documentation.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/labelsync.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/labelsync.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/labelsync.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/labelsync.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-automation.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/pr-automation.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-next.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/publish-next.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-next.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/publish-next.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-pull-request.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/validate-pull-request.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-pull-request.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/discordjs/discord-api-types/validate-pull-request.yml/main?enable=pin","Info:   0 out of  16 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   3 third-party GitHubAction dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 28 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":4,"reason":"6 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-8266-84wp-wv5c","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v","Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T06:45:11.063Z","repository_id":36993532,"created_at":"2025-08-18T06:45:11.063Z","updated_at":"2025-08-18T06:45:11.063Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31311159,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deno","discord","discord-api","discord-bot","discordjs","gateway","hacktoberfest","rest","typescript","typings"],"created_at":"2024-07-31T08:00:59.129Z","updated_at":"2026-04-02T17:07:12.213Z","avatar_url":"https://github.com/discordjs.png","language":"TypeScript","funding_links":["https://github.com/sponsors/discordjs","https://opencollective.com/discordjs","https://www.patreon.com/vladfrangu","https://ko-fi.com/wolfgalvlad","https://github.com/sponsors/vladfrangu"],"categories":["TypeScript"],"sub_categories":[],"readme":"# Discord API Types\n\n[![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)\n\n[![GitHub](https://img.shields.io/github/license/discordjs/discord-api-types)](https://github.com/discordjs/discord-api-types/blob/main/LICENSE.md)\n[![npm](https://img.shields.io/npm/v/discord-api-types?color=crimson\u0026logo=npm)](https://www.npmjs.com/package/discord-api-types)\n[![deno](https://img.shields.io/npm/v/discord-api-types?color=blue\u0026label=deno\u0026logo=deno)](https://deno.land/x/discord_api_types)\n[![Patreon Donate](https://img.shields.io/badge/patreon-donate-brightgreen.svg?label=Donate%20with%20Patreon\u0026logo=patreon\u0026colorB=F96854\u0026link=https://www.patreon.com/vladfrangu)](https://www.patreon.com/vladfrangu)\n[![Ko-fi Donate](https://img.shields.io/badge/kofi-donate-brightgreen.svg?label=Donate%20with%20Ko-fi\u0026logo=ko-fi\u0026colorB=F16061\u0026link=https://ko-fi.com/wolfgalvlad\u0026logoColor=FFFFFF)](https://ko-fi.com/wolfgalvlad)\n[![GitHub Sponsors](https://img.shields.io/badge/patreon-donate-brightgreen.svg?label=Sponsor%20through%20GitHub\u0026logo=github\u0026colorB=F96854\u0026link=https://github.com/sponsors/vladfrangu)](https://github.com/sponsors/vladfrangu)\n[![Powered by Vercel](https://raw.githubusercontent.com/discordjs/discord-api-types/main/website/static/powered-by-vercel.svg)](https://vercel.com?utm_source=discordjs\u0026utm_campaign=oss)\n\nSimple type definitions for the [Discord API](https://discord.com/developers/docs/intro).\n\n## Installation\n\nInstall with [npm](https://www.npmjs.com/) / [yarn](https://yarnpkg.com) / [pnpm](https://pnpm.js.org/):\n\n```sh\nnpm install discord-api-types\nyarn add discord-api-types\npnpm add discord-api-types\n```\n\n### Usage\n\nYou 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\n\n```js\nconst { APIUser } = require('discord-api-types/v10');\n```\n\n```ts\n// TypeScript/ES Module support\nimport { APIUser } from 'discord-api-types/v10';\n```\n\nYou 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\n\n```js\nconst { GatewayVersion } = require('discord-api-types/gateway/v10');\n```\n\n```ts\n// TypeScript/ES Module support\nimport { GatewayVersion } from 'discord-api-types/gateway/v10';\n```\n\n\u003e _**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_\n\n### Deno\n\nWe also provide typings compatible with the [deno](https://deno.land/) runtime. You have 3 ways you can import them:\n\n1. Directly from GitHub\n\n```ts\n// Importing a specific API version\nimport { APIUser } from 'https://raw.githubusercontent.com/discordjs/discord-api-types/main/deno/v10.ts';\n```\n\n2. From [deno.land/x](https://deno.land/x)\n\n```ts\n// Importing a specific API version\nimport { APIUser } from 'https://deno.land/x/discord_api_types/v10.ts';\n```\n\n3. From [skypack.dev](https://www.skypack.dev/)\n\n```ts\n// Importing a specific API version\nimport { APIUser } from 'https://cdn.skypack.dev/discord-api-types/v10?dts';\n```\n\n## Project Structure\n\nThe exports of each API version is split into three main parts:\n\n- Everything exported with the `API` prefix represents a payload you may get from the REST API _or_ the Gateway.\n\n- Everything exported with the `Gateway` prefix represents data that ONLY comes from or is directly related to the Gateway.\n\n- Everything exported with the `REST` prefix represents data that ONLY comes from or is directly related to the REST API.\n    - For endpoint options, they will follow the following structure: `REST\u003cHTTP Method\u003e\u003cType\u003e\u003cQuery|(JSON|FormData)Body|Result\u003e` where the type represents what it will return.\n        - For example, `RESTPostAPIChannelMessageJSONBody` or `RESTGetAPIGatewayBotInfoResult`.\n\n        - 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 `REST\u003cHTTP Method\u003eOAuth2`\n\n    - If a type ends with `Result`, then it represents the expected result by calling its accompanying route.\n        - Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore it. This does **not** account for errors.\n\n- Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object).\n\n- 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.\n\n**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),\nthat are mentioned in an open pull request, or known through other means _and have received the green light to be used_.\nAnything else will not be documented (for example client only types).\n\nWith 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.\nThey will be documented with an `@unstable` tag and are not subject with the same versioning rules.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiscordjs%2Fdiscord-api-types","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdiscordjs%2Fdiscord-api-types","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiscordjs%2Fdiscord-api-types/lists"}