bybit-api 4.2.0 → 4.2.2

package/README.md

@@ -29,10 +29,10 @@ Professional Node.js, JavaScript & TypeScript SDK for the Bybit REST APIs, WebSo
     - Rate limits are raised to 400 requests per second, higher than the highest VIP tier.
     - No action required. This is automatic for any API calls made with this SDK, for any user.
     - Read more in the announcement: [here](https://github.com/tiagosiebler/bybit-api/issues/458).
-  - Lower minimum order notional value with this SDK!*
+  - Lower minimum order notional value with this SDK!\*
     - Place orders with a notional value as low as $1.
     - Lower than the default minimum notional order value $5.
-    - *Note: the lower min notional requirement is an undocumented benefit that may end at any time.
+    - \*Note: the lower min notional requirement is an undocumented benefit that may end at any time.
 - Automatic support for HMAC & RSA authentication.
 - TypeScript support (thorough type declarations for most API requests & responses, including WS API).
 - JavaScript support (TypeScript not required but definitely recommended).
@@ -46,21 +46,22 @@ Professional Node.js, JavaScript & TypeScript SDK for the Bybit REST APIs, WebSo
     - Emit `reconnected` event when dropped connection is restored.
 - WebSocket API integration, with two design patterns to choose from:
   1. Asynchronous **promise**-driven responses:
-      - Make requests like a REST API, using the WebSocket API. No need to subscribe to asynchronous events.
-      - Import the `WebsocketAPIClient` and use it like the REST API client. Call functions and await responses.
-        - See example for more details: [examples/ws-api-client.ts](./examples/ws-api-client.ts).
-      - Prefer something more raw? Use the `sendWSAPIRequest(...)` method and await responses
-        - See example for more details: [examples/ws-api-raw-promises.ts](./examples/ws-api-raw-promises.ts)
+     - Make requests like a REST API, using the WebSocket API. No need to subscribe to asynchronous events.
+     - Import the `WebsocketAPIClient` and use it like the REST API client. Call functions and await responses.
+       - See example for more details: [examples/ws-api-client.ts](./examples/ws-api-client.ts).
+     - Prefer something more raw? Use the `sendWSAPIRequest(...)` method and await responses
+       - See example for more details: [examples/ws-api-raw-promises.ts](./examples/ws-api-raw-promises.ts)
   2. Asynchronous **event**-driven responses:
-      - Subscribe to `response` and `error` events from WebsocketClient's event emitter.
-      - Send commands with the `sendWSAPIRequest(...)` method.
-      - Responses to commands will arrive via the `response` and `error` events emitted by the client.
-      - See example for more details: [examples/ws-api-raw-events.ts](./examples/ws-api-raw-events.ts)
+     - Subscribe to `response` and `error` events from WebsocketClient's event emitter.
+     - Send commands with the `sendWSAPIRequest(...)` method.
+     - Responses to commands will arrive via the `response` and `error` events emitted by the client.
+     - See example for more details: [examples/ws-api-raw-events.ts](./examples/ws-api-raw-events.ts)
 - Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
 
 # Table of Contents
 
 ## Overview
+
 - [Installation](#installation)
 - [Issues & Discussion](#issues--discussion)
 - [Related Projects](#related-projects)
@@ -68,16 +69,19 @@ Professional Node.js, JavaScript & TypeScript SDK for the Bybit REST APIs, WebSo
 - [Examples](#examples)
 
 ## REST API Examples
+
 - [API Clients](#api-clients)
 - [REST API Usage](#rest-api-usage)
 
 ## WebSocket Integration & Examples
+
 - [WebSockets](#websockets)
 - [WebSocket Subscriptions - Consuming Events](#websocket-subscriptions---consuming-events)
 - [Websocket API - Sending Orders via WebSockets](#websocket-api---sending-orders-via-websockets)
 - [Consumer Load Balancing](#balancing-load-across-multiple-connections)
 
 ## Additional Features
+
 - [Logging](#logging)
   - [Customise Logging](#customise-logging)
   - [Debug HTTP Requests](#debug-http-requests)
@@ -85,11 +89,13 @@ Professional Node.js, JavaScript & TypeScript SDK for the Bybit REST APIs, WebSo
   - [Import](#import)
   - [Webpack](#webpack)
 - [Use with LLMs & AI](#use-with-llms--ai)
+- [Used By](#used-by)
 
 ## Contributing
+
 - [Contributions & Thanks](#contributions--thanks)
 
-------
+---
 
 ## Installation
 
@@ -135,7 +141,6 @@ Most methods accept JS objects. These can be populated using parameters specifie
 
 The SDK is written in TypeScript, but fully compatible with both TypeScript and pure JavaScript projects. A pure JavaScript version can be built using `npm run build`. The output of the `build` command is the version published to npm, packaged as a JavaScript module (with types available for you TypeScript users).
 
-
 - [src](./src) - the complete SDK written in TypeScript.
 - [lib](./lib) - the JavaScript version of the project (built from TypeScript) that is published to npm. This should not be edited directly, as it will be overwritten with each release.
 - [examples](./examples) - examples & demonstrations. Contributions are welcome!
@@ -160,13 +165,12 @@ Refer to the [V5 interface mapping page](https://bybit-exchange.github.io/docs/v
 
 Here are the available REST clients and the corresponding API groups described in the documentation:
 
-|                         Class                          |                                                                                                      Description                       |
-| :----------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: |
-|                     [ **V5 API** ]                     | The new unified V5 APIs (successor to previously fragmented APIs for all API groups).                                                  |
-|         [RestClientV5](src/rest-client-v5.ts)          |   Unified V5 all-in-one REST client for all [V5 REST APIs](https://bybit-exchange.github.io/docs/v5/intro)                             |
-|       [WebsocketClient](src/websocket-client.ts)       |   All WebSocket features (Public & Private consumers for all API categories & the WebSocket API)                                       |
-|    [WebsocketAPIClient](src/websocket-api-client.ts)   |   Use the WebSocket API like a REST API. Call functions and await responses, powered by WebSockets.                                    |
-
+|                       Class                       |                                               Description                                                |
+| :-----------------------------------------------: | :------------------------------------------------------------------------------------------------------: |
+|                  [ **V5 API** ]                   |          The new unified V5 APIs (successor to previously fragmented APIs for all API groups).           |
+|       [RestClientV5](src/rest-client-v5.ts)       | Unified V5 all-in-one REST client for all [V5 REST APIs](https://bybit-exchange.github.io/docs/v5/intro) |
+|    [WebsocketClient](src/websocket-client.ts)     |      All WebSocket features (Public & Private consumers for all API categories & the WebSocket API)      |
+| [WebsocketAPIClient](src/websocket-api-client.ts) |    Use the WebSocket API like a REST API. Call functions and await responses, powered by WebSockets.     |
 
 ## REST API Usage
 
@@ -175,7 +179,6 @@ Create API credentials on Bybit's website:
 - [Livenet](https://bybit.com/app/user/api-management?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
 - [Testnet](https://testnet.bybit.com/app/user/api-management)
 
-
 The following is a minimal example for using the REST clients included with this SDK. For more detailed examples, refer to the [examples](./examples/) folder in the repository on GitHub:
 
 ```typescript
@@ -242,34 +245,37 @@ const restClientOptions = {
 const API_KEY = 'xxx';
 const API_SECRET = 'yyy';
 
-const client = new RestClientV5({
-  key: API_KEY,
-  secret: API_SECRET,
-  // demoTrading: true,
+const client = new RestClientV5(
+  {
+    key: API_KEY,
+    secret: API_SECRET,
+    // demoTrading: true,
 
-  // Optional: enable to try parsing rate limit values from responses
-  // parseAPIRateLimits: true
-},
+    // Optional: enable to try parsing rate limit values from responses
+    // parseAPIRateLimits: true
+  },
   // requestLibraryOptions
 );
 
 // For public-only API calls, simply don't provide a key & secret or set them to undefined
 // const client = new RestClientV5();
 
-client.getAccountInfo()
-  .then(result => {
-    console.log("getAccountInfo result: ", result);
+client
+  .getAccountInfo()
+  .then((result) => {
+    console.log('getAccountInfo result: ', result);
   })
-  .catch(err => {
-    console.error("getAccountInfo error: ", err);
+  .catch((err) => {
+    console.error('getAccountInfo error: ', err);
   });
 
-client.getOrderbook({ category: 'linear', symbol: 'BTCUSDT' })
-  .then(result => {
-    console.log("getOrderBook result: ", result);
+client
+  .getOrderbook({ category: 'linear', symbol: 'BTCUSDT' })
+  .then((result) => {
+    console.log('getOrderBook result: ', result);
   })
-  .catch(err => {
-    console.error("getOrderBook error: ", err);
+  .catch((err) => {
+    console.error('getOrderBook error: ', err);
   });
 ```
 
@@ -416,6 +422,7 @@ ws.on('reconnected', (data) => {
 Bybit supports sending, amending and cancelling orders over a WebSocket connection. The [WebsocketClient](./src/WebsocketClient.ts) fully supports Bybit's WebSocket API via the `sendWSAPIRequest(...)` method. There is also a dedicated [WebsocketAPIClient](./src/websocket-api-client.ts), built over the WSClient's sendWSAPIRequest mechanism for a simpler experience.
 
 Links for reference:
+
 - [Bybit WebSocket API Documentation](https://bybit-exchange.github.io/docs/v5/websocket/trade/guideline)
 - [WebsocketAPIClient example, use the Websocket API like a REST API](./examples/ws-api-client.ts)
 - [Raw Asynchronous Websocket API Node.js/TypeScript/JavaScript example](./examples/ws-api-raw-promises.ts)
@@ -423,16 +430,17 @@ Links for reference:
 Note: as of January 2025, the demo trading environment does not support the WebSocket API.
 
 There are two ways to use the WS API, depending on individual preference:
+
 1. event-driven:
-    - send requests via `client.sendWSAPIRequest(wsKey, operation, params)`, fire and forget
-    - handle async replies via event handlers on `client.on('exception', cb)` and `client.on('response', cb)`
-    - See example for more details: [examples/ws-api-raw-events.ts](./examples/ws-api-raw-events.ts)
+   - send requests via `client.sendWSAPIRequest(wsKey, operation, params)`, fire and forget
+   - handle async replies via event handlers on `client.on('exception', cb)` and `client.on('response', cb)`
+   - See example for more details: [examples/ws-api-raw-events.ts](./examples/ws-api-raw-events.ts)
 2. promise-driven:
-    - import the `WebsocketAPIClient` and use it much like a REST API.
-    - make an instance & call the Websocket API with a function.
-    - await responses, much like a REST API.
-    - use try/catch blocks to handle promise rejections
-    - See example for more details: [examples/ws-api-client.ts](./examples/ws-api-client.ts)
+   - import the `WebsocketAPIClient` and use it much like a REST API.
+   - make an instance & call the Websocket API with a function.
+   - await responses, much like a REST API.
+   - use try/catch blocks to handle promise rejections
+   - See example for more details: [examples/ws-api-client.ts](./examples/ws-api-client.ts)
 
 The below example demonstrates the promise-driven approach, which behaves similar to a REST API. The WebSocket API even accepts the same parameters as the corresponding REST API endpoints, so this approach should be compatible with existing REST implementations.
 
@@ -448,25 +456,23 @@ const { WS_KEY_MAP, WebsocketAPIClient } = require('bybit-api');
 // top of the WebsocketClient and will automatically handle WebSocket
 // persistence and authentication for you.
 // supports HMAC & RSA API keys - automatically detected
-const wsClient = new WebsocketAPIClient(
-  {
-    key: 'yourApiKeyHere',
-    secret: 'yourApiSecretHere',
+const wsClient = new WebsocketAPIClient({
+  key: 'yourApiKeyHere',
+  secret: 'yourApiSecretHere',
 
-    // Whether to use the testnet environment.
-    // Create testnet API keys here: https://testnet.bybit.com/app/user/api-management
-    // testnet: true,
+  // Whether to use the testnet environment.
+  // Create testnet API keys here: https://testnet.bybit.com/app/user/api-management
+  // testnet: true,
 
-    // Whether to use the livenet demo trading environment
-    // Note: As of Jan 2025, demo trading only supports consuming events, it does
-    // NOT support the WS API.
-    // demoTrading: false,
+  // Whether to use the livenet demo trading environment
+  // Note: As of Jan 2025, demo trading only supports consuming events, it does
+  // NOT support the WS API.
+  // demoTrading: false,
 
-    // If you want your own event handlers instead of the default ones with logs,
-    // disable this setting and see ws-api-client example for more details.
-    // attachEventListeners: false
-  }
-);
+  // If you want your own event handlers instead of the default ones with logs,
+  // disable this setting and see ws-api-client example for more details.
+  // attachEventListeners: false
+});
 
 // This example is wrapped in an async function, so "await" can be used
 async function main() {
@@ -523,7 +529,6 @@ async function main() {
 
 // Start executing the example workflow
 main();
-
 ```
 
 ---
@@ -561,7 +566,10 @@ const customLogger = {
   trace: (...params) => console.log('trace', ...params),
 };
 
-const wsClient = new WebsocketClient({ key: 'xxx', secret: 'yyy' }, customLogger);
+const wsClient = new WebsocketClient(
+  { key: 'xxx', secret: 'yyy' },
+  customLogger,
+);
 ```
 
 ### Debug HTTP requests
@@ -613,6 +621,12 @@ This file contains AI optimised structure of all the functions in this package,
 
 ---
 
+## Used By
+
+[![Repository Users Preview Image](https://dependents.info/tiagosiebler/bybit-api/image)](https://github.com/tiagosiebler/bybit-api/network/dependents)
+
+---
+
 <!-- template_contributions -->
 
 ### Contributions & Thanks

package/lib/rest-client-v5.d.ts

@@ -1,4 +1,4 @@
-import { AccountBorrowCollateralLimitV5, AccountCoinBalanceV5, AccountInfoV5, AccountMarginModeV5, AccountOrderV5, AccountTypeV5, AddOrReduceMarginParamsV5, AddOrReduceMarginResultV5, AffiliateUserInfoV5, AffiliateUserListItemV5, AllCoinsBalanceV5, AllowedDepositCoinInfoV5, AmendOrderParamsV5, AmendSpreadOrderParamsV5, ApiKeyInfoV5, APIResponseV3, APIResponseV3WithTime, AssetInfoV5, BatchAmendOrderParamsV5, BatchAmendOrderResultV5, BatchCancelOrderParamsV5, BatchCancelOrderResultV5, BatchCreateOrderResultV5, BatchOrderParamsV5, BatchOrdersRetExtInfoV5, BorrowCryptoLoanParamsV5, BorrowHistoryRecordV5, BrokerIssuedVoucherV5, BrokerVoucherSpecV5, CancelAllOrdersParamsV5, CancelOrderParamsV5, CategoryCursorListV5, CategoryListV5, CategorySymbolListV5, CategoryV5, ClosedOptionsPositionV5, ClosedPnLV5, CoinExchangeRecordV5, CoinGreeksV5, CoinInfoV5, CollateralInfoV5, CompletedLoanOrderV5, ConfirmNewRiskLimitParamsV5, ConvertCoinsParamsV5, ConvertCoinSpecV5, ConvertHistoryRecordV5, ConvertQuoteV5, ConvertStatusV5, CreateP2PAdParamsV5, CreateSubApiKeyParamsV5, CreateSubApiKeyResultV5, CreateSubMemberParamsV5, CreateSubMemberResultV5, CursorListV5, CursorRowsV5, DCPInfoV5, DeleteSubMemberParamsV5, DeliveryPriceV5, DeliveryRecordV5, DepositAddressChainV5, DepositRecordV5, EarnOrderHistoryV5, EarnPositionV5, EarnProductV5, ExchangeBrokerAccountInfoV5, ExchangeBrokerEarningResultV5, ExchangeBrokerSubAccountDepositRecordV5, ExecutionV5, FeeRateV5, FundingRateHistoryResponseV5, GetAccountCoinBalanceParamsV5, GetAccountHistoricOrdersParamsV5, GetAccountOrdersParamsV5, GetAllCoinsBalanceParamsV5, GetAllowedDepositCoinInfoParamsV5, GetAssetInfoParamsV5, GetBorrowHistoryParamsV5, GetBrokerIssuedVoucherParamsV5, GetBrokerSubAccountDepositsV5, GetClassicTransactionLogsParamsV5, GetClosedOptionsPositionsParamsV5, GetClosedPnLParamsV5, GetCoinExchangeRecordParamsV5, GetCompletedLoanOrderHistoryParamsV5, GetConvertHistoryParamsV5, GetDeliveryPriceParamsV5, GetDeliveryRecordParamsV5, GetDepositRecordParamsV5, GetEarnOrderHistoryParamsV5, GetEarnPositionParamsV5, GetExchangeBrokerEarningsParamsV5, GetExecutionListParamsV5, GetFeeRateParamsV5, GetFundingRateHistoryParamsV5, GetHistoricalVolatilityParamsV5, GetIndexPriceKlineParamsV5, GetInstrumentsInfoParamsV5, GetInsuranceParamsV5, GetInternalDepositRecordParamsV5, GetInternalTransferParamsV5, GetKlineParamsV5, GetLoanLTVAdjustmentHistoryParamsV5, GetLongShortRatioParamsV5, GetMarkPriceKlineParamsV5, GetMovePositionHistoryParamsV5, GetOpenInterestParamsV5, GetOptionDeliveryPriceParamsV5, GetOrderbookParamsV5, GetP2PAccountCoinsBalanceParamsV5, GetP2PCounterpartyUserInfoParamsV5, GetP2POnlineAdsParamsV5, GetP2POrderMessagesParamsV5, GetP2POrdersParamsV5, GetP2PPendingOrdersParamsV5, GetP2PPersonalAdsParamsV5, GetPremiumIndexPriceKlineParamsV5, GetPreUpgradeClosedPnlParamsV5, GetPreUpgradeOptionDeliveryRecordParamsV5, GetPreUpgradeOrderHistoryParamsV5, GetPreUpgradeTradeHistoryParamsV5, GetPreUpgradeTransactionLogParamsV5, GetPreUpgradeUSDCSessionParamsV5, GetPublicTradingHistoryParamsV5, GetRepaymentHistoryParamsV5, GetRiskLimitParamsV5, GetSettlementRecordParamsV5, GetSpreadInstrumentsInfoParamsV5, GetSpreadOpenOrdersParamsV5, GetSpreadOrderHistoryParamsV5, GetSpreadTradeHistoryParamsV5, GetSubAccountAllApiKeysParamsV5, GetSubAccountDepositRecordParamsV5, GetTickersParamsV5, GetTransactionLogParamsV5, GetUniversalTransferRecordsParamsV5, GetUnpaidLoanOrdersParamsV5, GetVIPMarginDataParamsV5, GetWalletBalanceParamsV5, GetWithdrawalRecordsParamsV5, HistoricalVolatilityV5, InstrumentInfoResponseV5, InsuranceResponseV5, InternalDepositRecordV5, InternalTransferRecordV5, IssueVoucherParamsV5, LoanLTVAdjustmentHistoryV5, LongShortRatioV5, MarkP2POrderAsPaidParamsV5, MMPModifyParamsV5, MMPStateV5, MovePositionHistoryV5, MovePositionParamsV5, MovePositionResultV5, OHLCKlineV5, OHLCVKlineV5, OpenInterestResponseV5, OptionDeliveryPriceV5, OrderbookResponseV5, OrderParamsV5, OrderPriceLimitV5, OrderResultV5, OrderSideV5, P2PAccountCoinsBalanceV5, P2PAdDetailV5, P2PCounterpartyUserInfoV5, P2PCreateAdResponseV5, P2POnlineAdsResponseV5, P2POrderDetailV5, P2POrderMessageV5, P2POrdersResponseV5, P2PPersonalAdsResponseV5, P2PUserInfoV5, P2PUserPaymentV5, PositionInfoParamsV5, PositionV5, PreCheckOrderResultV5, PreUpgradeOptionsDelivery, PreUpgradeTransaction, PreUpgradeUSDCSessionSettlement, PublicTradeV5, RepayLiabilityParamsV5, RepayLiabilityResultV5, RepaymentHistoryV5, RequestConvertQuoteParamsV5, RiskLimitV5, SendP2POrderMessageParamsV5, SetAutoAddMarginParamsV5, SetCollateralCoinParamsV5, SetLeverageParamsV5, SetRiskLimitParamsV5, SetRiskLimitResultV5, SettlementRecordV5, SetTPSLModeParamsV5, SetTradingStopParamsV5, SpotBorrowCheckResultV5, SpotMarginStateV5, SpreadInstrumentInfoV5, SpreadOpenOrderV5, SpreadOrderbookResponseV5, SpreadOrderHistoryV5, SpreadRecentTradeV5, SpreadTickerV5, SpreadTradeV5, SubMemberV5, SubmitSpreadOrderParamsV5, SubmitStakeRedeemParamsV5, SwitchIsolatedMarginParamsV5, SwitchPositionModeParamsV5, TickerLinearInverseV5, TickerOptionV5, TickerSpotV5, TPSLModeV5, TransactionLogV5, UnifiedAccountUpgradeResultV5, UniversalTransferParamsV5, UniversalTransferRecordV5, UnpaidLoanOrderV5, UpdateApiKeyParamsV5, UpdateApiKeyResultV5, UpdateP2PAdParamsV5, VaspEntityV5, VipBorrowableCoinsV5, VipCollateralCoinsV5, VIPMarginDataV5, WalletBalanceV5, WithdrawableAmountV5, WithdrawalRecordV5, WithdrawParamsV5 } from './types';
+import { AccountBorrowCollateralLimitV5, AccountCoinBalanceV5, AccountInfoV5, AccountMarginModeV5, AccountOrderV5, AccountTypeV5, AddOrReduceMarginParamsV5, AddOrReduceMarginResultV5, AdjustCollateralAmountParamsV5, AdjustCollateralAmountV5, AffiliateUserInfoV5, AffiliateUserListItemV5, AllCoinsBalanceV5, AllowedDepositCoinInfoV5, AmendOrderParamsV5, AmendSpreadOrderParamsV5, ApiKeyInfoV5, APIResponseV3, APIResponseV3WithTime, AssetInfoV5, BatchAmendOrderParamsV5, BatchAmendOrderResultV5, BatchCancelOrderParamsV5, BatchCancelOrderResultV5, BatchCreateOrderResultV5, BatchOrderParamsV5, BatchOrdersRetExtInfoV5, BorrowableCoinV5, BorrowContractInfoFixedV5, BorrowCryptoLoanParamsV5, BorrowFlexibleParamsV5, BorrowFlexibleV5, BorrowHistoryFlexibleV5, BorrowHistoryRecordV5, BorrowOrderInfoFixedV5, BorrowOrderQuoteFixedV5, BrokerIssuedVoucherV5, BrokerVoucherSpecV5, CancelAllOrdersParamsV5, CancelBorrowOrderFixedParamsV5, CancelOrderParamsV5, CancelSupplyOrderFixedParamsV5, CategoryCursorListV5, CategoryListV5, CategorySymbolListV5, CategoryV5, ClosedOptionsPositionV5, ClosedPnLV5, CoinExchangeRecordV5, CoinGreeksV5, CoinInfoV5, CollateralAdjustmentHistoryV5, CollateralDataV5, CollateralInfoV5, CompletedLoanOrderV5, ConfirmNewRiskLimitParamsV5, ConvertCoinsParamsV5, ConvertCoinSpecV5, ConvertHistoryRecordV5, ConvertQuoteV5, ConvertStatusV5, CreateBorrowOrderFixedParamsV5, CreateBorrowOrderFixedV5, CreateP2PAdParamsV5, CreateSubApiKeyParamsV5, CreateSubApiKeyResultV5, CreateSubMemberParamsV5, CreateSubMemberResultV5, CreateSupplyOrderFixedParamsV5, CreateSupplyOrderFixedV5, CryptoLoanPositionV5, CursorListV5, CursorRowsV5, DCPInfoV5, DeleteSubMemberParamsV5, DeliveryPriceV5, DeliveryRecordV5, DepositAddressChainV5, DepositRecordV5, EarnOrderHistoryV5, EarnPositionV5, EarnProductV5, ExchangeBrokerAccountInfoV5, ExchangeBrokerEarningResultV5, ExchangeBrokerSubAccountDepositRecordV5, ExecutionV5, FeeRateV5, FundingRateHistoryResponseV5, GetAccountCoinBalanceParamsV5, GetAccountHistoricOrdersParamsV5, GetAccountOrdersParamsV5, GetAllCoinsBalanceParamsV5, GetAllowedDepositCoinInfoParamsV5, GetAssetInfoParamsV5, GetBorrowableCoinsParamsV5, GetBorrowContractInfoFixedParamsV5, GetBorrowHistoryFlexibleParamsV5, GetBorrowHistoryParamsV5, GetBorrowOrderInfoFixedParamsV5, GetBorrowOrderQuoteFixedParamsV5, GetBrokerIssuedVoucherParamsV5, GetBrokerSubAccountDepositsV5, GetClassicTransactionLogsParamsV5, GetClosedOptionsPositionsParamsV5, GetClosedPnLParamsV5, GetCoinExchangeRecordParamsV5, GetCollateralAdjustmentHistoryParamsV5, GetCollateralCoinsParamsV5, GetCompletedLoanOrderHistoryParamsV5, GetConvertHistoryParamsV5, GetDeliveryPriceParamsV5, GetDeliveryRecordParamsV5, GetDepositRecordParamsV5, GetEarnOrderHistoryParamsV5, GetEarnPositionParamsV5, GetExchangeBrokerEarningsParamsV5, GetExecutionListParamsV5, GetFeeRateParamsV5, GetFundingRateHistoryParamsV5, GetHistoricalVolatilityParamsV5, GetIndexPriceKlineParamsV5, GetInstrumentsInfoParamsV5, GetInsuranceParamsV5, GetInternalDepositRecordParamsV5, GetInternalTransferParamsV5, GetKlineParamsV5, GetLoanLTVAdjustmentHistoryParamsV5, GetLongShortRatioParamsV5, GetMarkPriceKlineParamsV5, GetMaxCollateralAmountParamsV5, GetMovePositionHistoryParamsV5, GetOngoingFlexibleLoansParamsV5, GetOpenInterestParamsV5, GetOptionDeliveryPriceParamsV5, GetOrderbookParamsV5, GetP2PAccountCoinsBalanceParamsV5, GetP2PCounterpartyUserInfoParamsV5, GetP2POnlineAdsParamsV5, GetP2POrderMessagesParamsV5, GetP2POrdersParamsV5, GetP2PPendingOrdersParamsV5, GetP2PPersonalAdsParamsV5, GetPremiumIndexPriceKlineParamsV5, GetPreUpgradeClosedPnlParamsV5, GetPreUpgradeOptionDeliveryRecordParamsV5, GetPreUpgradeOrderHistoryParamsV5, GetPreUpgradeTradeHistoryParamsV5, GetPreUpgradeTransactionLogParamsV5, GetPreUpgradeUSDCSessionParamsV5, GetPublicTradingHistoryParamsV5, GetRepaymentHistoryFixedParamsV5, GetRepaymentHistoryFlexibleParamsV5, GetRepaymentHistoryParamsV5, GetRiskLimitParamsV5, GetSettlementRecordParamsV5, GetSpreadInstrumentsInfoParamsV5, GetSpreadOpenOrdersParamsV5, GetSpreadOrderHistoryParamsV5, GetSpreadTradeHistoryParamsV5, GetSubAccountAllApiKeysParamsV5, GetSubAccountDepositRecordParamsV5, GetSupplyContractInfoFixedParamsV5, GetSupplyOrderInfoFixedParamsV5, GetSupplyOrderQuoteFixedParamsV5, GetSystemStatusParamsV5, GetTickersParamsV5, GetTransactionLogParamsV5, GetUniversalTransferRecordsParamsV5, GetUnpaidLoanOrdersParamsV5, GetVIPMarginDataParamsV5, GetWalletBalanceParamsV5, GetWithdrawalRecordsParamsV5, HistoricalVolatilityV5, InstrumentInfoResponseV5, InsuranceResponseV5, InternalDepositRecordV5, InternalTransferRecordV5, IssueVoucherParamsV5, LoanLTVAdjustmentHistoryV5, LongShortRatioV5, MarkP2POrderAsPaidParamsV5, MMPModifyParamsV5, MMPStateV5, MovePositionHistoryV5, MovePositionParamsV5, MovePositionResultV5, OHLCKlineV5, OHLCVKlineV5, OngoingFlexibleLoanV5, OpenInterestResponseV5, OptionDeliveryPriceV5, OrderbookResponseV5, OrderParamsV5, OrderPriceLimitV5, OrderResultV5, OrderSideV5, P2PAccountCoinsBalanceV5, P2PAdDetailV5, P2PCounterpartyUserInfoV5, P2PCreateAdResponseV5, P2POnlineAdsResponseV5, P2POrderDetailV5, P2POrderMessageV5, P2POrdersResponseV5, P2PPersonalAdsResponseV5, P2PUserInfoV5, P2PUserPaymentV5, PositionInfoParamsV5, PositionV5, PreCheckOrderResultV5, PreUpgradeOptionsDelivery, PreUpgradeTransaction, PreUpgradeUSDCSessionSettlement, PublicTradeV5, RepayFixedParamsV5, RepayFixedV5, RepayFlexibleParamsV5, RepayFlexibleV5, RepayLiabilityParamsV5, RepayLiabilityResultV5, RepaymentHistoryFixedV5, RepaymentHistoryFlexibleV5, RepaymentHistoryV5, RequestConvertQuoteParamsV5, RiskLimitV5, SendP2POrderMessageParamsV5, SetAutoAddMarginParamsV5, SetCollateralCoinParamsV5, SetLeverageParamsV5, SetLimitPriceActionParamsV5, SetRiskLimitParamsV5, SetRiskLimitResultV5, SettlementRecordV5, SetTPSLModeParamsV5, SetTradingStopParamsV5, SpotBorrowCheckResultV5, SpotMarginStateV5, SpreadInstrumentInfoV5, SpreadOpenOrderV5, SpreadOrderbookResponseV5, SpreadOrderHistoryV5, SpreadRecentTradeV5, SpreadTickerV5, SpreadTradeV5, SubMemberV5, SubmitSpreadOrderParamsV5, SubmitStakeRedeemParamsV5, SupplyContractInfoFixedV5, SupplyOrderInfoFixedV5, SupplyOrderQuoteFixedV5, SwitchIsolatedMarginParamsV5, SwitchPositionModeParamsV5, SystemStatusItemV5, TickerLinearInverseV5, TickerOptionV5, TickerSpotV5, TPSLModeV5, TransactionLogV5, UnifiedAccountUpgradeResultV5, UniversalTransferParamsV5, UniversalTransferRecordV5, UnpaidLoanOrderV5, UpdateApiKeyParamsV5, UpdateApiKeyResultV5, UpdateP2PAdParamsV5, VaspEntityV5, VipBorrowableCoinsV5, VipCollateralCoinsV5, VIPMarginDataV5, WalletBalanceV5, WithdrawableAmountV5, WithdrawalRecordV5, WithdrawParamsV5 } from './types';
 import BaseRestClient from './util/BaseRestClient';
 /**
  * REST API client for V5 REST APIs
@@ -24,6 +24,9 @@ export declare class RestClientV5 extends BaseRestClient {
      ****** Misc Bybit APIs
      *
      */
+    getSystemStatus(params?: GetSystemStatusParamsV5): Promise<APIResponseV3WithTime<{
+        list: SystemStatusItemV5[];
+    }>>;
     getClientType(): "v5";
     fetchServerTime(): Promise<number>;
     getServerTime(): Promise<APIResponseV3WithTime<{
@@ -687,6 +690,14 @@ export declare class RestClientV5 extends BaseRestClient {
     setSpotHedging(params: {
         setHedgingMode: 'ON' | 'OFF';
     }): Promise<APIResponseV3WithTime<{}>>;
+    /**
+     * Set Limit Price Behaviour
+     * You can configure how the system behaves when your limit order price exceeds the highest bid or lowest ask price.
+     *
+     * Spot: If the order price exceeds the boundary, the system rejects the request.
+     * Futures: If the order price exceeds the boundary, the system will automatically adjust the price to the nearest allowed boundary.
+     */
+    setLimitPriceAction(params: SetLimitPriceActionParamsV5): Promise<APIResponseV3WithTime<{}>>;
     /**
      * Configure Market Maker Protection (MMP)
      */
@@ -1286,13 +1297,16 @@ export declare class RestClientV5 extends BaseRestClient {
     }>>;
     /**
      *
-     ****** Crypto Loan
+     ****** Crypto Loan - Legacy
+     *
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
      *
      */
     /**
      * Get Collateral Coins
      *
      * INFO: Do not need authentication
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
      */
     getCollateralCoins(params?: {
         vipLevel?: string;
@@ -1304,6 +1318,7 @@ export declare class RestClientV5 extends BaseRestClient {
      * Get Borrowable Coins
      *
      * INFO: Do not need authentication
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
      */
     getBorrowableCoins(params?: {
         vipLevel?: string;
@@ -1316,6 +1331,7 @@ export declare class RestClientV5 extends BaseRestClient {
      * Query the account borrowable/collateral limit
      *
      * Permission: "Spot trade"
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
      */
     getAccountBorrowCollateralLimit(params: {
         loanCurrency: string;
@@ -1323,6 +1339,7 @@ export declare class RestClientV5 extends BaseRestClient {
     }): Promise<APIResponseV3WithTime<AccountBorrowCollateralLimitV5>>;
     /**
      * Borrow Crypto Loan
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
      *
      * Permission: "Spot trade"
      *
@@ -1336,6 +1353,8 @@ export declare class RestClientV5 extends BaseRestClient {
     /**
      * Repay Crypto Loan
      *
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
+     *
      * You can repay partial loan. If there is interest occurred, interest will be repaid in priority
      *
      * Permission: "Spot trade"
@@ -1354,6 +1373,8 @@ export declare class RestClientV5 extends BaseRestClient {
      * Get Unpaid Loan Orders
      * Query the ongoing loan orders, which are not fully repaid
      *
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
+     *
      * Permission: "Spot trade"
      */
     getUnpaidLoanOrders(params?: GetUnpaidLoanOrdersParamsV5): Promise<APIResponseV3WithTime<{
@@ -1364,6 +1385,8 @@ export declare class RestClientV5 extends BaseRestClient {
      * Get Repayment Transaction History
      * Query repaid transaction history
      *
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
+     *
      * Permission: "Spot trade"
      *
      * INFO:
@@ -1378,6 +1401,8 @@ export declare class RestClientV5 extends BaseRestClient {
      * Get Completed Loan Order History
      * Query the completed loan orders
      *
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
+     *
      * Permission: "Spot trade"
      *
      * INFO:
@@ -1391,6 +1416,8 @@ export declare class RestClientV5 extends BaseRestClient {
      * Get Max. Allowed Reduction Collateral Amount
      * Query the maximum allowed reduction collateral amount
      *
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
+     *
      * Permission: "Spot trade"
      */
     getMaxAllowedReductionCollateralAmount(params: {
@@ -1402,6 +1429,8 @@ export declare class RestClientV5 extends BaseRestClient {
      * Adjust Collateral Amount
      * You can increase or reduce collateral amount. When you reduce, please follow the max. allowed reduction amount.
      *
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
+     *
      * Permission: "Spot trade"
      *
      * INFO:
@@ -1418,6 +1447,8 @@ export declare class RestClientV5 extends BaseRestClient {
      * Get Loan LTV Adjustment History
      * Query the transaction history of collateral amount adjustment
      *
+     * @deprecated - Use "Crypto Loan - New" Endpoints instead
+     *
      * Permission: "Spot trade"
      *
      * INFO:
@@ -1428,6 +1459,178 @@ export declare class RestClientV5 extends BaseRestClient {
         list: LoanLTVAdjustmentHistoryV5[];
         nextPageCursor: string;
     }>>;
+    /**
+     *
+     ****** Crypto Loan New
+     *
+     */
+    /**
+     * Get Borrowable Coins New
+     *
+     */
+    getLoanBorrowableCoins(params?: GetBorrowableCoinsParamsV5): Promise<APIResponseV3WithTime<{
+        list: BorrowableCoinV5[];
+    }>>;
+    /**
+     * Get Collateral Coins New
+     *
+     */
+    getLoanCollateralCoins(params?: GetCollateralCoinsParamsV5): Promise<APIResponseV3WithTime<CollateralDataV5>>;
+    /**
+     * Get Max. Allowed Collateral Reduction Amount New
+     *
+     */
+    getMaxCollateralAmount(params: GetMaxCollateralAmountParamsV5): Promise<APIResponseV3WithTime<{
+        maxCollateralAmount: string;
+    }>>;
+    /**
+     * Adjust Collateral Amount New
+     * You can increase or reduce your collateral amount. When you reduce, please obey the Get Max. Allowed Collateral Reduction Amount
+     */
+    updateCollateralAmount(params: AdjustCollateralAmountParamsV5): Promise<APIResponseV3WithTime<AdjustCollateralAmountV5>>;
+    /**
+     * Get Collateral Adjustment History New
+     * Query for your LTV adjustment history.
+     *
+     */
+    getCollateralAdjustmentHistory(params?: GetCollateralAdjustmentHistoryParamsV5): Promise<APIResponseV3WithTime<{
+        list: CollateralAdjustmentHistoryV5[];
+        nextPageCursor: string;
+    }>>;
+    /**
+     * Get Crypto Loan Position New
+     *
+     */
+    getCryptoLoanPosition(): Promise<APIResponseV3WithTime<CryptoLoanPositionV5>>;
+    /**
+     *
+     ****** Crypto Loan New - Flexible Loan
+     *
+     */
+    /**
+     * Borrow Flexible Loan
+     * Fully or partially repay a loan. If interest is due, that is paid off first, with the loaned amount being paid off only after due interest.
+     *
+     */
+    borrowFlexible(params: BorrowFlexibleParamsV5): Promise<APIResponseV3WithTime<BorrowFlexibleV5>>;
+    /**
+     * Repay Flexible Loan
+     * Fully or partially repay a loan. If interest is due, that is paid off first, with the loaned amount being paid off only after due interest.
+     *
+     */
+    repayFlexible(params: RepayFlexibleParamsV5): Promise<APIResponseV3WithTime<RepayFlexibleV5>>;
+    /**
+     * Get Flexible Loans
+     * Query for your ongoing loans
+     *
+     */
+    getOngoingFlexibleLoans(params?: GetOngoingFlexibleLoansParamsV5): Promise<APIResponseV3WithTime<{
+        list: OngoingFlexibleLoanV5[];
+    }>>;
+    /**
+     * Get Borrow Orders History
+     *
+     */
+    getBorrowHistoryFlexible(params?: GetBorrowHistoryFlexibleParamsV5): Promise<APIResponseV3WithTime<{
+        list: BorrowHistoryFlexibleV5[];
+        nextPageCursor: string;
+    }>>;
+    /**
+     * Get Repayment Orders History
+     *
+     */
+    getRepaymentHistoryFlexible(params?: GetRepaymentHistoryFlexibleParamsV5): Promise<APIResponseV3WithTime<{
+        list: RepaymentHistoryFlexibleV5[];
+        nextPageCursor: string;
+    }>>;
+    /**
+     *
+     ****** Fixed Loan
+     *
+     */
+    /**
+     * Get Supplying Market
+     * If you want to supply, you can use this endpoint to check whether there are any suitable counterparty borrow orders available.
+     *
+     */
+    getSupplyOrderQuoteFixed(params: GetSupplyOrderQuoteFixedParamsV5): Promise<APIResponseV3WithTime<{
+        list: SupplyOrderQuoteFixedV5[];
+    }>>;
+    /**
+     * Get Borrowing Market
+     * If you want to borrow, you can use this endpoint to check whether there are any suitable counterparty supply orders available.
+     *
+     */
+    getBorrowOrderQuoteFixed(params: GetBorrowOrderQuoteFixedParamsV5): Promise<APIResponseV3WithTime<{
+        list: BorrowOrderQuoteFixedV5[];
+    }>>;
+    /**
+     * Create Borrow Order
+     * The loan funds are released to the Funding wallet.
+     * The collateral funds are deducted from the Funding wallet, so make sure you have enough collateral amount in the Funding wallet.
+     */
+    createBorrowOrderFixed(params: CreateBorrowOrderFixedParamsV5): Promise<APIResponseV3WithTime<CreateBorrowOrderFixedV5>>;
+    /**
+     * Create Supply Order
+     *
+     * Permission: "Spot trade"
+     */
+    createSupplyOrderFixed(params: CreateSupplyOrderFixedParamsV5): Promise<APIResponseV3WithTime<CreateSupplyOrderFixedV5>>;
+    /**
+     * Cancel Borrow Order
+     *
+     */
+    cancelBorrowOrderFixed(params: CancelBorrowOrderFixedParamsV5): Promise<APIResponseV3WithTime<{}>>;
+    /**
+     * Cancel Supply Order
+     */
+    cancelSupplyOrderFixed(params: CancelSupplyOrderFixedParamsV5): Promise<APIResponseV3WithTime<{}>>;
+    /**
+     * Get Borrow Contract Info
+     *
+     */
+    getBorrowContractInfoFixed(params?: GetBorrowContractInfoFixedParamsV5): Promise<APIResponseV3WithTime<{
+        list: BorrowContractInfoFixedV5[];
+        nextPageCursor: string;
+    }>>;
+    /**
+     * Get Supply Contract Info
+     *
+     */
+    getSupplyContractInfoFixed(params?: GetSupplyContractInfoFixedParamsV5): Promise<APIResponseV3WithTime<{
+        list: SupplyContractInfoFixedV5[];
+        nextPageCursor: string;
+    }>>;
+    /**
+     * Get Borrow Order Info
+     *
+     */
+    getBorrowOrderInfoFixed(params?: GetBorrowOrderInfoFixedParamsV5): Promise<APIResponseV3WithTime<{
+        list: BorrowOrderInfoFixedV5[];
+        nextPageCursor: string;
+    }>>;
+    /**
+     * Get Supply Order Info
+     *
+     */
+    getSupplyOrderInfoFixed(params?: GetSupplyOrderInfoFixedParamsV5): Promise<APIResponseV3WithTime<{
+        list: SupplyOrderInfoFixedV5[];
+        nextPageCursor: string;
+    }>>;
+    /**
+     * Repay Fixed Loan
+     * Either loanId or loanCurrency needs to be passed
+     *
+     */
+    repayFixed(params: RepayFixedParamsV5): Promise<APIResponseV3WithTime<RepayFixedV5>>;
+    /**
+     * Get Repayment History
+     *
+     */
+    getRepaymentHistoryFixed(params?: GetRepaymentHistoryFixedParamsV5): Promise<APIResponseV3WithTime<{
+        list: RepaymentHistoryFixedV5[];
+        nextPageCursor: string;
+    }>>;
     /**
      *
      ****** Institutional Lending