okx-api 2.0.7 → 3.0.0-beta.0

package/dist/mjs/types/websockets/ws-api-request.d.ts

@@ -0,0 +1,61 @@
+import { numberInString, OrderSide, OrderType, PositionSide, TradeMode } from '../rest/shared.js';
+export interface WSAPIPlaceOrderRequestV5 {
+    instId: string;
+    tdMode: TradeMode;
+    ccy?: string;
+    clOrdId?: string;
+    tag?: string;
+    side: OrderSide;
+    posSide?: PositionSide;
+    ordType: OrderType;
+    /** Quantity to buy or sell */
+    sz: numberInString;
+    px?: numberInString;
+    pxUsd?: numberInString;
+    pxVol?: numberInString;
+    reduceOnly?: boolean;
+    /** A spot buy on BTC-USDT with "base_ccy" would mean the QTY (sz) is in USDT */
+    tgtCcy?: 'base_ccy' | 'quote_ccy';
+    banAmend?: boolean;
+    tradeQuoteCcy?: string;
+    stpMode?: 'cancel_maker' | 'cancel_taker' | 'cancel_both';
+}
+export interface WSAPIAmendOrderRequestV5 {
+    instId: string;
+    cxlOnFail?: boolean;
+    ordId?: string;
+    clOrdId?: string;
+    reqId?: string;
+    newSz?: string;
+    newPx?: string;
+    newPxUsd?: string;
+    newPxVol?: string;
+}
+export interface WSAPIMassCancelOrdersRequestV5 {
+    instType: string;
+    instFamily: string;
+    lockInterval?: string;
+}
+export interface WSAPIPlaceSpreadOrderRequestV5 {
+    sprdId: string;
+    clOrdId?: string;
+    tag?: string;
+    side: OrderSide;
+    ordType: OrderType;
+    sz: numberInString;
+    px?: numberInString;
+}
+export interface WSAPIAmendSpreadOrderRequestV5 {
+    ordId?: string;
+    clOrdId?: string;
+    reqId?: string;
+    newSz?: string;
+    newPx?: string;
+}
+export interface WSAPICancelSpreadOrderRequestV5 {
+    ordId?: string;
+    clOrdId?: string;
+}
+export interface WSAPISpreadMassCancelOrdersRequestV5 {
+    sprdId?: string;
+}

package/dist/mjs/types/websockets/ws-api-request.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ws-api-request.js.map

package/dist/mjs/types/websockets/ws-api-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-api-request.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-api-request.ts"],"names":[],"mappings":""}

package/dist/mjs/types/websockets/ws-api-response.d.ts

@@ -0,0 +1,28 @@
+import { numberInString } from '../rest/shared.js';
+export interface WSAPICancelOrderResultV5 {
+    clOrdId: string;
+    ordId: string;
+    ts: numberInString;
+    sCode: string;
+    sMsg: string;
+}
+export interface WSAPISpreadPlaceOrderResultV5 {
+    clOrdId: string;
+    ordId: string;
+    tag: string;
+    sCode: numberInString;
+    sMsg: string;
+}
+export interface WSAPISpreadAmendOrderResultV5 {
+    clOrdId: string;
+    ordId: string;
+    reqId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface WSAPISpreadCancelOrderResultV5 {
+    clOrdId: string;
+    ordId: string;
+    sCode: string;
+    sMsg: string;
+}

package/dist/mjs/types/websockets/ws-api-response.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ws-api-response.js.map

package/dist/mjs/types/websockets/ws-api-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-api-response.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-api-response.ts"],"names":[],"mappings":""}

package/dist/mjs/types/websockets/ws-api.d.ts

@@ -0,0 +1,139 @@
+import { WS_KEY_MAP, WsKey } from '../../util/websocket-util.js';
+import { OrderIdRequest } from '../rest/request/trade.js';
+import { OrderResult } from '../rest/response/private-trade.js';
+import { numberInString } from '../rest/shared.js';
+import { WSAPIAmendOrderRequestV5, WSAPIAmendSpreadOrderRequestV5, WSAPICancelSpreadOrderRequestV5, WSAPIMassCancelOrdersRequestV5, WSAPIPlaceOrderRequestV5, WSAPIPlaceSpreadOrderRequestV5, WSAPISpreadMassCancelOrdersRequestV5 } from './ws-api-request.js';
+import { WSAPICancelOrderResultV5, WSAPISpreadAmendOrderResultV5, WSAPISpreadCancelOrderResultV5, WSAPISpreadPlaceOrderResultV5 } from './ws-api-response.js';
+import { WsAuthRequestArg, WsChannelSubUnSubRequestArg } from './ws-request.js';
+export interface WSAPIRequestFlags {
+    /** If true, will skip auth requirement for WS API connection */
+    authIsOptional?: boolean | undefined;
+    /**
+     * Request effective deadline. Unix timestamp format in milliseconds, e.g. 1597026383085
+     *
+     * Only applies for order placement and order amend (batch commands included)
+     */
+    expTime?: numberInString;
+}
+export type WSOperation = 'subscribe' | 'unsubscribe' | 'login';
+/**
+ *
+ * Top level requests with args
+ *
+ */
+/**
+
+/**
+ * request looks like this:
+{
+  "id": "1512",
+  "op": "subscribe",
+  "args": [
+    {
+      "channel": "tickers",
+      "instId": "BTC-USDT"
+    }
+  ]
+}
+ */
+export interface WsRequestOperationOKX<TWSRequestArg> {
+    id: string;
+    op: WSOperation;
+    args?: TWSRequestArg[];
+}
+export interface WsSubRequest extends WsRequestOperationOKX<WsChannelSubUnSubRequestArg> {
+    op: 'subscribe';
+}
+export interface WsUnsubRequest extends WsRequestOperationOKX<WsChannelSubUnSubRequestArg> {
+    op: 'unsubscribe';
+}
+export interface WsAuthRequest extends WsRequestOperationOKX<WsAuthRequestArg> {
+    op: 'login';
+}
+export type WSAPIPrivateOperations = 'order' | 'batch-orders' | 'cancel-order' | 'batch-cancel-orders' | 'amend-order' | 'batch-amend-orders' | 'mass-cancel';
+export type WSAPIBusinessOperations = 'sprd-order' | 'sprd-amend-order' | 'sprd-cancel-order' | 'sprd-mass-cancel';
+export type WSAPIOperation = WSAPIPrivateOperations | WSAPIBusinessOperations;
+export declare const WS_API_Operations: WSAPIOperation[];
+export declare const WS_API_PRIVATE_OPERATIONS: WSAPIPrivateOperations[];
+export declare const WS_API_BUSINESS_OPERATIONS: WSAPIBusinessOperations[];
+export declare const WS_API_TAG_OPERATIONS: WSAPIOperation[];
+export interface WSAPIRequestOKX<TRequestParams> {
+    id: numberInString;
+    op: WSAPIOperation;
+    expTime?: numberInString;
+    args: TRequestParams[];
+}
+export interface WSAPIResponse<TResponseData extends object = object, TOperation extends WSAPIOperation = WSAPIOperation> {
+    wsKey: WsKey;
+    id: numberInString;
+    op: TOperation;
+    code: numberInString;
+    msg: string;
+    data: TResponseData[];
+    inTime: numberInString;
+    outTime: numberInString;
+}
+export interface WSOperationLoginParams {
+    apiKey: string;
+    passphrase: string;
+    timestamp: number;
+    sign: string;
+}
+export type Exact<T> = {
+    [K: string]: never;
+} & {
+    [K in keyof T]: T[K];
+};
+/**
+ * List of operations supported for this WsKey (connection)
+ */
+export interface WsAPIWsKeyTopicMap {
+    [WS_KEY_MAP.prodPrivate]: WSAPIPrivateOperations;
+    [WS_KEY_MAP.prodDemoPrivate]: WSAPIPrivateOperations;
+    [WS_KEY_MAP.prodBusiness]: WSAPIBusinessOperations;
+    [WS_KEY_MAP.prodDemoBusiness]: WSAPIBusinessOperations;
+    [WS_KEY_MAP.eeaLivePrivate]: WSAPIPrivateOperations;
+    [WS_KEY_MAP.eeaDemoPrivate]: WSAPIPrivateOperations;
+    [WS_KEY_MAP.usLivePrivate]: WSAPIPrivateOperations;
+    [WS_KEY_MAP.usDemoPrivate]: WSAPIPrivateOperations;
+}
+/**
+ * Request parameters expected per operation
+ */
+export interface WsAPITopicRequestParamMap {
+    order: WSAPIPlaceOrderRequestV5;
+    'batch-orders': WSAPIPlaceOrderRequestV5[];
+    'cancel-order': OrderIdRequest;
+    'batch-cancel-orders': OrderIdRequest[];
+    'amend-order': WSAPIAmendOrderRequestV5;
+    'batch-amend-orders': WSAPIAmendOrderRequestV5[];
+    'mass-cancel': WSAPIMassCancelOrdersRequestV5;
+    'sprd-order': WSAPIPlaceSpreadOrderRequestV5;
+    'sprd-amend-order': WSAPIAmendSpreadOrderRequestV5;
+    'sprd-cancel-order': WSAPICancelSpreadOrderRequestV5;
+    'sprd-mass-cancel': WSAPISpreadMassCancelOrdersRequestV5;
+}
+/**
+ * Response structure expected for each operation
+ */
+export interface WsAPIOperationResponseMap {
+    order: WSAPIResponse<[OrderResult], 'order'>;
+    'batch-orders': WSAPIResponse<OrderResult[], 'batch-orders'>;
+    'cancel-order': WSAPIResponse<[WSAPICancelOrderResultV5], 'cancel-order'>;
+    'batch-cancel-orders': WSAPIResponse<WSAPICancelOrderResultV5[], 'batch-cancel-orders'>;
+    'amend-order': WSAPIResponse<[OrderResult], 'amend-order'>;
+    'batch-amend-orders': WSAPIResponse<[OrderResult], 'batch-amend-orders'>;
+    'mass-cancel': WSAPIResponse<[{
+        result: boolean;
+    }], 'mass-cancel'>;
+    'sprd-order': WSAPIResponse<[WSAPISpreadPlaceOrderResultV5], 'sprd-order'>;
+    'sprd-amend-order': WSAPIResponse<[
+        WSAPISpreadAmendOrderResultV5
+    ], 'sprd-amend-order'>;
+    'sprd-cancel-order': WSAPIResponse<[
+        WSAPISpreadCancelOrderResultV5
+    ], 'sprd-cancel-order'>;
+    'sprd-mass-cancel': WSAPIResponse<[{
+        result: boolean;
+    }], 'sprd-mass-cancel'>;
+}

package/dist/mjs/types/websockets/ws-api.js

@@ -0,0 +1,35 @@
+import { WS_KEY_MAP } from '../../util/websocket-util.js';
+export const WS_API_Operations = [
+    'order',
+    'batch-orders',
+    'cancel-order',
+    'batch-cancel-orders',
+    'amend-order',
+    'batch-amend-orders',
+    'mass-cancel',
+    'sprd-order',
+    'sprd-amend-order',
+    'sprd-cancel-order',
+    'sprd-mass-cancel',
+];
+export const WS_API_PRIVATE_OPERATIONS = [
+    'order',
+    'batch-orders',
+    'cancel-order',
+    'batch-cancel-orders',
+    'amend-order',
+    'batch-amend-orders',
+    'mass-cancel',
+];
+export const WS_API_BUSINESS_OPERATIONS = [
+    'sprd-order',
+    'sprd-amend-order',
+    'sprd-cancel-order',
+    'sprd-mass-cancel',
+];
+export const WS_API_TAG_OPERATIONS = [
+    'order',
+    'batch-orders',
+    'sprd-order',
+];
+//# sourceMappingURL=ws-api.js.map

package/dist/mjs/types/websockets/ws-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-api.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAS,MAAM,8BAA8B,CAAC;AAwGjE,MAAM,CAAC,MAAM,iBAAiB,GAAqB;IACjD,OAAO;IACP,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,aAAa;IACb,oBAAoB;IACpB,aAAa;IACb,YAAY;IACZ,kBAAkB;IAClB,mBAAmB;IACnB,kBAAkB;CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAA6B;IACjE,OAAO;IACP,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,aAAa;IACb,oBAAoB;IACpB,aAAa;CACd,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAA8B;IACnE,YAAY;IACZ,kBAAkB;IAClB,mBAAmB;IACnB,kBAAkB;CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAqB;IACrD,OAAO;IACP,cAAc;IACd,YAAY;CACb,CAAC"}

package/dist/mjs/types/websockets/ws-events.d.ts

@@ -0,0 +1,33 @@
+import { WsChannel } from './ws-request.js';
+export interface MessageEventLike {
+    target: WebSocket;
+    type: 'message';
+    data: string;
+}
+export declare function isMessageEvent(msg: unknown): msg is MessageEventLike;
+export interface WsEvent {
+    event: 'error' | 'login' | 'subscribe' | 'unsubscribe' | 'channel-conn-count';
+    code?: string;
+    msg?: string;
+    arg?: any;
+    data?: any;
+}
+export interface WsDataEvent<T = any> {
+    arg: {
+        channel: WsChannel;
+        uid?: string;
+        instId?: string;
+        instFamily?: string;
+    };
+    data: T;
+}
+export interface WsLoginEvent extends WsEvent {
+    event: 'login';
+}
+export interface WsChannelConnInfoEvent extends WsEvent {
+    event: 'channel-conn-count';
+    channel: string;
+    connId: string;
+    connCount: string;
+}
+export type WsResponse = WsEvent;

package/dist/mjs/types/websockets/ws-events.js

@@ -0,0 +1,8 @@
+export function isMessageEvent(msg) {
+    if (typeof msg !== 'object' || !msg) {
+        return false;
+    }
+    const message = msg;
+    return message['type'] === 'message' && typeof message['data'] === 'string';
+}
+//# sourceMappingURL=ws-events.js.map

package/dist/mjs/types/websockets/ws-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-events.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-events.ts"],"names":[],"mappings":"AAQA,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,GAAuB,CAAC;IACxC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC;AAC9E,CAAC"}

package/dist/mjs/types/websockets/ws-general.d.ts

@@ -0,0 +1,48 @@
+import { RestClientOptions } from '../rest/client.js';
+import { APICredentials, APIMarket } from '../shared.js';
+export interface WSClientConfigurableOptions {
+    accounts?: APICredentials[];
+    /**
+     * The API group this client should connect to:
+     * - market: 'prod' (default: connects to OKX global) https://www.okx.com/docs-v5/en/#overview-production-trading-services
+     * - market: 'EEA' // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
+     * - market: 'US' // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
+     */
+    market?: APIMarket;
+    /**
+     * Set to `true` to use OKX's demo trading functionality
+     */
+    demoTrading?: boolean;
+    disableHeartbeat?: boolean;
+    /** How often to check if the connection is alive */
+    pingInterval?: number;
+    /** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
+    pongTimeout?: number;
+    /** Delay in milliseconds before respawning the connection */
+    reconnectTimeout?: number;
+    requestOptions?: RestClientOptions;
+    wsOptions?: {
+        protocols?: string[];
+        agent?: any;
+    };
+    wsUrl?: string;
+    /**
+     * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
+     *
+     * Look in the examples folder for a demonstration on using node's createHmac instead.
+     */
+    customSignMessageFn?: (message: string, secret: string) => Promise<string>;
+}
+export interface WebsocketClientOptions extends WSClientConfigurableOptions {
+    market: APIMarket;
+    pongTimeout: number;
+    pingInterval: number;
+    reconnectTimeout: number;
+    authPrivateConnectionsOnConnect: boolean;
+    authPrivateRequests: boolean;
+    /**
+     * Whether to use native WebSocket ping/pong frames for heartbeats
+     */
+    useNativeHeartbeats: boolean;
+}
+export type WsEventInternalSrc = 'event' | 'function';

package/dist/mjs/types/websockets/ws-general.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ws-general.js.map

package/dist/mjs/types/websockets/ws-general.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-general.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-general.ts"],"names":[],"mappings":""}

package/dist/mjs/types/websockets/ws-request.d.ts

@@ -0,0 +1,93 @@
+export interface WsAuthRequestArg {
+    apiKey: string;
+    passphrase: string;
+    timestamp: string;
+    sign: string;
+}
+export type WsTradeOp = 'order' | 'batch-orders' | 'cancel-order' | 'batch-cancel-orders' | 'amend-order' | 'batch-amend-order';
+export type WsPrivateChannel = 'account' | 'positions' | 'balance_and_position' | 'orders' | 'orders-algo' | 'algo-advance' | 'liquidation-warning' | 'account-greeks' | 'grid-orders-spot' | 'grid-orders-contract' | 'grid-orders-moon' | 'grid-positions' | 'grid-sub-orders';
+export type WsPublicKlineChannel = 'candle1Y' | 'candle6M' | 'candle3M' | 'candle1M' | 'candle1W' | 'candle1D' | 'candle2D' | 'candle3D' | 'candle5D' | 'candle12H' | 'candle6H' | 'candle4H' | 'candle2H' | 'candle1H' | 'candle30m' | 'candle15m' | 'candle5m' | 'candle3m' | 'candle1m' | 'candle1s' | 'candle1Yutc' | 'candle3Mutc' | 'candle1Mutc' | 'candle1Wutc' | 'candle1Dutc' | 'candle2Dutc' | 'candle3Dutc' | 'candle5Dutc' | 'candle12Hutc' | 'candle6Hutc';
+export type WsPublicMarkPriceKlineChannel = 'mark-price-candle1Y' | 'mark-price-candle6M' | 'mark-price-candle3M' | 'mark-price-candle1M' | 'mark-price-candle1W' | 'mark-price-candle1D' | 'mark-price-candle2D' | 'mark-price-candle3D' | 'mark-price-candle5D' | 'mark-price-candle12H' | 'mark-price-candle6H' | 'mark-price-candle4H' | 'mark-price-candle2H' | 'mark-price-candle1H' | 'mark-price-candle30m' | 'mark-price-candle15m' | 'mark-price-candle5m' | 'mark-price-candle3m' | 'mark-price-candle1m' | 'mark-price-candle1Yutc' | 'mark-price-candle3Mutc' | 'mark-price-candle1Mutc' | 'mark-price-candle1Wutc' | 'mark-price-candle1Dutc' | 'mark-price-candle2Dutc' | 'mark-price-candle3Dutc' | 'mark-price-candle5Dutc' | 'mark-price-candle12Hutc' | 'mark-price-candle6Hutc';
+export type WsPublicIndexKlineChannel = 'index-candle1Y' | 'index-candle6M' | 'index-candle3M' | 'index-candle1M' | 'index-candle1W' | 'index-candle1D' | 'index-candle2D' | 'index-candle3D' | 'index-candle5D' | 'index-candle12H' | 'index-candle6H' | 'index-candle4H index -candle2H' | 'index-candle1H' | 'index-candle30m' | 'index-candle15m' | 'index-candle5m' | 'index-candle3m' | 'index-candle1m' | 'index-candle1Yutc' | 'index-candle3Mutc' | 'index-candle1Mutc' | 'index-candle1Wutc' | 'index-candle1Dutc' | 'index-candle2Dutc' | 'index-candle3Dutc' | 'index-candle5Dutc' | 'index-candle12Hutc' | 'index-candle6Hutc';
+export type WsPublicOrderBooksChannel = 'books' | 'books5' | 'bbo-tbt' | 'books-l2-tbt' | 'books50-l2-tpt';
+export type WsPublicChannel = 'instruments' | 'tickers' | 'open-interest' | WsPublicKlineChannel | WsPublicMarkPriceKlineChannel | WsPublicIndexKlineChannel | 'trades' | 'estimated-price' | 'mark-price' | 'price-limit' | WsPublicOrderBooksChannel | 'opt-summary' | 'funding-rate' | 'index-tickers' | 'status' | 'liquidation-orders';
+export type WsBusinessPrivateChannel = 'orders-algo' | 'algo-advance' | 'deposit-info' | 'withdrawal-info' | 'grid-orders-spot' | 'grid-orders-contract' | 'grid-orders-moon' | 'grid-positions' | 'grid-sub-orders' | 'algo-recurring-buy';
+export type WsBusinessPublicChannel = WsPublicKlineChannel | WsPublicMarkPriceKlineChannel | WsPublicIndexKlineChannel;
+export type WsBusinessChannel = WsBusinessPrivateChannel | WsBusinessPublicChannel;
+export type WsChannel = WsPublicChannel | WsPrivateChannel | WsBusinessChannel;
+/** Used to trigger order actions over websockets (e.g. placing & cancelling orders) */
+export interface WsTradeBaseRequest {
+    op: WsTradeOp;
+    id: string;
+    args: any[];
+}
+export interface WsBaseRequestArg {
+    channel: WsChannel;
+}
+/**
+ *
+ * Args to be sent with top level requests
+ *
+ */
+export interface WsPrivateChannelArgTickers extends WsBaseRequestArg {
+    channel: 'tickers';
+    instId: string;
+}
+export interface WsPrivateChannelArgWithCcy extends WsBaseRequestArg {
+    channel: 'account' | 'account-greeks' | 'withdrawal-info';
+    ccy?: string;
+}
+export type WsChannelArgInstType = 'SPOT' | 'MARGIN' | 'SWAP' | 'FUTURES' | 'OPTION' | 'ANY';
+export interface WsPrivateChannelArgWithInstFamily extends WsBaseRequestArg {
+    channel: 'positions' | 'orders' | 'orders-algo' | 'liquidation-warning';
+    instType: WsChannelArgInstType;
+    instFamily?: string;
+    instId?: string;
+}
+export interface WsPrivateChannelArgAlgo extends WsBaseRequestArg {
+    channel: 'algo-advance';
+    instType: WsChannelArgInstType;
+    instId?: string;
+    algoId?: string;
+}
+export interface WsPrivateChannelArgBalanceAndPosition extends WsBaseRequestArg {
+    channel: 'balance_and_position';
+}
+export interface WsPrivateChannelArgGridOrders extends WsBaseRequestArg {
+    channel: 'grid-orders-spot' | 'grid-orders-contract' | 'grid-orders-moon';
+    instType: 'SPOT' | 'ANY';
+    instId?: string;
+    algoId?: string;
+}
+export interface WsPrivateChannelArgGridOther extends WsBaseRequestArg {
+    channel: 'grid-positions' | 'grid-sub-orders';
+    algoId: string;
+}
+export interface WsPublicChannelArgInstType extends WsBaseRequestArg {
+    channel: 'instruments';
+    instType: WsChannelArgInstType;
+}
+export interface WsPublicChannelArgInstId extends WsBaseRequestArg {
+    channel: 'tickers' | 'open-interest' | WsPublicKlineChannel | WsPublicMarkPriceKlineChannel | WsPublicIndexKlineChannel | 'trades' | 'mark-price' | 'price-limit' | WsPublicOrderBooksChannel | 'funding-rate' | 'index-tickers';
+    instId: string;
+}
+export type WsPublicChannelArgInstIdOrFamily = {
+    channel: 'estimated-price';
+    instType: 'OPTION' | 'FUTURES';
+} & ({
+    instId: string;
+} | {
+    instFamily: string;
+});
+export interface WsPublicChannelArgOptionSummary extends WsBaseRequestArg {
+    channel: 'opt-summary';
+    instFamily: string;
+}
+export interface WsPublicChannelArgStatus extends WsBaseRequestArg {
+    channel: 'status';
+}
+export interface WsPublicChannelArgLiquidationOrders extends WsBaseRequestArg {
+    channel: 'liquidation-orders';
+    instType: 'SWAP' | 'FUTURES';
+}
+export type WsChannelSubUnSubRequestArg = WsPrivateChannelArgTickers | WsPrivateChannelArgWithCcy | WsPrivateChannelArgWithInstFamily | WsPrivateChannelArgAlgo | WsPrivateChannelArgBalanceAndPosition | WsPrivateChannelArgGridOrders | WsPrivateChannelArgGridOther | WsPublicChannelArgInstType | WsPublicChannelArgInstId | WsPublicChannelArgInstIdOrFamily | WsPublicChannelArgOptionSummary | WsPublicChannelArgStatus | WsPublicChannelArgLiquidationOrders;

package/dist/mjs/types/websockets/ws-request.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ws-request.js.map

package/dist/mjs/types/websockets/ws-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-request.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-request.ts"],"names":[],"mappings":""}

package/dist/mjs/util/BaseRestClient.d.ts

@@ -0,0 +1,29 @@
+import { AxiosRequestConfig } from 'axios';
+import { RestClientOptions } from '../types/rest/client.js';
+export declare const MISSING_CREDENTIALS_ERROR = "Private endpoints require api and secret to be provided in the REST client constructor";
+export default abstract class BaseRestClient {
+    private options;
+    private baseUrl;
+    private globalRequestOptions;
+    private apiKey;
+    private apiSecret;
+    private apiPassphrase;
+    constructor(options?: RestClientOptions, requestOptions?: AxiosRequestConfig);
+    get(endpoint: string, params?: any): Promise<any>;
+    post(endpoint: string, params?: any): Promise<any>;
+    getPrivate(endpoint: string, params?: any): Promise<any>;
+    postPrivate(endpoint: string, params?: any): Promise<any>;
+    deletePrivate(endpoint: string, params?: any): Promise<any>;
+    /**
+     * Make a HTTP request to a specific endpoint. Private endpoints are automatically signed.
+     */
+    private _call;
+    /**
+     * Sign request
+     */
+    private signRequest;
+    /**
+     * Generic handler to parse request exceptions
+     */
+    private parseException;
+}