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 Account group identifier
    AccountKey AccountKey Query-String Account identifier
    ClientKey ClientKey Query-String Client identifier
    EventId String Query-String Event id
    IncludeSubAccounts Boolean Query-String Indicate whether to include events from sub-clients.
    ManagementTypes ManagementType [] Query-String SaxoInternal - Management type filter for holdings.
    ModelIds String [] Query-String SaxoInternal - Model filter for holdings. Accepts comma separated model ids for filtering.
  • 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 Holding [] 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 /ca/v2/holdings?$skip=1&$top=1&AccountGroupKey=BxS0VWLta8lJ3SBpjGBQjw==&AccountKey=2y0tX0m9ZH7MH8HK38qM9g==&ClientKey=7m4I|vtYLUnEGg77o9uQhw==&EventId=987468&IncludeSubAccounts=False&ManagementTypes=Client,TradeAdvisory&ModelIds=1226
  • Response Example

    Response body
    {
      "__count": 1,
      "Data": [
        {
          "AccountId": "123INET",
          "Amount": 100,
          "CashReserved": {
            "Currency": "USD",
            "Value": 2583.62
          },
          "ClientId": "906869",
          "ClientName": "John",
          "ElectedAmount": 20,
          "EventId": "9652429",
          "Options": [
            {
              "ElectedAmount": 20,
              "ElectedBy": "John",
              "ElectionType": "Manual",
              "Instruction": {
                "Status": "Accepted"
              },
              "OptionId": "1",
              "Remarks": "Remarks by client..."
            }
          ],
          "OwnerId": "532"
        }
      ]
    }