Sign in

POST /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. Notice: This endpoint should be used for small results set. When number of results exceeded node configuration limit (http-list-max-elements-limit) there will be an error (413 Content Too Large) returned. Increasing this limit may lead to performance issues and high memory consumption. Consider using websockets (asyncapi) for better efficiency with larger results.
post/v2/updates

Query parameters

limitinteger

maximum number of elements to return, this param is ignored if is bigger than server setting

stream_idle_timeout_msinteger

timeout to complete and send result if no new elements are received (for open ended streams)

Request body

beginExclusiveinteger required

Exclusive lower bound offset of the requested ledger section (non-negative integer). The response will only contain transactions whose offset is strictly greater than this. If set to zero, the lower bound is set to the beginning of the ledger. If the participant has been pruned, this parameter must be greater or equal than the pruning offset. Required

endInclusiveinteger

Inclusive higher bound offset of the requested ledger section. If specified the response will only contain transactions whose offset is less than or equal to this. If not specified,

  • the descending_order must not be selected,
  • the stream will not terminate.

Optional

verboseboolean

Provided for backwards compatibility, it will be removed in the Canton version 3.5.0. If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels, record and variant type ids for record fields. Optional for backwards compatibility, if defined update_format must be unset

descendingOrderboolean

If set, the stream will populate the elements in descending order.

Optional

Response

Changes

No recorded changes to this endpoint across all 1 revision of this API.