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.
  • Request Example

    Request URL
    GET port/v1/balances/marginoverview/?ClientKey=493b43a5-fe85-4d1f-9071-dd4a9d4e42a4&AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86
  • Response Example

    Response body
    {
      "Groups": [
        {
          "Contributors": [
            {
              "AssetTypes": [
                "FxSpot"
              ],
              "InstrumentDescription": "EURUSD description",
              "InstrumentSpecifier": "EURUSD",
              "Margin": 1235.0,
              "Uic": 21
            },
            {
              "AssetTypes": [
                "FxSpot"
              ],
              "InstrumentDescription": "GBPUSD description",
              "InstrumentSpecifier": "GBPUSD",
              "Margin": 789.0,
              "Uic": 22
            }
          ],
          "GroupType": "FX",
          "TotalMargin": 100000.0
        },
        {
          "Contributors": [
            {
              "AssetTypes": [
                "CfdOnIndex"
              ],
              "InstrumentDescription": "SP500 description",
              "InstrumentSpecifier": "SP500.I",
              "Margin": 4321.0,
              "Uic": 4910
            },
            {
              "AssetTypes": [
                "CfdOnIndex"
              ],
              "InstrumentDescription": "CSE20 description",
              "InstrumentSpecifier": "CSE20.I",
              "Margin": 975.0,
              "Uic": 5768
            },
            {
              "AssetTypes": [
                "CfdOnIndex"
              ],
              "InstrumentDescription": "DAX description",
              "InstrumentSpecifier": "DAX.I",
              "Margin": 864.0,
              "Uic": 27098
            }
          ],
          "GroupType": "CFDs",
          "TotalMargin": 200000.0
        }
      ]
    }