CCPEDIAby Unity Nodes
Documentation/Canton Network Docs/Ledger APIAsyncAPI/v2/updates/treesView on Canton Network Docs ↗

Subscribe trees

JSON API AsyncAPI›/v2/updates/trees›subscribe

/v2/updates/trees

​
Subscribe trees

WebSocketUpdated 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.

​
Protocol Details

​
Inputs

​
Outputs

​
Either_JsCantonError_JsGetUpdateTreesResponse

Variants

​
JsCantonError

object

codestringrequired
causestringrequired
contextobjectrequired
errorCategorystringrequired

​
JsGetUpdateTreesResponse

object

updateobject
Variants

​
update

oneOf

OffsetCheckpointobject
Variants

​
OffsetCheckpoint

object

OffsetCheckpointobjectrequired

​
Reassignment

object

Reassignmentobjectrequired

​
TransactionTree

object

TransactionTreeobjectrequired

Either_JsCantonError_JsGetUpdateTreesResponse

Variants

JsCantonError

object

codestringrequired
causestringrequired
contextobjectrequired
errorCategorystringrequired

JsGetUpdateTreesResponse

object

updateobject
Variants

update

oneOf

OffsetCheckpointobject
Variants

OffsetCheckpoint

object

OffsetCheckpointobjectrequired

Reassignment

object

Reassignmentobjectrequired

TransactionTree

object

TransactionTreeobjectrequired

​
History

Updated3.5

subscribe description updated

wscat
wscat
npx wscat -c <WEBSOCKET_URL>
messageapplication/json
message
{
  "code": "<string>",
  "cause": "<string>",
  "context": {},
  "errorCategory": "<integer>"
}