API Reference
Complete URL specification, query parameters, and response formats.
URL format
https://shieldcn.dev/{provider}/{...params}.svghttps://shieldcn.dev/{provider}/{...params}.jsonhttps://shieldcn.dev/{provider}/{...params}/shields.jsonBadge endpoints
npm
| Endpoint | Description |
|---|---|
/npm/{package}.svg | Latest version |
/npm/{package}/downloads.svg | Weekly download count |
/npm/@scope/package.svg | Scoped package version |
GitHub
| Endpoint | Description |
|---|---|
/github/{owner}/{repo}/stars.svg | Star count |
/github/{owner}/{repo}/release.svg | Latest release tag |
/github/{owner}/{repo}/ci.svg | CI workflow status |
/github/{owner}/{repo}/license.svg | SPDX license identifier |
Discord
| Endpoint | Description |
|---|---|
/discord/{serverId}.svg | Online member count |
Static
| Endpoint | Description |
|---|---|
/badge/{label}-{message}-{color}.svg | Custom text badge |
/badge/dynamic/json.svg?url=...&query=... | Dynamic JSON badge |
Query parameters
Appearance
PropType
Colors
PropType
Icons
PropType
Layout
PropType
Response formats
SVG (default)
http
Content-Type: image/svg+xml
Cache-Control: public, max-age=3600, s-maxage=3600, stale-while-revalidate=86400JSON
json
{
"label": "npm",
"value": "v19.1.0",
"color": "blue",
"link": "https://www.npmjs.com/package/react"
}Shields.io compatible
json
{
"schemaVersion": 1,
"label": "npm",
"message": "v19.1.0",
"color": "blue"
}Use with shields.io endpoint badge:
