Channels

Authenticate the WebSocket connection

Must be called before accessing protected subscriptions (position, order, createorder, cancelorder)

Subscribe to trade/fill notifications for a symbol

Subscribe to order book updates at specified precision

Subscribe to OHLCV candle data at specified interval

Subscribe to price updates for one or more symbols

Subscribe to real-time price updates for specified symbols. When subscribing to all symbols (empty symbols array), updates are batched at the configured throttle interval (`ws_price_update_throttle_interval_ms`). At each interval, the handler sends the latest price update for each symbol that has changed since the last batch. CASH_ASSET and CASH_DEBT feeds are excluded from price subscriptions as they are internal system feeds.

Subscribe to summary updates for one or more symbols

Subscribe to real-time market summary updates (24h volume, open interest, funding rate, best bid/offer, etc.) for specified symbols. When subscribing to all symbols (empty symbols array), updates are batched at the same throttle interval as price (`ws_price_update_throttle_interval_ms`). CASH_ASSET and CASH_DEBT feeds are excluded.

Subscribe to position updates for an account (requires authentication, supports delegation)

Subscribe to order updates for an account, symbol, and order type (requires authentication, supports delegation)

Subscribe to fill updates for an account, subaccount, and symbol (requires authentication, supports delegation)

Subscribe to account stats (requires authentication, supports delegation)

Subscribe to account statistics (UPnL, cross leverage, maintenance margin, account value, free collateral, etc.). Updates are published at a fixed interval (every 5 seconds). Supports delegation - users can subscribe to accounts they are delegated to access.

Create a new order (requires authentication)

Uses the 'create' method with type 'order' to submit a new order to the matching engine

Cancel an existing order (requires authentication)

Uses the 'cancel' method with type 'order' to cancel an existing order. Provide either orderId or both clientId and account (required if orderId is not provided).

Cancel a batch of orders (requires authentication)

Uses the 'cancel' method with type 'batchOrders' to cancel multiple orders in one request. Provide either orderIds or both account and clientIds (required together). Cannot mix orderIds with account/clientIds.

Create a batch of orders (requires authentication)

Uses the 'create' method with type 'batchOrders' to submit multiple orders to the matching engine. Supports batch Limit orders, TWAP orders and Iceberg orders All orders in the batch must have the same: - account - subaccountIndex - symbol - orderType - period (if applicable) - side (buy or sell) For TWAP orders, the quantity of each order should be set such that the sum equals the total desired quantity. TWAPs must specify a nonzero period (in milliseconds) between orders. For Iceberg orders, the quantity of each order should be set to the desired display quantity.

Unsubscribe from trade notifications

Stops receiving trade updates for the specified symbol

Unsubscribe from order book updates

Stops receiving order book updates for the specified symbol

Unsubscribe from candle data

Stops receiving candle data for the specified symbol and interval

Unsubscribe from price updates

Stops receiving price updates for the specified symbols

Unsubscribe from summary updates

Stops receiving summary updates for the specified symbols

Unsubscribe from position updates (requires authentication)

Stops receiving position updates for the specified account

Unsubscribe from order updates (requires authentication)

Stops receiving order updates for the specified account, symbol, and order type

Unsubscribe from fill updates (requires authentication)

Stops receiving fill updates for the specified account, subaccount, and symbol

Unsubscribe from stats updates (requires authentication)

Stops receiving stats updates for the specified account and subaccount

Subscribe to account transfer updates (requires authentication, supports delegation)

Subscribe to real-time account transfer updates (deposits, withdrawals, transfers, fees, etc.) for GET account/transfers. Uses the Spacetime account_transfers table. Requires account and subaccount index.

Unsubscribe from transfer updates (requires authentication)

Stops receiving transfer updates for the specified account

Subscribe to balance updates for an account (requires authentication, supports delegation)

Subscribe to real-time balance updates for owned or delegated accounts. Can subscribe to all subaccounts or a specific subaccount.

Unsubscribe from balance updates (requires authentication)

Stops receiving balance updates for the specified account