bybit-api 3.10.0 → 3.10.2

package/lib/rest-client-v5.js

@@ -31,7 +31,7 @@ class RestClientV5 extends BaseRestClient_1.default {
         });
     }
     getServerTime() {
-        return this.get('/v3/public/time');
+        return this.get('/v5/market/time');
     }
     requestDemoTradingFunds() {
         return this.postPrivate('/v5/account/demo-apply-money');

package/lib/types/response/v5-position.d.ts

@@ -1,19 +1,19 @@
-import { CategoryV5, ExecTypeV5, OrderSideV5, OrderTypeV5, PositionIdx, StopOrderTypeV5, TPSLModeV5, TradeModeV5 } from '../v5-shared';
+import { CategoryV5, ExecTypeV5, OrderSideV5, OrderTypeV5, PositionIdx, PositionSideV5, PositionStatusV5, StopOrderTypeV5, TPSLModeV5, TradeModeV5 } from '../v5-shared';
 export interface PositionV5 {
     positionIdx: PositionIdx;
     riskId: number;
     riskLimitValue: string;
     symbol: string;
-    side: 'Buy' | 'Sell' | 'None';
+    side: PositionSideV5;
     size: string;
     avgPrice: string;
     positionValue: string;
     tradeMode: TradeModeV5;
     autoAddMargin?: number;
-    positionStatus: 'Normal' | 'Liq' | 'Adl';
+    positionStatus: PositionStatusV5;
     leverage?: string;
     markPrice: string;
-    liqPrice: string;
+    liqPrice: string | '';
     bustPrice?: string;
     positionIM?: string;
     positionMM?: string;
@@ -21,10 +21,21 @@ export interface PositionV5 {
     takeProfit?: string;
     stopLoss?: string;
     trailingStop?: string;
+    sessionAvgPrice: string | '';
+    delta?: string;
+    gamma?: string;
+    vega?: string;
+    theta?: string;
     unrealisedPnl: string;
+    curRealisedPnl: string;
     cumRealisedPnl: string;
+    adlRankIndicator: number;
+    isReduceOnly: boolean;
+    mmrSysUpdatedTime: string | '';
+    leverageSysUpdatedTime: string | '';
     createdTime: string;
     updatedTime: string;
+    seq: number;
 }
 export interface SetRiskLimitResultV5 {
     category: CategoryV5;
@@ -45,7 +56,7 @@ export interface AddOrReduceMarginResultV5 {
     positionValue: string;
     leverage: string;
     autoAddMargin: 0 | 1;
-    positionStatus: 'Normal' | 'Liq' | 'Adl';
+    positionStatus: PositionStatusV5;
     positionIM: string;
     positionMM: string;
     takeProfit: string;

package/lib/types/v5-shared.d.ts

@@ -63,7 +63,9 @@ export type OrderCreateTypeV5 =
 /** Order created by Ice berg strategy - web/app. */
  | 'CreateByIceBerg'
 /** Order created by arbitrage - web/app. */
- | 'CreateByArbitrage';
+ | 'CreateByArbitrage'
+/** Option dynamic delta hedge order - web/app */
+ | 'CreateByDdh';
 export type OrderCancelTypeV5 = 'CancelByUser' | 'CancelByReduceOnly' | 'CancelByPrepareLiq' | 'CancelAllBeforeLiq' | 'CancelByPrepareAdl' | 'CancelAllBeforeAdl' | 'CancelByAdmin' | 'CancelByTpSlTsClear' | 'CancelByPzSideCh' | 'UNKNOWN';
 export type OrderRejectReasonV5 = 'EC_NoError' | 'EC_Others' | 'EC_UnknownMessageType' | 'EC_MissingClOrdID' | 'EC_MissingOrigClOrdID' | 'EC_ClOrdIDOrigClOrdIDAreTheSame' | 'EC_DuplicatedClOrdID' | 'EC_OrigClOrdIDDoesNotExist' | 'EC_TooLateToCancel' | 'EC_UnknownOrderType' | 'EC_UnknownSide' | 'EC_UnknownTimeInForce' | 'EC_WronglyRouted' | 'EC_MarketOrderPriceIsNotZero' | 'EC_LimitOrderInvalidPrice' | 'EC_NoEnoughQtyToFill' | 'EC_NoImmediateQtyToFill' | 'EC_PerCancelRequest' | 'EC_MarketOrderCannotBePostOnly' | 'EC_PostOnlyWillTakeLiquidity' | 'EC_CancelReplaceOrder' | 'EC_InvalidSymbolStatus';
 export type StopOrderTypeV5 = 'TakeProfit' | 'StopLoss' | 'TrailingStop' | 'Stop' | 'PartialTakeProfit' | 'PartialStopLoss' | 'tpslOrder';
@@ -75,6 +77,15 @@ export type StopOrderTypeV5 = 'TakeProfit' | 'StopLoss' | 'TrailingStop' | 'Stop
  * - 2 Sell side of hedge-mode position
  */
 export type PositionIdx = 0 | 1 | 2;
+/**
+ * Position status.
+ *
+ * - 'Normal'
+ * - 'Liq' in the liquidation progress
+ * - 'Adl' in the auto-deleverage progress
+ */
+export type PositionStatusV5 = 'Normal' | 'Liq' | 'Adl';
+export type PositionSideV5 = 'Buy' | 'Sell' | 'None' | '';
 export type OptionTypeV5 = 'Call' | 'Put';
 /**
  * Trade mode.
@@ -107,7 +118,7 @@ export type LTOrderTypeV5 = '1' | '2';
  * Leveraged token order status: '1': completed, '2': in progress, '3': failed
  */
 export type LTOrderStatusV5 = '1' | '2' | '3';
-export type ExecTypeV5 = 'Trade' | 'AdlTrade' | 'Funding' | 'BustTrade' | 'Settle';
+export type ExecTypeV5 = 'Trade' | 'AdlTrade' | 'Funding' | 'BustTrade' | 'Settle' | 'BlockTrade' | 'MovePosition' | 'UNKNOWN';
 /**
  * Withdraw type. 0(default): on chain. 1: off chain. 2: all.
  */

package/lib/types/websocket.events.d.ts

@@ -1,24 +1,14 @@
-import { CategoryV5, OCOTriggerTypeV5, OrderRejectReasonV5, OrderSMPTypeV5, OrderSideV5, OrderStatusV5, OrderTimeInForceV5, OrderTriggerByV5, OrderTypeV5, StopOrderTypeV5, TPSLModeV5 } from './v5-shared';
+import { CategoryV5, ExecTypeV5, OCOTriggerTypeV5, OrderCancelTypeV5, OrderCreateTypeV5, OrderRejectReasonV5, OrderSMPTypeV5, OrderSideV5, OrderStatusV5, OrderTimeInForceV5, OrderTriggerByV5, OrderTypeV5, PositionIdx, PositionSideV5, PositionStatusV5, StopOrderTypeV5, TPSLModeV5, TradeModeV5 } from './v5-shared';
 import { WsKey } from './websockets';
-export interface WSOrderbookEventV5 {
-    topic: string;
+export interface WSPublicTopicEventV5<TTopic extends string, TType, TData> {
+    id?: string;
+    topic: TTopic;
+    type: TType;
+    /** Cross sequence */
+    cs?: number;
     /** Event timestamp */
     ts: number;
-    type: 'delta' | 'snapshot';
-    data: {
-        /** Symbol */
-        s: string;
-        /** [price, qty][] */
-        b: [string, string][];
-        /** [price, qty][] */
-        a: [string, string][];
-        /** Update ID */
-        u: number;
-        /**
-         * Cross sequence
-         */
-        seq: number;
-    };
+    data: TData;
     /**
      * matching engine timestamp (correlated with T from public trade channel)
      */
@@ -28,56 +18,146 @@ export interface WSOrderbookEventV5 {
      */
     wsKey: WsKey;
 }
-export interface WSAccountOrderV5 {
-    qty: string;
-    price: string;
+export interface WSPrivateTopicEventV5<TTopic extends string, TData> {
+    id?: string;
+    topic: TTopic;
+    creationTime: number;
+    data: TData;
+    wsKey: WsKey;
+}
+export interface WSOrderbookV5 {
+    /** Symbol */
+    s: string;
+    /** [price, qty][] */
+    b: [string, string][];
+    /** [price, qty][] */
+    a: [string, string][];
+    /** Update ID */
+    u: number;
+    /** Cross sequence */
+    seq: number;
+}
+export type WSOrderbookEventV5 = WSPublicTopicEventV5<string, 'delta' | 'snapshot', WSOrderbookV5[]>;
+export interface WSPositionV5 {
+    category: string;
     symbol: string;
-    orderId: string;
-    orderIv: string;
+    side: PositionSideV5;
+    size: string;
+    positionIdx: PositionIdx;
+    tradeMode: TradeModeV5;
+    positionValue: string;
+    riskId: number;
+    riskLimitValue: string;
+    entryPrice: string;
+    markPrice: string;
+    leverage: string;
+    positionBalance: string;
+    autoAddMargin: number;
+    positionMM: string;
+    positionIM: string;
+    liqPrice: string;
+    bustPrice: string;
+    tpslMode: string;
+    takeProfit: string;
     stopLoss: string;
-    smpGroup: number;
+    trailingStop: string;
+    unrealisedPnl: string;
+    curRealisedPnl: string;
+    sessionAvgPrice: string;
+    delta: string;
+    gamma: string;
+    vega: string;
+    theta: string;
+    cumRealisedPnl: string;
+    positionStatus: PositionStatusV5;
+    adlRankIndicator: number;
+    isReduceOnly: boolean;
+    mmrSysUpdatedTime: string;
+    leverageSysUpdatedTime: string;
+    createdTime: string;
+    updatedTime: string;
+    seq: number;
+}
+export type WSPositionEventV5 = WSPrivateTopicEventV5<'position', WSPositionV5[]>;
+export interface WSAccountOrderV5 {
+    category: CategoryV5;
+    orderId: string;
+    orderLinkId: string;
+    isLeverage: string;
+    blockTradeId: string;
+    symbol: string;
+    price: string;
+    qty: string;
     side: OrderSideV5;
-    placeType: string;
+    positionIdx: PositionIdx;
+    orderStatus: OrderStatusV5;
+    createType: OrderCreateTypeV5;
+    cancelType: OrderCancelTypeV5;
+    rejectReason?: OrderRejectReasonV5;
     avgPrice?: string;
     leavesQty?: string;
-    isLeverage: string;
-    cancelType: string;
+    leavesValue?: string;
     cumExecQty: string;
+    cumExecValue: string;
     cumExecFee: string;
-    smpOrderId: string;
+    feeCurrency: string;
+    timeInForce: OrderTimeInForceV5;
+    orderType: OrderTypeV5;
+    stopOrderType: StopOrderTypeV5;
+    ocoTriggerType?: OCOTriggerTypeV5;
+    orderIv: string;
+    marketUnit?: 'baseCoin' | 'quoteCoin';
+    triggerPrice: string;
     takeProfit: string;
-    reduceOnly: boolean;
-    orderLinkId: string;
-    positionIdx: number;
+    stopLoss: string;
+    tpslMode?: TPSLModeV5;
+    tpLimitPrice?: string;
+    slLimitPrice?: string;
     tpTriggerBy: string;
     slTriggerBy: string;
+    triggerDirection: number;
+    triggerBy: OrderTriggerByV5;
+    lastPriceOnCreated: string;
+    reduceOnly: boolean;
+    closeOnTrigger: boolean;
+    placeType: string;
+    smpType: OrderSMPTypeV5;
+    smpGroup: number;
+    smpOrderId: string;
     createdTime: string;
     updatedTime: string;
-    feeCurrency: string;
-    triggerPrice: string;
+}
+export type WSAccountOrderEventV5 = WSPrivateTopicEventV5<'order', WSAccountOrderV5[]>;
+export interface WSExecutionV5 {
     category: CategoryV5;
-    cumExecValue: string;
-    blockTradeId: string;
-    leavesValue?: string;
-    slLimitPrice?: string;
-    tpLimitPrice?: string;
-    tpslMode?: TPSLModeV5;
+    symbol: string;
+    isLeverage: string;
+    orderId: string;
+    orderLinkId: string;
+    side: OrderSideV5;
+    orderPrice: string;
+    orderQty: string;
+    leavesQty: string;
+    createType: OrderCreateTypeV5;
     orderType: OrderTypeV5;
-    smpType: OrderSMPTypeV5;
-    closeOnTrigger: boolean;
-    triggerDirection: number;
-    orderStatus: OrderStatusV5;
-    lastPriceOnCreated: string;
-    triggerBy: OrderTriggerByV5;
     stopOrderType: StopOrderTypeV5;
-    timeInForce: OrderTimeInForceV5;
-    ocoTriggerType?: OCOTriggerTypeV5;
-    rejectReason?: OrderRejectReasonV5;
-}
-export interface WSAccountOrderEventV5 {
-    id: string;
-    wsKey: WsKey;
-    topic: 'order';
-    creationTime: number;
-    data: WSAccountOrderV5[];
+    execFee: string;
+    execId: string;
+    execPrice: string;
+    execQty: string;
+    execType: ExecTypeV5;
+    execValue: string;
+    execTime: string;
+    isMaker: boolean;
+    feeRate: string;
+    tradeIv: string;
+    markIv: string;
+    markPrice: string;
+    indexPrice: string;
+    underlyingPrice: string;
+    blockTradeId: string;
+    closedSize: string;
+    seq: number;
+    marketUnit: string;
 }
+export type WSExecutionEventV5 = WSPrivateTopicEventV5<'execution', WSExecutionV5[]>;

package/lib/util/requestUtils.d.ts

@@ -25,7 +25,7 @@ export interface RestClientOptions {
     /** How often to sync time drift with bybit servers */
     sync_interval_ms?: number | string;
     /** Determines whether to perform time synchronization before sending private requests */
-    syncTimeBeforePrivateRequests?: false;
+    syncTimeBeforePrivateRequests?: boolean;
     /** Default: false. If true, we'll throw errors if any params are undefined */
     strict_param_validation?: boolean;
     /**

package/lib/util/typeGuards.d.ts

@@ -1,7 +1,7 @@
 /**
  * Use type guards to narrow down types with minimal efforts.
  */
-import { WSOrderbookEventV5 } from '../types/websocket.events';
+import { WSAccountOrderEventV5, WSExecutionEventV5, WSOrderbookEventV5, WSPositionEventV5 } from '../types/websocket.events';
 /**
  * Type guard to detect a V5 orderbook event (delta & snapshots)
  *
@@ -9,3 +9,24 @@ import { WSOrderbookEventV5 } from '../types/websocket.events';
  * @returns
  */
 export declare function isWsOrderbookEventV5(event: unknown): event is WSOrderbookEventV5;
+/**
+ * Type guard to detect a V5 position event.
+ *
+ * @param event
+ * @returns
+ */
+export declare function isWsPositionEventV5(event: unknown): event is WSPositionEventV5;
+/**
+ * Type guard to detect a V5 order event.
+ *
+ * @param event
+ * @returns
+ */
+export declare function isWsAccountOrderEventV5(event: unknown): event is WSAccountOrderEventV5;
+/**
+ * Type guard to detect a V5 execution event.
+ *
+ * @param event
+ * @returns
+ */
+export declare function isWsExecutionEventV5(event: unknown): event is WSExecutionEventV5;

package/lib/util/typeGuards.js

@@ -3,7 +3,7 @@
  * Use type guards to narrow down types with minimal efforts.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWsOrderbookEventV5 = void 0;
+exports.isWsExecutionEventV5 = exports.isWsAccountOrderEventV5 = exports.isWsPositionEventV5 = exports.isWsOrderbookEventV5 = void 0;
 /**
  * Type guard to detect a V5 orderbook event (delta & snapshots)
  *
@@ -21,4 +21,49 @@ function isWsOrderbookEventV5(event) {
         event['topic'].startsWith('orderbook'));
 }
 exports.isWsOrderbookEventV5 = isWsOrderbookEventV5;
+/**
+ * Type guard to detect a V5 position event.
+ *
+ * @param event
+ * @returns
+ */
+function isWsPositionEventV5(event) {
+    if (typeof event !== 'object' ||
+        !event ||
+        typeof event['topic'] !== 'string') {
+        return false;
+    }
+    return event['topic'] === 'position';
+}
+exports.isWsPositionEventV5 = isWsPositionEventV5;
+/**
+ * Type guard to detect a V5 order event.
+ *
+ * @param event
+ * @returns
+ */
+function isWsAccountOrderEventV5(event) {
+    if (typeof event !== 'object' ||
+        !event ||
+        typeof event['topic'] !== 'string') {
+        return false;
+    }
+    return event['topic'] === 'order';
+}
+exports.isWsAccountOrderEventV5 = isWsAccountOrderEventV5;
+/**
+ * Type guard to detect a V5 execution event.
+ *
+ * @param event
+ * @returns
+ */
+function isWsExecutionEventV5(event) {
+    if (typeof event !== 'object' ||
+        !event ||
+        typeof event['topic'] !== 'string') {
+        return false;
+    }
+    return event['topic'] === 'execution';
+}
+exports.isWsExecutionEventV5 = isWsExecutionEventV5;
 //# sourceMappingURL=typeGuards.js.map

package/lib/util/typeGuards.js.map

@@ -1 +1 @@
-{"version":3,"file":"typeGuards.js","sourceRoot":"","sources":["../../src/util/typeGuards.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAIH;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAc;IAEd,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK;QACN,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,QAAQ;QAClC,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ,EACjC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CACL,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CACvC,CAAC;AACJ,CAAC;AAhBD,oDAgBC"}
+{"version":3,"file":"typeGuards.js","sourceRoot":"","sources":["../../src/util/typeGuards.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAIH;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAc;IAEd,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK;QACN,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,QAAQ;QAClC,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ,EACjC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CACL,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CACvC,CAAC;AACJ,CAAC;AAhBD,oDAgBC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,KAAc;IAEd,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK;QACN,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,QAAQ,EAClC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC;AACvC,CAAC;AAZD,kDAYC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,KAAc;IAEd,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK;QACN,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,QAAQ,EAClC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC;AACpC,CAAC;AAZD,0DAYC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAc;IAEd,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK;QACN,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,QAAQ,EAClC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,WAAW,CAAC;AACxC,CAAC;AAZD,oDAYC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bybit-api",
-  "version": "3.10.0",
+  "version": "3.10.2",
   "description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",