GET
cURL
Roles: app, approver, auditor, monitor, operator, risk.

Authorizations

Authorization
string
header
required

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

X-Signature-Key
string

A signed request's key id, as venue.api.signing.clients configures it for the bearer's subject.

X-Signature-Timestamp
string

Seconds since the epoch, within venue.api.signing.window of the engine's clock, 5 minutes by default.

Pattern: ^[0-9]+$
X-Signature-Nonce
string

At least 16 random bytes in base64url, never reused within twice the window.

Required string length: 22 - 128
Pattern: ^[A-Za-z0-9_-]+={0,2}$
X-Signature
string

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.

X-Request-Id
string

Your id for this request, 1 to 128 printable characters, repeated in the answer; absent, the engine makes one.

Maximum string length: 128
Pattern: ^[\x21-\x7E]+$
traceparent
string

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}$

Query Parameters

order
enum<string>
default:asc

asc, the default, for oldest first, or desc for newest first. Which end of the feed a page starts from.

Available options:
asc,
desc
kind
enum<string>[]

Only events of these kinds; repeat it for several. Absent, both.

Which feed an event belongs to.

Available options:
journal,
control
type
enum<string>[]

Only events of these types; repeat it for several. Absent, every type.

What an event announces: the record and what happened to it, <record>.<event>.

Available options:
reconciliation.run,
reconciliation.finding,
reconciliation.hold,
hold.released,
statement.received,
statement.overdue,
distribution.payable,
distribution.held,
distribution.paid,
holder.restricted,
holder.unrestricted,
holder.forced-transfer,
holder.recovered,
instrument.paused,
distribution.rate-changed,
distribution.carried,
distribution.due,
standing-approval.granted,
standing-approval.revoked,
reserve.minted,
reserve.redeemed,
reserve.cover-low,
reserve.reported,
reserve.amended,
retention.pruned,
operation.succeeded,
operation.failed,
approval.requested,
approval.signed,
approval.approved,
approval.rejected,
subscription.priced,
subscription.delivered,
subscription.ended,
redemption.priced,
redemption.funded,
redemption.burned,
redemption.settled,
redemption.withdrawn,
dealing-cycle.settled,
dealing-cycle.released,
webhook.test,
settlement.proposed,
price.point,
subscription.created,
admission.offered,
admission.granted
instrumentId
string

Only this instrument's records.

holderId
string

Only events about this holder: its records, the moves in or out of it, and its party's ledger facts; refused to the monitor.

resourceKind
enum<string>[]

Only events about these kinds of record; repeat it for several. Absent, every kind.

A kind of record an operation, an action or an event concerns.

Available options:
instrument,
holder,
subscription,
redemption,
dealing-cycle,
standing-settlement,
reserve,
lock-agreement,
mint,
reserve-redemption,
amendment,
distribution,
standing-approval,
reconciliation-run,
external-statement,
primary-market,
restriction,
hold,
webhook,
external-account,
external-source,
issuer-powers-agreement,
scheduled-distribution,
contract,
exercise
resourceId
string

Only events about this record; the monitor names with it a resourceKind whose ids its feed keeps.

from
string<date-time>

Only events whose at is this instant or later.

to
string<date-time>

Only events whose at is before this instant; an event with no at is then left out.

limit
integer<int32>

The most records a page holds, 1 to 1000; 100 by default.

Required range: 1 <= x <= 1000
after
string

The previous page's next; absent, the first page.

Response

A page of events.

offset
integer<int64>
required

The ledger offset the answer was read at; 0 for an answer from the engine's own records.

now
string
required

The engine's clock when it answered, an ISO-8601 instant.

value
object[] | null
required

What the read answers; for a list, the page's records in the list's order.

next
string | null
required

The cursor for the next page, sent back as after; null on a list's last page, never on a feed.