Enumeration SubscriptionName

A combination of SubscriptionNameAuthenticated and SubscriptionNamePublic provided as a convenience.

Generally using the separated enums is useful as it makes it obvious which subscriptions are accepted by the WebSocketClient.subscribeAuthenticated and WebSocketClient.subscribePublic methods.

See

related SubscriptionNameAuthenticated
related SubscriptionNamePublic

Index

Enumeration Members

deposits fundingPayments orders positions withdrawals tickers trades liquidations candles l1orderbook l2orderbook

Enumeration Members

deposits

deposits: "deposits"

Subscription Update Events:

Receives KumaDepositEvent WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaDepositEventData

fundingPayments

fundingPayments: "fundingPayments"

Subscription Update Events:

Receives KumaFundingPaymentEvent WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaFundingPaymentEventData

orders

orders: "orders"

Subscription Update Events:

Receives KumaOrderEvent WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaOrderEventData

positions

positions: "positions"

Subscription Update Events:

Receives KumaPositionEvent WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaPositionEventData

withdrawals

withdrawals: "withdrawals"

Subscription Update Events:

Receives KumaWithdrawalEvent WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaWithdrawalEventData

tickers

tickers: "tickers"

Subscribe Requirements:

Requires a markets array to subscribe to.

Subscription Update Events:

Receives KumaTickerEvent WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaTickerEventData

trades

trades: "trades"

Subscribe Requirements:

Requires a markets array to subscribe to.

Subscription Update Events:

Receives KumaTradeEvent WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaTradeEventData

liquidations

liquidations: "liquidations"

Subscribe Requirements:

Requires a markets array to subscribe to.

Subscription Update Events:

Receives KumaLiquidationEvent WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaLiquidationEventData

candles

candles: "candles"

Subscribe Requirements:

Requires a markets array to subscribe to.
Requires a CandleInterval property

Subscription Update Events:

Receives KumaCandleEvent WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaCandleEventData

l1orderbook

l1orderbook: "l1orderbook"

Subscribe Requirements:

Requires a markets array to subscribe to.

Subscription Update Events:

Receives KumaOrderBookLevel1Event WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaOrderBookLevel1EventData

l2orderbook

l2orderbook: "l2orderbook"

Subscribe Requirements:

Requires a markets array to subscribe to.

Subscription Update Events:

Receives KumaOrderBookLevel2Event WebSocket updates via the WebSocketClient.onMessage handler.
event.data will match KumaOrderBookLevel2EventData

Enumeration SubscriptionName

See

Index

Enumeration Members

Enumeration Members

deposits

fundingPayments

orders

positions

withdrawals

tickers

trades

liquidations

candles

l1orderbook

l2orderbook

Settings

Member Visibility

Theme

On This Page