Interface WebSocketRequestUnsubscribe

UnsubscribeRequest

  • When removing a subscription, you need only provide the name of the subscription rather than a complete subscription object.
interface WebSocketRequestUnsubscribe {
    method: "unsubscribe";
    cid?: string;
    markets?: string[];
    subscriptions?: ("deposits" | "fundingPayments" | "orders" | "positions" | "withdrawals" | "webclient" | "tickers" | "trades" | "liquidations" | "candles" | "l1orderbook" | "l2orderbook" | Partial<KumaSubscribeOrders> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribeDeposits> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribeWithdrawals> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribePositions> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribeFundingPayments> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribeWebClient> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribeTickers> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribeTrades> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribeLiquidations> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribeOrderBookLevel1> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribeOrderBookLevel2> & {
        name: WebSocketRequestUnsubscribeShortNames;
    } | Partial<KumaSubscribeCandles> & {
        name: WebSocketRequestUnsubscribeShortNames;
    })[];
}

Hierarchy (view full)

Properties

method cid? markets? subscriptions?

Properties

method

method: "unsubscribe"

The request that is being made matching the enum WebSocketRequestMethod

Optional cid

cid?: string

Requests may optionally provide a cid parameter to identify the request a response should be associated with.

  • When provided, the onResponse callback object will include the provided cid as a property.

Optional markets

markets?: string[]

A top-level markets array can be used to allow multiple subscriptions to inherit this array without having define them themselves.

  • When a subscription does not define the markets parameter, it will inherit the top-level markets array provided here.

Optional subscriptions

subscriptions?: ("deposits" | "fundingPayments" | "orders" | "positions" | "withdrawals" | "webclient" | "tickers" | "trades" | "liquidations" | "candles" | "l1orderbook" | "l2orderbook" | Partial<KumaSubscribeOrders> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribeDeposits> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribeWithdrawals> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribePositions> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribeFundingPayments> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribeWebClient> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribeTickers> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribeTrades> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribeLiquidations> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribeOrderBookLevel1> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribeOrderBookLevel2> & {
    name: WebSocketRequestUnsubscribeShortNames;
} | Partial<KumaSubscribeCandles> & {
    name: WebSocketRequestUnsubscribeShortNames;
})[]

An array of subscription objects to unsubscribe from

Settings

Member Visibility

Theme

On This Page

methodcidmarketssubscriptions