Documentation Index
Fetch the complete documentation index at: https://cantonfoundation-api-reference-details-history.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Details and history
JSON API AsyncAPI Reference details and history
Generated-source metadata, version coverage, channel inventory, and per-version changes for this source stream.
AsyncAPI3.5
Generated from
Generated reference pages
Channel and action pages are generated from the publish-version AsyncAPI document, with history calculated across selected snapshots.
Version summary
Active since / addedChangedRemovedDeprecated
| VERSION | STATUS | SUMMARY |
|---|---|---|
3.4 | 0 surface changes | No surface changes detected in the selected inputs. |
3.5 | 5 changed | 5 changed. |
Current reference inventory
Published channels
These channels are present in the publish version and link to channel pages for publish and subscribe actions.| TYPE | STATUS | SUMMARY |
|---|---|---|
| /v2/commands/completions | Since 3.4Changed 3.5 | Subscribe to command completion events. |
| /v2/state/active-contracts | Since 3.4Changed 3.5 | Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream of GetActiveContractsResponses completes, the client… |
| /v2/updates | Since 3.4Changed 3.5 | Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection c… |
| /v2/updates/flats | Since 3.4Changed 3.5 | Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. |
| /v2/updates/trees | Since 3.4Changed 3.5 | Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. |
Change details
3.4Initial selected snapshot
5 channels were present when this source stream first appears in the selected inputs.
3.5Changed /v2/commands/completionschannel description updated; publish description updated; subscribe description updated
3.5Changed /v2/state/active-contractschannel description updated; publish description updated; publish required fields removed:
eventFormat; subscribe description updated3.5Changed /v2/updateschannel description updated; publish description updated; publish required fields added:
beginExclusive; publish required fields removed: updateFormat; subscribe description updated3.5Changed /v2/updates/flatspublish description updated; publish required fields added:
beginExclusive; publish required fields removed: updateFormat; subscribe description updated3.5Changed /v2/updates/treespublish description updated; publish required fields added:
beginExclusive; publish required fields removed: updateFormat; subscribe description updatedKnown limits
- Change detection is structural and compares selected generated inputs; it does not infer behavioral compatibility.
- Channel-level additions, removals, and changed message shapes are tracked when they are present in the selected snapshots.
- Lifecycle labels and replacement links are included only when the source document carries that metadata.