Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Platform & Version Support

Cocoapods platforms:/cocoapods/p/:spec
Conda:/conda/pn/:channel/:package
GitHub package.json dependency version (prod):/github/package-json/dependency-version/:user/:repo/:packageName
GitHub package.json dependency version (dev dep on branch):/github/package-json/dependency-version/:user/:repo/dev/:scope?/:packageName/:branch*
node:/node/v/:packageName
node (scoped):/node/v/@:scope/:packageName
node (tag):/node/v/:packageName/:tag
node (scoped with tag):/node/v/@:scope/:packageName/:tag
node (scoped with tag, custom registry):/node/v/@:scope/:packageName/:tag?registry_uri=https%3A%2F%2Fregistry.npmjs.com
npm peer dependency version:/npm/dependency-version/:packageName/peer/:dependency
npm peer dependency version (scoped):/npm/dependency-version/:scope?/:packageName/dev/:dependencyScope?/:dependency
npm dev dependency version:/npm/dependency-version/:packageName/dev/:dependency
npm dev dependency version (scoped):/npm/dependency-version/:scope?/:packageName/dev/:dependencyScope?/:dependency
npm (prod) dependency version:/npm/dependency-version/:packageName/:dependency
npm (prod) dependency version (scoped):/npm/dependency-version/:scope?/:packageName/:dependencyScope?/:dependency
npm type definitions:/npm/types/:packageName
PHP from Packagist:/packagist/php-v/:user/:repo
PHP from Packagist (specify version):/packagist/php-v/:user/:repo/:version
PowerShell Gallery:/powershellgallery/p/:packageName
Puppet Forge – PDK version:/puppetforge/pdk-version/:user/:moduleName
PyPI - Django Version:/pypi/djversions/:packageName
PyPI - Implementation:/pypi/implementation/:packageName
PyPI - Python Version:/pypi/pyversions/:packageName
PyPI - Wheel:/pypi/wheel/:packageName
Spiget tested server versions:/spiget/tested-versions/:resourceId
PHP from Travis config:/travis/php-v/:user/:repo/:branch*
WordPress Plugin: Required WP Version:/wordpress/plugin/wp-version/:slug
WordPress Plugin: Tested WP Version:/wordpress/plugin/tested/:slug

Your Badge

Static


Using dash "-" separator

https://img.shields.io/badge/<LABEL>-<MESSAGE>-<COLOR>

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

Using query string parameters

https://img.shields.io/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>

Colors

brightgreengreenyellowgreenyelloworangeredbluelightgrey
successimportantcriticalinformationalinactive
bluevioletff69b49cf

Endpoint

https://img.shields.io/endpoint?url=<URL>&style<STYLE>

Create badges from your own JSON endpoint.

Dynamic

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

https://img.shields.io/badge/dynamic/xml?url=<URL>&label=<LABEL>&query=<//data/subdata>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

https://img.shields.io/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 .pngfor 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 ofhttps://img.shields.io/v/npm/express ishttps://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