API#

Note

This is the deprecated documentation, to visit the up to date documentation, check the reference page

class AuthUrl(client_id, scope, redirect_uri, permissions)#

the base of the authorization url

Parameters:

client_id (str) – The client id of your app
scope (List[str]) – A list of Discord scopes
redirect_uri (str) – The redirect uri you want to use
permissions (int or the permissions class) – The permissions of the bot, Optional

async makeUrl()#

Makes the actual url and returns it

Returns:: The auth link
Return type:: str

class discordApi(client_id, client_secret, scope, redirect_uri)#

Where you can get your access token, and use some Discord API links

Parameters:

client_id (str) – The client id of your app
client_secret (str) – The client secret of your app
scope (List[str]) – a list of the scopes you authorized for
redirect_uri (str) – The redirect_uri you want to use

async accessToken(code)#

Makes a request to discord to get an access token

Parameters:: code (str) – The code that you get after the user gets redirected to your application
Returns:: The response recieved after the request is made
Return type:: dict[str, str]

class User(access_token)#

The links for the User API in Discord

Parameters:: access_token – The access token you get after using the accessToken() method in the discordApi class

async get_current_user()#

Uses the access token provided to request the current user from discord api

Returns:: The response from the Discord API
Return type:: UserObj

async get_user_guilds()#

Gets the users guilds from Discord

Returns:: A list of partial Guild objects
Return type:: List[str]

New in version 1.1: Used to get the users guilds.

async get_guild(id, with_counts)#

Gets a guild from the Guild ID

Parameters:

id – The id of the guild you want
with_counts – an optional parameter that indicates you want (True) Discord to return approximate_member_count approximate_presence_count or not (False). Defaults to False

Type:

bool or None

Type:

int or None

Returns:

The guild object for the given id

Return type:

GuildObj

New in version 1.2: Based off of the GET /guilds/<id> endpoint

class bot(client_id, permissions)#

Makes an auth url, but for bots

Parameters:

client_id – The client id of your bot
permissions (int or permissions) – The permissions of your bot

async url()#

Returns the url for the bot auth

Returns:: The url for bot auth
Return type:: str

class permissions(permissions)#

Updates, removes, and adds permissions that you want to use

New in version 1.3.

Parameters:: permissions (List of int or str, int, str, dictionary with keys as either int or str and values as bools, or None) – The permissions you want to use. Optional

async update(permissions)#

Updates the permissions to what you want

Parameters:: permissions (List of int or str, str, int, Dictionary of int or str as keys and a bool as the value) – The permissions you want to update

async add(permissions)#

Adds the permissions provided to the value, and if the permissions is already added, doesn’t change it.

Parameters:: permissions (int, str, or list of int or str) – The permissions you want to add

async remove(permissions)#

Removes the permissions provided, and if the permissions were already False, it doesn’t change it.

Parameters:: permissions (int, str, or list of int or str) – The permissions you want to remove

async all()#: Adds all of the permissions to the permission value

async none()#: Sets all permissions to false

async general()#