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

/v2/state/active-contracts

Back to overview

AsyncAPI Channel

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

WebSocketUpdated 3.5
Channel/v2/state/active-contracts
Actionspublish, subscribe

​
Actions

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.
publish /v2/state/active-contracts
WebSocketUpdated 3.5

Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream of GetActiveContractsResponses completes, t…

Operation IDsendV2StateActive-contracts
Method-
Payloadobject
subscribe /v2/state/active-contracts
WebSocketUpdated 3.5

Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream of GetActiveContractsResponses completes, t…

Operation IDonV2StateActive-contracts
Method-
PayloadoneOf

​
History

Updated3.5

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

subscribe: channel description updated; subscribe description updated