Documentation/Canton Network Docs/Ledger APIAsyncAPI/v2/commands/command-completionsView on Canton Network Docs ↗
Subscribe command completions
SUBSCRIBE
Subscribe to command completion events.
This streaming endpoint provides more flexibility in filtering than the predecessor /v2/commands/command-completionsCompletionStream.Protocol Details
ProtocolWebSocket
Channel/v2/commands/command-completions
Actionsubscribe
Operation IDonV2CommandsCommand-completions
Content typeapplication/json
PayloadoneOf
Inputs
Outputs
Either_JsCantonError_CompletionStreamResponse
DirectionServer -> Client
MessageEither_JsCantonError_CompletionStreamResponse
Variants
CompletionStreamResponse
object
completionResponseobjectJsCantonError
object
codestringrequiredcausestringrequiredcontextobjectrequirederrorCategorystringrequiredRelated Schemas
Either_JsCantonError_CompletionStreamResponse
Either_JsCantonError_CompletionStreamResponse
Variants
CompletionStreamResponse
object
completionResponseobjectVariants
completionResponse
oneOf
CompletionobjectVariants
Completion
object
CompletionobjectrequiredEmpty
object
EmptyobjectrequiredOffsetCheckpoint
object
OffsetCheckpointobjectrequiredJsCantonError
object
codestringrequiredcausestringrequiredcontextobjectrequirederrorCategorystringrequiredHistory
Added
3.5wscat
wscat
npx wscat -c <WEBSOCKET_URL>
messageapplication/json
message
{
"completionResponse": {
"Completion": {
"value": {
"commandId": "<string>",
"userId": "<string>",
"actAs": [
"<string>"
],
"offset": "<integer>",
"synchronizerTime": "<object>"
}
}
}
}