Skip to main content
GET
Get portfolio margin

Authorizations

X-Monaco-Signature
string
header
required

Ed25519 session-key request signing. Every authenticated request carries three headers: X-Monaco-PublicKey (64-char lowercase-hex session public key), X-Monaco-Timestamp (Unix milliseconds, within 30s of server time), and X-Monaco-Signature (hex ed25519 signature). The signature is over METHOD\npath?query\ntimestamp_ms\nSHA256_hex(body), where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from POST /api/v1/auth/challenge followed by POST /api/v1/auth/verify.

Query Parameters

marginAccountId
string

One of the caller's margin accounts (the default one or a sub-account) to describe instead of the default one: total, positions and risk_buckets are then that account's own.

includeAccounts
boolean

Also return accounts, one row per open margin account of the caller, and owner_total, their sum: the owner rollup across sub-accounts.

Response

OK

asOf
string | null
total
object
positions
object
riskBuckets
object[] | null
marginAccountId
string | null

The margin account total, positions and risk_buckets describe; absent when the caller has no margin account yet.

accounts
object[] | null

With include_accounts: every open margin account of the caller, the default one first, then sub-accounts by key.

ownerTotal
object | null

With include_accounts: the sum of accounts' totals.