Documentation/Canton Network docs/Ledger API › AsyncAPI › v2/updates/flatsView on Canton Network docs ↗
Subscribe flats
SUBSCRIBE
Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead./v2/updates/flatsProtocol Details
ProtocolWebSocket
Channel/v2/updates/flats
Actionsubscribe
Operation IDonV2UpdatesFlats
Content typeapplication/json
PayloadoneOf
Inputs
Outputs
Either_JsCantonError_JsGetUpdatesResponse
DirectionServer -> Client
MessageEither_JsCantonError_JsGetUpdatesResponse
Variants
JsCantonError
object
codestringrequiredcausestringrequiredcontextobjectrequirederrorCategorystringrequiredRelated Schemas
Either_JsCantonError_JsGetUpdatesResponse
Either_JsCantonError_JsGetUpdatesResponse
Variants
JsCantonError
object
codestringrequiredcausestringrequiredcontextobjectrequirederrorCategorystringrequiredJsGetUpdatesResponse
object
updateobjectVariants
update
oneOf
OffsetCheckpointobjectVariants
OffsetCheckpoint
object
OffsetCheckpointobjectrequiredReassignment
object
ReassignmentobjectrequiredTopologyTransaction
object
TopologyTransactionobjectrequiredTransaction
object
TransactionobjectrequiredHistory
Updated
3.5subscribe description updated
wscat
wscat
npx wscat -c <WEBSOCKET_URL>
messageapplication/json
message
{
"code": "<string>",
"cause": "<string>",
"context": {},
"errorCategory": "<integer>"
}