bybit-api 4.6.0 → 4.6.2

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.
Files changed (77) hide show
  1. package/README.md +3 -2
  2. package/lib/constants/enum.d.ts +1 -0
  3. package/lib/constants/enum.js +1 -0
  4. package/lib/constants/enum.js.map +1 -1
  5. package/lib/rest-client-v5.d.ts +419 -14
  6. package/lib/rest-client-v5.js +492 -4
  7. package/lib/rest-client-v5.js.map +1 -1
  8. package/lib/types/request/index.d.ts +6 -0
  9. package/lib/types/request/index.js +6 -0
  10. package/lib/types/request/index.js.map +1 -1
  11. package/lib/types/request/v5-account.d.ts +26 -0
  12. package/lib/types/request/v5-alpha-trade.d.ts +52 -0
  13. package/lib/types/request/v5-alpha-trade.js +6 -0
  14. package/lib/types/request/v5-alpha-trade.js.map +1 -0
  15. package/lib/types/request/v5-asset.d.ts +37 -2
  16. package/lib/types/request/v5-broker.d.ts +14 -0
  17. package/lib/types/request/v5-card.d.ts +51 -0
  18. package/lib/types/request/v5-card.js +7 -0
  19. package/lib/types/request/v5-card.js.map +1 -0
  20. package/lib/types/request/v5-earn-advance-discount.d.ts +75 -0
  21. package/lib/types/request/v5-earn-advance-discount.js +3 -0
  22. package/lib/types/request/v5-earn-advance-discount.js.map +1 -0
  23. package/lib/types/request/v5-earn-fixed-term.d.ts +42 -0
  24. package/lib/types/request/v5-earn-fixed-term.js +3 -0
  25. package/lib/types/request/v5-earn-fixed-term.js.map +1 -0
  26. package/lib/types/request/v5-earn-liquidity-mining.d.ts +7 -0
  27. package/lib/types/request/v5-earn-liquidity-mining.js +3 -0
  28. package/lib/types/request/v5-earn-liquidity-mining.js.map +1 -0
  29. package/lib/types/request/v5-earn-token.d.ts +49 -0
  30. package/lib/types/request/v5-earn-token.js +6 -0
  31. package/lib/types/request/v5-earn-token.js.map +1 -0
  32. package/lib/types/request/v5-earn.d.ts +24 -0
  33. package/lib/types/request/v5-market.d.ts +10 -1
  34. package/lib/types/request/v5-spot-leverage-token.d.ts +46 -0
  35. package/lib/types/request/v5-spreadtrading.d.ts +7 -0
  36. package/lib/types/request/v5-user.d.ts +15 -1
  37. package/lib/types/response/index.d.ts +6 -0
  38. package/lib/types/response/index.js +6 -0
  39. package/lib/types/response/index.js.map +1 -1
  40. package/lib/types/response/v5-account.d.ts +76 -0
  41. package/lib/types/response/v5-alpha-trade.d.ts +170 -0
  42. package/lib/types/response/v5-alpha-trade.js +6 -0
  43. package/lib/types/response/v5-alpha-trade.js.map +1 -0
  44. package/lib/types/response/v5-asset.d.ts +158 -10
  45. package/lib/types/response/v5-broker.d.ts +18 -0
  46. package/lib/types/response/v5-card.d.ts +118 -0
  47. package/lib/types/response/v5-card.js +3 -0
  48. package/lib/types/response/v5-card.js.map +1 -0
  49. package/lib/types/response/v5-earn-advance-discount.d.ts +143 -0
  50. package/lib/types/response/v5-earn-advance-discount.js +3 -0
  51. package/lib/types/response/v5-earn-advance-discount.js.map +1 -0
  52. package/lib/types/response/v5-earn-fixed-term.d.ts +102 -0
  53. package/lib/types/response/v5-earn-fixed-term.js +3 -0
  54. package/lib/types/response/v5-earn-fixed-term.js.map +1 -0
  55. package/lib/types/response/v5-earn-liquidity-mining.d.ts +31 -0
  56. package/lib/types/response/v5-earn-liquidity-mining.js +3 -0
  57. package/lib/types/response/v5-earn-liquidity-mining.js.map +1 -0
  58. package/lib/types/response/v5-earn-token.d.ts +62 -0
  59. package/lib/types/response/v5-earn-token.js +6 -0
  60. package/lib/types/response/v5-earn-token.js.map +1 -0
  61. package/lib/types/response/v5-earn.d.ts +103 -0
  62. package/lib/types/response/v5-market.d.ts +14 -0
  63. package/lib/types/response/v5-position.d.ts +4 -0
  64. package/lib/types/response/v5-spot-leverage-token.d.ts +56 -0
  65. package/lib/types/response/v5-spreadtrading.d.ts +5 -0
  66. package/lib/types/response/v5-user.d.ts +43 -0
  67. package/lib/types/shared-v5.d.ts +11 -1
  68. package/lib/types/websockets/ws-events.d.ts +4 -0
  69. package/lib/util/BaseWSClient.js +1 -0
  70. package/lib/util/BaseWSClient.js.map +1 -1
  71. package/lib/util/webCryptoAPI.d.ts +1 -1
  72. package/lib/util/webCryptoAPI.js +1 -1
  73. package/lib/util/webCryptoAPI.js.map +1 -1
  74. package/lib/util/websockets/websocket-util.js +1 -0
  75. package/lib/util/websockets/websocket-util.js.map +1 -1
  76. package/llms.txt +8037 -5345
  77. package/package.json +1 -1
@@ -1,4 +1,4 @@
1
- import { AcceptNonLPQuoteParamsV5, AcceptNonLPQuoteResultV5, AccountBorrowCollateralLimitV5, AccountCoinBalanceV5, AccountInfoV5, AccountInstrumentInfoResponseV5, AccountMarginModeV5, AccountOrderV5, AccountTypeV5, AddOrReduceMarginParamsV5, AddOrReduceMarginResultV5, AdjustCollateralAmountParamsV5, AdjustCollateralAmountV5, ADLAlertResponseV5, AffiliateUserInfoV5, AffiliateUserListItemV5, AllCoinsBalanceV5, AllowedDepositCoinInfoV5, AmendOrderParamsV5, AmendSpreadOrderParamsV5, ApiKeyInfoV5, APIP2PResponse, APIResponseV3, APIResponseV3WithTime, AssetInfoV5, AutoRepayModeResultV5, AvailableAmountToRepayV5, BatchAmendOrderParamsV5, BatchAmendOrderResultV5, BatchCancelOrderParamsV5, BatchCancelOrderResultV5, BatchCreateOrderResultV5, BatchOrderParamsV5, BatchOrdersRetExtInfoV5, BorrowableCoinV5, BorrowContractInfoFixedV5, BorrowCryptoLoanParamsV5, BorrowFlexibleParamsV5, BorrowFlexibleV5, BorrowHistoryFlexibleV5, BorrowHistoryRecordV5, BorrowOrderInfoFixedV5, BorrowOrderQuoteFixedV5, BrokerIssuedVoucherV5, BrokerVoucherSpecV5, CancelAllOrdersParamsV5, CancelAllRFQResultV5, CancelBorrowOrderFixedParamsV5, CancelOrderParamsV5, CancelRFQParamsV5, CancelRFQQuoteItemV5, CancelRFQQuoteParamsV5, CancelRFQQuoteResultV5, CancelRFQResultV5, CancelSupplyOrderFixedParamsV5, CategoryCursorListV5, CategoryListV5, CategorySymbolListV5, CategoryV5, ClosedOptionsPositionV5, ClosedPnLV5, CoinExchangeRecordV5, CoinGreeksV5, CoinInfoV5, CoinStateV5, CollateralAdjustmentHistoryV5, CollateralDataV5, CollateralInfoV5, CompletedLoanOrderV5, ConfirmNewRiskLimitParamsV5, ConvertCoinsParamsV5, ConvertCoinSpecV5, ConvertHistoryRecordV5, ConvertQuoteV5, ConvertStatusV5, CreateBorrowOrderFixedParamsV5, CreateBorrowOrderFixedV5, CreateP2PAdParamsV5, CreateRFQParamsV5, CreateRFQQuoteParamsV5, CreateRFQQuoteResultV5, CreateRFQResultV5, CreateSubApiKeyParamsV5, CreateSubApiKeyResultV5, CreateSubMemberParamsV5, CreateSubMemberResultV5, CreateSupplyOrderFixedParamsV5, CreateSupplyOrderFixedV5, CryptoLoanPositionV5, CurrencyPositionTiersV5, CursorListV5, CursorRowsV5, DCPInfoV5, DeleteSubMemberParamsV5, DeliveryPriceV5, DeliveryRecordV5, DepositAddressChainV5, DepositRecordV5, EarnHourlyYieldHistoryV5, EarnOrderHistoryV5, EarnPositionV5, EarnProductV5, EarnYieldHistoryV5, ExchangeBrokerAccountInfoV5, ExchangeBrokerEarningResultV5, ExchangeBrokerSubAccountDepositRecordV5, ExecuteRFQQuoteParamsV5, ExecuteRFQQuoteResultV5, ExecutionV5, FeeGroupStructureResponseV5, FeeRateV5, FiatTradingPairListV5, FundingRateHistoryResponseV5, GetAccountCoinBalanceParamsV5, GetAccountHistoricOrdersParamsV5, GetAccountInstrumentsInfoParamsV5, GetAccountOrdersParamsV5, GetADLAlertParamsV5, GetAffiliateUserListParamsV5, GetAllCoinsBalanceParamsV5, GetAllowedDepositCoinInfoParamsV5, GetAssetInfoParamsV5, GetAutoRepayModeParamsV5, GetAvailableAmountToRepayParamsV5, GetBorrowableCoinsParamsV5, GetBorrowContractInfoFixedParamsV5, GetBorrowHistoryFlexibleParamsV5, GetBorrowHistoryParamsV5, GetBorrowOrderInfoFixedParamsV5, GetBorrowOrderQuoteFixedParamsV5, GetBrokerIssuedVoucherParamsV5, GetBrokerSubAccountDepositsV5, GetClassicTransactionLogsParamsV5, GetClosedOptionsPositionsParamsV5, GetClosedPnLParamsV5, GetCoinExchangeRecordParamsV5, GetCoinStateParamsV5, GetCollateralAdjustmentHistoryParamsV5, GetCollateralCoinsParamsV5, GetCompletedLoanOrderHistoryParamsV5, GetConvertHistoryParamsV5, GetDeliveryPriceParamsV5, GetDeliveryRecordParamsV5, GetDepositRecordParamsV5, GetEarnHourlyYieldHistoryParamsV5, GetEarnOrderHistoryParamsV5, GetEarnPositionParamsV5, GetEarnYieldHistoryParamsV5, GetExchangeBrokerEarningsParamsV5, GetExecutionListParamsV5, GetFeeGroupStructureParamsV5, GetFeeRateParamsV5, GetFiatTradingPairListParamsV5, GetFundingRateHistoryParamsV5, GetHistoricalVolatilityParamsV5, GetIndexPriceComponentsParamsV5, GetIndexPriceKlineParamsV5, GetInstrumentsInfoParamsV5, GetInsuranceParamsV5, GetInternalDepositRecordParamsV5, GetInternalTransferParamsV5, GetKlineParamsV5, GetLoanLTVAdjustmentHistoryParamsV5, GetLongShortRatioParamsV5, GetMarkPriceKlineParamsV5, GetMaxBorrowableAmountParamsV5, GetMaxCollateralAmountParamsV5, GetMaxLoanAmountParamsV5, GetMovePositionHistoryParamsV5, GetOngoingFlexibleLoansParamsV5, GetOpenInterestParamsV5, GetOptionDeliveryPriceParamsV5, GetOrderbookParamsV5, GetP2PAccountCoinsBalanceParamsV5, GetP2PCounterpartyUserInfoParamsV5, GetP2POnlineAdsParamsV5, GetP2POrderMessagesParamsV5, GetP2POrdersParamsV5, GetP2PPendingOrdersParamsV5, GetP2PPersonalAdsParamsV5, GetPositionTiersParamsV5, GetPremiumIndexPriceKlineParamsV5, GetPreUpgradeClosedPnlParamsV5, GetPreUpgradeOptionDeliveryRecordParamsV5, GetPreUpgradeOrderHistoryParamsV5, GetPreUpgradeTradeHistoryParamsV5, GetPreUpgradeTransactionLogParamsV5, GetPreUpgradeUSDCSessionParamsV5, GetPublicTradingHistoryParamsV5, GetRenewOrderInfoFixedParamsV5, GetRepaymentHistoryFixedParamsV5, GetRepaymentHistoryFlexibleParamsV5, GetRepaymentHistoryParamsV5, GetRFQHistoryParamsV5, GetRFQListParamsV5, GetRFQPublicTradesParamsV5, GetRFQQuoteRealtimeParamsV5, GetRFQRealtimeParamsV5, GetRFQRealtimeResultV5, GetRFQTradeListParamsV5, GetRiskLimitParamsV5, GetRPIOrderbookParamsV5, GetSettlementRecordParamsV5, GetSmallBalanceListParamsV5, GetSpreadInstrumentsInfoParamsV5, GetSpreadOpenOrdersParamsV5, GetSpreadOrderHistoryParamsV5, GetSpreadTradeHistoryParamsV5, GetSubAccountAllApiKeysParamsV5, GetSubAccountDepositRecordParamsV5, GetSupplyContractInfoFixedParamsV5, GetSupplyOrderInfoFixedParamsV5, GetSupplyOrderQuoteFixedParamsV5, GetSystemStatusParamsV5, GetTickersParamsV5, GetTransactionLogParamsV5, GetUniversalTransferRecordsParamsV5, GetUnpaidLoanOrdersParamsV5, GetVIPMarginDataParamsV5, GetWalletBalanceParamsV5, GetWithdrawalAddressListParamsV5, GetWithdrawalRecordsParamsV5, HistoricalVolatilityV5, IndexPriceComponentsResponseV5, InstitutionalLoanLTVV5, InstrumentInfoResponseV5, InsuranceResponseV5, InternalDepositRecordV5, InternalTransferRecordV5, IssueVoucherParamsV5, LoanLTVAdjustmentHistoryV5, LongShortRatioV5, ManualBorrowParamsV5, ManualBorrowResultV5, ManualRepayParamsV5, ManualRepayResultV5, ManualRepayWithoutConversionParamsV5, ManualRepayWithoutConversionResultV5, MarkP2POrderAsPaidParamsV5, MaxBorrowableAmountV5, MaxLoanAmountV5, 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, RenewBorrowOrderFixedParamsV5, RenewBorrowOrderFixedV5, RenewOrderInfoFixedV5, RepayCollateralFixedParamsV5, RepayCollateralFlexibleParamsV5, RepayFixedParamsV5, RepayFixedV5, RepayFlexibleParamsV5, RepayFlexibleV5, RepayInstitutionalLoanParamsV5, RepayInstitutionalLoanResultV5, RepayLiabilityParamsV5, RepayLiabilityResultV5, RepaymentHistoryFixedV5, RepaymentHistoryFlexibleV5, RepaymentHistoryV5, RequestConvertQuoteParamsV5, RFQConfigV5, RFQHistory, RFQPublicTradeV5, RFQQuoteItemV5, RFQTradeV5, RiskLimitV5, RPIOrderbookResponseV5, SendP2POrderMessageParamsV5, SetAutoAddMarginParamsV5, SetAutoRepayModeParamsV5, SetCollateralCoinParamsV5, SetLeverageParamsV5, SetLimitPriceActionParamsV5, SetRiskLimitParamsV5, SetRiskLimitResultV5, SetSpotMarginLeverageParamsV5, SettlementRecordV5, SetTPSLModeParamsV5, SetTradingStopParamsV5, SmallBalanceListV5, 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, WithdrawalAddressV5, WithdrawalRecordV5, WithdrawParamsV5 } from './types';
1
+ import { AcceptNonLPQuoteParamsV5, AcceptNonLPQuoteResultV5, AccountBorrowCollateralLimitV5, AccountCoinBalanceV5, AccountInfoV5, AccountInstrumentInfoResponseV5, AccountMarginModeV5, AccountOrderV5, AccountTypeV5, AddOrReduceMarginParamsV5, AddOrReduceMarginResultV5, AdjustCollateralAmountParamsV5, AdjustCollateralAmountV5, ADLAlertResponseV5, AdvanceEarnAdvanceProductInfoV5, AdvanceEarnOrderListV5, AdvanceEarnPlaceOrderResultV5, AdvanceEarnPositionListV5, AdvanceEarnProductExtraInfoV5, AffiliateUserInfoV5, AffiliateUserListItemV5, AllCoinsBalanceV5, AllowedDepositCoinInfoV5, AlphaAssetDetailResultV5, AlphaAssetListResultV5, AlphaBizTokenDetailsV5, AlphaBizTokenPriceListResultV5, AlphaBizTokenV5, AlphaPayTokenV5, AlphaTradeOrderListResultV5, AlphaTradeQuoteResultV5, AmendOrderParamsV5, AmendSpreadOrderParamsV5, ApiKeyInfoV5, APIP2PResponse, APIResponseV3, APIResponseV3WithTime, AssetInfoV5, AssetOverviewResultV5, AutoRepayModeResultV5, AvailableAmountToRepayV5, BatchAmendOrderParamsV5, BatchAmendOrderResultV5, BatchCancelOrderParamsV5, BatchCancelOrderResultV5, BatchCreateOrderResultV5, BatchOrderParamsV5, BatchOrdersRetExtInfoV5, BorrowableCoinV5, BorrowContractInfoFixedV5, BorrowCryptoLoanParamsV5, BorrowFlexibleParamsV5, BorrowFlexibleV5, BorrowHistoryFlexibleV5, BorrowHistoryRecordV5, BorrowOrderInfoFixedV5, BorrowOrderQuoteFixedV5, BrokerIssuedVoucherV5, BrokerRateLimitAllItemV5, BrokerRateLimitCapItemV5, BrokerRateLimitSetResultItemV5, BrokerVoucherSpecV5, CancelAllOrdersParamsV5, CancelAllRFQResultV5, CancelBorrowOrderFixedParamsV5, CancelOrderParamsV5, CancelRFQParamsV5, CancelRFQQuoteItemV5, CancelRFQQuoteParamsV5, CancelRFQQuoteResultV5, CancelRFQResultV5, CancelSupplyOrderFixedParamsV5, CardAssetRecordsResultV5, CardMallItemListResultV5, CardPointBalanceV5, CardPointCashbackDetailV5, CardPointRecordsResultV5, CardPointTierInfoV5, CategoryCursorListV5, CategoryListV5, CategorySymbolListV5, CategoryV5, ClosedOptionsPositionV5, ClosedPnLV5, CoinExchangeRecordV5, CoinGreeksV5, CoinInfoV5, CoinStateV5, CollateralAdjustmentHistoryV5, CollateralDataV5, CollateralInfoV5, CompletedLoanOrderV5, ConfirmNewRiskLimitParamsV5, ConvertCoinsParamsV5, ConvertCoinSpecV5, ConvertHistoryRecordV5, ConvertQuoteV5, ConvertStatusV5, CreateBorrowOrderFixedParamsV5, CreateBorrowOrderFixedV5, CreateP2PAdParamsV5, CreateRFQParamsV5, CreateRFQQuoteParamsV5, CreateRFQQuoteResultV5, CreateRFQResultV5, CreateSubApiKeyParamsV5, CreateSubApiKeyResultV5, CreateSubMemberParamsV5, CreateSubMemberResultV5, CreateSupplyOrderFixedParamsV5, CreateSupplyOrderFixedV5, CryptoLoanPositionV5, CurrencyPositionTiersV5, CursorListV5, CursorRowsV5, DCPInfoV5, DeleteSubMemberParamsV5, DeliveryPriceV5, DeliveryRecordV5, DepositAddressChainV5, DepositRecordV5, EarnAprHistoryPointV5, EarnHourlyYieldHistoryV5, EarnOrderHistoryV5, EarnPositionV5, EarnProductV5, EarnTokenDailyYieldRecordV5, EarnTokenHistoryAprPointV5, EarnTokenHourlyYieldRecordV5, EarnTokenOrderV5, EarnTokenPositionV5, EarnTokenProductV5, EarnYieldHistoryV5, ExchangeBrokerAccountInfoV5, ExchangeBrokerEarningResultV5, ExchangeBrokerSubAccountDepositRecordV5, ExecuteAlphaTradeParamsV5, ExecuteAlphaTradeResultV5, ExecuteRFQQuoteParamsV5, ExecuteRFQQuoteResultV5, ExecutionV5, FeeGroupStructureResponseV5, FeeRateV5, FiatTradingPairListV5, FixedRateBorrowContractInfoV5, FixedRateBorrowOrderInfoV5, FixedRateBorrowParamsV5, FixedRateBorrowQuoteV5, FixedRateBorrowResultV5, FixedTermEarnOrderListV5, FixedTermEarnPlaceOrderResultV5, FixedTermEarnPositionListV5, FixedTermEarnProductListV5, FriendReferralRecordV5, FundingAccountTransactionRecordV5, FundingRateHistoryResponseV5, GetAccountCoinBalanceParamsV5, GetAccountHistoricOrdersParamsV5, GetAccountInstrumentsInfoParamsV5, GetAccountOrdersParamsV5, GetADLAlertParamsV5, GetAdvanceEarnOrderListParamsV5, GetAdvanceEarnPositionListParamsV5, GetAdvanceEarnProductExtraInfoParamsV5, GetAdvanceEarnProductParamsV5, GetAffiliateUserListParamsV5, GetAllBrokerRateLimitsParamsV5, GetAllCoinsBalanceParamsV5, GetAllowedDepositCoinInfoParamsV5, GetAlphaAssetDetailParamsV5, GetAlphaBizTokenDetailsParamsV5, GetAlphaBizTokenListParamsV5, GetAlphaBizTokenPriceListParamsV5, GetAlphaPayTokenListParamsV5, GetAlphaTradeOrderListParamsV5, GetAlphaTradeQuoteParamsV5, GetAssetInfoParamsV5, GetAssetOverviewParamsV5, GetAutoRepayModeParamsV5, GetAvailableAmountToRepayParamsV5, GetBorrowableCoinsParamsV5, GetBorrowContractInfoFixedParamsV5, GetBorrowHistoryFlexibleParamsV5, GetBorrowHistoryParamsV5, GetBorrowOrderInfoFixedParamsV5, GetBorrowOrderQuoteFixedParamsV5, GetBrokerIssuedVoucherParamsV5, GetBrokerSubAccountDepositsV5, GetClassicTransactionLogsParamsV5, GetClosedOptionsPositionsParamsV5, GetClosedPnLParamsV5, GetCoinExchangeRecordParamsV5, GetCoinStateParamsV5, GetCollateralAdjustmentHistoryParamsV5, GetCollateralCoinsParamsV5, GetCompletedLoanOrderHistoryParamsV5, GetConvertHistoryParamsV5, GetDeliveryPriceParamsV5, GetDeliveryRecordParamsV5, GetDepositRecordParamsV5, GetEarnAprHistoryParamsV5, GetEarnHourlyYieldHistoryParamsV5, GetEarnOrderHistoryParamsV5, GetEarnPositionParamsV5, GetEarnTokenDailyYieldParamsV5, GetEarnTokenHistoryAprParamsV5, GetEarnTokenHourlyYieldParamsV5, GetEarnTokenOrderListParamsV5, GetEarnTokenPositionParamsV5, GetEarnTokenProductParamsV5, GetEarnYieldHistoryParamsV5, GetExchangeBrokerEarningsParamsV5, GetExecutionListParamsV5, GetFeeGroupStructureParamsV5, GetFeeRateParamsV5, GetFiatTradingPairListParamsV5, GetFixedRateBorrowContractInfoParamsV5, GetFixedRateBorrowOrderInfoParamsV5, GetFixedRateBorrowOrderQuoteParamsV5, GetFixedTermEarnOrderListParamsV5, GetFixedTermEarnPositionParamsV5, GetFixedTermEarnProductParamsV5, GetFriendReferralsParamsV5, GetFundingAccountTransactionHistoryParamsV5, GetFundingRateHistoryParamsV5, GetHistoricalVolatilityParamsV5, GetIndexPriceComponentsParamsV5, GetIndexPriceKlineParamsV5, GetInstrumentsInfoParamsV5, GetInsuranceParamsV5, GetInternalDepositRecordParamsV5, GetInternalTransferParamsV5, GetKlineParamsV5, GetLiquidityMiningProductParamsV5, GetLoanLTVAdjustmentHistoryParamsV5, GetLongShortRatioParamsV5, GetMarkPriceKlineParamsV5, GetMaxBorrowableAmountParamsV5, GetMaxCollateralAmountParamsV5, GetMaxLoanAmountParamsV5, GetMovePositionHistoryParamsV5, GetOngoingFlexibleLoansParamsV5, GetOpenInterestParamsV5, GetOptionDeliveryPriceParamsV5, GetOrderbookParamsV5, GetP2PAccountCoinsBalanceParamsV5, GetP2PCounterpartyUserInfoParamsV5, GetP2POnlineAdsParamsV5, GetP2POrderMessagesParamsV5, GetP2POrdersParamsV5, GetP2PPendingOrdersParamsV5, GetP2PPersonalAdsParamsV5, GetPayInfoParamsV5, GetPortfolioMarginInfoParamsV5, GetPositionTiersParamsV5, GetPremiumIndexPriceKlineParamsV5, GetPreUpgradeClosedPnlParamsV5, GetPreUpgradeOptionDeliveryRecordParamsV5, GetPreUpgradeOrderHistoryParamsV5, GetPreUpgradeTradeHistoryParamsV5, GetPreUpgradeTransactionLogParamsV5, GetPreUpgradeUSDCSessionParamsV5, GetPublicTradingHistoryParamsV5, GetRenewOrderInfoFixedParamsV5, GetRepaymentHistoryFixedParamsV5, GetRepaymentHistoryFlexibleParamsV5, GetRepaymentHistoryParamsV5, GetRFQHistoryParamsV5, GetRFQListParamsV5, GetRFQPublicTradesParamsV5, GetRFQQuoteRealtimeParamsV5, GetRFQRealtimeParamsV5, GetRFQRealtimeResultV5, GetRFQTradeListParamsV5, GetRiskLimitParamsV5, GetRPIOrderbookParamsV5, GetSettlementRecordParamsV5, GetSmallBalanceListParamsV5, GetSpotMarginCurrencyDataParamsV5, GetSpotMarginLiabilityInfoParamsV5, GetSpreadInstrumentsInfoParamsV5, GetSpreadMaxQtyParamsV5, GetSpreadOpenOrdersParamsV5, GetSpreadOrderHistoryParamsV5, GetSpreadTradeHistoryParamsV5, GetSubAccountAllApiKeysParamsV5, GetSubAccountDepositRecordParamsV5, GetSupplyContractInfoFixedParamsV5, GetSupplyOrderInfoFixedParamsV5, GetSupplyOrderQuoteFixedParamsV5, GetSystemStatusParamsV5, GetTickersParamsV5, GetTotalMembersAssetsParamsV5, GetTradeInfoForAnalysisParamsV5, GetTransactionLogParamsV5, GetUniversalTransferRecordsParamsV5, GetUnpaidLoanOrdersParamsV5, GetVIPMarginDataParamsV5, GetWalletBalanceParamsV5, GetWithdrawalAddressListParamsV5, GetWithdrawalRecordsParamsV5, HistoricalVolatilityV5, IndexPriceComponentsResponseV5, InstitutionalLoanLTVV5, InstrumentInfoResponseV5, InsuranceResponseV5, InternalDepositRecordV5, InternalTransferRecordV5, IssueVoucherParamsV5, LiquidityMiningProductResultV5, LoanLTVAdjustmentHistoryV5, LongShortRatioV5, ManualBorrowParamsV5, ManualBorrowResultV5, ManualRepayParamsV5, ManualRepayResultV5, ManualRepayWithoutConversionParamsV5, ManualRepayWithoutConversionResultV5, MarkP2POrderAsPaidParamsV5, MaxBorrowableAmountV5, MaxLoanAmountV5, MMPModifyParamsV5, MMPStateV5, ModifyEarnPositionParamsV5, MovePositionHistoryV5, MovePositionParamsV5, MovePositionResultV5, OHLCKlineV5, OHLCVKlineV5, OngoingFlexibleLoanV5, OpenInterestResponseV5, OptionAssetInfoNestedResultV5, OptionDeliveryPriceV5, OrderbookResponseV5, OrderParamsV5, OrderPriceLimitV5, OrderResultV5, OrderSideV5, P2PAccountCoinsBalanceV5, P2PAdDetailV5, P2PCounterpartyUserInfoV5, P2PCreateAdResponseV5, P2POnlineAdsResponseV5, P2POrderDetailV5, P2POrderMessageV5, P2POrdersResponseV5, P2PPersonalAdsResponseV5, P2PUserInfoV5, P2PUserPaymentV5, PayInfoResultV5, PlaceEarnTokenOrderParamsV5, PlaceEarnTokenOrderResultV5, PortfolioMarginInfoResultV5, PositionInfoParamsV5, PositionV5, PreCheckOrderResultV5, PreUpgradeOptionsDelivery, PreUpgradeTransaction, PreUpgradeUSDCSessionSettlement, PublicTradeV5, QueryCardAssetRecordsParamsV5, QueryCardMallItemListParamsV5, QueryCardPointCashbackDetailParamsV5, QueryCardPointRecordsParamsV5, RedeemFixedTermEarnParamsV5, RedeemFixedTermEarnResultV5, RenewBorrowOrderFixedParamsV5, RenewBorrowOrderFixedV5, RenewFixedRateBorrowParamsV5, RenewOrderInfoFixedV5, RepayCollateralFixedParamsV5, RepayCollateralFlexibleParamsV5, RepayFixedParamsV5, RepayFixedV5, RepayFlexibleParamsV5, RepayFlexibleV5, RepayInstitutionalLoanParamsV5, RepayInstitutionalLoanResultV5, RepayLiabilityParamsV5, RepayLiabilityResultV5, RepaymentHistoryFixedV5, RepaymentHistoryFlexibleV5, RepaymentHistoryV5, RequestConvertQuoteParamsV5, RFQConfigV5, RFQHistory, RFQPublicTradeV5, RFQQuoteItemV5, RFQTradeV5, RiskLimitV5, RPIOrderbookResponseV5, SendP2POrderMessageParamsV5, SetAutoAddMarginParamsV5, SetAutoRepayModeParamsV5, SetBrokerRateLimitParamsV5, SetCollateralCoinParamsV5, SetDeltaNeutralModeParamsV5, SetFixedTermEarnAutoInvestParamsV5, SetLeverageParamsV5, SetLimitPriceActionParamsV5, SetRiskLimitParamsV5, SetRiskLimitResultV5, SetSpotMarginLeverageParamsV5, SettlementRecordV5, SetTPSLModeParamsV5, SetTradingStopParamsV5, SignAgreementParamsV5, SmallBalanceListV5, SpotBorrowCheckResultV5, SpotMarginCurrencyDataV5, SpotMarginLiabilityInfoV5, SpotMarginStateV5, SpreadInstrumentInfoV5, SpreadMaxQtyResultV5, SpreadOpenOrderV5, SpreadOrderbookResponseV5, SpreadOrderHistoryV5, SpreadRecentTradeV5, SpreadTickerV5, SpreadTradeV5, SubMemberV5, SubmitAdvanceEarnPlaceOrderParamsV5, SubmitFixedTermEarnOrderParamsV5, SubmitSpreadOrderParamsV5, SubmitStakeRedeemParamsV5, SupplyContractInfoFixedV5, SupplyOrderInfoFixedV5, SupplyOrderQuoteFixedV5, SwitchIsolatedMarginParamsV5, SwitchPositionModeParamsV5, SystemStatusItemV5, TickerLinearInverseV5, TickerOptionV5, TickerSpotV5, TotalMembersAssetsResultV5, TPSLModeV5, TradeInfoForAnalysisResultV5, TransactionLogV5, UnifiedAccountUpgradeResultV5, UniversalTransferParamsV5, UniversalTransferRecordV5, UnpaidLoanOrderV5, UpdateApiKeyParamsV5, UpdateApiKeyResultV5, UpdateP2PAdParamsV5, UserSettingConfigV5, VaspEntityV5, VipBorrowableCoinsV5, VipCollateralCoinsV5, VIPMarginDataV5, WalletBalanceV5, WithdrawableAmountV5, WithdrawalAddressV5, WithdrawalRecordV5, WithdrawParamsV5 } from './types';
2
2
  import BaseRestClient from './util/BaseRestClient';
3
3
  /**
4
4
  * REST API client for V5 REST APIs
@@ -87,6 +87,11 @@ export declare class RestClientV5 extends BaseRestClient {
87
87
  }): Promise<APIResponseV3WithTime<{
88
88
  list: SpreadRecentTradeV5[];
89
89
  }>>;
90
+ /**
91
+ * Get Spread Max Qty
92
+ * Max order quantity (available balance) for a spread order at a given side and price.
93
+ */
94
+ getSpreadMaxQty(params: GetSpreadMaxQtyParamsV5): Promise<APIResponseV3WithTime<SpreadMaxQtyResultV5>>;
90
95
  /**
91
96
  * Create Spread Order
92
97
  */
@@ -173,9 +178,11 @@ export declare class RestClientV5 extends BaseRestClient {
173
178
  /**
174
179
  * Query the mark price kline data. Charts are returned in groups based on the requested interval.
175
180
  *
176
- * Covers: Linear contract / Inverse contract
181
+ * Covers: USDT contract / USDC contract / Inverse contract / Options
182
+ *
183
+ * `category` defaults to linear if omitted. For options, `limit` max is 500; futures max is 1000.
177
184
  */
178
- getMarkPriceKline(params: GetMarkPriceKlineParamsV5): Promise<APIResponseV3WithTime<CategorySymbolListV5<OHLCKlineV5[], 'linear' | 'inverse'>>>;
185
+ getMarkPriceKline(params: GetMarkPriceKlineParamsV5): Promise<APIResponseV3WithTime<CategorySymbolListV5<OHLCKlineV5[], 'linear' | 'inverse' | 'option'>>>;
179
186
  /**
180
187
  * Query the index price kline data. Charts are returned in groups based on the requested interval.
181
188
  *
@@ -194,6 +201,7 @@ export declare class RestClientV5 extends BaseRestClient {
194
201
  * Covers: Spot / Linear contract / Inverse contract / Option
195
202
  *
196
203
  * Note: Spot does not support pagination, so limit & cursor are invalid.
204
+ * Note: e.g. `symbolType: 'commodity'`, and for linear also `stock`, `forex` (see Bybit Get Instruments Info).
197
205
  */
198
206
  getInstrumentsInfo<C extends CategoryV5>(params: GetInstrumentsInfoParamsV5 & {
199
207
  category: C;
@@ -644,6 +652,7 @@ export declare class RestClientV5 extends BaseRestClient {
644
652
  * Covers: SPOT / USDT contract / USDC contract / Inverse contract
645
653
  *
646
654
  * Includes RPI permission information (isPublicRpi, myRpiPermission)
655
+ * Note: e.g. `symbolType: 'commodity'`, and for linear also `stock`, `forex`.
647
656
  */
648
657
  getAccountInstrumentsInfo<C extends 'spot' | 'linear' | 'inverse'>(params: GetAccountInstrumentsInfoParamsV5 & {
649
658
  category: C;
@@ -667,8 +676,17 @@ export declare class RestClientV5 extends BaseRestClient {
667
676
  *
668
677
  * - Input the specific coin: repay the liability of this coin in particular
669
678
  * - No coin specified: repay the liability of all coins
679
+ *
680
+ * Does not repay manual-borrow (spot margin manual borrow) liabilities — use `manualRepay` or
681
+ * `manualRepayWithoutConversion` instead (API error 182120 otherwise).
682
+ * From 2026-03-17 (full 2026-03-24), BYUSDT can be used for repayment. MNT is temporarily not used for
683
+ * this flow; MNT convert-repay is not supported (use `manualRepayWithoutConversion` with existing balance).
684
+ * From 2026-02-10 08:00 UTC, coin-conversion fees use the higher of collateral or debt fee rate, with a
685
+ * per-transaction coin-conversion cap of 300,000 USD equivalent.
670
686
  */
671
- repayLiability(params?: RepayLiabilityParamsV5): Promise<APIResponseV3WithTime<CursorListV5<RepayLiabilityResultV5[]>>>;
687
+ repayLiability(params?: RepayLiabilityParamsV5): Promise<APIResponseV3WithTime<{
688
+ list: RepayLiabilityResultV5[];
689
+ }>>;
672
690
  /**
673
691
  * Manual Repay
674
692
  *
@@ -679,6 +697,14 @@ export declare class RestClientV5 extends BaseRestClient {
679
697
  * If that's not enough, the remaining amount will be repaid by converting other assets.
680
698
  *
681
699
  * Repayment is prohibited between 04:00 and 05:30 per hour.
700
+ *
701
+ * When `coin` and `amount` are both set, validation depends on `repaymentType` (e.g. amount must not
702
+ * exceed the matching liability pool). If neither `coin` nor `amount` is set, `repaymentType` must be
703
+ * ALL. Response timing: ALL and FIXED are asynchronous; FLEXIBLE is synchronous.
704
+ * For repay-without-convert (spot balance only), use `manualRepayWithoutConversion`.
705
+ * From 2026-03-17 (full 2026-03-24), BYUSDT can be used for repayment. MNT: not via convert-repay;
706
+ * use `manualRepayWithoutConversion` for MNT with existing balance. From 2026-02-10 08:00 UTC,
707
+ * coin-conversion cap 300,000 USD equivalent per transaction applies.
682
708
  */
683
709
  manualRepay(params?: ManualRepayParamsV5): Promise<APIResponseV3WithTime<ManualRepayResultV5>>;
684
710
  /**
@@ -773,13 +799,16 @@ export declare class RestClientV5 extends BaseRestClient {
773
799
  */
774
800
  setLimitPriceAction(params: SetLimitPriceActionParamsV5): Promise<APIResponseV3WithTime<{}>>;
775
801
  /**
776
- * Get Limit Price Behaviour
802
+ * Get Trade Behaviour Config / Get Limit Price Behaviour
777
803
  * You can get configuration how the system behaves when your limit order price exceeds the highest bid or lowest ask price.
804
+ * Response includes `deltaEnable` for Delta Neutral mode, and `smsef` / `fmsef` for Spot and Futures MNT fee deduction.
778
805
  */
779
- getLimitPriceAction(): Promise<APIResponseV3WithTime<{
780
- lpaSpot: boolean;
781
- lpaPerp: boolean;
782
- }>>;
806
+ getLimitPriceAction(): Promise<APIResponseV3WithTime<UserSettingConfigV5>>;
807
+ /**
808
+ * Set Delta Neutral Mode
809
+ * 1: enable, 0: disable. Query current status via `getLimitPriceAction()`.
810
+ */
811
+ setDeltaNeutralMode(params: SetDeltaNeutralModeParamsV5): Promise<APIResponseV3WithTime<Record<string, never>>>;
783
812
  /**
784
813
  * Configure Market Maker Protection (MMP)
785
814
  */
@@ -794,11 +823,55 @@ export declare class RestClientV5 extends BaseRestClient {
794
823
  getMMPState(baseCoin: string): Promise<APIResponseV3WithTime<{
795
824
  result: MMPStateV5[];
796
825
  }>>;
826
+ /**
827
+ * Get Option Asset Info
828
+ * P&L per coin for options: delta, RPL, UPL, margin. Result uses a nested `result` list.
829
+ */
830
+ getOptionAssetInfo(): Promise<APIResponseV3WithTime<OptionAssetInfoNestedResultV5>>;
831
+ /**
832
+ * Get Pay Info
833
+ * Repayment collateral snapshot before `manualRepay` or `repayLiability`. Optional `coin` for one liability; omit for total.
834
+ */
835
+ getPayInfo(params?: GetPayInfoParamsV5): Promise<APIResponseV3WithTime<PayInfoResultV5>>;
836
+ /**
837
+ * Get Trade Info For Analysis
838
+ * Aggregated spot trade stats for a symbol, including daily breakdown when returned.
839
+ */
840
+ getTradeInfoForAnalysis(params: GetTradeInfoForAnalysisParamsV5): Promise<APIResponseV3WithTime<TradeInfoForAnalysisResultV5>>;
797
841
  /**
798
842
  *
799
843
  ****** Asset APIs
800
844
  *
801
845
  */
846
+ /**
847
+ * Asset Overview
848
+ * Query master account or subaccount's total assets and detailed asset holdings across different accounts and product categories.
849
+ *
850
+ * INFO: For accountType=Alpha, on-chain assets are not included in the returned data in current version.
851
+ * `valuationCurrency` sets fiat for totals; `accountType` filters which account to return. For Alpha + farm, `extMap` may
852
+ * appear on `coinDetail` (price range and equity unit).
853
+ */
854
+ getAssetOverview(params?: GetAssetOverviewParamsV5): Promise<APIResponseV3WithTime<AssetOverviewResultV5>>;
855
+ /**
856
+ * Get Portfolio Margin Info
857
+ * Wallet and per-base-coin P&L range (aligned with the portfolio margin page).
858
+ */
859
+ getPortfolioMarginInfo(params?: GetPortfolioMarginInfoParamsV5): Promise<APIResponseV3WithTime<PortfolioMarginInfoResultV5>>;
860
+ /**
861
+ * Get Total Members Assets
862
+ * Master + sub-accounts; optional `coin` for valuation (default BTC).
863
+ */
864
+ getTotalMembersAssets(params?: GetTotalMembersAssetsParamsV5): Promise<APIResponseV3WithTime<TotalMembersAssetsResultV5>>;
865
+ /**
866
+ * Funding Account Transaction History
867
+ * Transaction log in Funding Account. Supports filtering by transaction type and time range.
868
+ *
869
+ * INFO: createTimeFrom and createTimeTo must be used together. Interval cannot exceed 7 days. If neither provided, defaults to last 7 days.
870
+ */
871
+ getFundingAccountTransactionHistory(params?: GetFundingAccountTransactionHistoryParamsV5): Promise<APIResponseV3WithTime<{
872
+ nextPageCursor: string;
873
+ list: FundingAccountTransactionRecordV5[];
874
+ }>>;
802
875
  /**
803
876
  * Query option delivery records, sorted by deliveryTime in descending order.
804
877
  *
@@ -857,13 +930,13 @@ export declare class RestClientV5 extends BaseRestClient {
857
930
  */
858
931
  getCoinBalance(params: GetAccountCoinBalanceParamsV5): Promise<APIResponseV3<AccountCoinBalanceV5>>;
859
932
  /**
860
- * Query withdrawable amount.
933
+ * Query withdrawable amount (incl. risk-frozen `limitAmountUsd` and per-wallet slices).
934
+ * May include FUND, UTA, EARN, SPOT keys depending on the coin. EARN is present when the coin
935
+ * supports withdrawal from the Earn account.
861
936
  */
862
937
  getWithdrawableAmount(params: {
863
938
  coin: string;
864
- }): Promise<APIResponseV3<{
865
- rows: WithdrawableAmountV5[];
866
- }>>;
939
+ }): Promise<APIResponseV3WithTime<WithdrawableAmountV5>>;
867
940
  /**
868
941
  * Query the transferable coin list between each account type.
869
942
  */
@@ -920,6 +993,7 @@ export declare class RestClientV5 extends BaseRestClient {
920
993
  }>>;
921
994
  /**
922
995
  * Set auto transfer account after deposit. The same function as the setting for Deposit on web GUI
996
+ * (UNIFIED, FUND, or EARN; if a coin is not in flexible saving, EARN may route to funding as per Bybit).
923
997
  */
924
998
  setDepositAccount(params: {
925
999
  accountType: AccountTypeV5;
@@ -1010,11 +1084,13 @@ export declare class RestClientV5 extends BaseRestClient {
1010
1084
  vasp: VaspEntityV5[];
1011
1085
  }>>;
1012
1086
  /**
1013
- * Withdraw assets from the SPOT account.
1087
+ * Withdraw from Funding, Unified, and/or Earn (and combos such as FUND,UTA,EARN per API).
1014
1088
  *
1015
1089
  * CAUTION: Make sure you have whitelisted your wallet address before calling this endpoint.
1016
1090
  *
1017
1091
  * You can make an off-chain transfer if the target wallet address is from Bybit. This means that no blockchain fee will be charged.
1092
+ *
1093
+ * Bybit Turkey (TR) site: `transactionPurpose` is required on the request (see `WithdrawParamsV5`).
1018
1094
  */
1019
1095
  submitWithdrawal(params: WithdrawParamsV5): Promise<APIResponseV3WithTime<{
1020
1096
  id: string;
@@ -1127,6 +1203,8 @@ export declare class RestClientV5 extends BaseRestClient {
1127
1203
  * Both master and sub user's api key are applicable.
1128
1204
  *
1129
1205
  * TIP: Any permission can access this endpoint.
1206
+ *
1207
+ * Response `permissions` may include `FiatBitPay`; `FiatBybitPay` is deprecated for the same scope.
1130
1208
  */
1131
1209
  getQueryApiKey(): Promise<APIResponseV3WithTime<ApiKeyInfoV5>>;
1132
1210
  /**
@@ -1149,6 +1227,8 @@ export declare class RestClientV5 extends BaseRestClient {
1149
1227
  *
1150
1228
  * TIP: The API key must have one of the permissions to be allowed to call the following API endpoint.
1151
1229
  * - master API key: "Account Transfer", "Subaccount Transfer", "Withdrawal"
1230
+ *
1231
+ * `permissions` may include `FiatBitPay`; `FiatBybitPay` remains during transition for the same scope.
1152
1232
  */
1153
1233
  updateMasterApiKey(params: UpdateApiKeyParamsV5): Promise<APIResponseV3WithTime<UpdateApiKeyResultV5>>;
1154
1234
  /**
@@ -1221,6 +1301,87 @@ export declare class RestClientV5 extends BaseRestClient {
1221
1301
  getAffiliateUserInfo(params: {
1222
1302
  uid: string;
1223
1303
  }): Promise<APIResponseV3WithTime<AffiliateUserInfoV5>>;
1304
+ /**
1305
+ * Get Friend Referrals
1306
+ * Query the friend's invitee data.
1307
+ *
1308
+ * TIP: Any permission can access this endpoint.
1309
+ */
1310
+ getFriendReferrals(params?: GetFriendReferralsParamsV5): Promise<APIResponseV3WithTime<{
1311
+ nextCursor: string;
1312
+ records: FriendReferralRecordV5[];
1313
+ }>>;
1314
+ /**
1315
+ * Sign Agreement
1316
+ * To trade commodity contracts (e.g. metals XAU/XAG perps, crude oil perps), complete the agreement signing first.
1317
+ * Recommended to sign in advance via API so you can trade immediately when contracts go live.
1318
+ * Send either `category` (legacy) or `categoryV2` (preferred; new agreement types are added to `categoryV2` only).
1319
+ *
1320
+ * INFO
1321
+ * - Only the master account can sign. Subaccounts are not supported.
1322
+ * - Once the master has signed, all subaccounts will be eligible to trade.
1323
+ * - API key must have: Account Transfer, Subaccount Transfer, or Withdrawal.
1324
+ * - Trading without signing returns code=110123, msg=You must agree to the Trading Terms.
1325
+ */
1326
+ signAgreement(params: SignAgreementParamsV5): Promise<APIResponseV3WithTime<{}>>;
1327
+ /**
1328
+ *
1329
+ ****** Alpha / Web3 (on-chain) trade APIs
1330
+ *
1331
+ */
1332
+ /**
1333
+ * Get Trade Quote
1334
+ * Get a price quote before a purchase or redeem. Required before `executeAlphaTradePurchase` or `executeAlphaTradeRedeem`.
1335
+ * Pass `quoteData` and `correctingCode` from the response unchanged to the execute endpoints.
1336
+ */
1337
+ getAlphaTradeQuote(params: GetAlphaTradeQuoteParamsV5): Promise<APIResponseV3WithTime<AlphaTradeQuoteResultV5>>;
1338
+ /**
1339
+ * Execute Purchase
1340
+ * Buy on-chain tokens with a payment token (e.g. USDT). Requires a valid quote; obtain user confirmation first.
1341
+ * HTTP 200 is only an acknowledgment — poll `getAlphaTradeOrderList` for final status. Idempotent by `quoteDataId` in the quote.
1342
+ */
1343
+ executeAlphaTradePurchase(params: ExecuteAlphaTradeParamsV5): Promise<APIResponseV3WithTime<ExecuteAlphaTradeResultV5>>;
1344
+ /**
1345
+ * Execute Redeem
1346
+ * Sell on-chain tokens for a payment token. Requires a valid quote; obtain user confirmation first.
1347
+ * HTTP 200 is only an acknowledgment — poll `getAlphaTradeOrderList` for final status. Idempotent by `quoteDataId` in the quote.
1348
+ */
1349
+ executeAlphaTradeRedeem(params: ExecuteAlphaTradeParamsV5): Promise<APIResponseV3WithTime<ExecuteAlphaTradeResultV5>>;
1350
+ /**
1351
+ * Get Payment Token List
1352
+ * List payment tokens (e.g. USDT) and CEX token codes (e.g. CEX_1) for quote and execution. Each entry includes `supportChains`.
1353
+ */
1354
+ getAlphaPayTokenList(params: GetAlphaPayTokenListParamsV5): Promise<APIResponseV3WithTime<AlphaPayTokenV5[]>>;
1355
+ /**
1356
+ * Get Order List
1357
+ * On-chain trade order history; filters for trade type, status, token, and time. Max 90 days.
1358
+ */
1359
+ getAlphaTradeOrderList(params: GetAlphaTradeOrderListParamsV5): Promise<APIResponseV3WithTime<AlphaTradeOrderListResultV5>>;
1360
+ /**
1361
+ * Get Biz Token List
1362
+ * Tradable on-chain tokens (DEX_ prefix ids), risk flags, limits, and supported payment token codes.
1363
+ */
1364
+ getAlphaBizTokenList(params?: GetAlphaBizTokenListParamsV5): Promise<APIResponseV3WithTime<AlphaBizTokenV5[]>>;
1365
+ /**
1366
+ * Get Token Price List
1367
+ * Batch market data (up to 20 `chainCode` + `tokenAddress` pairs). Prices, 24h change, volume, market cap, etc.
1368
+ */
1369
+ getAlphaBizTokenPriceList(params: GetAlphaBizTokenPriceListParamsV5): Promise<APIResponseV3WithTime<AlphaBizTokenPriceListResultV5>>;
1370
+ /**
1371
+ * Get Token Details
1372
+ * One token: description, links, `riskFlag`, and listing status. Use `chainCode` + `tokenAddress` from biz list or assets.
1373
+ */
1374
+ getAlphaBizTokenDetails(params: GetAlphaBizTokenDetailsParamsV5): Promise<APIResponseV3WithTime<AlphaBizTokenDetailsV5>>;
1375
+ /**
1376
+ * Get Asset List
1377
+ * Portfolio of on-chain token holdings (non-zero only), sorted by USD value.
1378
+ */
1379
+ getAlphaAssetList(): Promise<APIResponseV3WithTime<AlphaAssetListResultV5>>;
1380
+ /**
1381
+ * Get Asset Detail
1382
+ * Single-asset view; `result.assetList` has 0 or 1 item.
1383
+ */
1384
+ getAlphaAssetDetail(params: GetAlphaAssetDetailParamsV5): Promise<APIResponseV3WithTime<AlphaAssetDetailResultV5>>;
1224
1385
  /**
1225
1386
  *
1226
1387
  ****** Spot Margin Trade APIs (UTA)
@@ -1253,6 +1414,13 @@ export declare class RestClientV5 extends BaseRestClient {
1253
1414
  vipLevel: string;
1254
1415
  }[];
1255
1416
  }>>;
1417
+ /**
1418
+ * Get Currency Data
1419
+ * Borrowing currency data: flexible/fixed manual borrow, min qty, precision, interest rate range.
1420
+ */
1421
+ getSpotMarginCurrencyData(params?: GetSpotMarginCurrencyDataParamsV5): Promise<APIResponseV3WithTime<{
1422
+ list: SpotMarginCurrencyDataV5[];
1423
+ }>>;
1256
1424
  /**
1257
1425
  * Turn spot margin trade on / off in your UTA account.
1258
1426
  *
@@ -1306,6 +1474,10 @@ export declare class RestClientV5 extends BaseRestClient {
1306
1474
  *
1307
1475
  * IMPORTANT: Repayment is prohibited between 04:00 and 05:30 per hour.
1308
1476
  * When repaying, system will only use the spot available balance of the debt currency.
1477
+ *
1478
+ * Use `getAvailableAmountToRepay` to check spot available amount. Response timing: ALL and FIXED
1479
+ * asynchronous; FLEXIBLE synchronous. From 2026-03-17 (full 2026-03-24), BYUSDT can be used for
1480
+ * repayment, including MNT using existing spot balance.
1309
1481
  */
1310
1482
  manualRepayWithoutConversion(params: ManualRepayWithoutConversionParamsV5): Promise<APIResponseV3WithTime<ManualRepayWithoutConversionResultV5>>;
1311
1483
  /**
@@ -1327,6 +1499,38 @@ export declare class RestClientV5 extends BaseRestClient {
1327
1499
  * - The amount of repayments is the minimum of available spot balance and liability
1328
1500
  */
1329
1501
  setAutoRepayMode(params: SetAutoRepayModeParamsV5): Promise<APIResponseV3WithTime<AutoRepayModeResultV5>>;
1502
+ /**
1503
+ * Get Liability Info (spot margin UTA): fixed vs floating, spot vs derivatives borrow split.
1504
+ */
1505
+ getSpotMarginLiability(params: GetSpotMarginLiabilityInfoParamsV5): Promise<APIResponseV3WithTime<SpotMarginLiabilityInfoV5>>;
1506
+ /**
1507
+ * Fixed-rate borrow (place order).
1508
+ */
1509
+ submitFixedRateBorrow(params: FixedRateBorrowParamsV5): Promise<APIResponseV3WithTime<FixedRateBorrowResultV5>>;
1510
+ /**
1511
+ * Fixed-rate borrow order history (descending by order time).
1512
+ */
1513
+ getFixedRateBorrowOrderInfo(params?: GetFixedRateBorrowOrderInfoParamsV5): Promise<APIResponseV3WithTime<{
1514
+ list: FixedRateBorrowOrderInfoV5[];
1515
+ nextPageCursor: string;
1516
+ }>>;
1517
+ /**
1518
+ * Fixed-rate borrow contract list (descending by borrow time).
1519
+ */
1520
+ getFixedRateBorrowContractInfo(params?: GetFixedRateBorrowContractInfoParamsV5): Promise<APIResponseV3WithTime<{
1521
+ list: FixedRateBorrowContractInfoV5[];
1522
+ nextPageCursor: string;
1523
+ }>>;
1524
+ /**
1525
+ * Fixed-rate borrow order book quotes (sort by apy, term, or quantity).
1526
+ */
1527
+ getFixedRateBorrowOrderQuote(params: GetFixedRateBorrowOrderQuoteParamsV5): Promise<APIResponseV3WithTime<{
1528
+ list: FixedRateBorrowQuoteV5[];
1529
+ }>>;
1530
+ /**
1531
+ * Renew a fixed-rate loan contract (full remaining amount if `qty` omitted).
1532
+ */
1533
+ renewFixedRateBorrow(params: RenewFixedRateBorrowParamsV5): Promise<APIResponseV3WithTime<string>>;
1330
1534
  /**
1331
1535
  *
1332
1536
  ****** Spot Margin Trade APIs (Normal)
@@ -1972,6 +2176,48 @@ export declare class RestClientV5 extends BaseRestClient {
1972
2176
  * Use exchange broker master account to query
1973
2177
  */
1974
2178
  getBrokerIssuedVoucher(params: GetBrokerIssuedVoucherParamsV5): Promise<APIResponseV3<BrokerIssuedVoucherV5>>;
2179
+ /**
2180
+ * Set Rate Limit
2181
+ * Exchange broker only. Set the rate limit for sub accounts.
2182
+ *
2183
+ * API rate limit: 1 req per second
2184
+ *
2185
+ * INFO
2186
+ * - If the UID calling this endpoint is a master account, the UIDs specified in the uids parameter must belong to its subaccounts. The master account itself cannot set a custom rate limit.
2187
+ * - If the UID requesting this endpoint is a subaccount, the UID can only be itself in uids.
2188
+ * - Only exchange broker account can call this endpoint
2189
+ */
2190
+ setBrokerRateLimit(params: SetBrokerRateLimitParamsV5): Promise<APIResponseV3WithTime<{
2191
+ result: BrokerRateLimitSetResultItemV5[];
2192
+ }>>;
2193
+ /**
2194
+ * Get Rate Limit Cap
2195
+ * Get your exchange broker account entity total rate limit usage and cap, across the board.
2196
+ *
2197
+ * API rate limit: 5 req per second
2198
+ *
2199
+ * INFO
2200
+ * - Only Main UIDs can query this endpoint
2201
+ * - Only exchange broker account can call this endpoint
2202
+ * - If you never apply for a specific config via account manager, it gives empty response.
2203
+ */
2204
+ getBrokerRateLimitCap(): Promise<APIResponseV3WithTime<{
2205
+ list: BrokerRateLimitCapItemV5[];
2206
+ }>>;
2207
+ /**
2208
+ * Get All Rate Limits
2209
+ * Use the master account to query for all your UID-level rate limits, including all master accounts and subaccounts.
2210
+ *
2211
+ * API rate limit: 1 req per second
2212
+ *
2213
+ * INFO
2214
+ * - Only exchange broker account can call this endpoint
2215
+ * - The accounts that have never had a rate limit configured via Set Rate Limit will not appear in the response and will use the default rate limit.
2216
+ */
2217
+ getAllBrokerRateLimits(params?: GetAllBrokerRateLimitsParamsV5): Promise<APIResponseV3WithTime<{
2218
+ list: BrokerRateLimitAllItemV5[];
2219
+ nextPageCursor: string;
2220
+ }>>;
1975
2221
  /**
1976
2222
  *
1977
2223
  ****** EARN
@@ -1988,6 +2234,79 @@ export declare class RestClientV5 extends BaseRestClient {
1988
2234
  }): Promise<APIResponseV3WithTime<{
1989
2235
  list: EarnProductV5[];
1990
2236
  }>>;
2237
+ /**
2238
+ * Get Advanced Earn product info (Dual Asset, Double Win, Smart Leverage, etc. via `category`).
2239
+ *
2240
+ * INFO: No authentication. Up to 50 requests/second per IP.
2241
+ */
2242
+ getAdvanceEarnProduct(params: GetAdvanceEarnProductParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnAdvanceProductInfoV5>>;
2243
+ /**
2244
+ * Liquidity mining — product list (Advanced Earn).
2245
+ *
2246
+ * INFO: No authentication. Up to 50 requests/second per IP.
2247
+ */
2248
+ getLiquidityMiningProduct(params?: GetLiquidityMiningProductParamsV5): Promise<APIResponseV3WithTime<LiquidityMiningProductResultV5>>;
2249
+ /**
2250
+ * Fixed-term / fixed saving — product list (Earn).
2251
+ *
2252
+ * INFO: No authentication. Up to 50 requests/second per IP.
2253
+ */
2254
+ getFixedTermEarnProduct(params?: GetFixedTermEarnProductParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnProductListV5>>;
2255
+ /**
2256
+ * Advanced Earn — quote / extra info (Discount Buy, Dual Assets, …). Call before place order where required.
2257
+ *
2258
+ * INFO: No authentication. Up to 50 requests/second per IP.
2259
+ * Dual Assets: `productId` is required. Response uses `list` with `buyLowPrice` / `sellHighPrice`.
2260
+ */
2261
+ getAdvanceEarnProductExtraInfo(params: GetAdvanceEarnProductExtraInfoParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnProductExtraInfoV5>>;
2262
+ /**
2263
+ * Advanced Earn — place order (Dual Assets, Discount Buy, …). Async; use getAdvanceEarnOrder to track.
2264
+ *
2265
+ * INFO: API key needs "Earn" permission. Rate limit e.g. 5 req/s (Dual Assets per docs).
2266
+ */
2267
+ submitAdvanceEarnPlaceOrder(params: SubmitAdvanceEarnPlaceOrderParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnPlaceOrderResultV5>>;
2268
+ /**
2269
+ * Advanced Earn — active positions (Dual Assets, Discount Buy, …).
2270
+ *
2271
+ * INFO: API key needs "Earn" permission. E.g. 10 req/s (Dual Assets per docs).
2272
+ */
2273
+ getAdvanceEarnPosition(params: GetAdvanceEarnPositionListParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnPositionListV5>>;
2274
+ /**
2275
+ * Advanced Earn — order list (Dual Assets, Discount Buy, …). Distinct from getEarnOrderHistory (/v5/earn/order).
2276
+ *
2277
+ * INFO: API key needs "Earn" permission. E.g. 10 req/s (Dual Assets per docs).
2278
+ */
2279
+ getAdvanceEarnOrder(params: GetAdvanceEarnOrderListParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnOrderListV5>>;
2280
+ /**
2281
+ * Fixed-term earn — place order (stake). Async; use getFixedTermEarnOrder to track.
2282
+ *
2283
+ * INFO: API key needs "Earn" permission. Rate limit: 5 req/s.
2284
+ */
2285
+ submitFixedTermEarnOrder(params: SubmitFixedTermEarnOrderParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnPlaceOrderResultV5>>;
2286
+ /**
2287
+ * Fixed-term earn — early redeem (FundPool only, when product allows).
2288
+ *
2289
+ * INFO: API key needs "Earn" permission. Rate limit: 5 req/s.
2290
+ */
2291
+ redeemFixedTermEarn(params: RedeemFixedTermEarnParamsV5): Promise<APIResponseV3WithTime<RedeemFixedTermEarnResultV5>>;
2292
+ /**
2293
+ * Fixed-term earn — active positions.
2294
+ *
2295
+ * INFO: API key needs "Earn" permission. Rate limit: 10 req/s.
2296
+ */
2297
+ getFixedTermEarnPosition(params?: GetFixedTermEarnPositionParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnPositionListV5>>;
2298
+ /**
2299
+ * Fixed-term earn — order list.
2300
+ *
2301
+ * INFO: API key needs "Earn" permission. Rate limit: 10 req/s.
2302
+ */
2303
+ getFixedTermEarnOrder(params?: GetFixedTermEarnOrderListParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnOrderListV5>>;
2304
+ /**
2305
+ * Fixed-term earn — enable or disable auto-invest on a position.
2306
+ *
2307
+ * INFO: API key needs "Earn" permission. Rate limit: 5 req/s.
2308
+ */
2309
+ setFixedTermEarnAutoInvest(params: SetFixedTermEarnAutoInvestParamsV5): Promise<APIResponseV3WithTime<Record<string, never>>>;
1991
2310
  /**
1992
2311
  * Stake or Redeem Earn products
1993
2312
  *
@@ -2022,14 +2341,23 @@ export declare class RestClientV5 extends BaseRestClient {
2022
2341
  * INFO: API key needs "Earn" permission
2023
2342
  *
2024
2343
  * Note: Fully redeemed position is also returned in the response
2344
+ * Note: Response includes `autoReinvest` where applicable; use `modifyEarnPosition` to change it (OnChain fixed).
2025
2345
  */
2026
2346
  getEarnPosition(params: GetEarnPositionParamsV5): Promise<APIResponseV3WithTime<{
2027
2347
  list: EarnPositionV5[];
2028
2348
  }>>;
2349
+ /**
2350
+ * Modify OnChain Earn position (e.g. auto-reinvest for fixed duration products).
2351
+ *
2352
+ * INFO: API key needs "Earn" permission. Only `category=OnChain` and fixed positions (see product).
2353
+ */
2354
+ modifyEarnPosition(params: ModifyEarnPositionParamsV5): Promise<APIResponseV3WithTime<Record<string, never>>>;
2029
2355
  /**
2030
2356
  * Get Yield History
2031
2357
  *
2032
2358
  * INFO: API key needs "Earn" permission
2359
+ *
2360
+ * Note: `category` includes `OnChain`. For `OnChain`, do not pass `productId` (error).
2033
2361
  */
2034
2362
  getEarnYieldHistory(params: GetEarnYieldHistoryParamsV5): Promise<APIResponseV3WithTime<{
2035
2363
  yield: EarnYieldHistoryV5[];
@@ -2044,6 +2372,83 @@ export declare class RestClientV5 extends BaseRestClient {
2044
2372
  list: EarnHourlyYieldHistoryV5[];
2045
2373
  nextPageCursor: string;
2046
2374
  }>>;
2375
+ /**
2376
+ * Get historical APR (FlexibleSaving / OnChain), up to ~6 months.
2377
+ *
2378
+ * INFO: Does not need authentication
2379
+ */
2380
+ getEarnAprHistory(params: GetEarnAprHistoryParamsV5): Promise<APIResponseV3WithTime<{
2381
+ list: EarnAprHistoryPointV5[];
2382
+ }>>;
2383
+ /**
2384
+ * Earn token product (e.g. BYUSDT) — Get Product Info
2385
+ * Without auth, user-specific fields are empty or defaulted.
2386
+ */
2387
+ getEarnTokenProduct(params: GetEarnTokenProductParamsV5): Promise<APIResponseV3WithTime<EarnTokenProductV5>>;
2388
+ /**
2389
+ * Earn token — Place Order (Mint / Redeem). Accepted response is not final settlement; use `getEarnTokenOrders`.
2390
+ */
2391
+ submitEarnTokenOrder(params: PlaceEarnTokenOrderParamsV5): Promise<APIResponseV3WithTime<PlaceEarnTokenOrderResultV5>>;
2392
+ /**
2393
+ * Earn token — Get Order List
2394
+ */
2395
+ getEarnTokenOrders(params: GetEarnTokenOrderListParamsV5): Promise<APIResponseV3WithTime<{
2396
+ list: EarnTokenOrderV5[];
2397
+ nextPageCursor: string;
2398
+ }>>;
2399
+ /**
2400
+ * Earn token — Get Position Info
2401
+ */
2402
+ getEarnTokenPosition(params: GetEarnTokenPositionParamsV5): Promise<APIResponseV3WithTime<EarnTokenPositionV5>>;
2403
+ /**
2404
+ * Earn token — Get Daily Yield Records
2405
+ */
2406
+ getEarnTokenDailyYield(params: GetEarnTokenDailyYieldParamsV5): Promise<APIResponseV3WithTime<{
2407
+ list: EarnTokenDailyYieldRecordV5[];
2408
+ nextPageCursor: string;
2409
+ }>>;
2410
+ /**
2411
+ * Earn token — Get Hourly Yield Records
2412
+ */
2413
+ getEarnTokenHourlyYield(params: GetEarnTokenHourlyYieldParamsV5): Promise<APIResponseV3WithTime<{
2414
+ list: EarnTokenHourlyYieldRecordV5[];
2415
+ nextPageCursor: string;
2416
+ }>>;
2417
+ /**
2418
+ * Earn token — Get History APR (7/30/180 days). No authentication required.
2419
+ */
2420
+ getEarnTokenHistoryApr(params: GetEarnTokenHistoryAprParamsV5): Promise<APIResponseV3WithTime<{
2421
+ list: EarnTokenHistoryAprPointV5[];
2422
+ }>>;
2423
+ /**
2424
+ *
2425
+ ****** Bybit Card APIs
2426
+ *
2427
+ */
2428
+ /**
2429
+ * Bybit Card — query card transaction / asset history (filter by status, card digits, merchant, time, type, …).
2430
+ */
2431
+ queryCardAssetRecords(params?: QueryCardAssetRecordsParamsV5): Promise<APIResponseV3WithTime<CardAssetRecordsResultV5>>;
2432
+ /**
2433
+ * Bybit Card — point balance (available, pending, account status, …).
2434
+ */
2435
+ queryCardPointsBalance(): Promise<APIResponseV3WithTime<CardPointBalanceV5>>;
2436
+ /**
2437
+ * Bybit Card — point transaction records.
2438
+ */
2439
+ queryCardPointsRecords(params?: QueryCardPointRecordsParamsV5): Promise<APIResponseV3WithTime<CardPointRecordsResultV5>>;
2440
+ /**
2441
+ * Bybit Card — reward tier, spending limit, auto cashback.
2442
+ */
2443
+ queryCardPointsTier(): Promise<APIResponseV3WithTime<CardPointTierInfoV5>>;
2444
+ /**
2445
+ * Bybit Card — reward mall item list.
2446
+ */
2447
+ queryCardMallItemList(params?: QueryCardMallItemListParamsV5): Promise<APIResponseV3WithTime<CardMallItemListResultV5>>;
2448
+ /**
2449
+ * Bybit Card — cashback detail for a reward order.
2450
+ */
2451
+ queryCardPointCashbackDetail(params: QueryCardPointCashbackDetailParamsV5): Promise<APIResponseV3WithTime<CardPointCashbackDetailV5>>;
2047
2452
  /**
2048
2453
  *
2049
2454
  ****** RFQ APIs