API reference

Corporate actions

The corporate-action types Corpact books, the evidence each one needs, and how it reaches the ledger.

Every multiplier change is classified from issuer evidence only: never from the size of the change or its label. These are the types Corpact books, each validated against real recorded data.

ActionTypeLedger treatment
Cash dividendcash_dividendIncome
Withholding refundwithholding_adjustmentIncome
Stock dividendstock_dividendQuantity and basis adjustment
Forward splitforward_splitQuantity and basis adjustment
Reverse splitreverse_splitQuantity and basis adjustment
Spin-offspin_offBasis allocation
Rights distributionrights_distributionBasis allocation
Identity changeidentity_changeIdentity change

Other types the issuer can publish, such as mergers and redemptions, are recognised and shown with their reason, and are never booked automatically. No number reaches your ledger from an action type Corpact has not proven on real data.

Lifecycle

Each action moves through announced → confirmed → activated, and may end corrected, reversed or superseded. The history is append-only. Every issuer revision before activation is kept as its own step, naming the revision it supersedes, so a type that churned before delivery (SCCOx) keeps all of it.