Subscribe trees

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

/v2/updates/trees

Subscribe trees

WebSocketSince 3.4Changed 3.5

SUBSCRIBE/v2/updates/trees

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

Lifecycle Changes

3.5publish description updated; publish required fields added: beginExclusive; publish required fields removed: updateFormat; subscribe description updated

Related Schemas

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

wscat

wscat

npx wscat -c <WEBSOCKET_URL>

messageapplication/json

message

{
  "code": "<string>",
  "cause": "<string>",
  "context": {},
  "errorCategory": "<integer>"
}