Skip to main content
POST
/
v2
/
updates
/
transaction-by-offset
/v2/updates/transaction-by-offset
curl --request POST \
  --url https://api.example.com/v2/updates/transaction-by-offset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "offset": 123,
  "requestingParties": [
    "<string>"
  ]
}
'
{
  "transaction": {
    "updateId": "<string>",
    "effectiveAt": "<string>",
    "events": [
      {
        "ArchivedEvent": {
          "offset": 123,
          "nodeId": 123,
          "contractId": "<string>",
          "templateId": "<string>",
          "witnessParties": [
            "<string>"
          ],
          "packageName": "<string>",
          "implementedInterfaces": [
            "<string>"
          ]
        }
      }
    ],
    "offset": 123,
    "synchronizerId": "<string>",
    "recordTime": "<string>",
    "commandId": "<string>",
    "workflowId": "<string>",
    "traceContext": {
      "traceparent": "<string>",
      "tracestate": "<string>"
    },
    "externalTransactionHash": "<string>",
    "paidTrafficCost": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://cantonfoundation-issue-526-canton-docker-image-location.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Ledger API standard JWT token

Body

application/json

Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.

​
offset
integer<int64>
required

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

​
requestingParties
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).

​
transactionFormat
TransactionFormat · object

Optional for GetTransactionByOffset request for backwards compatibility: defaults to a TransactionFormat, where:

  • event_format.filters_by_party will have template-wildcard filters for all the requesting_parties
  • event_format.filters_for_any_party is unset
  • event_format.verbose = true
  • transaction_shape = TRANSACTION_SHAPE_ACS_DELTA

Response

Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.

​
transaction
JsTransaction · object
required

Required