Documentation/Canton Network docs/Ledger API › AsyncAPI › v2/commands/completionsView on Canton Network docs ↗
Subscribe completions
SUBSCRIBE
Deprecated: please use /v2/commands/completionsGetCompletions instead.
Subscribe to command completion events.Protocol Details
ProtocolWebSocket
Channel/v2/commands/completions
Actionsubscribe
Operation IDonV2CommandsCompletions
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
Updated
3.5channel description updated; subscribe description updated
wscat
wscat
npx wscat -c <WEBSOCKET_URL>
messageapplication/json
message
{
"completionResponse": {
"Completion": {
"value": {
"commandId": "<string>",
"userId": "<string>",
"actAs": [
"<string>"
],
"offset": "<integer>",
"synchronizerTime": "<object>"
}
}
}
}