Risk Metrics

Shields.io-style rank badge (JSON)

Public JSON for Shields Endpoint badges. No API key by default; optional shared secret via env RANKINGS_BADGE_TOKEN and query token=. Defaults: metric=subsector_residual, cohort=subsector, window=252d. rank_percentile 100 = best. Cached at the edge; per-IP rate limit when Upstash Redis is configured (RANKINGS_BADGE_IP_RPM, default 120).

get/rankings/{ticker}/badge

Request

  • Base URL: https://riskmodels.app/api
  • URL: https://riskmodels.app/api/rankings/{ticker}/badge
  • Auth: HTTP bearer

Path parameters

tickerstring required

Query parameters

tokenstring

Required when server sets RANKINGS_BADGE_TOKEN.

metric'mkt_cap' | 'gross_return' | 'sector_residual' | 'subsector_residual' | 'er_l1' | 'er_l2' | 'er_l3'
cohort'universe' | 'sector' | 'subsector'
window'1d' | '21d' | '63d' | '252d'

Response

Shields endpoint JSON (schemaVersion 1).

schemaVersion1 required
labelstring
messagestring
colorstring
isErrorboolean

Changes

No recorded changes to this operation across all 1 revision of this API.