cURL
curl -s \
"https://engine.example.com/v1/instruments/CASH/movements?limit=100" \
-H "Authorization: Bearer $TOKEN"
# Send each page's next back as after, until null.// A client from OpenAPI Generator: see Build a client.
import {
Configuration,
ProblemFromJSON,
ReportsApi,
ResponseError,
} from "./nodeasset-client";
const api = new ReportsApi(new Configuration({
basePath: "https://engine.example.com",
accessToken: process.env.TOKEN,
}));
try {
// Send each page's next back as after, until null.
let after: string | undefined;
do {
const page = await api.listInstrumentMovements({ instrumentId: "CASH", limit: 100, after });
for (const movement of page.value ?? []) {
console.log(movement);
}
after = page.next ?? undefined;
} while (after);
} catch (e) {
if (!(e instanceof ResponseError)) throw e;
// A refusal is a problem; its type ends in the slug.
const problem = ProblemFromJSON(await e.response.json());
const slug = problem.type.split(":").pop();
console.error(e.response.status, slug, problem.detail);
}
# A client from OpenAPI Generator: see Build a client.
import os
import sys
import nodeasset_client
config = nodeasset_client.Configuration(
host="https://engine.example.com",
access_token=os.environ["TOKEN"],
)
with nodeasset_client.ApiClient(config) as client:
api = nodeasset_client.ReportsApi(client)
try:
# Send each page's next back as after, until null.
after = None
while True:
page = api.list_instrument_movements(instrument_id="CASH", limit=100, after=after)
for movement in page.value or []:
print(movement)
after = page.next
if after is None:
break
except nodeasset_client.ApiException as e:
# A refusal is a problem; its type ends in the slug.
problem = nodeasset_client.Problem.from_json(e.body)
slug = problem.type.rsplit(":", 1)[-1]
print(e.status, slug, problem.detail, file=sys.stderr)
// A client from OpenAPI Generator: see Build a client.
import nodeasset.client.ApiClient;
import nodeasset.client.ApiException;
import nodeasset.client.api.ReportsApi;
import nodeasset.client.model.Problem;
public class ListInstrumentMovements {
public static void main(String[] args) throws Exception {
ApiClient client = new ApiClient();
client.updateBaseUri("https://engine.example.com");
client.setRequestInterceptor(builder ->
builder.header("Authorization", "Bearer " + System.getenv("TOKEN")));
ReportsApi api = new ReportsApi(client);
try {
// Send each page's next back as after, until null.
String after = null;
do {
var request = ReportsApi.APIListInstrumentMovementsRequest.newBuilder()
.instrumentId("CASH")
.limit(100)
.after(after)
.build();
var page = api.listInstrumentMovements(request);
for (var movement : page.getValue()) {
System.out.println(movement);
}
after = page.getNext();
} while (after != null);
} catch (ApiException e) {
// A refusal is a problem; its type ends in the slug.
Problem problem = client.getObjectMapper()
.readValue(e.getResponseBody(), Problem.class);
String type = problem.getType();
String slug = type.substring(type.lastIndexOf(':') + 1);
System.err.println(e.getCode() + " " + slug + " " + problem.getDetail());
}
}
}
{
"offset": 669,
"ledgerTime": "2026-10-03T13:26:05.540274Z",
"now": "2026-10-03T13:26:06.152274031Z",
"value": [
{
"instrumentId": "CASH",
"account": {
"owner": "zeta::12207ae69b2ef2f1249abd41923a06ee30bffa9298a17b0a875355c441bf32045d73",
"provider": null,
"id": ""
},
"holderId": "zeta",
"kind": "issue",
"units": 5000,
"balanceAfter": 5000,
"at": "2026-10-02T13:50:09.284511Z",
"offset": 437,
"updateId": "1220b21167332b1dd8d87d95893a063dde7a7766620e0c2abf9e829b317247e66bd0",
"counterparty": {
"owner": null,
"provider": null,
"id": "cip-112/mint"
},
"counterpartyHolderId": null,
"price": 1,
"amount": 5000,
"amountInstrumentId": "FUND",
"references": {
"settlementId": "s-26af2101887c802a1c6f",
"subscriptionId": null,
"redemptionId": null,
"dealingCycleId": null,
"distributionId": null,
"operationId": null,
"reference": null
}
},
{
"instrumentId": "CASH",
"account": {
"owner": "zeta::12207ae69b2ef2f1249abd41923a06ee30bffa9298a17b0a875355c441bf32045d73",
"provider": null,
"id": ""
},
"holderId": "zeta",
"kind": "transfer",
"units": -1200,
"balanceAfter": 3800,
"at": "2026-10-02T14:02:41.718003Z",
"offset": 512,
"updateId": "1220e4c1a8b7d6f5e4c3b2a1908f7e6d5c4b3a29180f7e6d5c4b3a2918071625f3a",
"counterparty": {
"owner": "gamma::12207ae69b2ef2f1249abd41923a06ee30bffa9298a17b0a875355c441bf32045d73",
"provider": null,
"id": ""
},
"counterpartyHolderId": "gamma",
"price": null,
"amount": null,
"amountInstrumentId": null,
"references": {
"settlementId": null,
"subscriptionId": null,
"redemptionId": null,
"dealingCycleId": null,
"distributionId": null,
"operationId": null,
"reference": null
}
}
],
"next": "bW92ZW1lbnRzfDUxMnxDQVNI"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}Reports
List an instrument's movements
Lists each change of the instrument’s units in every account of its register, oldest first, with its kind, the balance after it and its references.
GET
/
v1
/
instruments
/
{instrumentId}
/
movements
cURL
curl -s \
"https://engine.example.com/v1/instruments/CASH/movements?limit=100" \
-H "Authorization: Bearer $TOKEN"
# Send each page's next back as after, until null.// A client from OpenAPI Generator: see Build a client.
import {
Configuration,
ProblemFromJSON,
ReportsApi,
ResponseError,
} from "./nodeasset-client";
const api = new ReportsApi(new Configuration({
basePath: "https://engine.example.com",
accessToken: process.env.TOKEN,
}));
try {
// Send each page's next back as after, until null.
let after: string | undefined;
do {
const page = await api.listInstrumentMovements({ instrumentId: "CASH", limit: 100, after });
for (const movement of page.value ?? []) {
console.log(movement);
}
after = page.next ?? undefined;
} while (after);
} catch (e) {
if (!(e instanceof ResponseError)) throw e;
// A refusal is a problem; its type ends in the slug.
const problem = ProblemFromJSON(await e.response.json());
const slug = problem.type.split(":").pop();
console.error(e.response.status, slug, problem.detail);
}
# A client from OpenAPI Generator: see Build a client.
import os
import sys
import nodeasset_client
config = nodeasset_client.Configuration(
host="https://engine.example.com",
access_token=os.environ["TOKEN"],
)
with nodeasset_client.ApiClient(config) as client:
api = nodeasset_client.ReportsApi(client)
try:
# Send each page's next back as after, until null.
after = None
while True:
page = api.list_instrument_movements(instrument_id="CASH", limit=100, after=after)
for movement in page.value or []:
print(movement)
after = page.next
if after is None:
break
except nodeasset_client.ApiException as e:
# A refusal is a problem; its type ends in the slug.
problem = nodeasset_client.Problem.from_json(e.body)
slug = problem.type.rsplit(":", 1)[-1]
print(e.status, slug, problem.detail, file=sys.stderr)
// A client from OpenAPI Generator: see Build a client.
import nodeasset.client.ApiClient;
import nodeasset.client.ApiException;
import nodeasset.client.api.ReportsApi;
import nodeasset.client.model.Problem;
public class ListInstrumentMovements {
public static void main(String[] args) throws Exception {
ApiClient client = new ApiClient();
client.updateBaseUri("https://engine.example.com");
client.setRequestInterceptor(builder ->
builder.header("Authorization", "Bearer " + System.getenv("TOKEN")));
ReportsApi api = new ReportsApi(client);
try {
// Send each page's next back as after, until null.
String after = null;
do {
var request = ReportsApi.APIListInstrumentMovementsRequest.newBuilder()
.instrumentId("CASH")
.limit(100)
.after(after)
.build();
var page = api.listInstrumentMovements(request);
for (var movement : page.getValue()) {
System.out.println(movement);
}
after = page.getNext();
} while (after != null);
} catch (ApiException e) {
// A refusal is a problem; its type ends in the slug.
Problem problem = client.getObjectMapper()
.readValue(e.getResponseBody(), Problem.class);
String type = problem.getType();
String slug = type.substring(type.lastIndexOf(':') + 1);
System.err.println(e.getCode() + " " + slug + " " + problem.getDetail());
}
}
}
{
"offset": 669,
"ledgerTime": "2026-10-03T13:26:05.540274Z",
"now": "2026-10-03T13:26:06.152274031Z",
"value": [
{
"instrumentId": "CASH",
"account": {
"owner": "zeta::12207ae69b2ef2f1249abd41923a06ee30bffa9298a17b0a875355c441bf32045d73",
"provider": null,
"id": ""
},
"holderId": "zeta",
"kind": "issue",
"units": 5000,
"balanceAfter": 5000,
"at": "2026-10-02T13:50:09.284511Z",
"offset": 437,
"updateId": "1220b21167332b1dd8d87d95893a063dde7a7766620e0c2abf9e829b317247e66bd0",
"counterparty": {
"owner": null,
"provider": null,
"id": "cip-112/mint"
},
"counterpartyHolderId": null,
"price": 1,
"amount": 5000,
"amountInstrumentId": "FUND",
"references": {
"settlementId": "s-26af2101887c802a1c6f",
"subscriptionId": null,
"redemptionId": null,
"dealingCycleId": null,
"distributionId": null,
"operationId": null,
"reference": null
}
},
{
"instrumentId": "CASH",
"account": {
"owner": "zeta::12207ae69b2ef2f1249abd41923a06ee30bffa9298a17b0a875355c441bf32045d73",
"provider": null,
"id": ""
},
"holderId": "zeta",
"kind": "transfer",
"units": -1200,
"balanceAfter": 3800,
"at": "2026-10-02T14:02:41.718003Z",
"offset": 512,
"updateId": "1220e4c1a8b7d6f5e4c3b2a1908f7e6d5c4b3a29180f7e6d5c4b3a2918071625f3a",
"counterparty": {
"owner": "gamma::12207ae69b2ef2f1249abd41923a06ee30bffa9298a17b0a875355c441bf32045d73",
"provider": null,
"id": ""
},
"counterpartyHolderId": "gamma",
"price": null,
"amount": null,
"amountInstrumentId": null,
"references": {
"settlementId": null,
"subscriptionId": null,
"redemptionId": null,
"dealingCycleId": null,
"distributionId": null,
"operationId": null,
"reference": null
}
}
],
"next": "bW92ZW1lbnRzfDUxMnxDQVNI"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"gate": "<string>",
"check": "<string>",
"recovery": "<string>",
"retryAfter": 123,
"retryable": true,
"packageName": "<string>",
"party": "<string>",
"contractId": "<string>",
"projectionOffset": 123,
"ledgerEnd": 123,
"code": 123,
"reason": "<string>",
"policyVersion": 123,
"errors": [
{
"pointer": "<string>",
"detail": "<string>"
}
]
}Roles:
app, approver, auditor, operator, risk.Authorizations
A JWT from the deployment's identity provider, whose roles claim names the caller's roles and whose holder claim names an investor's holder.
Headers
A signed request's key id, as venue.api.signing.clients configures it for the bearer's subject.
Seconds since the epoch, within venue.api.signing.window of the engine's clock, 5 minutes by default.
Pattern:
^[0-9]+$At least 16 random bytes in base64url, never reused within twice the window.
Required string length:
22 - 128Pattern:
^[A-Za-z0-9_-]+={0,2}$The base64 HMAC-SHA256, under the key's secret, of the method, the path and query, the timestamp, the nonce and the body's SHA-256.
Your id for this request, 1 to 128 printable characters, repeated in the answer; absent, the engine makes one.
Maximum string length:
128Pattern:
^[\x21-\x7E]+$A W3C trace context, which the engine joins and passes on.
Pattern:
^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$Path Parameters
The instrument's id on the Registry.
Query Parameters
Only this holder's records.
Only movements of these kinds; repeat it for several. Absent, every kind.
What moved an account's units.
Available options:
issue, retire, subscription, redemption, distribution, forced-transfer, recovery, succession, transfer, correction, other Only movements whose ledger time is this instant or later.
Only movements whose ledger time is before this instant.
The most movements a page holds, 1 to 1000; absent, 100.
Required range:
1 <= x <= 1000The ledger offset to read at, instead of the latest; not with asOf. What depends on time is judged at the offset's ledger time.
An instant to read the ledger as it stood then; not with at. What depends on time is judged at that instant.
The previous page's next; absent, the first page.
Response
The movements.
The ledger offset the answer was read at; 0 for an answer from the engine's own records.
The ledger time of offset: the effective time of the latest transaction at or before it; null where the projection records none.
The engine's clock when it answered, an ISO-8601 instant.
What the read answers; for a list, the page's records in the list's order.
Show child attributes
Show child attributes
The cursor for the next page, sent back as after; null on a list's last page, never on a feed.