List ledger updates across all record types

Returns every ledger update in ledger order across all record types, and is
the endpoint to use for audit and for incremental synchronisation. The
typed endpoints are narrower views over the same events. The response is a
superset of the Ledger API v2 GetUpdatesResponse envelope —
CreatedEvent/ArchivedEvent entries carry their native field names alongside
this API's own chainId and envelope wrapper.

ledgerOffset is a monotonically increasing opaque cursor. Persist the
highest one you have processed and pass it as ledgerOffset[gt] to resume,
which is more reliable than filtering on a timestamp because two events can
share one commit time.

This is a genuinely tier-agnostic feed. Being native, it returns events from
every Daml application on the participant, not only the ones the other tiers model.
Two consequences worth planning for.

The volume is dominated by housekeeping. Most events on a participant are routine
Canton Coin housekeeping, chiefly a single validator-liveness record that is rewritten
roughly hourly, while DTCC registry activity is a small share. Filter on
packageName before anything else — it is far more effective than filtering on
templateId or interfaceId alone.

There is no normalised eventType — templateId and interfaceId are the type.
Canton itself has no such concept, and a fixed list of event types could never be
exhaustive: a new application on the participant produces events with template ids
this API has never seen. templateId is always present and always precise, so it is the
disambiguator where two applications define the same entity name — the token
standard's Holding interface and the DTCC registry's concrete Holding being the
case you will actually hit; filter on interfaceId when you want every implementation
of an interface regardless of concrete template. instrumentId and amount are
absent on events that carry no quantity, such as credentials and delegations.

Record families you can expect to see, for orientation only — not a filterable
field.
Use packageName/templateId/interfaceId to actually filter;
this table only helps you recognise what you're looking at.

PackageTemplate families
DTCC registryHolding, TransferOffer, ExecutedTransfer, mint/burn requests and offers, rejection records, compliance/registrar delegations, allow-list entries, party credentials, participant service/onboarding requests
Canton Token Standard (CIP-0056/V1 and CIP-0112/V2)Holding interface view, TransferInstruction interface view
Canton Coin (splice-amulet)Amulet/holding, transfer instructions, transfer pre-approvals (and proposals), validator licenses, validator reward coupons, validator rights, top-up state, wallet-app install
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🔑

This endpoint is served under the native tier. A request is refused with 403 if the native tier is not licensed for your account.

For usage guidance, see Audit & Incremental Sync.

Query Params
string
length ≤ 512

Return only events of this exact fully-qualified template. Repeatable.

string
length ≤ 512

Return only events of concrete templates implementing this interface. Repeatable.
Use this to catch every implementation of a token-standard interface (e.g. every
Holding) regardless of which application's concrete template produced it.

string
length ≤ 256

Return only events defined by this Daml package. Repeatable, and the cheapest way
to scope the feed — see the note on volume in the operation description.

string
length ≤ 255
^[A-Za-z0-9_-]+::[0-9a-f]{16,}$

Return only records in which this party takes part, in any role. Matched exactly, so pass the full party identifier.

string
length ≤ 65
^[A-Za-z0-9][A-Za-z0-9._:-]{0,64}$

Return only records for this instrument. Matched exactly against the registrar-scheme identifier.

string
^[0-9]+$

Return events after this cursor. Use the highest ledgerOffset you have already processed to resume a synchronisation run without gaps or repeats.

date-time

Return events committed at or after this instant.

date-time

Return events committed at or before this instant.

string
^[a-zA-Z]+:(asc|desc)$
Defaults to createdAt:desc

Ordering as field:direction. Timestamps default to desc.

integer
1 to 100
Defaults to 20

Maximum number of records to return in this page.

string
length ≤ 2048

Opaque cursor from a previous response's pagination.nextPageToken. Omit for the first page.

Headers
string
length ≤ 128

Optional client-supplied correlation identifier, echoed back in the X-Request-Id response header and requestId body field.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json