Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking

Activity

AUR last modified:AUR last modified badge/aur/last-modified/:packageName
Eclipse Marketplace:Eclipse Marketplace badge/eclipse-marketplace/last-update/:name
Factorio Mod Portal mod:Factorio Mod Portal mod badge/factorio-mod-portal/last-updated/:modName
Galaxy Toolshed (created date):Galaxy Toolshed (created date) badge/galaxytoolshed/created-date/:repository/:owner
GitHub Gist last commit:GitHub Gist last commit badge/github/gist/last-commit/:gistId
GitHub contributors (via allcontributors.org):GitHub contributors (via allcontributors.org) badge/github/all-contributors/:user/:repo/:branch*
GitHub commit activity:GitHub commit activity badge/github/commit-activity/:interval/:user/:repo
GitHub commit activity (branch):GitHub commit activity (branch) badge/github/commit-activity/:interval/:user/:repo/:branch*
GitHub commits difference between two branches/tags/commits:GitHub commits difference between two branches/tags/commits badge/github/commits-difference/:user/:repo?base=1.60.0&head=82f2db7
GitHub commits since tagged version:GitHub commits since tagged version badge/github/commits-since/:user/:repo/:version/:branch*
GitHub commits since tagged version (branch):GitHub commits since tagged version (branch) badge/github/commits-since/:user/:repo/:version/:branch*
GitHub commits since latest release (by date):GitHub commits since latest release (by date) badge/github/commits-since/:user/:repo/:version/:branch*
GitHub commits since latest release (by date) for a branch:GitHub commits since latest release (by date) for a branch badge/github/commits-since/:user/:repo/:version/:branch*
GitHub commits since latest release (by date including pre-releases):GitHub commits since latest release (by date including pre-releases) badge/github/commits-since/:user/:repo/:version/:branch*?include_prereleases
GitHub commits since latest release (by SemVer):GitHub commits since latest release (by SemVer) badge/github/commits-since/:user/:repo/:version/:branch*?sort=semver
GitHub commits since latest release (by SemVer including pre-releases):GitHub commits since latest release (by SemVer including pre-releases) badge/github/commits-since/:user/:repo/:version/:branch*?include_prereleases&sort=semver
GitHub contributors:GitHub contributors badge/github/:variant/:user/:repo
GitHub last commit:GitHub last commit badge/github/last-commit/:user/:repo
GitHub last commit (branch):GitHub last commit (branch) badge/github/last-commit/:user/:repo/:branch
GitHub last commit (by committer):GitHub last commit (by committer) badge/github/last-commit/:user/:repo?display_timestamp=committer
GitHub Release Date:GitHub Release Date badge/github/release-date/:user/:repo
GitHub (Pre-)Release Date:GitHub (Pre-)Release Date badge/github/release-date-pre/:user/:repo
GitHub Release Date - Published_At:GitHub Release Date - Published_At badge/github/release-date/:user/:repo?display_date=published_at
GitLab contributors:GitLab contributors badge/gitlab/contributors/:project+
GitLab (self-managed) contributors:GitLab (self-managed) contributors badge/gitlab/contributors/:project+?gitlab_url=https%3A%2F%2Fjihulab.com
GitLab last commit:GitLab last commit badge/gitlab/last-commit/:project+?gitlab_url=https%3A%2F%2Fgitlab.com
npm collaborators:npm collaborators badge/npm/collaborators/:packageName
npm collaborators:npm collaborators badge/npm/collaborators/:packageName?registry_uri=https%3A%2F%2Fregistry.npmjs.com
Open VSX Release Date:Open VSX Release Date badge/open-vsx/release-date/:namespace/:extension
Steam Release Date:Steam Release Date badge/steam/release-date/:fileId
Steam Update Date:Steam Update Date badge/steam/update-date/:fileId
Vaadin Directory:Vaadin Directory badge/vaadin-directory/release-date/:packageName
Visual Studio Marketplace Last Updated:Visual Studio Marketplace Last Updated badge/visual-studio-marketplace/last-updated/:extensionId
Visual Studio Marketplace Release Date:Visual Studio Marketplace Release Date badge/visual-studio-marketplace/release-date/:extensionId
WhatPulse user metric:WhatPulse user metric badge/whatpulse/:metric/:userType/:id
WhatPulse team metric - rank:WhatPulse team metric - rank badge/whatpulse/:metric/:userType/:id?rank
WordPress Plugin Last Updated:WordPress Plugin Last Updated badge/wordpress/plugin/last-updated/:slug
WordPress Theme Last Updated:WordPress Theme Last Updated badge/wordpress/theme/last-updated/: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, 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 and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored.
?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