Get details about a single account group

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	Number	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.
  ClientKey	ClientKey	Unique ID of the client.
  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	Boolean	Portfolio Based Margin (PBM) is a method for mapping the risk of an investment portfolio. True if enabled else false.
  SupportsAccountValueProtectionLimit	Boolean	If true, an AccountValueProtectionLimit may be set on this account. If it is false, the AccountValueProtectionLimit can be set on client or account group.

  HTTP Code	Description
  200	OK	OK
  400	Bad Request	Error Code Description InvalidInput An error was encountered when processing given input parameters.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  GET /port/v1/accountgroups/LZTc7DdejXODf-WSl2aCyQ==?ClientKey=5DG7K1P5cqYBZ77tl7Af4w==

• Response Example

  Response body

  {
    "AccountGroupKey": "stringValue",
    "AccountGroupName": "stringValue",
    "AccountValueProtectionLimit": 10,
    "ClientKey": "493b43a5-fe85-4d1f-9071-dd4a9d4e42a4",
    "CollateralMonitoringMode": "MaxOfCollateralCreditValueAndCollateralCreditLine",
    "MarginCalculationMethod": "SpanForFuturesAndOptions",
    "MarginLendingEnabled": "None",
    "MarginMonitoringMode": "Margin",
    "PortfolioBasedMarginEnabled": true,
    "SupportsAccountValueProtectionLimit": false
  }