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.

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
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
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[]