Pixel-perfect Retina-ready Fast Consistent Hackable No tracking
Love Shields? Please consider donating to sustain our activities
Version
| Mozilla Add-on: | /amo/v/:addonId | |
|---|---|---|
| APM: | /apm/v/:packageName | |
| Arch Linux package: | /archlinux/v/:repository/:architecture/:packageName | |
| AUR version: | /aur/version/:packageName | |
| Bintray: | /bintray/v/:subject/:repo/:packageName | |
| Bower Version: | /bower/v/:packageName | |
| Bower Version (including pre-releases): | /bower/v/:packageName?include_prereleases | |
| Cdnjs: | /cdnjs/v/:library | |
| Chocolatey Version: | /chocolatey/v/:packageName | |
| Chocolatey Version (including pre-releases): | /chocolatey/v/:packageName?include_prereleases | |
| Chrome Web Store: | /chrome-web-store/v/:storeId | |
| Clojars Version: | /clojars/v/:clojar+ | |
| Clojars Version (including pre-releases): | /clojars/v/:clojar+?include_prereleases | |
| Cocoapods: | /cocoapods/v/:spec | |
| Conda: | /conda/v/:channel/:package | |
| Conda (channel only): | /conda/vn/:channel/:package | |
| Chef cookbook: | /cookbook/v/:cookbook | |
| CPAN: | /cpan/v/:packageName | |
| CRAN/METACRAN: | /cran/v/:packageName | |
| Crates.io: | /crates/v/:crate | |
| CTAN: | /ctan/v/:library | |
| Debian package: | /debian/v/:packageName/:distribution? | |
| Docker Image Version (latest by date): | /docker/v/:user/:repo?sort=date | |
| Docker Image Version (latest semver): | /docker/v/:user/:repo?sort=semver | |
| Docker Image Version (tag latest semver): | /docker/v/:user/:repo/:tag | |
| DUB: | /dub/v/:packageName | |
| Eclipse Marketplace: | /eclipse-marketplace/v/:name | |
| Elm package: | /elm-package/v/:user/:packageName | |
| F-Droid: | /f-droid/v/:appId | |
| F-Droid (explicit metadata format): | /f-droid/v/:appId?metadata_format=yml | |
| Fedora package: | /fedora/v/:packageName/:branch? | |
| Gem: | /gem/v/:gem | |
| GitHub go.mod Go version: | /github/go-mod/go-version/:user/:repo | |
| GitHub go.mod Go version (branch): | /github/go-mod/go-version/:user/:repo/:branch | |
| GitHub go.mod Go version (subfolder of monorepo): | /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/:user/:repo/:branch?filename=src%2Fgo.mod | |
| Github lerna version: | /github/lerna-json/v/:user/:repo | |
| Github lerna version (branch): | /github/lerna-json/v/:user/:repo/:branch | |
| GitHub manifest version: | /github/manifest-json/v/:user/:repo | |
| GitHub manifest version: | /github/manifest-json/v/:user/:repo/:branch | |
| GitHub package.json version: | /github/package-json/v/:user/:repo | |
| GitHub package.json version (branch): | /github/package-json/v/:user/:repo/:branch | |
| GitHub release (latest by date): | /github/v/release/:user/:repo | |
| GitHub release (latest by date including pre-releases): | /github/v/release/:user/:repo?include_prereleases | |
| GitHub release (latest SemVer): | /github/v/release/:user/:repo?sort=semver | |
| GitHub release (latest SemVer including pre-releases): | /github/v/release/:user/:repo?include_prereleases&sort=semver | |
| GitHub tag (latest by date): | /github/v/tag/:user/:repo | |
| GitHub tag (latest SemVer): | /github/v/tag/:user/:repo?sort=semver | |
| GitHub tag (latest SemVer pre-release): | /github/v/tag/:user/:repo?include_prereleases&sort=semver | |
| Hackage: | /hackage/v/:packageName | |
| Hex.pm: | /hexpm/v/:packageName | |
| homebrew cask: | /homebrew/cask/v/:cask | |
| homebrew: | /homebrew/v/:formula | |
| iTunes App Store: | /itunes/v/:bundleId | |
| Jenkins Plugins: | /jenkins/plugin/v/:plugin | |
| JetBrains IntelliJ Plugins: | /jetbrains/plugin/v/:pluginId | |
| JitPack: | /jitpack/v/:vcs/:user/:repo | |
| LuaRocks: | /luarocks/v/:user/:moduleName/:version? | |
| Maven Central: | /maven-central/v/:groupId/:artifactId | |
| Maven Central with version prefix filter: | /maven-central/v/:groupId/:artifactId/:versionPrefix | |
| Maven metadata URL: | /maven-metadata/v?metadataUrl=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fgoogle%2Fcode%2Fgson%2Fgson%2Fmaven-metadata.xml | |
| MyGet: | /myget/:feed/v/:packageName | |
| MyGet (with prereleases): | /myget/:feed/vpre/:packageName | |
| MyGet tenant: | /:tenant.myget/:feed/v/:packageName | |
| Sonatype Nexus (Releases): | /nexus/r/:groupId/:artifactId?nexusVersion=3&server=https%3A%2F%2Fnexus.pentaho.org | |
| Sonatype Nexus (Snapshots): | /nexus/s/:groupId/:artifactId?server=https%3A%2F%2Foss.sonatype.org | |
| Sonatype Nexus (Repository): | /nexus/:repo/:groupId/:artifactId?server=https%3A%2F%2Frepository.jboss.org%2Fnexus | |
| Sonatype Nexus (Query Options): | /nexus/:repo/:groupId/:artifactId?queryOpt=%3Ac%3Dagent-apple-osx%3Ap%3Dtar.gz&server=https%3A%2F%2Frepository.jboss.org%2Fnexus | |
| npm: | /npm/v/:packageName | |
| npm (scoped): | /npm/v/:scope/:packageName | |
| npm (tag): | /npm/v/:packageName/:tag | |
| npm (custom registry): | /npm/v/:packageName/:tag?registry_uri=https%3A%2F%2Fregistry.npmjs.com | |
| npm (scoped with tag): | /npm/v/:scope/:packageName/:tag | |
| Nuget: | /nuget/v/:packageName | |
| Nuget (with prereleases): | /nuget/vpre/:packageName | |
| OPM: | /opm/v/:user/:moduleName | |
| Packagist Version: | /packagist/v/:user/:repo | |
| Packagist Version (including pre-releases): | /packagist/v/:user/:repo?include_prereleases | |
| Packagist Version (custom server): | /packagist/v/:user/:repo?server=https%3A%2F%2Fpackagist.org | |
| PowerShell Gallery Version: | /powershellgallery/v/:packageName | |
| PowerShell Gallery Version (including pre-releases): | /powershellgallery/v/:packageName?include_prereleases | |
| Pub Version: | /pub/v/:packageName | |
| Pub Version (including pre-releases): | /pub/v/:packageName?include_prereleases | |
| Puppet Forge version: | /puppetforge/v/:user/:moduleName | |
| PyPI: | /pypi/v/:packageName | |
| JetBrains ReSharper plugins Version: | /resharper/v/:packageName | |
| JetBrains ReSharper plugins Version (including pre-releases): | /resharper/v/:packageName?include_prereleases | |
| Spack: | /spack/v/:packageName | |
| Spiget Version: | /spiget/version/:resourceId | |
| Ubuntu package: | /ubuntu/v/:packageName/:series? | |
| Vaadin Directory: | /vaadin-directory/v/:packageName | |
| Visual Studio App Center (Minimum) OS Version: | /visual-studio-app-center/releases/osver/:owner/:app/:token | |
| Visual Studio App Center Releases: | /visual-studio-app-center/releases/version/:owner/:app/:token | |
| Visual Studio Marketplace Version: | /visual-studio-marketplace/v/:extensionId | |
| WordPress Theme Version: | /wordpress/theme/v/:slug | |
| WordPress Plugin Version: | /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
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=appveyor | |
?style=flat&logo=appveyor | |
?style=flat-square&logo=appveyor | |
?style=for-the-badge&logo=appveyor | |
?style=social&logo=appveyor |
Here are a few other parameters you can use: (connecting several with "&" is possible)
?label=healthinesses | Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!) |
?logo=appveyor | Insert 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=violet | Set the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported) |
?logoWidth=40 | Set the horizontal space to give to the logo |
?link=http://left&link=http://right | Specify what clicking on the left/right of a badge should do (esp. for social badge style) |
?labelColor=abcdef | Set background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorA" is also supported. |
?color=fedcba | Set background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorB" is also supported. |
?cacheSeconds=3600 | Set 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!