Interface
Routes
Route builder helpers for REST API. All routes are relative to /v1
Path helpers
| Name | Signature | Description |
|---|---|---|
| applicationsMeread-only | () => '/applications/@me' | |
| channelread-only | (id: Snowflake) => `/channels/${id}` | |
| channelAttachmentsread-only | (id: Snowflake) => `/channels/${id}/attachments` | |
| channelAttachmentsCompleteread-only | (id: Snowflake) => `/channels/${id}/attachments/complete` | |
| channelBulkDeleteread-only | (id: Snowflake) => `/channels/${id}/messages/bulk-delete` | |
| channelBulkDeleteMineread-only | (id: Snowflake) => `/channels/${id}/messages/bulk-delete-mine` | |
| channelInvitesread-only | (id: Snowflake) => `/channels/${id}/invites` | |
| channelMessageread-only | (channelId: Snowflake, messageId: Snowflake) => `/channels/${channelId}/messages/${messageId}` | |
| channelMessageAttachmentread-only | (channelId: Snowflake, messageId: Snowflake, attachmentId: Snowflake) => `/channels/${channelId}/messages/${messageId}/attachments/${attachmentId}` | |
| channelMessageReactionread-only | (channelId: Snowflake, messageId: Snowflake, emoji: string) => `/channels/${channelId}/messages/${messageId}/reactions/${encodeURIComponent(emoji)}` | |
| channelMessageReactionMeread-only | (channelId: Snowflake, messageId: Snowflake, emoji: string) => `/channels/${channelId}/messages/${messageId}/reactions/${encodeURIComponent(emoji)}/@me` | |
| channelMessageReactionsread-only | (channelId: Snowflake, messageId: Snowflake) => `/channels/${channelId}/messages/${messageId}/reactions` | |
| channelMessageReactionUserread-only | (channelId: Snowflake, messageId: Snowflake, emoji: string, userId: Snowflake) => `/channels/${channelId}/messages/${messageId}/reactions/${encodeURIComponent(emoji)}/${userId}` | |
| channelMessageReactionUsersread-only | (channelId: Snowflake, messageId: Snowflake, emoji: string) => `/channels/${channelId}/messages/${messageId}/reactions/${encodeURIComponent(emoji)}/users` | |
| channelMessagesread-only | (id: Snowflake) => `/channels/${id}/messages` | |
| channelMessagesAckread-only | (id: Snowflake) => `/channels/${id}/messages/ack` | |
| channelMessagesPurgeread-only | (id: Snowflake) => `/channels/${id}/messages/purge` | |
| channelPermissionread-only | (channelId: Snowflake, overwriteId: Snowflake) => `/channels/${channelId}/permissions/${overwriteId}` | |
| channelPinMessageread-only | (channelId: Snowflake, messageId: Snowflake) => `/channels/${channelId}/pins/${messageId}` | Pin/unpin: PUT or DELETE /channels/{id}/pins/{messageId}. |
| channelPinsread-only | (id: Snowflake) => `/channels/${id}/messages/pins` | |
| channelPinsAckread-only | (id: Snowflake) => `/channels/${id}/pins/ack` | |
| channelRecipientread-only | (channelId: Snowflake, userId: Snowflake) => `/channels/${channelId}/recipients/${userId}` | |
| channelRtcRegionsread-only | (id: Snowflake) => `/channels/${id}/rtc-regions` | |
| channelSlowmoderead-only | (id: Snowflake) => `/channels/${id}/slowmode` | |
| channelsMessagesBulkread-only | () => `/channels/messages/bulk` | POST /channels/messages/bulk — multi-channel message fetch |
| channelTypingread-only | (id: Snowflake) => `/channels/${id}/typing` | |
| channelWebhooksread-only | (id: Snowflake) => `/channels/${id}/webhooks` | |
| checkUsernameTagread-only | () => '/users/check-tag' | |
| currentUserread-only | () => `/users/@me` | |
| currentUserGuildsread-only | () => `/users/@me/guilds` | |
| emojiMetadataread-only | (emojiId: Snowflake) => `/emojis/${emojiId}/metadata` | |
| gatewayBotread-only | () => `/gateway/bot` | |
| guildread-only | (id: Snowflake) => `/guilds/${id}` | |
| guildAuditLogsread-only | (id: Snowflake) => `/guilds/${id}/audit-logs` | |
| guildBanread-only | (guildId: Snowflake, userId: Snowflake) => `/guilds/${guildId}/bans/${userId}` | |
| guildBansread-only | (id: Snowflake) => `/guilds/${id}/bans` | |
| guildBulkDeleteMineread-only | (guildId: Snowflake) => `/users/@me/guilds/${guildId}/messages/bulk-delete-mine` | |
| guildChannelsread-only | (id: Snowflake) => `/guilds/${id}/channels` | |
| guildDeleteread-only | (guildId: Snowflake) => `/guilds/${guildId}/delete` | |
| guildDiscoveryread-only | (guildId: Snowflake) => `/guilds/${guildId}/discovery` | |
| guildEmojiread-only | (guildId: Snowflake, emojiId: Snowflake) => `/guilds/${guildId}/emojis/${emojiId}` | |
| guildEmojisread-only | (id: Snowflake) => `/guilds/${id}/emojis` | |
| guildEmojisBulkread-only | (guildId: Snowflake) => `/guilds/${guildId}/emojis/bulk` | |
| guildEmojisCloneread-only | (guildId: Snowflake) => `/guilds/${guildId}/emojis/clone` | |
| guildInvitesread-only | (id: Snowflake) => `/guilds/${id}/invites` | |
| guildMemberread-only | (guildId: Snowflake, userId: Snowflake) => `/guilds/${guildId}/members/${userId}` | |
| guildMemberMeread-only | (guildId: Snowflake) => `/guilds/${guildId}/members/@me` | |
| guildMemberRoleread-only | (guildId: Snowflake, userId: Snowflake, roleId: Snowflake) => `/guilds/${guildId}/members/${userId}/roles/${roleId}` | |
| guildMembersread-only | (id: Snowflake) => `/guilds/${id}/members` | |
| guildMembersSearchread-only | (id: Snowflake) => `/guilds/${id}/members-search` | |
| guildRoleread-only | (guildId: Snowflake, roleId: Snowflake) => `/guilds/${guildId}/roles/${roleId}` | |
| guildRolesread-only | (id: Snowflake) => `/guilds/${id}/roles` | |
| guildRolesHoistPositionsread-only | (guildId: Snowflake) => `/guilds/${guildId}/roles/hoist-positions` | |
| guildsread-only | () => '/guilds' | |
| guildStickerread-only | (guildId: Snowflake, stickerId: Snowflake) => `/guilds/${guildId}/stickers/${stickerId}` | |
| guildStickersread-only | (id: Snowflake) => `/guilds/${id}/stickers` | |
| guildStickersBulkread-only | (guildId: Snowflake) => `/guilds/${guildId}/stickers/bulk` | |
| guildStickersCloneread-only | (guildId: Snowflake) => `/guilds/${guildId}/stickers/clone` | |
| guildTransferOwnershipread-only | (guildId: Snowflake) => `/guilds/${guildId}/transfer-ownership` | |
| guildVanityUrlread-only | (guildId: Snowflake) => `/guilds/${guildId}/vanity-url` | |
| guildWebhooksread-only | (id: Snowflake) => `/guilds/${id}/webhooks` | |
| instanceDiscoveryread-only | () => '/.well-known/fluxer' | Canonical instance discovery document (GET /.well-known/fluxer). |
| inviteread-only | (code: string) => `/invites/${encodeURIComponent(code)}` | |
| leaveGuildread-only | (guildId: Snowflake) => `/users/@me/guilds/${guildId}` | |
| oauth2ApplicationBotread-only | (id: Snowflake) => `/oauth2/applications/${id}/bot` | |
| oauth2ApplicationBotResetTokenread-only | (id: Snowflake) => `/oauth2/applications/${id}/bot/reset-token` | |
| oauth2ApplicationsMeread-only | () => '/oauth2/applications/@me' | |
| packread-only | (packId: Snowflake) => `/packs/${packId}` | |
| packEmojiread-only | (packId: Snowflake, emojiId: Snowflake) => `/packs/emojis/${packId}/${emojiId}` | |
| packEmojisread-only | (packId: Snowflake) => `/packs/emojis/${packId}` | |
| packEmojisBulkread-only | (packId: Snowflake) => `/packs/emojis/${packId}/bulk` | |
| packInstallread-only | (packId: Snowflake) => `/packs/${packId}/install` | |
| packInvitesread-only | (packId: Snowflake) => `/packs/${packId}/invites` | |
| packsread-only | () => '/packs' | |
| packsByTyperead-only | (packType: string) => `/packs/${packType}` | |
| packStickerread-only | (packId: Snowflake, stickerId: Snowflake) => `/packs/stickers/${packId}/${stickerId}` | |
| packStickersread-only | (packId: Snowflake) => `/packs/stickers/${packId}` | |
| packStickersBulkread-only | (packId: Snowflake) => `/packs/stickers/${packId}/bulk` | |
| preloadMessagesread-only | () => '/users/@me/preload-messages' | |
| preloadMessagesAltread-only | () => '/users/@me/channels/messages/preload' | |
| stickerMetadataread-only | (stickerId: Snowflake) => `/stickers/${stickerId}/metadata` | |
| streamPreviewread-only | (streamKey: string) => `/streams/${encodeURIComponent(streamKey)}/preview` | |
| userread-only | (id: Snowflake) => `/users/${id}` | |
| userMeChannelPinread-only | (channelId: Snowflake) => `/users/@me/channels/${channelId}/pin` | |
| userMeChannelsread-only | () => `/users/@me/channels` | |
| userProfileread-only | (id: Snowflake, guildId?: Snowflake) => string | GET /users/{id}/profile. Pass guildId for server-specific profile. |
| webhookread-only | (id: Snowflake) => `/webhooks/${id}` | |
| webhookExecuteread-only | (id: Snowflake, token: string) => `/webhooks/${id}/${token}` | |
| webhookMessageread-only | (id: Snowflake, token: string, messageId: Snowflake) => `/webhooks/${id}/${token}/messages/${messageId}` |