API ReferenceDiscord's API is based around two core layers, a HTTPS/REST API for general operations, and persistent secure websocket based connection for sending and subscribing to real-time events. The most common use case of the Discord API will be providing a service, or access to a platform through the OAuth2 API.
Base URLThe base URL for all API requests is:
Discord exposes different versions of our API. You can specify version by including it in the request path:
API and Gateway versions below v6 will be discontinued on October 16, 2017, after which they will be non-functioning.
Omitting the version number from the route will route requests to the current default version. You can find the change log for the newest API version here.
API and Gateway v6 will be made default on October 16, 2017
AuthenticationAuthenticating with the Discord API can be done in one of two ways:
For all authentication types, authentication is performed with the
- Using a bot token gained by registering a bot, for more information on bots see bots vs user accounts.
- Using an OAuth2 bearer token gained through the OAuth2 API.
Authorization HTTP header in the following format:
For bot tokens:
Authorization: TOKEN_TYPE TOKEN
For OAuth bearer tokens:
Authorization: Bot MTk4NjIyNDgzNDcxOTI1MjQ4.Cl2FMQ.ZnCjm1XVW7vRze4b7Cq4se7kKWs
Authorization: Bearer CZhtkLDpNYXgPH9Ml6shqh2OwykChw
EncryptionAll HTTP-layer services and protocols (e.g. http, websocket) within the Discord API use TLS 1.2.
Snowflake IDsDiscord utilizes Twitter's snowflake format for uniquely identifiable descriptors (IDs). These IDs are guaranteed to be unique across all of Discord, except in some unique scenarios in which child objects share their parent's ID. Because Snowflake IDs are up to 64 bits in size (e.g. a uint64), they are always returned as strings in the HTTP API to prevent integer overflows in some languages. See Gateway ETF/JSON for more information regarding Gateway encoding.
Nullable Resource FieldsResource fields that may be null have types that are prefixed with a question mark.
Optional Resource FieldsResources fields that are optional have names that are suffixed with a question mark.
Example Nullable and Optional Field
ConsistencyDiscord operates at a scale where true consistency is impossible. Because of this, lots of operations in our API and in-between our services are eventually consistent. Due to this, client actions can never be serialized and may be executed in any order (if executed at all). Along with these constraints, events in Discord may:
Clients should operate on events and results from the API in as much of a idempotent behavior as possible.
- Never be sent to a client
- Be sent exactly one time to the client
- Be sent up to N times per client
User AgentClients using the HTTP API must provide a valid User Agent which specifies information about the client library and version, in the following format:
Clients may append more information and metadata to the end of this string as they wish.
User-Agent: DiscordBot ($url, $versionNumber)
Rate LimitingThe HTTP API implements a process for limiting and preventing excessive requests in accordance with RFC 6585. API users that regularly hit and ignore rate limits will have their API keys revoked, and be blocked from the platform. For more information on rate limiting of requests, please see the Rate Limits section.
A bot account must connect and identify to a Gateway at least once before being able to send messages.
Gateway (WebSocket) APIDiscord's Gateway API is used for maintaining persistent, stateful websocket connections between your client and our servers. These connections are used for sending and receiving real-time events your client can use to track and update local state. The Gateway API uses secure websocket connections as specified in RFC 6455. For information on opening Gateway connections, please see the Gateway API section.
Message FormattingDiscord utilizes a subset of markdown for rendering message content on its clients, while also adding some custom functionality to enable things like mentioning users and channels. This functionality uses the following formats:
Using the markdown for either users, roles, or channels will mention the target(s) accordingly.
Image FormattingDiscord uses ids and hashes to render images in the client. These hashes can be retrieved through various API requests, like Get User. Below are the formats, size limitations, and CDN endpoints for images in Discord. The returned format can be changed by changing the extension name at the end of the URL, within the limitations. The returned size can be changed by appending a querystring of
?size=desired_size to the URL, within the limitations.
|GIF||.gif (user avatars only)|
Image SizesPowers of 2 between 16 and 2048.
All image URLs are prefixed with https://cdn.discordapp.com/
CDN Endpoints* In the case of the Default User Avatar endpoint, the value for
user_discriminator in the path should be the user's discriminator modulo 5—Test#1337 would be
1337 % 5, which evaluates to 2.