System Status - Edel Developer Docs

system.status is a public system-scoped channel. Authentication: none. Payload schema: RealtimeSystemStatusPayload. Source status: derived. One subscription covers the whole venue; send no marketId. The first frame after the accepted frame has kind: "snapshot" and holds the whole current status. Every later frame has kind: "update" and holds the whole status again, sent only when it changed. Gate each button on its own action in actions: when available is false, refuse the action and show message. state is the most severe condition in force, for one banner. status_unknown means the venue could not confirm the action is safe: treat it as unavailable. A venue component that stops reporting reads as status_unknown within 90 seconds, and a money component that comes back shows as available within 30 seconds. Nothing is replayed: after a gap or a reconnect, subscribe again and start from the new snapshot. The same status is one REST read at GET /v1/system/status; read it once after a (re)connect, never on a timer. 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-system-status",
  "channel": "system.status"
}

Accepted frame

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

{
  "version": "realtime-subscription-accepted/v1",
  "requestId": "subscribe-system-status",
  "channel": "system.status",
  "visibility": "public",
  "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 RealtimeSystemStatusPayload.

{
  "version": "realtime-stream/v1",
  "messageId": "messageid-example",
  "type": "data",
  "channel": "system.status",
  "sequence": 1,
  "occurredAtEpochMs": 1,
  "visibility": "public",
  "checkpoint": {
    "kind": "system"
  },
  "payload": {
    "version": "system-status/v1",
    "state": "normal",
    "changedAtEpochMs": 0,
    "actions": {
      "orders": {
        "available": false,
        "reason": "order_intake_stopped",
        "message": "message-example"
      },
      "cancels": {
        "available": false,
        "reason": "order_intake_stopped",
        "message": "message-example"
      },
      "deposit": {
        "available": false,
        "reason": "order_intake_stopped",
        "message": "message-example"
      },
      "withdraw": {
        "available": false,
        "reason": "order_intake_stopped",
        "message": "message-example"
      },
      "agent_fund": {
        "available": false,
        "reason": "order_intake_stopped",
        "message": "message-example"
      },
      "agent_money_back": {
        "available": false,
        "reason": "order_intake_stopped",
        "message": "message-example"
      },
      "agent_actions": {
        "available": false,
        "reason": "order_intake_stopped",
        "message": "message-example"
      }
    },
    "kind": "snapshot"
  }
}

Worked example

Send the subscribe envelope with request id subscribe-system-status.
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 RealtimeSystemStatusPayload.

​Subscribe envelope

​Accepted frame

​Data frame

​Worked example

Subscribe envelope

Accepted frame

Data frame

Worked example