Pixel-perfect Retina-ready Fast Consistent Hackable No tracking
Platform & Version Support
| Cocoapods platforms: | /cocoapods/p/:spec | |
|---|---|---|
| Conda: | /conda/pn/:channel/:package | |
| GitHub package.json dependency version (prod): | /github/package-json/dependency-version/:user/:repo/:packageName | |
| GitHub package.json dependency version (dev dep on branch): | /github/package-json/dependency-version/:user/:repo/dev/:scope?/:packageName/:branch* | |
| GitHub package.json dependency version (subfolder of monorepo): | /github/package-json/dependency-version/:user/:repo/:packageName?filename=packages%2Fchar-width-table-builder%2Fpackage.json | |
| GitHub Pipenv locked Python version: | /github/pipenv/locked/python-version/:user/:repo | |
| GitHub Pipenv locked Python version (branch): | /github/pipenv/locked/python-version/:user/:repo/:branch | |
| node-current: | /node/v/:packageName | |
| node-current (scoped): | /node/v/@:scope/:packageName | |
| node-current (tag): | /node/v/:packageName/:tag | |
| node-current (scoped with tag): | /node/v/@:scope/:packageName/:tag | |
| node-current (scoped with tag, custom registry): | /node/v/@:scope/:packageName/:tag?registry_uri=https%3A%2F%2Fregistry.npmjs.com | |
| node-lts: | /node/v-lts/:packageName | |
| node-lts (scoped): | /node/v-lts/@:scope/:packageName | |
| node-lts (tag): | /node/v-lts/:packageName/:tag | |
| node-lts (scoped with tag): | /node/v-lts/@:scope/:packageName/:tag | |
| node-lts (scoped with tag, custom registry): | /node/v-lts/@:scope/:packageName/:tag?registry_uri=https%3A%2F%2Fregistry.npmjs.com | |
| npm peer dependency version: | /npm/dependency-version/:packageName/peer/:dependency | |
| npm peer dependency version (scoped): | /npm/dependency-version/:scope?/:packageName/peer/:dependencyScope?/:dependency | |
| npm dev dependency version: | /npm/dependency-version/:packageName/dev/:dependency | |
| npm dev dependency version (scoped): | /npm/dependency-version/:scope?/:packageName/dev/:dependencyScope?/:dependency | |
| npm (prod) dependency version: | /npm/dependency-version/:packageName/:dependency | |
| npm (prod) dependency version (scoped): | /npm/dependency-version/:scope?/:packageName/:dependencyScope?/:dependency | |
| npm type definitions: | /npm/types/:packageName | |
| Compatible versions (plugins on Ore): | /ore/sponge-versions/:pluginId | |
| Packagist PHP Version Support: | /packagist/php-v/:user/:repo | |
| Packagist PHP Version Support (specify version): | /packagist/php-v/:user/:repo/:version | |
| Packagist PHP Version Support (custom server): | /packagist/php-v/:user/:repo?server=https%3A%2F%2Fpackagist.org | |
| PowerShell Gallery: | /powershellgallery/p/:packageName | |
| Puppet Forge – PDK version: | /puppetforge/pdk-version/:user/:moduleName | |
| PyPI - Django Version: | /pypi/djversions/:packageName | |
| PyPI - Implementation: | /pypi/implementation/:packageName | |
| PyPI - Python Version: | /pypi/pyversions/:packageName | |
| PyPI - Wheel: | /pypi/wheel/:packageName | |
| Repology - Repositories: | /repology/repositories/:projectName | |
| Spiget tested server versions: | /spiget/tested-versions/:resourceId | |
| PHP version from Travis config: | /travis/php-v/:user/:repo/:branch+ | |
| WordPress Plugin Required PHP Version: | /wordpress/plugin/required-php/:slug | |
| WordPress Theme Required PHP Version: | /wordpress/theme/required-php/:slug | |
| WordPress Plugin: Required WP Version: | /wordpress/plugin/wp-version/:slug | |
| WordPress Theme: Required WP Version: | /wordpress/theme/wp-version/:slug | |
| WordPress Plugin: Tested WP Version: | /wordpress/plugin/tested/: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, 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=violet | Set 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=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. Note that this only works when integrating your badge in an<object> HTML tag, but not an<img> tag or a markup language. |
?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/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!