Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Version

Mozilla Add-on:Mozilla Add-on badge/amo/v/:addonId
APM:APM badge/apm/v/:packageName
Arch Linux package:Arch Linux package badge/archlinux/v/:repository/:architecture/:packageName
AUR version:AUR version badge/aur/version/:packageName
Bintray:Bintray badge/bintray/v/:subject/:repo/:packageName
Bower Version:Bower Version badge/bower/v/:packageName
Bower Version (including pre-releases):Bower Version (including pre-releases) badge/bower/v/:packageName?include_prereleases
Cdnjs:Cdnjs badge/cdnjs/v/:library
Chocolatey Version:Chocolatey Version badge/chocolatey/v/:packageName
Chocolatey Version (including pre-releases):Chocolatey Version (including pre-releases) badge/chocolatey/v/:packageName?include_prereleases
Chrome Web Store:Chrome Web Store badge/chrome-web-store/v/:storeId
Clojars Version:Clojars Version badge/clojars/v/:clojar+
Clojars Version (including pre-releases):Clojars Version (including pre-releases) badge/clojars/v/:clojar+?include_prereleases
Cocoapods:Cocoapods badge/cocoapods/v/:spec
Conda:Conda badge/conda/v/:channel/:package
Conda (channel only):Conda (channel only) badge/conda/vn/:channel/:package
Chef cookbook:Chef cookbook badge/cookbook/v/:cookbook
CPAN:CPAN badge/cpan/v/:packageName
CRAN/METACRAN:CRAN/METACRAN badge/cran/v/:packageName
Crates.io:Crates.io badge/crates/v/:crate
CTAN:CTAN badge/ctan/v/:library
Debian package:Debian package badge/debian/v/:packageName/:distribution?
Docker Image Version (latest by date):Docker Image Version (latest by date) badge/docker/v/:user/:repo?sort=date
Docker Image Version (latest semver):Docker Image Version (latest semver) badge/docker/v/:user/:repo?sort=semver
Docker Image Version (tag latest semver):Docker Image Version (tag latest semver) badge/docker/v/:user/:repo/:tag
DUB:DUB badge/dub/v/:packageName
Eclipse Marketplace:Eclipse Marketplace badge/eclipse-marketplace/v/:name
Elm package:Elm package badge/elm-package/v/:user/:packageName
F-Droid:F-Droid badge/f-droid/v/:appId
F-Droid (including pre-releases):F-Droid (including pre-releases) badge/f-droid/v/:appId?include_prereleases
Fedora package:Fedora package badge/fedora/v/:packageName/:branch?
Flathub:Flathub badge/flathub/v/:packageName
Gem:Gem badge/gem/v/:gem
GitHub go.mod Go version:GitHub go.mod Go version badge/github/go-mod/go-version/:user/:repo
GitHub go.mod Go version (branch):GitHub go.mod Go version (branch) badge/github/go-mod/go-version/:user/:repo/:branch
GitHub go.mod Go version (subfolder of monorepo):GitHub go.mod Go version (subfolder of monorepo) badge/github/go-mod/go-version/:user/:repo?filename=src%2Fgo.mod
GitHub go.mod Go version (branch & subfolder of monorepo):GitHub go.mod Go version (branch & subfolder of monorepo) badge/github/go-mod/go-version/:user/:repo/:branch?filename=src%2Fgo.mod
Github lerna version:Github lerna version badge/github/lerna-json/v/:user/:repo
Github lerna version (branch):Github lerna version (branch) badge/github/lerna-json/v/:user/:repo/:branch
GitHub manifest version:GitHub manifest version badge/github/manifest-json/v/:user/:repo
GitHub manifest version:GitHub manifest version badge/github/manifest-json/v/:user/:repo/:branch
GitHub manifest version (path):GitHub manifest version (path) badge/github/manifest-json/v/:user/:repo?filename=extension%2Fmanifest.json
GitHub manifest version (path):GitHub manifest version (path) badge/github/manifest-json/v/:user/:repo/:branch?filename=extension%2Fmanifest.json
GitHub package.json version:GitHub package.json version badge/github/package-json/v/:user/:repo
GitHub package.json version (branch):GitHub package.json version (branch) badge/github/package-json/v/:user/:repo/:branch
GitHub release (latest by date):GitHub release (latest by date) badge/github/v/release/:user/:repo
GitHub release (latest by date including pre-releases):GitHub release (latest by date including pre-releases) badge/github/v/release/:user/:repo?include_prereleases
GitHub release (latest SemVer):GitHub release (latest SemVer) badge/github/v/release/:user/:repo?sort=semver
GitHub release (latest SemVer including pre-releases):GitHub release (latest SemVer including pre-releases) badge/github/v/release/:user/:repo?include_prereleases&sort=semver
GitHub tag (latest by date):GitHub tag (latest by date) badge/github/v/tag/:user/:repo
GitHub tag (latest SemVer):GitHub tag (latest SemVer) badge/github/v/tag/:user/:repo?sort=semver
GitHub tag (latest SemVer pre-release):GitHub tag (latest SemVer pre-release) badge/github/v/tag/:user/:repo?include_prereleases&sort=semver
Hackage:Hackage badge/hackage/v/:packageName
Hex.pm:Hex.pm badge/hexpm/v/:packageName
homebrew cask:homebrew cask badge/homebrew/cask/v/:cask
homebrew:homebrew badge/homebrew/v/:formula
iTunes App Store:iTunes App Store badge/itunes/v/:bundleId
Jenkins Plugins:Jenkins Plugins badge/jenkins/plugin/v/:plugin
JetBrains IntelliJ Plugins:JetBrains IntelliJ Plugins badge/jetbrains/plugin/v/:pluginId
JitPack:JitPack badge/jitpack/v/:vcs/:user/:repo
LuaRocks:LuaRocks badge/luarocks/v/:user/:moduleName/:version?
Maven Central:Maven Central badge/maven-central/v/:groupId/:artifactId
Maven Central with version prefix filter:Maven Central with version prefix filter badge/maven-central/v/:groupId/:artifactId/:versionPrefix
Maven metadata URL:Maven metadata URL badge/maven-metadata/v?metadataUrl=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fgoogle%2Fcode%2Fgson%2Fgson%2Fmaven-metadata.xml
MyGet:MyGet badge/myget/:feed/v/:packageName
MyGet (with prereleases):MyGet (with prereleases) badge/myget/:feed/vpre/:packageName
MyGet tenant:MyGet tenant badge/:tenant.myget/:feed/v/:packageName
Sonatype Nexus (Releases):Sonatype Nexus (Releases) badge/nexus/r/:groupId/:artifactId?nexusVersion=3&server=https%3A%2F%2Fnexus.pentaho.org
Sonatype Nexus (Snapshots):Sonatype Nexus (Snapshots) badge/nexus/s/:groupId/:artifactId?server=https%3A%2F%2Foss.sonatype.org
Sonatype Nexus (Repository):Sonatype Nexus (Repository) badge/nexus/:repo/:groupId/:artifactId?server=https%3A%2F%2Frepository.jboss.org%2Fnexus
Sonatype Nexus (Query Options):Sonatype Nexus (Query Options) badge/nexus/:repo/:groupId/:artifactId?queryOpt=%3Ac%3Dagent-apple-osx%3Ap%3Dtar.gz&server=https%3A%2F%2Frepository.jboss.org%2Fnexus
npm:npm badge/npm/v/:packageName
npm (scoped):npm (scoped) badge/npm/v/:scope/:packageName
npm (tag):npm (tag) badge/npm/v/:packageName/:tag
npm (custom registry):npm (custom registry) badge/npm/v/:packageName/:tag?registry_uri=https%3A%2F%2Fregistry.npmjs.com
npm (scoped with tag):npm (scoped with tag) badge/npm/v/:scope/:packageName/:tag
Nuget:Nuget badge/nuget/v/:packageName
Nuget (with prereleases):Nuget (with prereleases) badge/nuget/vpre/:packageName
OPM:OPM badge/opm/v/:user/:moduleName
Packagist Version:Packagist Version badge/packagist/v/:user/:repo
Packagist Version (including pre-releases):Packagist Version (including pre-releases) badge/packagist/v/:user/:repo?include_prereleases
Packagist Version (custom server):Packagist Version (custom server) badge/packagist/v/:user/:repo?server=https%3A%2F%2Fpackagist.org
PowerShell Gallery Version:PowerShell Gallery Version badge/powershellgallery/v/:packageName
PowerShell Gallery Version (including pre-releases):PowerShell Gallery Version (including pre-releases) badge/powershellgallery/v/:packageName?include_prereleases
Pub Version:Pub Version badge/pub/v/:packageName
Pub Version (including pre-releases):Pub Version (including pre-releases) badge/pub/v/:packageName?include_prereleases
Puppet Forge version:Puppet Forge version badge/puppetforge/v/:user/:moduleName
PyPI:PyPI badge/pypi/v/:packageName
JetBrains ReSharper plugins Version:JetBrains ReSharper plugins Version badge/resharper/v/:packageName
JetBrains ReSharper plugins Version (including pre-releases):JetBrains ReSharper plugins Version (including pre-releases) badge/resharper/v/:packageName?include_prereleases
Scoop Version:Scoop Version badge/scoop/v/:app
Scoop Version (extras bucket):Scoop Version (extras bucket) badge/scoop/v/:app?bucket=extras
Spack:Spack badge/spack/v/:packageName
Spiget Version:Spiget Version badge/spiget/version/:resourceId
Ubuntu package:Ubuntu package badge/ubuntu/v/:packageName/:series?
Vaadin Directory:Vaadin Directory badge/vaadin-directory/v/:packageName
Visual Studio App Center (Minimum) OS Version:Visual Studio App Center (Minimum) OS Version badge/visual-studio-app-center/releases/osver/:owner/:app/:token
Visual Studio App Center Releases:Visual Studio App Center Releases badge/visual-studio-app-center/releases/version/:owner/:app/:token
Visual Studio Marketplace Version:Visual Studio Marketplace Version badge/visual-studio-marketplace/v/:extensionId
WordPress Theme Version:WordPress Theme Version badge/wordpress/theme/v/:slug
WordPress Plugin Version:WordPress Plugin Version badge/wordpress/plugin/v/:slug

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