CompletionStream
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.
CompletionStream
Ledger API
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="/docs/canton/reference-grpc-ledger-api-reference-details">gRPC API</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="/docs/canton/reference-grpc-ledger-api-reference-com-daml-ledger-api-v2">v2</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<span>CompletionStream</span>
</div>
<div class="x2mdx-ref-hero">
<p class="x2mdx-ref-eyebrow">com.daml.ledger.api.v2</p>
<h1 class="x2mdx-ref-title">CompletionStream</h1>
<div class="x2mdx-ref-badges">
<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
</div>
</div>
<div class="x2mdx-ref-operation-bar">
<span class="x2mdx-ref-operation-method x2mdx-ref-operation-method--rpc">RPC</span>
<code>/com.daml.ledger.api.v2.CommandCompletionService/CompletionStream</code>
</div>
## Protocol Details
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Protocol</dt>
<dd>gRPC</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Service</dt>
<dd>CommandCompletionService</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>RPC</dt>
<dd>CompletionStream</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Client stream</dt>
<dd>No</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Server stream</dt>
<dd>Yes</dd>
</div>
</dl>
## Inputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>CompletionStreamRequest</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>com.daml.ledger.api.v2.CompletionStreamRequest</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Client stream</dt>
<dd>No</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">user\_id</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">parties</code>
<span class="x2mdx-ref-type-badge">repeated string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">begin\_exclusive</code>
<span class="x2mdx-ref-type-badge">int64</span>
</div>
</div>
</div>
</div>
## Outputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>CompletionStreamResponse</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>com.daml.ledger.api.v2.CompletionStreamResponse</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Server stream</dt>
<dd>Yes</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">completion</code>
<span class="x2mdx-ref-type-badge">Completion</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">offset\_checkpoint</code>
<span class="x2mdx-ref-type-badge">OffsetCheckpoint</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.4.4</span>
<span class="x2mdx-ref-change-detail">introduced</span>
</div>
</div>
## Related Schemas
<AccordionGroup>
<Accordion title="com.daml.ledger.api.v2.CompletionStreamRequest">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-completionstreamrequest">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">user\_id</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">parties</code>
<span class="x2mdx-ref-type-badge">repeated string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">begin\_exclusive</code>
<span class="x2mdx-ref-type-badge">int64</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.CompletionStreamResponse">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-completionstreamresponse">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">completion</code>
<span class="x2mdx-ref-type-badge">Completion</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">offset\_checkpoint</code>
<span class="x2mdx-ref-type-badge">OffsetCheckpoint</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.Completion">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-completion">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">command\_id</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">status</code>
<span class="x2mdx-ref-type-badge">Status</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">update\_id</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">user\_id</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">act\_as</code>
<span class="x2mdx-ref-type-badge">repeated string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">submission\_id</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">deduplication\_offset</code>
<span class="x2mdx-ref-type-badge">int64</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">deduplication\_duration</code>
<span class="x2mdx-ref-type-badge">Duration</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">trace\_context</code>
<span class="x2mdx-ref-type-badge">TraceContext</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">offset</code>
<span class="x2mdx-ref-type-badge">int64</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">synchronizer\_time</code>
<span class="x2mdx-ref-type-badge">SynchronizerTime</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">paid\_traffic\_cost</code>
<span class="x2mdx-ref-type-badge">int64</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.TraceContext">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-tracecontext">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">traceparent</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">tracestate</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.SynchronizerTime">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-synchronizertime">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">synchronizer\_id</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">record\_time</code>
<span class="x2mdx-ref-type-badge">Timestamp</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.OffsetCheckpoint">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-offsetcheckpoint">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">offset</code>
<span class="x2mdx-ref-type-badge">int64</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">synchronizer\_times</code>
<span class="x2mdx-ref-type-badge">repeated SynchronizerTime</span>
</div>
</div>
</div>
</div>
</Accordion>
</AccordionGroup>
grpcurl
```bash grpcurl theme={"theme":{"light":"github-light","dark":"github-dark"}}
# Add -plaintext if the server is not using TLS.
# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed.
grpcurl \
-d @ \
<HOST:PORT> \
com.daml.ledger.api.v2.CommandCompletionService/CompletionStream <<'EOF'
{
"userId": "string",
"parties": [
"string"
],
"beginExclusive": "0"
}
EOF
```
</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">OK</span>
<span className="x2mdx-ref-response-label">application/json</span>
</div>
```json OK theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"completion": {
"commandId": "string",
"status": "string",
"updateId": "string",
"userId": "string",
"actAs": [
"string"
],
"submissionId": "string",
"deduplicationOffset": "0"
}
}
```
</div>
</div>Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.