Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Issue Tracking

Bitbucket open issues:Bitbucket open issues badge/bitbucket/issues/:user/:repo
Bitbucket open issues:Bitbucket open issues badge/bitbucket/issues-raw/:user/:repo
Bitbucket open pull requests:Bitbucket open pull requests badge/bitbucket/pr/:user/:repo
Bitbucket Server open pull requests:Bitbucket Server open pull requests badge/bitbucket/pr/:user/:repo?server=https%3A%2F%2Fbitbucket.mydomain.net
Bitbucket open pull requests:Bitbucket open pull requests badge/bitbucket/pr-raw/:user/:repo
Bitbucket Server open pull requests:Bitbucket Server open pull requests badge/bitbucket/pr-raw/:user/:repo?server=https%3A%2F%2Fbitbucket.mydomain.net
Bugzilla bug status (Mozilla):Bugzilla bug status (Mozilla) badge/bugzilla/:bugNumber
Bugzilla bug status (non-Mozilla):Bugzilla bug status (non-Mozilla) badge/bugzilla/:bugNumber?baseUrl=https%3A%2F%2Fbugs.eclipse.org%2Fbugs
Gerrit change status:Gerrit change status badge/gerrit/:changeId?baseUrl=https%3A%2F%2Fandroid-review.googlesource.com
GitHub commit merge status:GitHub commit merge status badge/github/commit-status/:user/:repo/:branch/:commit
GitHub Hacktoberfest combined status:GitHub Hacktoberfest combined status badge/github/hacktoberfest/:year/:user/:repo
GitHub Hacktoberfest combined status (suggestion label override):GitHub Hacktoberfest combined status (suggestion label override) badge/github/hacktoberfest/:year/:user/:repo?suggestion_label=help%20wanted
GitHub issue/pull request detail:GitHub issue/pull request detail badge/github/:issueKind/detail/:property/:user/:repo/:number
GitHub issue custom search:GitHub issue custom search badge/github/issues-search?query=repo%3Abadges%2Fshields%20is%3Aclosed%20label%3Abug%20author%3Aapp%2Fsentry-io
GitHub issue custom search in repo:GitHub issue custom search in repo badge/github/issues-search/:user/:repo?query=is%3Aclosed%20label%3Abug%20author%3Aapp%2Fsentry-io
GitHub issues:GitHub issues badge/github/issues/:user/:repo
GitHub issues:GitHub issues badge/github/issues-raw/:user/:repo
GitHub issues by-label:GitHub issues by-label badge/github/issues/:user/:repo/:label
GitHub issues by-label:GitHub issues by-label badge/github/issues-raw/:user/:repo/:label
GitHub closed issues:GitHub closed issues badge/github/issues-closed/:user/:repo
GitHub closed issues:GitHub closed issues badge/github/issues-closed-raw/:user/:repo
GitHub closed issues by-label:GitHub closed issues by-label badge/github/issues-closed/:user/:repo/:label
GitHub closed issues by-label:GitHub closed issues by-label badge/github/issues-closed-raw/:user/:repo/:label
GitHub pull requests:GitHub pull requests badge/github/issues-pr/:user/:repo
GitHub pull requests:GitHub pull requests badge/github/issues-pr-raw/:user/:repo
GitHub closed pull requests:GitHub closed pull requests badge/github/issues-pr-closed/:user/:repo
GitHub closed pull requests:GitHub closed pull requests badge/github/issues-pr-closed-raw/:user/:repo
GitHub pull requests by-label:GitHub pull requests by-label badge/github/issues-pr/:user/:repo/:label
GitHub pull requests by-label:GitHub pull requests by-label badge/github/issues-pr-raw/:user/:repo/:label
GitHub closed pull requests by-label:GitHub closed pull requests by-label badge/github/issues-pr-closed/:user/:repo/:label
GitHub closed pull requests by-label:GitHub closed pull requests by-label badge/github/issues-pr-closed-raw/:user/:repo/:label
GitHub labels:GitHub labels badge/github/labels/:user/:repo/:name
GitHub milestone:GitHub milestone badge/github/milestones/:variant/:user/:repo/:number
GitHub milestones:GitHub milestones badge/github/milestones/:variant/:user/:repo
JIRA issue:JIRA issue badge/jira/issue/:issueKey?baseUrl=https%3A%2F%2Fissues.apache.org%2Fjira
JIRA sprint completion:JIRA sprint completion badge/jira/sprint/:sprintId?baseUrl=https%3A%2F%2Fjira.spring.io

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