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>GetLedgerApiVersion</span>
</div>
<div class="x2mdx-ref-hero">
<p class="x2mdx-ref-eyebrow">com.daml.ledger.api.v2</p>
<h1 class="x2mdx-ref-title">GetLedgerApiVersion</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.VersionService/GetLedgerApiVersion</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>VersionService</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>RPC</dt>
<dd>GetLedgerApiVersion</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>No</dd>
</div>
</dl>
## Inputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>GetLedgerApiVersionRequest</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>com.daml.ledger.api.v2.GetLedgerApiVersionRequest</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Client stream</dt>
<dd>No</dd>
</div>
</dl>
</div>
## Outputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>GetLedgerApiVersionResponse</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>com.daml.ledger.api.v2.GetLedgerApiVersionResponse</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Server 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">version</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">features</code>
<span class="x2mdx-ref-type-badge">FeaturesDescriptor</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.GetLedgerApiVersionRequest">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-getledgerapiversionrequest" />
</Accordion>
<Accordion title="com.daml.ledger.api.v2.GetLedgerApiVersionResponse">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-getledgerapiversionresponse">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">version</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">features</code>
<span class="x2mdx-ref-type-badge">FeaturesDescriptor</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.FeaturesDescriptor">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-featuresdescriptor">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">experimental</code>
<span class="x2mdx-ref-type-badge">ExperimentalFeatures</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">user\_management</code>
<span class="x2mdx-ref-type-badge">UserManagementFeature</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">party\_management</code>
<span class="x2mdx-ref-type-badge">PartyManagementFeature</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">OffsetCheckpointFeature</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">package\_feature</code>
<span class="x2mdx-ref-type-badge">PackageFeature</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.ExperimentalFeatures">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-experimentalfeatures">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">static\_time</code>
<span class="x2mdx-ref-type-badge">ExperimentalStaticTime</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">command\_inspection\_service</code>
<span class="x2mdx-ref-type-badge">ExperimentalCommandInspectionService</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.ExperimentalStaticTime">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-experimentalstatictime">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">supported</code>
<span class="x2mdx-ref-type-badge">bool</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.ExperimentalCommandInspectionService">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-experimentalcommandinspectionservice">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">supported</code>
<span class="x2mdx-ref-type-badge">bool</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.UserManagementFeature">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-usermanagementfeature">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">supported</code>
<span class="x2mdx-ref-type-badge">bool</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">max\_rights\_per\_user</code>
<span class="x2mdx-ref-type-badge">int32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">max\_users\_page\_size</code>
<span class="x2mdx-ref-type-badge">int32</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.PartyManagementFeature">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-partymanagementfeature">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">max\_parties\_page\_size</code>
<span class="x2mdx-ref-type-badge">int32</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.OffsetCheckpointFeature">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-offsetcheckpointfeature">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">max\_offset\_checkpoint\_emission\_delay</code>
<span class="x2mdx-ref-type-badge">Duration</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.PackageFeature">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-packagefeature">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">max\_vetted\_packages\_page\_size</code>
<span class="x2mdx-ref-type-badge">int32</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.
grpcurl \
-d @ \
<HOST:PORT> \
com.daml.ledger.api.v2.VersionService/GetLedgerApiVersion <<'EOF'
{}
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"}}
{
"version": "string",
"features": {
"experimental": {
"staticTime": {
"supported": true
},
"commandInspectionService": {
"supported": true
}
},
"userManagement": {
"supported": true,
"maxRightsPerUser": 0,
"maxUsersPageSize": 0
},
"partyManagement": {
"maxPartiesPageSize": 0
},
"offsetCheckpoint": {
"maxOffsetCheckpointEmissionDelay": "string"
},
"packageFeature": {
"maxVettedPackagesPageSize": 0
}
}
}
```
</div>
</div>
Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.
