Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $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
    AccountKey AccountKey Query-String Account key: If specified will only return entries pertaining to specified Account.
    ClientKey ClientKey Query-String Client key: If specified will only return entries pertaining to specified client and its sub clients depending upon includeSubAccounts.
    CorrelationKey String Query-String CorrelationKey: If specified, will only return entries with the specified CorrelationKey
    EntryType OrderEntryType Query-String EntryType: optional. Defaults to 'All': Return all entries pertaining to any order. 'Last': Only return the latest state of an order ignoring ToDateTime (if any).
    FieldGroups OrderActivityFieldGroup [] Query-String FieldGroups: DisplayAndFormat
    FromDateTime UtcDateTime Query-String Only include entries, with a ActivityDateTime greater than or equal to FromDateTime
    IncludeSubAccounts Boolean Query-String IncludeSubAccounts: If specified true will return entries for all clients under specified ClientId in a hierarchy.
    OrderId String Query-String OrderId: Will only return entries pertaining to specified OrderId
    Status OrderLogStatus [] Query-String Status: If specified will only return entries with the specified OrderStatus
    ToDateTime UtcDateTime Query-String Only include entries, with a ActivityDateTime less than or equal to ToDateTime. Cannot be used with EntryType="Last"

  • 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 OrderActivitiesResponse [] 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/audit/orderactivities?$skiptoken=B17D8890-3C7A-4A47-A9AA-01B022ED03A5&$top=1&AccountKey=uLDoIiVA30y8uj4kFKp7Og ==&ClientKey=2y0tX0m9ZH7MH8HK38qM9g==&CorrelationKey=bb6bfb96-606d-45d6-95f5-efa443192f5c&EntryType=All&FieldGroups=DisplayAndFormat&FromDateTime=2017-12-01&IncludeSubAccounts=False&OrderId=234728341&Status=Placed&ToDateTime=2017-12-31

  • Response Example

    Response body
    {
  "__next": "/openapi/....../?$top=1&$skiptoken=1",
  "Data": [
    {
      "AccountId": "120602INET",
      "ActivityTime": "2017-12-28T08:20:19Z",
      "Amount": 300,
      "AssetType": "CfdOnStock",
      "BuySell": "Buy",
      "ClientId": "3031269",
      "CorrelationKey": "bb6bfb96-606d-45d6-95f5-efa443192f5c",
      "DisplayAndFormat": {
        "BarrierFormat": "Normal",
        "Currency": "DKK",
        "Decimals": 3,
        "Description": "Genmab A/S",
        "Format": "Normal",
        "OrderDecimals": 2,
        "StrikeFormat": "Normal",
        "Symbol": "GEN:xcse"
      },
      "Duration": {
        "DurationType": "DayOrder"
      },
      "HandledBy": "3031269",
      "LogId": "260971",
      "OrderId": "234728341",
      "OrderRelation": "StandAlone",
      "OrderType": "Market",
      "Price": 1048.2,
      "RelatedOrders": [],
      "SleepingOrderCondition": {
        "BreakoutTriggerDownPrice": 150.1,
        "BreakoutTriggerUpPrice": 160.6,
        "BuySell": "Buy",
        "ConditionId": "114485191",
        "Duration": {
          "DurationType": "DayOrder"
        },
        "OrderType": "LimitTrigger",
        "Price": 16000.01,
        "Status": "Placed",
        "SubStatus": "Confirmed",
        "Symbol": "NAS100.I",
        "TrailingStopDistanceToMarket": 10.1,
        "TriggerPriceType": "Ask",
        "Uic": 1909050
      },
      "Status": "Placed",
      "SubStatus": "Requested",
      "Uic": 2090
    }
  ]
}