Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt

Use this file to discover all available pages before exploring further.

Back to overview

AsyncAPI Channel

/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

Actions

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 criteria for individual events depends on the transaction shape chosen.
  • ACS delta: a requesting party must be a stakeholder of an event for it to be included.
  • ledger effects: a requesting party must be a witness of an event for it to be included.

publish /v2/updates

Publish GetUpdatesRequest messages from the client to /v2/updates.

WebSocketSince 3.4Changed 3.5

subscribe /v2/updates

Receive Either_JsCantonError_JsGetUpdatesResponse messages from /v2/updates on the subscription stream.

WebSocketSince 3.4Changed 3.5