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

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

/v2/state/active-contracts

Subscribe active contracts

WebSocketAdded 3.4Updated 3.5

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

Inputs

Outputs

Either_JsCantonError_JsGetActiveContractsResponse

Variants

JsCantonError

object

codestringrequired

causestringrequired

contextobjectrequired

errorCategorystringrequired

JsGetActiveContractsResponse

object

workflowIdstring

contractEntryobject

streamContinuationTokenstring

Variants

contractEntry

oneOf

JsActiveContractobject

Variants

JsActiveContract

object

JsActiveContractobjectrequired

JsEmpty

object

JsEmptyobjectrequired

JsIncompleteAssigned

object

JsIncompleteAssignedobjectrequired

JsIncompleteUnassigned

object

JsIncompleteUnassignedobjectrequired

Related Schemas

Either_JsCantonError_JsGetActiveContractsResponse

Variants

JsCantonError

object

codestringrequired

causestringrequired

contextobjectrequired

errorCategorystringrequired

JsGetActiveContractsResponse

object

workflowIdstring

contractEntryobject

streamContinuationTokenstring

Variants

contractEntry

oneOf

JsActiveContractobject

Variants

JsActiveContract

object

JsActiveContractobjectrequired

JsEmpty

object

JsEmptyobjectrequired

JsIncompleteAssigned

object

JsIncompleteAssignedobjectrequired

JsIncompleteUnassigned

object

JsIncompleteUnassignedobjectrequired

History

Updated3.5

channel description updated; subscribe description updated

Added3.4

wscat

wscat

npx wscat -c <WEBSOCKET_URL>

messageapplication/json

message

{
  "code": "<string>",
  "cause": "<string>",
  "context": {},
  "errorCategory": "<integer>"
}