Merge pull request #449 from JJ-Cro/RelNotes9_9_2024

v2.13.3: feat(): Added new convert and PMPro endpoints
tiagosiebler · Sep 9, 2024 · 55e6b0b · 55e6b0b
2 parents 4493db5 + f1fca6b
commit 55e6b0b
Show file tree

Hide file tree

Showing 7 changed files with 131 additions and 11 deletions.
diff --git a/docs/endpointFunctionList.md b/docs/endpointFunctionList.md
@@ -369,6 +369,7 @@ This table includes all endpoints from the official Exchange API docs and corres
 | `getPortfolioMarginIndexPrice()` |  | GET | `sapi/v1/portfolio/asset-index-price` |
 | `getPortfolioMarginAssetLeverage()` | :closed_lock_with_key:  | GET | `sapi/v1/portfolio/margin-asset-leverage` |
 | `getPortfolioMarginProCollateralRate()` |  | GET | `sapi/v1/portfolio/collateralRate` |
+| `getPortfolioMarginProTieredCollateralRate()` |  | GET | `sapi/v2/portfolio/collateralRate` |
 | `getPortfolioMarginProAccountInfo()` | :closed_lock_with_key:  | GET | `sapi/v1/portfolio/account` |
 | `bnbTransfer()` | :closed_lock_with_key:  | POST | `sapi/v1/portfolio/bnb-transfer` |
 | `submitPortfolioMarginProFullTransfer()` | :closed_lock_with_key:  | POST | `sapi/v1/portfolio/auto-collection` |
@@ -534,6 +535,10 @@ This table includes all endpoints from the official Exchange API docs and corres
 | `setBNBBurnEnabled()` | :closed_lock_with_key:  | POST | `fapi/v1/feeBurn` |
 | `getBNBBurnStatus()` | :closed_lock_with_key:  | GET | `fapi/v1/feeBurn` |
 | `testOrder()` | :closed_lock_with_key:  | POST | `fapi/v1/order/test` |
+| `getAllConvertPairs()` |  | GET | `fapi/v1/convert/exchangeInfo` |
+| `submitConvertQuoteRequest()` | :closed_lock_with_key:  | POST | `fapi/v1/convert/getQuote` |
+| `acceptConvertQuote()` | :closed_lock_with_key:  | POST | `fapi/v1/convert/acceptQuote` |
+| `getConvertOrderStatus()` | :closed_lock_with_key:  | GET | `fapi/v1/convert/orderStatus` |
 | `getPortfolioMarginProAccountInfo()` | :closed_lock_with_key:  | GET | `fapi/v1/pmAccountInfo` |
 | `getBrokerIfNewFuturesUser()` | :closed_lock_with_key:  | GET | `fapi/v1/apiReferral/ifNewUser` |
 | `setBrokerCustomIdForClient()` | :closed_lock_with_key:  | POST | `fapi/v1/apiReferral/customization` |

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "binance",
-  "version": "2.13.2",
+  "version": "2.13.3",
   "description": "Node.js & JavaScript SDK for Binance REST APIs & WebSockets, with TypeScript & end-to-end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

diff --git a/src/main-client.ts b/src/main-client.ts
@@ -3080,19 +3080,23 @@ export class MainClient extends BaseRestClient {
     return this.getPrivate('sapi/v1/portfolio/margin-asset-leverage');
   }
 
+  getPortfolioMarginProCollateralRate(): Promise<
+    GetPortfolioMarginProCollateralRateResponse[]
+  > {
+    return this.get('sapi/v1/portfolio/collateralRate');
+  }
+
+  getPortfolioMarginProTieredCollateralRate(): Promise<any[]> {
+    return this.get('sapi/v2/portfolio/collateralRate');
+  }
+
   /**
    *
    * DERIVATIVES - Portfolio Margin Pro - Account
    * This is in mainclient because it shares the same base url
    *
    **/
 
-  getPortfolioMarginProCollateralRate(): Promise<
-    GetPortfolioMarginProCollateralRateResponse[]
-  > {
-    return this.get('sapi/v1/portfolio/collateralRate');
-  }
-
   getPortfolioMarginProAccountInfo(): Promise<GetPortfolioMarginProAccountInfoResponse> {
     return this.getPrivate('sapi/v1/portfolio/account');
   }

diff --git a/src/types/futures.ts b/src/types/futures.ts
@@ -870,3 +870,41 @@ export interface PortfolioMarginProAccountInfo {
   asset: string;
   maxWithdrawAmount: string; // This field will be ignored in the response
 }
+
+export interface FuturesConvertPair {
+  fromAsset: string;
+  toAsset: string;
+  fromAssetMinAmount: string;
+  fromAssetMaxAmount: string;
+  toAssetMinAmount: string;
+  toAssetMaxAmount: string;
+}
+
+export interface FuturesConvertQuoteRequest {
+  fromAsset: string;
+  toAsset: string;
+  fromAmount?: number;
+  toAmount?: number;
+  validTime?: '10s' | '30s' | '1m' | '2m';
+}
+
+export interface FuturesConvertQuote {
+  quoteId: string;
+  ratio: string;
+  inverseRatio: string;
+  validTimestamp: number;
+  toAmount: string;
+  fromAmount: string;
+}
+
+export interface FuturesConvertOrderStatus {
+  orderId: string;
+  orderStatus: 'PROCESS' | 'ACCEPT_SUCCESS' | 'SUCCESS' | 'FAIL';
+  fromAsset: string;
+  fromAmount: string;
+  toAsset: string;
+  toAmount: string;
+  ratio: string;
+  inverseRatio: string;
+  createTime: number;
+}
diff --git a/src/types/websockets.ts b/src/types/websockets.ts
@@ -50,7 +50,8 @@ export type WsMessageFuturesUserDataEventRaw =
   | WsMessageFuturesUserDataMarginCallRaw
   | WsMessageFuturesUserDataOrderTradeUpdateEventRaw
   | WsMessageFuturesUserDataAccountConfigUpdateEventRaw
-  | WsMessageFuturesUserDataCondOrderTriggerRejectEventRaw;
+  | WsMessageFuturesUserDataCondOrderTriggerRejectEventRaw
+  | WsMessageFuturesUserDataTradeLiteEventRaw;
 
 // TODO: consistent across USDM vs COINM?
 export type WsMessageFuturesUserDataEventFormatted =
@@ -59,7 +60,8 @@ export type WsMessageFuturesUserDataEventFormatted =
   | WsMessageFuturesUserDataMarginCallFormatted
   | WsMessageFuturesUserDataTradeUpdateEventFormatted
   | WsMessageFuturesUserDataAccountConfigUpdateEventFormatted
-  | WsMessageFuturesUserDataCondOrderTriggerRejectEventFormatted;
+  | WsMessageFuturesUserDataCondOrderTriggerRejectEventFormatted
+  | WsMessageFuturesUserDataTradeLiteEventFormatted;
 
 export type WsRawMessage =
   | WsMessageKlineRaw
@@ -755,6 +757,39 @@ export interface WsMessageFuturesUserDataOrderTradeUpdateEventRaw
     ss: numberInString; // ignore
   };
 }
+export interface WsMessageFuturesUserDataTradeLiteEventRaw
+  extends WsSharedBase {
+  e: 'TRADE_LITE'; // Event Type
+  E: number; // Event Time
+  T: number; // Transaction Time
+  s: string; // Symbol
+  q: string; // Original Quantity
+  p: string; // Original Price
+  m: boolean; // Is this trade the maker side?
+  c: string; // Client Order Id
+  S: 'BUY' | 'SELL'; // Side
+  L: string; // Last Filled Price
+  l: string; // Order Last Filled Quantity
+  t: number; // Trade Id
+  i: number; // Order Id
+}
+
+export interface WsMessageFuturesUserDataTradeLiteEventFormatted
+  extends WsSharedBase {
+  eventType: 'TRADE_LITE';
+  eventTime: number;
+  transactionTime: number;
+  symbol: string;
+  originalQuantity: number;
+  originalPrice: number;
+  isMakerSide: boolean;
+  clientOrderId: string;
+  side: 'BUY' | 'SELL';
+  lastFilledPrice: number;
+  lastFilledQuantity: number;
+  tradeId: number;
+  orderId: number;
+}
 
 export interface WsMessageFuturesUserDataTradeUpdateEventFormatted
   extends WsSharedBase {

diff --git a/src/usdm-client.ts b/src/usdm-client.ts
@@ -80,6 +80,10 @@ import {
   FuturesAccountConfig,
   SymbolConfig,
   UserForceOrder,
+  FuturesConvertPair,
+  FuturesConvertQuote,
+  FuturesConvertOrderStatus,
+  FuturesConvertQuoteRequest,
 } from './types/futures';
 
 import {
@@ -594,6 +598,40 @@ export class USDMClient extends BaseRestClient {
     return this.postPrivate('fapi/v1/order/test', params);
   }
 
+  /**
+   *
+   * Convert Endpoints
+   *
+   **/
+
+  getAllConvertPairs(params?: {
+    fromAsset?: string;
+    toAsset?: string;
+  }): Promise<FuturesConvertPair[]> {
+    return this.get('fapi/v1/convert/exchangeInfo', params);
+  }
+
+  submitConvertQuoteRequest(
+    params: FuturesConvertQuoteRequest,
+  ): Promise<FuturesConvertQuote> {
+    return this.postPrivate('fapi/v1/convert/getQuote', params);
+  }
+
+  acceptConvertQuote(params: { quoteId: string }): Promise<{
+    orderId: string;
+    createTime: number;
+    orderStatus: 'PROCESS' | 'ACCEPT_SUCCESS' | 'SUCCESS' | 'FAIL';
+  }> {
+    return this.postPrivate('fapi/v1/convert/acceptQuote', params);
+  }
+
+  getConvertOrderStatus(params: {
+    orderId?: string;
+    quoteId?: string;
+  }): Promise<FuturesConvertOrderStatus> {
+    return this.getPrivate('fapi/v1/convert/orderStatus', params);
+  }
+
   /**
    *
    * Portfolio Margin Pro Endpoints