developers:websocket:messages

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
developers:websocket:messages [2026/04/22 20:04] – [DepthBuffer] frankdevelopers:websocket:messages [2026/05/28 12:12] (current) – [MarketSettlement] chad
Line 266: Line 266:
 | settlement_time | google.protobuf.Timestamp | Time of settlement | | settlement_time | google.protobuf.Timestamp | Time of settlement |
 | settlement_trade_date | google.protobuf.Timestamp | Trade date of settlement | | settlement_trade_date | google.protobuf.Timestamp | Trade date of settlement |
-| settlement_held_price | string | Held settlement price |+| settlement_held_price | Price | Held settlement price |
 | settlement_held_time | google.protobuf.Timestamp | Time of held settlement | | settlement_held_time | google.protobuf.Timestamp | Time of held settlement |
 | settlement_held_trade_date | google.protobuf.Timestamp | Trade date of held settlement | | settlement_held_trade_date | google.protobuf.Timestamp | Trade date of held settlement |
Line 1147: Line 1147:
 ==== DepthLevels ==== ==== DepthLevels ====
  
-The ''DepthLevels'' enum defines possible depth level values.+The ''DepthLevels'' enum defines the number of price depth levels returned per update.
  
-^ Value ^ Description ^ +This setting controls how much market depth data is received. Higher levels increase bandwidth usage, so it is recommended to use the lowest level required on a per-market basis.
-| DEPTH_LEVELS_UNDEFINED | Undefined depth levels +
-| DEPTH_LEVELS_BEST_ONLY | Best price only | +
-| DEPTH_LEVELS_NORMAL | Normal depth levels (10) | +
-| DEPTH_LEVELS_ALL | All depth levels (255) |+
  
 +^ Value ^ Description ^
 +| DEPTH_LEVELS_UNDEFINED | Undefined. Not used by the API. |
 +| DEPTH_LEVELS_BEST_ONLY | Best bid/offer and trade information only. |
 +| DEPTH_LEVELS_NORMAL | Up to 10 levels of depth plus trade information. |
 +| DEPTH_LEVELS_ALL | All available depth levels plus trade information (typically capped at 10 levels). |
 ==== LoginResult ==== ==== LoginResult ====
  
  • developers/websocket/messages.1776888248.txt.gz
  • Last modified: 2026/04/22 20:04
  • by frank