Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $skip Integer Query-String The number of entries to skip from the beginning of the collection
    $skiptoken String Query-String Specifies an entity id to start retrieving entries from. This is normally only used in generated nextlinks.
    $top Integer Query-String The number of entries to return from the beginning of the collection
    AccountGroupKey AccountGroupKey Query-String The key of the account group to which the historic data belongs.
    AccountKey AccountKey Query-String The key of the account to which the historic data belongs.
    ClientKey ClientKey Route The key of the client to which the historic data belongs.
    FromDate Date Query-String from date in UTC, ignored when tradeId is given
    MockDataId String Query-String Optional Mock Data Parameter
    ToDate Date Query-String to date in UTC, ignored when tradeId is given
    TradeId String Query-String trade id, accountkey is mandatory with tradeId
  • Response Parameters

    View Response Codes
    Name Type Description
    __count Number The total count of items in the feed.
    __next String The link for the next page of items in the feed.
    Data Trade [] The collection of entities for this feed.
    MaxRows Number The maximum number of rows that can be returned (if applicable).
  • Request Example

    Request URL
    GET /hist/v1/reports/trades/AbSTLYSoo499JZpp|ckGFw==?$skip=1&$skiptoken=B17D8890-3C7A-4A47-A9AA-01B022ED03A5&$top=1&AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86&FromDate=2016-10-10&MockDataId={MockDataId}&ToDate=2017-10-10&TradeId=293832
  • Response Example

    Response body
    {
      "Data": [
        {
          "AccountCurrency": "stringValue",
          "AccountCurrencyDecimals": 99,
          "AccountId": "stringValue",
          "AdjustedTradeDate": "2021-05-21T00:00:00Z",
          "Amount": 2.55,
          "AssetType": "CertificateTwinWin",
          "Barrier1": 2.55,
          "Barrier2": 2.55,
          "BookedAmountAccountCurrency": 2.55,
          "BookedAmountClientCurrency": 2.55,
          "BookedAmountUSD": 2.55,
          "CaEventId": "stringValue",
          "CaEventTypeId": "stringValue",
          "CaEventTypeName": "stringValue",
          "CleanPrice": 2.55,
          "ClientCurrency": "stringValue",
          "CorrectionType": "stringValue",
          "Direction": "Short",
          "DirtyPrice": 2.55,
          "ExchangeDescription": "stringValue",
          "ExpiryDate": "2021-05-21T00:00:00Z",
          "FinancingLevel": 2.55,
          "IndexRatio": 2.55,
          "InitialMargin": 2.55,
          "InstrumentCategoryCode": "stringValue",
          "InstrumentCurrencyDecimal": 99,
          "InstrumentDescription": "stringValue",
          "InstrumentSectorName": "stringValue",
          "InstrumentSectorTypeId": 99,
          "InstrumentSymbol": "stringValue",
          "IssuerName": "stringValue",
          "MaintenanceMargin": 2.55,
          "Mnemonic": "stringValue",
          "OptionEventType": "KnockInCall",
          "OrderId": "stringValue",
          "Price": 2.55,
          "ResidualValue": 2.55,
          "RootInstrumentSectorName": "stringValue",
          "RootInstrumentSectorTypeId": 99,
          "SpreadCostAccountCurrency": 2.55,
          "SpreadCostClientCurrency": 2.55,
          "SpreadCostUSD": 2.55,
          "StopLoss": 2.55,
          "Strike": 2.55,
          "Strike2": 2.55,
          "ToolId": "stringValue",
          "ToOpenOrClose": "ToOpen",
          "TradeBarrierEventStatus": true,
          "TradeDate": "2021-05-21T00:00:00Z",
          "TradedValue": 2.55,
          "TradeEventType": "Bought",
          "TradeExecutionTime": "2021-05-21T00:00:00Z",
          "TradeId": "stringValue",
          "TradeType": "Limit",
          "Uic": 99,
          "UnderlyingInstrumentDescription": "stringValue",
          "UnderlyingInstrumentSymbol": "stringValue",
          "UnderlyingType": "Instrument",
          "ValueDate": "2021-05-21T00:00:00Z",
          "Venue": "stringValue"
        }
      ],
      "MaxRows": 99
    }