OpenCapTable — namespace overview

Everything under ocp.OpenCapTable.* reads OCF data from Canton. Each reader takes a contract id and returns a typed ContractResult<T> — { data, contractId } — where data is the OCF payload carrying its own object_type discriminant.

import { OcpClient, toContractId } from '@open-captable-protocol/canton';

const { data } = await ocp.OpenCapTable.stockClass.get({
  contractId: toContractId('STOCK_CLASS_CONTRACT_ID'),
});
// data.object_type === 'STOCK_CLASS'

All readers accept an optional readAs array to widen ledger visibility, and surface OcpParseError / OcpContractError / OcpValidationError on malformed or missing contracts.

Objects

The company, its stakeholders, and the instruments and records they hold.

Reader	Returns
issuer.get	The company at the root of the cap table.
stakeholder.get	An individual or entity holding securities.
stockClass.get	A class of stock (common, preferred, etc.).
stockPlan.get	An equity incentive plan.
stockLegendTemplate.get	A stock legend template.
valuation.get	A company valuation record.
vestingTerms.get	Vesting schedule terms.
document.get	A document attached to the cap table.

Transactions

Every transaction follows the same get pattern and returns its OCF transaction object.

Stock

Convertibles

Equity compensation

Warrants

Vesting

Stakeholder & issuer events

OpenCapTable — namespace overview

Objects

Transactions

See also