List aggregated positions

Returns one row per party and instrument, with the position already summed. This is
the endpoint to use for an availability check or a balance enquiry — /token/holdings
returns the individual records that compose a position and leaves the arithmetic to
you, which is the right shape for audit and the wrong shape for "can this settle".

Three figures are reported and the invariant always holds:

total = locked + available

locked is reserved against in-flight settlement and cannot fund anything else.
available is the figure an availability check needs — a position total includes
locked amounts, so checking against total will oversell a position already
committed elsewhere.

holdingCount tells you how many records compose the position. A high count against
a small amount means a fragmented position, which matters because a transfer has to
consume whole holdings as inputs.

Positions are computed from open holdings at a single ledger offset, reported both on
the X-Ledger-Offset response header and as asOfOffset on each row. Two rows from
the same response are always mutually consistent.

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.

boolean

Return only positions with a non-zero available amount — the set that can actually fund a transfer.

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