Discord Profile Markdown badge

Add to your GitHub readme a badge that shows your Discord username and presence!

Set up

The set up process will vary depending on what type of account you want to monitor:

User account

1. Join the Discord server (required, as that's where the bot gets your presence information from)

2. Add to the readme

   ![](https://dcbadge.vercel.app/api/shield/USERID)

   replacing USERID with your Discord user ID (e.g. ![](https://dcbadge.vercel.app/api/shield/406125028065804289))

Done! (Make sure not to leave the server, or this will break)

Bot account

1. DM me () your bot's invite link

2. Add to the readme

   ![](https://dcbadge.vercel.app/api/shield/BOTID?bot=true)

   replacing BOTID with your Discord bot's user ID (e.g. ![](https://dcbadge.vercel.app/api/shield/852977967776399400?bot=true))

Done!

HTML

The API returns an SVG image, so you can embed it in your html just like you would with a regular image by doing

<img src="https://dcbadge.vercel.app/api/shield/USERID" />

Styling

You can chain parameters by connecting them with & (e.g. ?style=flat&theme=clean&compact=true).

style

This uses shields.io to generate the badge, so you can choose one of the styles from there by appending ?style= to the url.

Badge	Style	Query
	flat	?style=flat
	flat-square	?style=flat-square
	for-the-badge	None (default)
	plastic	?style=plastic
	social	?style=social

theme

You can also use the theme query option to change the colors of the shield

In the following themes the green color gets replaced by the color corresponding to your presence (green, yellow, red, and grey, for online, idle, do not disturb, and offline, respectively)

Badge	Theme	Query
	Default	None (default)
	Default inverted	?theme=default-inverted
	Clean	?theme=clean
	Clean inverted	?theme=clean-inverted
	Discord	?theme=discord
	Discord inverted	?theme=discord-inverted
	Full presence	?theme=full-presence
	Gray	?theme=gray
	Blurple	?theme=blurple

Note: the theme option will not work with the social style.

compact

Badge	Query
	?compact=true

logoColor

You can pass a color for the logo (the examples below also use &theme=default-inverted to show the color better)

Badge	Query	Description
	?logoColor=presence	Changes the color of the logo according to the presence
	?logoColor=pink	Supported colors here
	?logoColor=ff6b6b	Any hex code, without the #

I've added this to my GitHub bio and it doesn't work!

This won't work in bios, only in profile readmes (and any other part of GitHub that supports markdown). Here's some info on what a profile readme is and how to set it up.

For any questions feel free to contact me (, [email protected])

Endpoints

(Preceded by https://dcbadge.vercel.app/api/shield)

Endpoint	Description	Example response
/USERID	returns a shield in the SVG format
/json/USERID	returns the raw JSON used to generate the shields	{ "t": "monty#9398", "p": "online" }

The above endpoints are also valid for bots, by adding the ?bot=true query parameter