GitHub

tiny shields

Live endpoint

Create a custom badge from a JSON endpoint using https://tinyshields.dev/live.

Query parameters

The live endpoint expects the following query parameters:
  • label:Label shown on the left side of the badge.
  • url:JSON endpoint to fetch data from.
  • query:Path to value in JSON data to show on the right side of the badge. The query is flattened so nested values can be reached too.
  • color:Background color to show on the right side of the badge, accepts a hex value or one of these colors.

Example

Fetch the npm version tagged as latest for the package microsite: https://tinyshields.dev/live?label=npm&url=https://registry.npmjs.org/-/package/microsite/dist-tags&query=latest&color=yellow

npm latest tag version