Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Other

Ansible Role:Ansible Role badge/ansible/role/:roleId
AUR maintainer:AUR maintainer badge/aur/maintainer/:packageName
bit:bit badge/bit/collection/total-components/:owner/:collection
bStats Players:bStats Players badge/bstats/players/:pluginid
bStats Servers:bStats Servers badge/bstats/servers/:pluginid
Relative date:Relative date badge/date/:timestamp
Eclipse Marketplace:Eclipse Marketplace badge/eclipse-marketplace/favorites/:name
Ecologi (Carbon Offset):Ecologi (Carbon Offset) badge/ecologi/carbon/:username
Ecologi (Trees):Ecologi (Trees) badge/ecologi/trees/:username
freeCodeCamp points:freeCodeCamp points badge/freecodecamp/points/:username
Gems:Gems badge/gem/u/:user
GitHub deployments:GitHub deployments badge/github/deployments/:user/:repo/:environment
GitHub Discussions:GitHub Discussions badge/github/discussions/:user/:repo
GitHub manifest.json dynamic:GitHub manifest.json dynamic badge/github/manifest-json/:key/:user/:repo
GitHub manifest.json dynamic:GitHub manifest.json dynamic badge/github/manifest-json/:key/:user/:repo/:branch
GitHub manifest.json dynamic (path):GitHub manifest.json dynamic (path) badge/github/manifest-json/:key/:user/:repo?filename=extension%2Fmanifest.json
GitHub manifest.json dynamic (path):GitHub manifest.json dynamic (path) badge/github/manifest-json/:key/:user/:repo/:branch?filename=extension%2Fmanifest.json
GitHub package.json dynamic:GitHub package.json dynamic badge/github/package-json/:key/:user/:repo
GitHub package.json dynamic:GitHub package.json dynamic badge/github/package-json/:key/:user/:repo/:branch
Dependent repos (via libraries.io):Dependent repos (via libraries.io) badge/librariesio/dependent-repos/:platform/:packageName
Dependent repos (via libraries.io), scoped npm package:Dependent repos (via libraries.io), scoped npm package badge/librariesio/dependent-repos/:platform/:scope/:packageName
Dependents (via libraries.io):Dependents (via libraries.io) badge/librariesio/dependents/:platform/:packageName
Dependents (via libraries.io), scoped npm package:Dependents (via libraries.io), scoped npm package badge/librariesio/dependents/:platform/:scope/:packageName
Localizely overall progress:Localizely overall progress badge/localizely/progress/:projectId/:branch*?token=0f4d5e31a44f48dcbab966c52cfb0a67c5f1982186c14b85ab389a031dbc225a
Localizely language progress:Localizely language progress badge/localizely/progress/:projectId/:branch*?languageCode=en-US&token=0f4d5e31a44f48dcbab966c52cfb0a67c5f1982186c14b85ab389a031dbc225a
Maintenance:Maintenance badge/maintenance/:maintained/:year
Ore Category:Ore Category badge/ore/category/:pluginId
OSS Lifecycle:OSS Lifecycle badge/osslifecycle/:user/:repo
OSS Lifecycle (branch):OSS Lifecycle (branch) badge/osslifecycle/:user/:repo/:branch
POEditor:POEditor badge/poeditor/progress/:projectId/:languageCode?token=abc123def456
Puppet Forge modules by user:Puppet Forge modules by user badge/puppetforge/mc/:user
Puppet Forge releases by user:Puppet Forge releases by user badge/puppetforge/rc/:user
PyPI - Format:PyPI - Format badge/pypi/format/:packageName
PyPI - Status:PyPI - Status badge/pypi/status/:packageName
Sourceforge Open Tickets:Sourceforge Open Tickets badge/sourceforge/open-tickets/:project/:type
Sourcegraph for Repo Reference Count:Sourcegraph for Repo Reference Count badge/sourcegraph/rrc/:repo
Steam Collection Files:Steam Collection Files badge/steam/collection-files/:collectionId
Steam Views:Steam Views badge/steam/views/:fileId
Swagger Validator:Swagger Validator badge/swagger/valid/3.0?specUrl=https%3A%2F%2Fraw.githubusercontent.com%2FOAI%2FOpenAPI-Specification%2Fmaster%2Fexamples%2Fv2.0%2Fjson%2Fpetstore-expanded.json
Treeware (Trees):Treeware (Trees) badge/treeware/trees/:owner/:packageName
Vaadin Directory:Vaadin Directory badge/vaadin-directory/status/:packageName
Weblate entities:Weblate entities badge/weblate/:type?server=https%3A%2F%2Fhosted.weblate.org
Weblate project translated:Weblate project translated badge/weblate/progress/:project?server=https%3A%2F%2Fhosted.weblate.org
Weblate user statistic:Weblate user statistic badge/weblate/:statistic/:user?server=https%3A%2F%2Fhosted.weblate.org
Wheelmap:Wheelmap badge/wheelmap/a/:nodeId

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, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. Simple-icons are referenced using icon slugs which can be found on the simple-icons site or in the slugs.md file in the simple-icons repository.
?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. Note that this only works when integrating your badge in an<object> HTML tag, but not an<img> tag or a markup language.
?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/npm/v/express is https://raster.shields.io/npm/v/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