GET
Read the bound agent account wallet and margin

Authorizations

Authorization
string
header
required

The authorization field takes the session bearer returned by sign-in, or an API key where the route allows keys. Paste the token itself into the authorization field. When invitation-only access is enabled, private operations require the account's sign-in email to be invited. Sign-in can complete without an invitation, but private HTTP, MCP and FIX operations refuse with access_not_allowlisted (HTTP 403): "Private access is limited to invited accounts. Contact support to request access." Public market data remains available. Invitation changes apply to the next private operation, including existing FIX sessions. Do not retry until support confirms access.

Path Parameters

accountId
string
required
Minimum string length: 1
deploymentId
string
required
Required string length: 1 - 64

Response

Success

version
string
required
Allowed value: "external-account-snapshot/v1"
accountId
string
required
Minimum string length: 1
asset
string
required
Minimum string length: 1
snapshotSequence
integer
required
Required range: x >= 0
readModelDigest
string
required

Covers the engine account view this response was built from, before decimal formatting. Not recomputable from the formatted payload.

Pattern: ^sha256:[0-9a-f]{64}$
marginMode
enum<string>
required

Always cross: margin is held per account across all positions and orders.

Available options:
isolated,
cross
cashBalanceAtoms
string
required
Pattern: ^[0-9]+$
cashBalance
string
required
Pattern: ^-?[0-9]+\.[0-9]+$
equityAtoms
string
required
Pattern: ^-?[0-9]+$
equity
string
required
Pattern: ^-?[0-9]+\.[0-9]+$
availableForOrdersAtoms
string
required
Pattern: ^[0-9]+$
availableForOrders
string
required
Pattern: ^-?[0-9]+\.[0-9]+$
resync
object
required
Available options:
absent,
pending,
active,
revoked,
package_unavailable
state
enum<string>

account_never_funded means the account exists but has never received trading funds. Show zero balances and an Add funds first action. Absence of this field makes no funding-history claim.

Available options:
account_never_funded
initialMarginAtoms
string

Account-wide initial margin in settlement-asset atoms: positionInitialMarginAtoms plus orderReserveAtoms at this frame's engine sequences. Includes resting-order fee and rounding reserves; excludes withdrawal holds, accrued fees and bad debt; not equity minus available capacity. Absent from legacy producers.

Pattern: ^[0-9]+$
initialMargin
string

Account-wide initial margin for cross margin, in settlement-asset decimal units: positionInitialMargin plus orderReserve at this frame's engine sequences. Includes resting-order fee and rounding reserves; excludes withdrawal holds, accrued fees and bad debt; not equity minus available capacity. Absent from legacy producers.

Pattern: ^-?[0-9]+\.[0-9]+$
positionInitialMarginAtoms
string

Account-wide sum of initial margin for all open cross-margin positions, in settlement-asset atoms at this frame's engine sequences. Excludes resting orders and other reserves. Absent from legacy producers.

Pattern: ^[0-9]+$
positionInitialMargin
string

Account-wide sum of initial margin for all open cross-margin positions, in settlement-asset decimal units at this frame's engine sequences. Excludes resting orders and other reserves. Absent from legacy producers.

Pattern: ^-?[0-9]+\.[0-9]+$
orderReserveAtoms
string

Account-wide collateral reserved for resting orders, in settlement-asset atoms at this frame's engine sequences. Includes reserved execution fees and fragmentation rounding; excludes position initial margin, withdrawal holds, accrued fees and bad debt. Absent from legacy producers.

Pattern: ^[0-9]+$
orderReserve
string

Account-wide collateral reserved for resting orders in cross margin, in settlement-asset decimal units at this frame's engine sequences. Includes reserved execution fees and fragmentation rounding; excludes position initial margin, withdrawal holds, accrued fees and bad debt. Absent from legacy producers.

Pattern: ^-?[0-9]+\.[0-9]+$
riskEvidence
object
liquidationCandidate
boolean

True while the account's equity is below its maintenance requirement or it holds bad debt. A candidate cannot withdraw or add risk, and the engine may close its positions.

maintenanceRequirementAtoms
string

The maintenance margin the account must hold across all of its positions, in settlement-asset atoms.

Pattern: ^[0-9]+$
marginHealthBps
string

Equity divided by the maintenance requirement, in basis points (10000 is exactly at maintenance, and 10000 is also reported when nothing is at risk). Signed; absent when it cannot be computed.

Pattern: ^-?[0-9]+$
badDebtAtoms
string

A liquidation loss that neither the order book, the insurance fund nor auto-deleverage covered, in settlement-asset atoms. The account stays blocked while it is above 0. A liquidation fee and an insurance fund cover show up only as a change in the cash balance, never here.

Pattern: ^[0-9]+$
positions
object[]