type return type

Author: carlosmiei

examples/oco-order.ts

@@ -29,7 +29,9 @@ async function main() {
     }
 
     const oco1 = await binance.ocoOrder(side, symbol, quantity, params);
-    console.log('oco1', oco1);
+    console.log('oco1', oco1.orderListId);
+    console.log(oco1.orderReports[0].orderId)
+    console.log(oco1.orderReports[1].orderId)
 
 }
 

src/node-binance-api.ts

@@ -16,7 +16,7 @@ import nodeFetch from 'node-fetch';
 import zip from 'lodash.zipobject';
 import stringHash from 'string-hash';
 // eslint-disable-next-line
-import { Interval, PositionRisk, Order, FuturesOrder, PositionSide, WorkingType, OrderType, OrderStatus, TimeInForce, Callback, IConstructorArgs, OrderSide, FundingRate, CancelOrder, AggregatedTrade, Trade, MyTrade, WithdrawHistoryResponse, DepositHistoryResponse, DepositAddress, WithdrawResponse, Candle, FuturesCancelAllOpenOrder, OrderBook, Ticker, FuturesUserTrade, Account, FuturesAccountInfo, FuturesBalance, QueryOrder, HttpMethod, BookTicker, DailyStats, PremiumIndex, OpenInterest, IWebsocketsMethods, SymbolConfig } from './types.js';
+import { Interval, PositionRisk, Order, FuturesOrder, PositionSide, WorkingType, OrderType, OrderStatus, TimeInForce, Callback, IConstructorArgs, OrderSide, FundingRate, CancelOrder, AggregatedTrade, Trade, MyTrade, WithdrawHistoryResponse, DepositHistoryResponse, DepositAddress, WithdrawResponse, Candle, FuturesCancelAllOpenOrder, OrderBook, Ticker, FuturesUserTrade, Account, FuturesAccountInfo, FuturesBalance, QueryOrder, HttpMethod, BookTicker, DailyStats, PremiumIndex, OpenInterest, IWebsocketsMethods, SymbolConfig, OCOOrder } from './types.js';
 // export { Interval, PositionRisk, Order, FuturesOrder, PositionSide, WorkingType, OrderType, OrderStatus, TimeInForce, Callback, IConstructorArgs, OrderSide, FundingRate, CancelOrder, AggregatedTrade, Trade, MyTrade, WithdrawHistoryResponse, DepositHistoryResponse, DepositAddress, WithdrawResponse, Candle, FuturesCancelAllOpenOrder, OrderBook, Ticker, FuturesUserTrade, FuturesAccountInfo, FuturesBalance, QueryOrder } from './types';
 
 export interface Dictionary<T> {
@@ -874,7 +874,7 @@ export default class Binance {
     }
 
     /**
-     * Create a OCO spot order
+     * Create an OCO spot order
      * @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-list---oco-trade
      * @param {OrderSide} side - BUY or SELL
      * @param {string} symbol - The symbol to buy or sell
@@ -893,7 +893,7 @@ export default class Binance {
      * @param {string} params.belowTimeInForce - The time in force of the below order
      * @return {undefined}
      */
-    async ocoOrder(side: OrderSide, symbol: string, quantity: number, params: Dict = {}): Promise<any> {
+    async ocoOrder(side: OrderSide, symbol: string, quantity: number, params: Dict = {}): Promise<OCOOrder> {
         const request = {
             symbol: symbol,
             side: side,

src/types.ts

@@ -602,4 +602,42 @@ export interface SymbolConfig  {
   isAutoAddMargin: boolean
   leverage: number
   maxNotionalValue: string
-}
+}
+
+/**
+ * The response structure for an OCO order, based on Binance API documentation.
+ * See: https://binance-docs.github.io/apidocs/spot/en/#new-oco-trade
+ */
+export interface OCOOrder {
+        orderListId: number;
+        contingencyType: string;
+        listStatusType: string;
+        listOrderStatus: string;
+        listClientOrderId: string;
+        transactionTime: number;
+        symbol: string;
+        orders: Array<{
+            symbol: string;
+            orderId: number;
+            clientOrderId: string;
+        }>;
+        orderReports: Array<{
+            symbol: string;
+            orderId: number;
+            orderListId: number;
+            clientOrderId: string;
+            transactTime: number;
+            price: string;
+            origQty: string;
+            executedQty: string;
+            cummulativeQuoteQty: string;
+            status: string;
+            timeInForce: string;
+            type: string;
+            side: string;
+            stopPrice?: string;
+            icebergQty?: string;
+            workingTime?: number;
+            selfTradePreventionMode?: string;
+        }>;
+    }