Skip to main content

Back to overview

AsyncAPI Channel

/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 c…

WebSocketUpdated 3.5
Channel/v2/updates
Actionspublish, subscribe

Actions

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.
publish /v2/updates
WebSocketUpdated 3.5

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

Operation IDsendV2Updates
Method-
Payloadobject
subscribe /v2/updates
WebSocketUpdated 3.5

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

Operation IDonV2Updates
Method-
PayloadoneOf

History

Updated3.5

publish: channel description updated; publish description updated; publish required fields added: beginExclusive; publish required fields removed: updateFormat

subscribe: channel description updated; subscribe description updated