bybit-api 4.6.1 → 4.6.3
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.
- package/README.md +1 -0
- package/lib/constants/enum.d.ts +1 -0
- package/lib/constants/enum.js +1 -0
- package/lib/constants/enum.js.map +1 -1
- package/lib/rest-client-v5.d.ts +503 -18
- package/lib/rest-client-v5.js +634 -5
- package/lib/rest-client-v5.js.map +1 -1
- package/lib/types/request/index.d.ts +8 -0
- package/lib/types/request/index.js +8 -0
- package/lib/types/request/index.js.map +1 -1
- package/lib/types/request/v5-account.d.ts +25 -1
- package/lib/types/request/v5-alpha-trade.d.ts +52 -0
- package/lib/types/request/v5-alpha-trade.js +6 -0
- package/lib/types/request/v5-alpha-trade.js.map +1 -0
- package/lib/types/request/v5-asset.d.ts +26 -2
- package/lib/types/request/v5-card.d.ts +51 -0
- package/lib/types/request/v5-card.js +7 -0
- package/lib/types/request/v5-card.js.map +1 -0
- package/lib/types/request/v5-crypto-loan.d.ts +8 -0
- package/lib/types/request/v5-earn-advance-discount.d.ts +75 -0
- package/lib/types/request/v5-earn-advance-discount.js +3 -0
- package/lib/types/request/v5-earn-advance-discount.js.map +1 -0
- package/lib/types/request/v5-earn-fixed-term.d.ts +42 -0
- package/lib/types/request/v5-earn-fixed-term.js +3 -0
- package/lib/types/request/v5-earn-fixed-term.js.map +1 -0
- package/lib/types/request/v5-earn-liquidity-mining.d.ts +7 -0
- package/lib/types/request/v5-earn-liquidity-mining.js +3 -0
- package/lib/types/request/v5-earn-liquidity-mining.js.map +1 -0
- package/lib/types/request/v5-earn-pwm.d.ts +167 -0
- package/lib/types/request/v5-earn-pwm.js +3 -0
- package/lib/types/request/v5-earn-pwm.js.map +1 -0
- package/lib/types/request/v5-earn-token.d.ts +49 -0
- package/lib/types/request/v5-earn-token.js +6 -0
- package/lib/types/request/v5-earn-token.js.map +1 -0
- package/lib/types/request/v5-earn.d.ts +35 -0
- package/lib/types/request/v5-market.d.ts +10 -3
- package/lib/types/request/v5-spot-leverage-token.d.ts +46 -0
- package/lib/types/request/v5-spreadtrading.d.ts +7 -0
- package/lib/types/request/v5-strategy.d.ts +80 -0
- package/lib/types/request/v5-strategy.js +3 -0
- package/lib/types/request/v5-strategy.js.map +1 -0
- package/lib/types/request/v5-user.d.ts +29 -3
- package/lib/types/response/index.d.ts +8 -0
- package/lib/types/response/index.js +8 -0
- package/lib/types/response/index.js.map +1 -1
- package/lib/types/response/v5-account.d.ts +76 -0
- package/lib/types/response/v5-alpha-trade.d.ts +170 -0
- package/lib/types/response/v5-alpha-trade.js +6 -0
- package/lib/types/response/v5-alpha-trade.js.map +1 -0
- package/lib/types/response/v5-asset.d.ts +128 -10
- package/lib/types/response/v5-card.d.ts +118 -0
- package/lib/types/response/v5-card.js +3 -0
- package/lib/types/response/v5-card.js.map +1 -0
- package/lib/types/response/v5-earn-advance-discount.d.ts +143 -0
- package/lib/types/response/v5-earn-advance-discount.js +3 -0
- package/lib/types/response/v5-earn-advance-discount.js.map +1 -0
- package/lib/types/response/v5-earn-fixed-term.d.ts +102 -0
- package/lib/types/response/v5-earn-fixed-term.js +3 -0
- package/lib/types/response/v5-earn-fixed-term.js.map +1 -0
- package/lib/types/response/v5-earn-liquidity-mining.d.ts +31 -0
- package/lib/types/response/v5-earn-liquidity-mining.js +3 -0
- package/lib/types/response/v5-earn-liquidity-mining.js.map +1 -0
- package/lib/types/response/v5-earn-pwm.d.ts +425 -0
- package/lib/types/response/v5-earn-pwm.js +3 -0
- package/lib/types/response/v5-earn-pwm.js.map +1 -0
- package/lib/types/response/v5-earn-token.d.ts +62 -0
- package/lib/types/response/v5-earn-token.js +6 -0
- package/lib/types/response/v5-earn-token.js.map +1 -0
- package/lib/types/response/v5-earn.d.ts +141 -0
- package/lib/types/response/v5-market.d.ts +16 -4
- package/lib/types/response/v5-position.d.ts +2 -0
- package/lib/types/response/v5-spot-leverage-token.d.ts +56 -0
- package/lib/types/response/v5-spreadtrading.d.ts +5 -0
- package/lib/types/response/v5-strategy.d.ts +96 -0
- package/lib/types/response/v5-strategy.js +3 -0
- package/lib/types/response/v5-strategy.js.map +1 -0
- package/lib/types/response/v5-user.d.ts +30 -0
- package/lib/types/shared-v5.d.ts +20 -1
- package/lib/types/websockets/ws-events.d.ts +2 -0
- package/lib/util/webCryptoAPI.d.ts +1 -1
- package/lib/util/webCryptoAPI.js +1 -1
- package/lib/util/webCryptoAPI.js.map +1 -1
- package/lib/util/websockets/websocket-util.js +1 -0
- package/lib/util/websockets/websocket-util.js.map +1 -1
- package/llms.txt +12585 -7241
- package/package.json +1 -1
package/lib/rest-client-v5.d.ts
CHANGED
|
@@ -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, 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, 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, FriendReferralRecordV5, FundingAccountTransactionRecordV5, FundingRateHistoryResponseV5, GetAccountCoinBalanceParamsV5, GetAccountHistoricOrdersParamsV5, GetAccountInstrumentsInfoParamsV5, GetAccountOrdersParamsV5, GetADLAlertParamsV5, GetAffiliateUserListParamsV5, GetAllBrokerRateLimitsParamsV5, GetAllCoinsBalanceParamsV5, GetAllowedDepositCoinInfoParamsV5, GetAssetInfoParamsV5, GetAssetOverviewParamsV5, 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, GetFriendReferralsParamsV5, GetFundingAccountTransactionHistoryParamsV5, 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, SetBrokerRateLimitParamsV5, SetCollateralCoinParamsV5, SetLeverageParamsV5, SetLimitPriceActionParamsV5, SetRiskLimitParamsV5, SetRiskLimitResultV5, SetSpotMarginLeverageParamsV5, SettlementRecordV5, SetTPSLModeParamsV5, SetTradingStopParamsV5, SignAgreementParamsV5, 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, AffiliateSubAffiliateListResultV5, 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, ClaimPwmWithdrawableFundsParamsV5, ClaimPwmWithdrawableFundsResultV5, ClosedOptionsPositionV5, ClosedPnLV5, CoinExchangeRecordV5, CoinGreeksV5, CoinInfoV5, CoinStateV5, CollateralAdjustmentHistoryV5, CollateralDataV5, CollateralInfoV5, CompletedLoanOrderV5, ConfirmNewRiskLimitParamsV5, ConvertCoinsParamsV5, ConvertCoinSpecV5, ConvertHistoryRecordV5, ConvertQuoteV5, ConvertStatusV5, CreateBorrowOrderFixedParamsV5, CreateBorrowOrderFixedV5, CreateP2PAdParamsV5, CreatePwmAssetManagerInvestmentPlanParamsV5, CreatePwmAssetManagerInvestmentPlanResultV5, CreatePwmCustomizeInvestmentPlanParamsV5, CreatePwmCustomizeInvestmentPlanResultV5, CreatePwmFundParamsV5, CreatePwmFundResultV5, CreatePwmFundSubAccountParamsV5, CreatePwmFundSubAccountResultV5, CreateRFQParamsV5, CreateRFQQuoteParamsV5, CreateRFQQuoteResultV5, CreateRFQResultV5, CreateStrategyOrderParamsV5, CreateStrategyOrderResultV5, 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, GetAffiliateSubAffiliateListParamsV5, GetAffiliateUserInfoParamsV5, 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, GetHoldToEarnAirdropYieldHistoryParamsV5, 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, GetPwmAllFundOrdersParamsV5, GetPwmAllFundsParamsV5, GetPwmAssetManagerInvestmentPlansParamsV5, GetPwmFundHistoricalNavParamsV5, GetPwmFundTransferRecordsParamsV5, GetPwmInvestmentPlanAssetTrendParamsV5, GetPwmInvestmentPlanDetailParamsV5, GetPwmInvestmentPlanOrdersParamsV5, GetPwmPendingInvestmentPlanDetailParamsV5, GetRenewOrderInfoFixedParamsV5, GetRepaymentHistoryFixedParamsV5, GetRepaymentHistoryFlexibleParamsV5, GetRepaymentHistoryParamsV5, GetRFQHistoryParamsV5, GetRFQListParamsV5, GetRFQPublicTradesParamsV5, GetRFQQuoteRealtimeParamsV5, GetRFQRealtimeParamsV5, GetRFQRealtimeResultV5, GetRFQTradeListParamsV5, GetRiskLimitParamsV5, GetRPIOrderbookParamsV5, GetSettlementRecordParamsV5, GetSmallBalanceListParamsV5, GetSpotMarginCurrencyDataParamsV5, GetSpotMarginLiabilityInfoParamsV5, GetSpreadInstrumentsInfoParamsV5, GetSpreadMaxQtyParamsV5, GetSpreadOpenOrdersParamsV5, GetSpreadOrderHistoryParamsV5, GetSpreadTradeHistoryParamsV5, GetStrategyListParamsV5, GetStrategyOrderListParamsV5, GetSubAccountAllApiKeysParamsV5, GetSubAccountDepositRecordParamsV5, GetSupplyContractInfoFixedParamsV5, GetSupplyOrderInfoFixedParamsV5, GetSupplyOrderQuoteFixedParamsV5, GetSystemStatusParamsV5, GetTickersParamsV5, GetTotalMembersAssetsParamsV5, GetTradeInfoForAnalysisParamsV5, GetTransactionLogParamsV5, GetUniversalTransferRecordsParamsV5, GetUnpaidLoanOrdersParamsV5, GetVIPMarginDataParamsV5, GetWalletBalanceParamsV5, GetWithdrawalAddressListParamsV5, GetWithdrawalRecordsParamsV5, HistoricalVolatilityV5, HoldToEarnAirdropProductsResultV5, HoldToEarnAirdropYieldHistoryResultV5, IndexPriceComponentsResponseV5, InstitutionalLoanLTVV5, InstrumentInfoResponseV5, InsuranceResponseV5, InternalDepositRecordV5, InternalTransferRecordV5, InvestMorePwmInvestmentPlanParamsV5, InvestMorePwmInvestmentPlanResultV5, IssueVoucherParamsV5, LiquidityMiningProductResultV5, LoanLTVAdjustmentHistoryV5, LongShortRatioV5, ManagePwmAssetManagerInvestmentPlanParamsV5, ManagePwmAssetManagerInvestmentPlanResultV5, ManagePwmFundOrderParamsV5, ManagePwmFundOrderResultV5, 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, PwmAllFundOrdersResultV5, PwmAllFundsResultV5, PwmAssetManagerInvestmentPlansResultV5, PwmFundHistoricalNavResultV5, PwmFundTransferParamsV5, PwmFundTransferRecordV5, PwmFundTransferResultV5, PwmInvestmentPlanAssetTrendResultV5, PwmInvestmentPlanDetailV5, PwmInvestmentPlanListResultV5, PwmInvestmentPlanOrdersResultV5, PwmPendingInvestmentPlanDetailV5, PwmSubscribableProductInfoResultV5, QueryCardAssetRecordsParamsV5, QueryCardMallItemListParamsV5, QueryCardPointCashbackDetailParamsV5, QueryCardPointRecordsParamsV5, RedeemFixedTermEarnParamsV5, RedeemFixedTermEarnResultV5, RedeemPwmInvestmentPlanParamsV5, RedeemPwmInvestmentPlanResultV5, 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, SettlePwmFundProfitParamsV5, SettlePwmFundProfitResultV5, SetTPSLModeParamsV5, SetTradingStopParamsV5, SignAgreementParamsV5, SmallBalanceListV5, SpotBorrowCheckResultV5, SpotMarginCurrencyDataV5, SpotMarginLiabilityInfoV5, SpotMarginStateV5, SpreadInstrumentInfoV5, SpreadMaxQtyResultV5, SpreadOpenOrderV5, SpreadOrderbookResponseV5, SpreadOrderHistoryV5, SpreadRecentTradeV5, SpreadTickerV5, SpreadTradeV5, StopStrategyParamsV5, StopStrategyResultV5, StrategyListResultV5, StrategyOrderListResultV5, SubMemberV5, SubmitAdvanceEarnPlaceOrderParamsV5, SubmitFixedTermEarnOrderParamsV5, SubmitSpreadOrderParamsV5, SubmitStakeRedeemParamsV5, SubscribePwmInvestmentPlanParamsV5, SubscribePwmInvestmentPlanResultV5, 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:
|
|
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;
|
|
@@ -414,6 +422,35 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
414
422
|
* Conditional order is not supported.
|
|
415
423
|
*/
|
|
416
424
|
preCheckOrder(params: OrderParamsV5): Promise<APIResponseV3WithTime<PreCheckOrderResultV5>>;
|
|
425
|
+
/**
|
|
426
|
+
*
|
|
427
|
+
****** Strategy APIs
|
|
428
|
+
*
|
|
429
|
+
*/
|
|
430
|
+
/**
|
|
431
|
+
* Create Strategy Order
|
|
432
|
+
*
|
|
433
|
+
* Supported strategy types: `twap`, `chaseOrder`, `iceberg`, `pov`.
|
|
434
|
+
*/
|
|
435
|
+
createStrategyOrder(params: CreateStrategyOrderParamsV5): Promise<APIResponseV3WithTime<CreateStrategyOrderResultV5>>;
|
|
436
|
+
/**
|
|
437
|
+
* Get Strategy List
|
|
438
|
+
*
|
|
439
|
+
* Query the strategy list. Supports filtering by strategy ID, symbol, status, category, and strategy type.
|
|
440
|
+
*/
|
|
441
|
+
getStrategyList(params?: GetStrategyListParamsV5): Promise<APIResponseV3WithTime<StrategyListResultV5>>;
|
|
442
|
+
/**
|
|
443
|
+
* Get Strategy Order List
|
|
444
|
+
*
|
|
445
|
+
* Query the individual orders generated by a specific strategy.
|
|
446
|
+
*/
|
|
447
|
+
getStrategyOrderList(params: GetStrategyOrderListParamsV5): Promise<APIResponseV3WithTime<StrategyOrderListResultV5>>;
|
|
448
|
+
/**
|
|
449
|
+
* Stop Strategy
|
|
450
|
+
*
|
|
451
|
+
* Stop a running strategy. Once stopped, the strategy cannot be resumed.
|
|
452
|
+
*/
|
|
453
|
+
stopStrategy(params: StopStrategyParamsV5): Promise<APIResponseV3WithTime<StopStrategyResultV5>>;
|
|
417
454
|
/**
|
|
418
455
|
*
|
|
419
456
|
****** Position APIs
|
|
@@ -429,6 +466,8 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
429
466
|
* Normal account covers: USDT perpetual / Inverse perpetual / Inverse futures
|
|
430
467
|
*
|
|
431
468
|
* Note: this will give a 404 error if you query the `option` category if your account is not unified
|
|
469
|
+
*
|
|
470
|
+
* Response list items include `openTime` (position open timestamp in ms, default `0`).
|
|
432
471
|
*/
|
|
433
472
|
getPositionInfo(params: PositionInfoParamsV5): Promise<APIResponseV3WithTime<CategoryCursorListV5<PositionV5[]>>>;
|
|
434
473
|
/**
|
|
@@ -644,6 +683,7 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
644
683
|
* Covers: SPOT / USDT contract / USDC contract / Inverse contract
|
|
645
684
|
*
|
|
646
685
|
* Includes RPI permission information (isPublicRpi, myRpiPermission)
|
|
686
|
+
* Note: e.g. `symbolType: 'commodity'`, and for linear also `stock`, `forex`.
|
|
647
687
|
*/
|
|
648
688
|
getAccountInstrumentsInfo<C extends 'spot' | 'linear' | 'inverse'>(params: GetAccountInstrumentsInfoParamsV5 & {
|
|
649
689
|
category: C;
|
|
@@ -667,8 +707,17 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
667
707
|
*
|
|
668
708
|
* - Input the specific coin: repay the liability of this coin in particular
|
|
669
709
|
* - No coin specified: repay the liability of all coins
|
|
710
|
+
*
|
|
711
|
+
* Does not repay manual-borrow (spot margin manual borrow) liabilities — use `manualRepay` or
|
|
712
|
+
* `manualRepayWithoutConversion` instead (API error 182120 otherwise).
|
|
713
|
+
* From 2026-03-17 (full 2026-03-24), BYUSDT can be used for repayment. MNT is temporarily not used for
|
|
714
|
+
* this flow; MNT convert-repay is not supported (use `manualRepayWithoutConversion` with existing balance).
|
|
715
|
+
* From 2026-02-10 08:00 UTC, coin-conversion fees use the higher of collateral or debt fee rate, with a
|
|
716
|
+
* per-transaction coin-conversion cap of 300,000 USD equivalent.
|
|
670
717
|
*/
|
|
671
|
-
repayLiability(params?: RepayLiabilityParamsV5): Promise<APIResponseV3WithTime<
|
|
718
|
+
repayLiability(params?: RepayLiabilityParamsV5): Promise<APIResponseV3WithTime<{
|
|
719
|
+
list: RepayLiabilityResultV5[];
|
|
720
|
+
}>>;
|
|
672
721
|
/**
|
|
673
722
|
* Manual Repay
|
|
674
723
|
*
|
|
@@ -679,6 +728,14 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
679
728
|
* If that's not enough, the remaining amount will be repaid by converting other assets.
|
|
680
729
|
*
|
|
681
730
|
* Repayment is prohibited between 04:00 and 05:30 per hour.
|
|
731
|
+
*
|
|
732
|
+
* When `coin` and `amount` are both set, validation depends on `repaymentType` (e.g. amount must not
|
|
733
|
+
* exceed the matching liability pool). If neither `coin` nor `amount` is set, `repaymentType` must be
|
|
734
|
+
* ALL. Response timing: ALL and FIXED are asynchronous; FLEXIBLE is synchronous.
|
|
735
|
+
* For repay-without-convert (spot balance only), use `manualRepayWithoutConversion`.
|
|
736
|
+
* From 2026-03-17 (full 2026-03-24), BYUSDT can be used for repayment. MNT: not via convert-repay;
|
|
737
|
+
* use `manualRepayWithoutConversion` for MNT with existing balance. From 2026-02-10 08:00 UTC,
|
|
738
|
+
* coin-conversion cap 300,000 USD equivalent per transaction applies.
|
|
682
739
|
*/
|
|
683
740
|
manualRepay(params?: ManualRepayParamsV5): Promise<APIResponseV3WithTime<ManualRepayResultV5>>;
|
|
684
741
|
/**
|
|
@@ -773,13 +830,16 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
773
830
|
*/
|
|
774
831
|
setLimitPriceAction(params: SetLimitPriceActionParamsV5): Promise<APIResponseV3WithTime<{}>>;
|
|
775
832
|
/**
|
|
776
|
-
* Get Limit Price Behaviour
|
|
833
|
+
* Get Trade Behaviour Config / Get Limit Price Behaviour
|
|
777
834
|
* You can get configuration how the system behaves when your limit order price exceeds the highest bid or lowest ask price.
|
|
835
|
+
* Response includes `deltaEnable` for Delta Neutral mode, and `smsef` / `fmsef` for Spot and Futures MNT fee deduction.
|
|
778
836
|
*/
|
|
779
|
-
getLimitPriceAction(): Promise<APIResponseV3WithTime<
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
837
|
+
getLimitPriceAction(): Promise<APIResponseV3WithTime<UserSettingConfigV5>>;
|
|
838
|
+
/**
|
|
839
|
+
* Set Delta Neutral Mode
|
|
840
|
+
* 1: enable, 0: disable. Query current status via `getLimitPriceAction()`.
|
|
841
|
+
*/
|
|
842
|
+
setDeltaNeutralMode(params: SetDeltaNeutralModeParamsV5): Promise<APIResponseV3WithTime<Record<string, never>>>;
|
|
783
843
|
/**
|
|
784
844
|
* Configure Market Maker Protection (MMP)
|
|
785
845
|
*/
|
|
@@ -794,6 +854,21 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
794
854
|
getMMPState(baseCoin: string): Promise<APIResponseV3WithTime<{
|
|
795
855
|
result: MMPStateV5[];
|
|
796
856
|
}>>;
|
|
857
|
+
/**
|
|
858
|
+
* Get Option Asset Info
|
|
859
|
+
* P&L per coin for options: delta, RPL, UPL, margin. Result uses a nested `result` list.
|
|
860
|
+
*/
|
|
861
|
+
getOptionAssetInfo(): Promise<APIResponseV3WithTime<OptionAssetInfoNestedResultV5>>;
|
|
862
|
+
/**
|
|
863
|
+
* Get Pay Info
|
|
864
|
+
* Repayment collateral snapshot before `manualRepay` or `repayLiability`. Optional `coin` for one liability; omit for total.
|
|
865
|
+
*/
|
|
866
|
+
getPayInfo(params?: GetPayInfoParamsV5): Promise<APIResponseV3WithTime<PayInfoResultV5>>;
|
|
867
|
+
/**
|
|
868
|
+
* Get Trade Info For Analysis
|
|
869
|
+
* Aggregated spot trade stats for a symbol, including daily breakdown when returned.
|
|
870
|
+
*/
|
|
871
|
+
getTradeInfoForAnalysis(params: GetTradeInfoForAnalysisParamsV5): Promise<APIResponseV3WithTime<TradeInfoForAnalysisResultV5>>;
|
|
797
872
|
/**
|
|
798
873
|
*
|
|
799
874
|
****** Asset APIs
|
|
@@ -804,8 +879,20 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
804
879
|
* Query master account or subaccount's total assets and detailed asset holdings across different accounts and product categories.
|
|
805
880
|
*
|
|
806
881
|
* INFO: For accountType=Alpha, on-chain assets are not included in the returned data in current version.
|
|
882
|
+
* `valuationCurrency` sets fiat for totals; `accountType` filters which account to return. For Alpha + farm, `extMap` may
|
|
883
|
+
* appear on `coinDetail` (price range and equity unit).
|
|
807
884
|
*/
|
|
808
885
|
getAssetOverview(params?: GetAssetOverviewParamsV5): Promise<APIResponseV3WithTime<AssetOverviewResultV5>>;
|
|
886
|
+
/**
|
|
887
|
+
* Get Portfolio Margin Info
|
|
888
|
+
* Wallet and per-base-coin P&L range (aligned with the portfolio margin page).
|
|
889
|
+
*/
|
|
890
|
+
getPortfolioMarginInfo(params?: GetPortfolioMarginInfoParamsV5): Promise<APIResponseV3WithTime<PortfolioMarginInfoResultV5>>;
|
|
891
|
+
/**
|
|
892
|
+
* Get Total Members Assets
|
|
893
|
+
* Master + sub-accounts; optional `coin` for valuation (default BTC).
|
|
894
|
+
*/
|
|
895
|
+
getTotalMembersAssets(params?: GetTotalMembersAssetsParamsV5): Promise<APIResponseV3WithTime<TotalMembersAssetsResultV5>>;
|
|
809
896
|
/**
|
|
810
897
|
* Funding Account Transaction History
|
|
811
898
|
* Transaction log in Funding Account. Supports filtering by transaction type and time range.
|
|
@@ -839,6 +926,9 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
839
926
|
}>>;
|
|
840
927
|
/**
|
|
841
928
|
* Query coin information, including chain information, withdraw and deposit status.
|
|
929
|
+
*
|
|
930
|
+
* Per-chain `withdrawMax` is the max amount per withdrawal on that chain (`-1` = no limit).
|
|
931
|
+
* `remainAmount` is deprecated.
|
|
842
932
|
*/
|
|
843
933
|
getCoinInfo(coin?: string): Promise<APIResponseV3WithTime<{
|
|
844
934
|
rows: CoinInfoV5[];
|
|
@@ -874,13 +964,13 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
874
964
|
*/
|
|
875
965
|
getCoinBalance(params: GetAccountCoinBalanceParamsV5): Promise<APIResponseV3<AccountCoinBalanceV5>>;
|
|
876
966
|
/**
|
|
877
|
-
* Query withdrawable amount.
|
|
967
|
+
* Query withdrawable amount (incl. risk-frozen `limitAmountUsd` and per-wallet slices).
|
|
968
|
+
* May include FUND, UTA, EARN, SPOT keys depending on the coin. EARN is present when the coin
|
|
969
|
+
* supports withdrawal from the Earn account.
|
|
878
970
|
*/
|
|
879
971
|
getWithdrawableAmount(params: {
|
|
880
972
|
coin: string;
|
|
881
|
-
}): Promise<
|
|
882
|
-
rows: WithdrawableAmountV5[];
|
|
883
|
-
}>>;
|
|
973
|
+
}): Promise<APIResponseV3WithTime<WithdrawableAmountV5>>;
|
|
884
974
|
/**
|
|
885
975
|
* Query the transferable coin list between each account type.
|
|
886
976
|
*/
|
|
@@ -937,6 +1027,7 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
937
1027
|
}>>;
|
|
938
1028
|
/**
|
|
939
1029
|
* Set auto transfer account after deposit. The same function as the setting for Deposit on web GUI
|
|
1030
|
+
* (UNIFIED, FUND, or EARN; if a coin is not in flexible saving, EARN may route to funding as per Bybit).
|
|
940
1031
|
*/
|
|
941
1032
|
setDepositAccount(params: {
|
|
942
1033
|
accountType: AccountTypeV5;
|
|
@@ -1027,11 +1118,13 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1027
1118
|
vasp: VaspEntityV5[];
|
|
1028
1119
|
}>>;
|
|
1029
1120
|
/**
|
|
1030
|
-
* Withdraw
|
|
1121
|
+
* Withdraw from Funding, Unified, and/or Earn (and combos such as FUND,UTA,EARN per API).
|
|
1031
1122
|
*
|
|
1032
1123
|
* CAUTION: Make sure you have whitelisted your wallet address before calling this endpoint.
|
|
1033
1124
|
*
|
|
1034
1125
|
* You can make an off-chain transfer if the target wallet address is from Bybit. This means that no blockchain fee will be charged.
|
|
1126
|
+
*
|
|
1127
|
+
* Bybit Turkey (TR) site: `transactionPurpose` is required on the request (see `WithdrawParamsV5`).
|
|
1035
1128
|
*/
|
|
1036
1129
|
submitWithdrawal(params: WithdrawParamsV5): Promise<APIResponseV3WithTime<{
|
|
1037
1130
|
id: string;
|
|
@@ -1144,6 +1237,8 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1144
1237
|
* Both master and sub user's api key are applicable.
|
|
1145
1238
|
*
|
|
1146
1239
|
* TIP: Any permission can access this endpoint.
|
|
1240
|
+
*
|
|
1241
|
+
* Response `permissions` may include `FiatBitPay` (not `FiatBybitPay`).
|
|
1147
1242
|
*/
|
|
1148
1243
|
getQueryApiKey(): Promise<APIResponseV3WithTime<ApiKeyInfoV5>>;
|
|
1149
1244
|
/**
|
|
@@ -1166,6 +1261,8 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1166
1261
|
*
|
|
1167
1262
|
* TIP: The API key must have one of the permissions to be allowed to call the following API endpoint.
|
|
1168
1263
|
* - master API key: "Account Transfer", "Subaccount Transfer", "Withdrawal"
|
|
1264
|
+
*
|
|
1265
|
+
* `permissions` may include `FiatBitPay` (not `FiatBybitPay`).
|
|
1169
1266
|
*/
|
|
1170
1267
|
updateMasterApiKey(params: UpdateApiKeyParamsV5): Promise<APIResponseV3WithTime<UpdateApiKeyResultV5>>;
|
|
1171
1268
|
/**
|
|
@@ -1225,6 +1322,16 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1225
1322
|
list: AffiliateUserListItemV5[];
|
|
1226
1323
|
nextPageCursor: string;
|
|
1227
1324
|
}>>;
|
|
1325
|
+
/**
|
|
1326
|
+
* Get Affiliate Sub-Affiliate List.
|
|
1327
|
+
*
|
|
1328
|
+
* To use this endpoint, you should have an affiliate account and only tick "affiliate" permission while creating the API key.
|
|
1329
|
+
*
|
|
1330
|
+
* TIP:
|
|
1331
|
+
* - Use master UID only
|
|
1332
|
+
* - The api key can only have "Affiliate" permission
|
|
1333
|
+
*/
|
|
1334
|
+
getAffiliateSubAffiliateList(params?: GetAffiliateSubAffiliateListParamsV5): Promise<APIResponseV3WithTime<AffiliateSubAffiliateListResultV5>>;
|
|
1228
1335
|
/**
|
|
1229
1336
|
* Get Affiliate User Info.
|
|
1230
1337
|
*
|
|
@@ -1235,9 +1342,7 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1235
1342
|
* The api key can only have "Affiliate" permission
|
|
1236
1343
|
* The transaction volume and deposit amount are the total amount of the user done on Bybit, and have nothing to do with commission settlement. Any transaction volume data related to commission settlement is subject to the Affiliate Portal.
|
|
1237
1344
|
*/
|
|
1238
|
-
getAffiliateUserInfo(params:
|
|
1239
|
-
uid: string;
|
|
1240
|
-
}): Promise<APIResponseV3WithTime<AffiliateUserInfoV5>>;
|
|
1345
|
+
getAffiliateUserInfo(params: GetAffiliateUserInfoParamsV5): Promise<APIResponseV3WithTime<AffiliateUserInfoV5>>;
|
|
1241
1346
|
/**
|
|
1242
1347
|
* Get Friend Referrals
|
|
1243
1348
|
* Query the friend's invitee data.
|
|
@@ -1250,8 +1355,9 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1250
1355
|
}>>;
|
|
1251
1356
|
/**
|
|
1252
1357
|
* Sign Agreement
|
|
1253
|
-
* To trade
|
|
1358
|
+
* To trade commodity contracts (e.g. metals XAU/XAG perps, crude oil perps), complete the agreement signing first.
|
|
1254
1359
|
* Recommended to sign in advance via API so you can trade immediately when contracts go live.
|
|
1360
|
+
* Send either `category` (legacy) or `categoryV2` (preferred; new agreement types are added to `categoryV2` only).
|
|
1255
1361
|
*
|
|
1256
1362
|
* INFO
|
|
1257
1363
|
* - Only the master account can sign. Subaccounts are not supported.
|
|
@@ -1260,6 +1366,64 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1260
1366
|
* - Trading without signing returns code=110123, msg=You must agree to the Trading Terms.
|
|
1261
1367
|
*/
|
|
1262
1368
|
signAgreement(params: SignAgreementParamsV5): Promise<APIResponseV3WithTime<{}>>;
|
|
1369
|
+
/**
|
|
1370
|
+
*
|
|
1371
|
+
****** Alpha / Web3 (on-chain) trade APIs
|
|
1372
|
+
*
|
|
1373
|
+
*/
|
|
1374
|
+
/**
|
|
1375
|
+
* Get Trade Quote
|
|
1376
|
+
* Get a price quote before a purchase or redeem. Required before `executeAlphaTradePurchase` or `executeAlphaTradeRedeem`.
|
|
1377
|
+
* Pass `quoteData` and `correctingCode` from the response unchanged to the execute endpoints.
|
|
1378
|
+
*/
|
|
1379
|
+
getAlphaTradeQuote(params: GetAlphaTradeQuoteParamsV5): Promise<APIResponseV3WithTime<AlphaTradeQuoteResultV5>>;
|
|
1380
|
+
/**
|
|
1381
|
+
* Execute Purchase
|
|
1382
|
+
* Buy on-chain tokens with a payment token (e.g. USDT). Requires a valid quote; obtain user confirmation first.
|
|
1383
|
+
* HTTP 200 is only an acknowledgment — poll `getAlphaTradeOrderList` for final status. Idempotent by `quoteDataId` in the quote.
|
|
1384
|
+
*/
|
|
1385
|
+
executeAlphaTradePurchase(params: ExecuteAlphaTradeParamsV5): Promise<APIResponseV3WithTime<ExecuteAlphaTradeResultV5>>;
|
|
1386
|
+
/**
|
|
1387
|
+
* Execute Redeem
|
|
1388
|
+
* Sell on-chain tokens for a payment token. Requires a valid quote; obtain user confirmation first.
|
|
1389
|
+
* HTTP 200 is only an acknowledgment — poll `getAlphaTradeOrderList` for final status. Idempotent by `quoteDataId` in the quote.
|
|
1390
|
+
*/
|
|
1391
|
+
executeAlphaTradeRedeem(params: ExecuteAlphaTradeParamsV5): Promise<APIResponseV3WithTime<ExecuteAlphaTradeResultV5>>;
|
|
1392
|
+
/**
|
|
1393
|
+
* Get Payment Token List
|
|
1394
|
+
* List payment tokens (e.g. USDT) and CEX token codes (e.g. CEX_1) for quote and execution. Each entry includes `supportChains`.
|
|
1395
|
+
*/
|
|
1396
|
+
getAlphaPayTokenList(params: GetAlphaPayTokenListParamsV5): Promise<APIResponseV3WithTime<AlphaPayTokenV5[]>>;
|
|
1397
|
+
/**
|
|
1398
|
+
* Get Order List
|
|
1399
|
+
* On-chain trade order history; filters for trade type, status, token, and time. Max 90 days.
|
|
1400
|
+
*/
|
|
1401
|
+
getAlphaTradeOrderList(params: GetAlphaTradeOrderListParamsV5): Promise<APIResponseV3WithTime<AlphaTradeOrderListResultV5>>;
|
|
1402
|
+
/**
|
|
1403
|
+
* Get Biz Token List
|
|
1404
|
+
* Tradable on-chain tokens (DEX_ prefix ids), risk flags, limits, and supported payment token codes.
|
|
1405
|
+
*/
|
|
1406
|
+
getAlphaBizTokenList(params?: GetAlphaBizTokenListParamsV5): Promise<APIResponseV3WithTime<AlphaBizTokenV5[]>>;
|
|
1407
|
+
/**
|
|
1408
|
+
* Get Token Price List
|
|
1409
|
+
* Batch market data (up to 20 `chainCode` + `tokenAddress` pairs). Prices, 24h change, volume, market cap, etc.
|
|
1410
|
+
*/
|
|
1411
|
+
getAlphaBizTokenPriceList(params: GetAlphaBizTokenPriceListParamsV5): Promise<APIResponseV3WithTime<AlphaBizTokenPriceListResultV5>>;
|
|
1412
|
+
/**
|
|
1413
|
+
* Get Token Details
|
|
1414
|
+
* One token: description, links, `riskFlag`, and listing status. Use `chainCode` + `tokenAddress` from biz list or assets.
|
|
1415
|
+
*/
|
|
1416
|
+
getAlphaBizTokenDetails(params: GetAlphaBizTokenDetailsParamsV5): Promise<APIResponseV3WithTime<AlphaBizTokenDetailsV5>>;
|
|
1417
|
+
/**
|
|
1418
|
+
* Get Asset List
|
|
1419
|
+
* Portfolio of on-chain token holdings (non-zero only), sorted by USD value.
|
|
1420
|
+
*/
|
|
1421
|
+
getAlphaAssetList(): Promise<APIResponseV3WithTime<AlphaAssetListResultV5>>;
|
|
1422
|
+
/**
|
|
1423
|
+
* Get Asset Detail
|
|
1424
|
+
* Single-asset view; `result.assetList` has 0 or 1 item.
|
|
1425
|
+
*/
|
|
1426
|
+
getAlphaAssetDetail(params: GetAlphaAssetDetailParamsV5): Promise<APIResponseV3WithTime<AlphaAssetDetailResultV5>>;
|
|
1263
1427
|
/**
|
|
1264
1428
|
*
|
|
1265
1429
|
****** Spot Margin Trade APIs (UTA)
|
|
@@ -1292,6 +1456,13 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1292
1456
|
vipLevel: string;
|
|
1293
1457
|
}[];
|
|
1294
1458
|
}>>;
|
|
1459
|
+
/**
|
|
1460
|
+
* Get Currency Data
|
|
1461
|
+
* Borrowing currency data: flexible/fixed manual borrow, min qty, precision, interest rate range.
|
|
1462
|
+
*/
|
|
1463
|
+
getSpotMarginCurrencyData(params?: GetSpotMarginCurrencyDataParamsV5): Promise<APIResponseV3WithTime<{
|
|
1464
|
+
list: SpotMarginCurrencyDataV5[];
|
|
1465
|
+
}>>;
|
|
1295
1466
|
/**
|
|
1296
1467
|
* Turn spot margin trade on / off in your UTA account.
|
|
1297
1468
|
*
|
|
@@ -1345,6 +1516,10 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1345
1516
|
*
|
|
1346
1517
|
* IMPORTANT: Repayment is prohibited between 04:00 and 05:30 per hour.
|
|
1347
1518
|
* When repaying, system will only use the spot available balance of the debt currency.
|
|
1519
|
+
*
|
|
1520
|
+
* Use `getAvailableAmountToRepay` to check spot available amount. Response timing: ALL and FIXED
|
|
1521
|
+
* asynchronous; FLEXIBLE synchronous. From 2026-03-17 (full 2026-03-24), BYUSDT can be used for
|
|
1522
|
+
* repayment, including MNT using existing spot balance.
|
|
1348
1523
|
*/
|
|
1349
1524
|
manualRepayWithoutConversion(params: ManualRepayWithoutConversionParamsV5): Promise<APIResponseV3WithTime<ManualRepayWithoutConversionResultV5>>;
|
|
1350
1525
|
/**
|
|
@@ -1366,6 +1541,38 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1366
1541
|
* - The amount of repayments is the minimum of available spot balance and liability
|
|
1367
1542
|
*/
|
|
1368
1543
|
setAutoRepayMode(params: SetAutoRepayModeParamsV5): Promise<APIResponseV3WithTime<AutoRepayModeResultV5>>;
|
|
1544
|
+
/**
|
|
1545
|
+
* Get Liability Info (spot margin UTA): fixed vs floating, spot vs derivatives borrow split.
|
|
1546
|
+
*/
|
|
1547
|
+
getSpotMarginLiability(params: GetSpotMarginLiabilityInfoParamsV5): Promise<APIResponseV3WithTime<SpotMarginLiabilityInfoV5>>;
|
|
1548
|
+
/**
|
|
1549
|
+
* Fixed-rate borrow (place order).
|
|
1550
|
+
*/
|
|
1551
|
+
submitFixedRateBorrow(params: FixedRateBorrowParamsV5): Promise<APIResponseV3WithTime<FixedRateBorrowResultV5>>;
|
|
1552
|
+
/**
|
|
1553
|
+
* Fixed-rate borrow order history (descending by order time).
|
|
1554
|
+
*/
|
|
1555
|
+
getFixedRateBorrowOrderInfo(params?: GetFixedRateBorrowOrderInfoParamsV5): Promise<APIResponseV3WithTime<{
|
|
1556
|
+
list: FixedRateBorrowOrderInfoV5[];
|
|
1557
|
+
nextPageCursor: string;
|
|
1558
|
+
}>>;
|
|
1559
|
+
/**
|
|
1560
|
+
* Fixed-rate borrow contract list (descending by borrow time).
|
|
1561
|
+
*/
|
|
1562
|
+
getFixedRateBorrowContractInfo(params?: GetFixedRateBorrowContractInfoParamsV5): Promise<APIResponseV3WithTime<{
|
|
1563
|
+
list: FixedRateBorrowContractInfoV5[];
|
|
1564
|
+
nextPageCursor: string;
|
|
1565
|
+
}>>;
|
|
1566
|
+
/**
|
|
1567
|
+
* Fixed-rate borrow order book quotes (sort by apy, term, or quantity).
|
|
1568
|
+
*/
|
|
1569
|
+
getFixedRateBorrowOrderQuote(params: GetFixedRateBorrowOrderQuoteParamsV5): Promise<APIResponseV3WithTime<{
|
|
1570
|
+
list: FixedRateBorrowQuoteV5[];
|
|
1571
|
+
}>>;
|
|
1572
|
+
/**
|
|
1573
|
+
* Renew a fixed-rate loan contract (full remaining amount if `qty` omitted).
|
|
1574
|
+
*/
|
|
1575
|
+
renewFixedRateBorrow(params: RenewFixedRateBorrowParamsV5): Promise<APIResponseV3WithTime<string>>;
|
|
1369
1576
|
/**
|
|
1370
1577
|
*
|
|
1371
1578
|
****** Spot Margin Trade APIs (Normal)
|
|
@@ -1789,6 +1996,8 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1789
1996
|
* Create Supply Order
|
|
1790
1997
|
*
|
|
1791
1998
|
* Permission: "Spot trade"
|
|
1999
|
+
*
|
|
2000
|
+
* Optional `availableSource`: 0 Funding, 1 Earn Flexible, 2 ALL (default 0).
|
|
1792
2001
|
*/
|
|
1793
2002
|
createSupplyOrderFixed(params: CreateSupplyOrderFixedParamsV5): Promise<APIResponseV3WithTime<CreateSupplyOrderFixedV5>>;
|
|
1794
2003
|
/**
|
|
@@ -1798,6 +2007,8 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1798
2007
|
cancelBorrowOrderFixed(params: CancelBorrowOrderFixedParamsV5): Promise<APIResponseV3WithTime<{}>>;
|
|
1799
2008
|
/**
|
|
1800
2009
|
* Cancel Supply Order
|
|
2010
|
+
*
|
|
2011
|
+
* Optional `refundedAccount`: 0 Funding, 1 EasyEarn (default 0).
|
|
1801
2012
|
*/
|
|
1802
2013
|
cancelSupplyOrderFixed(params: CancelSupplyOrderFixedParamsV5): Promise<APIResponseV3WithTime<{}>>;
|
|
1803
2014
|
/**
|
|
@@ -2069,6 +2280,85 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
2069
2280
|
}): Promise<APIResponseV3WithTime<{
|
|
2070
2281
|
list: EarnProductV5[];
|
|
2071
2282
|
}>>;
|
|
2283
|
+
/**
|
|
2284
|
+
* Get Hold to Earn airdrop products (ByFi).
|
|
2285
|
+
*
|
|
2286
|
+
* No authentication required; guest access supported. Authenticated users get eligibility-filtered products.
|
|
2287
|
+
*/
|
|
2288
|
+
getHoldToEarnAirdropProducts(): Promise<APIResponseV3WithTime<HoldToEarnAirdropProductsResultV5>>;
|
|
2289
|
+
/**
|
|
2290
|
+
* Get Advanced Earn product info (Dual Asset, Double Win, Smart Leverage, etc. via `category`).
|
|
2291
|
+
*
|
|
2292
|
+
* INFO: No authentication. Up to 50 requests/second per IP.
|
|
2293
|
+
*/
|
|
2294
|
+
getAdvanceEarnProduct(params: GetAdvanceEarnProductParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnAdvanceProductInfoV5>>;
|
|
2295
|
+
/**
|
|
2296
|
+
* Liquidity mining — product list (Advanced Earn).
|
|
2297
|
+
*
|
|
2298
|
+
* INFO: No authentication. Up to 50 requests/second per IP.
|
|
2299
|
+
*/
|
|
2300
|
+
getLiquidityMiningProduct(params?: GetLiquidityMiningProductParamsV5): Promise<APIResponseV3WithTime<LiquidityMiningProductResultV5>>;
|
|
2301
|
+
/**
|
|
2302
|
+
* Fixed-term / fixed saving — product list (Earn).
|
|
2303
|
+
*
|
|
2304
|
+
* INFO: No authentication. Up to 50 requests/second per IP.
|
|
2305
|
+
*/
|
|
2306
|
+
getFixedTermEarnProduct(params?: GetFixedTermEarnProductParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnProductListV5>>;
|
|
2307
|
+
/**
|
|
2308
|
+
* Advanced Earn — quote / extra info (Discount Buy, Dual Assets, …). Call before place order where required.
|
|
2309
|
+
*
|
|
2310
|
+
* INFO: No authentication. Up to 50 requests/second per IP.
|
|
2311
|
+
* Dual Assets: `productId` is required. Response uses `list` with `buyLowPrice` / `sellHighPrice`.
|
|
2312
|
+
*/
|
|
2313
|
+
getAdvanceEarnProductExtraInfo(params: GetAdvanceEarnProductExtraInfoParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnProductExtraInfoV5>>;
|
|
2314
|
+
/**
|
|
2315
|
+
* Advanced Earn — place order (Dual Assets, Discount Buy, …). Async; use getAdvanceEarnOrder to track.
|
|
2316
|
+
*
|
|
2317
|
+
* INFO: API key needs "Earn" permission. Rate limit e.g. 5 req/s (Dual Assets per docs).
|
|
2318
|
+
*/
|
|
2319
|
+
submitAdvanceEarnPlaceOrder(params: SubmitAdvanceEarnPlaceOrderParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnPlaceOrderResultV5>>;
|
|
2320
|
+
/**
|
|
2321
|
+
* Advanced Earn — active positions (Dual Assets, Discount Buy, …).
|
|
2322
|
+
*
|
|
2323
|
+
* INFO: API key needs "Earn" permission. E.g. 10 req/s (Dual Assets per docs).
|
|
2324
|
+
*/
|
|
2325
|
+
getAdvanceEarnPosition(params: GetAdvanceEarnPositionListParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnPositionListV5>>;
|
|
2326
|
+
/**
|
|
2327
|
+
* Advanced Earn — order list (Dual Assets, Discount Buy, …). Distinct from getEarnOrderHistory (/v5/earn/order).
|
|
2328
|
+
*
|
|
2329
|
+
* INFO: API key needs "Earn" permission. E.g. 10 req/s (Dual Assets per docs).
|
|
2330
|
+
*/
|
|
2331
|
+
getAdvanceEarnOrder(params: GetAdvanceEarnOrderListParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnOrderListV5>>;
|
|
2332
|
+
/**
|
|
2333
|
+
* Fixed-term earn — place order (stake). Async; use getFixedTermEarnOrder to track.
|
|
2334
|
+
*
|
|
2335
|
+
* INFO: API key needs "Earn" permission. Rate limit: 5 req/s.
|
|
2336
|
+
*/
|
|
2337
|
+
submitFixedTermEarnOrder(params: SubmitFixedTermEarnOrderParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnPlaceOrderResultV5>>;
|
|
2338
|
+
/**
|
|
2339
|
+
* Fixed-term earn — early redeem (FundPool only, when product allows).
|
|
2340
|
+
*
|
|
2341
|
+
* INFO: API key needs "Earn" permission. Rate limit: 5 req/s.
|
|
2342
|
+
*/
|
|
2343
|
+
redeemFixedTermEarn(params: RedeemFixedTermEarnParamsV5): Promise<APIResponseV3WithTime<RedeemFixedTermEarnResultV5>>;
|
|
2344
|
+
/**
|
|
2345
|
+
* Fixed-term earn — active positions.
|
|
2346
|
+
*
|
|
2347
|
+
* INFO: API key needs "Earn" permission. Rate limit: 10 req/s.
|
|
2348
|
+
*/
|
|
2349
|
+
getFixedTermEarnPosition(params?: GetFixedTermEarnPositionParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnPositionListV5>>;
|
|
2350
|
+
/**
|
|
2351
|
+
* Fixed-term earn — order list.
|
|
2352
|
+
*
|
|
2353
|
+
* INFO: API key needs "Earn" permission. Rate limit: 10 req/s.
|
|
2354
|
+
*/
|
|
2355
|
+
getFixedTermEarnOrder(params?: GetFixedTermEarnOrderListParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnOrderListV5>>;
|
|
2356
|
+
/**
|
|
2357
|
+
* Fixed-term earn — enable or disable auto-invest on a position.
|
|
2358
|
+
*
|
|
2359
|
+
* INFO: API key needs "Earn" permission. Rate limit: 5 req/s.
|
|
2360
|
+
*/
|
|
2361
|
+
setFixedTermEarnAutoInvest(params: SetFixedTermEarnAutoInvestParamsV5): Promise<APIResponseV3WithTime<Record<string, never>>>;
|
|
2072
2362
|
/**
|
|
2073
2363
|
* Stake or Redeem Earn products
|
|
2074
2364
|
*
|
|
@@ -2103,19 +2393,35 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
2103
2393
|
* INFO: API key needs "Earn" permission
|
|
2104
2394
|
*
|
|
2105
2395
|
* Note: Fully redeemed position is also returned in the response
|
|
2396
|
+
* Note: Response includes `autoReinvest` where applicable; use `modifyEarnPosition` to change it (OnChain fixed).
|
|
2397
|
+
* List items include `availableAmount` (redeemable) and `freezeDetails` (frozen amount + reason).
|
|
2106
2398
|
*/
|
|
2107
2399
|
getEarnPosition(params: GetEarnPositionParamsV5): Promise<APIResponseV3WithTime<{
|
|
2108
2400
|
list: EarnPositionV5[];
|
|
2109
2401
|
}>>;
|
|
2402
|
+
/**
|
|
2403
|
+
* Modify OnChain Earn position (e.g. auto-reinvest for fixed duration products).
|
|
2404
|
+
*
|
|
2405
|
+
* INFO: API key needs "Earn" permission. Only `category=OnChain` and fixed positions (see product).
|
|
2406
|
+
*/
|
|
2407
|
+
modifyEarnPosition(params: ModifyEarnPositionParamsV5): Promise<APIResponseV3WithTime<Record<string, never>>>;
|
|
2110
2408
|
/**
|
|
2111
2409
|
* Get Yield History
|
|
2112
2410
|
*
|
|
2113
2411
|
* INFO: API key needs "Earn" permission
|
|
2412
|
+
*
|
|
2413
|
+
* Note: `category` includes `OnChain`. For `OnChain`, do not pass `productId` (error).
|
|
2114
2414
|
*/
|
|
2115
2415
|
getEarnYieldHistory(params: GetEarnYieldHistoryParamsV5): Promise<APIResponseV3WithTime<{
|
|
2116
2416
|
yield: EarnYieldHistoryV5[];
|
|
2117
2417
|
nextPageCursor: string;
|
|
2118
2418
|
}>>;
|
|
2419
|
+
/**
|
|
2420
|
+
* Get Hold to Earn airdrop daily PnL records (ByFi). Up to 3 months of completed yield history.
|
|
2421
|
+
*
|
|
2422
|
+
* INFO: API key needs "Earn" permission
|
|
2423
|
+
*/
|
|
2424
|
+
getHoldToEarnAirdropYieldHistory(params: GetHoldToEarnAirdropYieldHistoryParamsV5): Promise<APIResponseV3WithTime<HoldToEarnAirdropYieldHistoryResultV5>>;
|
|
2119
2425
|
/**
|
|
2120
2426
|
* Get Hourly Yield History
|
|
2121
2427
|
*
|
|
@@ -2125,6 +2431,185 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
2125
2431
|
list: EarnHourlyYieldHistoryV5[];
|
|
2126
2432
|
nextPageCursor: string;
|
|
2127
2433
|
}>>;
|
|
2434
|
+
/**
|
|
2435
|
+
* Get historical APR (FlexibleSaving / OnChain), up to ~6 months.
|
|
2436
|
+
*
|
|
2437
|
+
* INFO: Does not need authentication
|
|
2438
|
+
*/
|
|
2439
|
+
getEarnAprHistory(params: GetEarnAprHistoryParamsV5): Promise<APIResponseV3WithTime<{
|
|
2440
|
+
list: EarnAprHistoryPointV5[];
|
|
2441
|
+
}>>;
|
|
2442
|
+
/**
|
|
2443
|
+
* Earn token product (e.g. BYUSDT) — Get Product Info
|
|
2444
|
+
* Without auth, user-specific fields are empty or defaulted.
|
|
2445
|
+
*/
|
|
2446
|
+
getEarnTokenProduct(params: GetEarnTokenProductParamsV5): Promise<APIResponseV3WithTime<EarnTokenProductV5>>;
|
|
2447
|
+
/**
|
|
2448
|
+
* Earn token — Place Order (Mint / Redeem). Accepted response is not final settlement; use `getEarnTokenOrders`.
|
|
2449
|
+
*/
|
|
2450
|
+
submitEarnTokenOrder(params: PlaceEarnTokenOrderParamsV5): Promise<APIResponseV3WithTime<PlaceEarnTokenOrderResultV5>>;
|
|
2451
|
+
/**
|
|
2452
|
+
* Earn token — Get Order List
|
|
2453
|
+
*/
|
|
2454
|
+
getEarnTokenOrders(params: GetEarnTokenOrderListParamsV5): Promise<APIResponseV3WithTime<{
|
|
2455
|
+
list: EarnTokenOrderV5[];
|
|
2456
|
+
nextPageCursor: string;
|
|
2457
|
+
}>>;
|
|
2458
|
+
/**
|
|
2459
|
+
* Earn token — Get Position Info
|
|
2460
|
+
*/
|
|
2461
|
+
getEarnTokenPosition(params: GetEarnTokenPositionParamsV5): Promise<APIResponseV3WithTime<EarnTokenPositionV5>>;
|
|
2462
|
+
/**
|
|
2463
|
+
* Earn token — Get Daily Yield Records
|
|
2464
|
+
*/
|
|
2465
|
+
getEarnTokenDailyYield(params: GetEarnTokenDailyYieldParamsV5): Promise<APIResponseV3WithTime<{
|
|
2466
|
+
list: EarnTokenDailyYieldRecordV5[];
|
|
2467
|
+
nextPageCursor: string;
|
|
2468
|
+
}>>;
|
|
2469
|
+
/**
|
|
2470
|
+
* Earn token — Get Hourly Yield Records
|
|
2471
|
+
*/
|
|
2472
|
+
getEarnTokenHourlyYield(params: GetEarnTokenHourlyYieldParamsV5): Promise<APIResponseV3WithTime<{
|
|
2473
|
+
list: EarnTokenHourlyYieldRecordV5[];
|
|
2474
|
+
nextPageCursor: string;
|
|
2475
|
+
}>>;
|
|
2476
|
+
/**
|
|
2477
|
+
* Earn token — Get History APR (7/30/180 days). No authentication required.
|
|
2478
|
+
*/
|
|
2479
|
+
getEarnTokenHistoryApr(params: GetEarnTokenHistoryAprParamsV5): Promise<APIResponseV3WithTime<{
|
|
2480
|
+
list: EarnTokenHistoryAprPointV5[];
|
|
2481
|
+
}>>;
|
|
2482
|
+
/**
|
|
2483
|
+
*
|
|
2484
|
+
****** PWM (Private Wealth Management) — Investment Plan
|
|
2485
|
+
*
|
|
2486
|
+
*/
|
|
2487
|
+
/**
|
|
2488
|
+
* Get all PWM investment plans.
|
|
2489
|
+
*/
|
|
2490
|
+
getPwmInvestmentPlanList(): Promise<APIResponseV3WithTime<PwmInvestmentPlanListResultV5>>;
|
|
2491
|
+
/**
|
|
2492
|
+
* Get PWM investment plan detail (Active or Closed).
|
|
2493
|
+
*/
|
|
2494
|
+
getPwmInvestmentPlanDetail(params: GetPwmInvestmentPlanDetailParamsV5): Promise<APIResponseV3WithTime<PwmInvestmentPlanDetailV5>>;
|
|
2495
|
+
/**
|
|
2496
|
+
* Get pending PWM investment plan detail (PendingSubscription).
|
|
2497
|
+
*/
|
|
2498
|
+
getPwmPendingInvestmentPlanDetail(params: GetPwmPendingInvestmentPlanDetailParamsV5): Promise<APIResponseV3WithTime<PwmPendingInvestmentPlanDetailV5>>;
|
|
2499
|
+
/**
|
|
2500
|
+
* Claim withdrawable funds from a PWM investment plan (Active).
|
|
2501
|
+
*/
|
|
2502
|
+
claimPwmWithdrawableFunds(params: ClaimPwmWithdrawableFundsParamsV5): Promise<APIResponseV3WithTime<ClaimPwmWithdrawableFundsResultV5>>;
|
|
2503
|
+
/**
|
|
2504
|
+
* Get PWM investment plan asset trend (default last 7 days).
|
|
2505
|
+
*/
|
|
2506
|
+
getPwmInvestmentPlanAssetTrend(params: GetPwmInvestmentPlanAssetTrendParamsV5): Promise<APIResponseV3WithTime<PwmInvestmentPlanAssetTrendResultV5>>;
|
|
2507
|
+
/**
|
|
2508
|
+
* Get PWM fund historical NAV (max 180 days between startTime and endTime).
|
|
2509
|
+
*/
|
|
2510
|
+
getPwmFundHistoricalNav(params: GetPwmFundHistoricalNavParamsV5): Promise<APIResponseV3WithTime<PwmFundHistoricalNavResultV5>>;
|
|
2511
|
+
/**
|
|
2512
|
+
* Subscribe to a PWM investment plan (PendingSubscription).
|
|
2513
|
+
*/
|
|
2514
|
+
subscribePwmInvestmentPlan(params: SubscribePwmInvestmentPlanParamsV5): Promise<APIResponseV3WithTime<SubscribePwmInvestmentPlanResultV5>>;
|
|
2515
|
+
/**
|
|
2516
|
+
* Invest more into a PWM investment plan product (Active).
|
|
2517
|
+
*/
|
|
2518
|
+
investMorePwmInvestmentPlan(params: InvestMorePwmInvestmentPlanParamsV5): Promise<APIResponseV3WithTime<InvestMorePwmInvestmentPlanResultV5>>;
|
|
2519
|
+
/**
|
|
2520
|
+
* Redeem from a PWM investment plan product.
|
|
2521
|
+
*/
|
|
2522
|
+
redeemPwmInvestmentPlan(params: RedeemPwmInvestmentPlanParamsV5): Promise<APIResponseV3WithTime<RedeemPwmInvestmentPlanResultV5>>;
|
|
2523
|
+
/**
|
|
2524
|
+
* Get PWM investment plan orders (subscribe / redeem / auto-reinvest).
|
|
2525
|
+
*/
|
|
2526
|
+
getPwmInvestmentPlanOrders(params?: GetPwmInvestmentPlanOrdersParamsV5): Promise<APIResponseV3WithTime<PwmInvestmentPlanOrdersResultV5>>;
|
|
2527
|
+
/**
|
|
2528
|
+
* Get PWM subscribable product info for customize plan. No authentication required.
|
|
2529
|
+
*/
|
|
2530
|
+
getPwmSubscribableProductInfo(): Promise<APIResponseV3WithTime<PwmSubscribableProductInfoResultV5>>;
|
|
2531
|
+
/**
|
|
2532
|
+
* Create a customized PWM investment plan (max 20 Active + Pending plans per user).
|
|
2533
|
+
*/
|
|
2534
|
+
createPwmCustomizeInvestmentPlan(params: CreatePwmCustomizeInvestmentPlanParamsV5): Promise<APIResponseV3WithTime<CreatePwmCustomizeInvestmentPlanResultV5>>;
|
|
2535
|
+
/**
|
|
2536
|
+
*
|
|
2537
|
+
****** PWM — Asset Manager
|
|
2538
|
+
*
|
|
2539
|
+
*/
|
|
2540
|
+
/**
|
|
2541
|
+
* Get all PWM funds managed by the institution (newest first).
|
|
2542
|
+
*/
|
|
2543
|
+
getPwmAllFunds(params?: GetPwmAllFundsParamsV5): Promise<APIResponseV3WithTime<PwmAllFundsResultV5>>;
|
|
2544
|
+
/**
|
|
2545
|
+
* Settle fund profit sharing (Active funds only).
|
|
2546
|
+
*/
|
|
2547
|
+
settlePwmFundProfit(params: SettlePwmFundProfitParamsV5): Promise<APIResponseV3WithTime<SettlePwmFundProfitResultV5>>;
|
|
2548
|
+
/**
|
|
2549
|
+
* Create a PWM fund (PendingSubscribe). Max 10 funds per institution.
|
|
2550
|
+
*/
|
|
2551
|
+
createPwmFund(params: CreatePwmFundParamsV5): Promise<APIResponseV3WithTime<CreatePwmFundResultV5>>;
|
|
2552
|
+
/**
|
|
2553
|
+
* Create a PWM investment plan for a user (PendingSubscription). Max 10 plans per institution.
|
|
2554
|
+
*/
|
|
2555
|
+
createPwmAssetManagerInvestmentPlan(params: CreatePwmAssetManagerInvestmentPlanParamsV5): Promise<APIResponseV3WithTime<CreatePwmAssetManagerInvestmentPlanResultV5>>;
|
|
2556
|
+
/**
|
|
2557
|
+
* Get PWM investment plans created by the institution (asset manager).
|
|
2558
|
+
*/
|
|
2559
|
+
getPwmAssetManagerInvestmentPlans(params?: GetPwmAssetManagerInvestmentPlansParamsV5): Promise<APIResponseV3WithTime<PwmAssetManagerInvestmentPlansResultV5>>;
|
|
2560
|
+
/**
|
|
2561
|
+
* Manage a PWM investment plan (status and/or fund allocation).
|
|
2562
|
+
*/
|
|
2563
|
+
managePwmAssetManagerInvestmentPlan(params: ManagePwmAssetManagerInvestmentPlanParamsV5): Promise<APIResponseV3WithTime<ManagePwmAssetManagerInvestmentPlanResultV5>>;
|
|
2564
|
+
/**
|
|
2565
|
+
* Get all PWM fund orders (asset manager). Default time window: last 7 days.
|
|
2566
|
+
*/
|
|
2567
|
+
getPwmAllFundOrders(params?: GetPwmAllFundOrdersParamsV5): Promise<APIResponseV3WithTime<PwmAllFundOrdersResultV5>>;
|
|
2568
|
+
/**
|
|
2569
|
+
* Manage a PWM fund order (approve / reject Pending Review orders).
|
|
2570
|
+
*/
|
|
2571
|
+
managePwmFundOrder(params: ManagePwmFundOrderParamsV5): Promise<APIResponseV3WithTime<ManagePwmFundOrderResultV5>>;
|
|
2572
|
+
/**
|
|
2573
|
+
* Create a PWM fund sub-account (async; max 30 per fund, fund must be Active).
|
|
2574
|
+
*/
|
|
2575
|
+
createPwmFundSubAccount(params: CreatePwmFundSubAccountParamsV5): Promise<APIResponseV3WithTime<CreatePwmFundSubAccountResultV5>>;
|
|
2576
|
+
/**
|
|
2577
|
+
* Transfer funds between custodian sub-accounts (fund custodian API key required).
|
|
2578
|
+
*/
|
|
2579
|
+
pwmFundTransfer(params: PwmFundTransferParamsV5): Promise<APIResponseV3WithTime<PwmFundTransferResultV5>>;
|
|
2580
|
+
/**
|
|
2581
|
+
* Query PWM fund transfer result (fund custodian API key required).
|
|
2582
|
+
*/
|
|
2583
|
+
getPwmFundTransferRecords(params?: GetPwmFundTransferRecordsParamsV5): Promise<APIResponseV3WithTime<PwmFundTransferRecordV5>>;
|
|
2584
|
+
/**
|
|
2585
|
+
*
|
|
2586
|
+
****** Bybit Card APIs
|
|
2587
|
+
*
|
|
2588
|
+
*/
|
|
2589
|
+
/**
|
|
2590
|
+
* Bybit Card — query card transaction / asset history (filter by status, card digits, merchant, time, type, …).
|
|
2591
|
+
*/
|
|
2592
|
+
queryCardAssetRecords(params?: QueryCardAssetRecordsParamsV5): Promise<APIResponseV3WithTime<CardAssetRecordsResultV5>>;
|
|
2593
|
+
/**
|
|
2594
|
+
* Bybit Card — point balance (available, pending, account status, …).
|
|
2595
|
+
*/
|
|
2596
|
+
queryCardPointsBalance(): Promise<APIResponseV3WithTime<CardPointBalanceV5>>;
|
|
2597
|
+
/**
|
|
2598
|
+
* Bybit Card — point transaction records.
|
|
2599
|
+
*/
|
|
2600
|
+
queryCardPointsRecords(params?: QueryCardPointRecordsParamsV5): Promise<APIResponseV3WithTime<CardPointRecordsResultV5>>;
|
|
2601
|
+
/**
|
|
2602
|
+
* Bybit Card — reward tier, spending limit, auto cashback.
|
|
2603
|
+
*/
|
|
2604
|
+
queryCardPointsTier(): Promise<APIResponseV3WithTime<CardPointTierInfoV5>>;
|
|
2605
|
+
/**
|
|
2606
|
+
* Bybit Card — reward mall item list.
|
|
2607
|
+
*/
|
|
2608
|
+
queryCardMallItemList(params?: QueryCardMallItemListParamsV5): Promise<APIResponseV3WithTime<CardMallItemListResultV5>>;
|
|
2609
|
+
/**
|
|
2610
|
+
* Bybit Card — cashback detail for a reward order.
|
|
2611
|
+
*/
|
|
2612
|
+
queryCardPointCashbackDetail(params: QueryCardPointCashbackDetailParamsV5): Promise<APIResponseV3WithTime<CardPointCashbackDetailV5>>;
|
|
2128
2613
|
/**
|
|
2129
2614
|
*
|
|
2130
2615
|
****** RFQ APIs
|