Skip to main content

Interface: DiscordProfile

providers/discord.DiscordProfile

Corresponds to the user structure documented here: https://discord.com/developers/docs/resources/user#user-object-user-structure

Hierarchy​

  • Record<string, any>

    ↳ DiscordProfile

Properties​

accent_color​

• accent_color: null | number

the user's banner color encoded as an integer representation of hexadecimal color code

avatar​

• avatar: null | string

the user's avatar hash: https://discord.com/developers/docs/reference#image-formatting

avatar_decoration​

• avatar_decoration: null | string

undocumented field; corresponds to the Discord feature where you can e.g. put your avatar inside of an ice cube

• banner: null | string

the user's banner hash: https://discord.com/developers/docs/reference#image-formatting

• banner_color: null | string

undocumented field; corresponds to the premium feature where you can select a custom banner color

discriminator​

• discriminator: string

the user's 4-digit discord-tag

display_name​

• display_name: null | string

undocumented field; corresponds to the user's custom nickname

email​

• email: null | string

the user's email

flags​

• flags: number

the flags on a user's account: https://discord.com/developers/docs/resources/user#user-object-user-flags

id​

• id: string

the user's id (i.e. the numerical snowflake)

image_url​

• image_url: string

undocumented field; the CDN URL of their profile picture

locale​

• locale: string

the user's chosen language option: https://discord.com/developers/docs/reference#locales

mfa_enabled​

• mfa_enabled: boolean

whether the user has two factor enabled on their account

premium_type​

• premium_type: number

the type of Nitro subscription on a user's account: https://discord.com/developers/docs/resources/user#user-object-premium-types

public_flags​

• public_flags: number

the public flags on a user's account: https://discord.com/developers/docs/resources/user#user-object-user-flags

username​

• username: string

the user's username, not unique across the platform

verified​

• verified: boolean

whether the email on this account has been verified

bot​

• Optional bot: boolean

whether the user belongs to an OAuth2 application

system​

• Optional system: boolean

whether the user is an Official Discord System user (part of the urgent message system)