> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cinder.exchange/llms.txt
> Use this file to discover all available pages before exploring further.

# Account

> Private account accounting and qualified risk context.

**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](/api/websocket), including subscriptions.

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

<RequestExample>
  ```ts SDK request theme={null}
  const response = await client.request({
    id: ctx.id,
    epoch: ctx.epoch,
    expiresAt: ctx.expiresAt,
    command: {
      kind: 'read',
      query: { family: 'account', limit: 32 },
    },
  });
  ```
</RequestExample>

<ResponseExample>
  ```ts Decoded page theme={null}
  ({
    kind: 'page',
    family: 'account',
    revision: snapshotRevision,
    next: new Uint8Array(40),
    evaluatedAt: observedAt,
    rows: [
      { kind: 'account', epoch: ctx.epoch, cash: 100n, funding: 0n, held: 0n },
    ],
  })
  ```

  ```ts Stale cursor error theme={null}
  ({ kind: 'error', code: 'conflict' })
  ```
</ResponseExample>

## Request fields

Use the configured [client and envelope](/api/authentication). Each request supplies
`id`, current `epoch` and authentication `expiresAt`, as shown in the example.

<ParamField body="command.kind" type="&#x22;read&#x22;" required>
  Read-command discriminator.
</ParamField>

<ParamField body="command.query.family" type="&#x22;account&#x22;" required>
  Selects this exact private projection.
</ParamField>

<ParamField body="command.query.limit" type="number" required>
  Integer from 1 to 64 rows. The example requests 32.
</ParamField>

<ParamField body="command.query.cursor" type="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.
</ParamField>

## Response fields

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

<ResponseField name="kind" type="&#x22;page&#x22;" required>
  Paged-response discriminator.
</ResponseField>

<ResponseField name="family" type="&#x22;account&#x22;" required>
  The requested family.
</ResponseField>

<ResponseField name="revision" type="Uint8Array (32 bytes)" required>
  Commitment to the permitted snapshot and query identity, not a global activity counter.
</ResponseField>

<ResponseField name="next" type="Uint8Array (40 bytes)" required>
  Next cursor; all-zero means no more retained rows.
</ResponseField>

<ResponseField name="evaluatedAt" type="bigint (u64)" required>
  Qualified Cinder evaluation time, in milliseconds.
</ResponseField>

<ResponseField name="rows" type="ReadRow[]" required>
  At most the requested limit.

  <Expandable title="Account row fields">
    <ResponseField name="kind" type="&#x22;account&#x22;" required>
      Account-row discriminator.
    </ResponseField>

    <ResponseField name="epoch" type="bigint (u64)" required>
      Current authority epoch.
    </ResponseField>

    <ResponseField name="cash" type="bigint (i128)" required>
      Signed settled cash, in quote atoms.
    </ResponseField>

    <ResponseField name="funding" type="bigint (i128)" required>
      Signed recognized unsettled funding, in quote atoms.
    </ResponseField>

    <ResponseField name="held" type="bigint (i128)" required>
      Explicit reserved amount, in quote atoms.
    </ResponseField>

    <ResponseField name="risk" type="Risk">
      Present only when required risk evidence is qualified.

      <Expandable title="risk fields">
        <ResponseField name="equity" type="bigint (i128)" required>
          Conservative risk equity.
        </ResponseField>

        <ResponseField name="initial" type="bigint (i128)" required>
          Current initial-margin requirement.
        </ResponseField>

        <ResponseField name="maintenance" type="bigint (i128)" required>
          Current maintenance-margin requirement.
        </ResponseField>

        <ResponseField name="outcomeRequirement" type="bigint (i128)" required>
          Requirement across qualified pending outcomes.
        </ResponseField>

        <ResponseField name="otherHeld" type="bigint (i128)" required>
          Other amounts held by the risk calculation.
        </ResponseField>

        <ResponseField name="free" type="bigint (i128)" required>
          Risk free collateral; not an unconditional instantly payable amount.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="accountingEquity" type="bigint (i128)">
      Optional marked accounting equity; distinct from conservative risk equity.
    </ResponseField>
  </Expandable>
</ResponseField>

## 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](/api/reads/paging), [errors](/api/errors), [limits](/api/limits)
and [availability](/status). A disconnected subscription needs fresh attestation,
current authority and a replacement snapshot.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.