Stickers

This section documents everything related to stickers.

Discord Models

Sticker

Attributes

• created_at
• description
• format
• id
• name
• pack_id
• url

Methods

• asyncread
• asyncsave
• asyncto_file

class disnake.Sticker

Represents a sticker.

New in version 1.6.

str(x)

Returns the name of the sticker.

x == y

Checks if the sticker is equal to another sticker.

x != y

Checks if the sticker is not equal to another sticker.

name

The sticker’s name.

Type:

str

id

The ID of the sticker.

Type:

int

description

The description of the sticker.

Type:

str

pack_id

The ID of the sticker’s pack.

Type:

int

format

The format for the sticker’s image.

Type:

StickerFormatType

property created_at

Returns the sticker’s creation time in UTC.

Type:

datetime.datetime

await read()

This function is a coroutine.

Retrieves the content of this sticker as a bytes object.

Note

Stickers that use the StickerFormatType.lottie format cannot be read.

Raises:

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The sticker is a lottie type.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

property url

The url for the sticker’s image.

Type:

str

StandardSticker

Attributes

• created_at
• description
• format
• id
• name
• pack_id
• sort_value
• tags
• url

Methods

• asyncpack
• asyncread
• asyncsave
• asyncto_file

class disnake.StandardSticker

Represents a sticker that is found in a standard sticker pack.

New in version 2.0.

str(x)

Returns the name of the sticker.

x == y

Checks if the sticker is equal to another sticker.

x != y

Checks if the sticker is not equal to another sticker.

name

The sticker’s name.

Type:

str

id

The ID of the sticker.

Type:

int

description

The description of the sticker.

Type:

str

pack_id

The ID of the sticker’s pack.

Type:

int

format

The format for the sticker’s image.

Type:

StickerFormatType

tags

A list of tags for the sticker.

Type:

List[str]

sort_value

The sticker’s sort order within its pack.

Type:

int

await pack()

This function is a coroutine.

Retrieves the sticker pack that this sticker belongs to.

Raises:

• InvalidData – The corresponding sticker pack was not found.

• HTTPException – Retrieving the sticker pack failed.

Returns:

The retrieved sticker pack.

Return type:

StickerPack

property created_at

Returns the sticker’s creation time in UTC.

Type:

datetime.datetime

await read()

This function is a coroutine.

Retrieves the content of this sticker as a bytes object.

Note

Stickers that use the StickerFormatType.lottie format cannot be read.

Raises:

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The sticker is a lottie type.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

property url

The url for the sticker’s image.

Type:

str

GuildSticker

Attributes

• available
• created_at
• description
• emoji
• format
• guild
• guild_id
• id
• name
• url
• user

Methods

• asyncdelete
• asyncedit
• asyncread
• asyncsave
• asyncto_file

class disnake.GuildSticker

Represents a sticker that belongs to a guild.

New in version 2.0.

str(x)

Returns the name of the sticker.

x == y

Checks if the sticker is equal to another sticker.

x != y

Checks if the sticker is not equal to another sticker.

name

The sticker’s name.

Type:

str

id

The ID of the sticker.

Type:

int

description

The description of the sticker.

Type:

str

format

The format for the sticker’s image.

Type:

StickerFormatType

available

Whether this sticker is available for use.

Type:

bool

guild_id

The ID of the guild that this sticker is from.

Type:

int

user

The user that created this sticker. This can only be retrieved using Guild.fetch_sticker()/Guild.fetch_stickers() while having the manage_guild_expressions permission.

Type:

Optional[User]

emoji

The name of a unicode emoji that represents this sticker.

Type:

str

guild

The guild that this sticker is from. Could be None if the bot is not in the guild.

New in version 2.0.

Type:

Optional[Guild]

await edit(*, name=..., description=..., emoji=..., reason=None)

This function is a coroutine.

Edits a GuildSticker for the guild.

You must have manage_guild_expressions permission to do this.

Parameters:

• name (str) – The sticker’s new name. Must be at least 2 characters.

• description (Optional[str]) – The sticker’s new description. Can be None.

• emoji (str) – The name of a unicode emoji that represents the sticker’s expression.

• reason (Optional[str]) – The reason for editing this sticker. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to edit stickers.

• HTTPException – An error occurred editing the sticker.

Returns:

The newly modified sticker.

Return type:

GuildSticker

await delete(*, reason=None)

This function is a coroutine.

Deletes the custom Sticker from the guild.

You must have manage_guild_expressions permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this sticker. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to delete stickers.

• HTTPException – An error occurred deleting the sticker.

property created_at

Returns the sticker’s creation time in UTC.

Type:

datetime.datetime

await read()

This function is a coroutine.

Retrieves the content of this sticker as a bytes object.

Note

Stickers that use the StickerFormatType.lottie format cannot be read.

Raises:

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The sticker is a lottie type.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

property url

The url for the sticker’s image.

Type:

str

StickerItem

Attributes

• format
• id
• name
• url

Methods

• asyncfetch
• asyncread
• asyncsave
• asyncto_file

class disnake.StickerItem

Represents a sticker item.

New in version 2.0.

str(x)

Returns the name of the sticker item.

x == y

Checks if the sticker item is equal to another sticker item.

x != y

Checks if the sticker item is not equal to another sticker item.

name

The sticker’s name.

Type:

str

id

The ID of the sticker.

Type:

int

format

The format for the sticker’s image.

Type:

StickerFormatType

await fetch()

This function is a coroutine.

Attempts to retrieve the full sticker data of the sticker item.

Raises:

HTTPException – Retrieving the sticker failed.

Returns:

The retrieved sticker.

Return type:

Union[StandardSticker, GuildSticker]

await read()

This function is a coroutine.

Retrieves the content of this sticker as a bytes object.

Note

Stickers that use the StickerFormatType.lottie format cannot be read.

Raises:

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The sticker is a lottie type.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

property url

The url for the sticker’s image.

Type:

str

StickerPack

Attributes

• banner
• cover_sticker
• cover_sticker_id
• description
• id
• name
• sku_id
• stickers

class disnake.StickerPack

Represents a sticker pack.

New in version 2.0.

Changed in version 2.8: cover_sticker_id, cover_sticker and banner are now optional.

str(x)

Returns the name of the sticker pack.

x == y

Checks if the sticker pack is equal to another sticker pack.

x != y

Checks if the sticker pack is not equal to another sticker pack.

name

The name of the sticker pack.

Type:

str

description

The description of the sticker pack.

Type:

str

id

The id of the sticker pack.

Type:

int

stickers

The stickers of this sticker pack.

Type:

List[StandardSticker]

sku_id

The SKU ID of the sticker pack.

Type:

int

cover_sticker_id

The ID of the sticker used for the cover of the sticker pack, if any.

Type:

Optional[int]

cover_sticker

The sticker used for the cover of the sticker pack, if any.

Type:

Optional[StandardSticker]

property banner

The banner asset of the sticker pack, if any.

Type:

Optional[Asset]

Enumerations

StickerType

class disnake.StickerType

Represents the type of sticker.

New in version 2.0.

standard

Represents a standard sticker that all Nitro users can use.

guild

Represents a custom sticker created in a guild.

StickerFormatType

class disnake.StickerFormatType

Represents the type of sticker images.

New in version 1.6.

png

Represents a sticker with a png image.

apng

Represents a sticker with an apng image.

lottie

Represents a sticker with a lottie image.

gif

Represents a sticker with a gif image.

New in version 2.8.

Events

• on_guild_stickers_update(guild, before, after)