curl --request POST \
  --url 'http://localhost:7575/v2/updates/transaction-by-offset' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"offset":0,"requestingParties":["string"],"transactionFormat":{"eventFormat":{},"transactionShape":"TRANSACTION_SHAPE_UNSPECIFIED"}}'

{
  "transaction": {
    "updateId": "string",
    "commandId": "string",
    "workflowId": "string",
    "effectiveAt": "string",
    "events": [
      {}
    ],
    "offset": 0,
    "synchronizerId": "string",
    "traceContext": {},
    "recordTime": "string",
    "externalTransactionHash": "string",
    "paidTrafficCost": 0
  }
}

{
  "code": "string",
  "cause": "string",
  "correlationId": "string",
  "traceId": "string",
  "context": {},
  "resources": [
    [
      "string"
    ]
  ],
  "errorCategory": 0,
  "grpcCodeValue": 0,
  "retryInfo": "string",
  "definiteAnswer": false
}

POST

updates

transaction-by-offset

curl --request POST \
  --url 'http://localhost:7575/v2/updates/transaction-by-offset' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"offset":0,"requestingParties":["string"],"transactionFormat":{"eventFormat":{},"transactionShape":"TRANSACTION_SHAPE_UNSPECIFIED"}}'

{
  "transaction": {
    "updateId": "string",
    "commandId": "string",
    "workflowId": "string",
    "effectiveAt": "string",
    "events": [
      {}
    ],
    "offset": 0,
    "synchronizerId": "string",
    "traceContext": {},
    "recordTime": "string",
    "externalTransactionHash": "string",
    "paidTrafficCost": 0
  }
}

{
  "code": "string",
  "cause": "string",
  "correlationId": "string",
  "traceId": "string",
  "context": {},
  "resources": [
    [
      "string"
    ]
  ],
  "errorCategory": 0,
  "grpcCodeValue": 0,
  "retryInfo": "string",
  "definiteAnswer": false
}

JSON Ledger API

Get transaction by offset

OpenAPISince 3.4Changed 3.5Remove as of 3.5.0

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.

Protocol Details

Operation IDpostV2UpdatesTransaction-by-offset

AuthenticationBearer token

Published3.5

Inputs

Request body

application/json

number

required

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

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

object

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

Outputs

200

application/json

JsTransaction

required

Filtered view of an on-ledger transaction’s create and archive events.

400

text/plain

string

required

default

application/json

string

required

string

required

string

Map_String

required

Tuple2_String_String[]

integer (int32)

required

integer (int32)

string

boolean

History

Remove as of3.5.0

Changed3.5

The POST /v2/updates/transaction-by-offset operation changed in this snapshot.

Deprecated3.4

Introduced3.4

curl --request POST \
  --url 'http://localhost:7575/v2/updates/transaction-by-offset' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"offset":0,"requestingParties":["string"],"transactionFormat":{"eventFormat":{},"transactionShape":"TRANSACTION_SHAPE_UNSPECIFIED"}}'

{
  "transaction": {
    "updateId": "string",
    "commandId": "string",
    "workflowId": "string",
    "effectiveAt": "string",
    "events": [
      {}
    ],
    "offset": 0,
    "synchronizerId": "string",
    "traceContext": {},
    "recordTime": "string",
    "externalTransactionHash": "string",
    "paidTrafficCost": 0
  }
}

{
  "code": "string",
  "cause": "string",
  "correlationId": "string",
  "traceId": "string",
  "context": {},
  "resources": [
    [
      "string"
    ]
  ],
  "errorCategory": 0,
  "grpcCodeValue": 0,
  "retryInfo": "string",
  "definiteAnswer": false
}

⌘I

Ledger API

Daml Standard Library

Daml Script

TypeScript

dApp API

Wallet Gateway

Splice APIs

Admin API

Get transaction by offset

Get transaction by offset

Protocol Details

Inputs

Request body

Outputs

200

400

default

History

​Get transaction by offset

​Protocol Details

​Inputs

​Request body

​Outputs

​200

​400

​default

​History

Get transaction by offset

Protocol Details

Inputs

Request body

Outputs

200

400

default

History