Account

const response = await client.request({
  id: ctx.id,
  epoch: ctx.epoch,
  expiresAt: ctx.expiresAt,
  command: {
    kind: 'read',
    query: { family: 'account', limit: 32 },
  },
});

({
  kind: 'page',
  family: 'account',
  revision: snapshotRevision,
  next: new Uint8Array(40),
  evaluatedAt: observedAt,
  rows: [
    { kind: 'account', epoch: ctx.epoch, cash: 100n, funding: 0n, held: 0n },
  ],
})

({ kind: 'error', code: 'conflict' })

const response = await client.request({
  id: ctx.id,
  epoch: ctx.epoch,
  expiresAt: ctx.expiresAt,
  command: {
    kind: 'read',
    query: { family: 'account', limit: 32 },
  },
});

({
  kind: 'page',
  family: 'account',
  revision: snapshotRevision,
  next: new Uint8Array(40),
  evaluatedAt: observedAt,
  rows: [
    { kind: 'account', epoch: ctx.epoch, cash: 100n, funding: 0n, held: 0n },
  ],
})

({ kind: 'error', code: 'conflict' })

Carrier: POST /v1/exchange (encrypted binary). Read family: account · Permission: owner or current READ agent. Private account accounting and qualified risk context. Results are private to the bound account. The same query is available over HTTP and WebSocket, including subscriptions.

These are signed SDK fields and decoded results, not a plaintext JSON HTTP body. The shared carrier accepts encrypted application/octet-stream.

const response = await client.request({
  id: ctx.id,
  epoch: ctx.epoch,
  expiresAt: ctx.expiresAt,
  command: {
    kind: 'read',
    query: { family: 'account', limit: 32 },
  },
});

({
  kind: 'page',
  family: 'account',
  revision: snapshotRevision,
  next: new Uint8Array(40),
  evaluatedAt: observedAt,
  rows: [
    { kind: 'account', epoch: ctx.epoch, cash: 100n, funding: 0n, held: 0n },
  ],
})

({ kind: 'error', code: 'conflict' })

Request fields

Use the configured client and envelope. Each request supplies id, current epoch and authentication expiresAt, as shown in the example.

"read"

required

Read-command discriminator.

"account"

required

Selects this exact private projection.

number

required

Integer from 1 to 64 rows. The example requests 32.

Uint8Array (40 bytes)

Omit or use all-zero bytes to start. For another page, use the prior page’s next under the same snapshot revision.

Response fields

Illustrative decoded SDK values are shown at the right; absent optional fields mean unavailable, not zero. Empty rows is valid.

"page"

required

Paged-response discriminator.

"account"

required

The requested family.

Uint8Array (32 bytes)

required

Commitment to the permitted snapshot and query identity, not a global activity counter.

Uint8Array (40 bytes)

required

Next cursor; all-zero means no more retained rows.

bigint (u64)

required

Qualified Cinder evaluation time, in milliseconds.

ReadRow[]

required

At most the requested limit.

Show Account row fields

"account"

required

Account-row discriminator.

bigint (u64)

required

Current authority epoch.

bigint (i128)

required

Signed settled cash, in quote atoms.

bigint (i128)

required

Signed recognized unsettled funding, in quote atoms.

bigint (i128)

required

Explicit reserved amount, in quote atoms.

Risk

Present only when required risk evidence is qualified.

Show risk fields

bigint (i128)

required

Conservative risk equity.

bigint (i128)

required

Current initial-margin requirement.

bigint (i128)

required

Current maintenance-margin requirement.

bigint (i128)

required

Requirement across qualified pending outcomes.

bigint (i128)

required

Other amounts held by the risk calculation.

bigint (i128)

required

Risk free collateral; not an unconditional instantly payable amount.

bigint (i128)

Optional marked accounting equity; distinct from conservative risk equity.

Behavior

Absent risk or valuation is unavailable, not zero. Cash, marked equity and risk.free are distinct; none bypasses fresh payout admission.

Paging and errors

Read queries do not change financial state or consume order budgets. Permissions filter rows before paging. Changed permitted rows return encrypted conflict; restart at zero instead of combining revisions. End-of-pages covers retained rows, not complete external venue history. See paging, errors, limits and availability. A disconnected subscription needs fresh attestation, current authority and a replacement snapshot.

Overview

Commands

Private reads

WebSocket

Request fields

Response fields

Behavior

Paging and errors

​Request fields

​Response fields

​Behavior

​Paging and errors

Request fields

Response fields

Behavior

Paging and errors