Health Badge
Add a nuxt.care health badge to your module's README to show its quality score.
Important Update: The Badge API has moved to
/api/v1/badge. The old /api/badge/{module} endpoint is deprecated and will be removed in a future version. Please update your badges!Quick Start
Add this to your README.md:
[](https://nuxt.care/?search=YOUR-MODULE)
Replace YOUR-MODULE with your module's name as shown on nuxt.care.
Examples
Nuxt Icon:
[](https://nuxt.care/?search=icon)
Pinia (by npm package):
[](https://nuxt.care/?search=pinia)
API Reference
Endpoint
GET https://nuxt.care/api/v1/badge
Query Parameters
| Parameter | Required | Description |
|---|---|---|
module | * | Module name as shown on nuxt.care |
package | * | npm package name (alternative to module) |
mode | score (default) = "85/100", status = "stable" |
* Either module or package is required.
Response
{
"schemaVersion": 1,
"label": "nuxt.care",
"message": "85/100",
"color": "green"
}
Colors & Status
| Score | Color | Status |
|---|---|---|
| 90+ | brightgreen | optimal |
| 70-89 | green | stable |
| 40-69 | yellow | degraded |
| <40 | red | critical |
Display Modes
Score (default): Shows numeric score
/api/v1/badge?module=icon → "85/100"
Status: Shows status label
/api/v1/badge?module=icon&mode=status → "stable"
Badge Styles
Customize with shields.io parameters:
<!-- Flat (default) -->
<!-- Flat square -->
<!-- For the badge -->
See shields.io styles for more options.
Migration from Old API
DEPRECATED:
/api/badge/{module} is deprecated and will be removed!If you're using the old format, update your badges:
| Old (deprecated) | New |
|---|---|
/api/badge/icon | /api/v1/badge?module=icon |
/api/badge/pinia | /api/v1/badge?module=pinia |
/api/badge/@pinia/nuxt | /api/v1/badge?package=@pinia/nuxt |
Before:
After:
