Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Social

GitHub followers:GitHub followers badge/github/followers/:user?label=Follow
GitHub forks:GitHub forks badge/github/forks/:user/:repo?label=Fork
GitHub Sponsors:GitHub Sponsors badge/github/sponsors/:user
GitHub Repo stars:GitHub Repo stars badge/github/stars/:user/:repo?style=social
GitHub User's stars:GitHub User's stars badge/github/stars/:user?affiliations=OWNER%2CCOLLABORATOR
GitHub Org's stars:GitHub Org's stars badge/github/stars/:org
GitHub watchers:GitHub watchers badge/github/watchers/:user/:repo?label=Watch
Keybase BTC:Keybase BTC badge/keybase/btc/:username
Keybase PGP:Keybase PGP badge/keybase/pgp/:username
Keybase XLM:Keybase XLM badge/keybase/xlm/:username
Keybase ZEC:Keybase ZEC badge/keybase/zec/:username
Mastodon Follow:Mastodon Follow badge/mastodon/follow/:id?domain=https%3A%2F%2Fmastodon.social
Subreddit subscribers:Subreddit subscribers badge/reddit/subreddit-subscribers/:subreddit
Reddit User Karma:Reddit User Karma badge/reddit/user-karma/:variant/:user
Twitter URL:Twitter URL badge/twitter/url?url=https%3A%2F%2Fshields.io
Twitter Follow:Twitter Follow badge/twitter/follow/:user?label=Follow
YouTube Video Comments:YouTube Video Comments badge/youtube/comments/:videoId
YouTube Video Likes:YouTube Video Likes badge/youtube/likes/:videoId
YouTube Video Votes:YouTube Video Votes badge/youtube/likes/:videoId?withDislikes
YouTube Video Views:YouTube Video Views badge/youtube/views/:videoId

Your Badge

Static


Using dash "-" separator

/badge/<LABEL>-<MESSAGE>-<COLOR>

Dashes --- Dash
Underscores ___ Underscore
_ or Space    Space

Using query string parameters

/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>

Colors

brightgreengreenyellowgreenyelloworangeredbluelightgrey
successimportantcriticalinformationalinactive
bluevioletff69b49cf

Endpoint

/endpoint?url=<URL>&style<STYLE>

Create badges from your own JSON endpoint.

Dynamic

/badge/dynamic/json?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

/badge/dynamic/xml?url=<URL>&label=<LABEL>&query=<//data/subdata>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

/badge/dynamic/yaml?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>


Styles

The following styles are available. Flat is the default. Examples are shown with an optional logo:

?style=plastic&logo=appveyorplastic
?style=flat&logo=appveyorflat
?style=flat-square&logo=appveyorflat-square
?style=for-the-badge&logo=appveyorfor-the-badge
?style=social&logo=appveyorsocial

Here are a few other parameters you can use: (connecting several with "&" is possible)

?label=healthinessesOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!)
?logo=appveyorInsert one of the named logos from (bitcoin, dependabot, discord, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. Simple-icons are referenced using names as they appear on the simple-icons site. If the name includes spaces, replace them with dashes (e.g: ?logo=visual-studio-code)
?logo=data:image/png;base64,…Insert custom logo image (≥ 14px high). There is a limit on the total size of request headers we can accept (8192 bytes). From a practical perspective, this means the base64-encoded image text is limited to somewhere slightly under 8192 bytes depending on the rest of the request header.
?logoColor=violetSet the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos but not for custom logos.
?logoWidth=40Set the horizontal space to give to the logo
?link=http://left&link=http://rightSpecify what clicking on the left/right of a badge should do (esp. for social badge style)
?labelColor=abcdefSet background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorA" is also supported.
?color=fedcbaSet background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorB" is also supported.
?cacheSeconds=3600Set the HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored). The legacy name "maxAge" is also supported.

We support .svg and .json. The default is .svg, which can be omitted from the URL.

While we highly recommend using SVG, we also support .png for use cases where SVG will not work. These requests should be made to our raster server https://raster.shields.io. For example, the raster equivalent of https://img.shields.io/v/npm/express is https://raster.shields.io/v/npm/express. For backward compatibility, the badge server will redirect .png badges to the raster server.

Like This?

Have an idea for an awesome new badge?
Tell us about it and we might bring it to you!

CommunityStatusMetricsGitHub