Aave-style lending health factor from collateral, debt and liquidation threshold

Aave-style lending health factor from collateral, debt and liquidation threshold: status, liquidation price, drop to liquidation, repay or add needed for a target.

Paid test badge: not yet. The checks above are free: we call the tool without paying and read the payment request it sends back. The Verified badge needs paid calls whose answers match the promised output, and nobody can buy a badge.

Endpoint

GET https://saylorinnovations.com/api/defi/health-factor

Our checks, last 30 days

Example input (from the provider)

{
  "method": "GET",
  "queryParams": {
    "collateral_price": "3500",
    "collateral_usd": "10000",
    "debt_usd": "5000",
    "liquidation_threshold_percent": "82.5",
    "ltv_percent": "80"
  },
  "type": "http"
}

Promised output schema (from the provider)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "input": {
      "additionalProperties": false,
      "properties": {
        "method": {
          "enum": [
            "GET"
          ],
          "type": "string"
        },
        "queryParams": {
          "properties": {
            "collateral_price": {
              "description": "optional collateral unit price for the liquidation price",
              "type": "string"
            },
            "collateral_usd": {
              "description": "collateral value in USD",
              "type": "string"
            },
            "debt_usd": {
              "description": "borrowed value in USD",
              "type": "string"
            },
            "liquidation_threshold_percent": {
              "description": "asset liquidation threshold, e.g. 82.5",
              "type": "string"
            },
            "ltv_percent": {
              "description": "optional max LTV for borrow headroom",
              "type": "string"
            }
          },
          "required": [
            "collateral_usd",
            "debt_usd",
            "liquidation_threshold_percent"
          ],
          "type": "object"
        },
        "type": {
          "const": "http",
          "type": "string"
        }
      },
      "required": [
        "type",
        "method"
      ],
      "type": "object"
    },
    "output": {
      "properties": {
        "example": {
          "properties": {
            "add_collateral_to_reach_target_usd": {
              "description": "Collateral to add to reach the target health factor",
              "type": "number"
            },
            "borrow_headroom_usd": {
              "description": "Additional borrow available before hitting the max LTV",
              "type": [
                "number",
                "null"
              ]
            },
            "collateral_drop_to_liquidation_percent": {
              "description": "How far the collateral can fall before liquidation, in percent",
              "type": "number"
            },
            "collateral_price": {
              "description": "Collateral unit price supplied",
              "type": [
                "number",
                "null"
              ]
            },
            "collateral_usd": {
              "description": "Collateral value used",
              "type": "number"
            },
            "current_ltv_percent": {
              "description": "Debt divided by collateral, in percent",
              "type": "number"
            },
            "debt_usd": {
              "description": "Borrowed value used",
              "type": "number"
            },
            "health_factor": {
              "description": "Collateral times threshold divided by debt; below 1 is liquidatable",
              "type": "number"
            },
            "liquidation_collateral_value_usd": {
              "description": "Collateral value at which the position is liquidated",
              "type": "number"
            },
            "liquidation_price": {
              "description": "Collateral unit price at which the position is liquidated",
              "type": [
                "number",
                "null"
              ]
            },
            "liquidation_threshold_percent": {
              "description": "Liquidation threshold of the collateral, in percent",
              "type": "number"
            },
            "max_borrow_usd": {
              "description": "Maximum borrow at the supplied LTV",
              "type": [
                "number",
                "null"
              ]
            },
            "note": {
              "description": "Plain-language caveat about how to read and use the result",
              "type": "string"
            },
            "repay_to_reach_target_usd": {
              "description": "Debt to repay to reach the target health factor",
              "type": "number"
            },
            "safe_additional_borrow_at_target_usd": {
              "description": "Additional borrow that still keeps the health factor at the target",
              "type": "number"
            },
            "source": {
              "description": "Where the data or formula comes from",
              "type": "string"
            },
            "status": {
              "description": "Risk label: liquidatable, critical, risky, moderate or healthy",
              "type": "string"
            },
            "target_health_factor": {
              "description": "Safety target used for the repay and top-up figures",
              "type": "number"
            }
          },
          "required": [
            "health_factor",
            "status"
          ],
          "type": "object"
        },
        "type": {
          "const": "json",
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "input"
  ],
  "type": "object"
}

This page as JSON