Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $inlinecount InlineCountValue Query-String Indication of whether the total count of elements must be returned.
    $skip Int Query-String Optional number of elements to skip.
    $skiptoken String Query-String Id token of entity to start taking elements from.
    $top Int Query-String Optional number of elements to retrieve.
    AccountGroupKey AccountGroupKey Query-String Id of the account containing the historical positions.
    AccountKey AccountKey Query-String Id of the account containing the historical positions.
    AssetType AssetType Query-String Filtering on asset type. If value not supplied all will be returned
    ClientKey ClientKey Route Id of the client owning the account
    FromDate Date Query-String From date from which the historical positions are requested.
    MockDataId String Query-String Optional Mock Data Parameter
    StandardPeriod AccountPerformanceStandardPeriod Query-String Standard period for account performance.
    Symbol String [] Query-String The Instrument Symbol Code
    ToDate Date Query-String To date till which the historical positions are requested.
  • Response Parameters

    View Response Codes
    Name Type Description
    AccountId AccountId ID/Name of the account on which the position was traded.
    Amount Decimal The amount held by the position.
    AmountAccountValueCloseRatio String The relative value of the Closed Position compared to the account at the time of the position closing.
    AmountAccountValueOpenRatio String The relative value of the Closed Position compared to the account at the time of the position creation.
    ClosingAssetType AssetType AssetType of instrument of closing trade.
    ClosingDisplayHint DisplayHintType Provides DisplayHintType to UI for closing trade.
    ClosingTradeDate Date The date the clsing trade was executed.
    ClosingValueDate Date The value date of the opening trade.
    CopiedFrom String The position id of the position that has been copied.
    CorrelationType CorrelationType The correlation type of the historical position.
    Decimals Int Number of Decimals.
    ExecutionTimeClose UtcDateTime UTC date and time of when the position was closed.
    ExecutionTimeOpen UtcDateTime UTC date and time of when the position was opened.
    ExpiryDate Date The date the option expires.
    InstrumentSymbol String The Instrument symbol.
    LongShort LongOrShort Indicates whether it is a long or a short position.
    LowerBarrier Decimal Lower barrier for options.
    OpeningAssetType AssetType AssetType of instrument of opening trade.
    OpeningDisplayHint DisplayHintType Provides DisplayHintType to UI for opening trade.
    OpeningTradeDate Date The date the opening trade was executed.
    OpeningValueDate Date The value date of the opening trade.
    PipsGainPerInstrumentUnit Decimal The pips or decipips Only applicable for FX
    PriceClose Decimal At what price was the posision closed (in instrument base currency).
    PriceGain Decimal The difference between opening and closing price in percent.
    PriceOpen Decimal At what price was the position opened (in instrument base currency).
    PricePct Decimal Percentage gain between the opening price and the closing price. The percentage gained is taking the 'short' / 'long' information into account. A price drops for a 'short' positions yields a positive price gain where as a price drop for a 'long' position yields a negative price gain. The reverse is true a price increase is registred. Return Percentage value from decimal fraction, e.g. 100% for 1, 50% for 0.50
    ProfitLoss Decimal The P/L of the position in absolute amount.
    ProfitLossAccountValueFraction Decimal The P/L over account value EOD previous day.
    PutCall PutCall Option type.
    StrikePrice Decimal The strike price of the option.
    Uic Uic Unique instrument code.
    UpperBarrier Decimal Upper barrier for options.
  • Request Example

    Request URL
    GET hist/v3/positions/AbSTLYSoo499JZpp|ckGFw==/?$top=99&$skip=99&$inlinecount=AllPages&$skiptoken=stringValue&Symbol=stringValue&AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86&FromDate=2021-05-21&ToDate=2021-05-21&StandardPeriod=AllTime&AssetType=CfdOnFutures&MockDataId=stringValue
  • Response Example

    Response body
    {
      "Data": [
        {
          "AccountId": "112209INET",
          "AccountValueEndOfDay": {
            "AccountBalance": 7526.17183,
            "CashTransfers": 0.0,
            "Date": "2016-07-19",
            "PositionsValue": -978.29753,
            "SecurityTransfers": 0.0,
            "TotalValue": 6547.8743
          },
          "Amount": -1.0,
          "AmountAccountValueCloseRatio": "2:1",
          "AmountAccountValueOpenRatio": "2:1",
          "ClosingAssetType": "CfdOnIndex",
          "ClosingTradeDate": "2016-07-19",
          "ClosingValueDate": "2016-07-19",
          "CopiedFrom": "1",
          "CorrelationType": "None",
          "Decimals": 2,
          "ExecutionTimeClose": "2016-07-19T07:25:37Z",
          "ExecutionTimeOpen": "2016-07-18T10:38:06Z",
          "FigureValue": 1.0,
          "InstrumentCcyToAccountCcyRateClose": 1.1020982542939,
          "InstrumentCcyToAccountCcyRateOpen": 1.11308229426434,
          "InstrumentSymbol": "GER30.I",
          "LongShort": {
            "PresentationValue": "Short",
            "Value": "Short"
          },
          "OpeningAssetType": "CfdOnIndex",
          "OpeningTradeDate": "2016-07-18",
          "OpeningValueDate": "2016-07-18",
          "PriceClose": 9998.0,
          "PriceGain": 0.0047780211029265383,
          "PriceOpen": 10046.0,
          "PricePct": -0.47780211029265379,
          "ProfitLoss": 52.87,
          "ProfitLossAccountValueFraction": 0.00807437613761156,
          "Uic": "1373",
          "ValueInAccountCurrencyClose": -11018.778346430412,
          "ValueInAccountCurrencyOpen": -11182.02472817956
        }
      ]
    }