Skip to content
← Open Cap Table Protocol Canton Node SDK

Reference

ledger.getTransactionTreeByOffset

GET /v2/updates/transaction-tree-by-offset/{offset} — transaction tree at offset path segment string.

Path {offset} uses offset string (not necessarily numeric formatting Canton expects — supply ledger offset representation verbatim). Same verbose / parties merge as getTransactionTreeById.

Receiver: await canton.ledger.getTransactionTreeByOffset

Setup

import { Canton } from '@fairmint/canton-node-sdk';

const canton = new Canton({
  network: 'devnet',
  provider: '5n',
  partyId: 'OWN_PARTY_ID',
});

Minimal example

const tree = await canton.ledger.getTransactionTreeByOffset({
  offset: '1000',
});

Parameters — GetTransactionTreeByOffsetParams

offset string, optional verbose, parties.

Returns — GetTransactionTreeByOffsetResponse

OpenAPI transaction tree JSON.

Auth and party

Same party-merge semantics as by-id variant.

Source

operations/v2/updates/get-transaction-tree-by-offset.ts