Balances

Raw and adjusted, always, with the multiplier that converts between them.

Every response shows its work

A balance response always carries four fields together: the raw ERC-20 amount, the underlying-share equivalent, the multiplier applied, and the block that multiplier became valid. A customer can always reconstruct the conversion.

FieldTypeDescription
balance_rawuint256Raw ERC-20 balance. Static across corporate actions.
balance_uidecimalbalance_raw × multiplier — the number to show a person.
multiplier_applieddecimalThe multiplier actually used.Never the current one when as_of is in the past.
multiplier_effective_blockuint64When that multiplier became valid.
as_of_blockuint64The block this valuation is stated at.
provenanceobjectSource, block, observation time, code version.

Correctness

Correctness note

Show balance_ui to people and use balance_raw for onchain arithmetic. A wallet displaying the raw amount after a split will generate support tickets, because the holder's position changed and the number did not.

Related