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

# POST /v2/updates/transaction-by-offset

> Get transaction by offset. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-offset instead.

<div class="x2mdx-ref-page x2mdx-ref-page--operation x2mdx-ref-page--manual-api" />

<div class="x2mdx-ref-hero">
  <p class="x2mdx-ref-summary">Get transaction by offset. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-offset instead.</p>

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

    <a class="x2mdx-ref-badge x2mdx-ref-badge--removed" href="#history-removal-scheduled-3-5-0">Removal scheduled 3.5.0</a>

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

    <a class="x2mdx-ref-badge x2mdx-ref-badge--removed" href="#history-deprecated-3-4">Deprecated 3.4</a>

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

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url 'http://localhost:7575/v2/updates/transaction-by-offset' \
    --header 'Authorization: Bearer $TOKEN' \
    --header 'Content-Type: application/json' \
    --data '{
    "offset": 123,
    "requestingParties": [
      "<string>"
    ],
    "transactionFormat": {
      "eventFormat": {
        "filtersByParty": {},
        "filtersForAnyParty": {
          "cumulative": [
            {
              "identifierFilter": "<object>"
            }
          ]
        },
        "verbose": false
      },
      "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
    }
  }'
  ```

  ```python Python theme={null}
  import json
  import requests

  url = "http://localhost:7575/v2/updates/transaction-by-offset"
  headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
  payload = json.loads(r'''{
    "offset": 123,
    "requestingParties": [
      "<string>"
    ],
    "transactionFormat": {
      "eventFormat": {
        "filtersByParty": {},
        "filtersForAnyParty": {
          "cumulative": [
            {
              "identifierFilter": "<object>"
            }
          ]
        },
        "verbose": false
      },
      "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
    }
  }''')
  response = requests.request(
      "POST", url, headers=headers, json=payload
  )

  print(response.text)
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('http://localhost:7575/v2/updates/transaction-by-offset', {
    method: 'POST',
    headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
    body: JSON.stringify({
    "offset": 123,
    "requestingParties": [
      "<string>"
    ],
    "transactionFormat": {
      "eventFormat": {
        "filtersByParty": {},
        "filtersForAnyParty": {
          "cumulative": [
            {
              "identifierFilter": "<object>"
            }
          ]
        },
        "verbose": false
      },
      "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
    }
  }),
  });

  console.log(await response.text());
  ```

  ```php PHP theme={null}
  <?php
  $curl = curl_init();

  curl_setopt_array($curl, [
      CURLOPT_URL => 'http://localhost:7575/v2/updates/transaction-by-offset',
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_CUSTOMREQUEST => 'POST',
      CURLOPT_POSTFIELDS => <<<'JSON'
  {
    "offset": 123,
    "requestingParties": [
      "<string>"
    ],
    "transactionFormat": {
      "eventFormat": {
        "filtersByParty": {},
        "filtersForAnyParty": {
          "cumulative": [
            {
              "identifierFilter": "<object>"
            }
          ]
        },
        "verbose": false
      },
      "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
    }
  }
  JSON,
      CURLOPT_HTTPHEADER => [
          "Authorization: Bearer <token>",
          "Content-Type: application/json"
      ],
  ]);

  $response = curl_exec($curl);
  echo $response;
  ```

  ```go Go theme={null}
  package main

  import (
    "bytes"
    "fmt"
    "io"
    "net/http"
  )

  func main() {
    req, _ := http.NewRequest("POST", "http://localhost:7575/v2/updates/transaction-by-offset", bytes.NewBufferString(`{
    "offset": 123,
    "requestingParties": [
      "<string>"
    ],
    "transactionFormat": {
      "eventFormat": {
        "filtersByParty": {},
        "filtersForAnyParty": {
          "cumulative": [
            {
              "identifierFilter": "<object>"
            }
          ]
        },
        "verbose": false
      },
      "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
    }
  }`))
    req.Header.Set("Authorization", "Bearer <token>")
    req.Header.Set("Content-Type", "application/json")
    response, _ := http.DefaultClient.Do(req)
    defer response.Body.Close()
    body, _ := io.ReadAll(response.Body)
    fmt.Println(string(body))
  }
  ```

  ```java Java theme={null}
  import java.net.URI;
  import java.net.http.HttpClient;
  import java.net.http.HttpRequest;
  import java.net.http.HttpResponse;

  var request = HttpRequest.newBuilder()
      .uri(URI.create("http://localhost:7575/v2/updates/transaction-by-offset"))
      .header("Authorization", "Bearer <token>")
      .header("Content-Type", "application/json")
      .method("POST", HttpRequest.BodyPublishers.ofString("""
  {
    "offset": 123,
    "requestingParties": [
      "<string>"
    ],
    "transactionFormat": {
      "eventFormat": {
        "filtersByParty": {},
        "filtersForAnyParty": {
          "cumulative": [
            {
              "identifierFilter": "<object>"
            }
          ]
        },
        "verbose": false
      },
      "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
    }
  }
  """))
      .build();
  var response = HttpClient.newHttpClient().send(
      request, HttpResponse.BodyHandlers.ofString());
  System.out.println(response.body());
  ```

  ```ruby Ruby theme={null}
  require 'net/http'
  require 'uri'

  uri = URI('http://localhost:7575/v2/updates/transaction-by-offset')
  request = Net::HTTP::Post.new(uri)
  request['Authorization'] = 'Bearer <token>'
  request['Content-Type'] = 'application/json'
  request.body = <<~JSON
  {
    "offset": 123,
    "requestingParties": [
      "<string>"
    ],
    "transactionFormat": {
      "eventFormat": {
        "filtersByParty": {},
        "filtersForAnyParty": {
          "cumulative": [
            {
              "identifierFilter": "<object>"
            }
          ]
        },
        "verbose": false
      },
      "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
    }
  }
  JSON
  response = Net::HTTP.start(uri.hostname, uri.port) do |http|
    http.request(request)
  end
  puts response.body
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "transaction": {
      "updateId": "<string>",
      "commandId": "<string>",
      "workflowId": "<string>",
      "effectiveAt": "<string>",
      "events": [
        {
          "ArchivedEvent": {
            "offset": 123,
            "nodeId": 123,
            "contractId": "<string>",
            "templateId": "<string>",
            "witnessParties": [
              "<string>"
            ],
            "packageName": "<string>",
            "implementedInterfaces": [
              "<string>"
            ]
          }
        }
      ],
      "offset": 123,
      "synchronizerId": "<string>",
      "traceContext": {
        "traceparent": "<string>",
        "tracestate": "<string>"
      },
      "recordTime": "<string>",
      "externalTransactionHash": "<string>",
      "paidTrafficCost": 123
    }
  }
  ```

  ```text 400 theme={null}
  <string>
  ```

  ```json default theme={null}
  {
    "code": "<string>",
    "cause": "<string>",
    "correlationId": "<string>",
    "traceId": "<string>",
    "context": {},
    "resources": [
      [
        "<string>"
      ]
    ],
    "errorCategory": 123,
    "grpcCodeValue": 123,
    "retryInfo": "<string>",
    "definiteAnswer": false
  }
  ```
</ResponseExample>

## Authorizations

### httpAuth

<ParamField header="Authorization" type="string" required>
  HTTP bearer authentication. Send the token as `Authorization: Bearer &lt;token&gt;`. Ledger API standard JWT token
</ParamField>

### apiKeyAuth

<ParamField header="Sec-WebSocket-Protocol" type="string" required>
  API key authentication in the header. Ledger API standard JWT token (websocket)
</ParamField>

## Body

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">application/json</span>
</div>

<ParamField body="offset" type="number" required>
  OpenAPI type: <code>integer (int64)</code>.

  The offset of the transaction being looked up. Must be a valid absolute offset (positive integer). Required
</ParamField>

<ParamField body="requestingParties" type="string[]">
  Provided for backwards compatibility, it will be removed in the Canton version 3.5.0. The parties whose events the client expects to see. Events that are not visible for the parties in this collection will not be present in the response. Each element must be a valid PartyIdString (as described in `value.proto`). Optional for backwards compatibility for GetTransactionByOffset request: if defined transaction\_format must be unset (falling back to defaults).
</ParamField>

<ParamField body="transactionFormat" type="object">
  OpenAPI type: <code>TransactionFormat</code>.

  A format that specifies what events to include in Daml transactions and what data to compute and include for them.

  <Expandable title="child attributes">
    <ParamField body="eventFormat" type="object" required>
      OpenAPI type: <code>EventFormat</code>.

      A format for events which defines both which events should be included and what data should be computed and included for them. Note that some of the filtering behavior depends on the `TransactionShape`, which is expected to be specified alongside usages of `EventFormat`.

      <Expandable title="child attributes">
        <ParamField body="filtersByParty" type="object">
          OpenAPI type: <code>Map\_Filters</code>.

          Each key must be a valid PartyIdString (as described in `value.proto`). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional: can be empty
        </ParamField>

        <ParamField body="filtersForAnyParty" type="object">
          OpenAPI type: <code>Filters</code>.

          The union of a set of template filters, interface filters, or a wildcard.

          <Expandable title="child attributes">
            <ParamField body="cumulative" type="object[]">
              OpenAPI type: <code>CumulativeFilter\[]</code>.

              Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include\_interface\_view and include\_created\_event\_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. If no `CumulativeFilter` defined, the default of a single `WildcardFilter` with include\_created\_event\_blob unset is used. Optional: can be empty

              <Expandable title="child attributes">
                <ParamField body="identifierFilter" type="object">
                  OpenAPI type: <code>IdentifierFilter</code>.

                  Required

                  <Expandable title="child attributes">
                    <ParamField body="Variant 1" type="object">
                      <Expandable title="child attributes">
                        <ParamField body="Empty" type="object" required>
                          OpenAPI type: <code>Empty1</code>.
                        </ParamField>
                      </Expandable>
                    </ParamField>

                    <ParamField body="Variant 2" type="object">
                      <Expandable title="child attributes">
                        <ParamField body="InterfaceFilter" type="object" required>
                          OpenAPI type: <code>InterfaceFilter</code>.

                          This filter matches contracts that implement a specific interface.

                          <Expandable title="child attributes">
                            <ParamField body="value" type="object" required>
                              OpenAPI type: <code>InterfaceFilter1</code>.

                              This filter matches contracts that implement a specific interface.

                              <Expandable title="child attributes">
                                <ParamField body="interfaceId" type="string" required>
                                  The interface that a matching contract must implement. The `interface_id` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
                                </ParamField>

                                <ParamField body="includeInterfaceView" type="boolean">
                                  Whether to include the interface view on the contract in the returned `CreatedEvent`. Use this to access contract data in a uniform manner in your API client. Optional
                                </ParamField>

                                <ParamField body="includeCreatedEventBlob" type="boolean">
                                  Whether to include a `created_event_blob` in the returned `CreatedEvent`. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
                                </ParamField>
                              </Expandable>
                            </ParamField>
                          </Expandable>
                        </ParamField>
                      </Expandable>
                    </ParamField>

                    <ParamField body="Variant 3" type="object">
                      <Expandable title="child attributes">
                        <ParamField body="TemplateFilter" type="object" required>
                          OpenAPI type: <code>TemplateFilter</code>.

                          This filter matches contracts of a specific template.

                          <Expandable title="child attributes">
                            <ParamField body="value" type="object" required>
                              OpenAPI type: <code>TemplateFilter1</code>.

                              This filter matches contracts of a specific template.

                              <Expandable title="child attributes">
                                <ParamField body="templateId" type="string" required>
                                  A template for which the payload should be included in the response. The `template_id` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
                                </ParamField>

                                <ParamField body="includeCreatedEventBlob" type="boolean">
                                  Whether to include a `created_event_blob` in the returned `CreatedEvent`. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
                                </ParamField>
                              </Expandable>
                            </ParamField>
                          </Expandable>
                        </ParamField>
                      </Expandable>
                    </ParamField>

                    <ParamField body="Variant 4" type="object">
                      <Expandable title="child attributes">
                        <ParamField body="WildcardFilter" type="object" required>
                          OpenAPI type: <code>WildcardFilter</code>.

                          This filter matches all templates.

                          <Expandable title="child attributes">
                            <ParamField body="value" type="object" required>
                              OpenAPI type: <code>WildcardFilter1</code>.

                              This filter matches all templates.

                              <Expandable title="child attributes">
                                <ParamField body="includeCreatedEventBlob" type="boolean">
                                  Whether to include a `created_event_blob` in the returned `CreatedEvent`. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
                                </ParamField>
                              </Expandable>
                            </ParamField>
                          </Expandable>
                        </ParamField>
                      </Expandable>
                    </ParamField>
                  </Expandable>
                </ParamField>
              </Expandable>
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField body="verbose" type="boolean">
          If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="transactionShape" type="string" required>
      What transaction shape to use for interpreting the filters of the event format. Required

      Allowed values: <code>TRANSACTION\_SHAPE\_UNSPECIFIED</code>, <code>TRANSACTION\_SHAPE\_ACS\_DELTA</code>, <code>TRANSACTION\_SHAPE\_LEDGER\_EFFECTS</code>.
    </ParamField>
  </Expandable>
</ParamField>

## Responses

### 200

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">application/json</span>
</div>

<ResponseField name="transaction" type="JsTransaction" required>
  Filtered view of an on-ledger transaction's create and archive events.

  <Expandable title="child attributes">
    <ResponseField name="updateId" type="string" required>
      Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in `value.proto`). Required
    </ResponseField>

    <ResponseField name="commandId" type="string">
      The ID of the command which resulted in this transaction. Missing for everyone except the submitting party. Must be a valid LedgerString (as described in `value.proto`). Optional
    </ResponseField>

    <ResponseField name="workflowId" type="string">
      The workflow ID used in command submission. Must be a valid LedgerString (as described in `value.proto`). Optional
    </ResponseField>

    <ResponseField name="effectiveAt" type="string" required>
      Ledger effective time. Required
    </ResponseField>

    <ResponseField name="events" type="Event[]" required>
      The collection of events. Contains: - `CreatedEvent` or `ArchivedEvent` in case of ACS\_DELTA transaction shape - `CreatedEvent` or `ExercisedEvent` in case of LEDGER\_EFFECTS transaction shape Required: must be non-empty

      <Expandable title="child attributes">
        <ResponseField name="Variant 1" type="object">
          <Expandable title="child attributes">
            <ResponseField name="ArchivedEvent" type="ArchivedEvent" required>
              Records that a contract has been archived, and choices may no longer be exercised on it.

              <Expandable title="child attributes">
                <ResponseField name="offset" type="integer (int64)" required>
                  The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required
                </ResponseField>

                <ResponseField name="nodeId" type="integer (int32)" required>
                  The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required
                </ResponseField>

                <ResponseField name="contractId" type="string" required>
                  The ID of the archived contract. Must be a valid LedgerString (as described in `value.proto`). Required
                </ResponseField>

                <ResponseField name="templateId" type="string" required>
                  Identifies the template that defines the choice that archived the contract. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
                </ResponseField>

                <ResponseField name="witnessParties" type="string[]" required>
                  The parties that are notified of this event. For an `ArchivedEvent`, these are the intersection of the stakeholders of the contract in question and the parties specified in the `TransactionFilter`. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in `value.proto`). Required: must be non-empty
                </ResponseField>

                <ResponseField name="packageName" type="string" required>
                  The package name of the contract. Required
                </ResponseField>

                <ResponseField name="implementedInterfaces" type="string[]">
                  The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include\_interface\_view set. If defined, the identifier uses the package-id reference format. Optional: can be empty
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="Variant 2" type="object">
          <Expandable title="child attributes">
            <ResponseField name="CreatedEvent" type="CreatedEvent" required>
              Records that a contract has been created, and choices may now be exercised on it.

              <Expandable title="child attributes">
                <ResponseField name="offset" type="integer (int64)" required>
                  The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required
                </ResponseField>

                <ResponseField name="nodeId" type="integer (int32)" required>
                  The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required
                </ResponseField>

                <ResponseField name="contractId" type="string" required>
                  The ID of the created contract. Must be a valid LedgerString (as described in `value.proto`). Required
                </ResponseField>

                <ResponseField name="templateId" type="string" required>
                  The template of the created contract. The identifier uses the package-id reference format. Required
                </ResponseField>

                <ResponseField name="contractKey" type="object">
                  The key of the created contract. This will be set if and only if `template_id` defines a contract key. Optional
                </ResponseField>

                <ResponseField name="contractKeyHash" type="string">
                  The hash of contract\_key. This will be set if and only if `template_id` defines a contract key. Optional: can be empty
                </ResponseField>

                <ResponseField name="createArgument" type="object" required>
                  The arguments that have been used to create the contract. Required
                </ResponseField>

                <ResponseField name="createdEventBlob" type="string">
                  Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional: can be empty
                </ResponseField>

                <ResponseField name="interfaceViews" type="JsInterfaceView[]">
                  Interface views specified in the transaction filter. Includes an `InterfaceView` for each interface for which there is a `InterfaceFilter` with - its party in the `witness_parties` of this event, - and which is implemented by the template of this event, - and which has `include_interface_view` set. Optional: can be empty

                  <Expandable title="child attributes">
                    <ResponseField name="interfaceId" type="string" required>
                      The interface implemented by the matched event. The identifier uses the package-id reference format. Required
                    </ResponseField>

                    <ResponseField name="viewStatus" type="JsStatus" required>
                      Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required

                      <Expandable title="child attributes">
                        <ResponseField name="code" type="integer (int32)" required />

                        <ResponseField name="message" type="string" required />

                        <ResponseField name="details" type="ProtoAny[]">
                          <Expandable title="child attributes">
                            <ResponseField name="typeUrl" type="string" required />

                            <ResponseField name="value" type="string" required />

                            <ResponseField name="unknownFields" type="UnknownFieldSet" required>
                              <Expandable title="child attributes">
                                <ResponseField name="fields" type="Map_Int_Field" required />
                              </Expandable>
                            </ResponseField>

                            <ResponseField name="valueDecoded" type="string" />
                          </Expandable>
                        </ResponseField>
                      </Expandable>
                    </ResponseField>

                    <ResponseField name="viewValue" type="object">
                      The value of the interface's view method on this event. Set if it was requested in the `InterfaceFilter` and it could be successfully computed. Optional
                    </ResponseField>

                    <ResponseField name="implementationPackageId" type="string">
                      The package defining the interface implementation used to compute the view. Can be different from the package that was used to create the contract itself, as the contract arguments can be upgraded or downgraded using smart-contract upgrading as part of computing the interface view. Populated if the view computation is successful, otherwise empty. Optional
                    </ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="witnessParties" type="string[]" required>
                  The parties that are notified of this event. When a `CreatedEvent` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the `TransactionFilter` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the `TransactionFilter` that are stakeholders of the contract (i.e. either signatories or observers). If the `CreatedEvent` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the `TransactionFilter` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the `TopologyEvent`s for that party by setting a corresponding `UpdateFormat`. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required: must be non-empty
                </ResponseField>

                <ResponseField name="signatories" type="string[]" required>
                  The signatories for this contract as specified by the template. Required: must be non-empty
                </ResponseField>

                <ResponseField name="observers" type="string[]">
                  The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Optional: can be empty
                </ResponseField>

                <ResponseField name="createdAt" type="string" required>
                  Ledger effective time of the transaction that created the contract. Required
                </ResponseField>

                <ResponseField name="packageName" type="string" required>
                  The package name of the created contract. Required
                </ResponseField>

                <ResponseField name="representativePackageId" type="string" required>
                  A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
                </ResponseField>

                <ResponseField name="acsDelta" type="boolean" required>
                  Whether this event would be part of respective ACS\_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="Variant 3" type="object">
          <Expandable title="child attributes">
            <ResponseField name="ExercisedEvent" type="ExercisedEvent" required>
              Records that a choice has been exercised on a target contract.

              <Expandable title="child attributes">
                <ResponseField name="offset" type="integer (int64)" required>
                  The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required
                </ResponseField>

                <ResponseField name="nodeId" type="integer (int32)" required>
                  The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required
                </ResponseField>

                <ResponseField name="contractId" type="string" required>
                  The ID of the target contract. Must be a valid LedgerString (as described in `value.proto`). Required
                </ResponseField>

                <ResponseField name="templateId" type="string" required>
                  Identifies the template that defines the executed choice. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
                </ResponseField>

                <ResponseField name="interfaceId" type="string">
                  The interface where the choice is defined, if inherited. If defined, the identifier uses the package-id reference format. Optional
                </ResponseField>

                <ResponseField name="choice" type="string" required>
                  The choice that was exercised on the target contract. Must be a valid NameString (as described in `value.proto`). Required
                </ResponseField>

                <ResponseField name="choiceArgument" type="object" required>
                  The argument of the exercised choice. Required
                </ResponseField>

                <ResponseField name="actingParties" type="string[]" required>
                  The parties that exercised the choice. Each element must be a valid PartyIdString (as described in `value.proto`). Required: must be non-empty
                </ResponseField>

                <ResponseField name="consuming" type="boolean" required>
                  If true, the target contract may no longer be exercised. Required
                </ResponseField>

                <ResponseField name="witnessParties" type="string[]" required>
                  The parties that are notified of this event. The witnesses of an exercise node will depend on whether the exercise was consuming or not. If consuming, the witnesses are the union of the stakeholders, the actors and all informees of all the ancestors of this event this participant knows about. If not consuming, the witnesses are the union of the signatories, the actors and all informees of all the ancestors of this event this participant knows about. In both cases the witnesses are limited to the querying parties, or not limited in case anyParty filters are used. Note that the actors might not necessarily be observers and thus stakeholders. This is the case when the controllers of a choice are specified using "flexible controllers", using the `choice ... controller` syntax, and said controllers are not explicitly marked as observers. Each element must be a valid PartyIdString (as described in `value.proto`). Required: must be non-empty
                </ResponseField>

                <ResponseField name="lastDescendantNodeId" type="integer (int32)" required>
                  Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of this `ExercisedEvent`. This allows unambiguous identification of all the members of the subtree rooted at this node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily filtered, it is only possible to determine if a node is in a consequent subtree or not. Required
                </ResponseField>

                <ResponseField name="exerciseResult" type="object">
                  The result of exercising the choice. Optional
                </ResponseField>

                <ResponseField name="packageName" type="string" required>
                  The package name of the contract. Required
                </ResponseField>

                <ResponseField name="implementedInterfaces" type="string[]">
                  If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include\_interface\_view set. The identifier uses the package-id reference format. Optional: can be empty
                </ResponseField>

                <ResponseField name="acsDelta" type="boolean" required>
                  Whether this event would be part of respective ACS\_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="offset" type="integer (int64)" required>
      The absolute offset. The details of this field are described in `community/ledger-api/README.md`. It is a valid absolute offset (positive integer). Required
    </ResponseField>

    <ResponseField name="synchronizerId" type="string" required>
      A valid synchronizer id. Identifies the synchronizer that synchronized the transaction. Required
    </ResponseField>

    <ResponseField name="traceContext" type="TraceContext">
      Ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead. Optional

      <Expandable title="child attributes">
        <ResponseField name="traceparent" type="string">
          [https://www.w3.org/TR/trace-context/](https://www.w3.org/TR/trace-context/) Optional
        </ResponseField>

        <ResponseField name="tracestate" type="string">
          Optional
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="recordTime" type="string" required>
      The time at which the transaction was recorded. The record time refers to the synchronizer which synchronized the transaction. Required
    </ResponseField>

    <ResponseField name="externalTransactionHash" type="string">
      For transaction externally signed, contains the external transaction hash signed by the external party. Can be used to correlate an external submission with a committed transaction. Optional: can be empty
    </ResponseField>

    <ResponseField name="paidTrafficCost" type="integer (int64)">
      The traffic cost that this participant node paid for the confirmation request for this transaction. Not set for transactions that were - initiated by another participant - initiated offline via the repair service - processed before the participant started serving traffic cost on the Ledger API - returned as part of a query filtering for a non submitting party Optional
    </ResponseField>
  </Expandable>
</ResponseField>

### 400

Invalid value, Invalid value for: body

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">text/plain</span>
</div>

<ResponseField name="value" type="string" required />

### default

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">application/json</span>
</div>

<ResponseField name="code" type="string" required />

<ResponseField name="cause" type="string" required />

<ResponseField name="correlationId" type="string" />

<ResponseField name="traceId" type="string" />

<ResponseField name="context" type="Map_String" required />

<ResponseField name="resources" type="Tuple2_String_String[]" />

<ResponseField name="errorCategory" type="integer (int32)" required />

<ResponseField name="grpcCodeValue" type="integer (int32)" />

<ResponseField name="retryInfo" type="string" />

<ResponseField name="definiteAnswer" type="boolean" />

## History

<div class="x2mdx-ref-history" aria-label="Reference history">
  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--remove-as-of" id="history-removal-scheduled-3-5-0">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Removal scheduled</span>
      <code class="x2mdx-ref-history-event-version">3.5.0</code>
    </div>
  </div>

  <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">The POST /v2/updates/transaction-by-offset operation was updated in this snapshot.</p>
  </div>

  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--deprecated" id="history-deprecated-3-4">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Deprecated</span>
      <code class="x2mdx-ref-history-event-version">3.4</code>
    </div>
  </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>