Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountGroupKey AccountGroupKey Route Unique key for the account group.
    ClientKey ClientKey Query-String The key of the client to which the account group belong.
  • Response Parameters

    View Response Codes
    Name Type Description
    AccountGroupKey AccountGroupKey Unique ID of the account group used for selection
    AccountGroupName String Name of the account group, displayed to the user
    AccountValueProtectionLimit Decimal If set, this value shields the account value from going below the given limit by automatically triggering closing of positions should the limit be exceeded. A limit of zero means there is no limit.
    CollateralMonitoringMode CollateralMonitoringMode Collateral Monitoring Mode. Null when entity is not monitored on collateral.
    MarginCalculationMethod PortfolioMarginMethod Calculation method for assessing margin utilization.
    MarginLendingEnabled MarginLendingEnabled Margin Lending Enabled
    MarginMonitoringMode MarginMonitoringMode Margin Monitoring Mode. Null when entity is not monitored on margin.
    PortfolioBasedMarginEnabled Bool Portfolio Based Margin (PBM) is a method for mapping the risk of an investment portfolio. True if enabled else false.
    SupportsAccountValueProtectionLimit Bool If true, an AccountValueProtectionLimit may be set on this account. If it is false, the AccountValueProtectionLimit can be set on client or account group.
  • Request Example

    Request URL
    GET port/v1/accountgroups/LZTc7DdejXODf-WSl2aCyQ==/?ClientKey=5DG7K1P5cqYBZ77tl7Af4w==
  • Response Example

    Response body
    {
      "AccountGroupKey": "stringValue",
      "AccountGroupName": "stringValue",
      "AccountValueProtectionLimit": 10.0,
      "CollateralMonitoringMode": "CollateralCreditValue",
      "EntityRelation": "Direct",
      "MarginCalculationMethod": "SpanForFutures",
      "MarginLendingEnabled": "None",
      "MarginMonitoringMode": "Margin",
      "Permissions": [
        "stringValue"
      ],
      "PortfolioBasedMarginEnabled": true,
      "SupportsAccountValueProtectionLimit": false
    }