Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $skip Integer Query-String The number of entries to skip from the beginning of the collection
    $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 resource belongs.
    AccountKeys String [] Query-String The keys of the accounts to which the resource belongs.
    AssetTypes String Query-String Comma seperated asset type list to provide filterd transaction only for passed asset types.
    BookingId String Query-String Booking id for which data is needed
    ClientKey ClientKey Query-String The key of the client to which the historic data belongs.
    CorporateActionId String Query-String Corporate action id for which data is needed
    Events String Query-String Comma seperated event type list to provide filterd transaction only for passed event types.
    FromDate Date Query-String From date
    FundingSubType String Query-String Comma seperated event type list to provide filterd transaction only for passed funding sub types.
    ToDate Date Query-String To date
    ToOpenOrClose String Query-String Comma seperated ToOpenOrClose to provide filtered transaction only for passed ToOpen/Close/Pending.
    TradeId String Query-String Trade id for which data is needed
    TransactionType TransactionType Query-String Transaction type for which trasactions are needed
    Uics String Query-String Comma seperated Uic list to provide filterd transaction only for passed Uics.

  • 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 Transaction [] 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/transactions?$skip=1&$top=1&AccountGroupKey=stringValue&AccountKeys=7wfA7-TCgQ0ygd||aOXY0w==,7wfA7-TCgQ0ygd||aOserd==&AssetTypes=stringValue&BookingId=stringValue&ClientKey=AbSTLYSoo499JZpp|ckGFw==&CorporateActionId=stringValue&Events=stringValue&FromDate=2021-05-21&FundingSubType=stringValue&ToDate=2021-05-21&ToOpenOrClose=stringValue&TradeId=stringValue&TransactionType=CorporateAction&Uics=stringValue

  • Response Example

    Response body
    {
  "Data": [
    {
      "AccountId": "stringValue",
      "BkRecordId": 122,
      "BookedAmount": 10,
      "BookingId": "stringValue",
      "Bookings": [
        {
          "AmountType": "stringValue",
          "AmountTypeDisplay": "stringValue",
          "AmountTypeId": "stringValue",
          "BookedAmount": 10,
          "BookingId": "stringValue",
          "ConversionCost": 10,
          "ConversionRate": 10,
          "ConversionRateAccountToClientCurrency": 10,
          "CostClass": "OngoingCosts",
          "CostSubClass": "NotAssigned",
          "Date": "2021-05-21T00:00:00Z",
          "IntradayAmount": 10,
          "PostingDate": "2021-05-21T00:00:00Z",
          "RecordDate": "2021-05-21T00:00:00Z",
          "TaxPercentage": 10,
          "ValueDate": "2021-05-21T00:00:00Z"
        }
      ],
      "Cash": {
        "After": {
          "Available": 10,
          "Balance": 10,
          "Blocked": 10
        },
        "Before": {
          "Available": 10,
          "Balance": 10,
          "Blocked": 10
        }
      },
      "Comment": "stringValue",
      "ConversionCost": 10,
      "ConversionRate": 10,
      "CorporateActionId": "stringValue",
      "CorporateActionTypeId": "stringValue",
      "CorrectionReason": "stringValue",
      "Currency": "stringValue",
      "CurrencyDecimals": 99,
      "Date": "2021-05-21T00:00:00Z",
      "DividendCurrency": "stringValue",
      "Event": "stringValue",
      "EventDisplay": "stringValue",
      "FrankedAmount": 10,
      "FrankingCredit": 10,
      "FromDerivative": "stringValue",
      "FrontOfficeTradeId": "stringValue",
      "FundingSubType": "Other",
      "FundingSubTypeDisplay": "stringValue",
      "IBAN": "stringValue",
      "IBANOwnerName": "stringValue",
      "Instrument": {
        "AssetType": "FxSpot",
        "Barrier1": 10,
        "Barrier2": 10,
        "Currency": "stringValue",
        "CurrencyDecimals": 99,
        "Description": "stringValue",
        "ExchangeDescription": "stringValue",
        "ExpiryDate": "2021-05-21T00:00:00Z",
        "FinancingLevel": 10,
        "IndexRatio": 10,
        "ISINCode": "stringValue",
        "IssuerName": "stringValue",
        "Mnemonic": "stringValue",
        "PriceCurrency": "stringValue",
        "ResidualValue": 2.55,
        "Strike": 10,
        "Strike2": 10,
        "Symbol": "stringValue",
        "Uic": 99
      },
      "IntradayAmount": 10,
      "IsAdvisedTrade": true,
      "IsIntradayData": false,
      "IsReversal": true,
      "OriginalTradeId": 48,
      "PositionId": "stringValue",
      "RealizedPnL": 10,
      "RelatedPositionId": "stringValue",
      "RelatedTradeId": "stringValue",
      "RemittanceInfo": "stringValue",
      "ReportTypes": [
        {
          "ReportDisplayName": "stringValue",
          "ReportName": "stringValue"
        }
      ],
      "TotalCost": 10,
      "TradeId": "stringValue",
      "Trades": [
        {
          "AdjustedTradeDate": "2021-05-21T00:00:00Z",
          "CleanPrice": 10,
          "DecisionMakerUserId": 99,
          "Direction": "Call",
          "DirtyPrice": 10,
          "ExchangeName": "stringValue",
          "InitialMargin": 10,
          "Instrument": {
            "AssetType": "FxCrypto",
            "Barrier1": 10,
            "Barrier2": 10,
            "Currency": "stringValue",
            "CurrencyDecimals": 99,
            "Description": "stringValue",
            "ExchangeDescription": "stringValue",
            "ExpiryDate": "2021-05-21T00:00:00Z",
            "FinancingLevel": 10,
            "IndexRatio": 10,
            "ISINCode": "stringValue",
            "IssuerName": "stringValue",
            "Mnemonic": "stringValue",
            "PriceCurrency": "stringValue",
            "ResidualValue": 2.55,
            "Strike": 10,
            "Strike2": 10,
            "Symbol": "stringValue",
            "Uic": 99
          },
          "MaintenanceMargin": 10,
          "OptionEventType": "OneTouch",
          "OrderId": "stringValue",
          "PositionId": "stringValue",
          "Price": 10,
          "SpreadCost": 10,
          "StopLoss": 10,
          "ToolId": "stringValue",
          "ToOpenOrClose": "Pending",
          "ToOpenOrCloseDisplay": "stringValue",
          "TradeBarrierEventStatus": true,
          "TradedQuantity": 10,
          "TradedValue": 10,
          "TradeEventType": "Sold",
          "TradeEventTypeDisplay": "stringValue",
          "TradeExecutionTime": "2021-05-21T00:00:00Z",
          "TradeId": "stringValue",
          "TradeType": "MarketStopOut",
          "Venue": "stringValue"
        }
      ],
      "TransactionDescription": "stringValue",
      "TransactionType": "Trade",
      "TransactionTypeDisplay": "stringValue",
      "UnderlyingInstrument": {
        "AssetType": "FxForwards",
        "Barrier1": 10,
        "Barrier2": 10,
        "Currency": "stringValue",
        "CurrencyDecimals": 99,
        "Description": "stringValue",
        "ExchangeDescription": "stringValue",
        "ExpiryDate": "2021-05-21T00:00:00Z",
        "FinancingLevel": 10,
        "IndexRatio": 10,
        "ISINCode": "stringValue",
        "IssuerName": "stringValue",
        "Mnemonic": "stringValue",
        "PriceCurrency": "stringValue",
        "ResidualValue": 2.55,
        "Strike": 10,
        "Strike2": 10,
        "Symbol": "stringValue",
        "Uic": 99
      },
      "UnderlyingInstrumentType": "stringValue",
      "UnderlyingType": "Instrument",
      "UnFrankedAmount": 10,
      "ValueDate": "2021-05-21T00:00:00Z",
      "Venue": "stringValue"
    }
  ],
  "MaxRows": 99
}