Merge pull request tiagosiebler#504 from JJ-Cro/master

feat(v4.4.2): Update full release notes since 1st October

Author: tiagosiebler

docs/endpointFunctionList.md

@@ -1,6 +1,6 @@
 {
   "name": "bybit-api",
-  "version": "4.4.1",
+  "version": "4.4.2",
   "description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

llms.txt

@@ -4,6 +4,7 @@ import {
   AccountBorrowCollateralLimitV5,
   AccountCoinBalanceV5,
   AccountInfoV5,
+  AccountInstrumentInfoResponseV5,
   AccountMarginModeV5,
   AccountOrderV5,
   AccountTypeV5,
@@ -22,6 +23,7 @@ import {
   APIResponseV3,
   APIResponseV3WithTime,
   AssetInfoV5,
+  AvailableAmountToRepayV5,
   BatchAmendOrderParamsV5,
   BatchAmendOrderResultV5,
   BatchCancelOrderParamsV5,
@@ -59,6 +61,7 @@ import {
   CoinExchangeRecordV5,
   CoinGreeksV5,
   CoinInfoV5,
+  CoinStateV5,
   CollateralAdjustmentHistoryV5,
   CollateralDataV5,
   CollateralInfoV5,
@@ -83,6 +86,7 @@ import {
   CreateSupplyOrderFixedParamsV5,
   CreateSupplyOrderFixedV5,
   CryptoLoanPositionV5,
+  CurrencyPositionTiersV5,
   CursorListV5,
   CursorRowsV5,
   DCPInfoV5,
@@ -91,9 +95,11 @@ import {
   DeliveryRecordV5,
   DepositAddressChainV5,
   DepositRecordV5,
+  EarnHourlyYieldHistoryV5,
   EarnOrderHistoryV5,
   EarnPositionV5,
   EarnProductV5,
+  EarnYieldHistoryV5,
   ExchangeBrokerAccountInfoV5,
   ExchangeBrokerEarningResultV5,
   ExchangeBrokerSubAccountDepositRecordV5,
@@ -105,11 +111,14 @@ import {
   FundingRateHistoryResponseV5,
   GetAccountCoinBalanceParamsV5,
   GetAccountHistoricOrdersParamsV5,
+  GetAccountInstrumentsInfoParamsV5,
   GetAccountOrdersParamsV5,
   GetADLAlertParamsV5,
+  GetAffiliateUserListParamsV5,
   GetAllCoinsBalanceParamsV5,
   GetAllowedDepositCoinInfoParamsV5,
   GetAssetInfoParamsV5,
+  GetAvailableAmountToRepayParamsV5,
   GetBorrowableCoinsParamsV5,
   GetBorrowContractInfoFixedParamsV5,
   GetBorrowHistoryFlexibleParamsV5,
@@ -122,15 +131,18 @@ import {
   GetClosedOptionsPositionsParamsV5,
   GetClosedPnLParamsV5,
   GetCoinExchangeRecordParamsV5,
+  GetCoinStateParamsV5,
   GetCollateralAdjustmentHistoryParamsV5,
   GetCollateralCoinsParamsV5,
   GetCompletedLoanOrderHistoryParamsV5,
   GetConvertHistoryParamsV5,
   GetDeliveryPriceParamsV5,
   GetDeliveryRecordParamsV5,
   GetDepositRecordParamsV5,
+  GetEarnHourlyYieldHistoryParamsV5,
   GetEarnOrderHistoryParamsV5,
   GetEarnPositionParamsV5,
+  GetEarnYieldHistoryParamsV5,
   GetExchangeBrokerEarningsParamsV5,
   GetExecutionListParamsV5,
   GetFeeGroupStructureParamsV5,
@@ -147,6 +159,7 @@ import {
   GetLoanLTVAdjustmentHistoryParamsV5,
   GetLongShortRatioParamsV5,
   GetMarkPriceKlineParamsV5,
+  GetMaxBorrowableAmountParamsV5,
   GetMaxCollateralAmountParamsV5,
   GetMovePositionHistoryParamsV5,
   GetOngoingFlexibleLoansParamsV5,
@@ -160,6 +173,7 @@ import {
   GetP2POrdersParamsV5,
   GetP2PPendingOrdersParamsV5,
   GetP2PPersonalAdsParamsV5,
+  GetPositionTiersParamsV5,
   GetPremiumIndexPriceKlineParamsV5,
   GetPreUpgradeClosedPnlParamsV5,
   GetPreUpgradeOptionDeliveryRecordParamsV5,
@@ -197,6 +211,7 @@ import {
   GetUnpaidLoanOrdersParamsV5,
   GetVIPMarginDataParamsV5,
   GetWalletBalanceParamsV5,
+  GetWithdrawalAddressListParamsV5,
   GetWithdrawalRecordsParamsV5,
   HistoricalVolatilityV5,
   IndexPriceComponentsResponseV5,
@@ -207,7 +222,14 @@ import {
   IssueVoucherParamsV5,
   LoanLTVAdjustmentHistoryV5,
   LongShortRatioV5,
+  ManualBorrowParamsV5,
+  ManualBorrowResultV5,
+  ManualRepayParamsV5,
+  ManualRepayResultV5,
+  ManualRepayWithoutConversionParamsV5,
+  ManualRepayWithoutConversionResultV5,
   MarkP2POrderAsPaidParamsV5,
+  MaxBorrowableAmountV5,
   MMPModifyParamsV5,
   MMPStateV5,
   MovePositionHistoryV5,
@@ -267,6 +289,7 @@ import {
   SetLimitPriceActionParamsV5,
   SetRiskLimitParamsV5,
   SetRiskLimitResultV5,
+  SetSpotMarginLeverageParamsV5,
   SettlementRecordV5,
   SetTPSLModeParamsV5,
   SetTradingStopParamsV5,
@@ -306,6 +329,7 @@ import {
   VIPMarginDataV5,
   WalletBalanceV5,
   WithdrawableAmountV5,
+  WithdrawalAddressV5,
   WithdrawalRecordV5,
   WithdrawParamsV5,
 } from './types';
@@ -1444,6 +1468,20 @@ export class RestClientV5 extends BaseRestClient {
     return this.getPrivate('/v5/account/withdrawal', params);
   }
 
+  /**
+   * Get Account Instruments Info
+   * Query for the instrument specification of online trading pairs that available to users.
+   *
+   * Covers: SPOT / USDT contract / USDC contract / Inverse contract
+   *
+   * Includes RPI permission information (isPublicRpi, myRpiPermission)
+   */
+  getAccountInstrumentsInfo<C extends 'spot' | 'linear' | 'inverse'>(
+    params: GetAccountInstrumentsInfoParamsV5 & { category: C },
+  ): Promise<APIResponseV3WithTime<AccountInstrumentInfoResponseV5<C>>> {
+    return this.getPrivate('/v5/account/instruments-info', params);
+  }
+
   /**
    * Upgrade to unified account.
    *
@@ -1480,6 +1518,23 @@ export class RestClientV5 extends BaseRestClient {
     return this.postPrivate('/v5/account/quick-repayment', params);
   }
 
+  /**
+   * Manual Repay
+   *
+   * If neither coin nor amount is passed, then repay all the liabilities.
+   * If coin is passed and amount is not, the coin will be repaid in full.
+   *
+   * When repaying, the system will first use the spot available balance of the debt currency.
+   * If that's not enough, the remaining amount will be repaid by converting other assets.
+   *
+   * Repayment is prohibited between 04:00 and 05:30 per hour.
+   */
+  manualRepay(
+    params?: ManualRepayParamsV5,
+  ): Promise<APIResponseV3WithTime<ManualRepayResultV5>> {
+    return this.postPrivate('/v5/account/repay', params);
+  }
+
   /**
    * You can decide whether the assets in the Unified account needs to be collateral coins.
    */
@@ -2012,6 +2067,21 @@ export class RestClientV5 extends BaseRestClient {
     return this.getPrivate('/v5/asset/withdraw/query-record', params);
   }
 
+  /**
+   * Get Withdrawal Address List
+   * Query the withdrawal addresses in the address book.
+   *
+   * TIP: The API key for querying this endpoint must have withdrawal permissions.
+   */
+  getWithdrawalAddressList(params?: GetWithdrawalAddressListParamsV5): Promise<
+    APIResponseV3WithTime<{
+      rows: WithdrawalAddressV5[];
+      nextPageCursor: string;
+    }>
+  > {
+    return this.getPrivate('/v5/asset/withdraw/query-address', params);
+  }
+
   /**
    * Get Exchange Entity List.
    *
@@ -2291,7 +2361,7 @@ export class RestClientV5 extends BaseRestClient {
    * - Use master UID only
    * - The api key can only have "Affiliate" permission
    */
-  getAffiliateUserList(params?: { size?: number; cursor?: string }): Promise<
+  getAffiliateUserList(params?: GetAffiliateUserListParamsV5): Promise<
     APIResponseV3WithTime<{
       list: AffiliateUserListItemV5[];
       nextPageCursor: string;
@@ -2377,13 +2447,22 @@ export class RestClientV5 extends BaseRestClient {
   }
 
   /**
-   * Set the user's maximum leverage in spot cross margin.
-   * CAUTION: Your account needs to enable spot margin first; i.e., you must have finished the quiz on web / app.
+   * @deprecated Use setSpotMarginLeverageV2 instead, which uses an object parameter instead. This method will be replaced by setSpotMarginLeverageV2 in a future release.
    */
   setSpotMarginLeverage(leverage: string): Promise<APIResponseV3WithTime<{}>> {
     return this.postPrivate('/v5/spot-margin-trade/set-leverage', { leverage });
   }
 
+  /**
+   * Set the user's maximum leverage in spot cross margin.
+   * CAUTION: Your account needs to enable spot margin first; i.e., you must have finished the quiz on web / app.
+   */
+  setSpotMarginLeverageV2(
+    params: SetSpotMarginLeverageParamsV5,
+  ): Promise<APIResponseV3WithTime<{}>> {
+    return this.postPrivate('/v5/spot-margin-trade/set-leverage', params);
+  }
+
   /**
    * Query the Spot margin status and leverage of Unified account.
    *
@@ -2393,6 +2472,70 @@ export class RestClientV5 extends BaseRestClient {
     return this.getPrivate('/v5/spot-margin-trade/state');
   }
 
+  /**
+   * Manual borrow for UTA
+   */
+  manualBorrow(
+    params: ManualBorrowParamsV5,
+  ): Promise<APIResponseV3WithTime<ManualBorrowResultV5>> {
+    return this.postPrivate('/v5/account/borrow', params);
+  }
+
+  /**
+   * Get max borrowable amount
+   */
+  getMaxBorrowableAmount(
+    params: GetMaxBorrowableAmountParamsV5,
+  ): Promise<APIResponseV3WithTime<MaxBorrowableAmountV5>> {
+    return this.getPrivate('/v5/spot-margin-trade/max-borrowable', params);
+  }
+
+  /**
+   * Get loan position risk information (position tiers)
+   */
+  getPositionTiers(params?: GetPositionTiersParamsV5): Promise<
+    APIResponseV3WithTime<{
+      list: CurrencyPositionTiersV5[];
+    }>
+  > {
+    return this.getPrivate('/v5/spot-margin-trade/position-tiers', params);
+  }
+
+  /**
+   * Get currency leverage information (coin state)
+   */
+  getCoinState(params?: GetCoinStateParamsV5): Promise<
+    APIResponseV3WithTime<{
+      list: CoinStateV5[];
+    }>
+  > {
+    return this.getPrivate('/v5/spot-margin-trade/coinstate', params);
+  }
+
+  /**
+   * Get available amount to repay
+   */
+  getAvailableAmountToRepay(
+    params: GetAvailableAmountToRepayParamsV5,
+  ): Promise<APIResponseV3WithTime<AvailableAmountToRepayV5>> {
+    return this.getPrivate(
+      '/v5/spot-margin-trade/repayment-available-amount',
+      params,
+    );
+  }
+
+  /**
+   * Manual repay without asset conversion
+   *
+   * IMPORTANT: Repayment is prohibited between 04:00 and 05:30 per hour.
+   * When repaying, system will only use the spot available balance of the debt currency.
+   */
+  manualRepayWithoutConversion(
+    params: ManualRepayWithoutConversionParamsV5,
+  ): Promise<APIResponseV3WithTime<ManualRepayWithoutConversionResultV5>> {
+    return this.postPrivate('/v5/account/no-convert-repay', params);
+  }
+
   /**
    *
    ****** Spot Margin Trade APIs (Normal)
@@ -3357,12 +3500,15 @@ export class RestClientV5 extends BaseRestClient {
    *
    * INFO: API key needs "Earn" permission
    *
-   * Note: Either orderId or orderLinkId is required. If both are passed,
-   * make sure they're matched, otherwise returning empty result
+   * Note:
+   * - For category = OnChain, either orderId or orderLinkId is required
+   * - If both are passed, make sure they're matched, otherwise returning empty result
+   * - Supports batch query with productId, startTime, endTime, limit, cursor
    */
   getEarnOrderHistory(params: GetEarnOrderHistoryParamsV5): Promise<
     APIResponseV3WithTime<{
       list: EarnOrderHistoryV5[];
+      nextPageCursor: string;
     }>
   > {
     return this.getPrivate('/v5/earn/order', params);
@@ -3383,6 +3529,34 @@ export class RestClientV5 extends BaseRestClient {
     return this.getPrivate('/v5/earn/position', params);
   }
 
+  /**
+   * Get Yield History
+   *
+   * INFO: API key needs "Earn" permission
+   */
+  getEarnYieldHistory(params: GetEarnYieldHistoryParamsV5): Promise<
+    APIResponseV3WithTime<{
+      yield: EarnYieldHistoryV5[];
+      nextPageCursor: string;
+    }>
+  > {
+    return this.getPrivate('/v5/earn/yield', params);
+  }
+
+  /**
+   * Get Hourly Yield History
+   *
+   * INFO: API key needs "Earn" permission
+   */
+  getEarnHourlyYieldHistory(params: GetEarnHourlyYieldHistoryParamsV5): Promise<
+    APIResponseV3WithTime<{
+      list: EarnHourlyYieldHistoryV5[];
+      nextPageCursor: string;
+    }>
+  > {
+    return this.getPrivate('/v5/earn/hourly-yield', params);
+  }
+
   /**
    *
    ****** RFQ APIs