Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountGroupKey AccountGroupKey Query-String The account group key.
    AccountKey AccountKey Query-String The account key.
    ClientKey ClientKey Query-String The client key.
    FieldGroups AccountSummaryFieldGroup [] Query-String The field groups.
    FromDate Date Query-String From date.
    MockDataId String Query-String The mock data identifier.
    StandardPeriod AccountPerformanceStandardPeriod Query-String The standard period.
    ToDate Date Query-String To date.
  • Response Parameters

    View Response Codes
    Name Type Description
    AccumulatedProfitLoss Number The accumulated Profit / Loss for the account over the period as a value.
    BenchMarks BenchMark [] The bench mark.
    From Date The start date is the offset date for all performance metrics that is a part of the 'AccountPerformance'.
    InceptionDay Date The date where the first account deposit have been registred.
    LastTradeDay Date Performance data that is returned is limited to the be data that lies between the first trade day and the last trade day for the account. The last trade day is the last day that one or more trades have been registred.
    Thru Date The end date is the ending date for all returned performance metrics that is a part of the 'AccountPerformance'. The 'ActualThruDate' date is included.
    TotalCashBalance Number The total cash balance
    TotalCashBalancePerCurrency StringValuePair [] The total cash balance grouped by currency.
    TotalOpenPositionsValue Number The total value of client's open positions
    TotalPositionsValuePerCurrency StringValuePair [] The total position value grouped by currency.
    TotalPositionsValuePerProductPerSecurity PositionOnSecurityAndProduct [] The total position value grouped by product.
    TradeSummary TradeSummary Summary of all trade activity between start and end date.
    WinFraction Number The fraction of trades with positive profit/loss.
  • Request Example

    Request URL
    GET /hist/v4/performance/summary?AccountGroupKey={AccountGroupKey}&AccountKey={AccountKey}&ClientKey={ClientKey}&FieldGroups=TradeSummary&FromDate={FromDate}&MockDataId={MockDataId}&StandardPeriod=AllTime&ToDate={ToDate}
  • Response Example

    Response body
    {
      "AccumulatedProfitLoss": 100,
      "BenchMarks": [
        {
          "Allocations": [
            {
              "AllocationPCT": 100,
              "AssetType": "Cash",
              "Description": "",
              "DisplayHintType": "None",
              "Uic": 211
            }
          ],
          "CurrencyCode": "USD",
          "Description": "Description1",
          "Name": "Bench Mark Name 1"
        },
        {
          "Allocations": [
            {
              "AllocationPCT": 100,
              "AssetType": "Bond",
              "Description": "",
              "DisplayHintType": "None",
              "Uic": 210
            },
            {
              "AllocationPCT": 100,
              "AssetType": "CertificateBonus",
              "Description": "",
              "DisplayHintType": "None",
              "Uic": 211
            }
          ],
          "CurrencyCode": "EUR",
          "Description": "Description2",
          "Name": "Bench Mark Name 2"
        }
      ],
      "From": "2024-04-10T00:00:00Z",
      "InceptionDay": "2024-04-10T00:00:00Z",
      "LastTradeDay": "2024-04-10T00:00:00Z",
      "Thru": "2024-04-10T00:00:00Z",
      "TotalCashBalance": 5000,
      "TotalCashBalancePerCurrency": [
        {
          "StringValue": "CAD",
          "Value": -491.707122366824
        }
      ],
      "TotalOpenPositionsValue": 6000,
      "TotalPositionsValuePerCurrency": [
        {
          "StringValue": "CAD",
          "Value": -491.707122366824
        }
      ],
      "TotalPositionsValuePerProductPerSecurity": [
        {
          "Description": "Position On Security And Product",
          "ProductName": "Product Name",
          "Symbol": "Symbol",
          "Value": 200
        }
      ],
      "TradeSummary": {
        "Allocation": {
          "TradesPerAssetType": {
            "ClosedTradesAllocations": [
              {
                "AssetClassType": "Equity",
                "ReturnAttribution": 1,
                "TradeCount": 168,
                "TradePercent": 0.380090497737557
              },
              {
                "AssetClassType": "Commodity",
                "ReturnAttribution": 0.562878945000956,
                "TradeCount": 105,
                "TradePercent": 0.237556561085973
              },
              {
                "AssetClassType": "Currency",
                "ReturnAttribution": 0.249937016456527,
                "TradeCount": 112,
                "TradePercent": 0.253393665158371
              },
              {
                "AssetClassType": "Fixed Income",
                "ReturnAttribution": -0.0131508561362492,
                "TradeCount": 57,
                "TradePercent": 0.1289592760181
              }
            ]
          },
          "TradesPerInstrument": {
            "ClosedTradesAllocations": [
              {
                "AssetType": "ContractFutures",
                "InstrumentDescription": "30-Year U.S. Treasury Bond - Sep 2016",
                "InstrumentSymbol": "ZBU6",
                "InstrumentUic": 3626018,
                "ReturnAttribution": -0.159871010056843,
                "TradeCount": 40,
                "TradePercent": 0.0904977375565611
              },
              {
                "AssetType": "FxSpot",
                "InstrumentDescription": "British Pound/US Dollar",
                "InstrumentSymbol": "GBPUSD",
                "InstrumentUic": 31,
                "ReturnAttribution": 0.146851552251858,
                "TradeCount": 37,
                "TradePercent": 0.083710407239819
              }
            ]
          }
        },
        "AverageTradeDurationInMinutes": 34260,
        "AverageTradesPerWeek": 48.2325728770595,
        "NumberOfDaysTraded": 1589,
        "NumberOfLongTrades": 5434,
        "NumberOfShortTrades": 5263,
        "TopTradedInstruments": [
          "DAX.I",
          "DJI.I",
          "EURUSD",
          "GBPUSD",
          "NAS100.I",
          "NOKSEK",
          "EURNOK",
          "SP500.I"
        ],
        "TradeActivity": {
          "TradesPerDay": [
            {
              "Date": "2024-04-10T00:00:00Z",
              "TradeCount": 100
            }
          ]
        },
        "TradedInstruments": [
          "FxSpot",
          "Stock",
          "FxVanillaOption",
          "ContractFutures"
        ],
        "TradesTotalCount": 10697,
        "TradesWonCount": 6499
      },
      "WinFraction": 5
    }