Docs

To quickly generate badge code, go to Get Started. This page has detailed endpoint documentation.

StatusBadges uses Shields.io's badge-maker library, so the badge query params follow the Shields format.

All query params are optional. Logos only display on the flat, flat-square, and plastic styles.

Badges

Status

https://api.statusbadges.me/badge/status/:id

currently onlinecurrently idlecurrently dndcurrently offline

Query Params

ParamDescriptionDefault
simplewhether to show online for idle and dnd statusesfalse
labelthe text on the left sidecurrently
labelColorthe color of the left sidegray
colorthe color of the right sidebrightgreen if online, yellow if idle, red if dnd, lightgray if offline
styleflat, flat-square, plastic, for-the-badge, or socialflat

Playing

https://api.statusbadges.me/badge/playing/:id

playing Minecraftplaying nothing rn

Query Params

ParamDescriptionDefault
labelthe text on the left sideplaying
fallbacktext to show on the left side if nothing is being playednothing rn
labelColorthe color of the left sidegray
colorthe color of the right side#5865f2
styleflat, flat-square, plastic, for-the-badge, or socialflat

Visual Studio Code

https://api.statusbadges.me/badge/vscode/:id

coding app.ts in statusbadgescoding nothing rn

Query Params

ParamDescriptionDefault
labelthe text on the left sidecoding
fallbacktext to show on the left side if VS Code isn't in usenothing rn
labelColorthe color of the left sidegray
colorthe color of the right side#23a7f2
styleflat, flat-square, plastic, for-the-badge, or socialflat
hideLogowhether to disable the VS Code logofalse

IntelliJ IDEA

https://api.statusbadges.me/badge/intellij/:id

coding app.ts in statusbadgescoding nothing rn

Query Params

ParamDescriptionDefault
labelthe text on the left sidecoding
fallbacktext to show on the left side if IntelliJ IDEA isn't in usenothing rn
labelColorthe color of the left sidegray
colorthe color of the right side#fe315d
styleflat, flat-square, plastic, for-the-badge, or socialflat
hideLogowhether to disable the IntelliJ logofalse

Spotify

https://api.statusbadges.me/badge/spotify/:id

listening to Am I Dreaming by Metro Boomin, A$AP Rocky, and Roiseelistening to nothing rn

Query Params

ParamDescriptionDefault
labelthe text on the left sidelistening to
fallbacktext to show on the left side if Spotify isn't in usenothing rn
labelColorthe color of the left sidegray
colorthe color of the right side#1db954
styleflat, flat-square, plastic, for-the-badge, or socialflat
hideLogowhether to disable the Spotify logofalse

Crunchyroll

https://api.statusbadges.me/badge/crunchyroll/:id

watching TONIKAWA: Over The Moon For Youwatching nothing rn

Query Params

ParamDescriptionDefault
labelthe text on the left sidewatching
fallbacktext to show on the left side if Crunchyroll isn't in usenothing rn
labelColorthe color of the left sidegray
colorthe color of the right side#f47521
styleflat, flat-square, plastic, for-the-badge, or socialflat
hideLogowhether to disable the Crunchyroll logofalse

Open Spotify

https://api.statusbadges.me/openspotify/:idRedirects to the track page of the song you're listening to on Spotify.

Presence

https://api.statusbadges.me/presence/:idReturns a JSON object of your presence so you can integrate it another way.