API Reference
Health
Retrieve API health scores for your monitored APIs.
List health scores
GET /api/v1/healthReturns the latest health score for each of your monitored APIs. Scores are recalculated daily.
Query parameters
| Parameter | Type | Description |
|---|---|---|
api_id | string | Filter to a single monitor UUID |
Example
curl https://api.varen.dev/v1/health \
-H "Authorization: Bearer vk_your_key"Response
{
"data": [
{
"api_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
"api_name": "Stripe API",
"score": 92,
"maturity": "stable",
"breakdown": {
"change_frequency": 95,
"breaking_ratio": 90,
"scrape_reliability": 100,
"doc_freshness": 88,
"deprecation_load": 85
},
"scored_at": "2026-03-22"
}
]
}Score breakdown
| Component | Weight | Description |
|---|---|---|
change_frequency | 20% | How often the API changes (fewer changes = higher score) |
breaking_ratio | 30% | Ratio of breaking changes to total changes (lower = better) |
scrape_reliability | 20% | How reliably Varen can fetch the API docs |
doc_freshness | 15% | How recently the docs were updated |
deprecation_load | 15% | Number of active deprecations pending sunset |
Maturity levels
| Maturity | Score range | Description |
|---|---|---|
stable | 80-100 | Low change frequency, rare breaking changes |
moderate | 50-79 | Regular changes, occasional breaking changes |
volatile | 0-49 | Frequent changes, high breaking change ratio |