Account Pnl - Edel Developer Docs

account.pnl is a private account-scoped channel. Authentication: bearer account session. Payload schema: RealtimeAccountPnlPayload. Source status: live. 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-pnl",
  "channel": "account.pnl",
  "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-pnl",
  "channel": "account.pnl",
  "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 RealtimeAccountPnlPayload.

{
  "version": "realtime-stream/v1",
  "messageId": "messageid-example",
  "type": "data",
  "channel": "account.pnl",
  "sequence": 1,
  "occurredAtEpochMs": 1,
  "visibility": "private",
  "accountId": "account-example",
  "checkpoint": {
    "kind": "system"
  },
  "payload": {
    "accountId": "account-example",
    "marketId": "marketid-example",
    "journalSequence": 1,
    "signedBaseAtoms": "1",
    "entryNotionalAtoms": "1",
    "entryPriceAtoms": "1",
    "markPriceAtoms": "1",
    "unrealizedPnlAtoms": "1",
    "realizedPnlAtoms": "1",
    "realizedPnlDeltaAtoms": "1"
  }
}

Worked example

Send the subscribe envelope with request id subscribe-account-pnl.
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 RealtimeAccountPnlPayload.