bybit-api 4.6.2 → 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/rest-client-v5.d.ts +167 -6
- package/lib/rest-client-v5.js +225 -2
- package/lib/rest-client-v5.js.map +1 -1
- package/lib/types/request/index.d.ts +2 -0
- package/lib/types/request/index.js +2 -0
- package/lib/types/request/index.js.map +1 -1
- package/lib/types/request/v5-account.d.ts +3 -5
- package/lib/types/request/v5-crypto-loan.d.ts +8 -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.d.ts +11 -0
- package/lib/types/request/v5-market.d.ts +3 -5
- 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 +22 -0
- package/lib/types/response/index.d.ts +2 -0
- package/lib/types/response/index.js +2 -0
- package/lib/types/response/index.js.map +1 -1
- package/lib/types/response/v5-asset.d.ts +3 -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.d.ts +38 -0
- package/lib/types/response/v5-market.d.ts +11 -13
- package/lib/types/response/v5-position.d.ts +2 -4
- 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 +19 -5
- package/lib/types/shared-v5.d.ts +11 -2
- package/lib/types/websockets/ws-events.d.ts +2 -4
- package/llms.txt +8587 -5935
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -61,6 +61,7 @@ Professional Node.js, JavaScript & TypeScript SDK for the Bybit REST APIs, WebSo
|
|
|
61
61
|
- See example for more details: [examples/ws-api-raw-events.ts](./examples/ws-api-raw-events.ts)
|
|
62
62
|
- Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
|
|
63
63
|
- QuickStart Guide: https://siebly.io/sdk/bybit/javascript
|
|
64
|
+
- Bybit JavaScript Tutorial: [Bybit JavaScript REST API & WebSocket Tutorial](https://siebly.io/sdk/bybit/javascript/tutorial)
|
|
64
65
|
|
|
65
66
|
# Table of Contents
|
|
66
67
|
|
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, 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';
|
|
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
|
|
@@ -422,6 +422,35 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
422
422
|
* Conditional order is not supported.
|
|
423
423
|
*/
|
|
424
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>>;
|
|
425
454
|
/**
|
|
426
455
|
*
|
|
427
456
|
****** Position APIs
|
|
@@ -437,6 +466,8 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
437
466
|
* Normal account covers: USDT perpetual / Inverse perpetual / Inverse futures
|
|
438
467
|
*
|
|
439
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`).
|
|
440
471
|
*/
|
|
441
472
|
getPositionInfo(params: PositionInfoParamsV5): Promise<APIResponseV3WithTime<CategoryCursorListV5<PositionV5[]>>>;
|
|
442
473
|
/**
|
|
@@ -895,6 +926,9 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
895
926
|
}>>;
|
|
896
927
|
/**
|
|
897
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.
|
|
898
932
|
*/
|
|
899
933
|
getCoinInfo(coin?: string): Promise<APIResponseV3WithTime<{
|
|
900
934
|
rows: CoinInfoV5[];
|
|
@@ -1204,7 +1238,7 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1204
1238
|
*
|
|
1205
1239
|
* TIP: Any permission can access this endpoint.
|
|
1206
1240
|
*
|
|
1207
|
-
* Response `permissions` may include `FiatBitPay
|
|
1241
|
+
* Response `permissions` may include `FiatBitPay` (not `FiatBybitPay`).
|
|
1208
1242
|
*/
|
|
1209
1243
|
getQueryApiKey(): Promise<APIResponseV3WithTime<ApiKeyInfoV5>>;
|
|
1210
1244
|
/**
|
|
@@ -1228,7 +1262,7 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1228
1262
|
* TIP: The API key must have one of the permissions to be allowed to call the following API endpoint.
|
|
1229
1263
|
* - master API key: "Account Transfer", "Subaccount Transfer", "Withdrawal"
|
|
1230
1264
|
*
|
|
1231
|
-
* `permissions` may include `FiatBitPay
|
|
1265
|
+
* `permissions` may include `FiatBitPay` (not `FiatBybitPay`).
|
|
1232
1266
|
*/
|
|
1233
1267
|
updateMasterApiKey(params: UpdateApiKeyParamsV5): Promise<APIResponseV3WithTime<UpdateApiKeyResultV5>>;
|
|
1234
1268
|
/**
|
|
@@ -1288,6 +1322,16 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1288
1322
|
list: AffiliateUserListItemV5[];
|
|
1289
1323
|
nextPageCursor: string;
|
|
1290
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>>;
|
|
1291
1335
|
/**
|
|
1292
1336
|
* Get Affiliate User Info.
|
|
1293
1337
|
*
|
|
@@ -1298,9 +1342,7 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1298
1342
|
* The api key can only have "Affiliate" permission
|
|
1299
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.
|
|
1300
1344
|
*/
|
|
1301
|
-
getAffiliateUserInfo(params:
|
|
1302
|
-
uid: string;
|
|
1303
|
-
}): Promise<APIResponseV3WithTime<AffiliateUserInfoV5>>;
|
|
1345
|
+
getAffiliateUserInfo(params: GetAffiliateUserInfoParamsV5): Promise<APIResponseV3WithTime<AffiliateUserInfoV5>>;
|
|
1304
1346
|
/**
|
|
1305
1347
|
* Get Friend Referrals
|
|
1306
1348
|
* Query the friend's invitee data.
|
|
@@ -1954,6 +1996,8 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1954
1996
|
* Create Supply Order
|
|
1955
1997
|
*
|
|
1956
1998
|
* Permission: "Spot trade"
|
|
1999
|
+
*
|
|
2000
|
+
* Optional `availableSource`: 0 Funding, 1 Earn Flexible, 2 ALL (default 0).
|
|
1957
2001
|
*/
|
|
1958
2002
|
createSupplyOrderFixed(params: CreateSupplyOrderFixedParamsV5): Promise<APIResponseV3WithTime<CreateSupplyOrderFixedV5>>;
|
|
1959
2003
|
/**
|
|
@@ -1963,6 +2007,8 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1963
2007
|
cancelBorrowOrderFixed(params: CancelBorrowOrderFixedParamsV5): Promise<APIResponseV3WithTime<{}>>;
|
|
1964
2008
|
/**
|
|
1965
2009
|
* Cancel Supply Order
|
|
2010
|
+
*
|
|
2011
|
+
* Optional `refundedAccount`: 0 Funding, 1 EasyEarn (default 0).
|
|
1966
2012
|
*/
|
|
1967
2013
|
cancelSupplyOrderFixed(params: CancelSupplyOrderFixedParamsV5): Promise<APIResponseV3WithTime<{}>>;
|
|
1968
2014
|
/**
|
|
@@ -2234,6 +2280,12 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
2234
2280
|
}): Promise<APIResponseV3WithTime<{
|
|
2235
2281
|
list: EarnProductV5[];
|
|
2236
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>>;
|
|
2237
2289
|
/**
|
|
2238
2290
|
* Get Advanced Earn product info (Dual Asset, Double Win, Smart Leverage, etc. via `category`).
|
|
2239
2291
|
*
|
|
@@ -2342,6 +2394,7 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
2342
2394
|
*
|
|
2343
2395
|
* Note: Fully redeemed position is also returned in the response
|
|
2344
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).
|
|
2345
2398
|
*/
|
|
2346
2399
|
getEarnPosition(params: GetEarnPositionParamsV5): Promise<APIResponseV3WithTime<{
|
|
2347
2400
|
list: EarnPositionV5[];
|
|
@@ -2363,6 +2416,12 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
2363
2416
|
yield: EarnYieldHistoryV5[];
|
|
2364
2417
|
nextPageCursor: string;
|
|
2365
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>>;
|
|
2366
2425
|
/**
|
|
2367
2426
|
* Get Hourly Yield History
|
|
2368
2427
|
*
|
|
@@ -2420,6 +2479,108 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
2420
2479
|
getEarnTokenHistoryApr(params: GetEarnTokenHistoryAprParamsV5): Promise<APIResponseV3WithTime<{
|
|
2421
2480
|
list: EarnTokenHistoryAprPointV5[];
|
|
2422
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>>;
|
|
2423
2584
|
/**
|
|
2424
2585
|
*
|
|
2425
2586
|
****** Bybit Card APIs
|
package/lib/rest-client-v5.js
CHANGED
|
@@ -518,6 +518,43 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
518
518
|
preCheckOrder(params) {
|
|
519
519
|
return this.postPrivate('/v5/order/pre-check', params);
|
|
520
520
|
}
|
|
521
|
+
/**
|
|
522
|
+
*
|
|
523
|
+
****** Strategy APIs
|
|
524
|
+
*
|
|
525
|
+
*/
|
|
526
|
+
/**
|
|
527
|
+
* Create Strategy Order
|
|
528
|
+
*
|
|
529
|
+
* Supported strategy types: `twap`, `chaseOrder`, `iceberg`, `pov`.
|
|
530
|
+
*/
|
|
531
|
+
createStrategyOrder(params) {
|
|
532
|
+
return this.postPrivate('/v5/strategy/create', params);
|
|
533
|
+
}
|
|
534
|
+
/**
|
|
535
|
+
* Get Strategy List
|
|
536
|
+
*
|
|
537
|
+
* Query the strategy list. Supports filtering by strategy ID, symbol, status, category, and strategy type.
|
|
538
|
+
*/
|
|
539
|
+
getStrategyList(params) {
|
|
540
|
+
return this.getPrivate('/v5/strategy/list', params);
|
|
541
|
+
}
|
|
542
|
+
/**
|
|
543
|
+
* Get Strategy Order List
|
|
544
|
+
*
|
|
545
|
+
* Query the individual orders generated by a specific strategy.
|
|
546
|
+
*/
|
|
547
|
+
getStrategyOrderList(params) {
|
|
548
|
+
return this.getPrivate('/v5/strategy/order-list', params);
|
|
549
|
+
}
|
|
550
|
+
/**
|
|
551
|
+
* Stop Strategy
|
|
552
|
+
*
|
|
553
|
+
* Stop a running strategy. Once stopped, the strategy cannot be resumed.
|
|
554
|
+
*/
|
|
555
|
+
stopStrategy(params) {
|
|
556
|
+
return this.postPrivate('/v5/strategy/stop', params);
|
|
557
|
+
}
|
|
521
558
|
/**
|
|
522
559
|
*
|
|
523
560
|
****** Position APIs
|
|
@@ -533,6 +570,8 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
533
570
|
* Normal account covers: USDT perpetual / Inverse perpetual / Inverse futures
|
|
534
571
|
*
|
|
535
572
|
* Note: this will give a 404 error if you query the `option` category if your account is not unified
|
|
573
|
+
*
|
|
574
|
+
* Response list items include `openTime` (position open timestamp in ms, default `0`).
|
|
536
575
|
*/
|
|
537
576
|
getPositionInfo(params) {
|
|
538
577
|
return this.getPrivate('/v5/position/list', params);
|
|
@@ -1051,6 +1090,9 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
1051
1090
|
}
|
|
1052
1091
|
/**
|
|
1053
1092
|
* Query coin information, including chain information, withdraw and deposit status.
|
|
1093
|
+
*
|
|
1094
|
+
* Per-chain `withdrawMax` is the max amount per withdrawal on that chain (`-1` = no limit).
|
|
1095
|
+
* `remainAmount` is deprecated.
|
|
1054
1096
|
*/
|
|
1055
1097
|
getCoinInfo(coin) {
|
|
1056
1098
|
return this.getPrivate('/v5/asset/coin/query-info', coin ? { coin } : undefined);
|
|
@@ -1383,7 +1425,7 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
1383
1425
|
*
|
|
1384
1426
|
* TIP: Any permission can access this endpoint.
|
|
1385
1427
|
*
|
|
1386
|
-
* Response `permissions` may include `FiatBitPay
|
|
1428
|
+
* Response `permissions` may include `FiatBitPay` (not `FiatBybitPay`).
|
|
1387
1429
|
*/
|
|
1388
1430
|
getQueryApiKey() {
|
|
1389
1431
|
return this.getPrivate('/v5/user/query-api');
|
|
@@ -1403,7 +1445,7 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
1403
1445
|
* TIP: The API key must have one of the permissions to be allowed to call the following API endpoint.
|
|
1404
1446
|
* - master API key: "Account Transfer", "Subaccount Transfer", "Withdrawal"
|
|
1405
1447
|
*
|
|
1406
|
-
* `permissions` may include `FiatBitPay
|
|
1448
|
+
* `permissions` may include `FiatBitPay` (not `FiatBybitPay`).
|
|
1407
1449
|
*/
|
|
1408
1450
|
updateMasterApiKey(params) {
|
|
1409
1451
|
return this.postPrivate('/v5/user/update-api', params);
|
|
@@ -1470,6 +1512,18 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
1470
1512
|
getAffiliateUserList(params) {
|
|
1471
1513
|
return this.getPrivate('/v5/affiliate/aff-user-list', params);
|
|
1472
1514
|
}
|
|
1515
|
+
/**
|
|
1516
|
+
* Get Affiliate Sub-Affiliate List.
|
|
1517
|
+
*
|
|
1518
|
+
* To use this endpoint, you should have an affiliate account and only tick "affiliate" permission while creating the API key.
|
|
1519
|
+
*
|
|
1520
|
+
* TIP:
|
|
1521
|
+
* - Use master UID only
|
|
1522
|
+
* - The api key can only have "Affiliate" permission
|
|
1523
|
+
*/
|
|
1524
|
+
getAffiliateSubAffiliateList(params) {
|
|
1525
|
+
return this.getPrivate('/v5/affiliate/affiliate-sub-list', params);
|
|
1526
|
+
}
|
|
1473
1527
|
/**
|
|
1474
1528
|
* Get Affiliate User Info.
|
|
1475
1529
|
*
|
|
@@ -2101,6 +2155,8 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
2101
2155
|
* Create Supply Order
|
|
2102
2156
|
*
|
|
2103
2157
|
* Permission: "Spot trade"
|
|
2158
|
+
*
|
|
2159
|
+
* Optional `availableSource`: 0 Funding, 1 Earn Flexible, 2 ALL (default 0).
|
|
2104
2160
|
*/
|
|
2105
2161
|
createSupplyOrderFixed(params) {
|
|
2106
2162
|
return this.postPrivate('/v5/crypto-loan-fixed/supply', params);
|
|
@@ -2114,6 +2170,8 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
2114
2170
|
}
|
|
2115
2171
|
/**
|
|
2116
2172
|
* Cancel Supply Order
|
|
2173
|
+
*
|
|
2174
|
+
* Optional `refundedAccount`: 0 Funding, 1 EasyEarn (default 0).
|
|
2117
2175
|
*/
|
|
2118
2176
|
cancelSupplyOrderFixed(params) {
|
|
2119
2177
|
return this.postPrivate('/v5/crypto-loan-fixed/supply-order-cancel', params);
|
|
@@ -2383,6 +2441,14 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
2383
2441
|
getEarnProduct(params) {
|
|
2384
2442
|
return this.get('/v5/earn/product', params);
|
|
2385
2443
|
}
|
|
2444
|
+
/**
|
|
2445
|
+
* Get Hold to Earn airdrop products (ByFi).
|
|
2446
|
+
*
|
|
2447
|
+
* No authentication required; guest access supported. Authenticated users get eligibility-filtered products.
|
|
2448
|
+
*/
|
|
2449
|
+
getHoldToEarnAirdropProducts() {
|
|
2450
|
+
return this.get('/v5/earn/hold-to-earn/product');
|
|
2451
|
+
}
|
|
2386
2452
|
/**
|
|
2387
2453
|
* Get Advanced Earn product info (Dual Asset, Double Win, Smart Leverage, etc. via `category`).
|
|
2388
2454
|
*
|
|
@@ -2513,6 +2579,7 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
2513
2579
|
*
|
|
2514
2580
|
* Note: Fully redeemed position is also returned in the response
|
|
2515
2581
|
* Note: Response includes `autoReinvest` where applicable; use `modifyEarnPosition` to change it (OnChain fixed).
|
|
2582
|
+
* List items include `availableAmount` (redeemable) and `freezeDetails` (frozen amount + reason).
|
|
2516
2583
|
*/
|
|
2517
2584
|
getEarnPosition(params) {
|
|
2518
2585
|
return this.getPrivate('/v5/earn/position', params);
|
|
@@ -2535,6 +2602,14 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
2535
2602
|
getEarnYieldHistory(params) {
|
|
2536
2603
|
return this.getPrivate('/v5/earn/yield', params);
|
|
2537
2604
|
}
|
|
2605
|
+
/**
|
|
2606
|
+
* Get Hold to Earn airdrop daily PnL records (ByFi). Up to 3 months of completed yield history.
|
|
2607
|
+
*
|
|
2608
|
+
* INFO: API key needs "Earn" permission
|
|
2609
|
+
*/
|
|
2610
|
+
getHoldToEarnAirdropYieldHistory(params) {
|
|
2611
|
+
return this.getPrivate('/v5/earn/hold-to-earn/yield-history', params);
|
|
2612
|
+
}
|
|
2538
2613
|
/**
|
|
2539
2614
|
* Get Hourly Yield History
|
|
2540
2615
|
*
|
|
@@ -2594,6 +2669,154 @@ class RestClientV5 extends BaseRestClient_1.default {
|
|
|
2594
2669
|
getEarnTokenHistoryApr(params) {
|
|
2595
2670
|
return this.get('/v5/earn/token/history-apr', params);
|
|
2596
2671
|
}
|
|
2672
|
+
/**
|
|
2673
|
+
*
|
|
2674
|
+
****** PWM (Private Wealth Management) — Investment Plan
|
|
2675
|
+
*
|
|
2676
|
+
*/
|
|
2677
|
+
/**
|
|
2678
|
+
* Get all PWM investment plans.
|
|
2679
|
+
*/
|
|
2680
|
+
getPwmInvestmentPlanList() {
|
|
2681
|
+
return this.getPrivate('/v5/earn/pwm/investment-plan/list');
|
|
2682
|
+
}
|
|
2683
|
+
/**
|
|
2684
|
+
* Get PWM investment plan detail (Active or Closed).
|
|
2685
|
+
*/
|
|
2686
|
+
getPwmInvestmentPlanDetail(params) {
|
|
2687
|
+
return this.getPrivate('/v5/earn/pwm/investment-plan/detail', params);
|
|
2688
|
+
}
|
|
2689
|
+
/**
|
|
2690
|
+
* Get pending PWM investment plan detail (PendingSubscription).
|
|
2691
|
+
*/
|
|
2692
|
+
getPwmPendingInvestmentPlanDetail(params) {
|
|
2693
|
+
return this.getPrivate('/v5/earn/pwm/investment-plan/new-plan', params);
|
|
2694
|
+
}
|
|
2695
|
+
/**
|
|
2696
|
+
* Claim withdrawable funds from a PWM investment plan (Active).
|
|
2697
|
+
*/
|
|
2698
|
+
claimPwmWithdrawableFunds(params) {
|
|
2699
|
+
return this.postPrivate('/v5/earn/pwm/investment-plan/claim', params);
|
|
2700
|
+
}
|
|
2701
|
+
/**
|
|
2702
|
+
* Get PWM investment plan asset trend (default last 7 days).
|
|
2703
|
+
*/
|
|
2704
|
+
getPwmInvestmentPlanAssetTrend(params) {
|
|
2705
|
+
return this.getPrivate('/v5/earn/pwm/investment-plan/asset-trend', params);
|
|
2706
|
+
}
|
|
2707
|
+
/**
|
|
2708
|
+
* Get PWM fund historical NAV (max 180 days between startTime and endTime).
|
|
2709
|
+
*/
|
|
2710
|
+
getPwmFundHistoricalNav(params) {
|
|
2711
|
+
return this.getPrivate('/v5/earn/pwm/investment-plan/fund-nav', params);
|
|
2712
|
+
}
|
|
2713
|
+
/**
|
|
2714
|
+
* Subscribe to a PWM investment plan (PendingSubscription).
|
|
2715
|
+
*/
|
|
2716
|
+
subscribePwmInvestmentPlan(params) {
|
|
2717
|
+
return this.postPrivate('/v5/earn/pwm/investment-plan/subscribe', params);
|
|
2718
|
+
}
|
|
2719
|
+
/**
|
|
2720
|
+
* Invest more into a PWM investment plan product (Active).
|
|
2721
|
+
*/
|
|
2722
|
+
investMorePwmInvestmentPlan(params) {
|
|
2723
|
+
return this.postPrivate('/v5/earn/pwm/investment-plan/invest-more', params);
|
|
2724
|
+
}
|
|
2725
|
+
/**
|
|
2726
|
+
* Redeem from a PWM investment plan product.
|
|
2727
|
+
*/
|
|
2728
|
+
redeemPwmInvestmentPlan(params) {
|
|
2729
|
+
return this.postPrivate('/v5/earn/pwm/investment-plan/redeem', params);
|
|
2730
|
+
}
|
|
2731
|
+
/**
|
|
2732
|
+
* Get PWM investment plan orders (subscribe / redeem / auto-reinvest).
|
|
2733
|
+
*/
|
|
2734
|
+
getPwmInvestmentPlanOrders(params) {
|
|
2735
|
+
return this.getPrivate('/v5/earn/pwm/investment-plan/order', params);
|
|
2736
|
+
}
|
|
2737
|
+
/**
|
|
2738
|
+
* Get PWM subscribable product info for customize plan. No authentication required.
|
|
2739
|
+
*/
|
|
2740
|
+
getPwmSubscribableProductInfo() {
|
|
2741
|
+
return this.get('/v5/earn/pwm/customize-plan/product');
|
|
2742
|
+
}
|
|
2743
|
+
/**
|
|
2744
|
+
* Create a customized PWM investment plan (max 20 Active + Pending plans per user).
|
|
2745
|
+
*/
|
|
2746
|
+
createPwmCustomizeInvestmentPlan(params) {
|
|
2747
|
+
return this.postPrivate('/v5/earn/pwm/customize-plan/create', params);
|
|
2748
|
+
}
|
|
2749
|
+
/**
|
|
2750
|
+
*
|
|
2751
|
+
****** PWM — Asset Manager
|
|
2752
|
+
*
|
|
2753
|
+
*/
|
|
2754
|
+
/**
|
|
2755
|
+
* Get all PWM funds managed by the institution (newest first).
|
|
2756
|
+
*/
|
|
2757
|
+
getPwmAllFunds(params) {
|
|
2758
|
+
return this.getPrivate('/v5/earn/pwm/asset-manager/all-funds', params);
|
|
2759
|
+
}
|
|
2760
|
+
/**
|
|
2761
|
+
* Settle fund profit sharing (Active funds only).
|
|
2762
|
+
*/
|
|
2763
|
+
settlePwmFundProfit(params) {
|
|
2764
|
+
return this.postPrivate('/v5/earn/pwm/asset-manager/settle-profit', params);
|
|
2765
|
+
}
|
|
2766
|
+
/**
|
|
2767
|
+
* Create a PWM fund (PendingSubscribe). Max 10 funds per institution.
|
|
2768
|
+
*/
|
|
2769
|
+
createPwmFund(params) {
|
|
2770
|
+
return this.postPrivate('/v5/earn/pwm/asset-manager/create-fund', params);
|
|
2771
|
+
}
|
|
2772
|
+
/**
|
|
2773
|
+
* Create a PWM investment plan for a user (PendingSubscription). Max 10 plans per institution.
|
|
2774
|
+
*/
|
|
2775
|
+
createPwmAssetManagerInvestmentPlan(params) {
|
|
2776
|
+
return this.postPrivate('/v5/earn/pwm/asset-manager/create-investment-plan', params);
|
|
2777
|
+
}
|
|
2778
|
+
/**
|
|
2779
|
+
* Get PWM investment plans created by the institution (asset manager).
|
|
2780
|
+
*/
|
|
2781
|
+
getPwmAssetManagerInvestmentPlans(params) {
|
|
2782
|
+
return this.getPrivate('/v5/earn/pwm/asset-manager/get-investment-plan', params);
|
|
2783
|
+
}
|
|
2784
|
+
/**
|
|
2785
|
+
* Manage a PWM investment plan (status and/or fund allocation).
|
|
2786
|
+
*/
|
|
2787
|
+
managePwmAssetManagerInvestmentPlan(params) {
|
|
2788
|
+
return this.postPrivate('/v5/earn/pwm/asset-manager/manage-investment-plan', params);
|
|
2789
|
+
}
|
|
2790
|
+
/**
|
|
2791
|
+
* Get all PWM fund orders (asset manager). Default time window: last 7 days.
|
|
2792
|
+
*/
|
|
2793
|
+
getPwmAllFundOrders(params) {
|
|
2794
|
+
return this.getPrivate('/v5/earn/pwm/asset-manager/all-order', params);
|
|
2795
|
+
}
|
|
2796
|
+
/**
|
|
2797
|
+
* Manage a PWM fund order (approve / reject Pending Review orders).
|
|
2798
|
+
*/
|
|
2799
|
+
managePwmFundOrder(params) {
|
|
2800
|
+
return this.postPrivate('/v5/earn/pwm/asset-manager/manage-order', params);
|
|
2801
|
+
}
|
|
2802
|
+
/**
|
|
2803
|
+
* Create a PWM fund sub-account (async; max 30 per fund, fund must be Active).
|
|
2804
|
+
*/
|
|
2805
|
+
createPwmFundSubAccount(params) {
|
|
2806
|
+
return this.postPrivate('/v5/earn/pwm/asset-manager/create-sub-account', params);
|
|
2807
|
+
}
|
|
2808
|
+
/**
|
|
2809
|
+
* Transfer funds between custodian sub-accounts (fund custodian API key required).
|
|
2810
|
+
*/
|
|
2811
|
+
pwmFundTransfer(params) {
|
|
2812
|
+
return this.postPrivate('/v5/earn/pwm/fund-transfer', params);
|
|
2813
|
+
}
|
|
2814
|
+
/**
|
|
2815
|
+
* Query PWM fund transfer result (fund custodian API key required).
|
|
2816
|
+
*/
|
|
2817
|
+
getPwmFundTransferRecords(params) {
|
|
2818
|
+
return this.getPrivate('/v5/earn/pwm/query-fund-transfer-result', params);
|
|
2819
|
+
}
|
|
2597
2820
|
/**
|
|
2598
2821
|
*
|
|
2599
2822
|
****** Bybit Card APIs
|