bybit-api 4.2.0 → 4.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- 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';
1
+ 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';
2
2
  import BaseRestClient from './util/BaseRestClient';
3
3
  /**
4
4
  * REST API client for V5 REST APIs
@@ -24,6 +24,9 @@ export declare class RestClientV5 extends BaseRestClient {
24
24
  ****** Misc Bybit APIs
25
25
  *
26
26
  */
27
+ getSystemStatus(params?: GetSystemStatusParamsV5): Promise<APIResponseV3WithTime<{
28
+ list: SystemStatusItemV5[];
29
+ }>>;
27
30
  getClientType(): "v5";
28
31
  fetchServerTime(): Promise<number>;
29
32
  getServerTime(): Promise<APIResponseV3WithTime<{
@@ -687,6 +690,14 @@ export declare class RestClientV5 extends BaseRestClient {
687
690
  setSpotHedging(params: {
688
691
  setHedgingMode: 'ON' | 'OFF';
689
692
  }): Promise<APIResponseV3WithTime<{}>>;
693
+ /**
694
+ * Set Limit Price Behaviour
695
+ * You can configure how the system behaves when your limit order price exceeds the highest bid or lowest ask price.
696
+ *
697
+ * Spot: If the order price exceeds the boundary, the system rejects the request.
698
+ * Futures: If the order price exceeds the boundary, the system will automatically adjust the price to the nearest allowed boundary.
699
+ */
700
+ setLimitPriceAction(params: SetLimitPriceActionParamsV5): Promise<APIResponseV3WithTime<{}>>;
690
701
  /**
691
702
  * Configure Market Maker Protection (MMP)
692
703
  */
@@ -1286,13 +1297,16 @@ export declare class RestClientV5 extends BaseRestClient {
1286
1297
  }>>;
1287
1298
  /**
1288
1299
  *
1289
- ****** Crypto Loan
1300
+ ****** Crypto Loan - Legacy
1301
+ *
1302
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1290
1303
  *
1291
1304
  */
1292
1305
  /**
1293
1306
  * Get Collateral Coins
1294
1307
  *
1295
1308
  * INFO: Do not need authentication
1309
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1296
1310
  */
1297
1311
  getCollateralCoins(params?: {
1298
1312
  vipLevel?: string;
@@ -1304,6 +1318,7 @@ export declare class RestClientV5 extends BaseRestClient {
1304
1318
  * Get Borrowable Coins
1305
1319
  *
1306
1320
  * INFO: Do not need authentication
1321
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1307
1322
  */
1308
1323
  getBorrowableCoins(params?: {
1309
1324
  vipLevel?: string;
@@ -1316,6 +1331,7 @@ export declare class RestClientV5 extends BaseRestClient {
1316
1331
  * Query the account borrowable/collateral limit
1317
1332
  *
1318
1333
  * Permission: "Spot trade"
1334
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1319
1335
  */
1320
1336
  getAccountBorrowCollateralLimit(params: {
1321
1337
  loanCurrency: string;
@@ -1323,6 +1339,7 @@ export declare class RestClientV5 extends BaseRestClient {
1323
1339
  }): Promise<APIResponseV3WithTime<AccountBorrowCollateralLimitV5>>;
1324
1340
  /**
1325
1341
  * Borrow Crypto Loan
1342
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1326
1343
  *
1327
1344
  * Permission: "Spot trade"
1328
1345
  *
@@ -1336,6 +1353,8 @@ export declare class RestClientV5 extends BaseRestClient {
1336
1353
  /**
1337
1354
  * Repay Crypto Loan
1338
1355
  *
1356
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1357
+ *
1339
1358
  * You can repay partial loan. If there is interest occurred, interest will be repaid in priority
1340
1359
  *
1341
1360
  * Permission: "Spot trade"
@@ -1354,6 +1373,8 @@ export declare class RestClientV5 extends BaseRestClient {
1354
1373
  * Get Unpaid Loan Orders
1355
1374
  * Query the ongoing loan orders, which are not fully repaid
1356
1375
  *
1376
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1377
+ *
1357
1378
  * Permission: "Spot trade"
1358
1379
  */
1359
1380
  getUnpaidLoanOrders(params?: GetUnpaidLoanOrdersParamsV5): Promise<APIResponseV3WithTime<{
@@ -1364,6 +1385,8 @@ export declare class RestClientV5 extends BaseRestClient {
1364
1385
  * Get Repayment Transaction History
1365
1386
  * Query repaid transaction history
1366
1387
  *
1388
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1389
+ *
1367
1390
  * Permission: "Spot trade"
1368
1391
  *
1369
1392
  * INFO:
@@ -1378,6 +1401,8 @@ export declare class RestClientV5 extends BaseRestClient {
1378
1401
  * Get Completed Loan Order History
1379
1402
  * Query the completed loan orders
1380
1403
  *
1404
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1405
+ *
1381
1406
  * Permission: "Spot trade"
1382
1407
  *
1383
1408
  * INFO:
@@ -1391,6 +1416,8 @@ export declare class RestClientV5 extends BaseRestClient {
1391
1416
  * Get Max. Allowed Reduction Collateral Amount
1392
1417
  * Query the maximum allowed reduction collateral amount
1393
1418
  *
1419
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1420
+ *
1394
1421
  * Permission: "Spot trade"
1395
1422
  */
1396
1423
  getMaxAllowedReductionCollateralAmount(params: {
@@ -1402,6 +1429,8 @@ export declare class RestClientV5 extends BaseRestClient {
1402
1429
  * Adjust Collateral Amount
1403
1430
  * You can increase or reduce collateral amount. When you reduce, please follow the max. allowed reduction amount.
1404
1431
  *
1432
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1433
+ *
1405
1434
  * Permission: "Spot trade"
1406
1435
  *
1407
1436
  * INFO:
@@ -1418,6 +1447,8 @@ export declare class RestClientV5 extends BaseRestClient {
1418
1447
  * Get Loan LTV Adjustment History
1419
1448
  * Query the transaction history of collateral amount adjustment
1420
1449
  *
1450
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1451
+ *
1421
1452
  * Permission: "Spot trade"
1422
1453
  *
1423
1454
  * INFO:
@@ -1428,6 +1459,178 @@ export declare class RestClientV5 extends BaseRestClient {
1428
1459
  list: LoanLTVAdjustmentHistoryV5[];
1429
1460
  nextPageCursor: string;
1430
1461
  }>>;
1462
+ /**
1463
+ *
1464
+ ****** Crypto Loan New
1465
+ *
1466
+ */
1467
+ /**
1468
+ * Get Borrowable Coins New
1469
+ *
1470
+ */
1471
+ getLoanBorrowableCoins(params?: GetBorrowableCoinsParamsV5): Promise<APIResponseV3WithTime<{
1472
+ list: BorrowableCoinV5[];
1473
+ }>>;
1474
+ /**
1475
+ * Get Collateral Coins New
1476
+ *
1477
+ */
1478
+ getLoanCollateralCoins(params?: GetCollateralCoinsParamsV5): Promise<APIResponseV3WithTime<CollateralDataV5>>;
1479
+ /**
1480
+ * Get Max. Allowed Collateral Reduction Amount New
1481
+ *
1482
+ */
1483
+ getMaxCollateralAmount(params: GetMaxCollateralAmountParamsV5): Promise<APIResponseV3WithTime<{
1484
+ maxCollateralAmount: string;
1485
+ }>>;
1486
+ /**
1487
+ * Adjust Collateral Amount New
1488
+ * You can increase or reduce your collateral amount. When you reduce, please obey the Get Max. Allowed Collateral Reduction Amount
1489
+ */
1490
+ updateCollateralAmount(params: AdjustCollateralAmountParamsV5): Promise<APIResponseV3WithTime<AdjustCollateralAmountV5>>;
1491
+ /**
1492
+ * Get Collateral Adjustment History New
1493
+ * Query for your LTV adjustment history.
1494
+ *
1495
+ */
1496
+ getCollateralAdjustmentHistory(params?: GetCollateralAdjustmentHistoryParamsV5): Promise<APIResponseV3WithTime<{
1497
+ list: CollateralAdjustmentHistoryV5[];
1498
+ nextPageCursor: string;
1499
+ }>>;
1500
+ /**
1501
+ * Get Crypto Loan Position New
1502
+ *
1503
+ */
1504
+ getCryptoLoanPosition(): Promise<APIResponseV3WithTime<CryptoLoanPositionV5>>;
1505
+ /**
1506
+ *
1507
+ ****** Crypto Loan New - Flexible Loan
1508
+ *
1509
+ */
1510
+ /**
1511
+ * Borrow Flexible Loan
1512
+ * 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.
1513
+ *
1514
+ */
1515
+ borrowFlexible(params: BorrowFlexibleParamsV5): Promise<APIResponseV3WithTime<BorrowFlexibleV5>>;
1516
+ /**
1517
+ * Repay Flexible Loan
1518
+ * 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.
1519
+ *
1520
+ */
1521
+ repayFlexible(params: RepayFlexibleParamsV5): Promise<APIResponseV3WithTime<RepayFlexibleV5>>;
1522
+ /**
1523
+ * Get Flexible Loans
1524
+ * Query for your ongoing loans
1525
+ *
1526
+ */
1527
+ getOngoingFlexibleLoans(params?: GetOngoingFlexibleLoansParamsV5): Promise<APIResponseV3WithTime<{
1528
+ list: OngoingFlexibleLoanV5[];
1529
+ }>>;
1530
+ /**
1531
+ * Get Borrow Orders History
1532
+ *
1533
+ */
1534
+ getBorrowHistoryFlexible(params?: GetBorrowHistoryFlexibleParamsV5): Promise<APIResponseV3WithTime<{
1535
+ list: BorrowHistoryFlexibleV5[];
1536
+ nextPageCursor: string;
1537
+ }>>;
1538
+ /**
1539
+ * Get Repayment Orders History
1540
+ *
1541
+ */
1542
+ getRepaymentHistoryFlexible(params?: GetRepaymentHistoryFlexibleParamsV5): Promise<APIResponseV3WithTime<{
1543
+ list: RepaymentHistoryFlexibleV5[];
1544
+ nextPageCursor: string;
1545
+ }>>;
1546
+ /**
1547
+ *
1548
+ ****** Fixed Loan
1549
+ *
1550
+ */
1551
+ /**
1552
+ * Get Supplying Market
1553
+ * If you want to supply, you can use this endpoint to check whether there are any suitable counterparty borrow orders available.
1554
+ *
1555
+ */
1556
+ getSupplyOrderQuoteFixed(params: GetSupplyOrderQuoteFixedParamsV5): Promise<APIResponseV3WithTime<{
1557
+ list: SupplyOrderQuoteFixedV5[];
1558
+ }>>;
1559
+ /**
1560
+ * Get Borrowing Market
1561
+ * If you want to borrow, you can use this endpoint to check whether there are any suitable counterparty supply orders available.
1562
+ *
1563
+ */
1564
+ getBorrowOrderQuoteFixed(params: GetBorrowOrderQuoteFixedParamsV5): Promise<APIResponseV3WithTime<{
1565
+ list: BorrowOrderQuoteFixedV5[];
1566
+ }>>;
1567
+ /**
1568
+ * Create Borrow Order
1569
+ * The loan funds are released to the Funding wallet.
1570
+ * The collateral funds are deducted from the Funding wallet, so make sure you have enough collateral amount in the Funding wallet.
1571
+ */
1572
+ createBorrowOrderFixed(params: CreateBorrowOrderFixedParamsV5): Promise<APIResponseV3WithTime<CreateBorrowOrderFixedV5>>;
1573
+ /**
1574
+ * Create Supply Order
1575
+ *
1576
+ * Permission: "Spot trade"
1577
+ */
1578
+ createSupplyOrderFixed(params: CreateSupplyOrderFixedParamsV5): Promise<APIResponseV3WithTime<CreateSupplyOrderFixedV5>>;
1579
+ /**
1580
+ * Cancel Borrow Order
1581
+ *
1582
+ */
1583
+ cancelBorrowOrderFixed(params: CancelBorrowOrderFixedParamsV5): Promise<APIResponseV3WithTime<{}>>;
1584
+ /**
1585
+ * Cancel Supply Order
1586
+ */
1587
+ cancelSupplyOrderFixed(params: CancelSupplyOrderFixedParamsV5): Promise<APIResponseV3WithTime<{}>>;
1588
+ /**
1589
+ * Get Borrow Contract Info
1590
+ *
1591
+ */
1592
+ getBorrowContractInfoFixed(params?: GetBorrowContractInfoFixedParamsV5): Promise<APIResponseV3WithTime<{
1593
+ list: BorrowContractInfoFixedV5[];
1594
+ nextPageCursor: string;
1595
+ }>>;
1596
+ /**
1597
+ * Get Supply Contract Info
1598
+ *
1599
+ */
1600
+ getSupplyContractInfoFixed(params?: GetSupplyContractInfoFixedParamsV5): Promise<APIResponseV3WithTime<{
1601
+ list: SupplyContractInfoFixedV5[];
1602
+ nextPageCursor: string;
1603
+ }>>;
1604
+ /**
1605
+ * Get Borrow Order Info
1606
+ *
1607
+ */
1608
+ getBorrowOrderInfoFixed(params?: GetBorrowOrderInfoFixedParamsV5): Promise<APIResponseV3WithTime<{
1609
+ list: BorrowOrderInfoFixedV5[];
1610
+ nextPageCursor: string;
1611
+ }>>;
1612
+ /**
1613
+ * Get Supply Order Info
1614
+ *
1615
+ */
1616
+ getSupplyOrderInfoFixed(params?: GetSupplyOrderInfoFixedParamsV5): Promise<APIResponseV3WithTime<{
1617
+ list: SupplyOrderInfoFixedV5[];
1618
+ nextPageCursor: string;
1619
+ }>>;
1620
+ /**
1621
+ * Repay Fixed Loan
1622
+ * Either loanId or loanCurrency needs to be passed
1623
+ *
1624
+ */
1625
+ repayFixed(params: RepayFixedParamsV5): Promise<APIResponseV3WithTime<RepayFixedV5>>;
1626
+ /**
1627
+ * Get Repayment History
1628
+ *
1629
+ */
1630
+ getRepaymentHistoryFixed(params?: GetRepaymentHistoryFixedParamsV5): Promise<APIResponseV3WithTime<{
1631
+ list: RepaymentHistoryFixedV5[];
1632
+ nextPageCursor: string;
1633
+ }>>;
1431
1634
  /**
1432
1635
  *
1433
1636
  ****** Institutional Lending
@@ -75,6 +75,9 @@ class RestClientV5 extends BaseRestClient_1.default {
75
75
  ****** Misc Bybit APIs
76
76
  *
77
77
  */
78
+ getSystemStatus(params) {
79
+ return this.getPrivate('/v5/system/status', params);
80
+ }
78
81
  getClientType() {
79
82
  return util_1.REST_CLIENT_TYPE_ENUM.v5;
80
83
  }
@@ -817,6 +820,16 @@ class RestClientV5 extends BaseRestClient_1.default {
817
820
  setSpotHedging(params) {
818
821
  return this.postPrivate('/v5/account/set-hedging-mode', params);
819
822
  }
823
+ /**
824
+ * Set Limit Price Behaviour
825
+ * You can configure how the system behaves when your limit order price exceeds the highest bid or lowest ask price.
826
+ *
827
+ * Spot: If the order price exceeds the boundary, the system rejects the request.
828
+ * Futures: If the order price exceeds the boundary, the system will automatically adjust the price to the nearest allowed boundary.
829
+ */
830
+ setLimitPriceAction(params) {
831
+ return this.postPrivate('/v5/account/set-limit-px-action', params);
832
+ }
820
833
  /**
821
834
  * Configure Market Maker Protection (MMP)
822
835
  */
@@ -1374,13 +1387,16 @@ class RestClientV5 extends BaseRestClient_1.default {
1374
1387
  }
1375
1388
  /**
1376
1389
  *
1377
- ****** Crypto Loan
1390
+ ****** Crypto Loan - Legacy
1391
+ *
1392
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1378
1393
  *
1379
1394
  */
1380
1395
  /**
1381
1396
  * Get Collateral Coins
1382
1397
  *
1383
1398
  * INFO: Do not need authentication
1399
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1384
1400
  */
1385
1401
  getCollateralCoins(params) {
1386
1402
  return this.get('/v5/crypto-loan/collateral-data', params);
@@ -1389,6 +1405,7 @@ class RestClientV5 extends BaseRestClient_1.default {
1389
1405
  * Get Borrowable Coins
1390
1406
  *
1391
1407
  * INFO: Do not need authentication
1408
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1392
1409
  */
1393
1410
  getBorrowableCoins(params) {
1394
1411
  return this.get('/v5/crypto-loan/loanable-data', params);
@@ -1398,12 +1415,14 @@ class RestClientV5 extends BaseRestClient_1.default {
1398
1415
  * Query the account borrowable/collateral limit
1399
1416
  *
1400
1417
  * Permission: "Spot trade"
1418
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1401
1419
  */
1402
1420
  getAccountBorrowCollateralLimit(params) {
1403
1421
  return this.getPrivate('/v5/crypto-loan/borrowable-collateralisable-number', params);
1404
1422
  }
1405
1423
  /**
1406
1424
  * Borrow Crypto Loan
1425
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1407
1426
  *
1408
1427
  * Permission: "Spot trade"
1409
1428
  *
@@ -1417,6 +1436,8 @@ class RestClientV5 extends BaseRestClient_1.default {
1417
1436
  /**
1418
1437
  * Repay Crypto Loan
1419
1438
  *
1439
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1440
+ *
1420
1441
  * You can repay partial loan. If there is interest occurred, interest will be repaid in priority
1421
1442
  *
1422
1443
  * Permission: "Spot trade"
@@ -1432,6 +1453,8 @@ class RestClientV5 extends BaseRestClient_1.default {
1432
1453
  * Get Unpaid Loan Orders
1433
1454
  * Query the ongoing loan orders, which are not fully repaid
1434
1455
  *
1456
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1457
+ *
1435
1458
  * Permission: "Spot trade"
1436
1459
  */
1437
1460
  getUnpaidLoanOrders(params) {
@@ -1441,6 +1464,8 @@ class RestClientV5 extends BaseRestClient_1.default {
1441
1464
  * Get Repayment Transaction History
1442
1465
  * Query repaid transaction history
1443
1466
  *
1467
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1468
+ *
1444
1469
  * Permission: "Spot trade"
1445
1470
  *
1446
1471
  * INFO:
@@ -1454,6 +1479,8 @@ class RestClientV5 extends BaseRestClient_1.default {
1454
1479
  * Get Completed Loan Order History
1455
1480
  * Query the completed loan orders
1456
1481
  *
1482
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1483
+ *
1457
1484
  * Permission: "Spot trade"
1458
1485
  *
1459
1486
  * INFO:
@@ -1466,6 +1493,8 @@ class RestClientV5 extends BaseRestClient_1.default {
1466
1493
  * Get Max. Allowed Reduction Collateral Amount
1467
1494
  * Query the maximum allowed reduction collateral amount
1468
1495
  *
1496
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1497
+ *
1469
1498
  * Permission: "Spot trade"
1470
1499
  */
1471
1500
  getMaxAllowedReductionCollateralAmount(params) {
@@ -1475,6 +1504,8 @@ class RestClientV5 extends BaseRestClient_1.default {
1475
1504
  * Adjust Collateral Amount
1476
1505
  * You can increase or reduce collateral amount. When you reduce, please follow the max. allowed reduction amount.
1477
1506
  *
1507
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1508
+ *
1478
1509
  * Permission: "Spot trade"
1479
1510
  *
1480
1511
  * INFO:
@@ -1487,6 +1518,8 @@ class RestClientV5 extends BaseRestClient_1.default {
1487
1518
  * Get Loan LTV Adjustment History
1488
1519
  * Query the transaction history of collateral amount adjustment
1489
1520
  *
1521
+ * @deprecated - Use "Crypto Loan - New" Endpoints instead
1522
+ *
1490
1523
  * Permission: "Spot trade"
1491
1524
  *
1492
1525
  * INFO:
@@ -1496,6 +1529,190 @@ class RestClientV5 extends BaseRestClient_1.default {
1496
1529
  getLoanLTVAdjustmentHistory(params) {
1497
1530
  return this.getPrivate('/v5/crypto-loan/adjustment-history', params);
1498
1531
  }
1532
+ /**
1533
+ *
1534
+ ****** Crypto Loan New
1535
+ *
1536
+ */
1537
+ /**
1538
+ * Get Borrowable Coins New
1539
+ *
1540
+ */
1541
+ getLoanBorrowableCoins(params) {
1542
+ return this.get('/v5/crypto-loan-common/loanable-data', params);
1543
+ }
1544
+ /**
1545
+ * Get Collateral Coins New
1546
+ *
1547
+ */
1548
+ getLoanCollateralCoins(params) {
1549
+ return this.get('/v5/crypto-loan-common/collateral-data', params);
1550
+ }
1551
+ /**
1552
+ * Get Max. Allowed Collateral Reduction Amount New
1553
+ *
1554
+ */
1555
+ getMaxCollateralAmount(params) {
1556
+ return this.getPrivate('/v5/crypto-loan-common/max-collateral-amount', params);
1557
+ }
1558
+ /**
1559
+ * Adjust Collateral Amount New
1560
+ * You can increase or reduce your collateral amount. When you reduce, please obey the Get Max. Allowed Collateral Reduction Amount
1561
+ */
1562
+ updateCollateralAmount(params) {
1563
+ return this.postPrivate('/v5/crypto-loan-common/adjust-ltv', params);
1564
+ }
1565
+ /**
1566
+ * Get Collateral Adjustment History New
1567
+ * Query for your LTV adjustment history.
1568
+ *
1569
+ */
1570
+ getCollateralAdjustmentHistory(params) {
1571
+ return this.getPrivate('/v5/crypto-loan-common/adjustment-history', params);
1572
+ }
1573
+ /**
1574
+ * Get Crypto Loan Position New
1575
+ *
1576
+ */
1577
+ getCryptoLoanPosition() {
1578
+ return this.getPrivate('/v5/crypto-loan-common/position');
1579
+ }
1580
+ /**
1581
+ *
1582
+ ****** Crypto Loan New - Flexible Loan
1583
+ *
1584
+ */
1585
+ /**
1586
+ * Borrow Flexible Loan
1587
+ * 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.
1588
+ *
1589
+ */
1590
+ borrowFlexible(params) {
1591
+ return this.postPrivate('/v5/crypto-loan-flexible/borrow', params);
1592
+ }
1593
+ /**
1594
+ * Repay Flexible Loan
1595
+ * 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.
1596
+ *
1597
+ */
1598
+ repayFlexible(params) {
1599
+ return this.postPrivate('/v5/crypto-loan-flexible/repay', params);
1600
+ }
1601
+ /**
1602
+ * Get Flexible Loans
1603
+ * Query for your ongoing loans
1604
+ *
1605
+ */
1606
+ getOngoingFlexibleLoans(params) {
1607
+ return this.getPrivate('/v5/crypto-loan-flexible/ongoing-coin', params);
1608
+ }
1609
+ /**
1610
+ * Get Borrow Orders History
1611
+ *
1612
+ */
1613
+ getBorrowHistoryFlexible(params) {
1614
+ return this.getPrivate('/v5/crypto-loan-flexible/borrow-history', params);
1615
+ }
1616
+ /**
1617
+ * Get Repayment Orders History
1618
+ *
1619
+ */
1620
+ getRepaymentHistoryFlexible(params) {
1621
+ return this.getPrivate('/v5/crypto-loan-flexible/repayment-history', params);
1622
+ }
1623
+ /**
1624
+ *
1625
+ ****** Fixed Loan
1626
+ *
1627
+ */
1628
+ /**
1629
+ * Get Supplying Market
1630
+ * If you want to supply, you can use this endpoint to check whether there are any suitable counterparty borrow orders available.
1631
+ *
1632
+ */
1633
+ getSupplyOrderQuoteFixed(params) {
1634
+ return this.get('/v5/crypto-loan-fixed/supply-order-quote', params);
1635
+ }
1636
+ /**
1637
+ * Get Borrowing Market
1638
+ * If you want to borrow, you can use this endpoint to check whether there are any suitable counterparty supply orders available.
1639
+ *
1640
+ */
1641
+ getBorrowOrderQuoteFixed(params) {
1642
+ return this.get('/v5/crypto-loan-fixed/borrow-order-quote', params);
1643
+ }
1644
+ /**
1645
+ * Create Borrow Order
1646
+ * The loan funds are released to the Funding wallet.
1647
+ * The collateral funds are deducted from the Funding wallet, so make sure you have enough collateral amount in the Funding wallet.
1648
+ */
1649
+ createBorrowOrderFixed(params) {
1650
+ return this.postPrivate('/v5/crypto-loan-fixed/borrow', params);
1651
+ }
1652
+ /**
1653
+ * Create Supply Order
1654
+ *
1655
+ * Permission: "Spot trade"
1656
+ */
1657
+ createSupplyOrderFixed(params) {
1658
+ return this.postPrivate('/v5/crypto-loan-fixed/supply', params);
1659
+ }
1660
+ /**
1661
+ * Cancel Borrow Order
1662
+ *
1663
+ */
1664
+ cancelBorrowOrderFixed(params) {
1665
+ return this.postPrivate('/v5/crypto-loan-fixed/borrow-order-cancel', params);
1666
+ }
1667
+ /**
1668
+ * Cancel Supply Order
1669
+ */
1670
+ cancelSupplyOrderFixed(params) {
1671
+ return this.postPrivate('/v5/crypto-loan-fixed/supply-order-cancel', params);
1672
+ }
1673
+ /**
1674
+ * Get Borrow Contract Info
1675
+ *
1676
+ */
1677
+ getBorrowContractInfoFixed(params) {
1678
+ return this.getPrivate('/v5/crypto-loan-fixed/borrow-contract-info', params);
1679
+ }
1680
+ /**
1681
+ * Get Supply Contract Info
1682
+ *
1683
+ */
1684
+ getSupplyContractInfoFixed(params) {
1685
+ return this.getPrivate('/v5/crypto-loan-fixed/supply-contract-info', params);
1686
+ }
1687
+ /**
1688
+ * Get Borrow Order Info
1689
+ *
1690
+ */
1691
+ getBorrowOrderInfoFixed(params) {
1692
+ return this.getPrivate('/v5/crypto-loan-fixed/borrow-order-info', params);
1693
+ }
1694
+ /**
1695
+ * Get Supply Order Info
1696
+ *
1697
+ */
1698
+ getSupplyOrderInfoFixed(params) {
1699
+ return this.getPrivate('/v5/crypto-loan-fixed/supply-order-info', params);
1700
+ }
1701
+ /**
1702
+ * Repay Fixed Loan
1703
+ * Either loanId or loanCurrency needs to be passed
1704
+ *
1705
+ */
1706
+ repayFixed(params) {
1707
+ return this.postPrivate('/v5/crypto-loan-fixed/fully-repay', params);
1708
+ }
1709
+ /**
1710
+ * Get Repayment History
1711
+ *
1712
+ */
1713
+ getRepaymentHistoryFixed(params) {
1714
+ return this.getPrivate('/v5/crypto-loan-fixed/repayment-history', params);
1715
+ }
1499
1716
  /**
1500
1717
  *
1501
1718
  ****** Institutional Lending