CCPEDIAby Unity Nodes
Documentation/Canton Network docs/Ledger API › AsyncAPI › v2/updatesView on Canton Network docs ↗

Publish updates

JSON API AsyncAPI›/v2/updates›publish

/v2/updates

​
Publish updates

WebSocketUpdated 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

ProtocolWebSocket
Channel/v2/updates
Actionpublish
Operation IDsendV2Updates
Content typeapplication/json
Payloadobject

​
Inputs

​
GetUpdatesRequest

DirectionClient -> Server
MessageGetUpdatesRequest
beginExclusivestringrequired

​
Outputs

GetUpdatesRequest

beginExclusivestringrequired

​
History

Updated3.5

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

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