bybit-api 4.6.1 → 4.6.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +339 -15
- package/lib/rest-client-v5.js +411 -5
- package/lib/rest-client-v5.js.map +1 -1
- package/lib/types/request/index.d.ts +6 -0
- package/lib/types/request/index.js +6 -0
- package/lib/types/request/index.js.map +1 -1
- package/lib/types/request/v5-account.d.ts +26 -0
- 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-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-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 +24 -0
- package/lib/types/request/v5-market.d.ts +10 -1
- 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-user.d.ts +7 -3
- package/lib/types/response/index.d.ts +6 -0
- package/lib/types/response/index.js +6 -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 +125 -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-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 +103 -0
- package/lib/types/response/v5-market.d.ts +14 -0
- package/lib/types/response/v5-position.d.ts +4 -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-user.d.ts +16 -0
- package/lib/types/shared-v5.d.ts +11 -1
- package/lib/types/websockets/ws-events.d.ts +4 -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 +8037 -5345
- package/package.json +1 -1
package/lib/constants/enum.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ export declare const API_ERROR_CODE: {
|
|
|
22
22
|
readonly DB_ERROR_WRONG_CURSOR: 10016;
|
|
23
23
|
/** Account not unified margin, update required */
|
|
24
24
|
readonly ACCOUNT_NOT_UNIFIED: 10020;
|
|
25
|
+
readonly COMPLIANCE_RULES_TRIGGERED: 10024;
|
|
25
26
|
readonly UNKNOWN_ERROR: 12000;
|
|
26
27
|
readonly BALANCE_INSUFFICIENT_SPOT_V3: 12131;
|
|
27
28
|
readonly ORDER_NOT_FOUND_SPOT_V3: 12213;
|
package/lib/constants/enum.js
CHANGED
|
@@ -25,6 +25,7 @@ exports.API_ERROR_CODE = {
|
|
|
25
25
|
DB_ERROR_WRONG_CURSOR: 10016,
|
|
26
26
|
/** Account not unified margin, update required */
|
|
27
27
|
ACCOUNT_NOT_UNIFIED: 10020,
|
|
28
|
+
COMPLIANCE_RULES_TRIGGERED: 10024,
|
|
28
29
|
UNKNOWN_ERROR: 12000,
|
|
29
30
|
BALANCE_INSUFFICIENT_SPOT_V3: 12131,
|
|
30
31
|
ORDER_NOT_FOUND_SPOT_V3: 12213,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../src/constants/enum.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;IACpC,UAAU,EAAE,cAAc;IAC1B,SAAS,EAAE,UAAU;CACb,CAAC;AAEE,QAAA,oBAAoB,GAAG;IAClC,4HAA4H;IAC5H,IAAI,EAAE,MAAM;IACZ,sHAAsH;IACtH,OAAO,EAAE,SAAS;CACV,CAAC;AAEE,QAAA,cAAc,GAAG;IAC5B,yBAAyB,EAAE,CAAC,IAAI;IAChC,gCAAgC,EAAE,CAAC,IAAI;IACvC,OAAO,EAAE,CAAC;IACV,0FAA0F;IAC1F,uBAAuB,EAAE,KAAK;IAC9B,8BAA8B,EAAE,KAAK;IACrC,mBAAmB,EAAE,KAAK;IAC1B,6BAA6B,EAAE,KAAK;IACpC,iFAAiF;IACjF,wBAAwB,EAAE,KAAK;IAC/B,qBAAqB,EAAE,KAAK;IAC5B,kDAAkD;IAClD,mBAAmB,EAAE,KAAK;IAC1B,aAAa,EAAE,KAAK;IACpB,4BAA4B,EAAE,KAAK;IACnC,uBAAuB,EAAE,KAAK;IAC9B,+BAA+B,EAAE,KAAK;IACtC,oCAAoC,EAAE,KAAK;IAC3C,wBAAwB,EAAE,KAAK;IAC/B,2BAA2B,EAAE,KAAK;IAClC,mCAAmC,EAAE,KAAK;IAC1C,wBAAwB,EAAE,KAAK;IAC/B,2BAA2B,EAAE,KAAK;IAClC,0BAA0B,EAAE,KAAK;IACjC,oCAAoC,EAAE,KAAK;IAC3C,iCAAiC;IACjC,mCAAmC,EAAE,KAAK;IAC1C,oCAAoC,EAAE,KAAK;IAC3C,+CAA+C;IAC/C,oBAAoB,EAAE,KAAK;IAC3B,2DAA2D;IAC3D,wBAAwB,EAAE,KAAK;IAC/B,0BAA0B,EAAE,KAAK;IACjC,qBAAqB,EAAE,KAAK;IAC5B,qBAAqB,EAAE,KAAK;IAC5B,uBAAuB,EAAE,KAAK;IAC9B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,KAAK;IACrB,yBAAyB,EAAE,KAAK;IAChC,kBAAkB,EAAE,MAAM;IAC1B,uBAAuB,EAAE,MAAM;IAC/B,4BAA4B,EAAE,KAAK;IACnC,oCAAoC,EAAE,MAAM;IAC5C,uBAAuB,EAAE,MAAM;IAC/B,0BAA0B,EAAE,MAAM;IAClC,mBAAmB,EAAE,KAAK;IAC1B,sBAAsB,EAAE,KAAK;IAC7B,8BAA8B,EAAE,KAAK;IACrC,yBAAyB,EAAE,KAAK;IAChC,uBAAuB,EAAE,MAAM;IAC/B,qBAAqB,EAAE,MAAM;IAC7B,kCAAkC,EAAE,MAAM;IAC1C,wBAAwB,EAAE,MAAM;IAChC,2CAA2C,EAAE,MAAM;IACnD,4BAA4B,EAAE,MAAM;IACpC,qBAAqB,EAAE,MAAM;IAC7B,4BAA4B,EAAE,MAAM;IACpC,0CAA0C,EAAE,MAAM;IAClD,qBAAqB,EAAE,MAAM;IAC7B,6BAA6B,EAAE,MAAM;IACrC,kBAAkB,EAAE,MAAM;IAC1B,oBAAoB,EAAE,MAAM;IAC5B,yBAAyB,EAAE,MAAM;IACjC,6BAA6B,EAAE,MAAM;IACrC,mCAAmC,EAAE,MAAM;IAC3C,iCAAiC,EAAE,MAAM;IACzC,mCAAmC,EAAE,MAAM;IAC3C,kCAAkC,EAAE,MAAM;IAC1C,kBAAkB,EAAE,MAAM;IAC1B,wCAAwC,EAAE,MAAM;IAChD,mCAAmC,EAAE,MAAM;IAC3C,2BAA2B,EAAE,MAAM;IACnC,uBAAuB,EAAE,MAAM;IAC/B,oCAAoC,EAAE,MAAM;IAC5C,oFAAoF;IACpF,uBAAuB,EAAE,OAAO;IAChC,eAAe,EAAE,OAAO;IACxB,eAAe,EAAE,OAAO;IACxB,yFAAyF;IACzF,iBAAiB,EAAE,OAAO;IAC1B,4BAA4B,EAAE,OAAO;IACrC,2BAA2B,EAAE,OAAO;IACpC,wBAAwB,EAAE,OAAO;IACjC,+BAA+B,EAAE,OAAO;CAChC,CAAC;AAEX;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,qEAAc,CAAA;IACd,+DAAW,CAAA;IACX,iEAAY,CAAA;AACd,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B"}
|
|
1
|
+
{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../src/constants/enum.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;IACpC,UAAU,EAAE,cAAc;IAC1B,SAAS,EAAE,UAAU;CACb,CAAC;AAEE,QAAA,oBAAoB,GAAG;IAClC,4HAA4H;IAC5H,IAAI,EAAE,MAAM;IACZ,sHAAsH;IACtH,OAAO,EAAE,SAAS;CACV,CAAC;AAEE,QAAA,cAAc,GAAG;IAC5B,yBAAyB,EAAE,CAAC,IAAI;IAChC,gCAAgC,EAAE,CAAC,IAAI;IACvC,OAAO,EAAE,CAAC;IACV,0FAA0F;IAC1F,uBAAuB,EAAE,KAAK;IAC9B,8BAA8B,EAAE,KAAK;IACrC,mBAAmB,EAAE,KAAK;IAC1B,6BAA6B,EAAE,KAAK;IACpC,iFAAiF;IACjF,wBAAwB,EAAE,KAAK;IAC/B,qBAAqB,EAAE,KAAK;IAC5B,kDAAkD;IAClD,mBAAmB,EAAE,KAAK;IAC1B,0BAA0B,EAAE,KAAK;IACjC,aAAa,EAAE,KAAK;IACpB,4BAA4B,EAAE,KAAK;IACnC,uBAAuB,EAAE,KAAK;IAC9B,+BAA+B,EAAE,KAAK;IACtC,oCAAoC,EAAE,KAAK;IAC3C,wBAAwB,EAAE,KAAK;IAC/B,2BAA2B,EAAE,KAAK;IAClC,mCAAmC,EAAE,KAAK;IAC1C,wBAAwB,EAAE,KAAK;IAC/B,2BAA2B,EAAE,KAAK;IAClC,0BAA0B,EAAE,KAAK;IACjC,oCAAoC,EAAE,KAAK;IAC3C,iCAAiC;IACjC,mCAAmC,EAAE,KAAK;IAC1C,oCAAoC,EAAE,KAAK;IAC3C,+CAA+C;IAC/C,oBAAoB,EAAE,KAAK;IAC3B,2DAA2D;IAC3D,wBAAwB,EAAE,KAAK;IAC/B,0BAA0B,EAAE,KAAK;IACjC,qBAAqB,EAAE,KAAK;IAC5B,qBAAqB,EAAE,KAAK;IAC5B,uBAAuB,EAAE,KAAK;IAC9B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,KAAK;IACrB,yBAAyB,EAAE,KAAK;IAChC,kBAAkB,EAAE,MAAM;IAC1B,uBAAuB,EAAE,MAAM;IAC/B,4BAA4B,EAAE,KAAK;IACnC,oCAAoC,EAAE,MAAM;IAC5C,uBAAuB,EAAE,MAAM;IAC/B,0BAA0B,EAAE,MAAM;IAClC,mBAAmB,EAAE,KAAK;IAC1B,sBAAsB,EAAE,KAAK;IAC7B,8BAA8B,EAAE,KAAK;IACrC,yBAAyB,EAAE,KAAK;IAChC,uBAAuB,EAAE,MAAM;IAC/B,qBAAqB,EAAE,MAAM;IAC7B,kCAAkC,EAAE,MAAM;IAC1C,wBAAwB,EAAE,MAAM;IAChC,2CAA2C,EAAE,MAAM;IACnD,4BAA4B,EAAE,MAAM;IACpC,qBAAqB,EAAE,MAAM;IAC7B,4BAA4B,EAAE,MAAM;IACpC,0CAA0C,EAAE,MAAM;IAClD,qBAAqB,EAAE,MAAM;IAC7B,6BAA6B,EAAE,MAAM;IACrC,kBAAkB,EAAE,MAAM;IAC1B,oBAAoB,EAAE,MAAM;IAC5B,yBAAyB,EAAE,MAAM;IACjC,6BAA6B,EAAE,MAAM;IACrC,mCAAmC,EAAE,MAAM;IAC3C,iCAAiC,EAAE,MAAM;IACzC,mCAAmC,EAAE,MAAM;IAC3C,kCAAkC,EAAE,MAAM;IAC1C,kBAAkB,EAAE,MAAM;IAC1B,wCAAwC,EAAE,MAAM;IAChD,mCAAmC,EAAE,MAAM;IAC3C,2BAA2B,EAAE,MAAM;IACnC,uBAAuB,EAAE,MAAM;IAC/B,oCAAoC,EAAE,MAAM;IAC5C,oFAAoF;IACpF,uBAAuB,EAAE,OAAO;IAChC,eAAe,EAAE,OAAO;IACxB,eAAe,EAAE,OAAO;IACxB,yFAAyF;IACzF,iBAAiB,EAAE,OAAO;IAC1B,4BAA4B,EAAE,OAAO;IACrC,2BAA2B,EAAE,OAAO;IACpC,wBAAwB,EAAE,OAAO;IACjC,+BAA+B,EAAE,OAAO;CAChC,CAAC;AAEX;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,qEAAc,CAAA;IACd,+DAAW,CAAA;IACX,iEAAY,CAAA;AACd,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B"}
|
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, AffiliateUserInfoV5, AffiliateUserListItemV5, AllCoinsBalanceV5, AllowedDepositCoinInfoV5, AlphaAssetDetailResultV5, AlphaAssetListResultV5, AlphaBizTokenDetailsV5, AlphaBizTokenPriceListResultV5, AlphaBizTokenV5, AlphaPayTokenV5, AlphaTradeOrderListResultV5, AlphaTradeQuoteResultV5, AmendOrderParamsV5, AmendSpreadOrderParamsV5, ApiKeyInfoV5, APIP2PResponse, APIResponseV3, APIResponseV3WithTime, AssetInfoV5, AssetOverviewResultV5, AutoRepayModeResultV5, AvailableAmountToRepayV5, BatchAmendOrderParamsV5, BatchAmendOrderResultV5, BatchCancelOrderParamsV5, BatchCancelOrderResultV5, BatchCreateOrderResultV5, BatchOrderParamsV5, BatchOrdersRetExtInfoV5, BorrowableCoinV5, BorrowContractInfoFixedV5, BorrowCryptoLoanParamsV5, BorrowFlexibleParamsV5, BorrowFlexibleV5, BorrowHistoryFlexibleV5, BorrowHistoryRecordV5, BorrowOrderInfoFixedV5, BorrowOrderQuoteFixedV5, BrokerIssuedVoucherV5, BrokerRateLimitAllItemV5, BrokerRateLimitCapItemV5, BrokerRateLimitSetResultItemV5, BrokerVoucherSpecV5, CancelAllOrdersParamsV5, CancelAllRFQResultV5, CancelBorrowOrderFixedParamsV5, CancelOrderParamsV5, CancelRFQParamsV5, CancelRFQQuoteItemV5, CancelRFQQuoteParamsV5, CancelRFQQuoteResultV5, CancelRFQResultV5, CancelSupplyOrderFixedParamsV5, CardAssetRecordsResultV5, CardMallItemListResultV5, CardPointBalanceV5, CardPointCashbackDetailV5, CardPointRecordsResultV5, CardPointTierInfoV5, CategoryCursorListV5, CategoryListV5, CategorySymbolListV5, CategoryV5, ClosedOptionsPositionV5, ClosedPnLV5, CoinExchangeRecordV5, CoinGreeksV5, CoinInfoV5, CoinStateV5, CollateralAdjustmentHistoryV5, CollateralDataV5, CollateralInfoV5, CompletedLoanOrderV5, ConfirmNewRiskLimitParamsV5, ConvertCoinsParamsV5, ConvertCoinSpecV5, ConvertHistoryRecordV5, ConvertQuoteV5, ConvertStatusV5, CreateBorrowOrderFixedParamsV5, CreateBorrowOrderFixedV5, CreateP2PAdParamsV5, CreateRFQParamsV5, CreateRFQQuoteParamsV5, CreateRFQQuoteResultV5, CreateRFQResultV5, CreateSubApiKeyParamsV5, CreateSubApiKeyResultV5, CreateSubMemberParamsV5, CreateSubMemberResultV5, CreateSupplyOrderFixedParamsV5, CreateSupplyOrderFixedV5, CryptoLoanPositionV5, CurrencyPositionTiersV5, CursorListV5, CursorRowsV5, DCPInfoV5, DeleteSubMemberParamsV5, DeliveryPriceV5, DeliveryRecordV5, DepositAddressChainV5, DepositRecordV5, EarnAprHistoryPointV5, EarnHourlyYieldHistoryV5, EarnOrderHistoryV5, EarnPositionV5, EarnProductV5, EarnTokenDailyYieldRecordV5, EarnTokenHistoryAprPointV5, EarnTokenHourlyYieldRecordV5, EarnTokenOrderV5, EarnTokenPositionV5, EarnTokenProductV5, EarnYieldHistoryV5, ExchangeBrokerAccountInfoV5, ExchangeBrokerEarningResultV5, ExchangeBrokerSubAccountDepositRecordV5, ExecuteAlphaTradeParamsV5, ExecuteAlphaTradeResultV5, ExecuteRFQQuoteParamsV5, ExecuteRFQQuoteResultV5, ExecutionV5, FeeGroupStructureResponseV5, FeeRateV5, FiatTradingPairListV5, FixedRateBorrowContractInfoV5, FixedRateBorrowOrderInfoV5, FixedRateBorrowParamsV5, FixedRateBorrowQuoteV5, FixedRateBorrowResultV5, FixedTermEarnOrderListV5, FixedTermEarnPlaceOrderResultV5, FixedTermEarnPositionListV5, FixedTermEarnProductListV5, FriendReferralRecordV5, FundingAccountTransactionRecordV5, FundingRateHistoryResponseV5, GetAccountCoinBalanceParamsV5, GetAccountHistoricOrdersParamsV5, GetAccountInstrumentsInfoParamsV5, GetAccountOrdersParamsV5, GetADLAlertParamsV5, GetAdvanceEarnOrderListParamsV5, GetAdvanceEarnPositionListParamsV5, GetAdvanceEarnProductExtraInfoParamsV5, GetAdvanceEarnProductParamsV5, GetAffiliateUserListParamsV5, GetAllBrokerRateLimitsParamsV5, GetAllCoinsBalanceParamsV5, GetAllowedDepositCoinInfoParamsV5, GetAlphaAssetDetailParamsV5, GetAlphaBizTokenDetailsParamsV5, GetAlphaBizTokenListParamsV5, GetAlphaBizTokenPriceListParamsV5, GetAlphaPayTokenListParamsV5, GetAlphaTradeOrderListParamsV5, GetAlphaTradeQuoteParamsV5, GetAssetInfoParamsV5, GetAssetOverviewParamsV5, GetAutoRepayModeParamsV5, GetAvailableAmountToRepayParamsV5, GetBorrowableCoinsParamsV5, GetBorrowContractInfoFixedParamsV5, GetBorrowHistoryFlexibleParamsV5, GetBorrowHistoryParamsV5, GetBorrowOrderInfoFixedParamsV5, GetBorrowOrderQuoteFixedParamsV5, GetBrokerIssuedVoucherParamsV5, GetBrokerSubAccountDepositsV5, GetClassicTransactionLogsParamsV5, GetClosedOptionsPositionsParamsV5, GetClosedPnLParamsV5, GetCoinExchangeRecordParamsV5, GetCoinStateParamsV5, GetCollateralAdjustmentHistoryParamsV5, GetCollateralCoinsParamsV5, GetCompletedLoanOrderHistoryParamsV5, GetConvertHistoryParamsV5, GetDeliveryPriceParamsV5, GetDeliveryRecordParamsV5, GetDepositRecordParamsV5, GetEarnAprHistoryParamsV5, GetEarnHourlyYieldHistoryParamsV5, GetEarnOrderHistoryParamsV5, GetEarnPositionParamsV5, GetEarnTokenDailyYieldParamsV5, GetEarnTokenHistoryAprParamsV5, GetEarnTokenHourlyYieldParamsV5, GetEarnTokenOrderListParamsV5, GetEarnTokenPositionParamsV5, GetEarnTokenProductParamsV5, GetEarnYieldHistoryParamsV5, GetExchangeBrokerEarningsParamsV5, GetExecutionListParamsV5, GetFeeGroupStructureParamsV5, GetFeeRateParamsV5, GetFiatTradingPairListParamsV5, GetFixedRateBorrowContractInfoParamsV5, GetFixedRateBorrowOrderInfoParamsV5, GetFixedRateBorrowOrderQuoteParamsV5, GetFixedTermEarnOrderListParamsV5, GetFixedTermEarnPositionParamsV5, GetFixedTermEarnProductParamsV5, GetFriendReferralsParamsV5, GetFundingAccountTransactionHistoryParamsV5, GetFundingRateHistoryParamsV5, GetHistoricalVolatilityParamsV5, GetIndexPriceComponentsParamsV5, GetIndexPriceKlineParamsV5, GetInstrumentsInfoParamsV5, GetInsuranceParamsV5, GetInternalDepositRecordParamsV5, GetInternalTransferParamsV5, GetKlineParamsV5, GetLiquidityMiningProductParamsV5, GetLoanLTVAdjustmentHistoryParamsV5, GetLongShortRatioParamsV5, GetMarkPriceKlineParamsV5, GetMaxBorrowableAmountParamsV5, GetMaxCollateralAmountParamsV5, GetMaxLoanAmountParamsV5, GetMovePositionHistoryParamsV5, GetOngoingFlexibleLoansParamsV5, GetOpenInterestParamsV5, GetOptionDeliveryPriceParamsV5, GetOrderbookParamsV5, GetP2PAccountCoinsBalanceParamsV5, GetP2PCounterpartyUserInfoParamsV5, GetP2POnlineAdsParamsV5, GetP2POrderMessagesParamsV5, GetP2POrdersParamsV5, GetP2PPendingOrdersParamsV5, GetP2PPersonalAdsParamsV5, GetPayInfoParamsV5, GetPortfolioMarginInfoParamsV5, GetPositionTiersParamsV5, GetPremiumIndexPriceKlineParamsV5, GetPreUpgradeClosedPnlParamsV5, GetPreUpgradeOptionDeliveryRecordParamsV5, GetPreUpgradeOrderHistoryParamsV5, GetPreUpgradeTradeHistoryParamsV5, GetPreUpgradeTransactionLogParamsV5, GetPreUpgradeUSDCSessionParamsV5, GetPublicTradingHistoryParamsV5, GetRenewOrderInfoFixedParamsV5, GetRepaymentHistoryFixedParamsV5, GetRepaymentHistoryFlexibleParamsV5, GetRepaymentHistoryParamsV5, GetRFQHistoryParamsV5, GetRFQListParamsV5, GetRFQPublicTradesParamsV5, GetRFQQuoteRealtimeParamsV5, GetRFQRealtimeParamsV5, GetRFQRealtimeResultV5, GetRFQTradeListParamsV5, GetRiskLimitParamsV5, GetRPIOrderbookParamsV5, GetSettlementRecordParamsV5, GetSmallBalanceListParamsV5, GetSpotMarginCurrencyDataParamsV5, GetSpotMarginLiabilityInfoParamsV5, GetSpreadInstrumentsInfoParamsV5, GetSpreadMaxQtyParamsV5, GetSpreadOpenOrdersParamsV5, GetSpreadOrderHistoryParamsV5, GetSpreadTradeHistoryParamsV5, GetSubAccountAllApiKeysParamsV5, GetSubAccountDepositRecordParamsV5, GetSupplyContractInfoFixedParamsV5, GetSupplyOrderInfoFixedParamsV5, GetSupplyOrderQuoteFixedParamsV5, GetSystemStatusParamsV5, GetTickersParamsV5, GetTotalMembersAssetsParamsV5, GetTradeInfoForAnalysisParamsV5, GetTransactionLogParamsV5, GetUniversalTransferRecordsParamsV5, GetUnpaidLoanOrdersParamsV5, GetVIPMarginDataParamsV5, GetWalletBalanceParamsV5, GetWithdrawalAddressListParamsV5, GetWithdrawalRecordsParamsV5, HistoricalVolatilityV5, IndexPriceComponentsResponseV5, InstitutionalLoanLTVV5, InstrumentInfoResponseV5, InsuranceResponseV5, InternalDepositRecordV5, InternalTransferRecordV5, IssueVoucherParamsV5, LiquidityMiningProductResultV5, LoanLTVAdjustmentHistoryV5, LongShortRatioV5, ManualBorrowParamsV5, ManualBorrowResultV5, ManualRepayParamsV5, ManualRepayResultV5, ManualRepayWithoutConversionParamsV5, ManualRepayWithoutConversionResultV5, MarkP2POrderAsPaidParamsV5, MaxBorrowableAmountV5, MaxLoanAmountV5, MMPModifyParamsV5, MMPStateV5, ModifyEarnPositionParamsV5, MovePositionHistoryV5, MovePositionParamsV5, MovePositionResultV5, OHLCKlineV5, OHLCVKlineV5, OngoingFlexibleLoanV5, OpenInterestResponseV5, OptionAssetInfoNestedResultV5, OptionDeliveryPriceV5, OrderbookResponseV5, OrderParamsV5, OrderPriceLimitV5, OrderResultV5, OrderSideV5, P2PAccountCoinsBalanceV5, P2PAdDetailV5, P2PCounterpartyUserInfoV5, P2PCreateAdResponseV5, P2POnlineAdsResponseV5, P2POrderDetailV5, P2POrderMessageV5, P2POrdersResponseV5, P2PPersonalAdsResponseV5, P2PUserInfoV5, P2PUserPaymentV5, PayInfoResultV5, PlaceEarnTokenOrderParamsV5, PlaceEarnTokenOrderResultV5, PortfolioMarginInfoResultV5, PositionInfoParamsV5, PositionV5, PreCheckOrderResultV5, PreUpgradeOptionsDelivery, PreUpgradeTransaction, PreUpgradeUSDCSessionSettlement, PublicTradeV5, QueryCardAssetRecordsParamsV5, QueryCardMallItemListParamsV5, QueryCardPointCashbackDetailParamsV5, QueryCardPointRecordsParamsV5, RedeemFixedTermEarnParamsV5, RedeemFixedTermEarnResultV5, RenewBorrowOrderFixedParamsV5, RenewBorrowOrderFixedV5, RenewFixedRateBorrowParamsV5, RenewOrderInfoFixedV5, RepayCollateralFixedParamsV5, RepayCollateralFlexibleParamsV5, RepayFixedParamsV5, RepayFixedV5, RepayFlexibleParamsV5, RepayFlexibleV5, RepayInstitutionalLoanParamsV5, RepayInstitutionalLoanResultV5, RepayLiabilityParamsV5, RepayLiabilityResultV5, RepaymentHistoryFixedV5, RepaymentHistoryFlexibleV5, RepaymentHistoryV5, RequestConvertQuoteParamsV5, RFQConfigV5, RFQHistory, RFQPublicTradeV5, RFQQuoteItemV5, RFQTradeV5, RiskLimitV5, RPIOrderbookResponseV5, SendP2POrderMessageParamsV5, SetAutoAddMarginParamsV5, SetAutoRepayModeParamsV5, SetBrokerRateLimitParamsV5, SetCollateralCoinParamsV5, SetDeltaNeutralModeParamsV5, SetFixedTermEarnAutoInvestParamsV5, SetLeverageParamsV5, SetLimitPriceActionParamsV5, SetRiskLimitParamsV5, SetRiskLimitResultV5, SetSpotMarginLeverageParamsV5, SettlementRecordV5, SetTPSLModeParamsV5, SetTradingStopParamsV5, SignAgreementParamsV5, SmallBalanceListV5, SpotBorrowCheckResultV5, SpotMarginCurrencyDataV5, SpotMarginLiabilityInfoV5, SpotMarginStateV5, SpreadInstrumentInfoV5, SpreadMaxQtyResultV5, SpreadOpenOrderV5, SpreadOrderbookResponseV5, SpreadOrderHistoryV5, SpreadRecentTradeV5, SpreadTickerV5, SpreadTradeV5, SubMemberV5, SubmitAdvanceEarnPlaceOrderParamsV5, SubmitFixedTermEarnOrderParamsV5, SubmitSpreadOrderParamsV5, SubmitStakeRedeemParamsV5, SupplyContractInfoFixedV5, SupplyOrderInfoFixedV5, SupplyOrderQuoteFixedV5, SwitchIsolatedMarginParamsV5, SwitchPositionModeParamsV5, SystemStatusItemV5, TickerLinearInverseV5, TickerOptionV5, TickerSpotV5, TotalMembersAssetsResultV5, TPSLModeV5, TradeInfoForAnalysisResultV5, TransactionLogV5, UnifiedAccountUpgradeResultV5, UniversalTransferParamsV5, UniversalTransferRecordV5, UnpaidLoanOrderV5, UpdateApiKeyParamsV5, UpdateApiKeyResultV5, UpdateP2PAdParamsV5, UserSettingConfigV5, VaspEntityV5, VipBorrowableCoinsV5, VipCollateralCoinsV5, VIPMarginDataV5, WalletBalanceV5, WithdrawableAmountV5, WithdrawalAddressV5, WithdrawalRecordV5, WithdrawParamsV5 } from './types';
|
|
2
2
|
import BaseRestClient from './util/BaseRestClient';
|
|
3
3
|
/**
|
|
4
4
|
* REST API client for V5 REST APIs
|
|
@@ -87,6 +87,11 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
87
87
|
}): Promise<APIResponseV3WithTime<{
|
|
88
88
|
list: SpreadRecentTradeV5[];
|
|
89
89
|
}>>;
|
|
90
|
+
/**
|
|
91
|
+
* Get Spread Max Qty
|
|
92
|
+
* Max order quantity (available balance) for a spread order at a given side and price.
|
|
93
|
+
*/
|
|
94
|
+
getSpreadMaxQty(params: GetSpreadMaxQtyParamsV5): Promise<APIResponseV3WithTime<SpreadMaxQtyResultV5>>;
|
|
90
95
|
/**
|
|
91
96
|
* Create Spread Order
|
|
92
97
|
*/
|
|
@@ -173,9 +178,11 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
173
178
|
/**
|
|
174
179
|
* Query the mark price kline data. Charts are returned in groups based on the requested interval.
|
|
175
180
|
*
|
|
176
|
-
* Covers:
|
|
181
|
+
* Covers: USDT contract / USDC contract / Inverse contract / Options
|
|
182
|
+
*
|
|
183
|
+
* `category` defaults to linear if omitted. For options, `limit` max is 500; futures max is 1000.
|
|
177
184
|
*/
|
|
178
|
-
getMarkPriceKline(params: GetMarkPriceKlineParamsV5): Promise<APIResponseV3WithTime<CategorySymbolListV5<OHLCKlineV5[], 'linear' | 'inverse'>>>;
|
|
185
|
+
getMarkPriceKline(params: GetMarkPriceKlineParamsV5): Promise<APIResponseV3WithTime<CategorySymbolListV5<OHLCKlineV5[], 'linear' | 'inverse' | 'option'>>>;
|
|
179
186
|
/**
|
|
180
187
|
* Query the index price kline data. Charts are returned in groups based on the requested interval.
|
|
181
188
|
*
|
|
@@ -194,6 +201,7 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
194
201
|
* Covers: Spot / Linear contract / Inverse contract / Option
|
|
195
202
|
*
|
|
196
203
|
* Note: Spot does not support pagination, so limit & cursor are invalid.
|
|
204
|
+
* Note: e.g. `symbolType: 'commodity'`, and for linear also `stock`, `forex` (see Bybit Get Instruments Info).
|
|
197
205
|
*/
|
|
198
206
|
getInstrumentsInfo<C extends CategoryV5>(params: GetInstrumentsInfoParamsV5 & {
|
|
199
207
|
category: C;
|
|
@@ -644,6 +652,7 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
644
652
|
* Covers: SPOT / USDT contract / USDC contract / Inverse contract
|
|
645
653
|
*
|
|
646
654
|
* Includes RPI permission information (isPublicRpi, myRpiPermission)
|
|
655
|
+
* Note: e.g. `symbolType: 'commodity'`, and for linear also `stock`, `forex`.
|
|
647
656
|
*/
|
|
648
657
|
getAccountInstrumentsInfo<C extends 'spot' | 'linear' | 'inverse'>(params: GetAccountInstrumentsInfoParamsV5 & {
|
|
649
658
|
category: C;
|
|
@@ -667,8 +676,17 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
667
676
|
*
|
|
668
677
|
* - Input the specific coin: repay the liability of this coin in particular
|
|
669
678
|
* - No coin specified: repay the liability of all coins
|
|
679
|
+
*
|
|
680
|
+
* Does not repay manual-borrow (spot margin manual borrow) liabilities — use `manualRepay` or
|
|
681
|
+
* `manualRepayWithoutConversion` instead (API error 182120 otherwise).
|
|
682
|
+
* From 2026-03-17 (full 2026-03-24), BYUSDT can be used for repayment. MNT is temporarily not used for
|
|
683
|
+
* this flow; MNT convert-repay is not supported (use `manualRepayWithoutConversion` with existing balance).
|
|
684
|
+
* From 2026-02-10 08:00 UTC, coin-conversion fees use the higher of collateral or debt fee rate, with a
|
|
685
|
+
* per-transaction coin-conversion cap of 300,000 USD equivalent.
|
|
670
686
|
*/
|
|
671
|
-
repayLiability(params?: RepayLiabilityParamsV5): Promise<APIResponseV3WithTime<
|
|
687
|
+
repayLiability(params?: RepayLiabilityParamsV5): Promise<APIResponseV3WithTime<{
|
|
688
|
+
list: RepayLiabilityResultV5[];
|
|
689
|
+
}>>;
|
|
672
690
|
/**
|
|
673
691
|
* Manual Repay
|
|
674
692
|
*
|
|
@@ -679,6 +697,14 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
679
697
|
* If that's not enough, the remaining amount will be repaid by converting other assets.
|
|
680
698
|
*
|
|
681
699
|
* Repayment is prohibited between 04:00 and 05:30 per hour.
|
|
700
|
+
*
|
|
701
|
+
* When `coin` and `amount` are both set, validation depends on `repaymentType` (e.g. amount must not
|
|
702
|
+
* exceed the matching liability pool). If neither `coin` nor `amount` is set, `repaymentType` must be
|
|
703
|
+
* ALL. Response timing: ALL and FIXED are asynchronous; FLEXIBLE is synchronous.
|
|
704
|
+
* For repay-without-convert (spot balance only), use `manualRepayWithoutConversion`.
|
|
705
|
+
* From 2026-03-17 (full 2026-03-24), BYUSDT can be used for repayment. MNT: not via convert-repay;
|
|
706
|
+
* use `manualRepayWithoutConversion` for MNT with existing balance. From 2026-02-10 08:00 UTC,
|
|
707
|
+
* coin-conversion cap 300,000 USD equivalent per transaction applies.
|
|
682
708
|
*/
|
|
683
709
|
manualRepay(params?: ManualRepayParamsV5): Promise<APIResponseV3WithTime<ManualRepayResultV5>>;
|
|
684
710
|
/**
|
|
@@ -773,13 +799,16 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
773
799
|
*/
|
|
774
800
|
setLimitPriceAction(params: SetLimitPriceActionParamsV5): Promise<APIResponseV3WithTime<{}>>;
|
|
775
801
|
/**
|
|
776
|
-
* Get Limit Price Behaviour
|
|
802
|
+
* Get Trade Behaviour Config / Get Limit Price Behaviour
|
|
777
803
|
* You can get configuration how the system behaves when your limit order price exceeds the highest bid or lowest ask price.
|
|
804
|
+
* Response includes `deltaEnable` for Delta Neutral mode, and `smsef` / `fmsef` for Spot and Futures MNT fee deduction.
|
|
778
805
|
*/
|
|
779
|
-
getLimitPriceAction(): Promise<APIResponseV3WithTime<
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
806
|
+
getLimitPriceAction(): Promise<APIResponseV3WithTime<UserSettingConfigV5>>;
|
|
807
|
+
/**
|
|
808
|
+
* Set Delta Neutral Mode
|
|
809
|
+
* 1: enable, 0: disable. Query current status via `getLimitPriceAction()`.
|
|
810
|
+
*/
|
|
811
|
+
setDeltaNeutralMode(params: SetDeltaNeutralModeParamsV5): Promise<APIResponseV3WithTime<Record<string, never>>>;
|
|
783
812
|
/**
|
|
784
813
|
* Configure Market Maker Protection (MMP)
|
|
785
814
|
*/
|
|
@@ -794,6 +823,21 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
794
823
|
getMMPState(baseCoin: string): Promise<APIResponseV3WithTime<{
|
|
795
824
|
result: MMPStateV5[];
|
|
796
825
|
}>>;
|
|
826
|
+
/**
|
|
827
|
+
* Get Option Asset Info
|
|
828
|
+
* P&L per coin for options: delta, RPL, UPL, margin. Result uses a nested `result` list.
|
|
829
|
+
*/
|
|
830
|
+
getOptionAssetInfo(): Promise<APIResponseV3WithTime<OptionAssetInfoNestedResultV5>>;
|
|
831
|
+
/**
|
|
832
|
+
* Get Pay Info
|
|
833
|
+
* Repayment collateral snapshot before `manualRepay` or `repayLiability`. Optional `coin` for one liability; omit for total.
|
|
834
|
+
*/
|
|
835
|
+
getPayInfo(params?: GetPayInfoParamsV5): Promise<APIResponseV3WithTime<PayInfoResultV5>>;
|
|
836
|
+
/**
|
|
837
|
+
* Get Trade Info For Analysis
|
|
838
|
+
* Aggregated spot trade stats for a symbol, including daily breakdown when returned.
|
|
839
|
+
*/
|
|
840
|
+
getTradeInfoForAnalysis(params: GetTradeInfoForAnalysisParamsV5): Promise<APIResponseV3WithTime<TradeInfoForAnalysisResultV5>>;
|
|
797
841
|
/**
|
|
798
842
|
*
|
|
799
843
|
****** Asset APIs
|
|
@@ -804,8 +848,20 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
804
848
|
* Query master account or subaccount's total assets and detailed asset holdings across different accounts and product categories.
|
|
805
849
|
*
|
|
806
850
|
* INFO: For accountType=Alpha, on-chain assets are not included in the returned data in current version.
|
|
851
|
+
* `valuationCurrency` sets fiat for totals; `accountType` filters which account to return. For Alpha + farm, `extMap` may
|
|
852
|
+
* appear on `coinDetail` (price range and equity unit).
|
|
807
853
|
*/
|
|
808
854
|
getAssetOverview(params?: GetAssetOverviewParamsV5): Promise<APIResponseV3WithTime<AssetOverviewResultV5>>;
|
|
855
|
+
/**
|
|
856
|
+
* Get Portfolio Margin Info
|
|
857
|
+
* Wallet and per-base-coin P&L range (aligned with the portfolio margin page).
|
|
858
|
+
*/
|
|
859
|
+
getPortfolioMarginInfo(params?: GetPortfolioMarginInfoParamsV5): Promise<APIResponseV3WithTime<PortfolioMarginInfoResultV5>>;
|
|
860
|
+
/**
|
|
861
|
+
* Get Total Members Assets
|
|
862
|
+
* Master + sub-accounts; optional `coin` for valuation (default BTC).
|
|
863
|
+
*/
|
|
864
|
+
getTotalMembersAssets(params?: GetTotalMembersAssetsParamsV5): Promise<APIResponseV3WithTime<TotalMembersAssetsResultV5>>;
|
|
809
865
|
/**
|
|
810
866
|
* Funding Account Transaction History
|
|
811
867
|
* Transaction log in Funding Account. Supports filtering by transaction type and time range.
|
|
@@ -874,13 +930,13 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
874
930
|
*/
|
|
875
931
|
getCoinBalance(params: GetAccountCoinBalanceParamsV5): Promise<APIResponseV3<AccountCoinBalanceV5>>;
|
|
876
932
|
/**
|
|
877
|
-
* Query withdrawable amount.
|
|
933
|
+
* Query withdrawable amount (incl. risk-frozen `limitAmountUsd` and per-wallet slices).
|
|
934
|
+
* May include FUND, UTA, EARN, SPOT keys depending on the coin. EARN is present when the coin
|
|
935
|
+
* supports withdrawal from the Earn account.
|
|
878
936
|
*/
|
|
879
937
|
getWithdrawableAmount(params: {
|
|
880
938
|
coin: string;
|
|
881
|
-
}): Promise<
|
|
882
|
-
rows: WithdrawableAmountV5[];
|
|
883
|
-
}>>;
|
|
939
|
+
}): Promise<APIResponseV3WithTime<WithdrawableAmountV5>>;
|
|
884
940
|
/**
|
|
885
941
|
* Query the transferable coin list between each account type.
|
|
886
942
|
*/
|
|
@@ -937,6 +993,7 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
937
993
|
}>>;
|
|
938
994
|
/**
|
|
939
995
|
* Set auto transfer account after deposit. The same function as the setting for Deposit on web GUI
|
|
996
|
+
* (UNIFIED, FUND, or EARN; if a coin is not in flexible saving, EARN may route to funding as per Bybit).
|
|
940
997
|
*/
|
|
941
998
|
setDepositAccount(params: {
|
|
942
999
|
accountType: AccountTypeV5;
|
|
@@ -1027,11 +1084,13 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1027
1084
|
vasp: VaspEntityV5[];
|
|
1028
1085
|
}>>;
|
|
1029
1086
|
/**
|
|
1030
|
-
* Withdraw
|
|
1087
|
+
* Withdraw from Funding, Unified, and/or Earn (and combos such as FUND,UTA,EARN per API).
|
|
1031
1088
|
*
|
|
1032
1089
|
* CAUTION: Make sure you have whitelisted your wallet address before calling this endpoint.
|
|
1033
1090
|
*
|
|
1034
1091
|
* You can make an off-chain transfer if the target wallet address is from Bybit. This means that no blockchain fee will be charged.
|
|
1092
|
+
*
|
|
1093
|
+
* Bybit Turkey (TR) site: `transactionPurpose` is required on the request (see `WithdrawParamsV5`).
|
|
1035
1094
|
*/
|
|
1036
1095
|
submitWithdrawal(params: WithdrawParamsV5): Promise<APIResponseV3WithTime<{
|
|
1037
1096
|
id: string;
|
|
@@ -1144,6 +1203,8 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1144
1203
|
* Both master and sub user's api key are applicable.
|
|
1145
1204
|
*
|
|
1146
1205
|
* TIP: Any permission can access this endpoint.
|
|
1206
|
+
*
|
|
1207
|
+
* Response `permissions` may include `FiatBitPay`; `FiatBybitPay` is deprecated for the same scope.
|
|
1147
1208
|
*/
|
|
1148
1209
|
getQueryApiKey(): Promise<APIResponseV3WithTime<ApiKeyInfoV5>>;
|
|
1149
1210
|
/**
|
|
@@ -1166,6 +1227,8 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1166
1227
|
*
|
|
1167
1228
|
* TIP: The API key must have one of the permissions to be allowed to call the following API endpoint.
|
|
1168
1229
|
* - master API key: "Account Transfer", "Subaccount Transfer", "Withdrawal"
|
|
1230
|
+
*
|
|
1231
|
+
* `permissions` may include `FiatBitPay`; `FiatBybitPay` remains during transition for the same scope.
|
|
1169
1232
|
*/
|
|
1170
1233
|
updateMasterApiKey(params: UpdateApiKeyParamsV5): Promise<APIResponseV3WithTime<UpdateApiKeyResultV5>>;
|
|
1171
1234
|
/**
|
|
@@ -1250,8 +1313,9 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1250
1313
|
}>>;
|
|
1251
1314
|
/**
|
|
1252
1315
|
* Sign Agreement
|
|
1253
|
-
* To trade
|
|
1316
|
+
* To trade commodity contracts (e.g. metals XAU/XAG perps, crude oil perps), complete the agreement signing first.
|
|
1254
1317
|
* Recommended to sign in advance via API so you can trade immediately when contracts go live.
|
|
1318
|
+
* Send either `category` (legacy) or `categoryV2` (preferred; new agreement types are added to `categoryV2` only).
|
|
1255
1319
|
*
|
|
1256
1320
|
* INFO
|
|
1257
1321
|
* - Only the master account can sign. Subaccounts are not supported.
|
|
@@ -1260,6 +1324,64 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1260
1324
|
* - Trading without signing returns code=110123, msg=You must agree to the Trading Terms.
|
|
1261
1325
|
*/
|
|
1262
1326
|
signAgreement(params: SignAgreementParamsV5): Promise<APIResponseV3WithTime<{}>>;
|
|
1327
|
+
/**
|
|
1328
|
+
*
|
|
1329
|
+
****** Alpha / Web3 (on-chain) trade APIs
|
|
1330
|
+
*
|
|
1331
|
+
*/
|
|
1332
|
+
/**
|
|
1333
|
+
* Get Trade Quote
|
|
1334
|
+
* Get a price quote before a purchase or redeem. Required before `executeAlphaTradePurchase` or `executeAlphaTradeRedeem`.
|
|
1335
|
+
* Pass `quoteData` and `correctingCode` from the response unchanged to the execute endpoints.
|
|
1336
|
+
*/
|
|
1337
|
+
getAlphaTradeQuote(params: GetAlphaTradeQuoteParamsV5): Promise<APIResponseV3WithTime<AlphaTradeQuoteResultV5>>;
|
|
1338
|
+
/**
|
|
1339
|
+
* Execute Purchase
|
|
1340
|
+
* Buy on-chain tokens with a payment token (e.g. USDT). Requires a valid quote; obtain user confirmation first.
|
|
1341
|
+
* HTTP 200 is only an acknowledgment — poll `getAlphaTradeOrderList` for final status. Idempotent by `quoteDataId` in the quote.
|
|
1342
|
+
*/
|
|
1343
|
+
executeAlphaTradePurchase(params: ExecuteAlphaTradeParamsV5): Promise<APIResponseV3WithTime<ExecuteAlphaTradeResultV5>>;
|
|
1344
|
+
/**
|
|
1345
|
+
* Execute Redeem
|
|
1346
|
+
* Sell on-chain tokens for a payment token. Requires a valid quote; obtain user confirmation first.
|
|
1347
|
+
* HTTP 200 is only an acknowledgment — poll `getAlphaTradeOrderList` for final status. Idempotent by `quoteDataId` in the quote.
|
|
1348
|
+
*/
|
|
1349
|
+
executeAlphaTradeRedeem(params: ExecuteAlphaTradeParamsV5): Promise<APIResponseV3WithTime<ExecuteAlphaTradeResultV5>>;
|
|
1350
|
+
/**
|
|
1351
|
+
* Get Payment Token List
|
|
1352
|
+
* List payment tokens (e.g. USDT) and CEX token codes (e.g. CEX_1) for quote and execution. Each entry includes `supportChains`.
|
|
1353
|
+
*/
|
|
1354
|
+
getAlphaPayTokenList(params: GetAlphaPayTokenListParamsV5): Promise<APIResponseV3WithTime<AlphaPayTokenV5[]>>;
|
|
1355
|
+
/**
|
|
1356
|
+
* Get Order List
|
|
1357
|
+
* On-chain trade order history; filters for trade type, status, token, and time. Max 90 days.
|
|
1358
|
+
*/
|
|
1359
|
+
getAlphaTradeOrderList(params: GetAlphaTradeOrderListParamsV5): Promise<APIResponseV3WithTime<AlphaTradeOrderListResultV5>>;
|
|
1360
|
+
/**
|
|
1361
|
+
* Get Biz Token List
|
|
1362
|
+
* Tradable on-chain tokens (DEX_ prefix ids), risk flags, limits, and supported payment token codes.
|
|
1363
|
+
*/
|
|
1364
|
+
getAlphaBizTokenList(params?: GetAlphaBizTokenListParamsV5): Promise<APIResponseV3WithTime<AlphaBizTokenV5[]>>;
|
|
1365
|
+
/**
|
|
1366
|
+
* Get Token Price List
|
|
1367
|
+
* Batch market data (up to 20 `chainCode` + `tokenAddress` pairs). Prices, 24h change, volume, market cap, etc.
|
|
1368
|
+
*/
|
|
1369
|
+
getAlphaBizTokenPriceList(params: GetAlphaBizTokenPriceListParamsV5): Promise<APIResponseV3WithTime<AlphaBizTokenPriceListResultV5>>;
|
|
1370
|
+
/**
|
|
1371
|
+
* Get Token Details
|
|
1372
|
+
* One token: description, links, `riskFlag`, and listing status. Use `chainCode` + `tokenAddress` from biz list or assets.
|
|
1373
|
+
*/
|
|
1374
|
+
getAlphaBizTokenDetails(params: GetAlphaBizTokenDetailsParamsV5): Promise<APIResponseV3WithTime<AlphaBizTokenDetailsV5>>;
|
|
1375
|
+
/**
|
|
1376
|
+
* Get Asset List
|
|
1377
|
+
* Portfolio of on-chain token holdings (non-zero only), sorted by USD value.
|
|
1378
|
+
*/
|
|
1379
|
+
getAlphaAssetList(): Promise<APIResponseV3WithTime<AlphaAssetListResultV5>>;
|
|
1380
|
+
/**
|
|
1381
|
+
* Get Asset Detail
|
|
1382
|
+
* Single-asset view; `result.assetList` has 0 or 1 item.
|
|
1383
|
+
*/
|
|
1384
|
+
getAlphaAssetDetail(params: GetAlphaAssetDetailParamsV5): Promise<APIResponseV3WithTime<AlphaAssetDetailResultV5>>;
|
|
1263
1385
|
/**
|
|
1264
1386
|
*
|
|
1265
1387
|
****** Spot Margin Trade APIs (UTA)
|
|
@@ -1292,6 +1414,13 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1292
1414
|
vipLevel: string;
|
|
1293
1415
|
}[];
|
|
1294
1416
|
}>>;
|
|
1417
|
+
/**
|
|
1418
|
+
* Get Currency Data
|
|
1419
|
+
* Borrowing currency data: flexible/fixed manual borrow, min qty, precision, interest rate range.
|
|
1420
|
+
*/
|
|
1421
|
+
getSpotMarginCurrencyData(params?: GetSpotMarginCurrencyDataParamsV5): Promise<APIResponseV3WithTime<{
|
|
1422
|
+
list: SpotMarginCurrencyDataV5[];
|
|
1423
|
+
}>>;
|
|
1295
1424
|
/**
|
|
1296
1425
|
* Turn spot margin trade on / off in your UTA account.
|
|
1297
1426
|
*
|
|
@@ -1345,6 +1474,10 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1345
1474
|
*
|
|
1346
1475
|
* IMPORTANT: Repayment is prohibited between 04:00 and 05:30 per hour.
|
|
1347
1476
|
* When repaying, system will only use the spot available balance of the debt currency.
|
|
1477
|
+
*
|
|
1478
|
+
* Use `getAvailableAmountToRepay` to check spot available amount. Response timing: ALL and FIXED
|
|
1479
|
+
* asynchronous; FLEXIBLE synchronous. From 2026-03-17 (full 2026-03-24), BYUSDT can be used for
|
|
1480
|
+
* repayment, including MNT using existing spot balance.
|
|
1348
1481
|
*/
|
|
1349
1482
|
manualRepayWithoutConversion(params: ManualRepayWithoutConversionParamsV5): Promise<APIResponseV3WithTime<ManualRepayWithoutConversionResultV5>>;
|
|
1350
1483
|
/**
|
|
@@ -1366,6 +1499,38 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
1366
1499
|
* - The amount of repayments is the minimum of available spot balance and liability
|
|
1367
1500
|
*/
|
|
1368
1501
|
setAutoRepayMode(params: SetAutoRepayModeParamsV5): Promise<APIResponseV3WithTime<AutoRepayModeResultV5>>;
|
|
1502
|
+
/**
|
|
1503
|
+
* Get Liability Info (spot margin UTA): fixed vs floating, spot vs derivatives borrow split.
|
|
1504
|
+
*/
|
|
1505
|
+
getSpotMarginLiability(params: GetSpotMarginLiabilityInfoParamsV5): Promise<APIResponseV3WithTime<SpotMarginLiabilityInfoV5>>;
|
|
1506
|
+
/**
|
|
1507
|
+
* Fixed-rate borrow (place order).
|
|
1508
|
+
*/
|
|
1509
|
+
submitFixedRateBorrow(params: FixedRateBorrowParamsV5): Promise<APIResponseV3WithTime<FixedRateBorrowResultV5>>;
|
|
1510
|
+
/**
|
|
1511
|
+
* Fixed-rate borrow order history (descending by order time).
|
|
1512
|
+
*/
|
|
1513
|
+
getFixedRateBorrowOrderInfo(params?: GetFixedRateBorrowOrderInfoParamsV5): Promise<APIResponseV3WithTime<{
|
|
1514
|
+
list: FixedRateBorrowOrderInfoV5[];
|
|
1515
|
+
nextPageCursor: string;
|
|
1516
|
+
}>>;
|
|
1517
|
+
/**
|
|
1518
|
+
* Fixed-rate borrow contract list (descending by borrow time).
|
|
1519
|
+
*/
|
|
1520
|
+
getFixedRateBorrowContractInfo(params?: GetFixedRateBorrowContractInfoParamsV5): Promise<APIResponseV3WithTime<{
|
|
1521
|
+
list: FixedRateBorrowContractInfoV5[];
|
|
1522
|
+
nextPageCursor: string;
|
|
1523
|
+
}>>;
|
|
1524
|
+
/**
|
|
1525
|
+
* Fixed-rate borrow order book quotes (sort by apy, term, or quantity).
|
|
1526
|
+
*/
|
|
1527
|
+
getFixedRateBorrowOrderQuote(params: GetFixedRateBorrowOrderQuoteParamsV5): Promise<APIResponseV3WithTime<{
|
|
1528
|
+
list: FixedRateBorrowQuoteV5[];
|
|
1529
|
+
}>>;
|
|
1530
|
+
/**
|
|
1531
|
+
* Renew a fixed-rate loan contract (full remaining amount if `qty` omitted).
|
|
1532
|
+
*/
|
|
1533
|
+
renewFixedRateBorrow(params: RenewFixedRateBorrowParamsV5): Promise<APIResponseV3WithTime<string>>;
|
|
1369
1534
|
/**
|
|
1370
1535
|
*
|
|
1371
1536
|
****** Spot Margin Trade APIs (Normal)
|
|
@@ -2069,6 +2234,79 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
2069
2234
|
}): Promise<APIResponseV3WithTime<{
|
|
2070
2235
|
list: EarnProductV5[];
|
|
2071
2236
|
}>>;
|
|
2237
|
+
/**
|
|
2238
|
+
* Get Advanced Earn product info (Dual Asset, Double Win, Smart Leverage, etc. via `category`).
|
|
2239
|
+
*
|
|
2240
|
+
* INFO: No authentication. Up to 50 requests/second per IP.
|
|
2241
|
+
*/
|
|
2242
|
+
getAdvanceEarnProduct(params: GetAdvanceEarnProductParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnAdvanceProductInfoV5>>;
|
|
2243
|
+
/**
|
|
2244
|
+
* Liquidity mining — product list (Advanced Earn).
|
|
2245
|
+
*
|
|
2246
|
+
* INFO: No authentication. Up to 50 requests/second per IP.
|
|
2247
|
+
*/
|
|
2248
|
+
getLiquidityMiningProduct(params?: GetLiquidityMiningProductParamsV5): Promise<APIResponseV3WithTime<LiquidityMiningProductResultV5>>;
|
|
2249
|
+
/**
|
|
2250
|
+
* Fixed-term / fixed saving — product list (Earn).
|
|
2251
|
+
*
|
|
2252
|
+
* INFO: No authentication. Up to 50 requests/second per IP.
|
|
2253
|
+
*/
|
|
2254
|
+
getFixedTermEarnProduct(params?: GetFixedTermEarnProductParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnProductListV5>>;
|
|
2255
|
+
/**
|
|
2256
|
+
* Advanced Earn — quote / extra info (Discount Buy, Dual Assets, …). Call before place order where required.
|
|
2257
|
+
*
|
|
2258
|
+
* INFO: No authentication. Up to 50 requests/second per IP.
|
|
2259
|
+
* Dual Assets: `productId` is required. Response uses `list` with `buyLowPrice` / `sellHighPrice`.
|
|
2260
|
+
*/
|
|
2261
|
+
getAdvanceEarnProductExtraInfo(params: GetAdvanceEarnProductExtraInfoParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnProductExtraInfoV5>>;
|
|
2262
|
+
/**
|
|
2263
|
+
* Advanced Earn — place order (Dual Assets, Discount Buy, …). Async; use getAdvanceEarnOrder to track.
|
|
2264
|
+
*
|
|
2265
|
+
* INFO: API key needs "Earn" permission. Rate limit e.g. 5 req/s (Dual Assets per docs).
|
|
2266
|
+
*/
|
|
2267
|
+
submitAdvanceEarnPlaceOrder(params: SubmitAdvanceEarnPlaceOrderParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnPlaceOrderResultV5>>;
|
|
2268
|
+
/**
|
|
2269
|
+
* Advanced Earn — active positions (Dual Assets, Discount Buy, …).
|
|
2270
|
+
*
|
|
2271
|
+
* INFO: API key needs "Earn" permission. E.g. 10 req/s (Dual Assets per docs).
|
|
2272
|
+
*/
|
|
2273
|
+
getAdvanceEarnPosition(params: GetAdvanceEarnPositionListParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnPositionListV5>>;
|
|
2274
|
+
/**
|
|
2275
|
+
* Advanced Earn — order list (Dual Assets, Discount Buy, …). Distinct from getEarnOrderHistory (/v5/earn/order).
|
|
2276
|
+
*
|
|
2277
|
+
* INFO: API key needs "Earn" permission. E.g. 10 req/s (Dual Assets per docs).
|
|
2278
|
+
*/
|
|
2279
|
+
getAdvanceEarnOrder(params: GetAdvanceEarnOrderListParamsV5): Promise<APIResponseV3WithTime<AdvanceEarnOrderListV5>>;
|
|
2280
|
+
/**
|
|
2281
|
+
* Fixed-term earn — place order (stake). Async; use getFixedTermEarnOrder to track.
|
|
2282
|
+
*
|
|
2283
|
+
* INFO: API key needs "Earn" permission. Rate limit: 5 req/s.
|
|
2284
|
+
*/
|
|
2285
|
+
submitFixedTermEarnOrder(params: SubmitFixedTermEarnOrderParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnPlaceOrderResultV5>>;
|
|
2286
|
+
/**
|
|
2287
|
+
* Fixed-term earn — early redeem (FundPool only, when product allows).
|
|
2288
|
+
*
|
|
2289
|
+
* INFO: API key needs "Earn" permission. Rate limit: 5 req/s.
|
|
2290
|
+
*/
|
|
2291
|
+
redeemFixedTermEarn(params: RedeemFixedTermEarnParamsV5): Promise<APIResponseV3WithTime<RedeemFixedTermEarnResultV5>>;
|
|
2292
|
+
/**
|
|
2293
|
+
* Fixed-term earn — active positions.
|
|
2294
|
+
*
|
|
2295
|
+
* INFO: API key needs "Earn" permission. Rate limit: 10 req/s.
|
|
2296
|
+
*/
|
|
2297
|
+
getFixedTermEarnPosition(params?: GetFixedTermEarnPositionParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnPositionListV5>>;
|
|
2298
|
+
/**
|
|
2299
|
+
* Fixed-term earn — order list.
|
|
2300
|
+
*
|
|
2301
|
+
* INFO: API key needs "Earn" permission. Rate limit: 10 req/s.
|
|
2302
|
+
*/
|
|
2303
|
+
getFixedTermEarnOrder(params?: GetFixedTermEarnOrderListParamsV5): Promise<APIResponseV3WithTime<FixedTermEarnOrderListV5>>;
|
|
2304
|
+
/**
|
|
2305
|
+
* Fixed-term earn — enable or disable auto-invest on a position.
|
|
2306
|
+
*
|
|
2307
|
+
* INFO: API key needs "Earn" permission. Rate limit: 5 req/s.
|
|
2308
|
+
*/
|
|
2309
|
+
setFixedTermEarnAutoInvest(params: SetFixedTermEarnAutoInvestParamsV5): Promise<APIResponseV3WithTime<Record<string, never>>>;
|
|
2072
2310
|
/**
|
|
2073
2311
|
* Stake or Redeem Earn products
|
|
2074
2312
|
*
|
|
@@ -2103,14 +2341,23 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
2103
2341
|
* INFO: API key needs "Earn" permission
|
|
2104
2342
|
*
|
|
2105
2343
|
* Note: Fully redeemed position is also returned in the response
|
|
2344
|
+
* Note: Response includes `autoReinvest` where applicable; use `modifyEarnPosition` to change it (OnChain fixed).
|
|
2106
2345
|
*/
|
|
2107
2346
|
getEarnPosition(params: GetEarnPositionParamsV5): Promise<APIResponseV3WithTime<{
|
|
2108
2347
|
list: EarnPositionV5[];
|
|
2109
2348
|
}>>;
|
|
2349
|
+
/**
|
|
2350
|
+
* Modify OnChain Earn position (e.g. auto-reinvest for fixed duration products).
|
|
2351
|
+
*
|
|
2352
|
+
* INFO: API key needs "Earn" permission. Only `category=OnChain` and fixed positions (see product).
|
|
2353
|
+
*/
|
|
2354
|
+
modifyEarnPosition(params: ModifyEarnPositionParamsV5): Promise<APIResponseV3WithTime<Record<string, never>>>;
|
|
2110
2355
|
/**
|
|
2111
2356
|
* Get Yield History
|
|
2112
2357
|
*
|
|
2113
2358
|
* INFO: API key needs "Earn" permission
|
|
2359
|
+
*
|
|
2360
|
+
* Note: `category` includes `OnChain`. For `OnChain`, do not pass `productId` (error).
|
|
2114
2361
|
*/
|
|
2115
2362
|
getEarnYieldHistory(params: GetEarnYieldHistoryParamsV5): Promise<APIResponseV3WithTime<{
|
|
2116
2363
|
yield: EarnYieldHistoryV5[];
|
|
@@ -2125,6 +2372,83 @@ export declare class RestClientV5 extends BaseRestClient {
|
|
|
2125
2372
|
list: EarnHourlyYieldHistoryV5[];
|
|
2126
2373
|
nextPageCursor: string;
|
|
2127
2374
|
}>>;
|
|
2375
|
+
/**
|
|
2376
|
+
* Get historical APR (FlexibleSaving / OnChain), up to ~6 months.
|
|
2377
|
+
*
|
|
2378
|
+
* INFO: Does not need authentication
|
|
2379
|
+
*/
|
|
2380
|
+
getEarnAprHistory(params: GetEarnAprHistoryParamsV5): Promise<APIResponseV3WithTime<{
|
|
2381
|
+
list: EarnAprHistoryPointV5[];
|
|
2382
|
+
}>>;
|
|
2383
|
+
/**
|
|
2384
|
+
* Earn token product (e.g. BYUSDT) — Get Product Info
|
|
2385
|
+
* Without auth, user-specific fields are empty or defaulted.
|
|
2386
|
+
*/
|
|
2387
|
+
getEarnTokenProduct(params: GetEarnTokenProductParamsV5): Promise<APIResponseV3WithTime<EarnTokenProductV5>>;
|
|
2388
|
+
/**
|
|
2389
|
+
* Earn token — Place Order (Mint / Redeem). Accepted response is not final settlement; use `getEarnTokenOrders`.
|
|
2390
|
+
*/
|
|
2391
|
+
submitEarnTokenOrder(params: PlaceEarnTokenOrderParamsV5): Promise<APIResponseV3WithTime<PlaceEarnTokenOrderResultV5>>;
|
|
2392
|
+
/**
|
|
2393
|
+
* Earn token — Get Order List
|
|
2394
|
+
*/
|
|
2395
|
+
getEarnTokenOrders(params: GetEarnTokenOrderListParamsV5): Promise<APIResponseV3WithTime<{
|
|
2396
|
+
list: EarnTokenOrderV5[];
|
|
2397
|
+
nextPageCursor: string;
|
|
2398
|
+
}>>;
|
|
2399
|
+
/**
|
|
2400
|
+
* Earn token — Get Position Info
|
|
2401
|
+
*/
|
|
2402
|
+
getEarnTokenPosition(params: GetEarnTokenPositionParamsV5): Promise<APIResponseV3WithTime<EarnTokenPositionV5>>;
|
|
2403
|
+
/**
|
|
2404
|
+
* Earn token — Get Daily Yield Records
|
|
2405
|
+
*/
|
|
2406
|
+
getEarnTokenDailyYield(params: GetEarnTokenDailyYieldParamsV5): Promise<APIResponseV3WithTime<{
|
|
2407
|
+
list: EarnTokenDailyYieldRecordV5[];
|
|
2408
|
+
nextPageCursor: string;
|
|
2409
|
+
}>>;
|
|
2410
|
+
/**
|
|
2411
|
+
* Earn token — Get Hourly Yield Records
|
|
2412
|
+
*/
|
|
2413
|
+
getEarnTokenHourlyYield(params: GetEarnTokenHourlyYieldParamsV5): Promise<APIResponseV3WithTime<{
|
|
2414
|
+
list: EarnTokenHourlyYieldRecordV5[];
|
|
2415
|
+
nextPageCursor: string;
|
|
2416
|
+
}>>;
|
|
2417
|
+
/**
|
|
2418
|
+
* Earn token — Get History APR (7/30/180 days). No authentication required.
|
|
2419
|
+
*/
|
|
2420
|
+
getEarnTokenHistoryApr(params: GetEarnTokenHistoryAprParamsV5): Promise<APIResponseV3WithTime<{
|
|
2421
|
+
list: EarnTokenHistoryAprPointV5[];
|
|
2422
|
+
}>>;
|
|
2423
|
+
/**
|
|
2424
|
+
*
|
|
2425
|
+
****** Bybit Card APIs
|
|
2426
|
+
*
|
|
2427
|
+
*/
|
|
2428
|
+
/**
|
|
2429
|
+
* Bybit Card — query card transaction / asset history (filter by status, card digits, merchant, time, type, …).
|
|
2430
|
+
*/
|
|
2431
|
+
queryCardAssetRecords(params?: QueryCardAssetRecordsParamsV5): Promise<APIResponseV3WithTime<CardAssetRecordsResultV5>>;
|
|
2432
|
+
/**
|
|
2433
|
+
* Bybit Card — point balance (available, pending, account status, …).
|
|
2434
|
+
*/
|
|
2435
|
+
queryCardPointsBalance(): Promise<APIResponseV3WithTime<CardPointBalanceV5>>;
|
|
2436
|
+
/**
|
|
2437
|
+
* Bybit Card — point transaction records.
|
|
2438
|
+
*/
|
|
2439
|
+
queryCardPointsRecords(params?: QueryCardPointRecordsParamsV5): Promise<APIResponseV3WithTime<CardPointRecordsResultV5>>;
|
|
2440
|
+
/**
|
|
2441
|
+
* Bybit Card — reward tier, spending limit, auto cashback.
|
|
2442
|
+
*/
|
|
2443
|
+
queryCardPointsTier(): Promise<APIResponseV3WithTime<CardPointTierInfoV5>>;
|
|
2444
|
+
/**
|
|
2445
|
+
* Bybit Card — reward mall item list.
|
|
2446
|
+
*/
|
|
2447
|
+
queryCardMallItemList(params?: QueryCardMallItemListParamsV5): Promise<APIResponseV3WithTime<CardMallItemListResultV5>>;
|
|
2448
|
+
/**
|
|
2449
|
+
* Bybit Card — cashback detail for a reward order.
|
|
2450
|
+
*/
|
|
2451
|
+
queryCardPointCashbackDetail(params: QueryCardPointCashbackDetailParamsV5): Promise<APIResponseV3WithTime<CardPointCashbackDetailV5>>;
|
|
2128
2452
|
/**
|
|
2129
2453
|
*
|
|
2130
2454
|
****** RFQ APIs
|