API Reference¶
The following section outlines the API of discord.py.
Note
This module uses the Python logging module to log diagnostic and errors in an output independent way. If the logging module is not configured, these logs will not be output anywhere. See Setting Up Logging for more information on how to set up and use the logging module with discord.py.
Clients¶
Client¶
- asyncapplication_info
- asyncbefore_identify_hook
- asyncchange_presence
- defclear
- asyncclose
- asyncconnect
- asynccreate_guild
- asyncdelete_invite
- @event
- asyncfetch_channel
- asyncfetch_guild
- asyncfetch_guilds
- asyncfetch_invite
- asyncfetch_template
- asyncfetch_user
- asyncfetch_user_profile
- asyncfetch_webhook
- asyncfetch_widget
- defget_all_channels
- defget_all_members
- defget_channel
- defget_emoji
- defget_guild
- defget_user
- defis_closed
- defis_ready
- defis_ws_ratelimited
- asynclogin
- asynclogout
- asyncon_error
- asyncrequest_offline_members
- defrun
- asyncstart
- asyncwait_for
- asyncwait_until_ready
-
class
discord.
Client
(*, loop=None, **options)¶ Represents a client connection that connects to Discord. This class is used to interact with the Discord WebSocket and API.
A number of options can be passed to the
Client
.- Parameters
max_messages (Optional[
int
]) –The maximum number of messages to store in the internal message cache. This defaults to
1000
. Passing inNone
disables the message cache.Changed in version 1.3: Allow disabling the message cache and change the default size to
1000
.loop (Optional[
asyncio.AbstractEventLoop
]) – Theasyncio.AbstractEventLoop
to use for asynchronous operations. Defaults toNone
, in which case the default event loop is used viaasyncio.get_event_loop()
.connector (
aiohttp.BaseConnector
) – The connector to use for connection pooling.proxy (Optional[
str
]) – Proxy URL.proxy_auth (Optional[
aiohttp.BasicAuth
]) – An object that represents proxy HTTP Basic Authorization.shard_id (Optional[
int
]) – Integer starting at0
and less thanshard_count
.shard_count (Optional[
int
]) – The total number of shards.intents (
Intents
) –The intents that you want to enable for the session. This is a way of disabling and enabling certain gateway events from triggering and being sent. If not given, defaults to a regularly constructed
Intents
class.New in version 1.5.
member_cache_flags (
MemberCacheFlags
) –Allows for finer control over how the library caches members. If not given, defaults to cache as much as possible with the currently selected intents.
New in version 1.5.
fetch_offline_members (
bool
) – A deprecated alias ofchunk_guilds_at_startup
.chunk_guilds_at_startup (
bool
) –Indicates if
on_ready()
should be delayed to chunk all guilds at start-up if necessary. This operation is incredibly slow for large amounts of guilds. The default isTrue
ifIntents.members
isTrue
.New in version 1.5.
status (Optional[
Status
]) – A status to start your presence with upon logging on to Discord.activity (Optional[
BaseActivity
]) – An activity to start your presence with upon logging on to Discord.allowed_mentions (Optional[
AllowedMentions
]) –Control how the client handles mentions by default on every message sent.
New in version 1.4.
heartbeat_timeout (
float
) – The maximum numbers of seconds before timing out and restarting the WebSocket in the case of not receiving a HEARTBEAT_ACK. Useful if processing the initial packets take too long to the point of disconnecting you. The default timeout is 60 seconds.guild_ready_timeout (
float
) –The maximum number of seconds to wait for the GUILD_CREATE stream to end before preparing the member cache and firing READY. The default timeout is 2 seconds.
New in version 1.4.
guild_subscriptions (
bool
) –Whether to dispatch presence or typing events. Defaults to
True
.New in version 1.3.
Warning
If this is set to
False
then the following features will be disabled:No user related updates (
on_user_update()
will not dispatch)- All member related events will be disabled.
Typing events will be disabled (
on_typing()
).If
fetch_offline_members
is set toFalse
then the user cache will not exist. This makes it difficult or impossible to do many things, for example:Computing permissions
Querying members in a voice channel via
VoiceChannel.members
will be empty.Most forms of receiving
Member
will be receivingUser
instead, except for message events.Guild.owner
will usually resolve toNone
.Guild.get_member()
will usually be unavailable.Anything that involves using
Member
.users
will not be as populated.etc.
In short, this makes it so the only member you can reliably query is the message author. Useful for bots that do not require any state.
assume_unsync_clock (
bool
) –Whether to assume the system clock is unsynced. This applies to the ratelimit handling code. If this is set to
True
, the default, then the library uses the time to reset a rate limit bucket given by Discord. If this isFalse
then your system clock is used to calculate how long to sleep for. If this is set toFalse
it is recommended to sync your system clock to Google’s NTP server.New in version 1.3.
-
ws
¶ The websocket gateway the client is currently connected to. Could be
None
.
-
loop
¶ The event loop that the client uses for HTTP requests and websocket operations.
-
latency
¶ Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.
This could be referred to as the Discord WebSocket protocol latency.
- Type
-
is_ws_ratelimited
()¶ bool
: Whether the websocket is currently rate limited.This can be useful to know when deciding whether you should query members using HTTP or via the gateway.
New in version 1.6.
-
user
¶ Represents the connected client.
None
if not logged in.- Type
Optional[
ClientUser
]
-
cached_messages
¶ Read-only list of messages the connected client has cached.
New in version 1.1.
- Type
Sequence[
Message
]
-
private_channels
¶ The private channels that the connected client is participating on.
Note
This returns only up to 128 most recent private channels due to an internal working on how Discord deals with private channels.
- Type
List[
abc.PrivateChannel
]
-
voice_clients
¶ Represents a list of voice connections.
These are usually
VoiceClient
instances.- Type
List[
VoiceProtocol
]
-
await
on_error
(event_method, *args, **kwargs)¶ This function is a coroutine.
The default error handler provided by the client.
By default this prints to
sys.stderr
however it could be overridden to have a different implementation. Checkon_error()
for more details.
-
await
request_offline_members
(*guilds)¶ This function is a coroutine.
Requests previously offline members from the guild to be filled up into the
Guild.members
cache. This function is usually not called. It should only be used if you have thefetch_offline_members
parameter set toFalse
.When the client logs on and connects to the websocket, Discord does not provide the library with offline members if the number of members in the guild is larger than 250. You can check if a guild is large if
Guild.large
isTrue
.Warning
This method is deprecated. Use
Guild.chunk()
instead.- Parameters
*guilds (
Guild
) – An argument list of guilds to request offline members for.- Raises
InvalidArgument – If any guild is unavailable in the collection.
-
await
before_identify_hook
(shard_id, *, initial=False)¶ This function is a coroutine.
A hook that is called before IDENTIFYing a session. This is useful if you wish to have more control over the synchronization of multiple IDENTIFYing clients.
The default implementation sleeps for 5 seconds.
New in version 1.4.
-
await
login
(token, *, bot=True)¶ This function is a coroutine.
Logs in the client with the specified credentials.
This function can be used in two different ways.
Warning
Logging on with a user token is against the Discord Terms of Service and doing so might potentially get your account banned. Use this at your own risk.
- Parameters
- Raises
LoginFailure – The wrong credentials are passed.
HTTPException – An unknown HTTP related error occurred, usually when it isn’t 200 or the known incorrect credentials passing status code.
-
await
connect
(*, reconnect=True)¶ This function is a coroutine.
Creates a websocket connection and lets the websocket listen to messages from Discord. This is a loop that runs the entire event system and miscellaneous aspects of the library. Control is not resumed until the WebSocket connection is terminated.
- Parameters
reconnect (
bool
) – If we should attempt reconnecting, either due to internet failure or a specific failure on Discord’s part. Certain disconnects that lead to bad state will not be handled (such as invalid sharding payloads or bad tokens).- Raises
GatewayNotFound – If the gateway to connect to Discord is not found. Usually if this is thrown then there is a Discord API outage.
ConnectionClosed – The websocket connection has been terminated.
-
clear
()¶ Clears the internal state of the bot.
After this, the bot can be considered “re-opened”, i.e.
is_closed()
andis_ready()
both returnFalse
along with the bot’s internal cache cleared.
-
await
start
(*args, **kwargs)¶ This function is a coroutine.
A shorthand coroutine for
login()
+connect()
.- Raises
TypeError – An unexpected keyword argument was received.
-
run
(*args, **kwargs)¶ A blocking call that abstracts away the event loop initialisation from you.
If you want more control over the event loop then this function should not be used. Use
start()
coroutine orconnect()
+login()
.Roughly Equivalent to:
try: loop.run_until_complete(start(*args, **kwargs)) except KeyboardInterrupt: loop.run_until_complete(logout()) # cancel all tasks lingering finally: loop.close()
Warning
This function must be the last function to call due to the fact that it is blocking. That means that registration of events or anything being called after this function call will not execute until it returns.
-
activity
¶ The activity being used upon logging in.
- Type
Optional[
BaseActivity
]
-
allowed_mentions
¶ The allowed mention configuration.
New in version 1.4.
- Type
Optional[
AllowedMentions
]
-
get_channel
(id)¶ Returns a channel with the given ID.
- Parameters
id (
int
) – The ID to search for.- Returns
The returned channel or
None
if not found.- Return type
Optional[Union[
abc.GuildChannel
,abc.PrivateChannel
]]
-
get_guild
(id)¶ Returns a guild with the given ID.
-
get_user
(id)¶ Returns a user with the given ID.
-
get_emoji
(id)¶ Returns an emoji with the given ID.
-
for ... in
get_all_channels
()¶ A generator that retrieves every
abc.GuildChannel
the client can ‘access’.This is equivalent to:
for guild in client.guilds: for channel in guild.channels: yield channel
Note
Just because you receive a
abc.GuildChannel
does not mean that you can communicate in said channel.abc.GuildChannel.permissions_for()
should be used for that.- Yields
abc.GuildChannel
– A channel the client can ‘access’.
-
for ... in
get_all_members
()¶ Returns a generator with every
Member
the client can see.This is equivalent to:
for guild in client.guilds: for member in guild.members: yield member
- Yields
Member
– A member the client can see.
-
await
wait_until_ready
()¶ This function is a coroutine.
Waits until the client’s internal cache is all ready.
-
wait_for
(event, *, check=None, timeout=None)¶ This function is a coroutine.
Waits for a WebSocket event to be dispatched.
This could be used to wait for a user to reply to a message, or to react to a message, or to edit a message in a self-contained way.
The
timeout
parameter is passed ontoasyncio.wait_for()
. By default, it does not timeout. Note that this does propagate theasyncio.TimeoutError
for you in case of timeout and is provided for ease of use.In case the event returns multiple arguments, a
tuple
containing those arguments is returned instead. Please check the documentation for a list of events and their parameters.This function returns the first event that meets the requirements.
Examples
Waiting for a user reply:
@client.event async def on_message(message): if message.content.startswith('$greet'): channel = message.channel await channel.send('Say hello!') def check(m): return m.content == 'hello' and m.channel == channel msg = await client.wait_for('message', check=check) await channel.send('Hello {.author}!'.format(msg))
Waiting for a thumbs up reaction from the message author:
@client.event async def on_message(message): if message.content.startswith('$thumb'): channel = message.channel await channel.send('Send me that 👍 reaction, mate') def check(reaction, user): return user == message.author and str(reaction.emoji) == '👍' try: reaction, user = await client.wait_for('reaction_add', timeout=60.0, check=check) except asyncio.TimeoutError: await channel.send('👎') else: await channel.send('👍')
- Parameters
event (
str
) – The event name, similar to the event reference, but without theon_
prefix, to wait for.check (Optional[Callable[…,
bool
]]) – A predicate to check what to wait for. The arguments must meet the parameters of the event being waited for.timeout (Optional[
float
]) – The number of seconds to wait before timing out and raisingasyncio.TimeoutError
.
- Raises
asyncio.TimeoutError – If a timeout is provided and it was reached.
- Returns
Returns no arguments, a single argument, or a
tuple
of multiple arguments that mirrors the parameters passed in the event reference.- Return type
Any
-
event
(coro)¶ A decorator that registers an event to listen to.
You can find more info about the events on the documentation below.
The events must be a coroutine, if not,
TypeError
is raised.Example
@client.event async def on_ready(): print('Ready!')
- Raises
TypeError – The coroutine passed is not actually a coroutine.
-
await
change_presence
(*, activity=None, status=None, afk=False)¶ This function is a coroutine.
Changes the client’s presence.
Example
game = discord.Game("with the API") await client.change_presence(status=discord.Status.idle, activity=game)
- Parameters
activity (Optional[
BaseActivity
]) – The activity being done.None
if no currently active activity is done.status (Optional[
Status
]) – Indicates what status to change to. IfNone
, thenStatus.online
is used.afk (Optional[
bool
]) – Indicates if you are going AFK. This allows the discord client to know how to handle push notifications better for you in case you are actually idle and not lying.
- Raises
InvalidArgument – If the
activity
parameter is not the proper type.
-
fetch_guilds
(*, limit=100, before=None, after=None)¶ This function is a coroutine.
Retrieves an
AsyncIterator
that enables receiving your guilds.Note
Using this, you will only receive
Guild.owner
,Guild.icon
,Guild.id
, andGuild.name
perGuild
.Note
This method is an API call. For general usage, consider
guilds
instead.Examples
Usage
async for guild in client.fetch_guilds(limit=150): print(guild.name)
Flattening into a list
guilds = await client.fetch_guilds(limit=150).flatten() # guilds is now a list of Guild...
All parameters are optional.
- Parameters
limit (Optional[
int
]) – The number of guilds to retrieve. IfNone
, it retrieves every guild you have access to. Note, however, that this would make it a slow operation. Defaults to100
.before (Union[
abc.Snowflake
,datetime.datetime
]) – Retrieves guilds before this date or object. If a date is provided it must be a timezone-naive datetime representing UTC time.after (Union[
abc.Snowflake
,datetime.datetime
]) – Retrieve guilds after this date or object. If a date is provided it must be a timezone-naive datetime representing UTC time.
- Raises
HTTPException – Getting the guilds failed.
- Yields
Guild
– The guild with the guild data parsed.
-
await
fetch_template
(code)¶ This function is a coroutine.
Gets a
Template
from a discord.new URL or code.- Parameters
code (Union[
Template
,str
]) – The Discord Template Code or URL (must be a discord.new URL).- Raises
NotFound – The template is invalid.
HTTPException – Getting the template failed.
- Returns
The template from the URL/code.
- Return type
-
await
fetch_guild
(guild_id)¶ This function is a coroutine.
Retrieves a
Guild
from an ID.Note
Using this, you will not receive
Guild.channels
,Guild.members
,Member.activity
andMember.voice
perMember
.Note
This method is an API call. For general usage, consider
get_guild()
instead.- Parameters
guild_id (
int
) – The guild’s ID to fetch from.- Raises
Forbidden – You do not have access to the guild.
HTTPException – Getting the guild failed.
- Returns
The guild from the ID.
- Return type
-
await
create_guild
(name, region=None, icon=None, *, code=None)¶ This function is a coroutine.
Creates a
Guild
.Bot accounts in more than 10 guilds are not allowed to create guilds.
- Parameters
name (
str
) – The name of the guild.region (
VoiceRegion
) – The region for the voice communication server. Defaults toVoiceRegion.us_west
.icon (
bytes
) – The bytes-like object representing the icon. SeeClientUser.edit()
for more details on what is expected.code (Optional[
str
]) –The code for a template to create the guild with.
New in version 1.4.
- Raises
HTTPException – Guild creation failed.
InvalidArgument – Invalid icon image format given. Must be PNG or JPG.
- Returns
The guild created. This is not the same guild that is added to cache.
- Return type
-
await
fetch_invite
(url, *, with_counts=True)¶ This function is a coroutine.
Gets an
Invite
from a discord.gg URL or ID.Note
If the invite is for a guild you have not joined, the guild and channel attributes of the returned
Invite
will bePartialInviteGuild
andPartialInviteChannel
respectively.- Parameters
url (Union[
Invite
,str
]) – The Discord invite ID or URL (must be a discord.gg URL).with_counts (
bool
) – Whether to include count information in the invite. This fills theInvite.approximate_member_count
andInvite.approximate_presence_count
fields.
- Raises
NotFound – The invite has expired or is invalid.
HTTPException – Getting the invite failed.
- Returns
The invite from the URL/ID.
- Return type
-
await
delete_invite
(invite)¶ This function is a coroutine.
Revokes an
Invite
, URL, or ID to an invite.You must have the
manage_channels
permission in the associated guild to do this.- Parameters
- Raises
Forbidden – You do not have permissions to revoke invites.
NotFound – The invite is invalid or expired.
HTTPException – Revoking the invite failed.
-
await
fetch_widget
(guild_id)¶ This function is a coroutine.
Gets a
Widget
from a guild ID.Note
The guild must have the widget enabled to get this information.
- Parameters
guild_id (
int
) – The ID of the guild.- Raises
Forbidden – The widget for this guild is disabled.
HTTPException – Retrieving the widget failed.
- Returns
The guild’s widget.
- Return type
-
await
application_info
()¶ This function is a coroutine.
Retrieves the bot’s application information.
- Raises
HTTPException – Retrieving the information failed somehow.
- Returns
The bot’s application information.
- Return type
-
await
fetch_user
(user_id)¶ This function is a coroutine.
Retrieves a
User
based on their ID. This can only be used by bot accounts. You do not have to share any guilds with the user to get this information, however many operations do require that you do.Note
This method is an API call. For general usage, consider
get_user()
instead.- Parameters
user_id (
int
) – The user’s ID to fetch from.- Raises
NotFound – A user with this ID does not exist.
HTTPException – Fetching the user failed.
- Returns
The user you requested.
- Return type
-
await
fetch_user_profile
(user_id)¶ This function is a coroutine.
Gets an arbitrary user’s profile.
Note
This can only be used by non-bot accounts.
- Parameters
user_id (
int
) – The ID of the user to fetch their profile for.- Raises
Forbidden – Not allowed to fetch profiles.
HTTPException – Fetching the profile failed.
- Returns
The profile of the user.
- Return type
-
await
fetch_channel
(channel_id)¶ This function is a coroutine.
Retrieves a
abc.GuildChannel
orabc.PrivateChannel
with the specified ID.Note
This method is an API call. For general usage, consider
get_channel()
instead.New in version 1.2.
- Raises
InvalidData – An unknown channel type was received from Discord.
HTTPException – Retrieving the channel failed.
NotFound – Invalid Channel ID.
Forbidden – You do not have permission to fetch this channel.
- Returns
The channel from the ID.
- Return type
Union[
abc.GuildChannel
,abc.PrivateChannel
]
AutoShardedClient¶
- asyncchange_presence
- asyncclose
- asyncconnect
- defget_shard
- defis_ws_ratelimited
- asyncrequest_offline_members
-
class
discord.
AutoShardedClient
(*args, loop=None, **kwargs)¶ A client similar to
Client
except it handles the complications of sharding for the user into a more manageable and transparent single process bot.When using this client, you will be able to use it as-if it was a regular
Client
with a single shard when implementation wise internally it is split up into multiple shards. This allows you to not have to deal with IPC or other complicated infrastructure.It is recommended to use this client only if you have surpassed at least 1000 guilds.
If no
shard_count
is provided, then the library will use the Bot Gateway endpoint call to figure out how many shards to use.If a
shard_ids
parameter is given, then those shard IDs will be used to launch the internal shards. Note thatshard_count
must be provided if this is used. By default, when omitted, the client will launch shards from 0 toshard_count - 1
.-
latency
¶ Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.
This operates similarly to
Client.latency()
except it uses the average latency of every shard’s latency. To get a list of shard latency, check thelatencies
property. Returnsnan
if there are no shards ready.- Type
-
latencies
¶ A list of latencies between a HEARTBEAT and a HEARTBEAT_ACK in seconds.
This returns a list of tuples with elements
(shard_id, latency)
.
-
get_shard
(shard_id)¶ Optional[
ShardInfo
]: Gets the shard information at a given shard ID orNone
if not found.
-
shards
¶ Returns a mapping of shard IDs to their respective info object.
- Type
Mapping[int,
ShardInfo
]
-
await
request_offline_members
(*guilds)¶ This function is a coroutine.
Requests previously offline members from the guild to be filled up into the
Guild.members
cache. This function is usually not called. It should only be used if you have thefetch_offline_members
parameter set toFalse
.When the client logs on and connects to the websocket, Discord does not provide the library with offline members if the number of members in the guild is larger than 250. You can check if a guild is large if
Guild.large
isTrue
.Warning
This method is deprecated. Use
Guild.chunk()
instead.- Parameters
*guilds (
Guild
) – An argument list of guilds to request offline members for.- Raises
InvalidArgument – If any guild is unavailable in the collection.
-
await
connect
(*, reconnect=True)¶ This function is a coroutine.
Creates a websocket connection and lets the websocket listen to messages from Discord. This is a loop that runs the entire event system and miscellaneous aspects of the library. Control is not resumed until the WebSocket connection is terminated.
- Parameters
reconnect (
bool
) – If we should attempt reconnecting, either due to internet failure or a specific failure on Discord’s part. Certain disconnects that lead to bad state will not be handled (such as invalid sharding payloads or bad tokens).- Raises
GatewayNotFound – If the gateway to connect to Discord is not found. Usually if this is thrown then there is a Discord API outage.
ConnectionClosed – The websocket connection has been terminated.
-
await
change_presence
(*, activity=None, status=None, afk=False, shard_id=None)¶ This function is a coroutine.
Changes the client’s presence.
Example:
game = discord.Game("with the API") await client.change_presence(status=discord.Status.idle, activity=game)
- Parameters
activity (Optional[
BaseActivity
]) – The activity being done.None
if no currently active activity is done.status (Optional[
Status
]) – Indicates what status to change to. IfNone
, thenStatus.online
is used.afk (
bool
) – Indicates if you are going AFK. This allows the discord client to know how to handle push notifications better for you in case you are actually idle and not lying.shard_id (Optional[
int
]) – The shard_id to change the presence to. If not specified orNone
, then it will change the presence of every shard the bot can see.
- Raises
InvalidArgument – If the
activity
parameter is not of proper type.
-
is_ws_ratelimited
()¶ bool
: Whether the websocket is currently rate limited.This can be useful to know when deciding whether you should query members using HTTP or via the gateway.
This implementation checks if any of the shards are rate limited. For more granular control, consider
ShardInfo.is_ws_ratelimited()
.New in version 1.6.
-
Application Info¶
AppInfo¶
-
class
discord.
AppInfo
¶ Represents the application info for the bot provided by Discord.
-
bot_public
¶ Whether the bot can be invited by anyone or if it is locked to the application owner.
- Type
-
bot_require_code_grant
¶ Whether the bot requires the completion of the full oauth2 code grant flow to join.
- Type
-
summary
¶ If this application is a game sold on Discord, this field will be the summary field for the store page of its primary SKU
New in version 1.3.
- Type
-
guild_id
¶ If this application is a game sold on Discord, this field will be the guild to which it has been linked
New in version 1.3.
- Type
Optional[
int
]
-
primary_sku_id
¶ If this application is a game sold on Discord, this field will be the id of the “Game SKU” that is created, if exists
New in version 1.3.
- Type
Optional[
int
]
-
slug
¶ If this application is a game sold on Discord, this field will be the URL slug that links to the store page
New in version 1.3.
- Type
Optional[
str
]
-
cover_image
¶ If this application is a game sold on Discord, this field will be the hash of the image on store embeds
New in version 1.3.
- Type
Optional[
str
]
-
icon_url
¶ Retrieves the application’s icon asset.
This is equivalent to calling
icon_url_as()
with the default parameters (‘webp’ format and a size of 1024).New in version 1.3.
- Type
-
icon_url_as
(*, format='webp', size=1024)¶ Returns an
Asset
for the icon the application has.The format must be one of ‘webp’, ‘jpeg’, ‘jpg’ or ‘png’. The size must be a power of 2 between 16 and 4096.
New in version 1.6.
- Parameters
- Raises
InvalidArgument – Bad image format passed to
format
or invalidsize
.- Returns
The resulting CDN asset.
- Return type
-
cover_image_url
¶ Retrieves the cover image on a store embed.
This is equivalent to calling
cover_image_url_as()
with the default parameters (‘webp’ format and a size of 1024).New in version 1.3.
- Type
-
cover_image_url_as
(*, format='webp', size=1024)¶ Returns an
Asset
for the image on store embeds if this application is a game sold on Discord.The format must be one of ‘webp’, ‘jpeg’, ‘jpg’ or ‘png’. The size must be a power of 2 between 16 and 4096.
New in version 1.6.
- Parameters
- Raises
InvalidArgument – Bad image format passed to
format
or invalidsize
.- Returns
The resulting CDN asset.
- Return type
-
Team¶
-
class
discord.
Team
¶ Represents an application team for a bot provided by Discord.
-
members
¶ A list of the members in the team
New in version 1.3.
- Type
List[
TeamMember
]
-
icon_url
¶ Retrieves the team’s icon asset.
This is equivalent to calling
icon_url_as()
with the default parameters (‘webp’ format and a size of 1024).- Type
-
icon_url_as
(*, format='webp', size=1024)¶ Returns an
Asset
for the icon the team has.The format must be one of ‘webp’, ‘jpeg’, ‘jpg’ or ‘png’. The size must be a power of 2 between 16 and 4096.
New in version 2.0.
- Parameters
- Raises
InvalidArgument – Bad image format passed to
format
or invalidsize
.- Returns
The resulting CDN asset.
- Return type
-
owner
¶ The team’s owner.
- Type
Optional[
TeamMember
]
-
TeamMember¶
-
class
discord.
TeamMember
¶ Represents a team member in a team.
-
x == y
Checks if two team members are equal.
-
x != y
Checks if two team members are not equal.
-
hash(x)
Return the team member’s hash.
-
str(x)
Returns the team member’s name with discriminator.
New in version 1.3.
-
discriminator
¶ The team member’s discriminator. This is given when the username has conflicts.
- Type
-
membership_state
¶ The membership state of the member (e.g. invited or accepted)
- Type
-
Event Reference¶
This section outlines the different types of events listened by Client
.
There are two ways to register an event, the first way is through the use of
Client.event()
. The second way is through subclassing Client
and
overriding the specific events. For example:
import discord
class MyClient(discord.Client):
async def on_message(self, message):
if message.author == self.user:
return
if message.content.startswith('$hello'):
await message.channel.send('Hello World!')
If an event handler raises an exception, on_error()
will be called
to handle it, which defaults to print a traceback and ignoring the exception.
Warning
All the events must be a coroutine. If they aren’t, then you might get unexpected
errors. In order to turn a function into a coroutine they must be async def
functions.
-
discord.
on_connect
()¶ Called when the client has successfully connected to Discord. This is not the same as the client being fully prepared, see
on_ready()
for that.The warnings on
on_ready()
also apply.
-
discord.
on_shard_connect
(shard_id)¶ Similar to
on_connect()
except used byAutoShardedClient
to denote when a particular shard ID has connected to Discord.New in version 1.4.
- Parameters
shard_id (
int
) – The shard ID that has connected.
-
discord.
on_disconnect
()¶ Called when the client has disconnected from Discord. This could happen either through the internet being disconnected, explicit calls to logout, or Discord terminating the connection one way or the other.
This function can be called many times.
-
discord.
on_shard_disconnect
(shard_id)¶ Similar to
on_disconnect()
except used byAutoShardedClient
to denote when a particular shard ID has disconnected from Discord.New in version 1.4.
- Parameters
shard_id (
int
) – The shard ID that has disconnected.
-
discord.
on_ready
()¶ Called when the client is done preparing the data received from Discord. Usually after login is successful and the
Client.guilds
and co. are filled up.Warning
This function is not guaranteed to be the first event called. Likewise, this function is not guaranteed to only be called once. This library implements reconnection logic and thus will end up calling this event whenever a RESUME request fails.
-
discord.
on_shard_ready
(shard_id)¶ Similar to
on_ready()
except used byAutoShardedClient
to denote when a particular shard ID has become ready.- Parameters
shard_id (
int
) – The shard ID that is ready.
-
discord.
on_resumed
()¶ Called when the client has resumed a session.
-
discord.
on_shard_resumed
(shard_id)¶ Similar to
on_resumed()
except used byAutoShardedClient
to denote when a particular shard ID has resumed a session.New in version 1.4.
- Parameters
shard_id (
int
) – The shard ID that has resumed.
-
discord.
on_error
(event, \*args, \*\*kwargs)¶ Usually when an event raises an uncaught exception, a traceback is printed to stderr and the exception is ignored. If you want to change this behaviour and handle the exception for whatever reason yourself, this event can be overridden. Which, when done, will suppress the default action of printing the traceback.
The information of the exception raised and the exception itself can be retrieved with a standard call to
sys.exc_info()
.If you want exception to propagate out of the
Client
class you can define anon_error
handler consisting of a single empty The raise statement. Exceptions raised byon_error
will not be handled in any way byClient
.Note
on_error
will only be dispatched toClient.event()
.It will not be received by
Client.wait_for()
, or, if used, Bots listeners such aslisten()
orlistener()
.- Parameters
event (
str
) – The name of the event that raised the exception.args – The positional arguments for the event that raised the exception.
kwargs – The keyword arguments for the event that raised the exception.
-
discord.
on_socket_raw_receive
(msg)¶ Called whenever a message is received from the WebSocket, before it’s processed. This event is always dispatched when a message is received and the passed data is not processed in any way.
This is only really useful for grabbing the WebSocket stream and debugging purposes.
Note
This is only for the messages received from the client WebSocket. The voice WebSocket will not trigger this event.
-
discord.
on_socket_raw_send
(payload)¶ Called whenever a send operation is done on the WebSocket before the message is sent. The passed parameter is the message that is being sent to the WebSocket.
This is only really useful for grabbing the WebSocket stream and debugging purposes.
Note
This is only for the messages sent from the client WebSocket. The voice WebSocket will not trigger this event.
-
discord.
on_typing
(channel, user, when)¶ Called when someone begins typing a message.
The
channel
parameter can be aabc.Messageable
instance. Which could either beTextChannel
,GroupChannel
, orDMChannel
.If the
channel
is aTextChannel
then theuser
parameter is aMember
, otherwise it is aUser
.This requires
Intents.typing
to be enabled.- Parameters
channel (
abc.Messageable
) – The location where the typing originated from.when (
datetime.datetime
) – When the typing started as a naive datetime in UTC.
-
discord.
on_message
(message)¶ Called when a
Message
is created and sent.This requires
Intents.messages
to be enabled.Warning
Your bot’s own messages and private messages are sent through this event. This can lead cases of ‘recursion’ depending on how your bot was programmed. If you want the bot to not reply to itself, consider checking the user IDs. Note that
Bot
does not have this problem.- Parameters
message (
Message
) – The current message.
-
discord.
on_message_delete
(message)¶ Called when a message is deleted. If the message is not found in the internal message cache, then this event will not be called. Messages might not be in cache if the message is too old or the client is participating in high traffic guilds.
If this occurs increase the
Client.max_messages
attribute or use theon_raw_message_delete()
event instead.This requires
Intents.messages
to be enabled.- Parameters
message (
Message
) – The deleted message.
-
discord.
on_bulk_message_delete
(messages)¶ Called when messages are bulk deleted. If none of the messages deleted are found in the internal message cache, then this event will not be called. If individual messages were not found in the internal message cache, this event will still be called, but the messages not found will not be included in the messages list. Messages might not be in cache if the message is too old or the client is participating in high traffic guilds.
If this occurs increase the
Client.max_messages
attribute or use theon_raw_bulk_message_delete()
event instead.This requires
Intents.messages
to be enabled.- Parameters
messages (List[
Message
]) – The messages that have been deleted.
-
discord.
on_raw_message_delete
(payload)¶ Called when a message is deleted. Unlike
on_message_delete()
, this is called regardless of the message being in the internal message cache or not.If the message is found in the message cache, it can be accessed via
RawMessageDeleteEvent.cached_message
This requires
Intents.messages
to be enabled.- Parameters
payload (
RawMessageDeleteEvent
) – The raw event payload data.
-
discord.
on_raw_bulk_message_delete
(payload)¶ Called when a bulk delete is triggered. Unlike
on_bulk_message_delete()
, this is called regardless of the messages being in the internal message cache or not.If the messages are found in the message cache, they can be accessed via
RawBulkMessageDeleteEvent.cached_messages
This requires
Intents.messages
to be enabled.- Parameters
payload (
RawBulkMessageDeleteEvent
) – The raw event payload data.
-
discord.
on_message_edit
(before, after)¶ Called when a
Message
receives an update event. If the message is not found in the internal message cache, then these events will not be called. Messages might not be in cache if the message is too old or the client is participating in high traffic guilds.If this occurs increase the
Client.max_messages
attribute or use theon_raw_message_edit()
event instead.The following non-exhaustive cases trigger this event:
A message has been pinned or unpinned.
The message content has been changed.
The message has received an embed.
For performance reasons, the embed server does not do this in a “consistent” manner.
The message’s embeds were suppressed or unsuppressed.
A call message has received an update to its participants or ending time.
This requires
Intents.messages
to be enabled.
-
discord.
on_raw_message_edit
(payload)¶ Called when a message is edited. Unlike
on_message_edit()
, this is called regardless of the state of the internal message cache.If the message is found in the message cache, it can be accessed via
RawMessageUpdateEvent.cached_message
Due to the inherently raw nature of this event, the data parameter coincides with the raw data given by the gateway.
Since the data payload can be partial, care must be taken when accessing stuff in the dictionary. One example of a common case of partial data is when the
'content'
key is inaccessible. This denotes an “embed” only edit, which is an edit in which only the embeds are updated by the Discord embed server.This requires
Intents.messages
to be enabled.- Parameters
payload (
RawMessageUpdateEvent
) – The raw event payload data.
-
discord.
on_reaction_add
(reaction, user)¶ Called when a message has a reaction added to it. Similar to
on_message_edit()
, if the message is not found in the internal message cache, then this event will not be called. Consider usingon_raw_reaction_add()
instead.Note
To get the
Message
being reacted, access it viaReaction.message
.This requires
Intents.reactions
to be enabled.
-
discord.
on_raw_reaction_add
(payload)¶ Called when a message has a reaction added. Unlike
on_reaction_add()
, this is called regardless of the state of the internal message cache.This requires
Intents.reactions
to be enabled.- Parameters
payload (
RawReactionActionEvent
) – The raw event payload data.
-
discord.
on_reaction_remove
(reaction, user)¶ Called when a message has a reaction removed from it. Similar to on_message_edit, if the message is not found in the internal message cache, then this event will not be called.
Note
To get the message being reacted, access it via
Reaction.message
.This requires
Intents.reactions
to be enabled.
-
discord.
on_raw_reaction_remove
(payload)¶ Called when a message has a reaction removed. Unlike
on_reaction_remove()
, this is called regardless of the state of the internal message cache.This requires
Intents.reactions
to be enabled.- Parameters
payload (
RawReactionActionEvent
) – The raw event payload data.
-
discord.
on_reaction_clear
(message, reactions)¶ Called when a message has all its reactions removed from it. Similar to
on_message_edit()
, if the message is not found in the internal message cache, then this event will not be called. Consider usingon_raw_reaction_clear()
instead.This requires
Intents.reactions
to be enabled.
-
discord.
on_raw_reaction_clear
(payload)¶ Called when a message has all its reactions removed. Unlike
on_reaction_clear()
, this is called regardless of the state of the internal message cache.This requires
Intents.reactions
to be enabled.- Parameters
payload (
RawReactionClearEvent
) – The raw event payload data.
-
discord.
on_reaction_clear_emoji
(reaction)¶ Called when a message has a specific reaction removed from it. Similar to
on_message_edit()
, if the message is not found in the internal message cache, then this event will not be called. Consider usingon_raw_reaction_clear_emoji()
instead.This requires
Intents.reactions
to be enabled.New in version 1.3.
- Parameters
reaction (
Reaction
) – The reaction that got cleared.
-
discord.
on_raw_reaction_clear_emoji
(payload)¶ Called when a message has a specific reaction removed from it. Unlike
on_reaction_clear_emoji()
this is called regardless of the state of the internal message cache.This requires
Intents.reactions
to be enabled.New in version 1.3.
- Parameters
payload (
RawReactionClearEmojiEvent
) – The raw event payload data.
-
discord.
on_private_channel_delete
(channel)¶ -
discord.
on_private_channel_create
(channel)¶ Called whenever a private channel is deleted or created.
This requires
Intents.messages
to be enabled.- Parameters
channel (
abc.PrivateChannel
) – The private channel that got created or deleted.
-
discord.
on_private_channel_update
(before, after)¶ Called whenever a private group DM is updated. e.g. changed name or topic.
This requires
Intents.messages
to be enabled.- Parameters
before (
GroupChannel
) – The updated group channel’s old info.after (
GroupChannel
) – The updated group channel’s new info.
-
discord.
on_private_channel_pins_update
(channel, last_pin)¶ Called whenever a message is pinned or unpinned from a private channel.
- Parameters
channel (
abc.PrivateChannel
) – The private channel that had its pins updated.last_pin (Optional[
datetime.datetime
]) – The latest message that was pinned as a naive datetime in UTC. Could beNone
.
-
discord.
on_guild_channel_delete
(channel)¶ -
discord.
on_guild_channel_create
(channel)¶ Called whenever a guild channel is deleted or created.
Note that you can get the guild from
guild
.This requires
Intents.guilds
to be enabled.- Parameters
channel (
abc.GuildChannel
) – The guild channel that got created or deleted.
-
discord.
on_guild_channel_update
(before, after)¶ Called whenever a guild channel is updated. e.g. changed name, topic, permissions.
This requires
Intents.guilds
to be enabled.- Parameters
before (
abc.GuildChannel
) – The updated guild channel’s old info.after (
abc.GuildChannel
) – The updated guild channel’s new info.
-
discord.
on_guild_channel_pins_update
(channel, last_pin)¶ Called whenever a message is pinned or unpinned from a guild channel.
This requires
Intents.guilds
to be enabled.- Parameters
channel (
abc.GuildChannel
) – The guild channel that had its pins updated.last_pin (Optional[
datetime.datetime
]) – The latest message that was pinned as a naive datetime in UTC. Could beNone
.
-
discord.
on_guild_integrations_update
(guild)¶ New in version 1.4.
Called whenever an integration is created, modified, or removed from a guild.
This requires
Intents.integrations
to be enabled.- Parameters
guild (
Guild
) – The guild that had its integrations updated.
-
discord.
on_webhooks_update
(channel)¶ Called whenever a webhook is created, modified, or removed from a guild channel.
This requires
Intents.webhooks
to be enabled.- Parameters
channel (
abc.GuildChannel
) – The channel that had its webhooks updated.
-
discord.
on_member_join
(member)¶ -
discord.
on_member_remove
(member)¶ Called when a
Member
leaves or joins aGuild
.This requires
Intents.members
to be enabled.- Parameters
member (
Member
) – The member who joined or left.
-
discord.
on_member_update
(before, after)¶ Called when a
Member
updates their profile.This is called when one or more of the following things change:
status
activity
nickname
roles
pending
This requires
Intents.members
to be enabled.
-
discord.
on_user_update
(before, after)¶ Called when a
User
updates their profile.This is called when one or more of the following things change:
avatar
username
discriminator
This requires
Intents.members
to be enabled.
-
discord.
on_guild_join
(guild)¶ Called when a
Guild
is either created by theClient
or when theClient
joins a guild.This requires
Intents.guilds
to be enabled.- Parameters
guild (
Guild
) – The guild that was joined.
-
discord.
on_guild_remove
(guild)¶ Called when a
Guild
is removed from theClient
.This happens through, but not limited to, these circumstances:
The client got banned.
The client got kicked.
The client left the guild.
The client or the guild owner deleted the guild.
In order for this event to be invoked then the
Client
must have been part of the guild to begin with. (i.e. it is part ofClient.guilds
)This requires
Intents.guilds
to be enabled.- Parameters
guild (
Guild
) – The guild that got removed.
-
discord.
on_guild_update
(before, after)¶ Called when a
Guild
updates, for example:Changed name
Changed AFK channel
Changed AFK timeout
etc
This requires
Intents.guilds
to be enabled.
-
discord.
on_guild_role_create
(role)¶ -
discord.
on_guild_role_delete
(role)¶ Called when a
Guild
creates or deletes a newRole
.To get the guild it belongs to, use
Role.guild
.This requires
Intents.guilds
to be enabled.- Parameters
role (
Role
) – The role that was created or deleted.
-
discord.
on_guild_role_update
(before, after)¶ Called when a
Role
is changed guild-wide.This requires
Intents.guilds
to be enabled.
-
discord.
on_guild_emojis_update
(guild, before, after)¶ Called when a
Guild
adds or removesEmoji
.This requires
Intents.emojis
to be enabled.
-
discord.
on_guild_available
(guild)¶ Called when a guild becomes available or unavailable. The guild must have existed in the
Client.guilds
cache.This requires
Intents.guilds
to be enabled.- Parameters
guild – The
Guild
that has changed availability.
-
discord.
on_voice_state_update
(member, before, after)¶ Called when a
Member
changes theirVoiceState
.The following, but not limited to, examples illustrate when this event is called:
A member joins a voice channel.
A member leaves a voice channel.
A member is muted or deafened by their own accord.
A member is muted or deafened by a guild administrator.
This requires
Intents.voice_states
to be enabled.- Parameters
member (
Member
) – The member whose voice states changed.before (
VoiceState
) – The voice state prior to the changes.after (
VoiceState
) – The voice state after to the changes.
-
discord.
on_member_ban
(guild, user)¶ Called when user gets banned from a
Guild
.This requires
Intents.bans
to be enabled.
-
discord.
on_member_unban
(guild, user)¶ Called when a
User
gets unbanned from aGuild
.This requires
Intents.bans
to be enabled.
-
discord.
on_invite_create
(invite)¶ Called when an
Invite
is created. You must have themanage_channels
permission to receive this.New in version 1.3.
Note
There is a rare possibility that the
Invite.guild
andInvite.channel
attributes will be ofObject
rather than the respective models.This requires
Intents.invites
to be enabled.- Parameters
invite (
Invite
) – The invite that was created.
-
discord.
on_invite_delete
(invite)¶ Called when an
Invite
is deleted. You must have themanage_channels
permission to receive this.New in version 1.3.
Note
There is a rare possibility that the
Invite.guild
andInvite.channel
attributes will be ofObject
rather than the respective models.Outside of those two attributes, the only other attribute guaranteed to be filled by the Discord gateway for this event is
Invite.code
.This requires
Intents.invites
to be enabled.- Parameters
invite (
Invite
) – The invite that was deleted.
-
discord.
on_group_join
(channel, user)¶ -
discord.
on_group_remove
(channel, user)¶ Called when someone joins or leaves a
GroupChannel
.- Parameters
channel (
GroupChannel
) – The group that the user joined or left.user (
User
) – The user that joined or left.
-
discord.
on_relationship_add
(relationship)¶ -
discord.
on_relationship_remove
(relationship)¶ Called when a
Relationship
is added or removed from theClientUser
.- Parameters
relationship (
Relationship
) – The relationship that was added or removed.
-
discord.
on_relationship_update
(before, after)¶ Called when a
Relationship
is updated, e.g. when you block a friend or a friendship is accepted.- Parameters
before (
Relationship
) – The previous relationship status.after (
Relationship
) – The updated relationship status.
Utility Functions¶
-
discord.utils.
find
(predicate, seq)¶ A helper to return the first element found in the sequence that meets the predicate. For example:
member = discord.utils.find(lambda m: m.name == 'Mighty', channel.guild.members)
would find the first
Member
whose name is ‘Mighty’ and return it. If an entry is not found, thenNone
is returned.This is different from
filter()
due to the fact it stops the moment it finds a valid entry.- Parameters
predicate – A function that returns a boolean-like result.
seq (iterable) – The iterable to search through.
-
discord.utils.
get
(iterable, **attrs)¶ A helper that returns the first element in the iterable that meets all the traits passed in
attrs
. This is an alternative forfind()
.When multiple attributes are specified, they are checked using logical AND, not logical OR. Meaning they have to meet every attribute passed in and not one of them.
To have a nested attribute search (i.e. search by
x.y
) then pass inx__y
as the keyword argument.If nothing is found that matches the attributes passed, then
None
is returned.Examples
Basic usage:
member = discord.utils.get(message.guild.members, name='Foo')
Multiple attribute matching:
channel = discord.utils.get(guild.voice_channels, name='Foo', bitrate=64000)
Nested attribute matching:
channel = discord.utils.get(client.get_all_channels(), guild__name='Cool', name='general')
- Parameters
iterable – An iterable to search through.
**attrs – Keyword arguments that denote attributes to search with.
-
discord.utils.
snowflake_time
(id)¶ - Parameters
id (
int
) – The snowflake ID.- Returns
The creation date in UTC of a Discord snowflake ID.
- Return type
-
discord.utils.
oauth_url
(client_id, permissions=None, guild=None, redirect_uri=None)¶ A helper function that returns the OAuth2 URL for inviting the bot into guilds.
- Parameters
client_id (
str
) – The client ID for your bot.permissions (
Permissions
) – The permissions you’re requesting. If not given then you won’t be requesting any permissions.guild (
Guild
) – The guild to pre-select in the authorization screen, if available.redirect_uri (
str
) – An optional valid redirect URI.
- Returns
The OAuth2 URL for inviting the bot into guilds.
- Return type
-
discord.utils.
escape_markdown
(text, *, as_needed=False, ignore_links=True)¶ A helper function that escapes Discord’s markdown.
- Parameters
text (
str
) – The text to escape markdown from.as_needed (
bool
) – Whether to escape the markdown characters as needed. This means that it does not escape extraneous characters if it’s not necessary, e.g.**hello**
is escaped into\*\*hello**
instead of\*\*hello\*\*
. Note however that this can open you up to some clever syntax abuse. Defaults toFalse
.ignore_links (
bool
) – Whether to leave links alone when escaping markdown. For example, if a URL in the text contains characters such as_
then it will be left alone. This option is not supported withas_needed
. Defaults toTrue
.
- Returns
The text with the markdown special characters escaped with a slash.
- Return type
-
discord.utils.
escape_mentions
(text)¶ A helper function that escapes everyone, here, role, and user mentions.
Note
This does not include channel mentions.
Note
For more granular control over what mentions should be escaped within messages, refer to the
AllowedMentions
class.
-
discord.utils.
resolve_template
(code)¶ Resolves a template code from a
Template
, URL or code.New in version 1.4.
-
await
discord.utils.
sleep_until
(when, result=None)¶ This function is a coroutine.
Sleep until a specified time.
If the time supplied is in the past this function will yield instantly.
New in version 1.3.
- Parameters
when (
datetime.datetime
) – The timestamp in which to sleep until. If the datetime is naive then it is assumed to be in UTC.result (Any) – If provided is returned to the caller when the coroutine completes.
Profile¶
-
class
discord.
Profile
¶ A namedtuple representing a user’s Discord public profile.
A boolean indicating if the user has premium (i.e. Discord Nitro).
- Type
A naive UTC datetime indicating how long the user has been premium since. This could be
None
if not applicable.- Type
-
early_supporter
¶ A boolean indicating if the user has had premium before 10 October, 2018.
- Type
-
hypesquad_houses
¶ A list of
HypeSquadHouse
that the user is in.- Type
List[
HypeSquadHouse
]
-
system
¶ A boolean indicating if the user is officially part of the Discord urgent message system.
New in version 1.3.
- Type
-
mutual_guilds
¶ A list of
Guild
that theClientUser
shares with this user.- Type
List[
Guild
]
Enumerations¶
The API provides some enumerations for certain types of strings to avoid the API from being stringly typed in case the strings change in the future.
All enumerations are subclasses of an internal class which mimics the behaviour
of enum.Enum
.
-
class
discord.
ChannelType
¶ Specifies the type of channel.
-
text
¶ A text channel.
-
voice
¶ A voice channel.
-
private
¶ A private text channel. Also called a direct message.
-
group
¶ A private group text channel.
-
category
¶ A category channel.
-
news
¶ A guild news channel.
-
store
¶ A guild store channel.
-
-
class
discord.
MessageType
¶ Specifies the type of
Message
. This is used to denote if a message is to be interpreted as a system message or a regular message.-
x == y
Checks if two messages are equal.
-
x != y
Checks if two messages are not equal.
-
default
¶ The default message type. This is the same as regular messages.
-
recipient_add
¶ The system message when a recipient is added to a group private message, i.e. a private channel of type
ChannelType.group
.
-
recipient_remove
¶ The system message when a recipient is removed from a group private message, i.e. a private channel of type
ChannelType.group
.
-
call
¶ The system message denoting call state, e.g. missed call, started call, etc.
-
channel_name_change
¶ The system message denoting that a channel’s name has been changed.
-
channel_icon_change
¶ The system message denoting that a channel’s icon has been changed.
-
pins_add
¶ The system message denoting that a pinned message has been added to a channel.
-
new_member
¶ The system message denoting that a new member has joined a Guild.
The system message denoting that a member has “nitro boosted” a guild.
The system message denoting that a member has “nitro boosted” a guild and it achieved level 1.
The system message denoting that a member has “nitro boosted” a guild and it achieved level 2.
The system message denoting that a member has “nitro boosted” a guild and it achieved level 3.
-
channel_follow_add
¶ The system message denoting that an announcement channel has been followed.
New in version 1.3.
-
-
class
discord.
ActivityType
¶ Specifies the type of
Activity
. This is used to check how to interpret the activity itself.-
unknown
¶ An unknown activity type. This should generally not happen.
-
playing
¶ A “Playing” activity type.
-
streaming
¶ A “Streaming” activity type.
-
listening
¶ A “Listening” activity type.
-
watching
¶ A “Watching” activity type.
-
custom
¶ A custom activity type.
-
competing
¶ A competing activity type.
New in version 1.5.
-
-
class
discord.
HypeSquadHouse
¶ Specifies the HypeSquad house a user belongs to.
-
bravery
¶ The “Bravery” house.
-
brilliance
¶ The “Brilliance” house.
-
balance
¶ The “Balance” house.
-
-
class
discord.
VoiceRegion
¶ Specifies the region a voice server belongs to.
-
amsterdam
¶ The Amsterdam region.
-
brazil
¶ The Brazil region.
-
dubai
¶ The Dubai region.
New in version 1.3.
-
eu_central
¶ The EU Central region.
-
eu_west
¶ The EU West region.
-
europe
¶ The Europe region.
New in version 1.3.
-
frankfurt
¶ The Frankfurt region.
-
hongkong
¶ The Hong Kong region.
-
india
¶ The India region.
New in version 1.2.
-
japan
¶ The Japan region.
-
london
¶ The London region.
-
russia
¶ The Russia region.
-
singapore
¶ The Singapore region.
-
southafrica
¶ The South Africa region.
-
south_korea
¶ The South Korea region.
-
sydney
¶ The Sydney region.
-
us_central
¶ The US Central region.
-
us_east
¶ The US East region.
-
us_south
¶ The US South region.
-
us_west
¶ The US West region.
-
vip_amsterdam
¶ The Amsterdam region for VIP guilds.
-
vip_us_east
¶ The US East region for VIP guilds.
-
vip_us_west
¶ The US West region for VIP guilds.
-
-
class
discord.
VerificationLevel
¶ Specifies a
Guild
’s verification level, which is the criteria in which a member must meet before being able to send messages to the guild.-
x == y
Checks if two verification levels are equal.
-
x != y
Checks if two verification levels are not equal.
-
x > y
Checks if a verification level is higher than another.
-
x < y
Checks if a verification level is lower than another.
-
x >= y
Checks if a verification level is higher or equal to another.
-
x <= y
Checks if a verification level is lower or equal to another.
-
none
¶ No criteria set.
-
low
¶ Member must have a verified email on their Discord account.
-
medium
¶ Member must have a verified email and be registered on Discord for more than five minutes.
-
high
¶ Member must have a verified email, be registered on Discord for more than five minutes, and be a member of the guild itself for more than ten minutes.
-
extreme
¶ Member must have a verified phone on their Discord account.
-
-
class
discord.
NotificationLevel
¶ Specifies whether a
Guild
has notifications on for all messages or mentions only by default.-
all_messages
¶ Members receive notifications for every message regardless of them being mentioned.
-
only_mentions
¶ Members receive notifications for messages they are mentioned in.
-
-
class
discord.
ContentFilter
¶ Specifies a
Guild
’s explicit content filter, which is the machine learning algorithms that Discord uses to detect if an image contains pornography or otherwise explicit content.-
x == y
Checks if two content filter levels are equal.
-
x != y
Checks if two content filter levels are not equal.
-
x > y
Checks if a content filter level is higher than another.
-
x < y
Checks if a content filter level is lower than another.
-
x >= y
Checks if a content filter level is higher or equal to another.
-
x <= y
Checks if a content filter level is lower or equal to another.
-
disabled
¶ The guild does not have the content filter enabled.
-
no_role
¶ The guild has the content filter enabled for members without a role.
-
all_members
¶ The guild has the content filter enabled for every member.
-
-
class
discord.
Status
¶ Specifies a
Member
‘s status.-
online
¶ The member is online.
-
offline
¶ The member is offline.
-
idle
¶ The member is idle.
-
dnd
¶ The member is “Do Not Disturb”.
-
invisible
¶ The member is “invisible”. In reality, this is only used in sending a presence a la
Client.change_presence()
. When you receive a user’s presence this will beoffline
instead.
-
-
class
discord.
AuditLogAction
¶ Represents the type of action being done for a
AuditLogEntry
, which is retrievable viaGuild.audit_logs()
.-
guild_update
¶ The guild has updated. Things that trigger this include:
Changing the guild vanity URL
Changing the guild invite splash
Changing the guild AFK channel or timeout
Changing the guild voice server region
Changing the guild icon
Changing the guild moderation settings
Changing things related to the guild widget
When this is the action, the type of
target
is theGuild
.Possible attributes for
AuditLogDiff
:
-
channel_create
¶ A new channel was created.
When this is the action, the type of
target
is either aabc.GuildChannel
orObject
with an ID.A more filled out object in the
Object
case can be found by usingafter
.Possible attributes for
AuditLogDiff
:
-
channel_update
¶ A channel was updated. Things that trigger this include:
The channel name or topic was changed
The channel bitrate was changed
When this is the action, the type of
target
is theabc.GuildChannel
orObject
with an ID.A more filled out object in the
Object
case can be found by usingafter
orbefore
.Possible attributes for
AuditLogDiff
:
-
channel_delete
¶ A channel was deleted.
When this is the action, the type of
target
is anObject
with an ID.A more filled out object can be found by using the
before
object.Possible attributes for
AuditLogDiff
:
-
overwrite_create
¶ A channel permission overwrite was created.
When this is the action, the type of
target
is theabc.GuildChannel
orObject
with an ID.When this is the action, the type of
extra
is either aRole
orMember
. If the object is not found then it is aObject
with an ID being filled, a name, and atype
attribute set to either'role'
or'member'
to help dictate what type of ID it is.Possible attributes for
AuditLogDiff
:
-
overwrite_update
¶ A channel permission overwrite was changed, this is typically when the permission values change.
See
overwrite_create
for more information on how thetarget
andextra
fields are set.Possible attributes for
AuditLogDiff
:
-
overwrite_delete
¶ A channel permission overwrite was deleted.
See
overwrite_create
for more information on how thetarget
andextra
fields are set.Possible attributes for
AuditLogDiff
:
-
kick
¶ A member was kicked.
When this is the action, the type of
target
is theUser
who got kicked.When this is the action,
changes
is empty.
-
member_prune
¶ A member prune was triggered.
When this is the action, the type of
target
is set toNone
.When this is the action, the type of
extra
is set to an unspecified proxy object with two attributes:delete_members_days
: An integer specifying how far the prune was.members_removed
: An integer specifying how many members were removed.
When this is the action,
changes
is empty.
-
ban
¶ A member was banned.
When this is the action, the type of
target
is theUser
who got banned.When this is the action,
changes
is empty.
-
unban
¶ A member was unbanned.
When this is the action, the type of
target
is theUser
who got unbanned.When this is the action,
changes
is empty.
-
member_update
¶ A member has updated. This triggers in the following situations:
A nickname was changed
They were server muted or deafened (or it was undo’d)
When this is the action, the type of
target
is theMember
orUser
who got updated.Possible attributes for
AuditLogDiff
:
-
member_role_update
¶ A member’s role has been updated. This triggers when a member either gains a role or losses a role.
When this is the action, the type of
target
is theMember
orUser
who got the role.Possible attributes for
AuditLogDiff
:
-
member_move
¶ A member’s voice channel has been updated. This triggers when a member is moved to a different voice channel.
When this is the action, the type of
extra
is set to an unspecified proxy object with two attributes:channel
: ATextChannel
orObject
with the channel ID where the members were moved.count
: An integer specifying how many members were moved.
New in version 1.3.
-
member_disconnect
¶ A member’s voice state has changed. This triggers when a member is force disconnected from voice.
When this is the action, the type of
extra
is set to an unspecified proxy object with one attribute:count
: An integer specifying how many members were disconnected.
New in version 1.3.
-
bot_add
¶ A bot was added to the guild.
When this is the action, the type of
target
is theMember
orUser
which was added to the guild.New in version 1.3.
-
role_create
¶ A new role was created.
When this is the action, the type of
target
is theRole
or aObject
with the ID.Possible attributes for
AuditLogDiff
:
-
role_update
¶ A role was updated. This triggers in the following situations:
The name has changed
The permissions have changed
The colour has changed
Its hoist/mentionable state has changed
When this is the action, the type of
target
is theRole
or aObject
with the ID.Possible attributes for
AuditLogDiff
:
-
role_delete
¶ A role was deleted.
When this is the action, the type of
target
is theRole
or aObject
with the ID.Possible attributes for
AuditLogDiff
:
-
invite_create
¶ An invite was created.
When this is the action, the type of
target
is theInvite
that was created.Possible attributes for
AuditLogDiff
:
-
invite_update
¶ An invite was updated.
When this is the action, the type of
target
is theInvite
that was updated.
-
invite_delete
¶ An invite was deleted.
When this is the action, the type of
target
is theInvite
that was deleted.Possible attributes for
AuditLogDiff
:
-
webhook_create
¶ A webhook was created.
When this is the action, the type of
target
is theObject
with the webhook ID.Possible attributes for
AuditLogDiff
:
-
webhook_update
¶ A webhook was updated. This trigger in the following situations:
The webhook name changed
The webhook channel changed
When this is the action, the type of
target
is theObject
with the webhook ID.Possible attributes for
AuditLogDiff
:
-
webhook_delete
¶ A webhook was deleted.
When this is the action, the type of
target
is theObject
with the webhook ID.Possible attributes for
AuditLogDiff
:
-
emoji_create
¶ An emoji was created.
When this is the action, the type of
target
is theEmoji
orObject
with the emoji ID.Possible attributes for
AuditLogDiff
:
-
emoji_update
¶ An emoji was updated. This triggers when the name has changed.
When this is the action, the type of
target
is theEmoji
orObject
with the emoji ID.Possible attributes for
AuditLogDiff
:
-
emoji_delete
¶ An emoji was deleted.
When this is the action, the type of
target
is theObject
with the emoji ID.Possible attributes for
AuditLogDiff
:
-
message_delete
¶ A message was deleted by a moderator. Note that this only triggers if the message was deleted by someone other than the author.
When this is the action, the type of
target
is theMember
orUser
who had their message deleted.When this is the action, the type of
extra
is set to an unspecified proxy object with two attributes:count
: An integer specifying how many messages were deleted.channel
: ATextChannel
orObject
with the channel ID where the message got deleted.
-
message_bulk_delete
¶ Messages were bulk deleted by a moderator.
When this is the action, the type of
target
is theTextChannel
orObject
with the ID of the channel that was purged.When this is the action, the type of
extra
is set to an unspecified proxy object with one attribute:count
: An integer specifying how many messages were deleted.
New in version 1.3.
-
message_pin
¶ A message was pinned in a channel.
When this is the action, the type of
target
is theMember
orUser
who had their message pinned.When this is the action, the type of
extra
is set to an unspecified proxy object with two attributes:channel
: ATextChannel
orObject
with the channel ID where the message was pinned.message_id
: the ID of the message which was pinned.
New in version 1.3.
-
message_unpin
¶ A message was unpinned in a channel.
When this is the action, the type of
target
is theMember
orUser
who had their message unpinned.When this is the action, the type of
extra
is set to an unspecified proxy object with two attributes:channel
: ATextChannel
orObject
with the channel ID where the message was unpinned.message_id
: the ID of the message which was unpinned.
New in version 1.3.
-
integration_create
¶ A guild integration was created.
When this is the action, the type of
target
is theObject
with the integration ID of the integration which was created.New in version 1.3.
-
-
class
discord.
AuditLogActionCategory
¶ Represents the category that the
AuditLogAction
belongs to.This can be retrieved via
AuditLogEntry.category
.-
create
¶ The action is the creation of something.
-
delete
¶ The action is the deletion of something.
-
update
¶ The action is the update of something.
-
-
class
discord.
RelationshipType
¶ Specifies the type of
Relationship
.Note
This only applies to users, not bots.
-
friend
¶ You are friends with this user.
-
blocked
¶ You have blocked this user.
-
incoming_request
¶ The user has sent you a friend request.
-
outgoing_request
¶ You have sent a friend request to this user.
-
-
class
discord.
UserContentFilter
¶ Represents the options found in
Settings > Privacy & Safety > Safe Direct Messaging
in the Discord client.Note
This only applies to users, not bots.
-
all_messages
¶ Scan all direct messages from everyone.
-
friends
¶ Scan all direct messages that aren’t from friends.
-
disabled
¶ Don’t scan any direct messages.
-
-
class
discord.
FriendFlags
¶ Represents the options found in
Settings > Privacy & Safety > Who Can Add You As A Friend
in the Discord client.Note
This only applies to users, not bots.
-
noone
¶ This allows no-one to add you as a friend.
-
mutual_guilds
¶ This allows guild members to add you as a friend.
-
mutual_friends
¶ This allows friends of friends to add you as a friend.
-
guild_and_friends
¶ This is a superset of
mutual_guilds
andmutual_friends
.
-
everyone
¶ This allows everyone to add you as a friend.
-
-
class
discord.
PremiumType
¶ Represents the user’s Discord Nitro subscription type.
Note
This only applies to users, not bots.
-
nitro
¶ Represents the Discord Nitro with Nitro-exclusive games.
-
nitro_classic
¶ Represents the Discord Nitro with no Nitro-exclusive games.
-
-
class
discord.
Theme
¶ Represents the theme synced across all Discord clients.
Note
This only applies to users, not bots.
-
light
¶ Represents the Light theme on Discord.
-
dark
¶ Represents the Dark theme on Discord.
-
-
class
discord.
TeamMembershipState
¶ Represents the membership state of a team member retrieved through
Bot.application_info()
.New in version 1.3.
-
invited
¶ Represents an invited member.
-
accepted
¶ Represents a member currently in the team.
-
-
class
discord.
WebhookType
¶ Represents the type of webhook that can be received.
New in version 1.3.
-
incoming
¶ Represents a webhook that can post messages to channels with a token.
-
channel_follower
¶ Represents a webhook that is internally managed by Discord, used for following channels.
-
-
class
discord.
ExpireBehaviour
¶ Represents the behaviour the
Integration
should perform when a user’s subscription has finished.There is an alias for this called
ExpireBehavior
.New in version 1.4.
-
remove_role
¶ This will remove the
Integration.role
from the user when their subscription is finished.
-
kick
¶ This will kick the user when their subscription is finished.
-
-
class
discord.
DefaultAvatar
¶ Represents the default avatar of a Discord
User
-
blurple
¶ Represents the default avatar with the color blurple. See also
Colour.blurple
-
grey
¶ Represents the default avatar with the color grey. See also
Colour.greyple
-
green
¶ Represents the default avatar with the color green. See also
Colour.green
-
orange
¶ Represents the default avatar with the color orange. See also
Colour.orange
-
red
¶ Represents the default avatar with the color red. See also
Colour.red
-
Async Iterator¶
Some API functions return an “async iterator”. An async iterator is something that is capable of being used in an async for statement.
These async iterators can be used as follows:
async for elem in channel.history():
# do stuff with elem here
Certain utilities make working with async iterators easier, detailed below.
-
class
discord.
AsyncIterator
¶ Represents the “AsyncIterator” concept. Note that no such class exists, it is purely abstract.
-
async for x in y
Iterates over the contents of the async iterator.
-
await
next
()¶ This function is a coroutine.
Advances the iterator by one, if possible. If no more items are found then this raises
NoMoreItems
.
-
await
get
(**attrs)¶ This function is a coroutine.
Similar to
utils.get()
except run over the async iterator.Getting the last message by a user named ‘Dave’ or
None
:msg = await channel.history().get(author__name='Dave')
-
await
find
(predicate)¶ This function is a coroutine.
Similar to
utils.find()
except run over the async iterator.Unlike
utils.find()
, the predicate provided can be a coroutine.Getting the last audit log with a reason or
None
:def predicate(event): return event.reason is not None event = await guild.audit_logs().find(predicate)
- Parameters
predicate – The predicate to use. Could be a coroutine.
- Returns
The first element that returns
True
for the predicate orNone
.
-
await
flatten
()¶ This function is a coroutine.
Flattens the async iterator into a
list
with all the elements.- Returns
A list of every element in the async iterator.
- Return type
-
chunk
(max_size)¶ Collects items into chunks of up to a given maximum size. Another
AsyncIterator
is returned which collects items intolist
s of a given size. The maximum chunk size must be a positive integer.New in version 1.6.
Collecting groups of users:
async for leader, *users in reaction.users().chunk(3): ...
Warning
The last chunk collected may not be as large as
max_size
.- Parameters
max_size – The size of individual chunks.
- Return type
-
map
(func)¶ This is similar to the built-in
map
function. AnotherAsyncIterator
is returned that executes the function on every element it is iterating over. This function can either be a regular function or a coroutine.Creating a content iterator:
def transform(message): return message.content async for content in channel.history().map(transform): message_length = len(content)
- Parameters
func – The function to call on every element. Could be a coroutine.
- Return type
-
filter
(predicate)¶ This is similar to the built-in
filter
function. AnotherAsyncIterator
is returned that filters over the original async iterator. This predicate can be a regular function or a coroutine.Getting messages by non-bot accounts:
def predicate(message): return not message.author.bot async for elem in channel.history().filter(predicate): ...
- Parameters
predicate – The predicate to call on every element. Could be a coroutine.
- Return type
-
Audit Log Data¶
Working with Guild.audit_logs()
is a complicated process with a lot of machinery
involved. The library attempts to make it easy to use and friendly. In order to accomplish
this goal, it must make use of a couple of data classes that aid in this goal.
AuditLogEntry¶
-
class
discord.
AuditLogEntry
(*, users, data, guild)¶ Represents an Audit Log entry.
You retrieve these via
Guild.audit_logs()
.-
action
¶ The action that was done.
- Type
-
target
¶ The target that got changed. The exact type of this depends on the action being done.
- Type
Any
-
extra
¶ Extra information that this entry has that might be useful. For most actions, this is
None
. However in some cases it contains extra information. SeeAuditLogAction
for which actions have this field filled out.- Type
Any
-
created_at
¶ Returns the entry’s creation time in UTC.
- Type
-
category
¶ The category of the action, if applicable.
- Type
Optional[
AuditLogActionCategory
]
-
changes
¶ The list of changes this entry has.
- Type
-
before
¶ The target’s prior state.
- Type
-
after
¶ The target’s subsequent state.
- Type
-
AuditLogChanges¶
-
class
discord.
AuditLogChanges
¶ An audit log change set.
-
before
¶ The old value. The attribute has the type of
AuditLogDiff
.Depending on the
AuditLogActionCategory
retrieved bycategory
, the data retrieved by this attribute differs:
-
after
¶ The new value. The attribute has the type of
AuditLogDiff
.Depending on the
AuditLogActionCategory
retrieved bycategory
, the data retrieved by this attribute differs:
-
AuditLogDiff¶
- afk_channel
- afk_timeout
- allow
- avatar
- bitrate
- channel
- code
- color
- colour
- deaf
- default_message_notifications
- default_notifications
- deny
- explicit_content_filter
- hoist
- icon
- id
- inviter
- max_age
- max_uses
- mentionable
- mfa_level
- mute
- name
- nick
- overwrites
- owner
- permissions
- position
- region
- roles
- slowmode_delay
- splash
- system_channel
- temporary
- topic
- type
- uses
- vanity_url_code
- verification_level
- widget_channel
- widget_enabled
-
class
discord.
AuditLogDiff
¶ Represents an audit log “change” object. A change object has dynamic attributes that depend on the type of action being done. Certain actions map to certain attributes being set.
Note that accessing an attribute that does not match the specified action will lead to an attribute error.
To get a list of attributes that have been set, you can iterate over them. To see a list of all possible attributes that could be set based on the action being done, check the documentation for
AuditLogAction
, otherwise check the documentation below for all attributes that are possible.-
iter(diff)
Returns an iterator over (attribute, value) tuple of this diff.
-
icon
¶ A guild’s icon hash. See also
Guild.icon
.- Type
-
splash
¶ The guild’s invite splash hash. See also
Guild.splash
.- Type
-
owner
¶ The guild’s owner. See also
Guild.owner
-
region
¶ The guild’s voice region. See also
Guild.region
.- Type
-
afk_channel
¶ The guild’s AFK channel.
If this could not be found, then it falls back to a
Object
with the ID being set.See
Guild.afk_channel
.- Type
Union[
VoiceChannel
,Object
]
-
system_channel
¶ The guild’s system channel.
If this could not be found, then it falls back to a
Object
with the ID being set.See
Guild.system_channel
.- Type
Union[
TextChannel
,Object
]
-
afk_timeout
¶ The guild’s AFK timeout. See
Guild.afk_timeout
.- Type
-
mfa_level
¶ The guild’s MFA level. See
Guild.mfa_level
.- Type
-
widget_channel
¶ The widget’s channel.
If this could not be found then it falls back to a
Object
with the ID being set.- Type
Union[
TextChannel
,Object
]
-
verification_level
¶ The guild’s verification level.
See also
Guild.verification_level
.- Type
-
default_notifications
¶ The guild’s default notification level.
See also
Guild.default_notifications
.- Type
-
explicit_content_filter
¶ The guild’s content filter.
See also
Guild.explicit_content_filter
.- Type
-
vanity_url_code
¶ The guild’s vanity URL.
See also
Guild.vanity_invite()
andGuild.edit()
.- Type
-
position
¶ The position of a
Role
orabc.GuildChannel
.- Type
-
type
¶ The type of channel or channel permission overwrite.
If the type is an
int
, then it is a type of channel which can be either0
to indicate a text channel or1
to indicate a voice channel.If the type is a
str
, then it is a type of permission overwrite which can be either'role'
or'member'
.
-
topic
¶ The topic of a
TextChannel
.See also
TextChannel.topic
.- Type
-
bitrate
¶ The bitrate of a
VoiceChannel
.See also
VoiceChannel.bitrate
.- Type
-
overwrites
¶ A list of permission overwrite tuples that represents a target and a
PermissionOverwrite
for said target.The first element is the object being targeted, which can either be a
Member
orUser
orRole
. If this object is not found then it is aObject
with an ID being filled and atype
attribute set to either'role'
or'member'
to help decide what type of ID it is.- Type
List[Tuple[target,
PermissionOverwrite
]]
-
roles
¶ A list of roles being added or removed from a member.
If a role is not found then it is a
Object
with the ID and name being filled in.
-
nick
¶ The nickname of a member.
See also
Member.nick
- Type
Optional[
str
]
-
deaf
¶ Whether the member is being server deafened.
See also
VoiceState.deaf
.- Type
-
mute
¶ Whether the member is being server muted.
See also
VoiceState.mute
.- Type
-
permissions
¶ The permissions of a role.
See also
Role.permissions
.- Type
-
colour
¶ -
color
¶ The colour of a role.
See also
Role.colour
- Type
-
hoist
¶ Whether the role is being hoisted or not.
See also
Role.hoist
- Type
-
mentionable
¶ Whether the role is mentionable or not.
See also
Role.mentionable
- Type
-
code
¶ The invite’s code.
See also
Invite.code
- Type
-
channel
¶ A guild channel.
If the channel is not found then it is a
Object
with the ID being set. In some cases the channel name is also set.- Type
Union[
abc.GuildChannel
,Object
]
-
inviter
¶ The user who created the invite.
See also
Invite.inviter
.- Type
-
max_uses
¶ The invite’s max uses.
See also
Invite.max_uses
.- Type
-
uses
¶ The invite’s current uses.
See also
Invite.uses
.- Type
-
max_age
¶ The invite’s max age in seconds.
See also
Invite.max_age
.- Type
-
temporary
¶ If the invite is a temporary invite.
See also
Invite.temporary
.- Type
-
avatar
¶ The avatar hash of a member.
See also
User.avatar
.- Type
-
slowmode_delay
¶ The number of seconds members have to wait before sending another message in the channel.
See also
TextChannel.slowmode_delay
.- Type
-
Webhook Support¶
discord.py offers support for creating, editing, and executing webhooks through the Webhook
class.
Webhook¶
- clsWebhook.from_url
- clsWebhook.partial
- defavatar_url_as
- defdelete
- defdelete_message
- defedit
- defedit_message
- defexecute
- defsend
-
class
discord.
Webhook
(data, *, adapter, state=None)¶ Represents a Discord webhook.
Webhooks are a form to send messages to channels in Discord without a bot user or authentication.
There are two main ways to use Webhooks. The first is through the ones received by the library such as
Guild.webhooks()
andTextChannel.webhooks()
. The ones received by the library will automatically have an adapter bound using the library’s HTTP session. Those webhooks will havesend()
,delete()
andedit()
as coroutines.The second form involves creating a webhook object manually without having it bound to a websocket connection using the
from_url()
orpartial()
classmethods. This form allows finer grained control over how requests are done, allowing you to mix async and sync code using either aiohttp or requests.For example, creating a webhook from a URL and using aiohttp:
from discord import Webhook, AsyncWebhookAdapter import aiohttp async def foo(): async with aiohttp.ClientSession() as session: webhook = Webhook.from_url('url-here', adapter=AsyncWebhookAdapter(session)) await webhook.send('Hello World', username='Foo')
Or creating a webhook from an ID and token and using requests:
import requests from discord import Webhook, RequestsWebhookAdapter webhook = Webhook.partial(123456, 'abcdefg', adapter=RequestsWebhookAdapter()) webhook.send('Hello World', username='Foo')
-
x == y
Checks if two webhooks are equal.
-
x != y
Checks if two webhooks are not equal.
-
hash(x)
Returns the webhooks’s hash.
Changed in version 1.4: Webhooks are now comparable and hashable.
-
type
¶ The type of the webhook.
New in version 1.3.
- Type
-
token
¶ The authentication token of the webhook. If this is
None
then the webhook cannot be used to make requests.- Type
Optional[
str
]
-
user
¶ The user this webhook was created by. If the webhook was received without authentication then this will be
None
.- Type
Optional[
abc.User
]
-
classmethod
partial
(id, token, *, adapter)¶ Creates a partial
Webhook
.- Parameters
id (
int
) – The ID of the webhook.token (
str
) – The authentication token of the webhook.adapter (
WebhookAdapter
) – The webhook adapter to use when sending requests. This is typicallyAsyncWebhookAdapter
for aiohttp orRequestsWebhookAdapter
for requests.
- Returns
A partial
Webhook
. A partial webhook is just a webhook object with an ID and a token.- Return type
-
classmethod
from_url
(url, *, adapter)¶ Creates a partial
Webhook
from a webhook URL.- Parameters
url (
str
) – The URL of the webhook.adapter (
WebhookAdapter
) – The webhook adapter to use when sending requests. This is typicallyAsyncWebhookAdapter
for aiohttp orRequestsWebhookAdapter
for requests.
- Raises
InvalidArgument – The URL is invalid.
- Returns
A partial
Webhook
. A partial webhook is just a webhook object with an ID and a token.- Return type
-
guild
¶ The guild this webhook belongs to.
If this is a partial webhook, then this will always return
None
.- Type
Optional[
Guild
]
-
channel
¶ The text channel this webhook belongs to.
If this is a partial webhook, then this will always return
None
.- Type
Optional[
TextChannel
]
-
created_at
¶ Returns the webhook’s creation time in UTC.
- Type
-
avatar_url
¶ Returns an
Asset
for the avatar the webhook has.If the webhook does not have a traditional avatar, an asset for the default avatar is returned instead.
This is equivalent to calling
avatar_url_as()
with the default parameters.- Type
-
avatar_url_as
(*, format=None, size=1024)¶ Returns an
Asset
for the avatar the webhook has.If the webhook does not have a traditional avatar, an asset for the default avatar is returned instead.
The format must be one of ‘jpeg’, ‘jpg’, or ‘png’. The size must be a power of 2 between 16 and 1024.
- Parameters
- Raises
InvalidArgument – Bad image format passed to
format
or invalidsize
.- Returns
The resulting CDN asset.
- Return type
-
delete
(*, reason=None)¶ This function could be a coroutine.
Deletes this Webhook.
If the webhook is constructed with a
RequestsWebhookAdapter
then this is not a coroutine.- Parameters
reason (Optional[
str
]) –The reason for deleting this webhook. Shows up on the audit log.
New in version 1.4.
- Raises
HTTPException – Deleting the webhook failed.
NotFound – This webhook does not exist.
Forbidden – You do not have permissions to delete this webhook.
InvalidArgument – This webhook does not have a token associated with it.
-
edit
(*, reason=None, **kwargs)¶ This function could be a coroutine.
Edits this Webhook.
If the webhook is constructed with a
RequestsWebhookAdapter
then this is not a coroutine.- Parameters
name (Optional[
str
]) – The webhook’s new default name.avatar (Optional[
bytes
]) – A bytes-like object representing the webhook’s new default avatar.reason (Optional[
str
]) –The reason for editing this webhook. Shows up on the audit log.
New in version 1.4.
- Raises
HTTPException – Editing the webhook failed.
NotFound – This webhook does not exist.
InvalidArgument – This webhook does not have a token associated with it.
-
send
(content=None, *, wait=False, username=None, avatar_url=None, tts=False, file=None, files=None, embed=None, embeds=None, allowed_mentions=None)¶ This function could be a coroutine.
Sends a message using the webhook.
If the webhook is constructed with a
RequestsWebhookAdapter
then this is not a coroutine.The content must be a type that can convert to a string through
str(content)
.To upload a single file, the
file
parameter should be used with a singleFile
object.If the
embed
parameter is provided, it must be of typeEmbed
and it must be a rich embed type. You cannot mix theembed
parameter with theembeds
parameter, which must be alist
ofEmbed
objects to send.- Parameters
content (
str
) – The content of the message to send.wait (
bool
) – Whether the server should wait before sending a response. This essentially means that the return type of this function changes fromNone
to aWebhookMessage
if set toTrue
.username (
str
) – The username to send with this message. If no username is provided then the default username for the webhook is used.avatar_url (Union[
str
,Asset
]) – The avatar URL to send with this message. If no avatar URL is provided then the default avatar for the webhook is used.tts (
bool
) – Indicates if the message should be sent using text-to-speech.file (
File
) – The file to upload. This cannot be mixed withfiles
parameter.files (List[
File
]) – A list of files to send with the content. This cannot be mixed with thefile
parameter.embed (
Embed
) – The rich embed for the content to send. This cannot be mixed withembeds
parameter.embeds (List[
Embed
]) – A list of embeds to send with the content. Maximum of 10. This cannot be mixed with theembed
parameter.allowed_mentions (
AllowedMentions
) –Controls the mentions being processed in this message.
New in version 1.4.
- Raises
HTTPException – Sending the message failed.
NotFound – This webhook was not found.
Forbidden – The authorization token for the webhook is incorrect.
InvalidArgument – You specified both
embed
andembeds
or the length ofembeds
was invalid or there was no token associated with this webhook.
- Returns
The message that was sent.
- Return type
Optional[
WebhookMessage
]
-
edit_message
(message_id, **fields)¶ This function could be a coroutine.
Edits a message owned by this webhook.
This is a lower level interface to
WebhookMessage.edit()
in case you only have an ID.New in version 1.6.
- Parameters
message_id (
int
) – The message ID to edit.content (Optional[
str
]) – The content to edit the message with orNone
to clear it.embeds (List[
Embed
]) – A list of embeds to edit the message with.embed (Optional[
Embed
]) – The embed to edit the message with.None
suppresses the embeds. This should not be mixed with theembeds
parameter.allowed_mentions (
AllowedMentions
) – Controls the mentions being processed in this message. Seeabc.Messageable.send()
for more information.
- Raises
HTTPException – Editing the message failed.
Forbidden – Edited a message that is not yours.
InvalidArgument – You specified both
embed
andembeds
or the length ofembeds
was invalid or there was no token associated with this webhook.
-
delete_message
(message_id)¶ This function could be a coroutine.
Deletes a message owned by this webhook.
This is a lower level interface to
WebhookMessage.delete()
in case you only have an ID.New in version 1.6.
- Parameters
message_id (
int
) – The message ID to delete.- Raises
HTTPException – Deleting the message failed.
Forbidden – Deleted a message that is not yours.
-
WebhookMessage¶
-
class
discord.
WebhookMessage
(*, state, channel, data)¶ Represents a message sent from your webhook.
This allows you to edit or delete a message sent by your webhook.
This inherits from
discord.Message
with changes toedit()
anddelete()
to work.New in version 1.6.
-
edit
(**fields)¶ This function could be a coroutine.
Edits the message.
The content must be able to be transformed into a string via
str(content)
.New in version 1.6.
- Parameters
content (Optional[
str
]) – The content to edit the message with orNone
to clear it.embeds (List[
Embed
]) – A list of embeds to edit the message with.embed (Optional[
Embed
]) – The embed to edit the message with.None
suppresses the embeds. This should not be mixed with theembeds
parameter.allowed_mentions (
AllowedMentions
) – Controls the mentions being processed in this message. Seeabc.Messageable.send()
for more information.
- Raises
HTTPException – Editing the message failed.
Forbidden – Edited a message that is not yours.
InvalidArgument – You specified both
embed
andembeds
or the length ofembeds
was invalid or there was no token associated with this webhook.
-
delete
(*, delay=None)¶ This function is a coroutine.
Deletes the message.
- Parameters
delay (Optional[
float
]) – If provided, the number of seconds to wait before deleting the message. If this is a coroutine, the waiting is done in the background and deletion failures are ignored. If this is not a coroutine then the delay blocks the thread.- Raises
Forbidden – You do not have proper permissions to delete the message.
NotFound – The message was deleted already.
HTTPException – Deleting the message failed.
-
Adapters¶
Adapters allow you to change how the request should be handled. They all build on a single
interface, WebhookAdapter.request()
.
-
class
discord.
WebhookAdapter
¶ Base class for all webhook adapters.
-
request
(verb, url, payload=None, multipart=None)¶ Actually does the request.
Subclasses must implement this.
- Parameters
verb (
str
) – The HTTP verb to use for the request.url (
str
) – The URL to send the request to. This will have the query parameters already added to it, if any.multipart (Optional[
dict
]) – A dict containing multipart form data to send with the request. If a filename is being uploaded, then it will be under afile
key which will have a 3-elementtuple
denoting(filename, file, content_type)
.payload (Optional[
dict
]) – The JSON to send with the request, if any.
-
handle_execution_response
(data, *, wait)¶ Transforms the webhook execution response into something more meaningful.
This is mainly used to convert the data into a
Message
if necessary.Subclasses must implement this.
- Parameters
data – The data that was returned from the request.
wait (
bool
) – Whether the webhook execution was asked to wait or not.
-
-
class
discord.
AsyncWebhookAdapter
(session)¶ A webhook adapter suited for use with aiohttp.
Note
You are responsible for cleaning up the client session.
- Parameters
session (
aiohttp.ClientSession
) – The session to use to send requests.
-
await
request
(verb, url, payload=None, multipart=None, *, files=None, reason=None)¶ Actually does the request.
Subclasses must implement this.
- Parameters
verb (
str
) – The HTTP verb to use for the request.url (
str
) – The URL to send the request to. This will have the query parameters already added to it, if any.multipart (Optional[
dict
]) – A dict containing multipart form data to send with the request. If a filename is being uploaded, then it will be under afile
key which will have a 3-elementtuple
denoting(filename, file, content_type)
.payload (Optional[
dict
]) – The JSON to send with the request, if any.
-
await
handle_execution_response
(response, *, wait)¶ Transforms the webhook execution response into something more meaningful.
This is mainly used to convert the data into a
Message
if necessary.Subclasses must implement this.
- Parameters
data – The data that was returned from the request.
wait (
bool
) – Whether the webhook execution was asked to wait or not.
-
class
discord.
RequestsWebhookAdapter
(session=None, *, sleep=True)¶ A webhook adapter suited for use with
requests
.Only versions of requests higher than 2.13.0 are supported.
- Parameters
session (Optional[requests.Session]) – The requests session to use for sending requests. If not given then each request will create a new session. Note if a session is given, the webhook adapter will not clean it up for you. You must close the session yourself.
sleep (
bool
) – Whether to sleep the thread when encountering a 429 or pre-emptive rate limit or a 5xx status code. Defaults toTrue
. If set toFalse
then this will raise anHTTPException
instead.
-
request
(verb, url, payload=None, multipart=None, *, files=None, reason=None)¶ Actually does the request.
Subclasses must implement this.
- Parameters
verb (
str
) – The HTTP verb to use for the request.url (
str
) – The URL to send the request to. This will have the query parameters already added to it, if any.multipart (Optional[
dict
]) – A dict containing multipart form data to send with the request. If a filename is being uploaded, then it will be under afile
key which will have a 3-elementtuple
denoting(filename, file, content_type)
.payload (Optional[
dict
]) – The JSON to send with the request, if any.
-
handle_execution_response
(response, *, wait)¶ Transforms the webhook execution response into something more meaningful.
This is mainly used to convert the data into a
Message
if necessary.Subclasses must implement this.
- Parameters
data – The data that was returned from the request.
wait (
bool
) – Whether the webhook execution was asked to wait or not.
Abstract Base Classes¶
An abstract base class (also known as an abc
) is a class that models can inherit
to get their behaviour. The Python implementation of an abc is
slightly different in that you can register them at run-time. Abstract base classes cannot be instantiated.
They are mainly there for usage with isinstance()
and issubclass()
.
This library has a module related to abstract base classes, some of which are actually from the abc standard module, others which are not.
Snowflake¶
-
class
discord.abc.
Snowflake
¶ An ABC that details the common operations on a Discord model.
Almost all Discord models meet this abstract base class.
If you want to create a snowflake on your own, consider using
Object
.-
abstractmethod
created_at
¶ Returns the model’s creation time as a naive datetime in UTC.
- Type
-
abstractmethod
User¶
PrivateChannel¶
GuildChannel¶
- asyncclone
- asynccreate_invite
- asyncdelete
- asyncinvites
- defoverwrites_for
- defpermissions_for
- asyncset_permissions
-
class
discord.abc.
GuildChannel
¶ An ABC that details the common operations on a Discord guild channel.
The following implement this ABC:
This ABC must also implement
Snowflake
.-
position
¶ The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.
- Type
-
changed_roles
¶ Returns a list of roles that have been overridden from their default values in the
roles
attribute.- Type
List[
Role
]
-
created_at
¶ Returns the channel’s creation time in UTC.
- Type
-
overwrites_for
(obj)¶ Returns the channel-specific overwrites for a member or a role.
-
overwrites
¶ Returns all of the channel’s overwrites.
This is returned as a dictionary where the key contains the target which can be either a
Role
or aMember
and the value is the overwrite as aPermissionOverwrite
.- Returns
The channel’s permission overwrites.
- Return type
Mapping[Union[
Role
,Member
],PermissionOverwrite
]
-
category
¶ The category this channel belongs to.
If there is no category then this is
None
.- Type
Optional[
CategoryChannel
]
-
permissions_synced
¶ Whether or not the permissions for this channel are synced with the category it belongs to.
If there is no category then this is
False
.New in version 1.3.
- Type
-
permissions_for
(member)¶ Handles permission resolution for the current
Member
.This function takes into consideration the following cases:
Guild owner
Guild roles
Channel overrides
Member overrides
- Parameters
member (
Member
) – The member to resolve permissions for.- Returns
The resolved permissions for the member.
- Return type
-
await
delete
(*, reason=None)¶ This function is a coroutine.
Deletes the channel.
You must have
manage_channels
permission to use this.- Parameters
reason (Optional[
str
]) – The reason for deleting this channel. Shows up on the audit log.- Raises
Forbidden – You do not have proper permissions to delete the channel.
NotFound – The channel was not found or was already deleted.
HTTPException – Deleting the channel failed.
-
await
set_permissions
(target, *, overwrite=see - below, reason=None, **permissions)¶ This function is a coroutine.
Sets the channel specific permission overwrites for a target in the channel.
The
target
parameter should either be aMember
or aRole
that belongs to guild.The
overwrite
parameter, if given, must either beNone
orPermissionOverwrite
. For convenience, you can pass in keyword arguments denotingPermissions
attributes. If this is done, then you cannot mix the keyword arguments with theoverwrite
parameter.If the
overwrite
parameter isNone
, then the permission overwrites are deleted.You must have the
manage_roles
permission to use this.Examples
Setting allow and deny:
await message.channel.set_permissions(message.author, read_messages=True, send_messages=False)
Deleting overwrites
await channel.set_permissions(member, overwrite=None)
Using
PermissionOverwrite
overwrite = discord.PermissionOverwrite() overwrite.send_messages = False overwrite.read_messages = True await channel.set_permissions(member, overwrite=overwrite)
- Parameters
target (Union[
Member
,Role
]) – The member or role to overwrite permissions for.overwrite (Optional[
PermissionOverwrite
]) – The permissions to allow and deny to the target, orNone
to delete the overwrite.**permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with
overwrite
.reason (Optional[
str
]) – The reason for doing this action. Shows up on the audit log.
- Raises
Forbidden – You do not have permissions to edit channel specific permissions.
HTTPException – Editing channel specific permissions failed.
NotFound – The role or member being edited is not part of the guild.
InvalidArgument – The overwrite parameter invalid or the target type was not
Role
orMember
.
-
await
clone
(*, name=None, reason=None)¶ This function is a coroutine.
Clones this channel. This creates a channel with the same properties as this channel.
You must have the
manage_channels
permission to do this.New in version 1.1.
- Parameters
- Raises
Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.
- Returns
The channel that was created.
- Return type
-
await
create_invite
(*, reason=None, **fields)¶ This function is a coroutine.
Creates an instant invite from a text or voice channel.
You must have the
create_instant_invite
permission to do this.- Parameters
max_age (
int
) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to0
.max_uses (
int
) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to0
.temporary (
bool
) – Denotes that the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults toFalse
.unique (
bool
) – Indicates if a unique invite URL should be created. Defaults to True. If this is set toFalse
then it will return a previously created invite.reason (Optional[
str
]) – The reason for creating this invite. Shows up on the audit log.
- Raises
HTTPException – Invite creation failed.
NotFound – The channel that was passed is a category or an invalid channel.
- Returns
The invite that was created.
- Return type
-
await
invites
()¶ This function is a coroutine.
Returns a list of all active instant invites from this channel.
You must have
manage_channels
to get this information.- Raises
Forbidden – You do not have proper permissions to get the information.
HTTPException – An error occurred while fetching the information.
- Returns
The list of invites that are currently active.
- Return type
List[
Invite
]
-
Messageable¶
- asyncfetch_message
- defhistory
- asyncpins
- asyncsend
- asynctrigger_typing
- deftyping
-
class
discord.abc.
Messageable
¶ An ABC that details the common operations on a model that can send messages.
The following implement this ABC:
-
async for ... in
history
(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶ Returns an
AsyncIterator
that enables receiving the destination’s message history.You must have
read_message_history
permissions to use this.Examples
Usage
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
Flattening into a list:
messages = await channel.history(limit=123).flatten() # messages is now a list of Message...
All parameters are optional.
- Parameters
limit (Optional[
int
]) – The number of messages to retrieve. IfNone
, retrieves every message in the channel. Note, however, that this would make it a slow operation.before (Optional[Union[
Snowflake
,datetime.datetime
]]) – Retrieve messages before this date or message. If a date is provided it must be a timezone-naive datetime representing UTC time.after (Optional[Union[
Snowflake
,datetime.datetime
]]) – Retrieve messages after this date or message. If a date is provided it must be a timezone-naive datetime representing UTC time.around (Optional[Union[
Snowflake
,datetime.datetime
]]) – Retrieve messages around this date or message. If a date is provided it must be a timezone-naive datetime representing UTC time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.oldest_first (Optional[
bool
]) – If set toTrue
, return messages in oldest->newest order. Defaults toTrue
ifafter
is specified, otherwiseFalse
.
- Raises
Forbidden – You do not have permissions to get channel message history.
HTTPException – The request to get message history failed.
- Yields
Message
– The message with the message data parsed.
-
async with
typing
()¶ Returns a context manager that allows you to type for an indefinite period of time.
This is useful for denoting long computations in your bot.
Note
This is both a regular context manager and an async context manager. This means that both
with
andasync with
work with this.Example Usage:
async with channel.typing(): # do expensive stuff here await channel.send('done!')
-
await
send
(content=None, *, tts=False, embed=None, file=None, files=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None)¶ This function is a coroutine.
Sends a message to the destination with the content given.
The content must be a type that can convert to a string through
str(content)
. If the content is set toNone
(the default), then theembed
parameter must be provided.To upload a single file, the
file
parameter should be used with a singleFile
object. To upload multiple files, thefiles
parameter should be used with alist
ofFile
objects. Specifying both parameters will lead to an exception.If the
embed
parameter is provided, it must be of typeEmbed
and it must be a rich embed type.- Parameters
content (
str
) – The content of the message to send.tts (
bool
) – Indicates if the message should be sent using text-to-speech.embed (
Embed
) – The rich embed for the content.file (
File
) – The file to upload.files (List[
File
]) – A list of files to upload. Must be a maximum of 10.nonce (
int
) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.delete_after (
float
) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.allowed_mentions (
AllowedMentions
) –Controls the mentions being processed in this message. If this is passed, then the object is merged with
allowed_mentions
. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set inallowed_mentions
. If no object is passed at all then the defaults given byallowed_mentions
are used instead.New in version 1.4.
reference (Union[
Message
,MessageReference
]) –A reference to the
Message
to which you are replying, this can be created usingto_reference()
or passed directly as aMessage
. You can control whether this mentions the author of the referenced message using thereplied_user
attribute ofallowed_mentions
or by settingmention_author
.New in version 1.6.
mention_author (Optional[
bool
]) –If set, overrides the
replied_user
attribute ofallowed_mentions
.New in version 1.6.
- Raises
HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The
files
list is not of the appropriate size, you specified bothfile
andfiles
, or thereference
object is not aMessage
orMessageReference
.
- Returns
The message that was sent.
- Return type
-
await
trigger_typing
()¶ This function is a coroutine.
Triggers a typing indicator to the destination.
Typing indicator will go away after 10 seconds, or after a message is sent.
-
await
fetch_message
(id)¶ This function is a coroutine.
Retrieves a single
Message
from the destination.This can only be used by bot accounts.
- Parameters
id (
int
) – The message ID to look for.- Raises
NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.
- Returns
The message asked for.
- Return type
-
await
pins
()¶ This function is a coroutine.
Retrieves all messages that are currently pinned in the channel.
Note
Due to a limitation with the Discord API, the
Message
objects returned by this method do not contain completeMessage.reactions
data.- Raises
HTTPException – Retrieving the pinned messages failed.
- Returns
The messages that are currently pinned.
- Return type
List[
Message
]
-
async for ... in
Connectable¶
-
class
discord.abc.
Connectable
¶ An ABC that details the common operations on a channel that can connect to a voice server.
The following implement this ABC:
Discord Models¶
Models are classes that are received from Discord and are not meant to be created by the user of the library.
Danger
The classes listed below are not intended to be created by users and are also read-only.
For example, this means that you should not make your own User
instances
nor should you modify the User
instance yourself.
If you want to get one of these model classes instances they’d have to be through
the cache, and a common way of doing so is through the utils.find()
function
or attributes of model classes that you receive from the events specified in the
Event Reference.
Note
Nearly all classes here have __slots__ defined which means that it is impossible to have dynamic attributes to the data classes.
ClientUser¶
- defavatar_url_as
- asynccreate_group
- asyncedit
- asyncedit_settings
- defget_relationship
- defis_avatar_animated
- defmentioned_in
- defpermissions_in
-
class
discord.
ClientUser
¶ Represents your Discord user.
-
x == y
Checks if two users are equal.
-
x != y
Checks if two users are not equal.
-
hash(x)
Return the user’s hash.
-
str(x)
Returns the user’s name with discriminator.
-
system
¶ Specifies if the user is a system user (i.e. represents Discord officially).
New in version 1.3.
- Type
Specifies if the user is a premium user (e.g. has Discord Nitro).
- Type
Specifies the type of premium a user has (e.g. Nitro or Nitro Classic). Could be None if the user is not premium.
- Type
Optional[
PremiumType
]
-
get_relationship
(user_id)¶ Retrieves the
Relationship
if applicable.Note
This can only be used by non-bot accounts.
- Parameters
user_id (
int
) – The user ID to check if we have a relationship with them.- Returns
The relationship if available or
None
.- Return type
Optional[
Relationship
]
-
relationships
¶ Returns all the relationships that the user has.
Note
This can only be used by non-bot accounts.
- Type
List[
User
]
-
friends
¶ Returns all the users that the user is friends with.
Note
This can only be used by non-bot accounts.
- Type
List[
User
]
-
blocked
¶ Returns all the users that the user has blocked.
Note
This can only be used by non-bot accounts.
- Type
List[
User
]
-
await
edit
(**fields)¶ This function is a coroutine.
Edits the current profile of the client.
If a bot account is used then a password field is optional, otherwise it is required.
Note
To upload an avatar, a bytes-like object must be passed in that represents the image being uploaded. If this is done through a file then the file must be opened via
open('some_filename', 'rb')
and the bytes-like object is given through the use offp.read()
.The only image formats supported for uploading is JPEG and PNG.
- Parameters
password (
str
) – The current password for the client’s account. Only applicable to user accounts.new_password (
str
) – The new password you wish to change to. Only applicable to user accounts.email (
str
) – The new email you wish to change to. Only applicable to user accounts.house (Optional[
HypeSquadHouse
]) – The hypesquad house you wish to change to. Could beNone
to leave the current house. Only applicable to user accounts.username (
str
) – The new username you wish to change to.avatar (
bytes
) – A bytes-like object representing the image to upload. Could beNone
to denote no avatar.
- Raises
HTTPException – Editing your profile failed.
InvalidArgument – Wrong image format passed for
avatar
.ClientException – Password is required for non-bot accounts. House field was not a HypeSquadHouse.
-
await
create_group
(*recipients)¶ This function is a coroutine.
Creates a group direct message with the recipients provided. These recipients must be have a relationship of type
RelationshipType.friend
.Note
This can only be used by non-bot accounts.
- Parameters
*recipients (
User
) – An argumentlist
ofUser
to have in your group.- Raises
HTTPException – Failed to create the group direct message.
ClientException – Attempted to create a group with only one recipient. This does not include yourself.
- Returns
The new group channel.
- Return type
-
await
edit_settings
(**kwargs)¶ This function is a coroutine.
Edits the client user’s settings.
Note
This can only be used by non-bot accounts.
- Parameters
afk_timeout (
int
) – How long (in seconds) the user needs to be AFK until Discord sends push notifications to your mobile device.animate_emojis (
bool
) – Whether or not to animate emojis in the chat.convert_emoticons (
bool
) – Whether or not to automatically convert emoticons into emojis. e.g. :-) -> 😃default_guilds_restricted (
bool
) – Whether or not to automatically disable DMs between you and members of new guilds you join.detect_platform_accounts (
bool
) – Whether or not to automatically detect accounts from services like Steam and Blizzard when you open the Discord client.developer_mode (
bool
) – Whether or not to enable developer mode.disable_games_tab (
bool
) – Whether or not to disable the showing of the Games tab.enable_tts_command (
bool
) – Whether or not to allow tts messages to be played/sent.explicit_content_filter (
UserContentFilter
) – The filter for explicit content in all messages.friend_source_flags (
FriendFlags
) – Who can add you as a friend.gif_auto_play (
bool
) – Whether or not to automatically play gifs that are in the chat.guild_positions (List[
abc.Snowflake
]) – A list of guilds in order of the guild/guild icons that are on the left hand side of the UI.inline_attachment_media (
bool
) – Whether or not to display attachments when they are uploaded in chat.inline_embed_media (
bool
) – Whether or not to display videos and images from links posted in chat.locale (
str
) – The RFC 3066 language identifier of the locale to use for the language of the Discord client.message_display_compact (
bool
) – Whether or not to use the compact Discord display mode.render_embeds (
bool
) – Whether or not to render embeds that are sent in the chat.render_reactions (
bool
) – Whether or not to render reactions that are added to messages.restricted_guilds (List[
abc.Snowflake
]) – A list of guilds that you will not receive DMs from.show_current_game (
bool
) – Whether or not to display the game that you are currently playing.status (
Status
) – The clients status that is shown to others.theme (
Theme
) – The theme of the Discord UI.timezone_offset (
int
) – The timezone offset to use.
- Raises
HTTPException – Editing the settings failed.
Forbidden – The client is a bot user and not a user account.
- Returns
The client user’s updated settings.
- Return type
-
avatar_url
¶ Returns an
Asset
for the avatar the user has.If the user does not have a traditional avatar, an asset for the default avatar is returned instead.
This is equivalent to calling
avatar_url_as()
with the default parameters (i.e. webp/gif detection and a size of 1024).- Type
-
avatar_url_as
(*, format=None, static_format='webp', size=1024)¶ Returns an
Asset
for the avatar the user has.If the user does not have a traditional avatar, an asset for the default avatar is returned instead.
The format must be one of ‘webp’, ‘jpeg’, ‘jpg’, ‘png’ or ‘gif’, and ‘gif’ is only valid for animated avatars. The size must be a power of 2 between 16 and 4096.
- Parameters
format (Optional[
str
]) – The format to attempt to convert the avatar to. If the format isNone
, then it is automatically detected into either ‘gif’ or static_format depending on the avatar being animated or not.static_format (Optional[
str
]) – Format to attempt to convert only non-animated avatars to. Defaults to ‘webp’size (
int
) – The size of the image to display.
- Raises
InvalidArgument – Bad image format passed to
format
orstatic_format
, or invalidsize
.- Returns
The resulting CDN asset.
- Return type
-
color
¶ A property that returns a color denoting the rendered color for the user. This always returns
Colour.default()
.There is an alias for this named
colour
.- Type
-
colour
¶ A property that returns a colour denoting the rendered colour for the user. This always returns
Colour.default()
.There is an alias for this named
color
.- Type
-
created_at
¶ Returns the user’s creation time in UTC.
This is when the user’s Discord account was created.
- Type
-
default_avatar
¶ Returns the default avatar for a given user. This is calculated by the user’s discriminator.
- Type
-
display_name
¶ Returns the user’s display name.
For regular users this is just their username, but if they have a guild specific nickname then that is returned instead.
- Type
-
mentioned_in
(message)¶ Checks if the user is mentioned in the specified message.
-
permissions_in
(channel)¶ An alias for
abc.GuildChannel.permissions_for()
.Basically equivalent to:
channel.permissions_for(self)
- Parameters
channel (
abc.GuildChannel
) – The channel to check your permissions for.
-
public_flags
¶ The publicly available flags the user has.
- Type
-
Relationship¶
-
class
discord.
Relationship
¶ Represents a relationship in Discord.
A relationship is like a friendship, a person who is blocked, etc. Only non-bot accounts can have relationships.
-
type
¶ The type of relationship you have.
- Type
-
await
delete
()¶ This function is a coroutine.
Deletes the relationship.
- Raises
HTTPException – Deleting the relationship failed.
-
await
accept
()¶ This function is a coroutine.
Accepts the relationship request. e.g. accepting a friend request.
- Raises
HTTPException – Accepting the relationship failed.
-
User¶
- defavatar_url_as
- asyncblock
- asynccreate_dm
- asyncfetch_message
- defhistory
- defis_avatar_animated
- defis_blocked
- defis_friend
- defmentioned_in
- asyncmutual_friends
- defpermissions_in
- asyncpins
- asyncprofile
- asyncremove_friend
- asyncsend
- asyncsend_friend_request
- asynctrigger_typing
- deftyping
- asyncunblock
-
class
discord.
User
¶ Represents a Discord user.
-
x == y
Checks if two users are equal.
-
x != y
Checks if two users are not equal.
-
hash(x)
Return the user’s hash.
-
str(x)
Returns the user’s name with discriminator.
-
async for ... in
history
(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶ Returns an
AsyncIterator
that enables receiving the destination’s message history.You must have
read_message_history
permissions to use this.Examples
Usage
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
Flattening into a list:
messages = await channel.history(limit=123).flatten() # messages is now a list of Message...
All parameters are optional.
- Parameters
limit (Optional[
int
]) – The number of messages to retrieve. IfNone
, retrieves every message in the channel. Note, however, that this would make it a slow operation.before (Optional[Union[
Snowflake
,datetime.datetime
]]) – Retrieve messages before this date or message. If a date is provided it must be a timezone-naive datetime representing UTC time.after (Optional[Union[
Snowflake
,datetime.datetime
]]) – Retrieve messages after this date or message. If a date is provided it must be a timezone-naive datetime representing UTC time.around (Optional[Union[
Snowflake
,datetime.datetime
]]) – Retrieve messages around this date or message. If a date is provided it must be a timezone-naive datetime representing UTC time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.oldest_first (Optional[
bool
]) – If set toTrue
, return messages in oldest->newest order. Defaults toTrue
ifafter
is specified, otherwiseFalse
.
- Raises
Forbidden – You do not have permissions to get channel message history.
HTTPException – The request to get message history failed.
- Yields
Message
– The message with the message data parsed.
-
async with
typing
()¶ Returns a context manager that allows you to type for an indefinite period of time.
This is useful for denoting long computations in your bot.
Note
This is both a regular context manager and an async context manager. This means that both
with
andasync with
work with this.Example Usage:
async with channel.typing(): # do expensive stuff here await channel.send('done!')
-
dm_channel
¶ Returns the channel associated with this user if it exists.
If this returns
None
, you can create a DM channel by calling thecreate_dm()
coroutine function.- Type
Optional[
DMChannel
]
-
await
create_dm
()¶ Creates a
DMChannel
with this user.This should be rarely called, as this is done transparently for most people.
- Returns
The channel that was created.
- Return type
-
relationship
¶ Returns the
Relationship
with this user if applicable,None
otherwise.Note
This can only be used by non-bot accounts.
- Type
Optional[
Relationship
]
-
await
mutual_friends
()¶ This function is a coroutine.
Gets all mutual friends of this user.
Note
This can only be used by non-bot accounts.
- Raises
Forbidden – Not allowed to get mutual friends of this user.
HTTPException – Getting mutual friends failed.
- Returns
The users that are mutual friends.
- Return type
List[
User
]
-
is_friend
()¶ bool
: Checks if the user is your friend.Note
This can only be used by non-bot accounts.
-
await
block
()¶ This function is a coroutine.
Blocks the user.
Note
This can only be used by non-bot accounts.
- Raises
Forbidden – Not allowed to block this user.
HTTPException – Blocking the user failed.
-
await
unblock
()¶ This function is a coroutine.
Unblocks the user.
Note
This can only be used by non-bot accounts.
- Raises
Forbidden – Not allowed to unblock this user.
HTTPException – Unblocking the user failed.
-
await
remove_friend
()¶ This function is a coroutine.
Removes the user as a friend.
Note
This can only be used by non-bot accounts.
- Raises
Forbidden – Not allowed to remove this user as a friend.
HTTPException – Removing the user as a friend failed.
-
await
send_friend_request
()¶ This function is a coroutine.
Sends the user a friend request.
Note
This can only be used by non-bot accounts.
- Raises
Forbidden – Not allowed to send a friend request to the user.
HTTPException – Sending the friend request failed.
-
await
profile
()¶ This function is a coroutine.
Gets the user’s profile.
Note
This can only be used by non-bot accounts.
- Raises
Forbidden – Not allowed to fetch profiles.
HTTPException – Fetching the profile failed.
- Returns
The profile of the user.
- Return type
-
avatar_url
¶ Returns an
Asset
for the avatar the user has.If the user does not have a traditional avatar, an asset for the default avatar is returned instead.
This is equivalent to calling
avatar_url_as()
with the default parameters (i.e. webp/gif detection and a size of 1024).- Type
-
avatar_url_as
(*, format=None, static_format='webp', size=1024)¶ Returns an
Asset
for the avatar the user has.If the user does not have a traditional avatar, an asset for the default avatar is returned instead.
The format must be one of ‘webp’, ‘jpeg’, ‘jpg’, ‘png’ or ‘gif’, and ‘gif’ is only valid for animated avatars. The size must be a power of 2 between 16 and 4096.
- Parameters
format (Optional[
str
]) – The format to attempt to convert the avatar to. If the format isNone
, then it is automatically detected into either ‘gif’ or static_format depending on the avatar being animated or not.static_format (Optional[
str
]) – Format to attempt to convert only non-animated avatars to. Defaults to ‘webp’size (
int
) – The size of the image to display.
- Raises
InvalidArgument – Bad image format passed to
format
orstatic_format
, or invalidsize
.- Returns
The resulting CDN asset.
- Return type
-
color
¶ A property that returns a color denoting the rendered color for the user. This always returns
Colour.default()
.There is an alias for this named
colour
.- Type
-
colour
¶ A property that returns a colour denoting the rendered colour for the user. This always returns
Colour.default()
.There is an alias for this named
color
.- Type
-
created_at
¶ Returns the user’s creation time in UTC.
This is when the user’s Discord account was created.
- Type
-
default_avatar
¶ Returns the default avatar for a given user. This is calculated by the user’s discriminator.
- Type
-
display_name
¶ Returns the user’s display name.
For regular users this is just their username, but if they have a guild specific nickname then that is returned instead.
- Type
-
await
fetch_message
(id)¶ This function is a coroutine.
Retrieves a single
Message
from the destination.This can only be used by bot accounts.
- Parameters
id (
int
) – The message ID to look for.- Raises
NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.
- Returns
The message asked for.
- Return type
-
mentioned_in
(message)¶ Checks if the user is mentioned in the specified message.
-
permissions_in
(channel)¶ An alias for
abc.GuildChannel.permissions_for()
.Basically equivalent to:
channel.permissions_for(self)
- Parameters
channel (
abc.GuildChannel
) – The channel to check your permissions for.
-
await
pins
()¶ This function is a coroutine.
Retrieves all messages that are currently pinned in the channel.
Note
Due to a limitation with the Discord API, the
Message
objects returned by this method do not contain completeMessage.reactions
data.- Raises
HTTPException – Retrieving the pinned messages failed.
- Returns
The messages that are currently pinned.
- Return type
List[
Message
]
-
public_flags
¶ The publicly available flags the user has.
- Type
-
await
send
(content=None, *, tts=False, embed=None, file=None, files=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None)¶ This function is a coroutine.
Sends a message to the destination with the content given.
The content must be a type that can convert to a string through
str(content)
. If the content is set toNone
(the default), then theembed
parameter must be provided.To upload a single file, the
file
parameter should be used with a singleFile
object. To upload multiple files, thefiles
parameter should be used with alist
ofFile
objects. Specifying both parameters will lead to an exception.If the
embed
parameter is provided, it must be of typeEmbed
and it must be a rich embed type.- Parameters
content (
str
) – The content of the message to send.tts (
bool
) – Indicates if the message should be sent using text-to-speech.embed (
Embed
) – The rich embed for the content.file (
File
) – The file to upload.files (List[
File
]) – A list of files to upload. Must be a maximum of 10.nonce (
int
) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.delete_after (
float
) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.allowed_mentions (
AllowedMentions
) –Controls the mentions being processed in this message. If this is passed, then the object is merged with
allowed_mentions
. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set inallowed_mentions
. If no object is passed at all then the defaults given byallowed_mentions
are used instead.New in version 1.4.
reference (Union[
Message
,MessageReference
]) –A reference to the
Message
to which you are replying, this can be created usingto_reference()
or passed directly as aMessage
. You can control whether this mentions the author of the referenced message using thereplied_user
attribute ofallowed_mentions
or by settingmention_author
.New in version 1.6.
mention_author (Optional[
bool
]) –If set, overrides the
replied_user
attribute ofallowed_mentions
.New in version 1.6.
- Raises
HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The
files
list is not of the appropriate size, you specified bothfile
andfiles
, or thereference
object is not aMessage
orMessageReference
.
- Returns
The message that was sent.
- Return type
-
Attachment¶
- defis_spoiler
- asyncread
- asyncsave
- asyncto_file
-
class
discord.
Attachment
¶ Represents an attachment from Discord.
-
height
¶ The attachment’s height, in pixels. Only applicable to images and videos.
- Type
Optional[
int
]
-
url
¶ The attachment URL. If the message this attachment was attached to is deleted, then this will 404.
- Type
-
proxy_url
¶ The proxy URL. This is a cached version of the
url
in the case of images. When the message is deleted, this URL might be valid for a few minutes or not valid at all.- Type
-
await
save
(fp, *, seek_begin=True, use_cached=False)¶ This function is a coroutine.
Saves this attachment into a file-like object.
- Parameters
fp (Union[
io.BufferedIOBase
,os.PathLike
]) – The file-like object to save this attachment 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.use_cached (
bool
) – Whether to useproxy_url
rather thanurl
when downloading the attachment. This will allow attachments to be saved after deletion more often, compared to the regular URL which is generally deleted right after the message is deleted. Note that this can still fail to download deleted attachments if too much time has passed and it does not work on some types of attachments.
- Raises
HTTPException – Saving the attachment failed.
NotFound – The attachment was deleted.
- Returns
The number of bytes written.
- Return type
-
await
read
(*, use_cached=False)¶ This function is a coroutine.
Retrieves the content of this attachment as a
bytes
object.New in version 1.1.
- Parameters
use_cached (
bool
) – Whether to useproxy_url
rather thanurl
when downloading the attachment. This will allow attachments to be saved after deletion more often, compared to the regular URL which is generally deleted right after the message is deleted. Note that this can still fail to download deleted attachments if too much time has passed and it does not work on some types of attachments.- Raises
HTTPException – Downloading the attachment failed.
Forbidden – You do not have permissions to access this attachment
NotFound – The attachment was deleted.
- Returns
The contents of the attachment.
- Return type
-
await
to_file
(*, use_cached=False, spoiler=False)¶ This function is a coroutine.
Converts the attachment into a
File
suitable for sending viaabc.Messageable.send()
.New in version 1.3.
- Parameters
use_cached (
bool
) –Whether to use
proxy_url
rather thanurl
when downloading the attachment. This will allow attachments to be saved after deletion more often, compared to the regular URL which is generally deleted right after the message is deleted. Note that this can still fail to download deleted attachments if too much time has passed and it does not work on some types of attachments.New in version 1.4.
spoiler (
bool
) –Whether the file is a spoiler.
New in version 1.4.
- Raises
HTTPException – Downloading the attachment failed.
Forbidden – You do not have permissions to access this attachment
NotFound – The attachment was deleted.
- Returns
The attachment as a file suitable for sending.
- Return type
-
Asset¶
-
class
discord.
Asset
¶ Represents a CDN asset on Discord.
-
str(x)
Returns the URL of the CDN asset.
-
len(x)
Returns the length of the CDN asset’s URL.
-
bool(x)
Checks if the Asset has a URL.
-
x == y
Checks if the asset is equal to another asset.
-
x != y
Checks if the asset is not equal to another asset.
-
hash(x)
Returns the hash of the asset.
-
await
read
()¶ This function is a coroutine.
Retrieves the content of this asset as a
bytes
object.Warning
PartialEmoji
won’t have a connection state if user created, and a URL won’t be present if a custom image isn’t associated with the asset, e.g. a guild with no custom icon.New in version 1.1.
- Raises
DiscordException – There was no valid URL or internal connection state.
HTTPException – Downloading the asset failed.
NotFound – The asset was deleted.
- Returns
The content of the asset.
- Return type
-
await
save
(fp, *, seek_begin=True)¶ This function is a coroutine.
Saves this asset into a file-like object.
- Parameters
fp (Union[BinaryIO,
os.PathLike
]) – Same as inAttachment.save()
.seek_begin (
bool
) – Same as inAttachment.save()
.
- Raises
DiscordException – There was no valid URL or internal connection state.
HTTPException – Downloading the asset failed.
NotFound – The asset was deleted.
- Returns
The number of bytes written.
- Return type
-
Message¶
- activity
- application
- attachments
- author
- call
- channel
- channel_mentions
- clean_content
- content
- created_at
- edited_at
- embeds
- flags
- guild
- id
- jump_url
- mention_everyone
- mentions
- nonce
- pinned
- raw_channel_mentions
- raw_mentions
- raw_role_mentions
- reactions
- reference
- role_mentions
- stickers
- system_content
- tts
- type
- webhook_id
- asyncack
- asyncadd_reaction
- asyncclear_reaction
- asyncclear_reactions
- asyncdelete
- asyncedit
- defis_system
- asyncpin
- asyncpublish
- asyncremove_reaction
- asyncreply
- defto_reference
- asyncunpin
-
class
discord.
Message
¶ Represents a message from Discord.
-
x == y
Checks if two messages are equal.
-
x != y
Checks if two messages are not equal.
-
hash(x)
Returns the message’s hash.
-
tts
¶ Specifies if the message was done with text-to-speech. This can only be accurately received in
on_message()
due to a discord limitation.- Type
-
type
¶ The type of message. In most cases this should not be checked, but it is helpful in cases where it might be a system message for
system_content
.- Type
A
Member
that sent the message. Ifchannel
is a private channel or the user has the left the guild, then it is aUser
instead.- Type
-
nonce
¶ The value used by the discord guild and the client to verify that the message is successfully sent. This is typically non-important.
-
channel
¶ The
TextChannel
that the message was sent from. Could be aDMChannel
orGroupChannel
if it’s a private message.- Type
Union[
abc.Messageable
]
-
call
¶ The call that the message refers to. This is only applicable to messages of type
MessageType.call
.- Type
Optional[
CallMessage
]
-
reference
¶ The message that this message references. This is only applicable to messages of type
MessageType.pins_add
, crossposted messages created by a followed channel integration, or message replies.New in version 1.5.
- Type
Optional[
MessageReference
]
-
mention_everyone
¶ Specifies if the message mentions everyone.
Note
This does not check if the
@everyone
or the@here
text is in the message itself. Rather this boolean indicates if either the@everyone
or the@here
text is in the message and it did end up mentioning.- Type
-
mentions
¶ A list of
Member
that were mentioned. If the message is in a private message then the list will be ofUser
instead. For messages that are not of typeMessageType.default
, this array can be used to aid in system messages. For more information, seesystem_content
.Warning
The order of the mentions list is not in any particular order so you should not rely on it. This is a Discord limitation, not one with the library.
- Type
List[
abc.User
]
-
channel_mentions
¶ A list of
abc.GuildChannel
that were mentioned. If the message is in a private message then the list is always empty.- Type
List[
abc.GuildChannel
]
-
role_mentions
¶ A list of
Role
that were mentioned. If the message is in a private message then the list is always empty.- Type
List[
Role
]
-
webhook_id
¶ If this message was sent by a webhook, then this is the webhook ID’s that sent this message.
- Type
Optional[
int
]
-
attachments
¶ A list of attachments given to a message.
- Type
List[
Attachment
]
-
flags
¶ Extra features of the message.
New in version 1.3.
- Type
-
reactions
¶ Reactions to a message. Reactions can be either custom emoji or standard unicode emoji.
- Type
List[
Reaction
]
-
activity
¶ The activity associated with this message. Sent with Rich-Presence related messages that for example, request joining, spectating, or listening to or with another member.
It is a dictionary with the following optional keys:
type
: An integer denoting the type of message activity being requested.party_id
: The party ID associated with the party.
- Type
Optional[
dict
]
-
application
¶ The rich presence enabled application associated with this message.
It is a dictionary with the following keys:
id
: A string representing the application’s ID.name
: A string representing the application’s name.description
: A string representing the application’s description.icon
: A string representing the icon ID of the application.cover_image
: A string representing the embed’s image asset ID.
- Type
Optional[
dict
]
-
raw_mentions
¶ A property that returns an array of user IDs matched with the syntax of
<@user_id>
in the message content.This allows you to receive the user IDs of mentioned users even in a private message context.
- Type
List[
int
]
-
raw_channel_mentions
¶ A property that returns an array of channel IDs matched with the syntax of
<#channel_id>
in the message content.- Type
List[
int
]
-
raw_role_mentions
¶ A property that returns an array of role IDs matched with the syntax of
<@&role_id>
in the message content.- Type
List[
int
]
-
clean_content
¶ A property that returns the content in a “cleaned up” manner. This basically means that mentions are transformed into the way the client shows it. e.g.
<#id>
will transform into#name
.This will also transform @everyone and @here mentions into non-mentions.
Note
This does not escape markdown. If you want to escape markdown then use
utils.escape_markdown()
along with this function.- Type
-
created_at
¶ The message’s creation time in UTC.
- Type
-
edited_at
¶ A naive UTC datetime object containing the edited time of the message.
- Type
Optional[
datetime.datetime
]
-
system_content
¶ A property that returns the content that is rendered regardless of the
Message.type
.In the case of
MessageType.default
, this just returns the regularMessage.content
. Otherwise this returns an English message denoting the contents of the system message.- Type
-
await
delete
(*, delay=None)¶ This function is a coroutine.
Deletes the message.
Your own messages could be deleted without any proper permissions. However to delete other people’s messages, you need the
manage_messages
permission.Changed in version 1.1: Added the new
delay
keyword-only parameter.- Parameters
delay (Optional[
float
]) – If provided, the number of seconds to wait in the background before deleting the message. If the deletion fails then it is silently ignored.- Raises
Forbidden – You do not have proper permissions to delete the message.
NotFound – The message was deleted already
HTTPException – Deleting the message failed.
-
await
edit
(**fields)¶ This function is a coroutine.
Edits the message.
The content must be able to be transformed into a string via
str(content)
.Changed in version 1.3: The
suppress
keyword-only parameter was added.- Parameters
content (Optional[
str
]) – The new content to replace the message with. Could beNone
to remove the content.embed (Optional[
Embed
]) – The new embed to replace the original with. Could beNone
to remove the embed.suppress (
bool
) – Whether to suppress embeds for the message. This removes all the embeds if set toTrue
. If set toFalse
this brings the embeds back if they were suppressed. Using this parameter requiresmanage_messages
.delete_after (Optional[
float
]) – If provided, the number of seconds to wait in the background before deleting the message we just edited. If the deletion fails, then it is silently ignored.allowed_mentions (Optional[
AllowedMentions
]) –Controls the mentions being processed in this message. If this is passed, then the object is merged with
allowed_mentions
. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set inallowed_mentions
. If no object is passed at all then the defaults given byallowed_mentions
are used instead.New in version 1.4.
- Raises
HTTPException – Editing the message failed.
Forbidden – Tried to suppress a message without permissions or edited a message’s content or embed that isn’t yours.
-
await
publish
()¶ This function is a coroutine.
Publishes this message to your announcement channel.
If the message is not your own then the
manage_messages
permission is needed.- Raises
Forbidden – You do not have the proper permissions to publish this message.
HTTPException – Publishing the message failed.
-
await
pin
(*, reason=None)¶ This function is a coroutine.
Pins the message.
You must have the
manage_messages
permission to do this in a non-private channel context.- Parameters
reason (Optional[
str
]) –The reason for pinning the message. Shows up on the audit log.
New in version 1.4.
- Raises
Forbidden – You do not have permissions to pin the message.
NotFound – The message or channel was not found or deleted.
HTTPException – Pinning the message failed, probably due to the channel having more than 50 pinned messages.
-
await
unpin
(*, reason=None)¶ This function is a coroutine.
Unpins the message.
You must have the
manage_messages
permission to do this in a non-private channel context.- Parameters
reason (Optional[
str
]) –The reason for unpinning the message. Shows up on the audit log.
New in version 1.4.
- Raises
Forbidden – You do not have permissions to unpin the message.
NotFound – The message or channel was not found or deleted.
HTTPException – Unpinning the message failed.
-
await
add_reaction
(emoji)¶ This function is a coroutine.
Add a reaction to the message.
The emoji may be a unicode emoji or a custom guild
Emoji
.You must have the
read_message_history
permission to use this. If nobody else has reacted to the message using this emoji, theadd_reactions
permission is required.- Parameters
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) – The emoji to react with.- Raises
HTTPException – Adding the reaction failed.
Forbidden – You do not have the proper permissions to react to the message.
NotFound – The emoji you specified was not found.
InvalidArgument – The emoji parameter is invalid.
-
await
remove_reaction
(emoji, member)¶ This function is a coroutine.
Remove a reaction by the member from the message.
The emoji may be a unicode emoji or a custom guild
Emoji
.If the reaction is not your own (i.e.
member
parameter is not you) then themanage_messages
permission is needed.The
member
parameter must represent a member and meet theabc.Snowflake
abc.- Parameters
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) – The emoji to remove.member (
abc.Snowflake
) – The member for which to remove the reaction.
- Raises
HTTPException – Removing the reaction failed.
Forbidden – You do not have the proper permissions to remove the reaction.
NotFound – The member or emoji you specified was not found.
InvalidArgument – The emoji parameter is invalid.
-
await
clear_reaction
(emoji)¶ This function is a coroutine.
Clears a specific reaction from the message.
The emoji may be a unicode emoji or a custom guild
Emoji
.You need the
manage_messages
permission to use this.New in version 1.3.
- Parameters
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) – The emoji to clear.- Raises
HTTPException – Clearing the reaction failed.
Forbidden – You do not have the proper permissions to clear the reaction.
NotFound – The emoji you specified was not found.
InvalidArgument – The emoji parameter is invalid.
-
await
clear_reactions
()¶ This function is a coroutine.
Removes all the reactions from the message.
You need the
manage_messages
permission to use this.- Raises
HTTPException – Removing the reactions failed.
Forbidden – You do not have the proper permissions to remove all the reactions.
-
await
ack
()¶ This function is a coroutine.
Marks this message as read.
The user must not be a bot user.
- Raises
HTTPException – Acking failed.
ClientException – You must not be a bot user.
-
await
reply
(content=None, **kwargs)¶ This function is a coroutine.
A shortcut method to
abc.Messageable.send()
to reply to theMessage
.New in version 1.6.
- Raises
HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The
files
list is not of the appropriate size or you specified bothfile
andfiles
.
- Returns
The message that was sent.
- Return type
-
to_reference
()¶ Creates a
MessageReference
from the current message.New in version 1.6.
- Returns
The reference to this message.
- Return type
-
DeletedReferencedMessage¶
-
class
discord.
DeletedReferencedMessage
¶ A special sentinel type that denotes whether the resolved message referenced message had since been deleted.
The purpose of this class is to separate referenced messages that could not be fetched and those that were previously fetched but have since been deleted.
New in version 1.6.
Reaction¶
-
class
discord.
Reaction
¶ Represents a reaction to a message.
Depending on the way this object was created, some of the attributes can have a value of
None
.-
x == y
Checks if two reactions are equal. This works by checking if the emoji is the same. So two messages with the same reaction will be considered “equal”.
-
x != y
Checks if two reactions are not equal.
-
hash(x)
Returns the reaction’s hash.
-
str(x)
Returns the string form of the reaction’s emoji.
-
emoji
¶ The reaction emoji. May be a custom emoji, or a unicode emoji.
- Type
Union[
Emoji
,PartialEmoji
,str
]
-
async for ... in
users
(limit=None, after=None)¶ Returns an
AsyncIterator
representing the users that have reacted to the message.The
after
parameter must represent a member and meet theabc.Snowflake
abc.Examples
Usage
# I do not actually recommend doing this. async for user in reaction.users(): await channel.send('{0} has reacted with {1.emoji}!'.format(user, reaction))
Flattening into a list:
users = await reaction.users().flatten() # users is now a list of User... winner = random.choice(users) await channel.send('{} has won the raffle.'.format(winner))
- Parameters
limit (
int
) – The maximum number of results to return. If not provided, returns all the users who reacted to the message.after (
abc.Snowflake
) – For pagination, reactions are sorted by member.
- Raises
HTTPException – Getting the users for the reaction failed.
- Yields
Union[
User
,Member
] – The member (if retrievable) or the user that has reacted to this message. The case where it can be aMember
is in a guild message context. Sometimes it can be aUser
if the member has left the guild.
-
await
remove
(user)¶ This function is a coroutine.
Remove the reaction by the provided
User
from the message.If the reaction is not your own (i.e.
user
parameter is not you) then themanage_messages
permission is needed.The
user
parameter must represent a user or member and meet theabc.Snowflake
abc.- Parameters
user (
abc.Snowflake
) – The user or member from which to remove the reaction.- Raises
HTTPException – Removing the reaction failed.
Forbidden – You do not have the proper permissions to remove the reaction.
NotFound – The user you specified, or the reaction’s message was not found.
-
await
clear
()¶ This function is a coroutine.
Clears this reaction from the message.
You need the
manage_messages
permission to use this.New in version 1.3.
- Raises
HTTPException – Clearing the reaction failed.
Forbidden – You do not have the proper permissions to clear the reaction.
NotFound – The emoji you specified was not found.
InvalidArgument – The emoji parameter is invalid.
-
CallMessage¶
-
class
discord.
CallMessage
¶ Represents a group call message from Discord.
This is only received in cases where the message type is equivalent to
MessageType.call
.-
ended_timestamp
¶ A naive UTC datetime object that represents the time that the call has ended.
- Type
Optional[
datetime.datetime
]
-
channel
¶ The private channel associated with this message.
- Type
-
duration
¶ Queries the duration of the call.
If the call has not ended then the current duration will be returned.
- Returns
The timedelta object representing the duration.
- Return type
-
GroupCall¶
-
class
discord.
GroupCall
¶ Represents the actual group call from Discord.
This is accompanied with a
CallMessage
denoting the information.-
call
¶ The call message associated with this group call.
- Type
Denotes if this group call is unavailable.
- Type
-
region
¶ The guild region the group call is being hosted on.
- Type
-
channel
¶ Returns the channel the group call is in.
- Type
-
voice_state_for
(user)¶ Retrieves the
VoiceState
for a specifiedUser
.If the
User
has no voice state then this function returnsNone
.- Parameters
user (
User
) – The user to retrieve the voice state for.- Returns
The voice state associated with this user.
- Return type
Optional[
VoiceState
]
-
Guild¶
- afk_channel
- afk_timeout
- banner
- banner_url
- bitrate_limit
- categories
- channels
- chunked
- created_at
- default_notifications
- default_role
- description
- discovery_splash
- discovery_splash_url
- emoji_limit
- emojis
- explicit_content_filter
- features
- filesize_limit
- icon
- icon_url
- id
- large
- max_members
- max_presences
- max_video_channel_users
- me
- member_count
- members
- mfa_level
- name
- owner
- owner_id
- preferred_locale
- premium_subscriber_role
- premium_subscribers
- premium_subscription_count
- premium_tier
- public_updates_channel
- region
- roles
- rules_channel
- self_role
- shard_id
- splash
- splash_url
- system_channel
- system_channel_flags
- text_channels
- unavailable
- verification_level
- voice_channels
- voice_client
- asyncack
- defaudit_logs
- asyncban
- defbanner_url_as
- asyncbans
- defby_category
- asyncchange_voice_state
- asyncchunk
- asynccreate_category
- asynccreate_category_channel
- asynccreate_custom_emoji
- asynccreate_integration
- asynccreate_role
- asynccreate_text_channel
- asynccreate_voice_channel
- asyncdelete
- defdiscovery_splash_url_as
- asyncedit
- asyncedit_role_positions
- asyncestimate_pruned_members
- asyncfetch_ban
- asyncfetch_channels
- asyncfetch_emoji
- asyncfetch_emojis
- asyncfetch_member
- asyncfetch_members
- asyncfetch_roles
- defget_channel
- defget_member
- defget_member_named
- defget_role
- deficon_url_as
- asyncintegrations
- asyncinvites
- defis_icon_animated
- asynckick
- asyncleave
- asyncprune_members
- asyncquery_members
- defsplash_url_as
- asyncunban
- asyncvanity_invite
- asyncwebhooks
- asyncwidget
-
class
discord.
Guild
¶ Represents a Discord guild.
This is referred to as a “server” in the official Discord UI.
-
x == y
Checks if two guilds are equal.
-
x != y
Checks if two guilds are not equal.
-
hash(x)
Returns the guild’s hash.
-
str(x)
Returns the guild’s name.
-
region
¶ The region the guild belongs on. There is a chance that the region will be a
str
if the value is not recognised by the enumerator.- Type
-
afk_channel
¶ The channel that denotes the AFK channel.
None
if it doesn’t exist.- Type
Optional[
VoiceChannel
]
-
owner_id
¶ The guild owner’s ID. Use
Guild.owner
instead.- Type
Indicates if the guild is unavailable. If this is
True
then the reliability of other attributes outside ofGuild.id()
is slim and they might all beNone
. It is best to not do anything with the guild if it is unavailable.Check the
on_guild_unavailable()
andon_guild_available()
events.- Type
-
max_members
¶ The maximum amount of members for the guild.
Note
This attribute is only available via
Client.fetch_guild()
.- Type
Optional[
int
]
-
max_video_channel_users
¶ The maximum amount of users in a video channel.
New in version 1.4.
- Type
Optional[
int
]
The guild’s banner.
- Type
Optional[
str
]
-
mfa_level
¶ Indicates the guild’s two factor authorisation level. If this value is 0 then the guild does not require 2FA for their administrative members. If the value is 1 then they do.
- Type
-
verification_level
¶ The guild’s verification level.
- Type
-
explicit_content_filter
¶ The guild’s explicit content filter.
- Type
-
default_notifications
¶ The guild’s notification settings.
- Type
-
features
¶ A list of features that the guild has. They are currently as follows:
VIP_REGIONS
: Guild has VIP voice regionsVANITY_URL
: Guild can have a vanity invite URL (e.g. discord.gg/discord-api)INVITE_SPLASH
: Guild’s invite page can have a special splash.VERIFIED
: Guild is a verified server.PARTNERED
: Guild is a partnered server.MORE_EMOJI
: Guild is allowed to have more than 50 custom emoji.DISCOVERABLE
: Guild shows up in Server Discovery.FEATURABLE
: Guild is able to be featured in Server Discovery.COMMUNITY
: Guild is a community server.COMMERCE
: Guild can sell things using store channels.PUBLIC
: Guild is a public guild.NEWS
: Guild can create news channels.BANNER
: Guild can upload and use a banner (i.e.banner_url()
).ANIMATED_ICON
: Guild can upload an animated icon.PUBLIC_DISABLED
: Guild cannot be public.WELCOME_SCREEN_ENABLED
: Guild has enabled the welcome screenMEMBER_VERIFICATION_GATE_ENABLED
: Guild has Membership Screening enabled.PREVIEW_ENABLED
: Guild can be viewed before being accepted via Membership Screening.
- Type
List[
str
]
The premium tier for this guild. Corresponds to “Nitro Server” in the official UI. The number goes from 0 to 3 inclusive.
- Type
The number of “boosts” this guild currently has.
- Type
-
preferred_locale
¶ The preferred locale for the guild. Used when filtering Server Discovery results to a specific language.
- Type
Optional[
str
]
-
async for ... in
audit_logs
(*, limit=100, before=None, after=None, oldest_first=None, user=None, action=None)¶ Returns an
AsyncIterator
that enables receiving the guild’s audit logs.You must have the
view_audit_log
permission to use this.Examples
Getting the first 100 entries:
async for entry in guild.audit_logs(limit=100): print('{0.user} did {0.action} to {0.target}'.format(entry))
Getting entries for a specific action:
async for entry in guild.audit_logs(action=discord.AuditLogAction.ban): print('{0.user} banned {0.target}'.format(entry))
Getting entries made by a specific user:
entries = await guild.audit_logs(limit=None, user=guild.me).flatten() await channel.send('I made {} moderation actions.'.format(len(entries)))
- Parameters
limit (Optional[
int
]) – The number of entries to retrieve. IfNone
retrieve all entries.before (Union[
abc.Snowflake
,datetime.datetime
]) – Retrieve entries before this date or entry. If a date is provided it must be a timezone-naive datetime representing UTC time.after (Union[
abc.Snowflake
,datetime.datetime
]) – Retrieve entries after this date or entry. If a date is provided it must be a timezone-naive datetime representing UTC time.oldest_first (
bool
) – If set toTrue
, return entries in oldest->newest order. Defaults toTrue
ifafter
is specified, otherwiseFalse
.user (
abc.Snowflake
) – The moderator to filter entries from.action (
AuditLogAction
) – The action to filter with.
- Raises
Forbidden – You are not allowed to fetch audit logs
HTTPException – An error occurred while fetching the audit logs.
- Yields
AuditLogEntry
– The audit log entry.
-
channels
¶ A list of channels that belongs to this guild.
- Type
List[
abc.GuildChannel
]
-
large
¶ Indicates if the guild is a ‘large’ guild.
A large guild is defined as having more than
large_threshold
count members, which for this library is set to the maximum of 250.- Type
-
voice_channels
¶ A list of voice channels that belongs to this guild.
This is sorted by the position and are in UI order from top to bottom.
- Type
List[
VoiceChannel
]
-
me
¶ Similar to
Client.user
except an instance ofMember
. This is essentially used to get the member version of yourself.- Type
-
voice_client
¶ Returns the
VoiceProtocol
associated with this guild, if any.- Type
Optional[
VoiceProtocol
]
-
text_channels
¶ A list of text channels that belongs to this guild.
This is sorted by the position and are in UI order from top to bottom.
- Type
List[
TextChannel
]
-
categories
¶ A list of categories that belongs to this guild.
This is sorted by the position and are in UI order from top to bottom.
- Type
List[
CategoryChannel
]
-
by_category
()¶ Returns every
CategoryChannel
and their associated channels.These channels and categories are sorted in the official Discord UI order.
If the channels do not have a category, then the first element of the tuple is
None
.- Returns
The categories and their associated channels.
- Return type
List[Tuple[Optional[
CategoryChannel
], List[abc.GuildChannel
]]]
-
get_channel
(channel_id)¶ Returns a channel with the given ID.
- Parameters
channel_id (
int
) – The ID to search for.- Returns
The returned channel or
None
if not found.- Return type
Optional[
abc.GuildChannel
]
-
system_channel
¶ Returns the guild’s channel used for system messages.
If no channel is set, then this returns
None
.- Type
Optional[
TextChannel
]
-
system_channel_flags
¶ Returns the guild’s system channel settings.
- Type
-
rules_channel
¶ Return’s the guild’s channel used for the rules. The guild must be a Community guild.
If no channel is set, then this returns
None
.New in version 1.3.
- Type
Optional[
TextChannel
]
-
public_updates_channel
¶ Return’s the guild’s channel where admins and moderators of the guilds receive notices from Discord. The guild must be a Community guild.
If no channel is set, then this returns
None
.New in version 1.4.
- Type
Optional[
TextChannel
]
-
get_member
(user_id)¶ Returns a member with the given ID.
A list of members who have “boosted” this guild.
- Type
List[
Member
]
-
roles
¶ Returns a
list
of the guild’s roles in hierarchy order.The first element of this list will be the lowest role in the hierarchy.
- Type
List[
Role
]
-
get_role
(role_id)¶ Returns a role with the given ID.
Gets the premium subscriber role, AKA “boost” role, in this guild.
New in version 1.6.
- Type
Optional[
Role
]
-
self_role
¶ Gets the role associated with this client’s user, if any.
New in version 1.6.
- Type
Optional[
Role
]
-
icon_url_as
(*, format=None, static_format='webp', size=1024)¶ Returns an
Asset
for the guild’s icon.The format must be one of ‘webp’, ‘jpeg’, ‘jpg’, ‘png’ or ‘gif’, and ‘gif’ is only valid for animated avatars. The size must be a power of 2 between 16 and 4096.
- Parameters
format (Optional[
str
]) – The format to attempt to convert the icon to. If the format isNone
, then it is automatically detected into either ‘gif’ or static_format depending on the icon being animated or not.static_format (Optional[
str
]) – Format to attempt to convert only non-animated icons to.size (
int
) – The size of the image to display.
- Raises
InvalidArgument – Bad image format passed to
format
or invalidsize
.- Returns
The resulting CDN asset.
- Return type
Returns the guild’s banner asset.
- Type
Returns an
Asset
for the guild’s banner.The format must be one of ‘webp’, ‘jpeg’, or ‘png’. The size must be a power of 2 between 16 and 4096.
- Parameters
- Raises
InvalidArgument – Bad image format passed to
format
or invalidsize
.- Returns
The resulting CDN asset.
- Return type
-
splash_url_as
(*, format='webp', size=2048)¶ Returns an
Asset
for the guild’s invite splash.The format must be one of ‘webp’, ‘jpeg’, ‘jpg’, or ‘png’. The size must be a power of 2 between 16 and 4096.
- Parameters
- Raises
InvalidArgument – Bad image format passed to
format
or invalidsize
.- Returns
The resulting CDN asset.
- Return type
-
discovery_splash_url_as
(*, format='webp', size=2048)¶ Returns an
Asset
for the guild’s discovery splash.The format must be one of ‘webp’, ‘jpeg’, ‘jpg’, or ‘png’. The size must be a power of 2 between 16 and 4096.
New in version 1.3.
- Parameters
- Raises
InvalidArgument – Bad image format passed to
format
or invalidsize
.- Returns
The resulting CDN asset.
- Return type
-
member_count
¶ Returns the true member count regardless of it being loaded fully or not.
Warning
Due to a Discord limitation, in order for this attribute to remain up-to-date and accurate, it requires
Intents.members
to be specified.
-