Documentation/canton-network-docs/Ledger APIAsyncAPIView on canton-network-docs ↗
canton-network-docs/Ledger APIAsyncAPI

Details and history

asyncapi reference

​
JSON API AsyncAPI Reference

​
Details and history

JSON Ledger API WebSocket AsyncAPI reference and version history. Operation-first WebSocket reference pages built from AsyncAPI channel snapshots and lifecycle deltas.

AsyncAPIv3.5

​
Channels

Use the channel page to choose a specific publish or subscribe action. Action pages are the primary reference surface.

​
/v2/commands/completions

Subscribe to command completion events.

WebSocketSince 3.4Changed 3.5

​
/v2/state/active-contracts

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…

WebSocketSince 3.4Changed 3.5

​
/v2/updates

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…

WebSocketSince 3.4Changed 3.5

​
/v2/updates/flats

Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.

WebSocketSince 3.4Changed 3.5

​
/v2/updates/trees

Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.

WebSocketSince 3.4Changed 3.5