Get margin overview

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  AccountGroupKey	AccountGroupKey	Query-String	The key of the account group for which the margin overview is returned
  AccountKey	AccountKey	Query-String	The key of the account for which the margin overview is returned
  ClientKey	ClientKey	Query-String	The key of the client for which the margin overview is returned

• Response Parameters

  View Response Codes

  Name	Type	Description
  Groups	MarginOverviewGroup []	List of AssetType groups with it's contributing positions and total margin utilization.

  HTTP Code	Description
  200	OK	OK
  400	Bad Request	Error Code Description InvalidClientId Indicates that the requested client id was invalid. NoValidInput No valid input values passed.
  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/balances/marginoverview?AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86&ClientKey=493b43a5-fe85-4d1f-9071-dd4a9d4e42a4

• Response Example

  Response body

  {
    "Groups": [
      {
        "Contributors": [
          {
            "AssetTypes": [
              "FxSpot"
            ],
            "InstrumentDescription": "EURUSD description",
            "InstrumentSpecifier": "EURUSD",
            "Margin": 1235,
            "Uic": 21
          },
          {
            "AssetTypes": [
              "FxSpot"
            ],
            "InstrumentDescription": "GBPUSD description",
            "InstrumentSpecifier": "GBPUSD",
            "Margin": 789,
            "Uic": 22
          }
        ],
        "GroupType": "FX",
        "TotalMargin": 100000
      },
      {
        "Contributors": [
          {
            "AssetTypes": [
              "CfdOnIndex"
            ],
            "InstrumentDescription": "SP500 description",
            "InstrumentSpecifier": "SP500.I",
            "Margin": 4321,
            "Uic": 4910
          },
          {
            "AssetTypes": [
              "CfdOnIndex"
            ],
            "InstrumentDescription": "CSE20 description",
            "InstrumentSpecifier": "CSE20.I",
            "Margin": 975,
            "Uic": 5768
          },
          {
            "AssetTypes": [
              "CfdOnIndex"
            ],
            "InstrumentDescription": "DAX description",
            "InstrumentSpecifier": "DAX.I",
            "Margin": 864,
            "Uic": 27098
          }
        ],
        "GroupType": "CFDs",
        "TotalMargin": 200000
      }
    ]
  }