Loan covenant headroom API

Compute headroom against a financial covenant for max-type covenants (e.g. leverage <= 3.5) or min-type covenants (e.g. DSCR >= 1.25), returning absolute and percent headroom, a breach flag, and a compliant/at-risk/breach status. Answers 'how much covenant headroom is left','am I about to breach a covenant','distance to the leverage covenant'.

Price$0.016per request

MethodPOST

Route/v1/score/credit-covenant-headroom

StatusLive

MIME typeapplication/json

Rate limit120/minute

CacheNo cache

scorecreditcovenantheadroombreachlendingloancompliance

API URLhttps://x402.hexl.dev/v1/score/credit-covenant-headroom

Integration docs

Example request

{
  "actual": 3,
  "threshold": 3.5,
  "type": "max"
}

Example response

{
  "model": "Covenant headroom",
  "type": "max",
  "actual": 3,
  "threshold": 3.5,
  "headroom": 0.5,
  "headroomPct": 0.1429,
  "breach": false,
  "status": "compliant",
  "interpretation": "14.3% headroom before breach."
}

Input schema

{
  "type": "object",
  "required": [
    "actual",
    "threshold"
  ],
  "properties": {
    "actual": {
      "type": "number",
      "description": "Actual metric value",
      "examples": [
        3
      ]
    },
    "threshold": {
      "type": "number",
      "description": "Covenant threshold",
      "examples": [
        3.5
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "max",
        "min"
      ],
      "description": "'max' = must stay below, 'min' = must stay above",
      "default": "max",
      "examples": [
        "max"
      ]
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}