Documentation/Canton Network Docs/Ledger APIAsyncAPI/v2/commands/command-completionsView on Canton Network Docs ↗

Publish command completions

/v2/commands/command-completions

PUBLISH/v2/commands/command-completions

Subscribe to command completion events. This streaming endpoint provides more flexibility in filtering than the predecessor CompletionStream.

Protocol Details

ProtocolWebSocket

Channel/v2/commands/command-completions

Actionpublish

Operation IDsendV2CommandsCommand-completions

Content typeapplication/json

Payloadobject

DirectionClient -> Server

MessageGetCompletionsRequest

partiesarray[string]

beginExclusivestring

GetCompletionsRequest

partiesarray[string]

beginExclusivestring

Added3.5

wscat

wscat
npx wscat \
  -c <WEBSOCKET_URL> \
  -x '{"parties": ["<string>"], "beginExclusive": "<integer>"}' \
  -w -1

messageapplication/json

message
{
  "parties": [
    "<string>"
  ],
  "beginExclusive": "<integer>"
}