List instrument holdings

Returns holding records ordered oldest first by createdAt. sort accepts only
createdAt:asc — the one order this endpoint's keyset pagination can serve; any other
value, including the shared parameter's createdAt:desc default, is rejected with
400. A holding
with status: open is a live position; status: closed means the record was superseded
by a transfer or burn and is retained for reconciliation.

A locked holding (isLocked: true) is reserved against an in-flight transfer
instruction and cannot fund another one until that instruction settles or
expires. lockExpiresAt tells you when a lock lapses without anyone acting, which
is what distinguishes a settlement in progress from one that has stalled.

This endpoint reads the token standard's interface view, so it returns holdings of
every compliant asset — DTCC securities and Canton Coin alike. Where the dtcc tier
is also licensed, registry-specific fields (instrumentScheme, label) are added to
the same records. Summing amount across a party's open holdings for one instrument
gives that party's position; include locked holdings in the total, since a
lock reserves a position rather than removing it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🔑

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

For usage guidance, see Positions & Availability Checks.

Query Params
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
enum

Return only holdings in this state.

Allowed:
boolean

Return only holdings that are, or are not, reserved against an in-flight transfer instruction.

date-time

Return holdings created at or after this instant.

date-time

Return holdings created 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