Core

The core mechanisms for using all of the library’s components collaboratively.

client

class aiocord.client.HTTPMeddle(...)

Bases: Generic[_V]

Returned for all HTTP-related methods.

Facilitates editing a request’s options before it’s performed.

Useful for attaching request/request-specific headers.

``await``ing the instance will perform the request.

request = client.update_channel(channel_id, topic = 'silly fun')
request.set_reason('just so things dont get too serious')
channel = await request

set_reason(value)

Set the Audit Log Reason for executing this request.

class aiocord.client.GatewayCache(...)

Bases: Object

Holds objects during gateway connections.

user: User

guilds: Collection[Guild]

application: Application

class aiocord.client.Client(token=None, loads=<function loads>, dumps=<function dumps>)

Bases: object

Core means of interaction with the Discord API components.

Parameters:

• token – The type-less authentication token.

• loads – Used for converting json text to objects.

• dumps – Used for converting json objects to text.

property session: ClientSession

The session for making requests.

property http: Client

The HTTP client for executing routes.

property callbacks: Callable

The functions called upon receiving an event.

property shards: dict[int, Client]

The gateway clients againt their ids.

property cache: GatewayCache

The dispatch cache.

property voices: dict[Snowflake, Client]

The voice clients.

ready()

Wait until all shards are ready to dispatch events.

Return type:

Awaitable[None]

get_global_application_commands(application_id, /, **fields)

Use http.routes.get_global_application_commands.

Parameters:

with_localizations – Source: with_localizations

Return type:

HTTPMeddle[list[ApplicationCommand]]

create_global_application_command(application_id, /, **fields)

Use http.routes.create_global_application_command.

Parameters:

• name – Source: name

• name_localizations – Source: name_localizations

• description – Source: description

• description_localizations – Source: description_localizations

• options – Source: options

• default_member_permissions – Source: default_member_permissions

• dm_permission – Source: dm_permission

• type – Source: type

• nsfw – Source: nsfw

Return type:

HTTPMeddle[ApplicationCommand]

get_global_application_command(application_id, command_id, /, **fields)

Use http.routes.get_global_application_command.

Return type:

HTTPMeddle[ApplicationCommand]

update_global_application_command(application_id, command_id, /, **fields)

Use http.routes.update_global_application_command.

Parameters:

• name – Source: name

• name_localizations – Source: name_localizations

• description – Source: description

• description_localizations – Source: description_localizations

• options – Source: options

• default_member_permissions – Source: default_member_permissions

• dm_permission – Source: dm_permission

• default_permission – Source: default_permission

• nsfw – Source: nsfw

Return type:

HTTPMeddle[ApplicationCommand]

delete_global_application_command(application_id, command_id, /, **fields)

Use http.routes.delete_global_application_command.

Return type:

HTTPMeddle[None]

update_all_global_application_commands(application_id, /, commands)

Use http.routes.update_all_global_application_commands.

Return type:

HTTPMeddle[list[ApplicationCommand]]

get_guild_application_commands(application_id, guild_id, /, **fields)

Parameters:

localized – Source: with_localizations

Return type:

HTTPMeddle[list[ApplicationCommand]]

Use http.routes.get_guild_application_commands.

create_guild_application_command(application_id, guild_id, /, **fields)

Use http.routes.create_guild_application_command.

Parameters:

• name – Source: name

• name_localizations – Source: name_localizations

• description – Source: description

• description_localizations – Source: description_localizations

• options – Source: options

• default_member_permissions – Source: default_member_permissions

• default_permission – Source: default_permission

• type – Source: type

• nsfw – Source: nsfw

Return type:

HTTPMeddle[ApplicationCommand]

get_guild_application_command(application_id, guild_id, command_id, /, **fields)

Use http.routes.get_guild_application_command.

Return type:

HTTPMeddle[ApplicationCommand]

update_guild_application_command(application_id, guild_id, command_id, /, **fields)

Use http.routes.update_guild_application_command.

Parameters:

• name – Source: name

• name_localizations – Source: name_localizations

• description – Source: description

• description_localizations – Source: description_localizations

• options – Source: options

• default_member_permissions – Source: default_member_permissions

• default_permission – Source: default_permission

• nsfw – Source: nsfw

Return type:

HTTPMeddle[ApplicationCommand]

delete_guild_application_command(application_id, guild_id, command_id, /, **fields)

Use http.routes.delete_guild_application_command.

Return type:

HTTPMeddle[None]

update_all_guild_application_commands(application_id, guild_id, /, **fields)

Use http.routes.update_all_guild_application_commands.

Parameters:

• id – Source: id

• name – Source: name

• name_localizations – Source: name_localizations

• description – Source: description

• description_localizations – Source: description_localizations

• options – Source: options

• default_member_permissions – Source: default_member_permissions

• dm_permission – Source: dm_permission

• default_permission – Source: default_permission

• type – Source: type

• nsfw – Source: nsfw

Return type:

HTTPMeddle[list[ApplicationCommand]]

get_guild_application_command_permissions(application_id, guild_id, /, **fields)

Use http.routes.get_guild_application_command_permissions.

Return type:

HTTPMeddle[list[GuildApplicationCommandPermissions]]

get_application_command_permissions(application_id, guild_id, command_id, /, **fields)

Use http.routes.get_application_command_permissions.

Return type:

HTTPMeddle[GuildApplicationCommandPermissions]

update_application_command_permissions(application_id, guild_id, command_id, /, **fields)

Use http.routes.update_application_command_permissions.

Parameters:

permissions – Source: permissions

Return type:

HTTPMeddle[GuildApplicationCommandPermissions]

create_interaction_response(interaction_id, interaction_token, /, **fields)

Use http.routes.create_interaction_response.

Return type:

HTTPMeddle[None]

get_interaction_response(application_id, interaction_token, /, **fields)

Use http.routes.get_interaction_response.

Parameters:

thread_id – Source: thread_id

Return type:

HTTPMeddle[Message]

update_interaction_response(application_id, interaction_token, /, **fields)

Use http.routes.update_interaction_response.

Parameters:

• thread_id – Source: thread_id

• content – Source: content

• components – Source: components

• files – Source: files[n]

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

HTTPMeddle[Message]

delete_interaction_response(application_id, interaction_token, /, **fields)

Use http.routes.delete_interaction_response.

Return type:

HTTPMeddle[None]

create_followup_message(application_id, interaction_token, /, **fields)

Use http.routes.create_followup_message.

Parameters:

• thread_id – Source: thread_id

• content – Source: content

• username – Source: username

• avatar_url – Source: avatar_url

• tts – Source: tts

• components – Source: components

• files – Source: files[n]

• flags – Source: flags

• thread_name – Source: thread_name

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

HTTPMeddle[Message]

get_followup_message(application_id, interaction_token, message_id, /, **fields)

Use http.routes.get_followup_message.

Return type:

HTTPMeddle[Message]

update_followup_message(application_id, interaction_token, message_id, /, **fields)

Use http.routes.update_followup_message.

Parameters:

• thread_id – Source: thread_id

• content – Source: content

• components – Source: components

• files – Source: files[n]

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

HTTPMeddle[Message]

delete_followup_message(application_id, interaction_token, message_id, /, **fields)

Use http.routes.delete_followup_message.

Return type:

HTTPMeddle[None]

get_application_role_connection_metadata(application_id, /, **fields)

Use http.routes.get_application_role_connection_metadata.

Return type:

HTTPMeddle[list[ApplicationRoleConnectionMetadata]]

update_application_role_connection_metadata(application_id, /, **fields)

Use http.routes.update_application_role_connection_metadata.

Return type:

HTTPMeddle[list[ApplicationRoleConnectionMetadata]]

get_guild_audit_log(guild_id, /, **fields)

Use http.routes.get_guild_audit_log.

Parameters:

• user_id – Source: user_id

• action_type – Source: action_type

• before – Source: before

• after – Source: after

• limit – Source: limit

Return type:

HTTPMeddle[AuditLog]

get_guild_auto_moderation_rules(guild_id, /, **fields)

Use http.routes.get_guild_auto_moderation_rules.

Return type:

HTTPMeddle[list[AutoModerationRule]]

get_auto_moderation_rule(guild_id, auto_moderation_rule_id, /, **fields)

Use http.routes.get_auto_moderation_rule.

Return type:

HTTPMeddle[AutoModerationRule]

create_auto_moderation_rule(guild_id, /, **fields)

Use http.routes.create_auto_moderation_rule.

Parameters:

• name – Source: name

• event_type – Source: event_type

• trigger_type – Source: trigger_type

• enabled – Source: enabled

• exempt_roles – Source: exempt_roles

• exempt_channels – Source: exempt_channels

• trigger_metadata – Source: trigger_metadata

• actions – Source: actions

Return type:

HTTPMeddle[AutoModerationRule]

update_auto_moderation_rule(guild_id, auto_moderation_rule_id, /, **fields)

Use http.routes.update_auto_moderation_rule.

Parameters:

• name – Source: name

• event_type – Source: event_type

• enabled – Source: enabled

• exempt_roles – Source: exempt_roles

• exempt_channels – Source: exempt_channels

• trigger_metadata – Source: trigger_metadata

• actions – Source: actions

Return type:

HTTPMeddle[AutoModerationRule]

delete_auto_moderation_rule(guild_id, auto_moderation_rule_id, /, **fields)

Use http.routes.delete_auto_moderation_rule.

Return type:

HTTPMeddle[AutoModerationRule]

get_channel(channel_id, /, **fields)

Use http.routes.get_channel.

Return type:

HTTPMeddle[Channel]

update_channel(channel_id, /, **fields)

Use http.routes.update_channel.

Parameters:

• name – Source: name

• archived – Source: archived

• auto_archive_duration – Source: auto_archive_duration

• locked – Source: locked

• invitable – Source: invitable

• rate_limit_per_user – Source: rate_limit_per_user

• flags – Source: flags

• applied_tags – Source: applied_tags

Return type:

HTTPMeddle[Channel]

delete_channel(channel_id, /, **fields)

Use http.routes.delete_channel.

Return type:

HTTPMeddle[None]

get_messages(channel_id, /, **fields)

Use http.routes.get_messages.

Parameters:

• around – Source: around

• before – Source: before

• after – Source: after

• limit – Source: limit

Return type:

HTTPMeddle[list[Message]]

get_message(channel_id, message_id, /, **fields)

Use http.routes.get_message.

Return type:

HTTPMeddle[Message]

create_message(channel_id, /, **fields)

Use http.routes.create_message.

Parameters:

• content – Source: content

• nonce – Source: nonce

• tts – Source: tts

• message_reference – Source: message_reference

• sticker_ids – Source: sticker_ids

• files – Source: files[n]

• flags – Source: flags

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• components – Source: components

• attachments – Source: attachments

Return type:

HTTPMeddle[Message]

create_message_crosspost(channel_id, message_id, /, **fields)

Use http.routes.create_message_crosspost.

Return type:

HTTPMeddle[Message]

create_reaction(channel_id, message_id, emoji, /, **fields)

Use http.routes.create_reaction.

Return type:

HTTPMeddle[Reaction]

delete_own_reaction(channel_id, message_id, emoji, /, **fields)

Use http.routes.delete_own_reaction.

Return type:

HTTPMeddle[None]

delete_user_reaction(channel_id, message_id, emoji, user_id, /, **fields)

Use http.routes.delete_user_reaction.

Return type:

HTTPMeddle[None]

get_reactions(channel_id, message_id, emoji, /, **fields)

Use http.routes.get_reactions.

Parameters:

• after – Source: after

• limit – Source: limit

Return type:

HTTPMeddle[list[User]]

delete_all_reactions(channel_id, message_id, /, **fields)

Use http.routes.delete_all_reactions.

Return type:

HTTPMeddle[None]

delete_all_emoji_reactions(channel_id, message_id, emoji, /, **fields)

Use http.routes.delete_all_emoji_reactions.

Return type:

HTTPMeddle[None]

update_message(channel_id, message_id, /, **fields)

Use http.routes.update_message.

Parameters:

• content – Source: content

• flags – Source: flags

• components – Source: components

• files – Source: files[n]

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

HTTPMeddle[Message]

delete_message(channel_id, message_id, /, **fields)

Use http.routes.delete_message.

Return type:

HTTPMeddle[None]

delete_messages(channel_id, /, **fields)

Use http.routes.delete_messages.

Parameters:

message_ids – Source: messages

Return type:

HTTPMeddle[None]

update_channel_permissions(channel_id, overwrite_id, /, **fields)

Parameters:

• allow – Source: allow

• deny – Source: deny

• type – Source: type

Return type:

HTTPMeddle[None]

Use http.routes.update_channel_permissions.

get_channel_invites(channel_id, /, **fields)

Use http.routes.get_channel_invites.

Return type:

HTTPMeddle[list[Invite]]

create_channel_invite(channel_id, /, **fields)

Use http.routes.create_channel_invite.

Parameters:

• max_age – Source: max_age

• max_uses – Source: max_uses

• temporary – Source: temporary

• unique – Source: unique

• target_type – Source: target_type

• target_user_id – Source: target_user_id

• target_application_id – Source: target_application_id

Return type:

HTTPMeddle[Invite]

delete_channel_permission(channel_id, overwrite_id, /, **fields)

Use http.routes.delete_channel_permission.

Return type:

HTTPMeddle[None]

create_channel_follow(channel_id, /, **fields)

Use http.routes.create_channel_follow.

Parameters:

webhook_channel_id – Source: webhook_channel_id

Return type:

HTTPMeddle[FollowedChannel]

create_typing_indicator(channel_id, /, **fields)

Use http.routes.create_typing_indicator.

Return type:

HTTPMeddle[None]

get_channel_pins(channel_id, /, **fields)

Use http.routes.get_channel_pins.

Return type:

HTTPMeddle[list[Message]]

create_channel_pin(channel_id, message_id, /, **fields)

Use http.routes.create_channel_pin.

Return type:

HTTPMeddle[None]

delete_channel_pin(channel_id, message_id, /, **fields)

Use http.routes.delete_channel_pin.

Return type:

HTTPMeddle[None]

create_channel_recipient(channel_id, user_id, /, **fields)

Use http.routes.create_channel_recipient.

Parameters:

• access_token – Source: access_token

• nick – Source: nick

Return type:

HTTPMeddle[None]

delete_channel_recipient(channel_id, user_id, /, **fields)

Use http.routes.delete_channel_recipient.

Return type:

HTTPMeddle[None]

create_message_thread(channel_id, message_id, /, **fields)

Use http.routes.create_message_thread.

Parameters:

• name – Source: name

• auto_archive_duration – Source: auto_archive_duration

• rate_limit_per_user – Source: rate_limit_per_user

Return type:

HTTPMeddle[Channel]

create_thread(channel_id, /, **fields)

Use http.routes.create_thread.

Parameters:

• name – Source: name

• auto_archive_duration – Source: auto_archive_duration

• type – Source: type

• invitable – Source: invitable

• rate_limit_per_user – Source: rate_limit_per_user

• message – Source: message

• applied_tags – Source: applied_tags

create_self_thread_member(channel_id, /, **fields)

Use http.routes.create_self_thread_member.

Return type:

HTTPMeddle[None]

create_thread_member(channel_id, user_id, /, **fields)

Use http.routes.create_thread_member.

Return type:

HTTPMeddle[None]

delete_self_thread_member(channel_id, /, **fields)

Use http.routes.delete_self_thread_member.

Return type:

HTTPMeddle[None]

delete_thread_member(channel_id, user_id, /, **fields)

Use http.routes.delete_thread_member.

Return type:

HTTPMeddle[None]

get_thread_member(channel_id, user_id, /, **fields)

Use http.routes.get_thread_member.

Parameters:

with_member – Source: with_member

Return type:

HTTPMeddle[ThreadMember]

get_thread_members(channel_id, /, **fields)

When with_member is set to true, the results will be paginated and each thread member object will include a member field containing a guild member object.

Parameters:

• with_member – Source: with_member

• after – Source: after

• limit – Source: limit

Return type:

HTTPMeddle[list[ThreadMember]]

Use http.routes.get_thread_members.

get_public_archived_threads(channel_id, /, **fields)

Use http.routes.get_public_archived_threads.

Parameters:

• before – Source: before

• limit – Source: limit

Return type:

HTTPMeddle[get_public_archived_threads]

get_private_archived_threads(channel_id, /, **fields)

Use http.routes.get_private_archived_threads.

Parameters:

• before – Source: before

• limit – Source: limit

Return type:

HTTPMeddle[get_public_archived_threads]

get_self_private_archived_threads(channel_id, /, **fields)

Use http.routes.get_self_private_archived_threads.

Parameters:

• before – Source: before

• limit – Source: limit

Return type:

HTTPMeddle[get_self_private_archived_threads]

get_guild_emojis(guild_id, /, **fields)

Use http.routes.get_guild_emojis.

Return type:

HTTPMeddle[list[Emoji]]

get_guild_emoji(guild_id, emoji_id, /, **fields)

Use http.routes.get_guild_emoji.

Return type:

HTTPMeddle[Emoji]

create_guild_emoji(guild_id, /, **fields)

Use http.routes.create_guild_emoji.

Parameters:

• name – Source: name

• image – Source: image

• roles – Source: roles

Return type:

HTTPMeddle[Emoji]

update_guild_emoji(guild_id, emoji_id, /, **fields)

Use http.routes.update_guild_emoji.

Parameters:

• name – Source: name

• roles – Source: roles

Return type:

HTTPMeddle[Emoji]

delete_guild_emoji(guild_id, emoji_id, /, **fields)

Use http.routes.delete_guild_emoji.

Parameters:

• name – Source: name

• roles – Source: roles

Return type:

HTTPMeddle[None]

create_guild(**fields)

Use http.routes.create_guild.

Parameters:

• name – Source: name

• region – Source: region

• icon – Source: icon

• verification_level – Source: verification_level

• default_message_notifications – Source: default_message_notifications

• explicit_content_filter – Source: explicit_content_filter

• afk_channel_id – Source: afk_channel_id

• afk_timeout – Source: afk_timeout

• system_channel_id – Source: system_channel_id

• system_channel_flags – Source: system_channel_flags

• roles – Source: roles

• channels – Source: channels

Return type:

HTTPMeddle[Guild]

get_guild(guild_id, /, **fields)

Use http.routes.get_guild.

Parameters:

with_counts – Source: with_counts

Return type:

HTTPMeddle[Guild]

get_guild_preview(guild_id, /, **fields)

Use http.routes.get_guild_preview.

Return type:

HTTPMeddle[Guild]

update_guild(guild_id, /, **fields)

Use http.routes.update_guild.

Parameters:

• name – Source: name

• region – Source: region

• verification_level – Source: verification_level

• default_message_notifications – Source: default_message_notifications

• explicit_content_filter – Source: explicit_content_filter

• afk_channel_id – Source: afk_channel_id

• afk_timeout – Source: afk_timeout

• icon – Source: icon

• owner_id – Source: owner_id

• splash – Source: splash

• discovery_splash – Source: discovery_splash

• banner – Source: banner

• system_channel_id – Source: system_channel_id

• system_channel_flags – Source: system_channel_flags

• rules_channel_id – Source: rules_channel_id

• public_updates_channel_id – Source: public_updates_channel_id

• preferred_locale – Source: preferred_locale

• features – Source: features

• description – Source: description

• premium_progress_bar_enabled – Source: premium_progress_bar_enabled

Return type:

HTTPMeddle[Guild]

delete_guild(guild_id, /, **fields)

Use http.routes.delete_guild.

Return type:

HTTPMeddle[None]

get_guild_channels(guild_id, /, **fields)

Use http.routes.get_guild_channels.

Return type:

HTTPMeddle[list[Channel]]

create_guild_channel(guild_id, /, **fields)

Use http.routes.create_guild_channel.

Parameters:

• name – Source: name

• type – Source: type

• topic – Source: topic

• bitrate – Source: bitrate

• user_limit – Source: user_limit

• rate_limit_per_user – Source: rate_limit_per_user

• position – Source: position

• parent_id – Source: parent_id

• nsfw – Source: nsfw

• rtc_region – Source: rtc_region

• video_quality_mode – Source: video_quality_mode

• default_auto_archive_duration – Source: default_auto_archive_duration

• default_sort_order – Source: default_sort_order

• permission_overwrites – Source: permission_overwrites

• default_reaction_emoji – Source: default_reaction_emoji

• available_tags – Source: available_tags

Return type:

HTTPMeddle[Channel]

update_guild_channel_positions(guild_id, /, positions)

Use http.routes.update_guild_channel_positions.

Parameters:

positions (list[___update_guild_channel_positions_hint]) – An array of objects.

Return type:

HTTPMeddle[None]

Each element of positions must abide to the following:

Parameters:

• id – Source: id

• position – Source: position

• lock_permissions – Source: lock_permissions

• parent_id – Source: parent_id

get_active_guild_threads(guild_id, /, **fields)

Use http.routes.get_active_guild_threads.

Return type:

HTTPMeddle[get_active_guild_threads]

get_guild_member(guild_id, user_id, /, **fields)

Use http.routes.get_guild_member.

Return type:

HTTPMeddle[GuildMember]

get_guild_members(guild_id, /, **fields)

Use http.routes.get_guild_members.

Parameters:

• limit – Source: limit

• after – Source: after

Return type:

HTTPMeddle[GuildMember]

search_guild_members(guild_id, /, **fields)

Use http.routes.search_guild_members.

Parameters:

• query – Source: query

• limit – Source: limit

Return type:

HTTPMeddle[list[GuildMember]]

create_guild_member(guild_id, user_id, /, **fields)

Use http.routes.create_guild_member.

Parameters:

• access_token – Source: access_token

• nick – Source: nick

• roles – Source: roles

• mute – Source: mute

• deaf – Source: deaf

Return type:

HTTPMeddle[GuildMember]

update_guild_member(guild_id, user_id, /, **fields)

Use http.routes.update_guild_member.

Parameters:

• nick – Source: nick

• roles – Source: roles

• mute – Source: mute

• deaf – Source: deaf

• channel_id – Source: channel_id

• communication_disabled_until – Source: communication_disabled_until

• flags – Source: flags

Return type:

HTTPMeddle[GuildMember]

update_self_guild_member(guild_id, /, **fields)

Use http.routes.update_self_guild_member.

Parameters:

nick – Source: nick

Return type:

HTTPMeddle[GuildMember]

create_guild_member_role(guild_id, user_id, role_id, /, **fields)

Use http.routes.create_guild_member_role.

Return type:

HTTPMeddle[None]

delete_guild_member_role(guild_id, user_id, role_id, /, **fields)

Use http.routes.delete_guild_member_role.

Return type:

HTTPMeddle[None]

delete_guild_member(guild_id, user_id, /, **fields)

Use http.routes.delete_guild_member.

Return type:

HTTPMeddle[None]

get_guild_bans(guild_id, /, **fields)

Use http.routes.get_guild_bans.

Parameters:

• limit – Source: limit

• before – Source: before

• after – Source: after

Return type:

HTTPMeddle[list[Ban]]

get_guild_ban(guild_id, user_id, /, **fields)

Use http.routes.get_guild_ban.

Return type:

HTTPMeddle[Ban]

create_guild_ban(guild_id, user_id, /, **fields)

Use http.routes.create_guild_ban.

Return type:

HTTPMeddle[None]

delete_guild_ban(guild_id, user_id, /, **fields)

Use http.routes.delete_guild_ban.

Return type:

HTTPMeddle[None]

get_guild_roles(guild_id, /, **fields)

Use http.routes.get_guild_roles.

Return type:

HTTPMeddle[list[Role]]

get_guild_role(guild_id, role_id, /, **fields)

Use http.routes.get_guild_role.

Return type:

HTTPMeddle[list[Role]]

create_guild_role(guild_id, /, **fields)

Use http.routes.create_guild_role.

Parameters:

• name – Source: name

• permissions – Source: permissions

• color – Source: color

• hoist – Source: hoist

• icon – Source: icon

• unicode_emoji – Source: unicode_emoji

• mentionable – Source: mentionable

Return type:

HTTPMeddle[Role]

update_guild_role_positions(guild_id, /, positions)

Use http.routes.update_guild_role_positions.

Parameters:

positions (list[___update_guild_role_positions_hint]) – An array of objects.

Return type:

HTTPMeddle[list[Role]]

Each element of positions must abide to the following:

Parameters:

• id – Source: id

• position – Source: position

update_guild_role(guild_id, role_id, /, **fields)

Use http.routes.update_guild_role.

Parameters:

• name – Source: name

• permissions – Source: permissions

• color – Source: color

• hoist – Source: hoist

• icon – Source: icon

• unicode_emoji – Source: unicode_emoji

• mentionable – Source: mentionable

Return type:

HTTPMeddle[Role]

update_guild_mfa_level(guild_id, /, **fields)

Use http.routes.update_guild_mfa_level.

Parameters:

level – Source: level

Return type:

HTTPMeddle[GuildMFALevel]

delete_guild_role(guild_id, role_id, /, **fields)

Use http.routes.delete_guild_role.

Return type:

HTTPMeddle[None]

get_guild_prune_count(guild_id, /, **fields)

Use http.routes.get_guild_prune_count.

Parameters:

• days – Source: days

• include_roles – Source: include_roles

Return type:

HTTPMeddle[int]

start_guild_prune(guild_id, /, **fields)

Use http.routes.start_guild_prune.

Parameters:

• days – Source: days

• compute_prune_count – Source: compute_prune_count

• include_roles – Source: include_roles

• reason – Source: reason

Return type:

HTTPMeddle[int]

get_guild_voice_regions(guild_id, /, **fields)

Use http.routes.get_guild_voice_regions.

Return type:

HTTPMeddle[list[VoiceRegion]]

get_guild_invites(guild_id, /, **fields)

Use http.routes.get_guild_invites.

Return type:

HTTPMeddle[list[Invite]]

get_guild_integrations(guild_id, /, **fields)

Use http.routes.get_guild_integrations.

Return type:

HTTPMeddle[list[Integration]]

delete_guild_integration(guild_id, integration_id, /, **fields)

Use http.routes.delete_guild_integration.

Return type:

HTTPMeddle[None]

get_guild_widget_settings(guild_id, /, **fields)

Use http.routes.get_guild_widget_settings.

Return type:

HTTPMeddle[GuildWidgetSettings]

update_guild_widget(guild_id, /, **fields)

Use http.routes.update_guild_widget.

Return type:

HTTPMeddle[GuildWidgetSettings]

get_guild_widget(guild_id, /, **fields)

Use http.routes.get_guild_widget.

Return type:

HTTPMeddle[GuildWidget]

get_guild_vanity_url(guild_id, /, **fields)

Use http.routes.get_guild_vanity_url.

Return type:

HTTPMeddle[Invite]

get_guild_widget_image(guild_id, /, **fields)

Use http.routes.get_guild_widget_image.

Parameters:

style – Source: style

Return type:

HTTPMeddle[Any]

get_guild_welcome_screen(guild_id, /, **fields)

Use http.routes.get_guild_welcome_screen.

Return type:

HTTPMeddle[WelcomeScreen]

update_guild_welcome_screen(guild_id, /, **fields)

Use http.routes.update_guild_welcome_screen.

Parameters:

• enabled – Source: enabled

• description – Source: description

• welcome_channels – Source: welcome_channels

Return type:

HTTPMeddle[WelcomeScreen]

get_guild_onboarding(guild_id, /, **fields)

Use http.routes.get_guild_onboarding.

Return type:

HTTPMeddle[GuildOnboarding]

update_self_voice_state(guild_id, /, **fields)

Use http.routes.update_self_voice_state.

Parameters:

• channel_id – Source: channel_id

• suppress – Source: suppress

• request_to_speak_timestamp – Source: request_to_speak_timestamp

Return type:

HTTPMeddle[None]

update_voice_state(guild_id, user_id, /, **fields)

Use http.routes.update_voice_state.

Parameters:

• channel_id – Source: channel_id

• suppress – Source: suppress

• request_to_speak_timestamp – Source: request_to_speak_timestamp

Return type:

HTTPMeddle[None]

get_guild_scheduled_events(guild_id, /, **fields)

Use http.routes.get_guild_scheduled_events.

Parameters:

with_user_count – Source: with_user_count

Return type:

HTTPMeddle[GuildScheduledEvent]

create_guild_scheduled_event(guild_id, /, **fields)

Use http.routes.create_guild_scheduled_event.

Parameters:

• channel_id – Source: channel_id

• entity_metadata – Source: entity_metadata

• name – Source: name

• privacy_level – Source: privacy_level

• scheduled_start_time – Source: scheduled_start_time

• scheduled_end_time – Source: scheduled_end_time

• description – Source: description

• entity_type – Source: entity_type

• image – Source: image

Return type:

HTTPMeddle[GuildScheduledEvent]

get_guild_scheduled_event(guild_id, guild_scheduled_event_id, /, **fields)

Use http.routes.get_guild_scheduled_event.

Parameters:

with_user_count – Source: with_user_count

Return type:

HTTPMeddle[GuildScheduledEvent]

update_guild_scheduled_event(guild_id, guild_scheduled_event_id, /, **fields)

Use http.routes.update_guild_scheduled_event.

Parameters:

• channel_id – Source: channel_id

• entity_metadata – Source: entity_metadata

• name – Source: name

• privacy_level – Source: privacy_level

• scheduled_start_time – Source: scheduled_start_time

• scheduled_end_time – Source: scheduled_end_time

• description – Source: description

• entity_type – Source: entity_type

• status – Source: status

• image – Source: image

Return type:

HTTPMeddle[GuildScheduledEvent]

delete_guild_scheduled_event(guild_id, guild_scheduled_event_id, /, **fields)

Use http.routes.delete_guild_scheduled_event.

Return type:

HTTPMeddle[None]

get_guild_scheduled_event_users(guild_id, guild_scheduled_event_id, /, **fields)

Use http.routes.get_guild_scheduled_event_users

Return type:

HTTPMeddle[None]

get_guild_template(template_code, /, **fields)

Use http.routes.get_guild_template.

Return type:

HTTPMeddle[GuildTemplate]

create_guild_via_guild_template(template_code, /, **fields)

Use http.routes.create_guild_via_guild_template.

Parameters:

• name – Source: name

• icon – Source: icon

Return type:

HTTPMeddle[Guild]

get_guild_templates(guild_id, /, **fields)

Use http.routes.get_guild_templates.

Return type:

HTTPMeddle[list[GuildTemplate]]

create_guild_template(guild_id, /, **fields)

Use http.routes.create_guild_template.

Parameters:

• name – Source: name

• description – Source: description

Return type:

HTTPMeddle[GuildTemplate]

sync_guild_template(guild_id, template_code, /, **fields)

Use http.routes.sync_guild_template.

Return type:

HTTPMeddle[GuildTemplate]

update_guild_template(guild_id, template_code, /, **fields)

Use http.routes.update_guild_template.

Parameters:

• name – Source: name

• description – Source: description

Return type:

HTTPMeddle[GuildTemplate]

delete_guild_template(guild_id, template_code, /, **fields)

Use http.routes.delete_guild_template.

Parameters:

• name – Source: name

• description – Source: description

Return type:

HTTPMeddle[GuildTemplate]

get_invite(invite_code, /, **fields)

Use http.routes.get_invite.

Parameters:

• with_counts – Source: with_counts

• with_expiration – Source: with_expiration

• guild_scheduled_event_id – Source: guild_scheduled_event_id

Return type:

HTTPMeddle[Invite]

delete_invite(invite_code, /, **fields)

Use http.routes.delete_invite.

Return type:

HTTPMeddle[Invite]

create_stage_instance(**fields)

Use http.routes.create_stage_instance.

Parameters:

• channel_id – Source: channel_id

• topic – Source: topic

• privacy_level – Source: privacy_level

• send_start_notification – Source: send_start_notification

Return type:

HTTPMeddle[StageInstance]

get_stage_instance(channel_id, /, **fields)

Use http.routes.get_stage_instance.

Return type:

HTTPMeddle[StageInstance]

update_stage_instance(channel_id, /, **fields)

Use http.routes.update_stage_instance.

Parameters:

• topic – Source: topic

• privacy_level – Source: privacy_level

Return type:

HTTPMeddle[StageInstance]

delete_stage_instance(channel_id, /, **fields)

Use http.routes.delete_stage_instance.

Parameters:

• topic – Source: topic

• privacy_level – Source: privacy_level

Return type:

HTTPMeddle[None]

get_sticker(sticker_id, /, **fields)

Use http.routes.get_sticker.

Return type:

HTTPMeddle[Sticker]

get_sticker_packs(guild_id, /, **fields)

Use http.routes.get_sticker_packs.

Return type:

HTTPMeddle[list[StickerPack]]

get_guild_stickers(guild_id, /, **fields)

Use http.routes.get_guild_stickers.

Return type:

HTTPMeddle[list[Sticker]]

get_guild_sticker(guild_id, sticker_id, /, **fields)

Use http.routes.get_guild_sticker.

Return type:

HTTPMeddle[Sticker]

create_guild_sticker(guild_id, /, **fields)

Use http.routes.create_guild_sticker.

Parameters:

• name – Source: name

• description – Source: description

• tags – Source: tags

• file – Source: file

Return type:

HTTPMeddle[Sticker]

update_guild_sticker(guild_id, sticker_id, /, **fields)

Use http.routes.update_guild_sticker.

Parameters:

• name – Source: name

• description – Source: description

• tags – Source: tags

Return type:

HTTPMeddle[Sticker]

delete_guild_sticker(guild_id, sticker_id, /, **fields)

Use http.routes.delete_guild_sticker.

Parameters:

• name – Source: name

• description – Source: description

• tags – Source: tags

Return type:

HTTPMeddle[Sticker]

get_self_user(**fields)

Use http.routes.get_self_user.

Return type:

HTTPMeddle[User]

get_user(user_id, /, **fields)

Use http.routes.get_user.

Return type:

HTTPMeddle[User]

update_self_user(**fields)

Use http.routes.update_self_user.

Parameters:

• username – Source: username

• avatar – Source: avatar

Return type:

HTTPMeddle[User]

get_self_guilds(**fields)

Use http.routes.get_self_guilds.

Parameters:

• before – Source: before

• after – Source: after

• limit – Source: limit

Return type:

HTTPMeddle[list[Guild]]

get_self_guild_member(guild_id, /, **fields)

Use http.routes.get_self_guild_member.

Return type:

HTTPMeddle[GuildMember]

delete_self_guild_member(guild_id, /, **fields)

Use http.routes.delete_self_guild_member.

Return type:

HTTPMeddle[None]

create_self_channel(**fields)

Use http.routes.create_self_channel.

Parameters:

recipient_id – Source: recipient_id

get_self_connections(**fields)

Use http.routes.get_self_connections.

Return type:

HTTPMeddle[list[Connection]]

get_self_application_role_connection(application_id, /, **fields)

Use http.routes.get_self_application_role_connection.

Return type:

HTTPMeddle[ApplicationRoleConnection]

update_self_application_role_connection(application_id, /, **fields)

Use http.routes.update_self_application_role_connection.

Return type:

HTTPMeddle[ApplicationRoleConnection]

get_voice_regions(**fields)

Use http.routes.get_voice_regions.

Return type:

HTTPMeddle[list[VoiceRegion]]

get_self_voice_state(**fields)

Use http.routes.get_self_voice_state.

Return type:

HTTPMeddle[list[VoiceRegion]]

get_user_voice_state(user_id, **fields)

Use http.routes.get_user_voice_state.

Return type:

HTTPMeddle[list[VoiceRegion]]

create_webhook(channel_id, /, **fields)

Use http.routes.create_webhook.

Parameters:

• name – Source: name

• avatar – Source: avatar

Return type:

HTTPMeddle[Webhook]

get_channel_webhooks(channel_id, /, **fields)

Use http.routes.get_channel_webhooks.

Return type:

HTTPMeddle[list[Webhook]]

get_guild_webhooks(guild_id, /, **fields)

Use http.routes.get_guild_webhooks.

Return type:

HTTPMeddle[list[Webhook]]

get_webhook(webhook_id, /, **fields)

Use http.routes.get_webhook.

Return type:

HTTPMeddle[Webhook]

get_webhook_via_token(webhook_id, webhook_token, /, **fields)

Use http.routes.get_webhook_via_token.

Return type:

HTTPMeddle[Webhook]

update_webhook(webhook_id, /, **fields)

Use http.routes.update_webhook.

Parameters:

• name – Source: name

• avatar – Source: avatar

• channel_id – Source: channel_id

Return type:

HTTPMeddle[Webhook]

update_webhook_via_token(webhook_id, webhook_token, /, **fields)

Use http.routes.update_webhook_via_token.

Return type:

HTTPMeddle[Webhook]

delete_webhook(webhook_id, /, **fields)

Use http.routes.delete_webhook.

Return type:

HTTPMeddle[None]

delete_webhook_via_token(webhook_id, webhook_token, /, **fields)

Use http.routes.delete_webhook_via_token.

Return type:

HTTPMeddle[None]

create_webhook_message(webhook_id, webhook_token, /, **fields)

Use http.routes.create_webhook_message.

Parameters:

• wait – Source: wait

• thread_id – Source: thread_id

• content – Source: content

• username – Source: username

• avatar_url – Source: avatar_url

• tts – Source: tts

• components – Source: components

• files – Source: files[n]

• flags – Source: flags

• thread_name – Source: thread_name

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

HTTPMeddle[Message | None]

get_webhook_message(webhook_id, webhook_token, message_id, /, **fields)

Use http.routes.get_webhook_message.

Parameters:

thread_id – Source: thread_id

Return type:

HTTPMeddle[Message]

update_webhook_message(webhook_id, webhook_token, /, **fields)

Use http.routes.update_webhook_message.

Parameters:

• thread_id – Source: thread_id

• content – Source: content

• components – Source: components

• files – Source: files[n]

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

HTTPMeddle[Message | None]

delete_webhook_message(webhook_id, webhook_token, message_id, /, **fields)

Use http.routes.delete_webhook_message.

Parameters:

thread_id – Source: thread_id

Return type:

HTTPMeddle[None]

get_self_application_information(**fields)

Use http.routes.get_self_application_information.

Return type:

HTTPMeddle[Application]

get_self_authorization_information(**fields)

Use http.routes.get_self_authorization_information.

Return type:

HTTPMeddle[get_self_authorization_information]

get_skus(application_id, /, **fields)

Use http.routes.get_skus.

get_entitlements(application_id, /, **fields)

Use http.routes.get_entitlements.

create_entitlement(application_id, /, **fields)

Use http.routes.create_entitlement.

delete_entitlement(application_id, entitlement_id, /, **fields)

Use http.routes.delete_entitlement.

wait(Event, check=None, /, timeout=None)

Setup waiting for a specific event.

Parameters:

• Event – Any class of the first argument of callback.

• check – Called the same way as callback. Should return bool indicating whether to set the event.

• timeout (int) – Maximum amount of seconds to wait before setting the event.

Return type:

Task[Any]

Returns:

The inputs to the matched event.

def check(event):
    return event.message.author.id == client.cache.user.id and event.message.content == 'pass'

task = asyncio.create_task(aiocord.events.CreateMessage, check, timeout = 10)

await client.create_message(channel_id, content = 'pass')

event = await task # the corresponding CreateMessage event

request_guild_members(**fields)

Use gateway.client.Client.request_guild_members() for the respective guild’s shard.

Return type:

Awaitable[None]

create_self_voice_state(**fields)

Use gateway.client.Client.update_voice_state() for the respective guild’s shard. :rtype: Awaitable[None]

Warning

This does not create a voice client, use start_voice() for that.

update_self_presence(**fields)

Use gateway.client.Client.update_presence() for all shards.

Return type:

Awaitable[None]

start(intents=None, shard_ids=None, shard_count=None, present=None)

Start shard connections.

Parameters:

• intents (None | Intents) – The intents to identify with.

• shard_ids (None | list[int]) – The shard ids to connect to. If not specified, the recommended are used.

• shard_count (None | int) – The total number of shards for the client. If not specified, the recommended is used.

• present (Optional[Callable[[], Presence]]) – A callable that, when called, returns the desired presence.

Return type:

Awaitable[None]

stop()

Stop all shard connections and their products and close the session.

Return type:

Awaitable[None]

start_voice(guild_id, channel_id)

Join a voice channel and start the voice connection lifecycle.

Parameters:

• guild_id (Snowflake) – The id of the joining channel’s guild.

• channel_id (Snowflake) – The id of the joining channel.

Return type:

Awaitable[Client]

stop_voice(guild_id, /, *, force=False)

Stop the voice connection lifecycle and leave the voice channel.

Parameters:

• guild_id (Snowflake) – The id of the leaving channel’s guild.

• force (bool) – Whether to not send the gateway request for leaving the channel before stopping the voice client.

Return type:

Awaitable[Client]

events

class aiocord.events.Ready

Bases: NamedTuple

Dispatched on enums.GatewayEvent.ready.

class aiocord.events.UpdateApplicationCommandPermission(guild: Guild, application_command_permissions: GuildApplicationCommandPermissions)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_application_command_permissions.

guild: Guild

Source	Target
guild_id	id

application_command_permissions: GuildApplicationCommandPermissions

Source	Target
body

class aiocord.events.CreateAutoModerationRule(guild: Guild, auto_moderation_rule: AutoModerationRule)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_auto_moderation_rule.

guild: Guild

Source	Target
guild_id	id

auto_moderation_rule: AutoModerationRule

Source	Target
body

class aiocord.events.UpdateAutoModerationRule(guild: Guild, auto_moderation_rule: AutoModerationRule)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_auto_moderation_rule.

guild: Guild

Source	Target
guild_id	id

auto_moderation_rule: AutoModerationRule

Source	Target
body

class aiocord.events.DeleteAutoModerationRule(guild: Guild, auto_moderation_rule: AutoModerationRule)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_auto_moderation_rule.

guild: Guild

Source	Target
guild_id	id

auto_moderation_rule: AutoModerationRule

Source	Target
body

class aiocord.events.ExecuteAutoModerationRule(guild: Guild, auto_moderation_action: AutoModerationAction, auto_moderation_rule: AutoModerationRule, user: User, channel: Channel, source_message: Message, system_message: Message, matched_keyword: str, matched_content: str)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.execute_auto_moderation_action.

guild: Guild

Source	Target
guild_id	id

auto_moderation_action: AutoModerationAction

Source	Target
action

auto_moderation_rule: AutoModerationRule

Source	Target
rule_id	id
rule_trigger_type	trigger_type

user: User

Source	Target
user_id	id

channel: Channel

Source	Target
channel_id	id

source_message: Message

Source	Target
message_id	id
content	content

system_message: Message

Source	Target
alert_system_message_id	id

matched_keyword: str

Source	Target
matched_keyword

matched_content: str

Source	Target
matched_content

class aiocord.events.CreateChannel(guild: Guild, channel: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_channel.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
body

class aiocord.events.UpdateChannel(guild: Guild, channel: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_channel.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
body

class aiocord.events.DeleteChannel(guild: Guild, channel: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_channel.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
body

class aiocord.events.CreateThread(guild: Guild, thread: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_thread.

guild: Guild

Source	Target
guild_id	id

thread: Channel

Source	Target
body

class aiocord.events.UpdateThread(guild: Guild, thread: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_thread.

guild: Guild

Source	Target
guild_id	id

thread: Channel

Source	Target
body

class aiocord.events.DeleteThread(guild: Guild, thread: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_thread.

guild: Guild

Source	Target
guild_id	id

thread: Channel

Source	Target
body

class aiocord.events.SyncThreads(guild: Guild, threads: Collection[Channel])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.sync_threads.

guild: Guild

Source	Target
guild_id	id

threads: Collection[Channel]

Source	Target
threads

class aiocord.events.UpdateThreadMember(guild: Guild, thread: Channel, thread_member: ThreadMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_thread_member.

guild: Guild

Source	Target
guild_id	id

thread: Channel

Source	Target
id	id

thread_member: ThreadMember

Source	Target
body

class aiocord.events.UpdateThreadMembers(guild: Guild, thread: Channel, created_thread_members: Collection[ThreadMember], deleted_thread_members: Collection[ThreadMember])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_thread_members.

guild: Guild

Source	Target
guild_id	id

thread: Channel

Source	Target
id	id

created_thread_members: Collection[ThreadMember]

Source	Target
added_members

deleted_thread_members: Collection[ThreadMember]

Source	Target
removed_member_ids	id

class aiocord.events.UpdateChannelPins(guild: Guild, channel: Channel, timestamp: ISO8601Timestamp)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_channel_pins.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
channel_id	id

timestamp: ISO8601Timestamp

Source	Target
last_pin_timestamp

class aiocord.events.CreateGuild(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild when the guild is created.

guild: Guild

Source	Target
body

class aiocord.events.AvailableGuild(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild when the guild is available.

guild: Guild

Source	Target
body

class aiocord.events.DeleteGuild(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild when the guild is deleted.

guild: Guild

Source	Target
body

class aiocord.events.UnavailableGuild(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent. when the guild is unavailable.

guild: Guild

Source	Target
body

class aiocord.events.UpdateGuild(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild.

Copiable with data before updating.

guild: Guild

Source	Target
body

class aiocord.events.CreateGuildAuditLogEntry(guild: Guild, guild_audit_log_entry: AuditLogEntry)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_audit_log_entry.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_audit_log_entry: AuditLogEntry

Source	Target
body

class aiocord.events.CreateGuildBan(guild: Guild, user: User)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_ban.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

user: User

Source	Target
user

class aiocord.events.DeleteGuildBan(guild: Guild, user: User)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild_ban.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

user: User

Source	Target
user

class aiocord.events.UpdateGuildEmojis(guild: Guild, emojis: Collection[Emoji])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_emojis.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

emojis: Collection[Emoji]

Source	Target
emojis

class aiocord.events.UpdateGuildStickers(guild: Guild, emojis: Collection[Emoji])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_stickers.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

emojis: Collection[Emoji]

Source	Target
stickers

class aiocord.events.UpdateGuildIntegrations(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_integrations.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

class aiocord.events.CreateGuildMember(guild: Guild, guild_member: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_member.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_member: GuildMember

Source	Target
body

class aiocord.events.DeleteGuildMember(guild: Guild, guild_member: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild_member.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_member: GuildMember

Source	Target
user	user

class aiocord.events.UpdateGuildMember(guild: Guild, guild_member: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_member.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_member: GuildMember

Source	Target
body

class aiocord.events.ReceiveGuildMembers(guild: Guild, guild_members: Collection[GuildMember], guild_presences: Collection[Presence], chunk_index: int, chunk_count: int)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.receive_guild_members.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_members: Collection[GuildMember]

Source	Target
members

guild_presences: Collection[Presence]

Source	Target
members

chunk_index: int

Source	Target
chunk_index

chunk_count: int

Source	Target
chunk_count

class aiocord.events.CreateGuildRole(guild: Guild, guild_role: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_role.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_role: GuildMember

Source	Target
role

class aiocord.events.UpdateGuildRole(guild: Guild, guild_role: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_role.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_role: GuildMember

Source	Target
role

class aiocord.events.DeleteGuildRole(guild: Guild, guild_role: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild_role.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_role: GuildMember

Source	Target
role_id	id

class aiocord.events.CreateGuildScheduledEvent(guild: Guild, guild_scheduled_event: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_scheduled_event.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_scheduled_event: GuildMember

Source	Target
body

class aiocord.events.UpdateGuildScheduledEvent(guild: Guild, guild_scheduled_event: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_scheduled_event.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_scheduled_event: GuildMember

Source	Target
body

class aiocord.events.DeleteGuildScheduledEvent(guild: Guild, guild_scheduled_event: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild_scheduled_event.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_scheduled_event: GuildMember

Source	Target
body

class aiocord.events.CreateGuildScheduledEventUser(guild: Guild, guild_scheduled_event: GuildMember, guild_member: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_scheduled_event_user.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_scheduled_event: GuildMember

Source	Target
guild_scheduled_event_id	id

guild_member: GuildMember

Source	Target
user_id	user’s id

class aiocord.events.DeleteGuildScheduledEventUser(guild: Guild, guild_scheduled_event: GuildMember, guild_member: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild_scheduled_event_user.

Copiable with data before updating.

guild: Guild

Source	Target
guild_id	id

guild_scheduled_event: GuildMember

Source	Target
guild_scheduled_event_id	id

guild_member: GuildMember

Source	Target
user_id	user’s id

class aiocord.events.CreateIntegration(guild: Guild, integration: Integration)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_integration.

guild: Guild

Source	Target
guild_id	id

integration: Integration

Source	Target
body

class aiocord.events.UpdateIntegration(guild: Guild, integration: Integration)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_integration.

guild: Guild

Source	Target
guild_id	id

integration: Integration

Source	Target
body

class aiocord.events.DeleteIntegration(guild: Guild, integration: Integration)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_integration.

guild: Guild

Source	Target
guild_id	id

integration: Integration

Source	Target
body

class aiocord.events.CreateInvite(guild: Guild, channel: Channel, invite: Invite)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_invite.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
channel_id	id

invite: Invite

Source	Target
body

class aiocord.events.DeleteInvite(guild: Guild, channel: Channel, invite: Invite)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_invite.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
channel_id	id

invite: Invite

Source	Target
code	code

class aiocord.events.CreateMessage(guild: Guild, channel: Channel, message: Message)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_message.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
channel_id	id
last_message_id	last_message_id

message: Message

Source	Target
body

class aiocord.events.UpdateMessage(guild: Guild, channel: Channel, message: Message)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_message.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
channel_id	id
last_message_id	last_message_id

message: Message

Source	Target
body

class aiocord.events.DeleteMessage(guild: Guild, channel: Channel, message: Message)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_message.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
channel_id	id
last_message_id	last_message_id

message: Message

Source	Target
id	id

class aiocord.events.DeleteMessages(guild: Guild, channel: Channel, messages: Collection[Message])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_messages.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
channel_id	id
last_message_id	last_message_id

messages: Collection[Message]

Source	Target
ids (each)	id

class aiocord.events.CreateMessageReaction(guild: Guild, guild_member: GuildMember, user: User, channel: Channel, message: Message, emoji: Emoji)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_message_reaction.

guild: Guild

Source	Target
guild_id	id

guild_member: GuildMember

Source	Target
member

user: User

Source	Target
user_id	id

channel: Channel

Source	Target
channel_id	id

message: Message

Source	Target
message_id	id

emoji: Emoji

Source	Target
emoji

class aiocord.events.DeleteMessageReaction(guild: Guild, guild_member: GuildMember, user: User, channel: Channel, message: Message, emoji: Emoji)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_message_reaction.

guild: Guild

Source	Target
guild_id	id

guild_member: GuildMember

Source	Target
user_id	user’s id

user: User

Source	Target
user_id	id

channel: Channel

Source	Target
channel_id	id

message: Message

Source	Target
message_id	id

emoji: Emoji

Source	Target
emoji

class aiocord.events.DeleteAllMessageReactions(guild: Guild, channel: Channel, message: Message)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_all_message_reactions.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
channel_id	id

message: Message

Source	Target
message_id	id

class aiocord.events.DeleteAllMessageEmojiReactions(guild: Guild, channel: Channel, message: Message, emoji: Emoji)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_all_message_emoji_reactions.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
channel_id	id

message: Message

Source	Target
message_id	id

emoji: Emoji

Source	Target
emoji

class aiocord.events.UpdatePresence(guild: Guild, presence: Presence)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_presence.

guild: Guild

Source	Target
guild_id	id

presence: Presence

Source	Target
body

class aiocord.events.CreateTypingIndicator(guild: Guild, guild_member: GuildMember, user: GuildMember, channel: Channel, timestamp: Timestamp)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_typing_indicator.

guild: Guild

Source	Target
guild_id	id

guild_member: GuildMember

Source	Target
member

user: GuildMember

Source	Target
user_id	id

channel: Channel

Source	Target
channel_id	id

timestamp: Timestamp

Source	Target
timestamp

class aiocord.events.UpdateSelfUser(user: User)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_self_user.

user: User

Source	Target
body

class aiocord.events.UpdateVoiceState(guild: Guild, voice_state: VoiceState, voice: Client | None)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_voice_state.

guild: Guild

Source	Target
guild_id	id

voice_state: VoiceState

Source	Target
body

voice: Client | None

The self’s voice client.

class aiocord.events.UpdateVoiceServer(guild: Guild, token: str, uri: str)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_voice_server.

guild: Guild

Source	Target
guild_id	id

token: str

Source	Target
token

uri: str

Source	Target
uri

class aiocord.events.UpdateWebhooks(guild: Guild, channel: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_webhooks.

guild: Guild

Source	Target
guild_id	id

channel: Channel

Source	Target
channel_id	id

class aiocord.events.CreateInteraction(interaction: Interaction)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_interaction.

interaction: Interaction

Source	Target
body

class aiocord.events.CreateStageInstance(stage_instance: StageInstance)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_stage_instance.

stage_instance: StageInstance

Source	Target
body

class aiocord.events.UpdateStageInstance(stage_instance: StageInstance)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_stage_instance.

stage_instance: StageInstance

Source	Target
body

class aiocord.events.DeleteStageInstance(stage_instance: StageInstance)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_stage_instance.

stage_instance: StageInstance

Source	Target
body

class aiocord.events.EnterVoice(guild: Guild, user: GuildMember)

Bases: NamedTuple

Dispatched on enums.VoiceEvent.enter.

guild: Guild

Source	Target
guild_id	id

user: GuildMember

Source	Target
user_id	user’s id

class aiocord.events.LeaveVoice(guild: Guild, user: GuildMember)

Bases: NamedTuple

Dispatched on enums.VoiceEvent.leave.

guild: Guild

Source	Target
guild_id	id

user: GuildMember

Source	Target
user_id	user’s id

class aiocord.events.Speak(guild: Guild, user: GuildMember, flags: SpeechFlags, ssrc: int)

Bases: NamedTuple

Dispatched on enums.VoiceEvent.speak.

guild: Guild

Source	Target
guild_id	id

user: GuildMember

Source	Target
user_id	user’s id

flags: SpeechFlags

Source	Target
speaking

ssrc: int

Source	Target
ssrc

enums

class aiocord.enums.Intents(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntFlag

Available Gateway Intents.

guilds = 1

guild_members = 2

guild_moderation = 4

guild_emojis_and_stickers = 8

guild_integrations = 16

guild_webhooks = 32

guild_invites = 64

guild_voice_states = 128

guild_presences = 256

guild_messages = 512

guild_message_reactions = 1024

guild_message_typing = 2048

direct_messages = 4096

direct_message_reactions = 8192

direct_message_typing = 16384

message_content = 32768

guild_scheduled_events = 65536

auto_moderation_configuration = 1048576

auto_moderation_action_execution = 2097152

class aiocord.enums.GatewayEvent(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

Available Events </topics/gateway-events#receive-events> received through gateway.enums.OpCode.dispatch.

ready = 'READY'

Source: Ready

update_application_command_permissions = 'APPLICATION_COMMAND_PERMISSIONS_UPDATE'

Source: Application Command Permissions Update

create_auto_moderation_rule = 'AUTO_MODERATION_RULE_CREATE'

Source: Auto Moderation Rule Create

update_auto_moderation_rule = 'AUTO_MODERATION_RULE_UPDATE'

Source: Auto Moderation Rule Update

delete_auto_moderation_rule = 'AUTO_MODERATION_RULE_DELETE'

Source: Auto Moderation Rule Delete

execute_auto_moderation_action = 'AUTO_MODERATION_ACTION_EXECUTION'

Source: Auto Moderation Action Execution

create_channel = 'CHANNEL_CREATE'

Source: Channel Create

update_channel = 'CHANNEL_UPDATE'

Source: Channel Update

delete_channel = 'CHANNEL_DELETE'

Source: Channel Delete

update_channel_pins = 'CHANNEL_PINS_UPDATE'

Source: Channel Pins Update

create_thread = 'THREAD_CREATE'

Source: Thread Create

update_thread = 'THREAD_UPDATE'

Source: Thread Update

delete_thread = 'THREAD_DELETE'

Source: Thread Delete

sync_threads = 'THREAD_LIST_SYNC'

Source: Thread List Sync

update_thread_member = 'THREAD_MEMBER_UPDATE'

Source: Thread Member Update

update_thread_members = 'THREAD_MEMBERS_UPDATE'

Source: Thread Members Update

create_guild = 'GUILD_CREATE'

Source: Guild Create

update_guild = 'GUILD_UPDATE'

Source: Guild Update

delete_guild = 'GUILD_DELETE'

Source: Guild Delete

create_guild_audit_log_entry = 'GUILD_AUDIT_LOG_ENTRY_CREATE'

Source: Guild Audit Log Entry Create

create_guild_ban = 'GUILD_BAN_ADD'

Source: Guild Ban Add

delete_guild_ban = 'GUILD_BAN_REMOVE'

Source: Guild Ban Remove

update_guild_emojis = 'GUILD_EMOJIS_UPDATE'

Source: Guild Emojis Update

update_guild_stickers = 'GUILD_STICKERS_UPDATE'

Source: Guild Stickers Update

update_guild_integrations = 'GUILD_INTEGRATIONS_UPDATE'

Source: Guild Integrations Update

create_guild_member = 'GUILD_MEMBER_ADD'

Source: Guild Member Add

delete_guild_member = 'GUILD_MEMBER_REMOVE'

Source: Guild Member Remove

update_guild_member = 'GUILD_MEMBER_UPDATE'

Source: Guild Member Update

receive_guild_members = 'GUILD_MEMBERS_CHUNK'

Source: Guild Members Chunk

create_guild_role = 'GUILD_ROLE_CREATE'

Source: Guild Role Create

update_guild_role = 'GUILD_ROLE_UPDATE'

Source: Guild Role Update

delete_guild_role = 'GUILD_ROLE_DELETE'

Source: Guild Role Delete

create_guild_scheduled_event = 'GUILD_SCHEDULED_EVENT_CREATE'

Source: Guild Scheduled Event Create

update_guild_scheduled_event = 'GUILD_SCHEDULED_EVENT_UPDATE'

Source: Guild Scheduled Event Update

delete_guild_scheduled_event = 'GUILD_SCHEDULED_EVENT_DELETE'

Source: Guild Scheduled Event Delete

create_guild_scheduled_event_user = 'GUILD_SCHEDULED_EVENT_USER_ADD'

Source: Guild Scheduled Event User Add

delete_guild_scheduled_event_user = 'GUILD_SCHEDULED_EVENT_USER_REMOVE'

Source: Guild Scheduled Event User Remove

create_integration = 'INTEGRATION_CREATE'

Source: Integration Create

update_integration = 'INTEGRATION_UPDATE'

Source: Integration Update

delete_integration = 'INTEGRATION_DELETE'

Source: Integration Delete

create_interaction = 'INTERACTION_CREATE'

Source: Interaction Create

create_invite = 'INVITE_CREATE'

Source: Invite Create

delete_invite = 'INVITE_DELETE'

Source: Invite Delete

create_message = 'MESSAGE_CREATE'

Source: Message Create

update_message = 'MESSAGE_UPDATE'

Source: Message Update

delete_message = 'MESSAGE_DELETE'

Source: Message Delete

delete_messages = 'MESSAGE_DELETE_BULK'

Source: Message Delete Bulk

create_message_reaction = 'MESSAGE_REACTION_ADD'

Source: Message Reaction Add

delete_message_reaction = 'MESSAGE_REACTION_REMOVE'

Source: Message Reaction Remove

delete_all_message_reactions = 'MESSAGE_REACTION_REMOVE_ALL'

Source: Message Reaction Remove All

delete_all_message_emoji_reactions = 'MESSAGE_REACTION_REMOVE_EMOJI'

Source: Message Reaction Remove Emoji

update_presence = 'PRESENCE_UPDATE'

Source: Presence Update

create_stage_instance = 'STAGE_INSTANCE_CREATE'

Source: Stage Instance Create

update_stage_instance = 'STAGE_INSTANCE_UPDATE'

Source: Stage Instance Update

delete_stage_instance = 'STAGE_INSTANCE_DELETE'

Source: Stage Instance Delete

create_typing_indicator = 'TYPING_START'

Source: Typing Start

update_self_user = 'USER_UPDATE'

Source: User Update

update_voice_state = 'VOICE_STATE_UPDATE'

Source: Voice State Update

update_voice_server = 'VOICE_SERVER_UPDATE'

Source: Voice Server Update

update_webhooks = 'WEBHOOKS_UPDATE'

Source: Webhooks Update

create_entitlement = 'ENTITLEMENT_CREATE'

Source: https://discord.com/developers/docsEntitlement Create </monetization/entitlements#new-entitlement>

update_entitlement = 'ENTITLEMENT_UPDATE'

Source: https://discord.com/developers/docsEntitlement Update </monetization/entitlements#updated-entitlement>

delete_entitlement = 'ENTITLEMENT_DELETE'

Source: https://discord.com/developers/docsEntitlement Delete </monetization/entitlements#deleted-entitlement>

class aiocord.enums.VoiceEvent(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

speak = 'SPEAK'

A user has spoken.

enter = 'ENTER'

A user has joined the channel.

leave = 'LEAVE'

A user has left the channel.

utils

aiocord.utils.get_eventful_intents(Events)

Get the intents required to receive the specified events.

aiocord.utils.interact(client, callback, component, /, timeout=60)

Invoke a callback when the component has been interacted with.

If a .model.protocols.InteractionResponse is returned, it is used to respond via client.create_interaction_response().

Parameters:

• client (Client) – The client to attach the callback to.

• callback (Callable[[Optional[Any]], Awaitable[InteractionResponse | None]]) – Used with (event) if successful or (None) if timed-out.

• component (MessageButtonComponent | MessageSelectMenuComponent | MessageTextInputComponent) – A 'custom_id' will be set for identifying interactions to it.

• timeout (float) – Same as client.wait.timeout.

widget

class aiocord.widget.Info(client: Client, widgets: dict[str, ModuleType])

Bases: NamedTuple

Holds global information.

client: Client

The client for which this widget has been loaded.

widgets: dict[str, ModuleType]

All currently loaded widgets.

aiocord.widget.callback(Event)

Create a callback for an core_event.

Parameters:

Event (TypeVar(_V)) – Any event dispatchable by client.Client.

Return type:

Callable[[Callable[[ParamSpec(_P)], TypeVar(_V)]], Callable[[Info, Unpack[tuple[TypeVar(_V), ...]]], None]]

aiocord.widget.interact(*path)

Create a callback for an interaction.

If a .model.protocols.InteractionResponse is returned, it is used to respond via client.create_interaction_response().

Parameters:

*path – The command-name to sub[command/group]-name leading to the desired command.

Return type:

Callable[[Callable[[ParamSpec(_P)], TypeVar(_V)]], Callable[[Info, CreateIntegration], Awaitable[InteractionResponse | None]]]

aiocord.widget.load(client, name, path=None, vendor=None, *, version=None)

Load a widget by creating and attaching events to the client.

Parameters:

• client (Client) – The client to load the widget for.

• name (str) – The name of the widget, used for identifying in Info.widgets and :func:`.drop`ing.

• path (str) – The location of the package. If not specified, the calling widget’s parent directory is used.

• vendor (Literal['github']) – The vendor from which to download the widget, given that path is an the form of author/project/version.

• version (str) – The project version to fetch. The latest is used if not specified. Only valid when vendor is used.

Return type:

Awaitable[ModuleType]

The widget may define a __load__(info) function, which will be called before callbacks are attached.

aiocord.widget.drop(client, name)

Unload a widget by detaching all the related callbles from the client.

Parameters:

• client (Client) – The client to unload the widget for.

• name (str) – The name of the widget, as specified in load().

Return type:

Awaitable[None]

The widget may define a __drop__ function which will be called after callbacks are detached.

vendor

Starting

Installing the library attaches a script to your terminal.

To use it, create an example blep/__init__.py file (relative imports are allowed).

Note

See aiocord.widget.load() and aiocord.widget.drop() for further details.

Then, simply run:

aiocord --token <TOKEN> start blep

Executing will create a client, connect to the gateway and begin listening to any events defined.

Updating

Defining interaction callbacks will do nothing unless you have created commands.

This can be achieved by creating a commands.json containing all desired commands.

Then, simply run:

aiocord --token <TOKEN> update commands

Executing will overwrite (delete/create/replace) the existing commands for the application.

Creating commands by hand can be cumbersome due to the complexity of the data required.

This can be eliviated using intellisense by creating a commands.py and defining a commands variable.

import aiocord

commands = [
    aiocord.model.protocols.ApplicationCommand(
        name = 'blep',
        type = aiocord.model.enums.ApplicationCommandType.chat_input,
        description = 'blep someone',
        options = [
            aiocord.model.protocols.ApplicationCommandOption(
                name = 'user',
                description = 'the user to blep',
                type = aiocord.model.enums.ApplicationCommandOptionType.user
            )
        ]
    )
]

Then, run the script as shown above.

The .py file will be used to generate the .json file before continuing.

Internal

The internal mechanisms of the library.

When scoped functionality is desired, these may be used directly.

http

The REST part of the Discord API.

client

class aiocord.http.client.Client(session, loads=<function loads>, dumps=<function dumps>, ignore_rate=False, raise_after=60)

Bases: object

Core means of communication with the HTTP Discord API.

Parameters:

• session (ClientSession) – Used to make requests.

• loads (Callable[[str], Any]) – Used for converting json text to objects.

• dumps (Callable[[Any], str]) – Used for converting json objects to text.

• ignore_rate (bool) – Whether to NOT handle rate limiting.

authenticate(token)

Set the authentication token.

Return type:

None

async request(verb, path, query=None, json=None, data=None, files=None, headers=None, identity=None)

Make a request to the API and get the responding data.

Parameters:

• verb (str) – The HTTP method.

• path (str) – The path portion for the url.

• query (None | dict[str, str | int | bool]) – The HTTP query.

• json (None | Any) – Used to compose the HTTP body.

• data (None | Any) – Used to compose the HTTP body.

• headers (None | dict[str, str]) – The HTTP headers.

• identity (None | Any) – Used for handling rate limits.

Return type:

Any

routes

class aiocord.http.routes.Route(verb, path_template)

Bases: object

Contains all necessary data to perform a targeted request.

Parameters:

• verb (str) – The HTTP method.

• path_template (str) – The formattable path portion for the url.

route = Route('GET', '/path/{0}/to/{1}/resource')
value = await route(client, 'step0', 'step1', json = ..., params = ..., headers = ...)

aiocord.http.routes.get_global_application_commands = <Route(GET /applications/{0}/commands)>

Source: Get Global Application Commands

aiocord.http.routes.create_global_application_command = <Route(POST /applications/{0}/commands)>

Source: Create Global Application Command

aiocord.http.routes.get_global_application_command = <Route(GET /applications/{0}/commands/{1})>

Source: Get Global Application Command

aiocord.http.routes.update_global_application_command = <Route(PATCH /applications/{0}/commands/{1})>

Source: Edit Global Application Command

aiocord.http.routes.delete_global_application_command = <Route(DELETE /applications/{0}/commands/{1})>

Source: Delete Global Application Command

aiocord.http.routes.update_all_global_application_commands = <Route(PUT /applications/{0}/commands)>

Source: Bulk Overwrite Global Application Commands

aiocord.http.routes.get_guild_application_commands = <Route(GET /applications/{0}/guilds/{1}/commands)>

Source: Get Guild Application Commands

aiocord.http.routes.create_guild_application_command = <Route(POST /applications/{0}/guilds/{1}/commands)>

Source: Create Guild Application Command

aiocord.http.routes.get_guild_application_command = <Route(GET /applications/{0}/guilds/{1}/commands/{2})>

Source: Get Guild Application Command

aiocord.http.routes.update_guild_application_command = <Route(PATCH /applications/{0}/guilds/{1}/commands/{2})>

Source: Edit Guild Application Command

aiocord.http.routes.delete_guild_application_command = <Route(DELETE /applications/{0}/guilds/{1}/commands/{2})>

Source: Delete Guild Application Command

aiocord.http.routes.update_all_guild_application_commands = <Route(PUT /applications/{0}/guilds/{1}/commands)>

Source: Bulk Overwrite Guild Application Commands

aiocord.http.routes.get_guild_application_command_permissions = <Route(GET /applications/{0}/guilds/{1}/commands/permissions)>

Source: Get Guild Application Command Permissions

aiocord.http.routes.get_application_command_permissions = <Route(GET /applications/{0}/guilds/{1}/commands/{2}/permissions)>

Source: Get Application Command Permissions

aiocord.http.routes.update_application_command_permissions = <Route(PUT /applications/{0}/guilds/{1}/commands/{2}/permissions)>

Source: Edit Application Command Permissions

aiocord.http.routes.create_interaction_response = <Route(POST /interactions/{0}/{1}/callback)>

Source: Create Interaction Response

aiocord.http.routes.get_interaction_response = <Route(GET /webhooks/{0}/{1}/messages/@original)>

Source: Get Original Interaction Response

aiocord.http.routes.update_interaction_response = <Route(PATCH /webhooks/{0}/{1}/messages/@original)>

Source: Edit Original Interaction Response

aiocord.http.routes.delete_interaction_response = <Route(DELETE /webhooks/{0}/{1}/messages/@original)>

Source: Delete Original Interaction Response

aiocord.http.routes.create_followup_message = <Route(POST /webhooks/{0}/{1})>

Source: Create Followup Message

aiocord.http.routes.get_followup_message = <Route(GET /webhooks/{0}/{1}/messages/{2})>

Source: Get Followup Message

aiocord.http.routes.update_followup_message = <Route(PATCH /webhooks/{0}/{1}/messages/{2})>

Source: Edit Followup Message

aiocord.http.routes.delete_followup_message = <Route(DELETE /webhooks/{0}/{1}/messages/{2})>

Source: Delete Followup Message

aiocord.http.routes.get_application_role_connection_metadata = <Route(GET /applications/{0}/role-connections/metadata)>

Source: Get Application Role Connection Metadata Records

aiocord.http.routes.update_application_role_connection_metadata = <Route(PUT /applications/{0}/role-connections/metadata)>

Source: Update Application Role Connection Metadata Records

aiocord.http.routes.get_guild_audit_log = <Route(GET /guilds/{0}/audit-logs)>

Source: Get Guild Audit Log

aiocord.http.routes.get_guild_auto_moderation_rules = <Route(GET /guilds/{0}/auto-moderation/rules)>

Source: List Auto Moderation Rules For Guild

aiocord.http.routes.get_auto_moderation_rule = <Route(GET /guilds/{0}/auto-moderation/rules/{1})>

Source: Get Auto Moderation Rule

aiocord.http.routes.create_auto_moderation_rule = <Route(POST /guilds/{0}/auto-moderation/rules)>

Source: Create Auto Moderation Rule

aiocord.http.routes.update_auto_moderation_rule = <Route(PATCH /guilds/{0}/auto-moderation/rules/{1})>

Source: Modify Auto Moderation Rule

aiocord.http.routes.delete_auto_moderation_rule = <Route(DELETE /guilds/{0}/auto-moderation/rules/{1})>

Source: Delete Auto Moderation Rule

aiocord.http.routes.get_channel = <Route(GET /channels/{0})>

Source: Get Channel

aiocord.http.routes.update_channel = <Route(PATCH /channels/{0})>

Source: Modify Channel

aiocord.http.routes.delete_channel = <Route(DELETE /channels/{0})>

Source: Delete/Close Channel

aiocord.http.routes.get_messages = <Route(GET /channels/{0}/messages)>

Source: Get Channel Messages

aiocord.http.routes.get_message = <Route(GET /channels/{0}/messages/{1})>

Source: Get Channel Message

aiocord.http.routes.create_message = <Route(POST /channels/{0}/messages)>

Source: Create Message

aiocord.http.routes.create_message_crosspost = <Route(POST /channels/{0}/messages/{1}/crosspost)>

Source: Crosspost Message

aiocord.http.routes.create_reaction = <Route(PUT /channels/{0}/messages/{1}/reactions/{2}/@me)>

Source: Create Reaction

aiocord.http.routes.delete_own_reaction = <Route(DELETE /channels/{0}/messages/{1}/reactions/{2}/@me)>

Source: Delete Own Reaction

aiocord.http.routes.delete_user_reaction = <Route(DELETE /channels/{0}/messages/{1}/reactions/{2}/{3})>

Source: Delete User Reaction

aiocord.http.routes.get_reactions = <Route(GET /channels/{0}/messages/{1}/reactions/{2})>

Source: Get Reactions

aiocord.http.routes.delete_all_reactions = <Route(DELETE /channels/{0}/messages/{1}/reactions)>

Source: Delete All Reactions

aiocord.http.routes.delete_all_emoji_reactions = <Route(DELETE /channels/{0}/messages/{1}/reactions/{2})>

Source: Delete All Reactions For Emoji

aiocord.http.routes.update_message = <Route(PATCH /channels/{0}/messages/{1})>

Source: Edit Message

aiocord.http.routes.delete_message = <Route(DELETE /channels/{0}/messages/{1})>

Source: Delete Message

aiocord.http.routes.delete_messages = <Route(POST /channels/{0}/messages/bulk-delete)>

Source: Bulk Delete Messages

aiocord.http.routes.update_channel_permissions = <Route(PUT /channels/{0}/permissions/{1})>

Source: Edit Channel Permissions

aiocord.http.routes.get_channel_invites = <Route(GET /channels/{0}/invites)>

Source: Get Channel Invites

aiocord.http.routes.create_channel_invite = <Route(POST /channels/{0}/invites)>

Source: Create Channel Invite

aiocord.http.routes.delete_channel_permission = <Route(DELETE /channels/{0}/permissions/{1})>

Source: Delete Channel Permission

aiocord.http.routes.create_channel_follow = <Route(POST /channels/{0}/followers)>

Source: Follow Announcement Channel

aiocord.http.routes.create_typing_indicator = <Route(POST /channels/{0}/typing)>

Source: Trigger Typing Indicator

aiocord.http.routes.get_channel_pins = <Route(GET /channels/{0}/pins)>

Source: Get Pinned Messages

aiocord.http.routes.create_channel_pin = <Route(PUT /channels/{0}/pins/{1})>

Source: Pin Message

aiocord.http.routes.delete_channel_pin = <Route(DELETE /channels/{0}/pins/{1})>

Source: Unpin Message

aiocord.http.routes.create_channel_recipient = <Route(PUT /channels/{0}/recipients/{1})>

Source: Group Dm Add Recipient

aiocord.http.routes.delete_channel_recipient = <Route(DELETE /channels/{0}/recipients/{1})>

Source: Group Dm Remove Recipient

aiocord.http.routes.create_message_thread = <Route(POST /channels/{0}/messages/{1}/threads)>

Source: Start Thread From Message

aiocord.http.routes.create_thread = <Route(POST /channels/{0}/threads)>

Source: Start Thread Without Message

aiocord.http.routes.create_self_thread_member = <Route(PUT /channels/{0}/thread-members/@me)>

Source: Join Thread

aiocord.http.routes.create_thread_member = <Route(PUT /channels/{0}/thread-members/{1})>

Source: Add Thread Member

aiocord.http.routes.delete_self_thread_member = <Route(DELETE /channels/{0}/thread-members/@me)>

Source: Leave Thread

aiocord.http.routes.delete_thread_member = <Route(DELETE /channels/{0}/thread-members/{1})>

Source: Remove Thread Member

aiocord.http.routes.get_thread_member = <Route(GET /channels/{0}/thread-members/{1})>

Source: Get Thread Member

aiocord.http.routes.get_thread_members = <Route(GET /channels/{0}/thread-members)>

Source: List Thread Members

aiocord.http.routes.get_public_archived_threads = <Route(GET /channels/{0}/threads/archived/public)>

Source: List Public Archived Threads

aiocord.http.routes.get_private_archived_threads = <Route(GET /channels/{0}/threads/archived/private)>

Source: List Private Archived Threads

aiocord.http.routes.get_self_private_archived_threads = <Route(GET /channels/{0}/users/@me/threads/archived/private)>

Source: List Joined Private Archived Threads

aiocord.http.routes.get_guild_emojis = <Route(GET /guilds/{0}/emojis)>

Source: List Guild Emojis

aiocord.http.routes.get_guild_emoji = <Route(GET /guilds/{0}/emojis/{1})>

Source: Get Guild Emoji

aiocord.http.routes.create_guild_emoji = <Route(POST /guilds/{0}/emojis)>

Source: Create Guild Emoji

aiocord.http.routes.update_guild_emoji = <Route(PATCH /guilds/{0}/emojis/{1})>

Source: Modify Guild Emoji

aiocord.http.routes.delete_guild_emoji = <Route(DELETE /guilds/{0}/emojis/{1})>

Source: Delete Guild Emoji

aiocord.http.routes.create_guild = <Route(POST /guilds)>

Source: Create Guild

aiocord.http.routes.get_guild = <Route(GET /guilds/{0})>

Source: Get Guild

aiocord.http.routes.get_guild_preview = <Route(GET /guilds/{0}/preview)>

Source: Get Guild Preview

aiocord.http.routes.update_guild = <Route(PATCH /guilds/{0})>

Source: Modify Guild

aiocord.http.routes.delete_guild = <Route(DELETE /guilds/{0})>

Source: Delete Guild

aiocord.http.routes.get_guild_channels = <Route(GET /guilds/{0}/channels)>

Source: Get Guild Channels

aiocord.http.routes.create_guild_channel = <Route(POST /guilds/{0}/channels)>

Source: Create Guild Channel

aiocord.http.routes.update_guild_channel_positions = <Route(PATCH /guilds/{0}/channels)>

Source: Modify Guild Channel Positions

aiocord.http.routes.get_active_guild_threads = <Route(GET /guilds/{0}/threads/active)>

Source: List Active Guild Threads

aiocord.http.routes.get_guild_member = <Route(GET /guilds/{0}/members/{1})>

Source: Get Guild Member

aiocord.http.routes.get_guild_members = <Route(GET /guilds/{0}/members)>

Source: List Guild Members

aiocord.http.routes.search_guild_members = <Route(GET /guilds/{0}/members/search)>

Source: Search Guild Members

aiocord.http.routes.create_guild_member = <Route(PUT /guilds/{0}/members/{1})>

Source: Add Guild Member

aiocord.http.routes.update_guild_member = <Route(PATCH /guilds/{0}/members/{1})>

Source: Modify Guild Member

aiocord.http.routes.update_self_guild_member = <Route(PATCH /guilds/{0}/members/@me)>

Source: Modify Current Member

aiocord.http.routes.create_guild_member_role = <Route(PUT /guilds/{0}/members/{1}/roles/{2})>

Source: Add Guild Member Role

aiocord.http.routes.delete_guild_member_role = <Route(DELETE /guilds/{0}/members/{1}/roles/{2})>

Source: Remove Guild Member Role

aiocord.http.routes.delete_guild_member = <Route(DELETE /guilds/{0}/members/{1})>

Source: Remove Guild Member

aiocord.http.routes.get_guild_bans = <Route(GET /guilds/{0}/bans)>

Source: Get Guild Bans

aiocord.http.routes.get_guild_ban = <Route(GET /guilds/{0}/bans/{1})>

Source: Get Guild Ban

aiocord.http.routes.create_guild_ban = <Route(PUT /guilds/{0}/bans/{1})>

Source: Create Guild Ban

aiocord.http.routes.delete_guild_ban = <Route(DELETE /guilds/{0}/bans/{1})>

Source: Remove Guild Ban

aiocord.http.routes.get_guild_roles = <Route(GET /guilds/{0}/roles)>

Source: Get Guild Roles

aiocord.http.routes.create_guild_role = <Route(POST /guilds/{0}/roles)>

Source: Create Guild Role

aiocord.http.routes.update_guild_role_positions = <Route(PATCH /guilds/{0}/roles)>

Source: Modify Guild Role Positions

aiocord.http.routes.update_guild_role = <Route(PATCH /guilds/{0}/roles/{1})>

Source: Modify Guild Role

aiocord.http.routes.update_guild_mfa_level = <Route(POST /guilds/{0}/mfa)>

Source: Modify Guild Mfa Level

aiocord.http.routes.delete_guild_role = <Route(DELETE /guilds/{0}/roles/{1})>

Source: Delete Guild Role

aiocord.http.routes.get_guild_prune_count = <Route(GET /guilds/{0}/prune)>

Source: Get Guild Prune Count

aiocord.http.routes.start_guild_prune = <Route(POST /guilds/{0}/prune)>

Source: Begin Guild Prune

aiocord.http.routes.get_guild_voice_regions = <Route(GET /guilds/{0}/regions)>

Source: Get Guild Voice Regions

aiocord.http.routes.get_guild_invites = <Route(GET /guilds/{0}/invites)>

Source: Get Guild Invites

aiocord.http.routes.get_guild_integrations = <Route(GET /guilds/{0}/integrations)>

Source: Get Guild Integrations

aiocord.http.routes.delete_guild_integration = <Route(DELETE /guilds/{0}/integrations/{1})>

Source: Delete Guild Integration

aiocord.http.routes.get_guild_widget_settings = <Route(GET /guilds/{0}/widget)>

Source: Get Guild Widget Settings

aiocord.http.routes.update_guild_widget = <Route(PATCH /guilds/{0}/widget)>

Source: Modify Guild Widget

aiocord.http.routes.get_guild_widget = <Route(GET /guilds/{0}/widget.json)>

Source: Get Guild Widget

aiocord.http.routes.get_guild_vanity_url = <Route(GET /guilds/{0}/vanity-url)>

Source: Get Guild Vanity Url

aiocord.http.routes.get_guild_widget_image = <Route(GET /guilds/{0}/widget.png)>

Source: Get Guild Widget Image

aiocord.http.routes.get_guild_welcome_screen = <Route(GET /guilds/{0}/welcome-screen)>

Source: Get Guild Welcome Screen

aiocord.http.routes.update_guild_welcome_screen = <Route(PATCH /guilds/{0}/welcome-screen)>

Source: Modify Guild Welcome Screen

aiocord.http.routes.get_guild_onboarding = <Route(GET /guilds/{0}/onboarding)>

Source: Get Guild Onboarding

aiocord.http.routes.update_self_voice_state = <Route(PATCH /guilds/{0}/voice-states/@me)>

Source: Modify Current User Voice State

aiocord.http.routes.update_voice_state = <Route(PATCH /guilds/{0}/voice-states/{1})>

Source: Modify User Voice State

aiocord.http.routes.get_guild_scheduled_events = <Route(GET /guilds/{0}/scheduled-events)>

Source: List Scheduled Events For Guild

aiocord.http.routes.create_guild_scheduled_event = <Route(POST /guilds/{0}/scheduled-events)>

Source: Create Guild Scheduled Event

aiocord.http.routes.get_guild_scheduled_event = <Route(GET /guilds/{0}/scheduled-events/{1})>

Source: Get Guild Scheduled Event

aiocord.http.routes.update_guild_scheduled_event = <Route(PATCH /guilds/{0}/scheduled-events/{1})>

Source: Modify Guild Scheduled Event

aiocord.http.routes.delete_guild_scheduled_event = <Route(DELETE /guilds/{0}/scheduled-events/{1})>

Source: Delete Guild Scheduled Event

aiocord.http.routes.get_guild_scheduled_event_users = <Route(GET /guilds/{0}/scheduled-events/{1}/users)>

Source: Get Guild Scheduled Event Users

aiocord.http.routes.get_guild_template = <Route(GET /guilds/templates/{0})>

Source: Get Guild Template

aiocord.http.routes.create_guild_via_guild_template = <Route(POST /guilds/templates/{0})>

Source: Create Guild From Guild Template

aiocord.http.routes.get_guild_templates = <Route(GET /guilds/{0}/templates)>

Source: Get Guild Templates

aiocord.http.routes.create_guild_template = <Route(POST /guilds/{0}/templates)>

Source: Create Guild Template

aiocord.http.routes.sync_guild_template = <Route(PUT /guilds/{0}/templates/{1})>

Source: Sync Guild Template

aiocord.http.routes.update_guild_template = <Route(PATCH /guilds/{0}/templates/{1})>

Source: Modify Guild Template

aiocord.http.routes.delete_guild_template = <Route(DELETE /guilds/{0}/templates/{1})>

Source: Delete Guild Template

aiocord.http.routes.get_invite = <Route(GET /invites/{0})>

Source: Get Invite

aiocord.http.routes.delete_invite = <Route(DELETE /invites/{0})>

Source: Delete Invite

aiocord.http.routes.create_stage_instance = <Route(POST /stage-instances)>

Source: Create Stage Instance

aiocord.http.routes.get_stage_instance = <Route(GET /stage-instances/{0})>

Source: Get Stage Instance

aiocord.http.routes.update_stage_instance = <Route(PATCH /stage-instances/{0})>

Source: Modify Stage Instance

aiocord.http.routes.delete_stage_instance = <Route(DELETE /stage-instances/{0})>

Source: Delete Stage Instance

aiocord.http.routes.get_sticker = <Route(GET /stickers/{0})>

Source: Get Sticker

aiocord.http.routes.get_sticker_packs = <Route(GET /sticker-packs)>

Source: List Nitro Sticker Packs

aiocord.http.routes.get_guild_stickers = <Route(GET /guilds/{0}/stickers)>

Source: List Guild Stickers

aiocord.http.routes.get_guild_sticker = <Route(GET /guilds/{0}/stickers/{1})>

Source: Get Guild Sticker

aiocord.http.routes.create_guild_sticker = <Route(POST /guilds/{0}/stickers)>

Source: Create Guild Sticker

aiocord.http.routes.update_guild_sticker = <Route(PATCH /guilds/{0}/stickers/{1})>

Source: Modify Guild Sticker

aiocord.http.routes.delete_guild_sticker = <Route(DELETE /guilds/{0}/stickers/{1})>

Source: Delete Guild Sticker

aiocord.http.routes.get_self_user = <Route(GET /users/@me)>

Source: Get Current User

aiocord.http.routes.get_user = <Route(GET /users/{0})>

Source: Get User

aiocord.http.routes.update_self_user = <Route(PATCH /users/@me)>

Source: Modify Current User

aiocord.http.routes.get_self_guilds = <Route(GET /users/@me/guilds)>

Source: Get Current User Guilds

aiocord.http.routes.get_self_guild_member = <Route(GET /users/@me/guilds/{0}/member)>

Source: Get Current User Guild Member

aiocord.http.routes.delete_self_guild_member = <Route(DELETE /users/@me/guilds/{0})>

Source: Leave Guild

aiocord.http.routes.create_self_channel = <Route(POST /users/@me/channels)>

Source: Create Dm

aiocord.http.routes.get_self_connections = <Route(GET /users/@me/connections)>

Source: Get User Connections

aiocord.http.routes.get_self_application_role_connection = <Route(GET /users/@me/applications/{0}/role-connection)>

Source: Get User Application Role Connection

aiocord.http.routes.update_self_application_role_connection = <Route(PUT /users/@me/applications/{0}/role-connection)>

Source: Update User Application Role Connection

aiocord.http.routes.get_voice_regions = <Route(GET /voice/regions)>

Source: List Voice Regions

aiocord.http.routes.get_self_voice_state = <Route(GET /guilds/{0}/voie-states/@me)>

Source: Get Current User Voice State

aiocord.http.routes.create_webhook = <Route(POST /channels/{0}/webhooks)>

Source: Create Webhook

aiocord.http.routes.get_channel_webhooks = <Route(GET /channels/{0}/webhooks)>

Source: Get Channel Webhooks

aiocord.http.routes.get_guild_webhooks = <Route(GET /guilds/{0}/webhooks)>

Source: Get Guild Webhooks

aiocord.http.routes.get_webhook = <Route(GET /webhooks/{0})>

Source: Get Webhook

aiocord.http.routes.get_webhook_via_token = <Route(GET /webhooks/{0}/{1})>

Source: Get Webhook With Token

aiocord.http.routes.update_webhook = <Route(PATCH /webhooks/{0})>

Source: Modify Webhook

aiocord.http.routes.update_webhook_via_token = <Route(PATCH /webhooks/{0}/{1})>

Source: Modify Webhook With Token

aiocord.http.routes.delete_webhook = <Route(DELETE /webhooks/{0})>

Source: Delete Webhook

aiocord.http.routes.delete_webhook_via_token = <Route(DELETE /webhooks/{0}/{1})>

Source: Delete Webhook With Token

aiocord.http.routes.create_webhook_message = <Route(POST /webhooks/{0}/{1})>

Source: Execute Webhook

aiocord.http.routes.create_webhook_message_slack_compatible = <Route(POST /webhooks/{0}/{1}/slack)>

Source: Execute Slack Compatible Webhook

aiocord.http.routes.create_webhook_message_github_compatible = <Route(POST /webhooks/{0}/{1}/github)>

Source: Execute Github Compatible Webhook

aiocord.http.routes.get_webhook_message = <Route(GET /webhooks/{0}/{1}/messages/{2})>

Source: Get Webhook Message

aiocord.http.routes.update_webhook_message = <Route(PATCH /webhooks/{0}/{1}/messages/{2})>

Source: Edit Webhook Message

aiocord.http.routes.delete_webhook_message = <Route(DELETE /webhooks/{0}/{1}/messages/{2})>

Source: Delete Webhook Message

aiocord.http.routes.get_gateway = <Route(GET /gateway)>

Source: Get Gateway

aiocord.http.routes.get_gateway_bot = <Route(GET /gateway/bot)>

Source: Get Gateway Bot

aiocord.http.routes.get_self_application_information = <Route(GET /oauth2/applications/@me)>

Source: Get Current Bot Application Information

aiocord.http.routes.get_self_authorization_information = <Route(GET /oauth2/@me)>

Source: Get Current Authorization Information

aiocord.http.routes.get_skus = <Route(GET /applications/{0}/skus)>

Source: List SKUs

aiocord.http.routes.get_entitlements = <Route(GET /applications/{0}/entitlements)>

Source: List Entitlements

aiocord.http.routes.create_entitlement = <Route(POST /applications/{0}/entitlements)>

Source: Create Test Entitlement

aiocord.http.routes.delete_entitlement = <Route(DELETE /applications/{0}/entitlements/{1})>

Source: Delete Test Entitlement

errors

exception aiocord.http.errors.Base

Bases: Exception

Base module error.

exception aiocord.http.errors.Client

Bases: Base

Base for client errors.

exception aiocord.http.errors.Interrupted

Bases: Client

A request was interrupted.

exception aiocord.http.errors.Request(response, data)

Bases: Client

Received a response with an unsupported status.

property response

property data

exception aiocord.http.errors.Internal(response, data)

Bases: Request

There was an server error.

exception aiocord.http.errors.BadRequest(response, data)

Bases: Request

The request was badly formatted.

exception aiocord.http.errors.Unauthorized(response, data)

Bases: Request

The request token is missing or invalid.

exception aiocord.http.errors.Forbidden(response, data)

Bases: Request

The user is missing the necessary permissions for the request.

exception aiocord.http.errors.NotFound(response, data)

Bases: Request

The target resource could not be found.

exception aiocord.http.errors.RateLimited(response, data)

Bases: Request

There are too many requests being sent.

gateway

The Gateway part of the Discord API.

client

class aiocord.gateway.client.Client(callback, session, token, intents, uri, info_id, info_count, encoding='json', present=None, loads=<function loads>, dumps=<function dumps>)

Bases: object

Core means of communication with the Discord Gateway API.

Parameters:

• callback (Callable[[str, Any], Awaitable[None]]) – Used for dispatching events.

• session (ClientSession) – Used for creating websocket connections.

• token (str) – Used for authentication during identify and resume.

• intents (int) – Used for signaling which events to allow through during identify.

• uri (str) – Used for creating werbsocket connections. Must be fetched from Get Gateway:ddoc: Bot </topics/gateway#get-gateway-bot>.

• info_id (int) – The id of the shard.

• info_count (int) – The total amount of shards.

• encoding (str) – The desired encoding. Can be 'json' or 'etf', and by chosing either, loads and dumps should be adjusted accordingly.

• present (Optional[Callable[[], Awaitable[dict]]]) – Used for fetching the initial presence to send during identify.

• loads (Callable[[str], Any]) – Used for converting json text to objects.

• dumps (Callable[[Any], str]) – Used for converting json objects to text.

property info

property event_identify

property event_complete

inform_session(session_id, resume_uri)

Update the session information.

Parameters:

• session_id (str) – The session id. Can be found as 'session_id' in the ready event.

• resume_uri (str) – Used for resuming the session. Can be found as 'resume_gateway_url' in the ready event.

async request_guild_members(data)

Source: Request Guild Members

update_voice_state(data)

Source: Update Voice State

Return type:

Awaitable[None]

update_presence(status, activities, since, afk)

Source: Update Presence

Return type:

Awaitable[None]

start()

Start the connection lifecycle.

Return type:

Awaitable[None]

stop()

Cancel tasks and close connections.

Return type:

Awaitable[None]

errors

exception aiocord.gateway.errors.Base

Bases: Exception

Base module error.

exception aiocord.gateway.errors.Client

Bases: Base

Base for client errors.

exception aiocord.gateway.errors.Interrupted

Bases: Connection

Received a non-salvageable close code.

exception aiocord.gateway.errors.Invalidated

Bases: Connection

Received a non-salvageable invalid session.

voice

The Voice part of the Discord API.

client

class aiocord.voice.client.Client(callback, session, user_id, guild_id, session_id, token, uri, loads=<function loads>, dumps=<function dumps>)

Bases: object

Core means of communication with the Discord Voice API.

Parameters:

• callback (Callable[[str, Any], Awaitable[None]]) – Used for dispatching events.

• session (ClientSession) – Used for creating websocket connections.

• user_id (str) – The connecting client’s user id.

• guild_id (str) – The connecting guild’s id.

• session_id (str) – The voice state session id.

• token (str) – The voice server token.

• uri (str) – The voice server endpoint.

• loads (Callable[[str], Any]) – Used for converting json text to objects.

• dumps (Callable[[Any], str]) – Used for converting json objects to text.

property guild_id: str

The connected guild’s id.

property event_identify: Event

Set after the identify payload has been sent.

property event_complete: Event

Set after the session description has been handled or when resumed.

property codec: str

The name of the expected codec.

property player: Player

The player.

send_audio(samples, data)

Send an audio packet.

Parameters:

• samples (int) – The sample count per frame.

• data (bytes) – The encoded packet data.

Return type:

None

start()

Start the connection lifecycle.

Return type:

Awaitable[None]

stop()

Cancel tasks and close connections.

Return type:

Awaitable[None]

audio

class aiocord.voice.audio.Audio(source='-', executable='ffmpeg', codec='opus', sample_rate=48000, channels=2, bit_depth=16, frame_duration=0.02)

Bases: object

Manages a FFMPEG subprocess for converting and encoding audio.

:param Source:

The source of the file, or '-' if data is going to be fed later.

Parameters:

executable (str) – The path to the FFMPEG executable.

All other parameters should remain as-is according to discord’s specification.

property sample_rate

property channels

property frame_duration

property sample_bytes_count

property frame_samples_count

property frame_bytes_count

property join

feed(data)

Feed data if '-' has been used for the source.

Parameters:

data (bytes) – The data to write to the subprocess.

Return type:

None

get()

Get a single audio packet.

Return type:

Awaitable[bytes]

start()

Create the subprocess for feeding and reading data.

Return type:

Awaitable[None]

stop()

Stop the reading data and close the subprocess.

Return type:

Awaitable[None]

player

class aiocord.voice.player.Player(send)

Bases: object

Manages timely sending voice packets.

Parameters:

send (Callable[[int, bytes], None]) – Used with (samples, data) for sending.

property audio: Audio

The current audio source.

start(audio)

Start sending voice packets.

Parameters:

audio (Audio) – Used for reading.

Return type:

Awaitable[None]

Note

Will close() the source when all packets have been sent.

stop()

Close the current audio source.

Return type:

Awaitable[None]

errors

exception aiocord.voice.errors.Base

Bases: Exception

Base module error.

exception aiocord.voice.errors.Client

Bases: Base

Base for client errors.

exception aiocord.voice.errors.Connection

Bases: Client

Base for connection-related errors.

exception aiocord.voice.errors.Interrupted

Bases: Connection

Received a non-salvageable close code.

exception aiocord.voice.errors.Transmission

Bases: Client

Base for creating and sending audio errors.

exception aiocord.voice.errors.SocketClosed

Bases: Transmission

The socket is closed upon sending audio.

exception aiocord.voice.errors.Player

Bases: Base

Base for player.Player errors.

exception aiocord.voice.errors.Audio

Bases: Player

Base for audio.Audio errors.

exception aiocord.voice.errors.Stream

Bases: Audio

Base for stream.Stream errors.

exception aiocord.voice.errors.StreamPrefixMissing

Bases: Stream

Got an unexpected audio stream OGG prefix.

exception aiocord.voice.errors.StreamComplete

Bases: Stream

The audio OGG stream has been exhausted.

model

All forms of data that may be encountered while interacting Discord API.

types

All types found within more complex objects.

aiocord.model.types.String

alias of str

aiocord.model.types.Boolean

alias of bool

aiocord.model.types.Integer

alias of int

aiocord.model.types.Decimal

alias of float

aiocord.model.types.List

alias of list

aiocord.model.types.Dict

alias of dict

class aiocord.model.types.Timestamp

Bases: int

A Unix Timestamp.

property datetime: datetime

The datetime object representation.

mention(style=None)

Get the mention.

Parameters:

style (TimestampStyle) – The visual representation type.

class aiocord.model.types.ISO8601Timestamp

Bases: str

Source: ISO8601 Date/Time

property datetime: datetime

The datetime object representation.

class aiocord.model.types.Snowflake

Bases: int

Source: Snowflakes

property timestamp: Timestamp

The internal timestamp.

enums

All enumerations found within more complex objects.

class aiocord.model.enums.ApplicationCommandType(data, *args, **kwargs)

Bases: IntEnum

Source: Application Command Option Types

chat_input = 1

user = 2

message = 3

class aiocord.model.enums.StatusType(data, *args, **kwargs)

Bases: StrEnum

Source: Update Presence Status Types

online = 'online'

dnd = 'dnd'

idle = 'idle'

invisible = 'invisible'

offline = 'offline'

class aiocord.model.enums.Locale(data, *args, **kwargs)

Bases: StrEnum

Source: Locales

indonesian = 'id'

danish = 'da'

german = 'de'

english_uk = 'en-GB'

english_us = 'en-US'

spanish_es = 'es-ES'

french = 'fr'

croatian = 'hr'

italian = 'it'

lithuanian = 'lt'

hungarian = 'hu'

dutch = 'nl'

norwegian = 'no'

polish = 'pl'

portuguese_br = 'pt-BR'

romanian = 'ro'

finnish = 'fi'

swedish_se = 'sv-SE'

vietnamese = 'vi'

turkish = 'tr'

czech = 'cs'

greek = 'el'

bulgarian = 'bg'

russian = 'ru'

ukrainian = 'uk'

hindi = 'hi'

thai = 'th'

chinese_cn = 'zh-CN'

japanese = 'ja'

chinese_tw = 'zh-TW'

korean = 'ko'

class aiocord.model.enums.Permissions(data, *args, **kwargs)

Bases: IntFlag

Source: Permission Flags

Object accessing using dot-notation returns bool indicating whether the permission is present.

Checking whether the role has the “view_channel” permission.

if role.permissions.view_channel:
    ...

create_instant_invite = 1

kick_members = 2

ban_members = 4

administrator = 8

manage_channels = 16

manage_guild = 32

add_reactions = 64

view_audit_log = 128

priority_speaker = 256

stream = 512

view_channel = 1024

send_messages = 2048

send_tts_messages = 4096

manage_messages = 8192

embed_links = 16384

attach_files = 32768

read_message_history = 65536

mention_everyone = 131072

use_external_emojis = 262144

view_guild_insights = 524288

connect = 1048576

speak = 2097152

mute_members = 4194304

deafen_members = 8388608

move_members = 16777216

use_vad = 33554432

change_nickname = 67108864

manage_nicknames = 134217728

manage_roles = 268435456

manage_webhooks = 536870912

manage_guild_expressions = 1073741824

use_application_commands = 2147483648

request_to_speak = 4294967296

manage_events = 8589934592

manage_threads = 17179869184

create_public_threads = 34359738368

create_private_threads = 68719476736

use_external_stickers = 137438953472

send_messages_in_threads = 274877906944

use_embedded_activities = 549755813888

moderate_members = 1099511627776

view_creator_monetization_analytics = 2199023255552

use_soundboard = 4398046511104

create_guild_expressions = 8796093022208

create_events = 17592186044416

send_voice_messages = 70368744177664

use_external_apps = 1125899906842624

class aiocord.model.enums.ApplicationCommandOptionType(data, *args, **kwargs)

Bases: IntEnum

Source: Application Command Option Types

sub_command = 1

sub_command_group = 2

string = 3

integer = 4

boolean = 5

user = 6

channel = 7

role = 8

mentionable = 9

number = 10

attachment = 11

class aiocord.model.enums.ChannelType(data, *args, **kwargs)

Bases: IntEnum

Source: Channel Types

guild_text = 0

dm = 1

guild_voice = 2

group_dm = 3

guild_category = 4

guild_announcement = 5

announcement_thread = 10

public_thread = 11

private_thread = 12

guild_stage_voice = 13

guild_directory = 14

guild_forum = 15

guild_media = 16

class aiocord.model.enums.MessageComponentType(data, *args, **kwargs)

Bases: IntEnum

Source: Component Types

action_row = 1

button = 2

string_select = 3

text_input = 4

user_select = 5

role_select = 6

mentionable_select = 7

channel_select = 8

class aiocord.model.enums.MessageButtonComponentStyle(data, *args, **kwargs)

Bases: IntEnum

Source: Button Styles

primary = 1

secondary = 2

success = 3

danger = 4

link = 5

premium = 6

class aiocord.model.enums.MessageTextInputComponentStyle(data, *args, **kwargs)

Bases: IntEnum

Source: Text Input Styles

short = 1

paragraph = 2

class aiocord.model.enums.InteractionType(data, *args, **kwargs)

Bases: IntEnum

Source: Interaction Types

ping = 1

application_command = 2

message_component = 3

application_command_autocomplete = 4

modal_submit = 5

class aiocord.model.enums.InteractionContextType(data, *args, **kwargs)

Bases: IntEnum

Source: Interaction Context Types

guild = 0

bot_dm = 1

private_channel = 2

class aiocord.model.enums.InteractionResponseType(data, *args, **kwargs)

Bases: IntEnum

Source: Interaction Callback Types

pong = 1

channel_message_with_source = 4

deferred_channel_message_with_source = 5

deferred_update_message = 6

update_message = 7

application_command_autocomplete_result = 8

modal = 9

launch_activity = 12

class aiocord.model.enums.ApplicationIntegrationType(data, *args, **kwargs)

Bases: IntEnum

Source: Application Integration Types

guild_install = 0

user_install = 1

class aiocord.model.enums.ApplicationFlags(data, *args, **kwargs)

Bases: IntFlag

Source: Application Flags

application_auto_moderation_rule_create_badge = 64

gateway_presence = 4096

gateway_presence_limited = 8192

gateway_guild_members = 16384

gateway_guild_members_limited = 32768

verification_pending_guild_limit = 65536

embedded = 131072

gateway_message_content = 262144

gateway_message_content_limited = 524288

application_command_badge = 8388608

class aiocord.model.enums.ApplicationRoleConnectionMetadataType(data, *args, **kwargs)

Bases: IntEnum

Source: Application Role Connection Metadata Types

integer_less_than_or_equal = 1

integer_greater_than_or_equal = 2

integer_equal = 3

integer_not_equal = 4

datetime_less_than_or_equal = 5

datetime_greater_than_or_equal = 6

boolean_equal = 7

boolean_not_equal = 8

class aiocord.model.enums.AuditLogEvent(data, *args, **kwargs)

Bases: IntEnum

Source: Audit Log Events

guild_update = 1

channel_create = 10

channel_update = 11

channel_delete = 12

channel_overwrite_create = 13

channel_overwrite_update = 14

channel_overwrite_delete = 15

member_kick = 20

member_prune = 21

member_ban_add = 22

member_ban_remove = 23

member_update = 24

member_role_update = 25

member_move = 26

member_disconnect = 27

bot_add = 28

role_create = 30

role_update = 31

role_delete = 32

invite_create = 40

invite_update = 41

invite_delete = 42

webhook_create = 50

webhook_update = 51

webhook_delete = 52

emoji_create = 60

emoji_update = 61

emoji_delete = 62

message_delete = 72

message_bulk_delete = 73

message_pin = 74

message_unpin = 75

integration_create = 80

integration_update = 81

integration_delete = 82

stage_instance_create = 83

stage_instance_update = 84

stage_instance_delete = 85

sticker_create = 90

sticker_update = 91

sticker_delete = 92

guild_scheduled_event_create = 100

guild_scheduled_event_update = 101

guild_scheduled_event_delete = 102

thread_create = 110

thread_update = 111

thread_delete = 112

application_command_permission_update = 121

auto_moderation_rule_create = 140

auto_moderation_rule_update = 141

auto_moderation_rule_delete = 142

auto_moderation_block_message = 143

auto_moderation_flag_to_channel = 144

auto_moderation_user_communication_disabled = 145

class aiocord.model.enums.OptionalAuditLogEntryInfoOverwrittenEntityType(data, *args, **kwargs)

Bases: StrEnum

Source: Optional Audit Entry Info

role = '0'

member = '1'

class aiocord.model.enums.AutoModerationTriggerType(data, *args, **kwargs)

Bases: IntEnum

Source: Trigger Types

keyword = 1

spam = 3

keyword_preset = 4

mention_spam = 5

member_profile = 6

class aiocord.model.enums.AutoModerationRuleKeywordPresetType(data, *args, **kwargs)

Bases: IntEnum

Source: Keyword Preset Types

profanity = 1

sexual_content = 2

slurs = 3

class aiocord.model.enums.AutoModerationRuleEventType(data, *args, **kwargs)

Bases: IntEnum

Source: Event Types

message_send = 1

class aiocord.model.enums.AutoModerationActionType(data, *args, **kwargs)

Bases: IntEnum

Source: Action Types

block_message = 1

send_alert_message = 2

timeout = 3

block_member_interaction = 4

class aiocord.model.enums.ChannelVideoQualityMode(data, *args, **kwargs)

Bases: IntEnum

Source: Video Quality Modes

auto = 1

full = 2

class aiocord.model.enums.ChannelFlags(data, *args, **kwargs)

Bases: IntFlag

Source: Channel Flags

pinned = 2

require_tag = 16

class aiocord.model.enums.ChannelSortOrderType(data, *args, **kwargs)

Bases: IntEnum

Source: Sort Order Types

latest_activity = 0

creation_date = 1

class aiocord.model.enums.ForumLayoutType(data, *args, **kwargs)

Bases: IntEnum

Source: Forum Layout Types

not_set = 0

list_view = 1

gallery_view = 2

class aiocord.model.enums.MessageType(data, *args, **kwargs)

Bases: IntEnum

Source: Message Types

default = 0

recipient_add = 1

recipient_remove = 2

call = 3

channel_name_change = 4

channel_icon_change = 5

channel_pinned_message = 6

user_join = 7

guild_boost = 8

guild_boost_tier_1 = 9

guild_boost_tier_2 = 10

guild_boost_tier_3 = 11

channel_follow_add = 12

guild_discovery_disqualified = 14

guild_discovery_requalified = 15

guild_discovery_grace_period_initial_warning = 16

guild_discovery_grace_period_final_warning = 17

thread_created = 18

reply = 19

chat_input_command = 20

thread_starter_message = 21

guild_invite_reminder = 22

context_menu_command = 23

auto_moderation_action = 24

role_subscription_purchase = 25

interaction_premium_upsell = 26

stage_start = 27

stage_end = 28

stage_speaker = 29

stage_topic = 31

guild_application_premium_subscription = 32

class aiocord.model.enums.MessageActivityType(data, *args, **kwargs)

Bases: IntEnum

Source: Message Activity Types

join = 1

spectate = 2

listen = 3

join_request = 5

class aiocord.model.enums.MessageFlags(data, *args, **kwargs)

Bases: IntEnum

Source: Message Flags

crossposted = 1

is_crosspost = 2

suppress_embeds = 4

source_message_deleted = 8

urgent = 16

has_thread = 32

ephemeral = 64

loading = 128

failed_to_mention_some_roles_in_thread = 256

suppress_notifications = 4096

is_voice_message = 8192

class aiocord.model.enums.OverwriteType(data, *args, **kwargs)

Bases: IntEnum

Source: Overwrite Structure

role = 0

member = 1

class aiocord.model.enums.EmbedType(data, *args, **kwargs)

Bases: StrEnum

Source: Embed Types

rich = 'rich'

image = 'image'

video = 'video'

gifv = 'gifv'

article = 'article'

link = 'link'

class aiocord.model.enums.AllowedMentionsType(data, *args, **kwargs)

Bases: StrEnum

Source: Allowed Mention Types

roles = 'roles'

users = 'users'

everyone = 'everyone'

class aiocord.model.enums.GuildVerificationLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Verification Level

none = 0

low = 1

medium = 2

high = 3

very_high = 4

class aiocord.model.enums.GuildDefaultMessageNotificationLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Default Message Notification Level

all_messages = 0

only_mentions = 1

class aiocord.model.enums.GuildExplicitContentFilterLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Explicit Content Filter Level

disabled = 0

members_without_roles = 1

all_members = 2

class aiocord.model.enums.GuildFeature(data, *args, **kwargs)

Bases: StrEnum

Source: Guild Features

animated_banner = 'ANIMATED_BANNER'

animated_icon = 'ANIMATED_ICON'

application_command_permissions_v2 = 'APPLICATION_COMMAND_PERMISSIONS_V2'

auto_moderation = 'AUTO_MODERATION'

banner = 'BANNER'

community = 'COMMUNITY'

creator_monetizable_provisional = 'CREATOR_MONETIZABLE_PROVISIONAL'

creator_store_page = 'CREATOR_STORE_PAGE'

developer_support_server = 'DEVELOPER_SUPPORT_SERVER'

discoverable = 'DISCOVERABLE'

featurable = 'FEATURABLE'

invites_disabled = 'INVITES_DISABLED'

invite_splash = 'INVITE_SPLASH'

member_verification_gate_enabled = 'MEMBER_VERIFICATION_GATE_ENABLED'

more_stickers = 'MORE_STICKERS'

news = 'NEWS'

partnered = 'PARTNERED'

preview_enabled = 'PREVIEW_ENABLED'

role_icons = 'ROLE_ICONS'

role_subscriptions_available_for_purchase = 'ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE'

role_subscriptions_enabled = 'ROLE_SUBSCRIPTIONS_ENABLED'

ticketed_events_enabled = 'TICKETED_EVENTS_ENABLED'

vanity_url = 'VANITY_URL'

verified = 'VERIFIED'

vip_regions = 'VIP_REGIONS'

welcome_screen_enabled = 'WELCOME_SCREEN_ENABLED'

raid_alerts_disabled = 'RAID_ALERTS_DISABLED'

text_in_voice_enabled = 'TEXT_IN_VOICE_ENABLED'

class aiocord.model.enums.GuildMFALevel(data, *args, **kwargs)

Bases: IntEnum

Source: Mfa Level

none = 0

elevated = 1

class aiocord.model.enums.GuildNSFWLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Guild Nsfw Level

default = 0

explicit = 1

safe = 2

age_restricted = 3

class aiocord.model.enums.GuildSystemChannelFlags(data, *args, **kwargs)

Bases: IntFlag

Source: System Channel Flags

suppress_join_notifications = 1

suppress_premium_subscriptions = 2

suppress_guild_reminder_notifications = 4

suppress_join_notification_replies = 8

suppress_role_subscription_purchase_notifications = 16

suppress_role_subscription_purchase_notification_replies = 32

class aiocord.model.enums.GuildPremiumTier(data, *args, **kwargs)

Bases: IntEnum

Source: Premium Tier

none = 0

tier_1 = 1

tier_2 = 2

tier_3 = 3

class aiocord.model.enums.GuildMemberFlags(data, *args, **kwargs)

Bases: IntFlag

Source: Guild Member Flags

did_rejoin = 1

completed_onboarding = 2

bypasses_verification = 4

started_onboarding = 8

class aiocord.model.enums.IntegrationExpireBehaviorType(data, *args, **kwargs)

Bases: IntEnum

Source: Integration Expire Behaviors

remove_role = 0

kick = 1

class aiocord.model.enums.GuildOnboardingPromptType(data, *args, **kwargs)

Bases: IntEnum

Source: Prompt Types

multiple_choice = 0

dropdown = 1

class aiocord.model.enums.GuildScheduledEventPrivacyLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Guild Scheduled Event Privacy Level

guild_only = 2

class aiocord.model.enums.GuildScheduledEventEntityType(data, *args, **kwargs)

Bases: IntEnum

Source: Guild Scheduled Event Entity Types

stage_instance = 1

voice = 2

external = 3

class aiocord.model.enums.GuildScheduledEventStatus(data, *args, **kwargs)

Bases: IntEnum

Source: Guild Scheduled Event Status

scheduled = 1

active = 2

completed = 3

canceled = 4

class aiocord.model.enums.InviteTargetType(data, *args, **kwargs)

Bases: IntEnum

Source: Invite Target Types

stream = 1

embedded_application = 2

class aiocord.model.enums.StageInstancePrivacyLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Privacy Level

public = 1

guild_only = 2

class aiocord.model.enums.StickerType(data, *args, **kwargs)

Bases: IntEnum

Source: Sticker Types

standard = 1

guild = 2

class aiocord.model.enums.StickerFormatType(data, *args, **kwargs)

Bases: IntEnum

Source: Sticker Format Types

png = 1

apng = 2

lottie = 3

gif = 4

class aiocord.model.enums.UserFlags(data, *args, **kwargs)

Bases: IntFlag

Source: User Flags

staff = 1

partner = 2

hypesquad = 4

bug_hunter_level_1 = 8

hypesquad_online_house_1 = 64

hypesquad_online_house_2 = 128

hypesquad_online_house_3 = 256

premium_early_supporter = 512

team_pseudo_user = 1024

bug_hunter_level_2 = 16384

verified_bot = 65536

verified_developer = 131072

certified_moderator = 262144

bot_http_interactions = 524288

active_developer = 4194304

class aiocord.model.enums.UserPremiumType(data, *args, **kwargs)

Bases: IntEnum

Source: Premium Types

none = 0

nitro_classic = 1

nitro = 2

nitro_basic = 3

class aiocord.model.enums.ConnectionVisibilityType(data, *args, **kwargs)

Bases: IntEnum

Source: Visibility Types

none = 0

everyone = 1

class aiocord.model.enums.WebhookType(data, *args, **kwargs)

Bases: IntEnum

Source: Webhook Types

incoming = 1

channel_follower = 2

application = 3

class aiocord.model.enums.ActivityType(data, *args, **kwargs)

Bases: IntEnum

Source: Activity Types

game = 0

streaming = 1

listening = 2

watching = 3

custom = 4

competing = 5

class aiocord.model.enums.ActivityFlags(data, *args, **kwargs)

Bases: IntFlag

Source: Activity Types

instance = 1

join = 2

spectate = 4

join_request = 8

sync = 16

play = 32

party_privacy_friends = 64

party_privacy_voice_channel = 128

embedded = 256

class aiocord.model.enums.TeamMemberMembershipState(data, *args, **kwargs)

Bases: IntEnum

Source: Data Models Membership State Enum

invited = 1

accepted = 2

class aiocord.model.enums.WidgetStyleOption(data, *args, **kwargs)

Bases: StrEnum

Source: Widget Style Options

shield = 'shield'

banner1 = 'banner1'

banner2 = 'banner2'

banner3 = 'banner3'

banner4 = 'banner4'

class aiocord.model.enums.SpeechFlags(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntFlag

Source: Speaking Flags

microphone = 1

soundshare = 2

priority = 4

class aiocord.model.enums.TimestampStyle(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

Source: Message Formatting Timestamp Styles

short_time = 't'

long_time = 'T'

short_date = 'd'

long_date = 'D'

short_date_time = 'f'

long_date_time = 'F'

relative_time = 'R'

class aiocord.model.enums.SKUType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Source: SKU Types

subscription = 5

subscription_group = 6

class aiocord.model.enums.SKUFlags(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntFlag

Source: SKU Flags

available = 4

guild_subscription = 128

user_subscription = 256

class aiocord.model.enums.EntitlementOwnerType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Source: Entitlement Owner Type

guild_subscription = 1

user_subscription = 2

protocols

All data models that may be sent or received.

These can be used directly when formulating request payloads.

class aiocord.model.protocols.ApplicationCommand

Bases: TypedDict

id: Snowflake

type: ApplicationCommandType

application_id: Snowflake

guild_id: Snowflake

name: str

name_localizations: dict[Locale, str]

description: str

description_localizations: dict[Locale, str]

options: list[ApplicationCommandOption]

default_member_permissions: Permissions

default_permission: bool

nsfw: bool

version: Snowflake

integration_types: list[ApplicationIntegrationType]

contexts: list[InteractionContextType]

class aiocord.model.protocols.ApplicationCommandOption

Bases: TypedDict

type: ApplicationCommandOptionType

name: str

name_localizations: dict[Locale, str]

description: str

description_localizations: dict[Locale, str]

required: bool

choices: list[ApplicationCommandOptionChoice]

options: list[ApplicationCommandOption]

channel_types: list[ChannelType]

min_value: Union[int, float]

max_value: Union[int, float]

min_length: int

max_length: int

autocomplete: bool

class aiocord.model.protocols.ApplicationCommandOptionChoice

Bases: TypedDict

name: str

name_localizations: dict[Locale, str]

value: Union[str, int, float]

class aiocord.model.protocols.GuildApplicationCommandPermissions

Bases: TypedDict

id: Snowflake

application_id: Snowflake

guild_id: Snowflake

permissions: Collection[ApplicationCommandPermission]

class aiocord.model.protocols.ApplicationCommandPermissions

Bases: TypedDict

id: Snowflake

type: ApplicationCommandPermissionType

permission: bool

class aiocord.model.protocols.MessageActionRowComponent

Bases: TypedDict

type: MessageComponentType

components: list[Union[MessageButtonComponent, MessageSelectMenuComponent, MessageTextInputComponent]]

class aiocord.model.protocols.MessageButtonComponent

Bases: TypedDict

type: int

style: int

label: str

emoji: Emoji

custom_id: str

url: str

disabled: bool

class aiocord.model.protocols.MessageSelectMenuComponent

Bases: TypedDict

type: MessageComponentType

custom_id: str

options: list[MessageSelectMenuComponentOption]

channel_types: list[ChannelType]

placeholder: str

default_values: list[MessageSelectMenuComponentDefaultValue]

min_values: int

max_values: int

disabled: bool

class aiocord.model.protocols.MessageSelectMenuComponentDefaultValue

Bases: TypedDict

id: Snowflake

type: MessageSelectMenuComponentDefaultValueType

class aiocord.model.protocols.MessageSelectMenuComponentOption

Bases: TypedDict

label: str

value: str

description: str

emoji: Emoji

default: bool

class aiocord.model.protocols.MessageTextInputComponent

Bases: TypedDict

type: int

custom_id: str

style: MessageTextInputComponentStyle

label: str

min_length: int

max_length: int

required: bool

value: str

placeholder: str

class aiocord.model.protocols.Interaction

Bases: TypedDict

id: Snowflake

application_id: Snowflake

type: InteractionType

data: Union[ApplicationCommandInteractionData, MessageComponentInteractionData, ModalSubmitInteractionData, ResolvedInteractionData]

guild_id: Snowflake

channel: Channel

channel_id: Snowflake

member: GuildMember

user: User

token: str

version: int

message: Message

app_permissions: str

locale: str

guild_locale: str

entitlements: list[Entitlement]

authorizing_integration_owners: dict[ApplicationIntegrationType, Snowflake]

context: InteractionContextType

class aiocord.model.protocols.ApplicationCommandInteractionData

Bases: TypedDict

id: Snowflake

name: str

type: int

resolved: ResolvedInteractionData

options: list[ApplicationCommandInteractionDataOption]

guild_id: Snowflake

target_id: Snowflake

class aiocord.model.protocols.ApplicationCommandInteractionDataOption

Bases: TypedDict

name: str

type: int

value: Union[str, int, float, bool]

options: list[ApplicationCommandInteractionDataOption]

focused: bool

class aiocord.model.protocols.MessageComponentInteractionData

Bases: TypedDict

custom_id: str

component_type: int

class aiocord.model.protocols.ModalSubmitInteractionData

Bases: TypedDict

custom_id: str

components: list[Union[MessageActionRowComponent, MessageButtonComponent, MessageSelectMenuComponent, MessageTextInputComponent]]

class aiocord.model.protocols.ResolvedInteractionData

Bases: TypedDict

users: list[User]

guild_members: list[GuildMember]

channels: list[Channel]

messages: list[Message]

attachments: list[Attachment]

class aiocord.model.protocols.MessageInteraction

Bases: TypedDict

id: Snowflake

type: InteractionType

name: str

user: User

guild_member: GuildMember

class aiocord.model.protocols.InteractionResponse

Bases: TypedDict

type: InteractionResponseType

data: Union[MessageInteractionResponse, AutocompleteInteractionResponse, ModalInteractionResponse]

class aiocord.model.protocols.MessageInteractionResponse

Bases: TypedDict

tts: Optional[bool]

content: Optional[str]

embeds: Optional[list[Embed]]

allowed_mentions: Optional[AllowedMentions]

flags: Optional[MessageFlags]

components: Optional[list[Union[MessageButtonComponent, MessageSelectMenuComponent, MessageTextInputComponent]]]

attachments: Optional[list[Attachment]]

class aiocord.model.protocols.AutocompleteInteractionResponse

Bases: TypedDict

choices: list[ApplicationCommandOptionChoice]

class aiocord.model.protocols.ModalInteractionResponse

Bases: TypedDict

custom_id: str

title: str

components: list[Union[MessageButtonComponent, MessageSelectMenuComponent, MessageTextInputComponent]]

class aiocord.model.protocols.Application

Bases: TypedDict

id: Snowflake

name: str

icon: Optional[str]

description: str

rpc_origins: list[str]

bot_public: bool

bot_require_code_grant: bool

terms_of_service_url: str

privacy_policy_url: str

owner: User

verify_key: str

team: Optional[Team]

guild_id: Snowflake

primary_sku_id: Snowflake

slug: str

cover_image: str

approximate_user_install_count: int

flags: int

tags: list[str]

install_params: ApplicationInstallParams

custom_install_url: str

role_connections_verification_url: str

integration_types_config: dict[ApplicationIntegrationType, ApplicationIntegrationTypeConfiguration]

class aiocord.model.protocols.ApplicationIntegrationTypeConfiguration

Bases: TypedDict

oauth2_install_params: ApplicationInstallParams

class aiocord.model.protocols.ApplicationInstallParams

Bases: TypedDict

scopes: list[str]

permissions: Permissions

class aiocord.model.protocols.ApplicationRoleConnectionMetadata

Bases: TypedDict

type: ApplicationRoleConnectionMetadataType

key: str

name: str

name_localizations: dict[Locale, str]

description: str

description_localizations: dict[Locale, str]

class aiocord.model.protocols.AuditLog

Bases: TypedDict

application_commands: list[ApplicationCommand]

audit_log_entries: list[AuditLogEntry]

auto_moderation_rules: list[AutoModerationRule]

guild_scheduled_events: list[GuildScheduledEvent]

integrations: list[Integration]

threads: list[Channel]

users: list[User]

webhooks: list[Webhook]

class aiocord.model.protocols.AuditLogEntry

Bases: TypedDict

target_id: Optional[str]

changes: list[AuditLogChange]

user_id: Optional[Snowflake]

id: Snowflake

action_type: AuditLogEvent

options: OptionalAuditLogEntryInfo

reason: str

class aiocord.model.protocols.OptionalAuditLogEntryInfo

Bases: TypedDict

application_id: Snowflake

auto_moderation_rule_name: str

auto_moderation_rule_trigger_type: str

channel_id: Snowflake

count: str

delete_member_days: str

id: Snowflake

members_removed: str

message_id: Snowflake

role_name: str

type: OptionalAuditLogEntryInfoOverwrittenEntityType

class aiocord.model.protocols.AuditLogChange

Bases: TypedDict

new_value: Any

old_value: Any

key: str

class aiocord.model.protocols.AutoModerationRule

Bases: TypedDict

id: Snowflake

guild_id: Snowflake

name: str

creator_id: Snowflake

event_type: AutoModerationRuleEventType

trigger_type: AutoModerationTriggerType

trigger_metadata: AutoModerationTriggerMetadata

actions: list[AutoModerationAction]

enabled: bool

exempt_roles: list[Snowflake]

exempt_channels: list[Snowflake]

class aiocord.model.protocols.AutoModerationTriggerMetadata

Bases: TypedDict

keyword_filter: list[str]

regex_patterns: list[str]

presets: list[AutoModerationRuleKeywordPresetType]

allow_list: list[str]

mention_total_limit: int

mention_raid_protection_enabled: bool

class aiocord.model.protocols.AutoModerationAction

Bases: TypedDict

type: AutoModerationActionType

metadata: AutoModerationActionMetadata

class aiocord.model.protocols.AutoModerationActionMetadata

Bases: TypedDict

channel_id: Snowflake

duration_seconds: int

custom_message: str

class aiocord.model.protocols.Channel

Bases: TypedDict

id: Snowflake

type: ChannelType

guild_id: Snowflake

position: int

permission_overwrites: list[Overwrite]

name: Optional[str]

topic: Optional[str]

nsfw: bool

last_message_id: Optional[Snowflake]

bitrate: int

user_limit: int

rate_limit_per_user: int

recipients: list[User]

icon: Optional[str]

owner_id: Snowflake

application_id: Snowflake

managed: bool

parent_id: Optional[Snowflake]

last_pin_timestamp: Optional[ISO8601Timestamp]

rtc_region: Optional[str]

video_quality_mode: ChannelVideoQualityMode

message_count: int

member_count: int

thread_metadata: ThreadMetadata

member: ThreadMember

default_auto_archive_duration: int

permissions: Permissions

flags: ChannelFlags

total_message_sent: int

available_tags: list[ForumTag]

applied_tags: list[Snowflake]

default_reaction_emoji: Optional[DefaultReaction]

default_thread_rate_limit_per_user: int

default_sort_order: Optional[ChannelSortOrderType]

default_forum_layout: ForumLayoutType

class aiocord.model.protocols.Message

Bases: TypedDict

id: Snowflake

channel_id: Snowflake

author: User

content: str

timestamp: ISO8601Timestamp

edited_timestamp: Optional[ISO8601Timestamp]

tts: bool

mention_everyone: bool

mentions: list[User]

mention_roles: list[Snowflake]

mention_channels: list[Channel]

attachments: list[Attachment]

embeds: list[Embed]

reactions: list[Reaction]

nonce: Union[str, int]

pinned: bool

webhook_id: Snowflake

type: MessageType

activity: MessageActivity

application: Application

application_id: Snowflake

message_reference: MessageReference

message_snapshots: list[MessageSnapshot]

flags: MessageFlags

referenced_message: Optional[Message]

interaction: MessageInteraction

thread: Channel

components: list[MessageActionRowComponent]

stickers: list[Sticker]

position: int

role_subscription_data: RoleSubscriptionData

interaction_metadata: MessageInteractionMetadata

class aiocord.model.protocols.MessageActivity

Bases: TypedDict

type: MessageActivityType

party_id: str

class aiocord.model.protocols.MessageInteractionMetadata

Bases: TypedDict

id: Snowflake

type: InteractionType

user: User

authorizing_integration_owners: dict[ApplicationIntegrationType, Any]

original_response_message_id: Snowflake

interacted_message_id: Snowflake

triggering_interaction_metadata: MessageInteractionMetadata

class aiocord.model.protocols.MessageReference

Bases: TypedDict

message_id: Snowflake

channel_id: Snowflake

guild_id: Snowflake

fail_if_not_exists: bool

class aiocord.model.protocols.MessageSnapshot

Bases: TypedDict

message: Message

class aiocord.model.protocols.Reaction

Bases: TypedDict

count: int

me: bool

emoji: Emoji

class aiocord.model.protocols.FollowedChannel

Bases: TypedDict

channel_id: Snowflake

webhook_id: OverwriteType

class aiocord.model.protocols.Overwrite

Bases: TypedDict

id: Snowflake

type: OverwriteType

allow: Permissions

deny: Permissions

class aiocord.model.protocols.ThreadMetadata

Bases: TypedDict

archived: bool

auto_archive_duration: int

archive_timestamp: ISO8601Timestamp

locked: bool

invitable: bool

create_timestamp: Optional[ISO8601Timestamp]

class aiocord.model.protocols.ThreadMember

Bases: TypedDict

thread_id: Snowflake

user_id: Snowflake

join_timestamp: ISO8601Timestamp

flags: int

member: GuildMember

class aiocord.model.protocols.DefaultReaction

Bases: TypedDict

emoji_id: Optional[Snowflake]

emoji_name: Optional[str]

class aiocord.model.protocols.ForumTag

Bases: TypedDict

id: Snowflake

name: str

moderated: bool

emoji_id: Optional[Snowflake]

emoji_name: Optional[str]

class aiocord.model.protocols.Embed

Bases: TypedDict

title: str

type: EmbedType

description: str

url: str

timestamp: ISO8601Timestamp

color: int

footer: EmbedFooter

image: EmbedImage

thumbnail: EmbedThumbnail

video: EmbedVideo

provider: EmbedProvider

author: EmbedAuthor

fields: list[EmbedField]

class aiocord.model.protocols.EmbedThumbnail

Bases: TypedDict

url: str

proxy_url: str

height: int

width: int

class aiocord.model.protocols.EmbedVideo

Bases: TypedDict

url: str

proxy_url: str

height: int

width: int

class aiocord.model.protocols.EmbedImage

Bases: TypedDict

url: str

proxy_url: str

height: int

width: int

class aiocord.model.protocols.EmbedProvider

Bases: TypedDict

name: str

url: str

class aiocord.model.protocols.EmbedAuthor

Bases: TypedDict

name: str

url: str

icon_url: str

proxy_icon_url: str

class aiocord.model.protocols.EmbedFooter

Bases: TypedDict

text: str

icon_url: str

proxy_icon_url: str

class aiocord.model.protocols.EmbedField

Bases: TypedDict

name: str

value: str

inline: bool

class aiocord.model.protocols.Attachment

Bases: TypedDict

id: Snowflake

filename: str

description: str

content_type: str

size: int

url: str

proxy_url: str

height: Optional[int]

width: Optional[int]

ephemeral: bool

duration_secs: float

waveform: str

class aiocord.model.protocols.AllowedMentions

Bases: TypedDict

parse: list[AllowedMentionsType]

roles: list[Snowflake]

users: list[Snowflake]

replied_user: bool

class aiocord.model.protocols.RoleSubscriptionData

Bases: TypedDict

role_subscription_listing_id: Snowflake

tier_name: str

total_months_subscribed: int

is_renewal: bool

class aiocord.model.protocols.Emoji

Bases: TypedDict

id: Optional[Snowflake]

name: Optional[str]

roles: list[Snowflake]

user: User

require_colons: bool

managed: bool

animated: bool

available: bool

class aiocord.model.protocols.Guild

Bases: TypedDict

id: Snowflake

name: str

icon: Optional[str]

icon_hash: Optional[str]

splash: Optional[str]

discovery_splash: Optional[str]

owner: bool

owner_id: Snowflake

permissions: Permissions

afk_channel_id: Optional[Snowflake]

afk_timeout: int

widget_enabled: bool

widget_channel_id: Optional[Snowflake]

verification_level: GuildVerificationLevel

default_message_notifications: GuildDefaultMessageNotificationLevel

explicit_content_filter: GuildExplicitContentFilterLevel

roles: list[Role]

emojis: list[Emoji]

features: list[GuildFeature]

mfa_level: int

application_id: Optional[Snowflake]

system_channel_id: Optional[Snowflake]

system_channel_flags: GuildSystemChannelFlags

rules_channel_id: Optional[Snowflake]

max_presences: Optional[int]

max_members: int

vanity_url_code: Optional[str]

description: Optional[str]

banner: Optional[str]

premium_tier: GuildPremiumTier

premium_subscription_count: int

preferred_locale: str

public_updates_channel_id: Optional[Snowflake]

max_video_channel_users: int

max_stage_video_channel_users: int

approximate_member_count: int

approximate_presence_count: int

welcome_screen: WelcomeScreen

nsfw_level: GuildNSFWLevel

stickers: list[Sticker]

premium_progress_bar_enabled: bool

joined_at: ISO8601Timestamp

large: bool

unavailable: bool

member_count: int

voice_states: list[VoiceState]

members: list[GuildMember]

channels: list[Channel]

threads: list[Channel]

presences: list[Presence]

stage_instances: list[StageInstance]

scheduled_events: list[GuildScheduledEvent]

safety_alerts_channel_id: Snowflake

class aiocord.model.protocols.GuildWidgetSettings

Bases: TypedDict

enabled: bool

channel_id: Optional[Snowflake]

class aiocord.model.protocols.GuildWidget

Bases: TypedDict

id: Snowflake

name: str

instant_invite: Optional[str]

channels: list[Channel]

members: list[User]

presence_count: int

class aiocord.model.protocols.GuildMember

Bases: TypedDict

user: User

nick: Optional[str]

avatar: Optional[str]

banner: Optional[str]

roles: list[Snowflake]

joined_at: ISO8601Timestamp

premium_since: Optional[ISO8601Timestamp]

deaf: bool

mute: bool

flags: GuildMemberFlags

pending: bool

permissions: Permissions

communication_disabled_until: Optional[ISO8601Timestamp]

class aiocord.model.protocols.Integration

Bases: TypedDict

id: Snowflake

name: str

type: str

enabled: bool

syncing: bool

role_id: Snowflake

enable_emoticons: bool

expire_behavior: IntegrationExpireBehaviorType

expire_grace_period: int

user: User

account: IntegrationAccount

synced_at: ISO8601Timestamp

subscriber_count: int

revoked: bool

application: Application

scopes: list[str]

class aiocord.model.protocols.IntegrationAccount

Bases: TypedDict

id: str

name: str

class aiocord.model.protocols.IntegrationApplication

Bases: TypedDict

id: Snowflake

name: str

icon: Optional[str]

description: str

bot: User

class aiocord.model.protocols.Ban

Bases: TypedDict

reason: Optional[str]

user: User

class aiocord.model.protocols.WelcomeScreen

Bases: TypedDict

description: Optional[str]

welcome_channels: list[WelcomeScreenChannel]

class aiocord.model.protocols.WelcomeScreenChannel

Bases: TypedDict

channel_id: Snowflake

description: str

emoji_id: Optional[Snowflake]

emoji_name: Optional[str]

class aiocord.model.protocols.GuildOnboarding

Bases: TypedDict

guild_id: Snowflake

prompts: list[GuildOnboardingPrompt]

default_channel_ids: list[Snowflake]

enabled: bool

class aiocord.model.protocols.GuildOnboardingPrompt

Bases: TypedDict

id: Snowflake

type: GuildOnboardingPromptType

options: list[GuildOnboardingPromptOption]

title: str

single_select: bool

required: bool

in_onboarding: bool

class aiocord.model.protocols.GuildOnboardingPromptOption

Bases: TypedDict

id: Snowflake

channel_ids: list[Snowflake]

role_ids: list[Snowflake]

emoji: Emoji

title: str

description: Optional[str]

class aiocord.model.protocols.GuildScheduledEvent

Bases: TypedDict

id: Snowflake

guild_id: Snowflake

channel_id: Optional[Snowflake]

creator_id: Optional[Snowflake]

name: str

description: Optional[str]

scheduled_start_time: ISO8601Timestamp

scheduled_end_time: Optional[ISO8601Timestamp]

privacy_level: GuildScheduledEventPrivacyLevel

status: GuildScheduledEventStatus

entity_type: GuildScheduledEventEntityType

entity_id: Optional[Snowflake]

entity_metadata: Optional[GuildScheduledEventEntityMetadata]

creator: User

user_count: int

image: Optional[str]

class aiocord.model.protocols.GuildScheduledEventEntityMetadata

Bases: TypedDict

location: str

class aiocord.model.protocols.GuildScheduledEventUser

Bases: TypedDict

guild_scheduled_event_id: Snowflake

user: User

member: GuildMember

class aiocord.model.protocols.GuildTemplate

Bases: TypedDict

code: str

name: str

description: Optional[str]

usage_count: int

creator_id: Snowflake

creator: User

created_at: ISO8601Timestamp

updated_at: ISO8601Timestamp

source_guild_id: Snowflake

serialized_source_guild: Guild

is_dirty: Optional[bool]

class aiocord.model.protocols.Invite

Bases: TypedDict

code: str

guild: Guild

channel: Optional[Channel]

inviter: User

target_type: InviteTargetType

target_user: User

target_application: Application

approximate_presence_count: int

approximate_member_count: int

expires_at: Optional[ISO8601Timestamp]

stage_instance: InviteStageInstance

guild_scheduled_event: GuildScheduledEvent

uses: int

max_uses: int

max_age: int

temporary: bool

created_at: ISO8601Timestamp

class aiocord.model.protocols.InviteStageInstance

Bases: TypedDict

members: list[GuildMember]

participant_count: int

speaker_count: int

topic: str

class aiocord.model.protocols.StageInstance

Bases: TypedDict

id: Snowflake

guild_id: Snowflake

channel_id: Snowflake

topic: str

privacy_level: StageInstancePrivacyLevel

discoverable_disabled: bool

guild_scheduled_event_id: Optional[Snowflake]

class aiocord.model.protocols.Sticker

Bases: TypedDict

id: Snowflake

pack_id: Snowflake

name: str

description: Optional[str]

tags: str

asset: str

type: StickerType

format_type: StickerFormatType

available: bool

guild_id: Snowflake

user: User

sort_value: int

class aiocord.model.protocols.StickerPack

Bases: TypedDict

id: Snowflake

stickers: list[Sticker]

name: str

sku_id: Snowflake

cover_sticker_id: Snowflake

description: str

banner_asset_id: Snowflake

class aiocord.model.protocols.User

Bases: TypedDict

id: Snowflake

username: str

discriminator: str

global_name: str

avatar: Optional[str]

bot: bool

system: bool

mfa_enabled: bool

banner: Optional[str]

accent_color: Optional[int]

locale: Locale

verified: bool

email: Optional[str]

flags: UserFlags

premium_type: UserPremiumType

public_flags: UserFlags

class aiocord.model.protocols.Connection

Bases: TypedDict

id: str

name: str

type: str

revoked: bool

integrations: list[Integration]

verified: bool

friend_sync: bool

show_activity: bool

two_way_link: bool

visibility: ConnectionVisibilityType

class aiocord.model.protocols.ApplicationRoleConnection

Bases: TypedDict

platform_name: Optional[str]

platform_username: Optional[str]

metadata: dict[str, ApplicationRoleConnectionMetadata]

class aiocord.model.protocols.VoiceState

Bases: TypedDict

guild_id: Snowflake

channel_id: Optional[Snowflake]

user_id: Snowflake

member: GuildMember

session_id: str

deaf: bool

mute: bool

self_deaf: bool

self_mute: bool

self_stream: bool

self_video: bool

suppress: bool

request_to_speak_timestamp: Optional[ISO8601Timestamp]

class aiocord.model.protocols.VoiceRegion

Bases: TypedDict

id: str

name: str

optimal: bool

deprecated: bool

custom: bool

class aiocord.model.protocols.Webhook

Bases: TypedDict

id: Snowflake

type: WebhookType

guild_id: Optional[Snowflake]

channel_id: Optional[Snowflake]

user: User

name: Optional[str]

avatar: Optional[str]

token: str

application_id: Optional[Snowflake]

source_guild: Guild

source_channel: Channel

url: str

class aiocord.model.protocols.Presence

Bases: TypedDict

user: User

guild_id: Snowflake

status: StatusType

activities: list[Activity]

client_status: ClientStatus

class aiocord.model.protocols.ClientStatus

Bases: TypedDict

desktop: str

mobile: str

web: str

class aiocord.model.protocols.Activity

Bases: TypedDict

name: str

type: ActivityType

url: Optional[str]

created_at: Timestamp

timestamps: ActivityTimestamps

application_id: Snowflake

details: Optional[str]

state: Optional[str]

emoji: Optional[Emoji]

party: ActivityParty

assets: ActivityAssets

secrets: ActivitySecrets

instance: bool

flags: ActivityFlags

buttons: list[ActivityButton]

class aiocord.model.protocols.ActivityTimestamps

Bases: TypedDict

start: Timestamp

end: Timestamp

class aiocord.model.protocols.ActivityParty

Bases: TypedDict

id: str

size: list[int]

class aiocord.model.protocols.ActivityAssets

Bases: TypedDict

large_image: str

large_text: str

small_image: str

small_text: str

class aiocord.model.protocols.ActivitySecrets

Bases: TypedDict

join: str

spectate: str

match: str

class aiocord.model.protocols.ActivityButton

Bases: TypedDict

label: str

url: str

class aiocord.model.protocols.Role

Bases: TypedDict

id: Snowflake

name: str

color: int

hoist: bool

icon: Optional[str]

unicode_emoji: Optional[str]

position: int

permissions: str

managed: bool

mentionable: bool

tags: RoleTags

class aiocord.model.protocols.RoleTags

Bases: TypedDict

bot_id: Snowflake

integration_id: Snowflake

premium_subscriber: bool

subscription_listing_id: Snowflake

available_for_purchase: bool

guild_connections: bool

class aiocord.model.protocols.Team

Bases: TypedDict

icon: Optional[str]

id: Snowflake

members: list[TeamMember]

name: str

owner_user_id: Snowflake

class aiocord.model.protocols.TeamMember

Bases: TypedDict

membership_state: TeamMemberMembershipState

permissions: list[str]

team_id: Snowflake

user: User

class aiocord.model.protocols.SKU

Bases: TypedDict

id: Snowflake

type: SKUType

application_id: Snowflake

name: str

slug: str

flags: SKUFlags

class aiocord.model.protocols.Entitlement

Bases: TypedDict

id: Snowflake

sku_id: Snowflake

application_id: Snowflake

user_id: Snowflake

type: EntitlementType

deleted: bool

starts_at: ISO8601Timestamp

ends_at: ISO8601Timestamp

guild_id: Snowflake

objects

Dynamic versions of models that may be updated at any point.

These will be found in responses or cached during live connections.

class aiocord.model.objects.ApplicationCommand(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommand]

Source: Application Command Structure

id: Snowflake

Source: id

type: ApplicationCommandType

Source: type

application_id: Snowflake

Source: application_id

guild_id: Snowflake

Source: guild_id

name: str

Source: name

name_localizations: dict[Locale, str]

Source: name_localizations

description: str

Source: description

description_localizations: dict[Locale, str]

Source: description_localizations

options: Collection[ApplicationCommandOption]

Source: options

default_member_permissions: Permissions

Source: default_member_permissions

dm_permission: bool

Source: dm_permission (deprecated)

default_permission: bool

Source: default_permission

nsfw: bool

Source: nsfw

version: Snowflake

Source: version

integration_types: Collection[ApplicationIntegrationType]

Source: integration_types

context_types: Collection[InteractionContextType]

Source: contexts

mention()

Get the mention.

class aiocord.model.objects.ApplicationCommandOption(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommandOption]

Source: Application Command Option Structure

type: ApplicationCommandOptionType

Source: type

name: str

Source: name

name_localizations: dict[Locale, str]

Source: name_localizations

description: str

Source: description

description_localizations: dict[Locale, str]

Source: description_localizations

required: bool

Source: required

choices: Collection[ApplicationCommandOptionChoice]

Source: choices

options: Collection[ApplicationCommandOption]

Source: options

channel_types: Collection[ChannelType]

Source: channel_types

min_value: Union[int, float]

Source: min_value

max_value: Union[int, float]

Source: max_value

min_length: int

Source: min_length

max_length: int

Source: max_length

autocomplete: bool

Source: autocomplete

class aiocord.model.objects.ApplicationCommandOptionChoice(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommandOptionChoice]

Source: Application Command Option Choice Structure

name: str

Source: name

name_localizations: dict[Locale, str]

Source: name_localizations

value: Union[str, int, float]

Source: value

class aiocord.model.objects.GuildApplicationCommandPermissions(data: _DataV, /, *, unique=False)

Bases: Object[GuildApplicationCommandPermissions]

DocumenGuild Application Command Permissions Structure </interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure>`

id: Snowflake

application_id: Snowflake

guild_id: Snowflake

permissions: Collection[ApplicationCommandPermission]

class aiocord.model.objects.ApplicationCommandPermissions(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommandPermissions]

DocumenApplication Command Permissions Structure </interactions/application-commands#application-command-permissions-object-application-command-permissions-structure>`

id: Snowflake

type: ApplicationCommandPermissionType

permission: bool

class aiocord.model.objects.MessageActionRowComponent(data: _DataV, /, *, unique=False)

Bases: Object[MessageActionRowComponent]

Source: Action Rows

type: MessageComponentType = (<function MessageActionRowComponent.<lambda>>, <function _update>, False)

components: Collection[Union[MessageButtonComponent, MessageSelectMenuComponent, MessageTextInputComponent]]

Source: components

class aiocord.model.objects.MessageButtonComponent(data: _DataV, /, *, unique=False)

Bases: Object[MessageButtonComponent]

Source: Button Structure

type: int

Source: type

style: int

Source: style

label: str

Source: label

emoji: Emoji

Source: emoji

custom_id: str

Source: custom_id

url: str

Source: url

disabled: bool

Source: disabled

class aiocord.model.objects.MessageSelectMenuComponent(data: _DataV, /, *, unique=False)

Bases: Object[MessageSelectMenuComponent]

Source: Select Menu Structure

type: MessageComponentType

Source: type

custom_id: str

Source: custom_id

options: Collection[MessageSelectMenuComponentOption]

Source: options

channel_types: Collection[ChannelType]

Source: channel_types

placeholder: str

Source: placeholder

default_values: Collection[MessageSelectMenuComponentDefaultValue]

Source: default_values

min_values: int

Source: min_values

max_values: int

Source: max_values

disabled: bool

Source: disabled

class aiocord.model.objects.MessageSelectMenuComponentDefaultValue(data: _DataV, /, *, unique=False)

Bases: Object[MessageSelectMenuComponentDefaultValue]

Source: Select Default Value Structure

id: Snowflake

Source: id

type: MessageSelectMenuComponentDefaultValueType

Source: type

class aiocord.model.objects.MessageSelectMenuComponentOption(data: _DataV, /, *, unique=False)

Bases: Object[MessageSelectMenuComponentOption]

Source: Select Option Structure

label: str

Source: label

value: str

Source: value

description: str

Source: description

emoji: Emoji

Source: emoji

default: bool

Source: default

class aiocord.model.objects.MessageTextInputComponent(data: _DataV, /, *, unique=False)

Bases: Object[MessageTextInputComponent]

Source: Text Inputs Text Input Structure

type: int

Source: type

custom_id: str

Source: custom_id

style: MessageTextInputComponentStyle

Source: style

label: str

Source: label

min_length: int

Source: min_length

max_length: int

Source: max_length

required: bool

Source: required

value: str

Source: value

placeholder: str

Source: placeholder

class aiocord.model.objects.Interaction(data: _DataV, /, *, unique=False)

Bases: Object[Interaction]

Source: Interaction Structure

id: Snowflake

Source: id

application_id: Snowflake

Source: application_id

type: InteractionType

Source: type

data: Union[ApplicationCommandInteractionData, MessageComponentInteractionData, ModalSubmitInteractionData, ResolvedInteractionData]

Source: data

guild_id: Snowflake

Source: guild_id

channel: Channel

Source: channel

channel_id: Snowflake

Source: channel_id

member: GuildMember

Source: member

user: User

Source: user

token: str

Source: token

version: int

Source: version

message: Message

Source: message

app_permissions: str

Source: app_permissions

locale: str

Source: locale

guild_locale: str

Source: guild_locale

entitlements: Collection[Entitlement]

Source: entitlements

authorizing_integration_owners: dict[ApplicationIntegrationType, Snowflake]

Source: authorizing_integration_owners

context: InteractionContextType

Source: context

class aiocord.model.objects.ApplicationCommandInteractionData(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommandInteractionData]

Source: Application Command Data Structure

id: Snowflake

Source: id

name: str

Source: name

type: int

Source: type

resolved: ResolvedInteractionData

Source: resolved

options: Collection[ApplicationCommandInteractionDataOption]

Source: options

guild_id: Snowflake

Source: guild_id

target_id: Snowflake

Source: target_id

class aiocord.model.objects.ApplicationCommandInteractionDataOption(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommandInteractionDataOption]

Source: Application Command Interaction Data Option Structure

name: str

Source: name

type: int

Source: type

value: Union[str, int, float, bool]

Source: value

options: Collection[ApplicationCommandInteractionDataOption]

Source: options

focused: bool

Source: focused

class aiocord.model.objects.MessageComponentInteractionData(data: _DataV, /, *, unique=False)

Bases: Object[MessageComponentInteractionData]

Source: Message Component Data Structure

custom_id: str

Source: custom_id

component_type: int

Source: component_type

values: Collection[MessageSelectMenuComponent]

Source: values

class aiocord.model.objects.ModalSubmitInteractionData(data: _DataV, /, *, unique=False)

Bases: Object[ModalSubmitInteractionData]

Source: Modal Submit Data Structure

custom_id: str

Source: custom_id

components: Collection[Union[MessageActionRowComponent, MessageButtonComponent, MessageSelectMenuComponent, MessageTextInputComponent]]

Source: components

class aiocord.model.objects.ResolvedInteractionData(data: _DataV, /, *, unique=False)

Bases: Object[ResolvedInteractionData]

Source: Resolved Data Structure

users: Collection[User]

Source: users

guild_members: Collection[GuildMember]

Source: guild_members

channels: Collection[Channel]

Source: channels

messages: Collection[Message]

Source: messages

attachments: Collection[Attachment]

Source: attachments

class aiocord.model.objects.MessageInteraction(data: _DataV, /, *, unique=False)

Bases: Object[MessageInteraction]

Source: Message Interaction Structure

id: Snowflake

Source: id

type: InteractionType

Source: type

name: str

Source: name

user: User

Source: user

guild_member: GuildMember

Source: guild_member

class aiocord.model.objects.InteractionResponse(data: _DataV, /, *, unique=False)

Bases: Object[InteractionResponse]

Source: Interaction Response Structure

type: InteractionResponseType

Source: type

data: Any

Source: data

class aiocord.model.objects.Application(data: _DataV, /, *, unique=False)

Bases: Object[Application]

Source: Application Structure

id: Snowflake

Source: id

name: str

Source: name

icon: Optional[str]

Source: icon

description: str

Source: description

rpc_origins: Collection[str]

Source: rpc_origins

bot_public: bool

Source: bot_public

bot_require_code_grant: bool

Source: bot_require_code_grant

terms_of_service_url: str

Source: terms_of_service_url

privacy_policy_url: str

Source: privacy_policy_url

owner: User

Source: owner

verify_key: str

Source: verify_key

team: Optional[Team]

Source: team

guild_id: Snowflake

Source: guild_id

primary_sku_id: Snowflake

Source: primary_sku_id

slug: str

Source: slug

cover: str

Source: cover_image

flags: int

Source: flags

approximate_user_install_count: int

Source: approximate_user_install_count

tags: Collection[str]

Source: tags

install_params: ApplicationInstallParams

Source: install_params

custom_install_url: str

Source: custom_install_url

role_connections_verification_url: str

Source: role_connections_verification_url

integration_type_configs: dict[ApplicationIntegrationType, ApplicationIntegrationTypeConfiguration]

Source: integration_types_config

icon_url(**kwargs)

Get the icon url.

cover_url(**kwargs)

Get the cover url.

asset_url(asset_id, **kwargs)

Get the asset url.

class aiocord.model.objects.ApplicationIntegrationTypeConfiguration(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationIntegrationTypeConfiguration]

Source: Application Integration Type Configuration Object

oauth2_install_params: ApplicationInstallParams

Source: oauth2_install_params

class aiocord.model.objects.ApplicationInstallParams(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationInstallParams]

Source: Install Params Structure

scopes: Collection[str]

Source: scopes

permissions: Permissions

Source: permissions

class aiocord.model.objects.ApplicationRoleConnectionMetadata(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationRoleConnectionMetadata]

Source: Application Role Connection Metadata Structure

type: ApplicationRoleConnectionMetadataType

Source: type

key: str

Source: key

name: str

Source: name

name_localizations: dict[Locale, str]

Source: name_localizations

description: str

Source: description

description_localizations: dict[Locale, str]

Source: description_localizations

class aiocord.model.objects.AuditLog(data: _DataV, /, *, unique=False)

Bases: Object[AuditLog]

Source: Audit Log Structure

application_commands: Collection[ApplicationCommand]

Source: application_commands

audit_log_entries: Collection[AuditLogEntry]

Source: audit_log_entries

auto_moderation_rules: Collection[AutoModerationRule]

Source: auto_moderation_rules

guild_scheduled_events: Collection[GuildScheduledEvent]

Source: guild_scheduled_events

integrations: Collection[Integration]

Source: integrations

threads: Collection[Channel]

Source: threads

users: Collection[User]

Source: users

webhooks: Collection[Webhook]

Source: webhooks

class aiocord.model.objects.AuditLogEntry(data: _DataV, /, *, unique=False)

Bases: Object[AuditLogEntry]

Source: Audit Log Entry Structure

target_id: Optional[str]

Source: target_id

changes: Collection[AuditLogChange]

Source: changes

user_id: Optional[Snowflake]

Source: user_id

id: Snowflake

Source: id

action_type: AuditLogEvent

Source: action_type

options: OptionalAuditLogEntryInfo

Source: options

reason: str

Source: reason

class aiocord.model.objects.OptionalAuditLogEntryInfo(data: _DataV, /, *, unique=False)

Bases: Object[OptionalAuditLogEntryInfo]

Source: Optional Audit Entry Info

application_id: Snowflake

Source: application_id

auto_moderation_rule_name: str

Source: auto_moderation_rule_name

auto_moderation_rule_trigger_type: str

Source: auto_moderation_rule_trigger_type

channel_id: Snowflake

Source: channel_id

count: str

Source: count

delete_member_days: str

Source: delete_member_days

id: Snowflake

Source: id

members_removed: str

Source: members_removed

message_id: Snowflake

Source: message_id

role_name: str

Source: role_name

type: OptionalAuditLogEntryInfoOverwrittenEntityType

Source: type

class aiocord.model.objects.AuditLogChange(data: _DataV, /, *, unique=False)

Bases: Object[AuditLogChange]

Source: Audit Log Change Structure

new_value: Any

Source: new_value

old_value: Any

Source: old_value

key: str

Source: key

class aiocord.model.objects.AutoModerationRule(data: _DataV, /, *, unique=False)

Bases: Object[AutoModerationRule]

Source: Trigger Metadata

id: Snowflake

Source: id

guild_id: Snowflake

Source: guild_id

name: str

Source: name

creator_id: Snowflake

Source: creator_id

event_type: AutoModerationRuleEventType

Source: event_type

trigger_type: AutoModerationTriggerType

Source: trigger_type

trigger_metadata: AutoModerationTriggerMetadata

Source: trigger_metadata

actions: Collection[AutoModerationAction]

Source: actions

enabled: bool

Source: enabled

exempt_roles: Collection[Snowflake]

Source: exempt_roles

exempt_channels: Collection[Snowflake]

Source: exempt_channels

class aiocord.model.objects.AutoModerationTriggerMetadata(data: _DataV, /, *, unique=False)

Bases: Object[AutoModerationTriggerMetadata]

Source: Resources

keyword_filter: Collection[str]

Source: keyword_filter

regex_patterns: Collection[str]

Source: regex_patterns

presets: Collection[AutoModerationRuleKeywordPresetType]

Source: presets

allow_list: Collection[str]

Source: allow_list

mention_total_limit: int

Source: mention_total_limit

mention_raid_protection_enabled: bool

Source: mention_total_limit

class aiocord.model.objects.AutoModerationAction(data: _DataV, /, *, unique=False)

Bases: Object[AutoModerationAction]

Source: Auto Moderation Action Structure

type: AutoModerationActionType

Source: type

metadata: AutoModerationActionMetadata

Source: metadata

class aiocord.model.objects.AutoModerationActionMetadata(data: _DataV, /, *, unique=False)

Bases: Object[AutoModerationActionMetadata]

Source: Resources

channel_id: Snowflake

Source: channel_id

duration_seconds: int

Source: duration_seconds

custom_message: str

Source: custom_message

class aiocord.model.objects.Channel(data: _DataV, /, *, unique=False)

Bases: Object[Channel]

Source: Channel Structure

id: Snowflake

Source: id

type: ChannelType

Source: type

guild_id: Snowflake

Source: guild_id

position: int

Source: position

permission_overwrites: Collection[Overwrite]

Source: permission_overwrites

name: Optional[str]

Source: name

topic: Optional[str]

Source: topic

nsfw: bool

Source: nsfw

last_message_id: Optional[Snowflake]

Source: last_message_id

bitrate: int

Source: bitrate

user_limit: int

Source: user_limit

rate_limit_per_user: int

Source: rate_limit_per_user

recipients: Collection[User]

Source: recipients

icon: Optional[str]

Source: icon

owner_id: Snowflake

Source: owner_id

application_id: Snowflake

Source: application_id

managed: bool

Source: managed

parent_id: Optional[Snowflake]

Source: parent_id

last_pin_timestamp: Optional[ISO8601Timestamp]

Source: last_pin_timestamp

rtc_region: Optional[str]

Source: rtc_region

video_quality_mode: ChannelVideoQualityMode

Source: video_quality_mode

message_count: int

Source: message_count

member_count: int

Source: member_count

thread_metadata: ThreadMetadata

Source: thread_metadata

member: ThreadMember

Source: member

default_auto_archive_duration: int

Source: default_auto_archive_duration

permissions: Permissions

Source: permissions

flags: ChannelFlags

Source: flags

total_message_sent: int

Source: total_message_sent

available_tags: Collection[ForumTag]

Source: available_tags

applied_tags: Collection[Snowflake]

Source: applied_tags

default_reaction_emoji: Optional[DefaultReaction]

Source: default_reaction_emoji

default_thread_rate_limit_per_user: int

Source: default_thread_rate_limit_per_user

default_sort_order: Optional[ChannelSortOrderType]

Source: default_sort_order

default_forum_layout: ForumLayoutType

Source: default_forum_layout

mention()

Get the mention.

class aiocord.model.objects.Message(data: _DataV, /, *, unique=False)

Bases: Object[Message]

Source: Message Structure

id: Snowflake

Source: id

channel_id: Snowflake

Source: channel_id

author: User

Source: author

content: str

Source: content

timestamp: ISO8601Timestamp

Source: timestamp

edited_timestamp: Optional[ISO8601Timestamp]

Source: edited_timestamp

tts: bool

Source: tts

mention_everyone: bool

Source: mention_everyone

mentions: Collection[User]

Source: mentions

mention_roles: Collection[Snowflake]

Source: mention_roles

mention_channels: Collection[Channel]

Source: mention_channels

attachments: Collection[Attachment]

Source: attachments

embeds: Collection[Embed]

Source: embeds

reactions: Collection[Reaction]

Source: reactions

nonce: str | int

Source: nonce

pinned: bool

Source: pinned

webhook_id: Snowflake

Source: webhook_id

type: MessageType

Source: type

activity: MessageActivity

Source: activity

application: Application

Source: application

application_id: Snowflake

Source: application_id

message_reference: MessageReference

Source: message_reference

flags: MessageFlags

Source: flags

referenced_message: Optional[Message]

Source: referenced_message

interaction: MessageInteraction

Source: interaction (deprecated)

thread: Channel

Source: thread

components: Collection[MessageActionRowComponent]

Source: components

stickers: Collection[Sticker]

Source: sticker_items

position: int

Source: position

role_subscription_data: RoleSubscriptionData

Source: role_subscription_data

interaction_metadata: MessageInteractionMetadata

Source: interaction_metadata

class aiocord.model.objects.MessageActivity(data: _DataV, /, *, unique=False)

Bases: Object[MessageActivity]

Source: Message Activity Structure

type: MessageActivityType

Source: type

party_id: str

Source: party_id

class aiocord.model.objects.MessageInteractionMetadata(data: _DataV, /, *, unique=False)

Bases: Object[MessageInteractionMetadata]

Source: https://discord.com/developers/docsMessage Interaction Metadata Structure </resources/channel#message-interaction-metadata-object-message-interaction-metadata-structure

id: Snowflake

Source: id

type: InteractionType

Source: type

user: User

Source: user

authorizing_integration_owners: dict[ApplicationIntegrationType, InteractionContextType]

Source: authorizing_integration_owners

original_response_message_id: Snowflake

Source: original_response_message_id

interacted_message_id: Snowflake

Source: interacted_message_id

triggering_interaction_metadata: MessageInteractionMetadata

Source: triggering_interaction_metadata

class aiocord.model.objects.MessageReference(data: _DataV, /, *, unique=False)

Bases: Object[MessageReference]

Source: Message Reference Structure

message_id: Snowflake

Source: message_id

channel_id: Snowflake

Source: channel_id

guild_id: Snowflake

Source: guild_id

fail_if_not_exists: bool

Source: fail_if_not_exists

class aiocord.model.objects.MessageSnapshot(data: _DataV, /, *, unique=False)

Bases: Object[MessageSnapshot]

Source: Message Snapshot Structure

message: Snowflake

Source: message

class aiocord.model.objects.Reaction(data: _DataV, /, *, unique=False)

Bases: Object[Reaction]

Source: Reaction Structure

count: int

Source: count

me: bool

Source: me

emoji: Emoji

Source: emoji

class aiocord.model.objects.FollowedChannel(data: _DataV, /, *, unique=False)

Bases: Object[FollowedChannel]

Source: Followed Channel Structure

channel_id: Snowflake

Source: channel_id

webhook_id: OverwriteType

Source: webhook_id

class aiocord.model.objects.Overwrite(data: _DataV, /, *, unique=False)

Bases: Object[Overwrite]

Source: Overwrite Structure

id: Snowflake

Source: id

type: OverwriteType

Source: type

allow: Permissions

Source: allow

deny: Permissions

Source: deny

class aiocord.model.objects.ThreadMetadata(data: _DataV, /, *, unique=False)

Bases: Object[ThreadMetadata]

Source: Thread Metadata Structure

archived: bool

Source: archived

auto_archive_duration: int

Source: auto_archive_duration

archive_timestamp: ISO8601Timestamp

Source: archive_timestamp

locked: bool

Source: locked

invitable: bool

Source: invitable

create_timestamp: Optional[ISO8601Timestamp]

Source: create_timestamp

class aiocord.model.objects.ThreadMember(data: _DataV, /, *, unique=False)

Bases: Object[ThreadMember]

Source: Thread Member Structure

thread_id: Snowflake

Source: id

user_id: Snowflake

Source: user_id

join_timestamp: ISO8601Timestamp

Source: join_timestamp

flags: int

Source: flags

member: GuildMember

Source: member

class aiocord.model.objects.DefaultReaction(data: _DataV, /, *, unique=False)

Bases: Object[DefaultReaction]

Source: Default Reaction Structure

emoji_id: Optional[Snowflake]

Source: emoji_id

emoji_name: Optional[str]

Source: emoji_name

class aiocord.model.objects.ForumTag(data: _DataV, /, *, unique=False)

Bases: Object[ForumTag]

Source: Forum Tag Structure

id: Snowflake

Source: id

name: str

Source: name

moderated: bool

Source: moderated

emoji_id: Optional[Snowflake]

Source: emoji_id

emoji_name: Optional[str]

Source: emoji_name

class aiocord.model.objects.Embed(data: _DataV, /, *, unique=False)

Bases: Object[Embed]

Source: Embed Structure

title: str

Source: title

type: EmbedType

Source: type

description: str

Source: description

url: str

Source: url

timestamp: ISO8601Timestamp

Source: timestamp

color: int

Source: color

footer: EmbedFooter

Source: footer

image: EmbedImage

Source: image

thumbnail: EmbedThumbnail

Source: thumbnail

video: EmbedVideo

Source: video

provider: EmbedProvider

Source: provider

author: EmbedAuthor

Source: author

fields: Collection[EmbedField]

Source: fields

class aiocord.model.objects.EmbedThumbnail(data: _DataV, /, *, unique=False)

Bases: Object[EmbedThumbnail]

Source: Embed Thumbnail Structure

url: str

Source: url

proxy_url: str

Source: proxy_url

height: int

Source: height

width: int

Source: width

class aiocord.model.objects.EmbedVideo(data: _DataV, /, *, unique=False)

Bases: Object[EmbedVideo]

Source: Embed Video Structure

url: str

Source: url

proxy_url: str

Source: proxy_url

height: int

Source: height

width: int

Source: width

class aiocord.model.objects.EmbedImage(data: _DataV, /, *, unique=False)

Bases: Object[EmbedImage]

Source: Embed Image Structure

url: str

Source: url

proxy_url: str

Source: proxy_url

height: int

Source: height

width: int

Source: width

class aiocord.model.objects.EmbedProvider(data: _DataV, /, *, unique=False)

Bases: Object[EmbedProvider]

Source: Embed Provider Structure

name: str

Source: name

url: str

Source: url

class aiocord.model.objects.EmbedAuthor(data: _DataV, /, *, unique=False)

Bases: Object[EmbedAuthor]

Source: Embed Author Structure

name: str

Source: name

url: str

Source: url

icon_url: str

Source: icon_url

proxy_icon_url: str

Source: proxy_icon_url

class aiocord.model.objects.EmbedFooter(data: _DataV, /, *, unique=False)

Bases: Object[EmbedFooter]

Source: Embed Footer Structure

text: str

Source: text

icon_url: str

Source: icon_url

proxy_icon_url: str

Source: proxy_icon_url

class aiocord.model.objects.EmbedField(data: _DataV, /, *, unique=False)

Bases: Object[EmbedField]

Source: Embed Field Structure

name: str

Source: name

value: str

Source: value

inline: bool

Source: inline

class aiocord.model.objects.Attachment(data: _DataV, /, *, unique=False)

Bases: Object[Attachment]

Source: Resources

id: Snowflake

Source: id

filename: str

Source: filename

description: str

Source: description

content_type: str

Source: content_type

size: int

Source: size

url: str

Source: url

proxy_url: str

Source: proxy_url

height: Optional[int]

Source: height

width: Optional[int]

Source: width

ephemeral: bool

Source: ephemeral

duration_secs: float

Source: duration_secs

waveform: str

Source: waveform

class aiocord.model.objects.AllowedMentions(data: _DataV, /, *, unique=False)

Bases: Object[AllowedMentions]

Source: Allowed Mentions Structure

parse: Collection[AllowedMentionsType]

Source: parse

roles: Collection[Snowflake]

Source: roles

users: Collection[Snowflake]

Source: users

replied_user: bool

Source: replied_user

class aiocord.model.objects.RoleSubscriptionData(data: _DataV, /, *, unique=False)

Bases: Object[RoleSubscriptionData]

Source: Role Subscription Data Object

role_subscription_listing_id: Snowflake

Source: role_subscription_listing_id

tier_name: str

Source: tier_name

total_months_subscribed: int

Source: total_months_subscribed

is_renewal: bool

Source: is_renewal

class aiocord.model.objects.Emoji(data: _DataV, /, *, unique=False)

Bases: Object[Emoji]

Source: Emoji Structure

id: Optional[Snowflake]

Source: id

name: Optional[str]

Source: name

roles: Collection[Snowflake]

Source: roles

user: User

Source: user

require_colons: bool

Source: require_colons

managed: bool

Source: managed

animated: bool

Source: animated

available: bool

Source: available

mention()

Get the mention.

image_url(**kwargs)

Get the image url.

class aiocord.model.objects.Guild(data: _DataV, /, *, unique=False)

Bases: Object[Guild]

Source: Guild Structure | Guild Create Guild Create Extra Fields

id: Snowflake

Source: id

name: str

Source: name

icon: Optional[str]

Source: icon

icon_hash: Optional[str]

Source: icon_hash

splash: Optional[str]

Source: splash

discovery_splash: Optional[str]

Source: discovery_splash

owner: bool

Source: owner

owner_id: Snowflake

Source: owner_id

permissions: Permissions

Source: permissions

afk_channel_id: Optional[Snowflake]

Source: afk_channel_id

afk_timeout: int

Source: afk_timeout

widget_enabled: bool

Source: widget_enabled

widget_channel_id: Optional[Snowflake]

Source: widget_channel_id

verification_level: GuildVerificationLevel

Source: verification_level

default_message_notifications: GuildDefaultMessageNotificationLevel

Source: default_message_notifications

explicit_content_filter: GuildExplicitContentFilterLevel

Source: explicit_content_filter

roles: Collection[Role]

Source: roles

emojis: Collection[Emoji]

Source: emojis

features: Collection[GuildFeature]

Source: features

mfa_level: int

Source: mfa_level

application_id: Optional[Snowflake]

Source: application_id

system_channel_id: Optional[Snowflake]

Source: system_channel_id

system_channel_flags: GuildSystemChannelFlags

Source: system_channel_flags

rules_channel_id: Optional[Snowflake]

Source: rules_channel_id

max_presences: Optional[int]

Source: max_presences

max_members: int

Source: max_members

vanity_url_code: Optional[str]

Source: vanity_url_code

description: Optional[str]

Source: description

banner: Optional[str]

Source: banner

premium_tier: GuildPremiumTier

Source: premium_tier

premium_subscription_count: int

Source: premium_subscription_count

preferred_locale: str

Source: preferred_locale

public_updates_channel_id: Optional[Snowflake]

Source: public_updates_channel_id

max_video_channel_users: int

Source: max_video_channel_users

max_stage_video_channel_users: int

Source: max_stage_video_channel_users

approximate_member_count: int

Source: approximate_member_count

approximate_presence_count: int

Source: approximate_presence_count

welcome_screen: WelcomeScreen

Source: welcome_screen

nsfw_level: GuildNSFWLevel

Source: nsfw_level

stickers: Collection[Sticker]

Source: stickers

premium_progress_bar_enabled: bool

Source: premium_progress_bar_enabled

joined_at: ISO8601Timestamp

Source: joined_at

large: bool

Source: large

unavailable: bool

Source: unavailable

member_count: int

Source: member_count

voice_states: Collection[VoiceState]

Source: voice_states

members: Collection[GuildMember]

Source: members

channels: Collection[Channel]

Source: channels

threads: Collection[Channel]

Source: threads

presences: Collection[Presence]

Source: presences

stage_instances: Collection[StageInstance]

Source: stage_instances

scheduled_events: Collection[GuildScheduledEvent]

Source: scheduled_events

safety_alerts_channel_id: Snowflake

Source: safety_alerts_channel_id

icon_url(**kwargs)

Get the icon url.

splash_url(**kwargs)

Get the splash url.

discovery_splash_url(**kwargs)

Get the discovery splash url.

banner_url(**kwargs)

Get the banner url.

class aiocord.model.objects.GuildWidgetSettings(data: _DataV, /, *, unique=False)

Bases: Object[GuildWidgetSettings]

Source: Guild Widget Settings Structure

enabled: bool

Source: enabled

channel_id: Optional[Snowflake]

Source: channel_id

class aiocord.model.objects.GuildWidget(data: _DataV, /, *, unique=False)

Bases: Object[GuildWidget]

Source: Guild Widget Structure

id: Snowflake

Source: id

name: str

Source: name

instant_invite: Optional[str]

Source: instant_invite

channels: Collection[Channel]

Source: channels

members: Collection[User]

Source: members

presence_count: int

Source: presence_count

class aiocord.model.objects.GuildMember(data: _DataV, /, *, unique=False)

Bases: Object[GuildMember]

Source: Guild Member Structure | Guild Member Add Guild Member Add Extra Fields

guild_id: Snowflake

Source: guild_id

user: User

Source: user

nick: Optional[str]

Source: nick

avatar: Optional[str]

Source: avatar

banner: Optional[str]

Source: banner

roles: Collection[Snowflake]

Source: roles

joined_at: ISO8601Timestamp

Source: joined_at

premium_since: Optional[ISO8601Timestamp]

Source: premium_since

deaf: bool

Source: deaf

mute: bool

Source: mute

flags: GuildMemberFlags

Source: flags

pending: bool

Source: pending

permissions: Permissions

Source: permissions

communication_disabled_until: Optional[ISO8601Timestamp]

Source: communication_disabled_until

avatar_url(**kwargs)

Get the avatar url.

class aiocord.model.objects.Integration(data: _DataV, /, *, unique=False)

Bases: Object[Integration]

Source: Integration Structure

id: Snowflake

Source: id

name: str

Source: name

type: str

Source: type

enabled: bool

Source: enabled

syncing: bool

Source: syncing

role_id: Snowflake

Source: role_id

enable_emoticons: bool

Source: enable_emoticons

expire_behavior: IntegrationExpireBehaviorType

Source: expire_behavior

expire_grace_period: int

Source: expire_grace_period

user: User

Source: user

account: IntegrationAccount

Source: account

synced_at: ISO8601Timestamp

Source: synced_at

subscriber_count: int

Source: subscriber_count

revoked: bool

Source: revoked

application: Application

Source: application

scopes: Collection[str]

Source: scopes

class aiocord.model.objects.IntegrationAccount(data: _DataV, /, *, unique=False)

Bases: Object[IntegrationAccount]

Source: Integration Account Structure

id: str

Source: id

name: str

Source: name

class aiocord.model.objects.IntegrationApplication(data: _DataV, /, *, unique=False)

Bases: Object[IntegrationApplication]

Source: Integration Application Structure

id: Snowflake

Source: id

name: str

Source: name

icon: Optional[str]

Source: icon

description: str

Source: description

bot: User

Source: bot

class aiocord.model.objects.Ban(data: _DataV, /, *, unique=False)

Bases: Object[Ban]

Source: Ban Structure

reason: Optional[str]

Source: reason

user: User

Source: user

class aiocord.model.objects.WelcomeScreen(data: _DataV, /, *, unique=False)

Bases: Object[WelcomeScreen]

Source: Welcome Screen Structure

description: Optional[str]

Source: description

welcome_channels: Collection[WelcomeScreenChannel]

Source: welcome_channels

class aiocord.model.objects.WelcomeScreenChannel(data: _DataV, /, *, unique=False)

Bases: Object[WelcomeScreenChannel]

Source: Welcome Screen Channel Structure

channel_id: Snowflake

Source: channel_id

description: str

Source: description

emoji_id: Optional[Snowflake]

Source: emoji_id

emoji_name: Optional[str]

Source: emoji_name

class aiocord.model.objects.GuildOnboarding(data: _DataV, /, *, unique=False)

Bases: Object[GuildOnboarding]

Source: Guild Onboarding Structure

guild_id: Snowflake

Source: guild_id

prompts: Collection[GuildOnboardingPrompt]

Source: prompts

default_channel_ids: Collection[Snowflake]

Source: default_channel_ids

enabled: bool

Source: enabled

class aiocord.model.objects.GuildOnboardingPrompt(data: _DataV, /, *, unique=False)

Bases: Object[GuildOnboardingPrompt]

Source: Onboarding Prompt Structure

id: Snowflake

Source: id

type: GuildOnboardingPromptType

Source: type

options: Collection[GuildOnboardingPromptOption]

Source: options

title: str

Source: title

single_select: bool

Source: single_select

required: bool

Source: required

in_onboarding: bool

Source: in_onboarding

class aiocord.model.objects.GuildOnboardingPromptOption(data: _DataV, /, *, unique=False)

Bases: Object[GuildOnboardingPromptOption]

Source: Prompt Option Structure

id: Snowflake

Source: id

channel_ids: Collection[Snowflake]

Source: channel_ids

role_ids: Collection[Snowflake]

Source: role_ids

emoji: Emoji

Source: emoji

title: str

Source: title

description: Optional[str]

Source: description

class aiocord.model.objects.GuildScheduledEvent(data: _DataV, /, *, unique=False)

Bases: Object[GuildScheduledEvent]

Source: Guild Scheduled Event Structure

id: Snowflake

Source: id

guild_id: Snowflake

Source: guild_id

channel_id: Optional[Snowflake]

Source: channel_id

creator_id: Optional[Snowflake]

Source: creator_id

name: str

Source: name

description: Optional[str]

Source: description

scheduled_start_time: ISO8601Timestamp

Source: scheduled_start_time

scheduled_end_time: Optional[ISO8601Timestamp]

Source: scheduled_end_time

privacy_level: GuildScheduledEventPrivacyLevel

Source: privacy_level

status: GuildScheduledEventStatus

Source: status

entity_type: GuildScheduledEventEntityType

Source: entity_type

entity_id: Optional[Snowflake]

Source: entity_id

entity_metadata: Optional[GuildScheduledEventEntityMetadata]

Source: entity_metadata

creator: User

Source: creator

user_count: int

Source: user_count

cover: Optional[str]

Source: image

cover_url(**kwargs)

Get the cover url.

class aiocord.model.objects.GuildScheduledEventEntityMetadata(data: _DataV, /, *, unique=False)

Bases: Object[GuildScheduledEventEntityMetadata]

Source: Guild Scheduled Event Entity Metadata

location: str

Source: location

class aiocord.model.objects.GuildScheduledEventUser(data: _DataV, /, *, unique=False)

Bases: Object[GuildScheduledEventUser]

Source: Guild Scheduled Event User Structure

guild_scheduled_event_id: Snowflake

Source: guild_scheduled_event_id

user: User

Source: user

member: GuildMember

Source: member

class aiocord.model.objects.GuildTemplate(data: _DataV, /, *, unique=False)

Bases: Object[GuildTemplate]

Source: Guild Template Structure

code: str

Source: code

name: str

Source: name

description: Optional[str]

Source: description

usage_count: int

Source: usage_count

creator_id: Snowflake

Source: creator_id

creator: User

Source: creator

created_at: ISO8601Timestamp

Source: created_at

updated_at: ISO8601Timestamp

Source: updated_at

source_guild_id: Snowflake

Source: source_guild_id

serialized_source_guild: Guild

Source: serialized_source_guild

is_dirty: Optional[bool]

Source: is_dirty

class aiocord.model.objects.Invite(data: _DataV, /, *, unique=False)

Bases: Object[Invite]

Source: Invite Structure (Invite Metadata Structure)

code: str

Source: code

guild: Guild

Source: guild

channel: Optional[Channel]

Source: channel

inviter: User

Source: inviter

target_type: InviteTargetType

Source: target_type

target_user: User

Source: target_user

target_application: Application

Source: target_application

approximate_presence_count: int

Source: approximate_presence_count

approximate_member_count: int

Source: approximate_member_count

expires_at: Optional[ISO8601Timestamp]

Source: expires_at

stage_instance: InviteStageInstance

Source: stage_instance

guild_scheduled_event: GuildScheduledEvent

Source: guild_scheduled_event

uses: int

Source: uses

max_uses: int

Source: max_uses

max_age: int

Source: max_age

temporary: bool

Source: temporary

created_at: ISO8601Timestamp

Source: created_at

class aiocord.model.objects.InviteStageInstance(data: _DataV, /, *, unique=False)

Bases: Object[InviteStageInstance]

Source: Invite Stage Instance Structure

members: Collection[GuildMember]

Source: members

participant_count: int

Source: participant_count

speaker_count: int

Source: speaker_count

topic: str

Source: topic

class aiocord.model.objects.StageInstance(data: _DataV, /, *, unique=False)

Bases: Object[StageInstance]

Source: Stage Instance Structure

id: Snowflake

Source: id

guild_id: Snowflake

Source: guild_id

channel_id: Snowflake

Source: channel_id

topic: str

Source: topic

privacy_level: StageInstancePrivacyLevel

Source: privacy_level

discoverable_disabled: bool

Source: discoverable_disabled

guild_scheduled_event_id: Optional[Snowflake]

Source: guild_scheduled_event_id

class aiocord.model.objects.Sticker(data: _DataV, /, *, unique=False)

Bases: Object[Sticker]

Source: Sticker Structure

id: Snowflake

Source: id

pack_id: Snowflake

Source: pack_id

name: str

Source: name

description: Optional[str]

Source: description

tags: str

Source: tags

asset: str

Source: asset

type: StickerType

Source: type

format_type: StickerFormatType

Source: format_type

available: bool

Source: available

guild_id: Snowflake

Source: guild_id

user: User

Source: user

sort_value: int

Source: sort_value

image_url(**kwargs)

Get the icon url.

class aiocord.model.objects.StickerPack(data: _DataV, /, *, unique=False)

Bases: Object[StickerPack]

Source: Sticker Pack Structure

id: Snowflake

Source: id

stickers: Collection[Sticker]

Source: stickers

name: str

Source: name

sku_id: Snowflake

Source: sku_id

cover_sticker_id: Snowflake

Source: cover_sticker_id

description: str

Source: description

banner_asset_id: Snowflake

Source: banner_asset_id

banner_url(**kwargs)

Get the icon url.

class aiocord.model.objects.User(data: _DataV, /, *, unique=False)

Bases: Object[User]

Source: User Structure

id: Snowflake

Source: id

username: str

Source: username

discriminator: str

Source: discriminator

global_name: Optional[str]

Source: global_name

avatar: Optional[str]

Source: avatar

bot: bool

Source: bot

system: bool

Source: system

mfa_enabled: bool

Source: mfa_enabled

banner: Optional[str]

Source: banner

accent_color: Optional[int]

Source: accent_color

locale: Locale

Source: locale

verified: bool

Source: verified

email: Optional[str]

Source: email

flags: UserFlags

Source: flags

premium_type: UserPremiumType

Source: premium_type

public_flags: UserFlags

Source: public_flags

property name

Alias for username.

display()

Get the display name.

mention()

Get the mention.

banner_url(**kwargs)

Get the banner url.

avatar_url(**kwargs)

Get the avatar url.

class aiocord.model.objects.Connection(data: _DataV, /, *, unique=False)

Bases: Object[Connection]

Source: Connection Structure

id: str

Source: id

name: str

Source: name

type: str

Source: type

revoked: bool

Source: revoked

integrations: Collection[Integration]

Source: integrations

verified: bool

Source: verified

friend_sync: bool

Source: friend_sync

show_activity: bool

Source: show_activity

two_way_link: bool

Source: two_way_link

visibility: ConnectionVisibilityType

Source: visibility

class aiocord.model.objects.ApplicationRoleConnection(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationRoleConnection]

Source: Application Role Connection Structure

platform_name: Optional[str]

Source: platform_name

platform_username: Optional[str]

Source: platform_username

metadata: dict[str, ApplicationRoleConnectionMetadata]

Source: metadata

class aiocord.model.objects.VoiceState(data: _DataV, /, *, unique=False)

Bases: Object[VoiceState]

Source: Voice State Structure

guild_id: Snowflake

Source: guild_id

channel_id: Optional[Snowflake]

Source: channel_id

user_id: Snowflake

Source: user_id

member: GuildMember

Source: member

session_id: str

Source: session_id

deaf: bool

Source: deaf

mute: bool

Source: mute

self_deaf: bool

Source: self_deaf

self_mute: bool

Source: self_mute

self_stream: bool

Source: self_stream

self_video: bool

Source: self_video

suppress: bool

Source: suppress

request_to_speak_timestamp: Optional[ISO8601Timestamp]

Source: request_to_speak_timestamp

class aiocord.model.objects.VoiceRegion(data: _DataV, /, *, unique=False)

Bases: Object[VoiceRegion]

Source: Voice Region Structure

id: str

Source: id

name: str

Source: name

optimal: bool

Source: optimal

deprecated: bool

Source: deprecated

custom: bool

Source: custom

class aiocord.model.objects.Webhook(data: _DataV, /, *, unique=False)

Bases: Object[Webhook]

Source: Webhook Structure

id: Snowflake

Source: id

type: WebhookType

Source: type

guild_id: Optional[Snowflake]

Source: guild_id

channel_id: Optional[Snowflake]

Source: channel_id

user: User

Source: user

name: Optional[str]

Source: name

avatar: Optional[str]

Source: avatar

token: str

Source: token

application_id: Optional[Snowflake]

Source: application_id

source_guild: Guild

Source: source_guild

source_channel: Channel

Source: source_channel

url: str

Source: url

class aiocord.model.objects.Presence(data: _DataV, /, *, unique=False)

Bases: Object[Presence]

Source: Presence Update Presence Update Event Fields

user: User

Source: user

guild_id: Snowflake

Source: guild_id

status: StatusType

Source: status

activities: Collection[Activity]

Source: activities

client_status: ClientStatus

Source: client_status

class aiocord.model.objects.ClientStatus(data: _DataV, /, *, unique=False)

Bases: Object[ClientStatus]

Source: https://discord.com/developers/docs</topics/gateway-events#client-status-object>

desktop: str

Source: desktop

mobile: str

Source: mobile

web: str

Source: web

class aiocord.model.objects.Activity(data: _DataV, /, *, unique=False)

Bases: Object[Activity]

Source: Activity Structure

name: str

Source: name

type: ActivityType

Source: type

url: Optional[str]

Source: url

created_at: Timestamp

Source: created_at

timestamps: ActivityTimestamps

Source: timestamps

application_id: Snowflake

Source: application_id

details: Optional[str]

Source: details

state: Optional[str]

Source: state

emoji: Optional[Emoji]

Source: emoji

party: ActivityParty

Source: party

assets: ActivityAssets

Source: assets

secrets: ActivitySecrets

Source: secrets

instance: bool

Source: instance

flags: ActivityFlags

Source: flags

buttons: Collection[ActivityButton]

Source: buttons

class aiocord.model.objects.ActivityTimestamps(data: _DataV, /, *, unique=False)

Bases: Object[ActivityTimestamps]

Source: Activity Timestamps

start: Timestamp

Source: start

end: Timestamp

Source: end

class aiocord.model.objects.ActivityParty(data: _DataV, /, *, unique=False)

Bases: Object[ActivityParty]

Source: Activity Party

id: str

Source: id

size: Collection[int]

Source: size

class aiocord.model.objects.ActivityAssets(data: _DataV, /, *, unique=False)

Bases: Object[ActivityAssets]

Source: Activity Assets

large_image: str

Source: large_image

large_text: str

Source: large_text

small_image: str

Source: small_image

small_text: str

Source: small_text

class aiocord.model.objects.ActivitySecrets(data: _DataV, /, *, unique=False)

Bases: Object[ActivitySecrets]

Source: Activity Secrets

join: str

Source: join

spectate: str

Source: spectate

match: str

Source: match

class aiocord.model.objects.ActivityButton(data: _DataV, /, *, unique=False)

Bases: Object[ActivityButton]

Source: Activity Buttons

label: str

Source: label

url: str

Source: url

class aiocord.model.objects.Role(data: _DataV, /, *, unique=False)

Bases: Object[Role]

Source: Role Structure

id: Snowflake

Source: id

name: str

Source: name

color: int

Source: color

hoist: bool

Source: hoist

icon: Optional[str]

Source: icon

unicode_emoji: Optional[str]

Source: unicode_emoji

position: int

Source: position

permissions: Permissions

Source: permissions

managed: bool

Source: managed

mentionable: bool

Source: mentionable

tags: RoleTags

Source: tags

mention()

Get the mention.

icon_url(**kwargs)

Get the icon url.

class aiocord.model.objects.RoleTags(data: _DataV, /, *, unique=False)

Bases: Object[RoleTags]

Source: Role Tags Structure

bot_id: Snowflake

Source: bot_id

integration_id: Snowflake

Source: integration_id

premium_subscriber: bool

Source: premium_subscriber

subscription_listing_id: Snowflake

Source: subscription_listing_id

available_for_purchase: bool

Source: available_for_purchase

guild_connections: bool

Source: guild_connections

class aiocord.model.objects.Team(data: _DataV, /, *, unique=False)

Bases: Object[Team]

Source: Data Models Team Object

icon: Optional[str]

Source: icon

id: Snowflake

Source: id

members: Collection[TeamMember]

Source: members

name: str

Source: name

owner_user_id: Snowflake

Source: owner_user_id

image_url(**kwargs)

Get the image url.

class aiocord.model.objects.TeamMember(data: _DataV, /, *, unique=False)

Bases: Object[TeamMember]

Source: Data Models Team Member Object

membership_state: TeamMemberMembershipState

Source: membership_state

permissions: Collection[str]

Source: permissions

team_id: Snowflake

Source: team_id

user: User

Source: user

class aiocord.model.objects.SKU(data: _DataV, /, *, unique=False)

Bases: Object[SKU]

Source: SKU Structure

id: Snowflake

type: SKUType

application_id: Snowflake

name: str

slug: str

flags: SKUFlags

class aiocord.model.objects.Entitlement(data: _DataV, /, *, unique=False)

Bases: Object[Entitlement]

Source: Entitlement Structure

id: Snowflake

sku_id: Snowflake

application_id: Snowflake

user_id: Snowflake

deleted: bool

starts_at: ISO8601Timestamp

ends_at: ISO8601Timestamp

guild_id: Snowflake

mentions

Message Formatting using basic types.

aiocord.model.mentions.user(user_id)

aiocord.model.mentions.channel(channel_id)

aiocord.model.mentions.role(role_id)

aiocord.model.mentions.command(command_name, command_id)

aiocord.model.mentions.emoji(emoji_name, emoji_id, animated=False)

aiocord.model.mentions.timestamp(value, style=None)

images

Image Formatting using basic types.

aiocord.model.images.emoji(emoji_id, /, **kwargs)

aiocord.model.images.guild_icon(guild_id, guild_icon, /, **kwargs)

aiocord.model.images.guild_splash(guild_id, guild_splash, /, **kwargs)

aiocord.model.images.guild_discovery_splash(guild_id, guild_discovery_splash, /, **kwargs)

aiocord.model.images.guild_banner(guild_id, guild_banner, /, **kwargs)

aiocord.model.images.user_banner(user_id, user_banner, /, **kwargs)

aiocord.model.images.default_user_avatar(user_discriminator, /, **kwargs)

aiocord.model.images.user_avatar(user_id, user_avatar, /, **kwargs)

aiocord.model.images.guild_member_avatar(guild_id, user_id, guild_member_avatar, /, **kwargs)

aiocord.model.images.application_icon(application_id, icon, /, **kwargs)

aiocord.model.images.application_cover(application_id, cover_image, /, **kwargs)

aiocord.model.images.application_asset(application_id, asset_id, /, **kwargs)

aiocord.model.images.achievement_icon(application_id, achievement_id, icon_hash, /, **kwargs)

aiocord.model.images.store_page_asset(application_id, asset_id, /, **kwargs)

aiocord.model.images.sticker_pack_banner(sticker_pack_banner_asset_id, /, **kwargs)

aiocord.model.images.team_icon(team_id, team_icon, /, **kwargs)

aiocord.model.images.sticker(sticker_id, /, **kwargs)

aiocord.model.images.role_icon(role_id, role_icon, /, **kwargs)

aiocord.model.images.guild_scheduled_event_cover(scheduled_event_id, scheduled_event_cover, /, **kwargs)

aiocord.model.images.guild_member_banner(guild_id, user_id, member_banner, /, **kwargs)