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

Subscribe flats

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

/v2/updates/flats

​
Subscribe flats

WebSocketUpdated 3.5
/v2/updates/flats
Get flat transactions update 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_JsGetUpdatesResponse

Variants

​
JsCantonError

object

codestringrequired
causestringrequired
contextobjectrequired
errorCategorystringrequired

​
JsGetUpdatesResponse

object

updateobject
Variants

​
update

oneOf

OffsetCheckpointobject
Variants

​
OffsetCheckpoint

object

OffsetCheckpointobjectrequired

​
Reassignment

object

Reassignmentobjectrequired

​
TopologyTransaction

object

TopologyTransactionobjectrequired

​
Transaction

object

Transactionobjectrequired

Either_JsCantonError_JsGetUpdatesResponse

Variants

JsCantonError

object

codestringrequired
causestringrequired
contextobjectrequired
errorCategorystringrequired

JsGetUpdatesResponse

object

updateobject
Variants

update

oneOf

OffsetCheckpointobject
Variants

OffsetCheckpoint

object

OffsetCheckpointobjectrequired

Reassignment

object

Reassignmentobjectrequired

TopologyTransaction

object

TopologyTransactionobjectrequired

Transaction

object

Transactionobjectrequired

​
History

Updated3.5

subscribe description updated

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