Skip to content

    Risk Envelope

    verified

    Max loss / max gain / breakevens / margin requirement / buying-power effect.

    Verification note

    Verified against Probability Engine and risk sidebar.

    Example payload

    Realistic wire-shaped payload a conforming producer would emit. Validates against the schema above.

    {
      "max_loss": {
        "amount": 1925,
        "currency": "USD",
        "precision": 2
      },
      "max_gain": {
        "amount": 3075,
        "currency": "USD",
        "precision": 2
      },
      "breakevens": [
        238.85
      ],
      "margin_requirement": {
        "amount": 1925,
        "currency": "USD",
        "precision": 2
      },
      "buying_power_effect": {
        "amount": -1925,
        "currency": "USD",
        "precision": 2
      },
      "regulation": "REG_T"
    }

    JSON Schema

    draft/2020-12
    {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "$id": "https://rebeltrade.com/options-schema/v0.1/verdicts/risk.envelope.json",
      "type": "object",
      "required": [
        "max_loss",
        "max_gain",
        "breakevens"
      ],
      "properties": {
        "max_loss": {
          "$ref": "https://rebeltrade.com/options-schema/v0.1/types/Money.json"
        },
        "max_gain": {
          "$ref": "https://rebeltrade.com/options-schema/v0.1/types/Money.json"
        },
        "breakevens": {
          "type": "array",
          "items": {
            "type": "number"
          }
        },
        "margin_requirement": {
          "$ref": "https://rebeltrade.com/options-schema/v0.1/types/Money.json"
        },
        "buying_power_effect": {
          "$ref": "https://rebeltrade.com/options-schema/v0.1/types/Money.json"
        },
        "regulation": {
          "enum": [
            "REG_T",
            "PORTFOLIO_MARGIN"
          ]
        }
      }
    }