Canton developer docs / Reference

Complete documentation page mirrored and translated for learning. Attribution is shown at the bottom of each article.

阅读中文版

referencejson-api-asyncapi-referenceoperationsdetails

Details and history

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt Use this file to discover all available pages before exploring further.

Details and history

asyncapi reference

  <h1 class="x2mdx-ref-title">JSON API AsyncAPI Reference</h1>
  <h2>Details and history</h2>
  <p>JSON Ledger API WebSocket AsyncAPI reference and version history. Operation-first WebSocket reference pages built from AsyncAPI channel snapshots and lifecycle deltas.</p>

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

    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">v3.5</span>
  </div>
</div>
Publish version
3.5
<div class="x2mdx-ref-meta-item">
  <dt>AsyncAPI version</dt>
  <dd>2.6.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Source</dt>
  <dd>Canton release bundle JSON Ledger API AsyncAPI fixtures</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Version filter</dt>
  <dd>configured docs major versions from Canton release bundles</dd>
</div>

Channels

Use the channel page to choose a specific publish or subscribe action. Action pages are the primary reference surface.

/v2/commands/completions

<p class="x2mdx-ref-card-summary">Subscribe to command completion events.</p>

<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">Since 3.4</span>

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

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

  <div class="x2mdx-ref-meta-item">
    <dt>Last seen</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/state/active-contracts

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

<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">Since 3.4</span>

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

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

  <div class="x2mdx-ref-meta-item">
    <dt>Last seen</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/updates

<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 selection c...</p>

<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">Since 3.4</span>

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

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

  <div class="x2mdx-ref-meta-item">
    <dt>Last seen</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/updates/flats

<p class="x2mdx-ref-card-summary">Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.</p>

<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">Since 3.4</span>

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

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

  <div class="x2mdx-ref-meta-item">
    <dt>Last seen</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/updates/trees

<p class="x2mdx-ref-card-summary">Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.</p>

<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">Since 3.4</span>

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

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

  <div class="x2mdx-ref-meta-item">
    <dt>Last seen</dt>
    <dd>3.5</dd>
  </div>
</dl>

Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.