> ## Documentation Index
> Fetch the complete documentation index at: https://cantonfoundation-generated-reference-full-stack-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# /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.

<div class="x2mdx-ref-page x2mdx-ref-page--collection" />

<p class="x2mdx-ref-back"><a href="../index">Back to overview</a></p>

<div class="x2mdx-ref-hero">
  <p class="x2mdx-ref-eyebrow">AsyncAPI Channel</p>

  <h1 class="x2mdx-ref-title">/v2/updates</h1>

  <p class="x2mdx-ref-summary">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 c...</p>

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">WebSocket</span>

    <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-3-4">Added 3.4</a>

    <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-3-5">Updated 3.5</a>
  </div>

  <dl class="x2mdx-ref-meta-grid">
    <div class="x2mdx-ref-meta-item">
      <dt>Channel</dt>
      <dd>/v2/updates</dd>
    </div>

    <div class="x2mdx-ref-meta-item">
      <dt>Actions</dt>
      <dd>publish, subscribe</dd>
    </div>
  </dl>
</div>

## Actions

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.

<div class="x2mdx-ref-card-grid">
  <div class="x2mdx-ref-card">
    <div class="x2mdx-ref-card-head">
      <a class="x2mdx-ref-card-title" href="../operations/v2-updates/publish">publish /v2/updates</a>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">WebSocket</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Added 3.4</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">Updated 3.5</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">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 s...</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Operation ID</dt>
        <dd>sendV2Updates</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Method</dt>
        <dd>-</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Payload</dt>
        <dd>object</dd>
      </div>
    </dl>
  </div>

  <div class="x2mdx-ref-card">
    <div class="x2mdx-ref-card-head">
      <a class="x2mdx-ref-card-title" href="../operations/v2-updates/subscribe">subscribe /v2/updates</a>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">WebSocket</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Added 3.4</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">Updated 3.5</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">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 s...</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Operation ID</dt>
        <dd>onV2Updates</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Method</dt>
        <dd>-</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Payload</dt>
        <dd>oneOf</dd>
      </div>
    </dl>
  </div>
</div>

## History

<div class="x2mdx-ref-history" aria-label="Reference history">
  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--changed" id="history-updated-3-5">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Updated</span>
      <code class="x2mdx-ref-history-event-version">3.5</code>
    </div>

    <p class="x2mdx-ref-history-event-detail">publish: channel description updated; publish description updated; publish required fields added: `beginExclusive`; publish required fields removed: `updateFormat`</p>

    <p class="x2mdx-ref-history-event-detail">subscribe: channel description updated; subscribe description updated</p>
  </div>

  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--introduced" id="history-added-3-4">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Added</span>
      <code class="x2mdx-ref-history-event-version">3.4</code>
    </div>
  </div>
</div>