Account Margin - Edel Developer Docs

account.margin is a private account-scoped channel. Authentication: realtime ticket, sent in an auth frame before subscribing. Payload schema: RealtimeAccountMarginPayload. Source status: digest. Authenticate the socket with a realtime ticket and wait for auth_ok before you send the subscribe envelope below; a subscribe sent earlier is refused as unauthorized. The socket authentication flow covers minting, rotation and expiry. Send this exact JSON shape. requestId is required and there is no action field. The series field is not sent for this channel.

{
  "version": "realtime-subscribe/v1",
  "requestId": "subscribe-account-margin",
  "channel": "account.margin",
  "accountId": "account-example"
}

Accepted frame

The subscription is active only after a matching realtime-subscription-accepted/v1 frame arrives.

{
  "version": "realtime-subscription-accepted/v1",
  "requestId": "subscribe-account-margin",
  "channel": "account.margin",
  "visibility": "private",
  "accountId": "account-example",
  "nextSequence": 1,
  "heartbeatIntervalMs": 10000,
  "replay": {
    "mode": "latest",
    "gapErrorCode": "sequence_gap",
    "resyncErrorCode": "resync_required"
  }
}

Data frame

The envelope is realtime-stream/v1; its payload validates against RealtimeAccountMarginPayload.

{
  "version": "realtime-stream/v1",
  "messageId": "messageid-example",
  "type": "data",
  "channel": "account.margin",
  "sequence": 1,
  "occurredAtEpochMs": 1,
  "visibility": "private",
  "accountId": "account-example",
  "checkpoint": {
    "kind": "system"
  },
  "payload": {
    "accountId": "account-example",
    "accountRootHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000",
    "journalSequence": 1,
    "cashBalanceAtoms": "1",
    "equityAtoms": "1",
    "availableForOrdersAtoms": "1"
  }
}

Worked example

Send the subscribe envelope with request id subscribe-account-margin.
Wait for the accepted frame with the same request id; receiving any other frame does not prove this subscription.
Process the data frame at sequence 1 and validate its payload as RealtimeAccountMarginPayload.

​Subscribe envelope

​Accepted frame

​Data frame

​Worked example

Subscribe envelope

Accepted frame

Data frame

Worked example