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

JSON API AsyncAPI›/v2/updates›publish

/v2/updates

Publish updates

WebSocketPresent since at least 3.4Updated 3.5

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

GetUpdatesRequest

beginExclusivestringrequired

Outputs

Related Schemas

GetUpdatesRequest

beginExclusivestringrequired

History

Updated3.5

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

Present since at least3.4

wscat

wscat

npx wscat \
  -c <WEBSOCKET_URL> \
  -x '{"beginExclusive": "<integer>"}' \
  -w -1

messageapplication/json

message

{
  "beginExclusive": "<integer>"
}