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 to get the events for. AccountKey AccountKey Query-String Account to get the events for. AssetTypes AssetType [] Query-String Asset type filter for events. ClientKey ClientKey Query-String Client to get the events for. CorporateActionTypes CorporateActionType [] Query-String Corporate action type filter for events. ElectionStatuses ElectionStatus [] Query-String Election status filter for events. EventStates EventState [] Query-String Filter collection based on event state. Note that some events are only returned if IncludeLapsedEvents is set to true. EventStatus EventStatus Query-String Event status filter. EventTypes String [] Query-String Event type filter. Use event type codes to filter. FromDeadlineDate Date Query-String Events on or after specified deadline date. FromExDate Date Query-String Events on or after specified ex date. FromPayDate Date Query-String Events on or after specified pay date. FromRecordDate Date Query-String Events on or after specified record date. IncludeLapsedEvents Boolean Query-String If true, the returned collection will include otherwise excluded events. These events have EventStatus of Past and an EventState of Preliminary, Cancelled, or Confirmed. These events are excluded by default due their low importance and excessive volumes. IncludeSubAccounts Boolean Query-String Indicate whether to include events from sub-clients. Keywords String Query-String Looks for keywords in instrument description, ISIN code, and instrument symbol. SortColumn SortColumn Query-String Specify a column to sort on. Default sort will be provided on Date. SortType SortType Query-String Specify ascending or descending sort. Default sort type will be Descending. ToDeadlineDate Date Query-String Events on or before specified deadline date. ToExDate Date Query-String Events on or before specified ex date. ToPayDate Date Query-String Events on or before specified pay date. ToRecordDate Date Query-String Events on or before specified record date. -
Response Parameters
View Response CodesName 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 Event [] 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/events?$skip=1&$top=1&AccountGroupKey=BxS0VWLta8lJ3SBpjGBQjw==&AccountKey=2y0tX0m9ZH7MH8HK38qM9g==&AssetTypes=Stock,Bond&ClientKey=7m4I|vtYLUnEGg77o9uQhw==&CorporateActionTypes=Mandatory,Voluntary&ElectionStatuses=Elected,PartialElected&EventStates=Preliminary,Confirmed,Approved&EventStatus=Active&EventTypes=DVCA,DVOP&FromDeadlineDate=2020-06-16&FromExDate=2020-06-16&FromPayDate=2020-06-16&FromRecordDate=2020-06-16&IncludeLapsedEvents=False&IncludeSubAccounts=False&Keywords=Appl&SortColumn=Date&SortType=Desc&ToDeadlineDate=2020-10-15&ToExDate=2020-10-15&ToPayDate=2020-10-15&ToRecordDate=2020-10-15 -
Response Example
Response body
{ "__count": 1, "Data": [ { "AnnouncedDate": "2026-11-06T00:00:00Z", "AssetType": "Stock", "CorporateActionType": "Mandatory", "DisplayAndFormat": { "Description": "NVIDIA Corp.", "IsinCode": "US67066G1040", "Symbol": "NVDA:xnas" }, "Effective": { "Date": "2026-11-09T00:00:00Z" }, "Electable": "Electable", "EventId": "9652431", "EventIndicators": [ { "Indicator": "AdditionalBusinessProcess", "Values": [ { "Code": "NPLE", "Description": "The issuer only allows a single option to be selected per designated holding.", "Name": "No Split Election" } ] }, { "Indicator": "Change", "Values": [ { "Code": "BERE", "Description": "Change from bearer into registered form.", "Name": "Bearer to Registered" } ] }, { "Indicator": "Consent", "Values": [ { "Code": "CTRM", "Description": "This is a change in the terms and conditions of the bond.", "Name": "Change in Terms" } ] }, { "Indicator": "Dividend", "Values": [ { "Code": "FINL", "Description": "Payment of a dividend, less the amounts already paid through interim dividends.", "Name": "Final" } ] } ], "EventState": "Approved", "EventStatus": "Active", "EventType": { "Code": "DVCA", "Description": "Distribution of cash to shareholders, in proportion to their equity holding. Ordinary dividends are recurring and regular. Shareholder must take cash and may be offered a choice of currency.", "Name": "Cash Dividend" }, "Ex": { "Date": "2026-11-09T00:00:00Z" }, "Holdings": [ { "AccountId": "79880/570923", "Amount": 100, "CashReserved": { "Currency": "USD", "Value": 3083.62 }, "ClientId": "21024173", "ClientName": "John", "EventId": "9652431", "OwnerId": "532" } ], "Narrative": "ADTXCash Dividend Announced.
", "Options": [ { "CashMovements": [ { "AdrFees": { "Currency": "EUR", "Type": "Actual", "Value": 5 }, "CashMovementType": "Credit", "Currency": "USD", "PriceType": "Actual" } ], "CashRequired": false, "IsDefault": true, "IsGross": true, "IsTaxable": true, "OptionId": "1", "OptionType": { "Code": "CASH", "Name": "Cash" }, "Payment": { "Date": "2027-01-15T00:00:00Z" }, "PayoutBreakdown": [ { "Amount": 5.9623, "Component": { "Code": "INTRT", "Description": "Interest", "Name": "Interest" }, "Currency": "USD" }, { "Amount": 6, "Component": { "Code": "LTCG", "Description": "Long term capital gain", "Name": "Long term capital gain" }, "Currency": "USD" } ] } ], "Record": { "Status": "Ongoing" }, "Uic": 1249, "UpdatedDateTime": "2026-11-06T11:07:26.221208Z" } ] }