Merge pull request #293 from tiagosiebler/next

v3.7.4: feat(#251, #291) add optional endpoint rate limit parsing, add deprecation warnings for v1/v2 rest clients, improve v5 types, bump dependencies
tiagosiebler · Oct 30, 2023 · a64b2ca · a64b2ca
2 parents 81ca8a6 + 976a4e8
commit a64b2ca
Show file tree

Hide file tree

Showing 28 changed files with 685 additions and 774 deletions.
diff --git a/README.md b/README.md
@@ -155,6 +155,12 @@ const restClientOptions = {
 
   /** Default: true. whether to try and post-process request exceptions. */
   parse_exceptions?: boolean;
+
+  /** Default: false. Enable to parse/include per-API/endpoint rate limits in responses. */
+  parseAPIRateLimits?: boolean;
+
+  /** Default: false. Enable to throw error if rate limit parser fails */
+  throwOnFailedRateLimitParse?: boolean;
 };
 
 const API_KEY = 'xxx';

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bybit-api",
-  "version": "3.7.3",
+  "version": "3.7.4",
   "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",

diff --git a/src/account-asset-client.ts b/src/account-asset-client.ts
@@ -17,6 +17,10 @@ import BaseRestClient from './util/BaseRestClient';
 
 /**
  * REST API client for Account Asset APIs
+ *
+ * @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
+ * will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
+ * Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
  */
 export class AccountAssetClient extends BaseRestClient {
   getClientType() {
@@ -35,29 +39,29 @@ export class AccountAssetClient extends BaseRestClient {
    */
 
   createInternalTransfer(
-    params: InternalTransferRequest
+    params: InternalTransferRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('/asset/v1/private/transfer', params);
   }
 
   createSubAccountTransfer(
-    params: SubAccountTransferRequest
+    params: SubAccountTransferRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('/asset/v1/private/sub-member/transfer', params);
   }
 
   getInternalTransfers(
-    params?: TransferQueryRequest
+    params?: TransferQueryRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('/asset/v1/private/transfer/list', params);
   }
 
   getSubAccountTransfers(
-    params?: TransferQueryRequest
+    params?: TransferQueryRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate(
       '/asset/v1/private/sub-member/transfer/list',
-      params
+      params,
     );
   }
 
@@ -66,19 +70,19 @@ export class AccountAssetClient extends BaseRestClient {
   }
 
   enableUniversalTransfer(
-    params?: EnableUniversalTransferRequest
+    params?: EnableUniversalTransferRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('/asset/v1/private/transferable-subs/save', params);
   }
 
   createUniversalTransfer(
-    params: UniversalTransferRequest
+    params: UniversalTransferRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('/asset/v1/private/universal/transfer', params);
   }
 
   getUniversalTransfers(
-    params?: TransferQueryRequest
+    params?: TransferQueryRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('/asset/v1/private/universal/transfer/list', params);
   }
@@ -90,19 +94,19 @@ export class AccountAssetClient extends BaseRestClient {
    */
 
   getSupportedDepositList(
-    params?: SupportedDepositListRequest
+    params?: SupportedDepositListRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.get('/asset/v1/public/deposit/allowed-deposit-list', params);
   }
 
   getDepositRecords(
-    params?: DepositRecordsRequest
+    params?: DepositRecordsRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('/asset/v1/private/deposit/record/query', params);
   }
 
   getWithdrawRecords(
-    params?: WithdrawalRecordsRequest
+    params?: WithdrawalRecordsRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('/asset/v1/private/withdraw/record/query', params);
   }
@@ -112,13 +116,13 @@ export class AccountAssetClient extends BaseRestClient {
   }
 
   getAssetInformation(
-    params?: AccountAssetInformationRequest
+    params?: AccountAssetInformationRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('/asset/v1/private/asset-info/query', params);
   }
 
   submitWithdrawal(
-    params: WithdrawalRequest
+    params: WithdrawalRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('/asset/v1/private/withdraw', params);
   }

diff --git a/src/inverse-client.ts b/src/inverse-client.ts
@@ -32,6 +32,10 @@ import BaseRestClient from './util/BaseRestClient';
 
 /**
  * REST API client for Inverse Perpetual Futures APIs (v2)
+ *
+ * @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
+ * will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
+ * Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
  */
 export class InverseClient extends BaseRestClient {
   getClientType() {
@@ -54,7 +58,7 @@ export class InverseClient extends BaseRestClient {
   }
 
   getKline(
-    params: SymbolIntervalFromLimitParam
+    params: SymbolIntervalFromLimitParam,
   ): Promise<APIResponseWithTime<any[]>> {
     return this.get('v2/public/kline/list', params);
   }
@@ -63,7 +67,7 @@ export class InverseClient extends BaseRestClient {
    * Get latest information for symbol
    */
   getTickers(
-    params?: Partial<SymbolParam>
+    params?: Partial<SymbolParam>,
   ): Promise<APIResponseWithTime<any[]>> {
     return this.get('v2/public/tickers', params);
   }
@@ -77,19 +81,19 @@ export class InverseClient extends BaseRestClient {
   }
 
   getMarkPriceKline(
-    params: SymbolIntervalFromLimitParam
+    params: SymbolIntervalFromLimitParam,
   ): Promise<APIResponseWithTime<any[]>> {
     return this.get('v2/public/mark-price-kline', params);
   }
 
   getIndexPriceKline(
-    params: SymbolIntervalFromLimitParam
+    params: SymbolIntervalFromLimitParam,
   ): Promise<APIResponseWithTime<any[]>> {
     return this.get('v2/public/index-price-kline', params);
   }
 
   getPremiumIndexKline(
-    params: SymbolIntervalFromLimitParam
+    params: SymbolIntervalFromLimitParam,
   ): Promise<APIResponseWithTime<any[]>> {
     return this.get('v2/public/premium-index-kline', params);
   }
@@ -101,19 +105,19 @@ export class InverseClient extends BaseRestClient {
    */
 
   getOpenInterest(
-    params: SymbolPeriodLimitParam
+    params: SymbolPeriodLimitParam,
   ): Promise<APIResponseWithTime<any[]>> {
     return this.get('v2/public/open-interest', params);
   }
 
   getLatestBigDeal(
-    params: SymbolLimitParam
+    params: SymbolLimitParam,
   ): Promise<APIResponseWithTime<any[]>> {
     return this.get('v2/public/big-deal', params);
   }
 
   getLongShortRatio(
-    params: SymbolPeriodLimitParam
+    params: SymbolPeriodLimitParam,
   ): Promise<APIResponseWithTime<any[]>> {
     return this.get('v2/public/account-ratio', params);
   }
@@ -135,25 +139,25 @@ export class InverseClient extends BaseRestClient {
    */
 
   getWalletBalance(
-    params?: Partial<CoinParam>
+    params?: Partial<CoinParam>,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/wallet/balance', params);
   }
 
   getWalletFundRecords(
-    params?: WalletFundRecordsReq
+    params?: WalletFundRecordsReq,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/wallet/fund/records', params);
   }
 
   getWithdrawRecords(
-    params?: WithdrawRecordsReq
+    params?: WithdrawRecordsReq,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/wallet/withdraw/list', params);
   }
 
   getAssetExchangeRecords(
-    params?: AssetExchangeRecordsReq
+    params?: AssetExchangeRecordsReq,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/exchange-order/list', params);
   }
@@ -183,37 +187,37 @@ export class InverseClient extends BaseRestClient {
    */
 
   placeActiveOrder(
-    orderRequest: InverseOrderRequest
+    orderRequest: InverseOrderRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/order/create', orderRequest);
   }
 
   getActiveOrderList(
-    params: InverseActiveOrdersRequest
+    params: InverseActiveOrdersRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/order/list', params);
   }
 
   cancelActiveOrder(
-    params: InverseCancelOrderRequest
+    params: InverseCancelOrderRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/order/cancel', params);
   }
 
   cancelAllActiveOrders(
-    params: SymbolParam
+    params: SymbolParam,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/order/cancelAll', params);
   }
 
   replaceActiveOrder(
-    params: InverseReplaceOrderRequest
+    params: InverseReplaceOrderRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/order/replace', params);
   }
 
   queryActiveOrder(
-    params: InverseGetOrderRequest
+    params: InverseGetOrderRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/order', params);
   }
@@ -223,38 +227,38 @@ export class InverseClient extends BaseRestClient {
    */
 
   placeConditionalOrder(
-    params: InverseConditionalOrderRequest
+    params: InverseConditionalOrderRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/stop-order/create', params);
   }
 
   /** get conditional order list. This may see delays, use queryConditionalOrder() for real-time queries */
   getConditionalOrder(
-    params: InverseActiveConditionalOrderRequest
+    params: InverseActiveConditionalOrderRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/stop-order/list', params);
   }
 
   cancelConditionalOrder(
-    params: InverseCancelConditionalOrderRequest
+    params: InverseCancelConditionalOrderRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/stop-order/cancel', params);
   }
 
   cancelAllConditionalOrders(
-    params: SymbolParam
+    params: SymbolParam,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/stop-order/cancelAll', params);
   }
 
   replaceConditionalOrder(
-    params: InverseReplaceConditionalOrderRequest
+    params: InverseReplaceConditionalOrderRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/stop-order/replace', params);
   }
 
   queryConditionalOrder(
-    params: InverseGetOrderRequest
+    params: InverseGetOrderRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/stop-order', params);
   }
@@ -264,49 +268,49 @@ export class InverseClient extends BaseRestClient {
    */
 
   getPosition(
-    params?: Partial<SymbolParam>
+    params?: Partial<SymbolParam>,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/position/list', params);
   }
 
   changePositionMargin(
-    params: InverseChangePositionMarginRequest
+    params: InverseChangePositionMarginRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('position/change-position-margin', params);
   }
 
   setTradingStop(
-    params: InverseSetTradingStopRequest
+    params: InverseSetTradingStopRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/position/trading-stop', params);
   }
 
   setUserLeverage(
-    params: InverseSetLeverageRequest
+    params: InverseSetLeverageRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/position/leverage/save', params);
   }
 
   getTradeRecords(
-    params: InverseGetTradeRecordsRequest
+    params: InverseGetTradeRecordsRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/execution/list', params);
   }
 
   getClosedPnl(
-    params: InverseGetClosedPnlRequest
+    params: InverseGetClosedPnlRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.getPrivate('v2/private/trade/closed-pnl/list', params);
   }
 
   setSlTpPositionMode(
-    params: InverseSetSlTpPositionModeRequest
+    params: InverseSetSlTpPositionModeRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/tpsl/switch-mode', params);
   }
 
   setMarginType(
-    params: InverseSetMarginTypeRequest
+    params: InverseSetMarginTypeRequest,
   ): Promise<APIResponseWithTime<any>> {
     return this.postPrivate('v2/private/position/switch-isolated', params);
   }