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 resource belongs.
    AccountKey AccountKey Query-String The key of the account to which the resource belongs.
    ClientKey ClientKey Route The key of the client to which the resource 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 /cs/v1/reports/trades/493b43a5-fe85-4d1f-9071-dd4a9d4e42a4?$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
    {
      "__next": "/openapi/....../?$top=1&$skip=1",
      "Data": [
        {
          "AccountCurrency": "AUD",
          "AccountCurrencyDecimals": 0,
          "AccountId": "148455INET",
          "AdjustedTradeDate": "2010-10-10T00:00:00Z",
          "Amount": -100000,
          "AssetType": "FxSpot",
          "CleanPrice": 0.73356,
          "ClientCurrency": "AUD",
          "Direction": "None",
          "DirtyPrice": 0.73356,
          "ExchangeDescription": "Inter Bank",
          "InitialMargin": 0,
          "InstrumentCurrencyDecimal": 2,
          "InstrumentDescription": "Australian Dollar/US Dollar",
          "InstrumentSectorName": "Major",
          "InstrumentSectorTypeId": 2,
          "InstrumentSymbol": "AUDUSD",
          "MaintenanceMargin": 0,
          "OrderId": "735126300",
          "Price": 0.73356,
          "RootInstrumentSectorName": "FX",
          "RootInstrumentSectorTypeId": 1,
          "Strike": 0,
          "ToOpenOrClose": "ToClose",
          "TradeBarrierEventStatus": false,
          "TradeDate": "2015-10-12T00:00:00Z",
          "TradedValue": 73356,
          "TradeEventType": "Sold",
          "TradeExecutionTime": "2015-10-12T04:26:47Z",
          "TradeId": "861198960",
          "TradeType": "Market",
          "Uic": 4,
          "UnderlyingInstrumentDescription": "Australian Dollar/US Dollar",
          "UnderlyingInstrumentSymbol": "AUDUSD",
          "ValueDate": "2015-10-14T00:00:00Z",
          "Venue": "OTC"
        }
      ]
    }