Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Activity

Eclipse Marketplace:Eclipse Marketplace badge/eclipse-marketplace/last-update/:name
GitHub commit activity:GitHub commit activity badge/github/commit-activity/:interval/:user/:repo
GitHub commits since tagged version:GitHub commits since tagged version badge/github/commits-since/:user/:repo/:version/:branch*
GitHub commits since tagged version (branch):GitHub commits since tagged version (branch) badge/github/commits-since/:user/:repo/:version/:branch*
GitHub commits since latest release:GitHub commits since latest release badge/github/commits-since/:user/:repo/:version/:branch*
GitHub commits since latest release (branch):GitHub commits since latest release (branch) badge/github/commits-since/:user/:repo/:version/:branch*
GitHub contributors:GitHub contributors badge/github/:variant/:user/:repo
GitHub last commit:GitHub last commit badge/github/last-commit/:user/:repo
GitHub last commit (branch):GitHub last commit (branch) badge/github/last-commit/:user/:repo/:branch
GitHub Release Date:GitHub Release Date badge/github/release-date/:user/:repo
GitHub (Pre-)Release Date:GitHub (Pre-)Release Date badge/github/release-date-pre/:user/:repo
npm collaborators:npm collaborators badge/npm/collaborators/:packageName
npm collaborators:npm collaborators badge/npm/collaborators/:packageName?registry_uri=https%3A%2F%2Fregistry.npmjs.com
Steam Release Date:Steam Release Date badge/steam/release-date/:fileId
Twitch Status:Twitch Status badge/twitch/status/:user
Vaadin Directory:Vaadin Directory badge/vaadin-directory/release-date/:packageName

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)
?logoColor=violetSet the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported)
?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!

StatusMetricsGitHub