developers:apiv2:reference

Message Catalog

◀ WebSocket API (V2)

The .proto files define every message and field. This page maps each envelope payload to its message and the proto file that describes it.

All messages travel inside a transport envelope, one Protobuf message per WebSocket binary frame:

  • ClientMessage — Client → Server messages
  • ServerMessage — Server → Client messages

Each envelope is a oneof: exactly one payload is set. Read the payload case to know what you received.

message ClientMessage {
  oneof payload {
    Heartbeat            heartbeat          = 1;
    auth.LoginRequest    login_request      = 2;
    market.MarketSubscribe    market_subscribe   = 100;
    account.AccountSubscribe  account_subscribe  = 200;
    orderrouting.OrderSubmit  order_submit       = 300;
    // ...
  }
}

message ServerMessage {
  oneof payload {
    Heartbeat            heartbeat          = 1;
    auth.LoginResponse   login_response     = 2;
    market.MarketSnapshot     market_snapshot    = 108;
    account.AccountSnapshot   account_snapshot   = 205;
    orderrouting.OrderUpdate  order_update       = 300;
    // ...
  }
}

The full envelope is in proto/t4/v2/service.proto.

File Contents
proto/t4/v2/service.proto ClientMessage / ServerMessage envelopes, Heartbeat.
proto/t4/v2/auth/auth.proto Login and authentication tokens.
proto/t4/v2/market/market.proto Market-data subscribe and feed messages.
proto/t4/v2/account/account.proto Account subscribe, snapshot and updates.
proto/t4/v2/orderrouting/orderrouting.proto Order submit/revise/pull/batch and updates.
proto/t4/v2/common/enums.proto All enums.
proto/t4/v2/common/price.proto Price and Decimal wrappers.
Payload Purpose
Heartbeat Keepalive.
LoginRequest Authenticate.
AuthenticationTokenRequest Request a token.
MarketSubscribe Subscribe/unsubscribe a market (quotes level + ticker).
AccountSubscribe Subscribe account(s).
OrderSubmit Place order(s).
OrderRevise Revise order(s).
OrderPull Cancel order(s).
OrderBatch All-or-nothing batch.
CreateUDS Define a strategy.
Payload Purpose
Heartbeat Keepalive.
LoginResponse Login result, identity, entitlements.
AuthenticationToken Token + expiry.
MarketSubscribeReject Subscribe refused (check mode).
MarketDetails Instrument definition.
MarketDepth Depth update (top-of-book / full book).
MarketTrade Trade print (ticker).
MarketHighLow Session high/low/open.
MarketPriceLimits Price limits.
MarketSettlement Settlement, OI, VWAP.
MarketSnapshot Full state on subscribe (price feed).
MarketByOrderSnapshot Full book on subscribe (MBO).
MarketByOrderUpdate Per-order changes (MBO).
AccountSubscribeResponse Subscribe result.
AccountCurrency Currency rates.
AccountPosition Position.
AccountUpdate Balances / margin.
AccountDetails Account configuration.
AccountSnapshot Full state on subscribe.
AccountProfit Account UPL / RPL.
AccountPositionProfit Per-position UPL / RPL.
OrderUpdate Unified order lifecycle event.
OrderTrade Fill.
MarginInquiryResponse Margin preview.
OrderBatchAcknowledge Batch accepted.
OrderBatchReject Batch rejected.
CreateUDSResponse Strategy created.
  • developers/apiv2/reference.txt
  • Last modified: 2026/09/07 17:48
  • by chad