Skip to main content

GET /v1/model-info

Returns the current risk engine version, calibration parameters, and score configuration.

Request

GET https://api.canonprotocol.org/v1/model-info

Headers

HeaderRequiredValue
AuthorizationYesBearer YOUR_API_KEY

Response

{
"engine_version": "0.2.0",
"calibration_hash": "a1b2c3d4e5f6...",
"calibration_name": "default",
"weights": {
"slippage": 0.10,
"liquidation": 0.35,
"funding": 0.10,
"impact": 0.05,
"var": 0.25,
"oi": 0.15
},
"recommendation_bands": {
"proceed_max": 40,
"caution_max": 70
},
"scenarios": ["jelly_squeeze", "luna_collapse", "ftx_crash", "short_squeeze", "flash_recovery"]
}

Fields

FieldTypeDescription
engine_versionstringSemantic version of the risk engine
calibration_hashstringSHA-256 hash of the active calibration parameters
calibration_namestringName of the active calibration
weightsobjectRisk model weights used in the composite score calculation
recommendation_bandsobjectScore thresholds for recommendation bands
scenariosstring[]Names of stress test scenarios in the current calibration

Weights Object

FieldTypeDescription
slippagenumberWeight for order book slippage (0.0 - 1.0)
liquidationnumberWeight for liquidation proximity
fundingnumberWeight for funding rate analysis
impactnumberWeight for market impact
varnumberWeight for Value-at-Risk
oinumberWeight for open interest utilization

Weights sum to 1.0.

Recommendation Bands

FieldTypeDescription
proceed_maxnumberMaximum score for "proceed" recommendation
caution_maxnumberMaximum score for "proceed_with_caution". Scores above this are "abort"