Skip to main content

/v2/updates

Subscribe updates

/v2/updates
Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection criteria for individual events depends on the transaction shape chosen.
  • ACS delta: a requesting party must be a stakeholder of an event for it to be included.
  • ledger effects: a requesting party must be a witness of an event for it to be included.

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

channel description updated; subscribe description updated

Added3.4