CCPEDIAby Unity Nodes
Documentation/Canton Network Docs/Ledger API › AsyncAPI › v2/state/active-contractsView on Canton Network Docs ↗

Publish active contracts

JSON API AsyncAPI›/v2/state/active-contracts›publish

/v2/state/active-contracts

​
Publish active contracts

WebSocketUpdated 3.5
PUBLISH/v2/state/active-contracts
Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream of GetActiveContractsResponses completes, the client SHOULD begin streaming updates from the update service, starting at the GetActiveContractsRequest.active_at_offset specified in this request. Clients SHOULD NOT assume that the set of active contracts they receive reflects the state at the ledger end.

​
Protocol Details

ProtocolWebSocket
Channel/v2/state/active-contracts
Actionpublish
Operation IDsendV2StateActive-contracts
Content typeapplication/json
Payloadobject

​
Inputs

​
GetActiveContractsRequest

DirectionClient -> Server
MessageGetActiveContractsRequest
activeAtOffsetstringrequired

​
Outputs

GetActiveContractsRequest

activeAtOffsetstringrequired

​
History

Updated3.5

channel description updated; publish description updated; publish required fields removed: eventFormat

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