Publish 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›publish

/v2/state/active-contracts

Publish active contracts

WebSocketAdded 3.4Updated 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

Inputs

GetActiveContractsRequest

activeAtOffsetstringrequired

Outputs

Related Schemas

GetActiveContractsRequest

activeAtOffsetstringrequired

History

Updated3.5

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

Added3.4

wscat

wscat

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

messageapplication/json

message

{
  "activeAtOffset": "<integer>"
}