JSON API AsyncAPI
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="/docs/canton/reference-json-api-asyncapi-reference-operations-v2-state-active-contracts-details">/v2/state/active-contracts</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<span>subscribe</span>
</div>
<div class="x2mdx-ref-hero">
<p class="x2mdx-ref-eyebrow">/v2/state/active-contracts</p>
<h1 class="x2mdx-ref-title">Subscribe active contracts</h1>
<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>
</div>
<div class="x2mdx-ref-operation-bar">
<span class="x2mdx-ref-operation-method x2mdx-ref-operation-method--subscribe">SUBSCRIBE</span>
<code>/v2/state/active-contracts</code>
</div>
## Protocol Details
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Protocol</dt>
<dd>WebSocket</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Channel</dt>
<dd>/v2/state/active-contracts</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Action</dt>
<dd>subscribe</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Operation ID</dt>
<dd>onV2StateActive-contracts</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Content type</dt>
<dd>application/json</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Payload</dt>
<dd>oneOf</dd>
</div>
</dl>
## Inputs
## Outputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>Either\_JsCantonError\_JsGetActiveContractsResponse</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Direction</dt>
<dd>Server -> Client</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>Either\_JsCantonError\_JsGetActiveContractsResponse</dd>
</div>
</dl>
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">code</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">cause</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">context</code>
<span class="x2mdx-ref-type-badge">object</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">errorCategory</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
</div>
</div>
## Lifecycle Changes
<div class="x2mdx-ref-change-list">
<div class="x2mdx-ref-change-item">
<span class="x2mdx-ref-change-version">3.5</span>
<span class="x2mdx-ref-change-detail">channel description updated; publish description updated; publish required fields removed: `eventFormat`; subscribe description updated</span>
</div>
</div>
## Related Schemas
<AccordionGroup>
<Accordion title="Either_JsCantonError_JsGetActiveContractsResponse">
<div class="x2mdx-ref-schema" id="schema-v2-state-active-contracts-subscribe">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">code</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">cause</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">context</code>
<span class="x2mdx-ref-type-badge">object</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">errorCategory</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
</div>
</div>
</Accordion>
</AccordionGroup>
wscat
```bash wscat theme={"theme":{"light":"github-light","dark":"github-dark"}}
npx wscat -c <WEBSOCKET_URL>
```
</div>
</div>
<div className="x2mdx-ref-rail-panel">
<div className="x2mdx-ref-rail-code x2mdx-ref-rail-code--response">
<div className="x2mdx-ref-rail-head">
<span className="x2mdx-ref-rail-heading">message</span>
<span className="x2mdx-ref-response-label">application/json</span>
</div>
```json message theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"code": "<string>",
"cause": "<string>",
"context": {},
"errorCategory": "<integer>"
}
```
</div>
</div>
Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.
