Skip to main content

Skill Badges

Use GET /api/v1/skills/badge to generate Shields-compatible badge payloads for any published skill.

EndpointDirect link to Endpoint​

  • Route: GET /api/v1/skills/badge
  • Required query parameter: name
  • Optional query parameters:
    • metric: version | status | trust | upvotes | updated
    • label: custom badge label (defaults to skill)
    • style: flat | flat-square | for-the-badge | plastic | social

The endpoint returns a JSON payload that can be rendered directly with Shields:

const endpointUrl =
  'https://hol.org/registry/api/v1/skills/badge?name=demo-skill&metric=version&style=flat';

const imageUrl = `https://img.shields.io/endpoint?url=${encodeURIComponent(endpointUrl)}`;

Metric behaviorDirect link to Metric behavior​

  • version: vX.Y.Z · verified|unverified (changes based on verification state)
  • status: verified or unverified
  • trust: numeric trust score
  • upvotes: total upvotes
  • updated: relative time since publish (5m ago, 2h ago, 7d ago)

GitHub README embedDirect link to GitHub README embed​

[![demo-skill version badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fhol.org%2Fregistry%2Fapi%2Fv1%2Fskills%2Fbadge%3Fname%3Ddemo-skill%26metric%3Dversion%26style%3Dflat)](https://hol.org/registry/skills/demo-skill)

HTML embedDirect link to HTML embed​

<a href="https://hol.org/registry/skills/demo-skill">
  <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fhol.org%2Fregistry%2Fapi%2Fv1%2Fskills%2Fbadge%3Fname%3Ddemo-skill%26metric%3Dstatus%26style%3Dflat-square" alt="demo-skill verification badge" />
</a>

Example endpoint variantsDirect link to Example endpoint variants​

const examples = [
  'https://hol.org/registry/api/v1/skills/badge?name=demo-skill&metric=version',
  'https://hol.org/registry/api/v1/skills/badge?name=demo-skill&metric=status',
  'https://hol.org/registry/api/v1/skills/badge?name=demo-skill&metric=trust',
  'https://hol.org/registry/api/v1/skills/badge?name=demo-skill&metric=upvotes',
  'https://hol.org/registry/api/v1/skills/badge?name=demo-skill&metric=updated&style=for-the-badge',
];