binance 3.0.0-beta.5 → 3.0.0-beta.6

package/lib/types/websockets/ws-api-requests.d.ts

@@ -1,6 +1,7 @@
-import { KlineInterval, numberInString } from '../shared';
+import { FuturesOrderType, PositionSide, PriceMatchMode, WorkingType } from '../futures';
+import { BooleanString, BooleanStringCapitalised, KlineInterval, numberInString, OrderResponseType, OrderSide, OrderTimeInForce, OrderType, SelfTradePreventionMode, SideEffects, StringBoolean } from '../shared';
 /**
- * Simple request params with timestamp? & recv window optional
+ * Simple request params with timestamp (required) & recv window (optional)
  */
 export type WSAPIRecvWindowTimestamp = {
     recvWindow?: number;
@@ -11,7 +12,7 @@ export type WSAPIRecvWindowTimestamp = {
  * Authentication request types
  *
  */
-export interface SessionLogonWSAPIRequest {
+export interface WSAPISessionLogonRequest {
     timestamp: number;
 }
 /**
@@ -19,7 +20,7 @@ export interface SessionLogonWSAPIRequest {
  * General request types
  *
  */
-export interface ExchangeInfoWSAPIRequest {
+export interface WSAPIExchangeInfoRequest {
     symbol?: string;
     symbols?: string[];
     permissions?: string[];
@@ -31,27 +32,27 @@ export interface ExchangeInfoWSAPIRequest {
  * Market data request types
  *
  */
-export interface DepthWSAPIRequest {
+export interface WSAPIOrderBookRequest {
     symbol: string;
     limit?: number;
 }
-export interface TradesRecentWSAPIRequest {
+export interface WSAPITradesRecentRequest {
     symbol: string;
     limit?: number;
 }
-export interface TradesHistoricalWSAPIRequest {
+export interface WSAPITradesHistoricalRequest {
     symbol: string;
     fromId?: number;
     limit?: number;
 }
-export interface TradesAggregateWSAPIRequest {
+export interface WSAPITradesAggregateRequest {
     symbol: string;
     fromId?: number;
     startTime?: number;
     endTime?: number;
     limit?: number;
 }
-export interface KlinesWSAPIRequest {
+export interface WSAPIKlinesRequest {
     symbol: string;
     interval: KlineInterval;
     startTime?: number;
@@ -59,13 +60,13 @@ export interface KlinesWSAPIRequest {
     timeZone?: string;
     limit?: number;
 }
-export interface AvgPriceWSAPIRequest {
+export interface WSAPIAvgPriceRequest {
     symbol: string;
 }
 /**
  * Symbol for single symbol, or symbols for multiple symbols
  */
-export interface Ticker24hrWSAPIRequest {
+export interface WSAPITicker24hrRequest {
     symbol?: string;
     symbols?: string[];
     type?: 'FULL' | 'MINI';
@@ -73,7 +74,7 @@ export interface Ticker24hrWSAPIRequest {
 /**
  * Symbol for single symbol, or symbols for multiple symbols
  */
-export interface TickerTradingDayWSAPIRequest {
+export interface WSAPITickerTradingDayRequest {
     symbol?: string;
     symbols?: string[];
     timeZone?: string;
@@ -82,7 +83,7 @@ export interface TickerTradingDayWSAPIRequest {
 /**
  * Symbol for single symbol, or symbols for multiple symbols
  */
-export interface TickerWSAPIRequest {
+export interface WSAPITickerRequest {
     symbol?: string;
     symbols?: string[];
     windowSize?: string;
@@ -91,14 +92,14 @@ export interface TickerWSAPIRequest {
 /**
  * Symbol for single symbol, or symbols for multiple symbols
  */
-export interface TickerPriceWSAPIRequest {
+export interface WSAPITickerPriceRequest {
     symbol?: string;
     symbols?: string[];
 }
 /**
  * Symbol for single symbol, or symbols for multiple symbols
  */
-export interface TickerBookWSAPIRequest {
+export interface WSAPITickerBookRequest {
     symbol?: string;
     symbols?: string[];
 }
@@ -107,20 +108,20 @@ export interface TickerBookWSAPIRequest {
  * Account request types - Spot
  *
  */
-export interface AllOrdersWSAPIRequest {
+export interface WSAPIAllOrdersRequest {
     symbol: string;
     orderId?: number;
     startTime?: number;
     endTime?: number;
     limit?: number;
 }
-export interface AllOrderListsWSAPIRequest {
+export interface WSAPIAllOrderListsRequest {
     fromId?: number;
     startTime?: number;
     endTime?: number;
     limit?: number;
 }
-export interface MyTradesWSAPIRequest {
+export interface WSAPIMyTradesRequest {
     symbol: string;
     orderId?: number;
     startTime?: number;
@@ -128,14 +129,14 @@ export interface MyTradesWSAPIRequest {
     fromId?: number;
     limit?: number;
 }
-export interface MyPreventedMatchesWSAPIRequest {
+export interface WSAPIMyPreventedMatchesRequest {
     symbol: string;
     preventedMatchId?: number;
     orderId?: number;
     fromPreventedMatchId?: number;
     limit?: number;
 }
-export interface MyAllocationsWSAPIRequest {
+export interface WSAPIMyAllocationsRequest {
     symbol: string;
     startTime?: number;
     endTime?: number;
@@ -146,7 +147,25 @@ export interface MyAllocationsWSAPIRequest {
 /**
  * Trading request types
  */
-export interface OrderTestWSAPIRequest {
+export interface WSAPINewSpotOrderRequest<T extends OrderType = OrderType, RT extends OrderResponseType | undefined = OrderResponseType> {
+    symbol: string;
+    side: OrderSide;
+    type: T;
+    timeInForce?: OrderTimeInForce;
+    quantity?: number;
+    quoteOrderQty?: number;
+    price?: number;
+    newClientOrderId?: string;
+    strategyId?: number;
+    strategyType?: number;
+    stopPrice?: number;
+    trailingDelta?: number;
+    icebergQty?: number;
+    newOrderRespType?: RT;
+    isIsolated?: StringBoolean;
+    sideEffectType?: SideEffects;
+}
+export interface WSAPIOrderTestRequest {
     symbol: string;
     side: 'BUY' | 'SELL';
     type: string;
@@ -165,14 +184,14 @@ export interface OrderTestWSAPIRequest {
     timestamp?: number;
     recvWindow?: number;
 }
-export interface OrderStatusWSAPIRequest {
+export interface WSAPIOrderStatusRequest {
     symbol: string;
     orderId?: number;
     origClientOrderId?: string;
     recvWindow?: number;
     timestamp?: number;
 }
-export interface OrderCancelWSAPIRequest {
+export interface WSAPIOrderCancelRequest {
     symbol: string;
     orderId?: number;
     origClientOrderId?: string;
@@ -181,7 +200,7 @@ export interface OrderCancelWSAPIRequest {
     recvWindow?: number;
     timestamp?: number;
 }
-export interface OrderCancelReplaceWSAPIRequest {
+export interface WSAPIOrderCancelReplaceRequest {
     symbol: string;
     cancelReplaceMode: 'STOP_ON_FAILURE' | 'ALLOW_FAILURE';
     cancelOrderId?: number;
@@ -206,12 +225,12 @@ export interface OrderCancelReplaceWSAPIRequest {
     recvWindow?: number;
     timestamp?: number;
 }
-export interface OpenOrdersStatusWSAPIRequest {
+export interface WSAPIOpenOrdersStatusRequest {
     symbol?: string;
     recvWindow?: number;
     timestamp?: number;
 }
-export interface OpenOrdersCancelAllWSAPIRequest {
+export interface WSAPIOpenOrdersCancelAllRequest {
     symbol: string;
     recvWindow?: number;
     timestamp?: number;
@@ -219,7 +238,7 @@ export interface OpenOrdersCancelAllWSAPIRequest {
 /**
  * Order list request types
  */
-export interface OrderListPlaceWSAPIRequest {
+export interface WSAPIOrderListPlaceRequest {
     symbol: string;
     side: 'BUY' | 'SELL';
     price: numberInString;
@@ -242,7 +261,7 @@ export interface OrderListPlaceWSAPIRequest {
     recvWindow?: number;
     timestamp?: number;
 }
-export interface OrderListPlaceOCOWSAPIRequest {
+export interface WSAPIOrderListPlaceOCORequest {
     symbol: string;
     side: 'BUY' | 'SELL';
     quantity: numberInString;
@@ -270,7 +289,7 @@ export interface OrderListPlaceOCOWSAPIRequest {
     recvWindow?: number;
     timestamp?: number;
 }
-export interface OrderListPlaceOTOWSAPIRequest {
+export interface WSAPIOrderListPlaceOTORequest {
     symbol: string;
     listClientOrderId?: string;
     newOrderRespType?: 'ACK' | 'RESULT' | 'FULL';
@@ -298,7 +317,7 @@ export interface OrderListPlaceOTOWSAPIRequest {
     recvWindow?: number;
     timestamp?: number;
 }
-export interface OrderListPlaceOTOCOWSAPIRequest {
+export interface WSAPIOrderListPlaceOTOCORequest {
     symbol: string;
     listClientOrderId?: string;
     newOrderRespType?: 'ACK' | 'RESULT' | 'FULL';
@@ -335,13 +354,13 @@ export interface OrderListPlaceOTOCOWSAPIRequest {
     recvWindow?: number;
     timestamp?: number;
 }
-export interface OrderListStatusWSAPIRequest {
+export interface WSAPIOrderListStatusRequest {
     origClientOrderId?: string;
     orderListId?: number;
     recvWindow?: number;
     timestamp?: number;
 }
-export interface OrderListCancelWSAPIRequest {
+export interface WSAPIOrderListCancelRequest {
     symbol: string;
     orderListId?: number;
     listClientOrderId?: string;
@@ -352,7 +371,7 @@ export interface OrderListCancelWSAPIRequest {
 /**
  * SOR request types
  */
-export interface SOROrderPlaceWSAPIRequest {
+export interface WSAPISOROrderPlaceRequest {
     symbol: string;
     side: 'BUY' | 'SELL';
     type: 'LIMIT' | 'MARKET';
@@ -368,26 +387,49 @@ export interface SOROrderPlaceWSAPIRequest {
     timestamp?: number;
     recvWindow?: number;
 }
-export interface SOROrderTestWSAPIRequest extends SOROrderPlaceWSAPIRequest {
+export type WSAPISOROrderTestRequest = WSAPISOROrderPlaceRequest & {
     computeCommissionRates?: boolean;
-}
+};
 /**
  * Futures market data request types
  */
-export interface FuturesDepthWSAPIRequest {
+export interface WSAPIFuturesOrderBookRequest {
     symbol: string;
     limit?: number;
 }
-export interface FuturesTickerPriceWSAPIRequest {
+export interface WSAPIFuturesTickerPriceRequest {
     symbol?: string;
 }
-export interface FuturesTickerBookWSAPIRequest {
+export interface WSAPIFuturesTickerBookRequest {
     symbol?: string;
 }
 /**
  * Futures trading request types
  */
-export interface FuturesOrderModifyWSAPIRequest {
+export interface WSAPINewFuturesOrderRequest<numberType = number> {
+    symbol: string;
+    side: OrderSide;
+    positionSide?: PositionSide;
+    type: FuturesOrderType;
+    timeInForce?: OrderTimeInForce;
+    quantity?: numberType;
+    reduceOnly?: BooleanString;
+    price?: numberType;
+    newClientOrderId?: string;
+    stopPrice?: numberType;
+    closePosition?: BooleanString;
+    activationPrice?: numberType;
+    callbackRate?: numberType;
+    workingType?: WorkingType;
+    priceProtect?: BooleanStringCapitalised;
+    newOrderRespType?: 'ACK' | 'RESULT';
+    selfTradePreventionMode?: SelfTradePreventionMode;
+    priceMatch?: PriceMatchMode;
+    goodTillDate?: number;
+    recvWindow?: number;
+    timestamp: number;
+}
+export interface WSAPIFuturesOrderModifyRequest {
     symbol: string;
     orderId?: number;
     origClientOrderId?: string;
@@ -400,35 +442,35 @@ export interface FuturesOrderModifyWSAPIRequest {
     recvWindow?: number;
     timestamp?: number;
 }
-export interface FuturesOrderCancelWSAPIRequest {
+export interface WSAPIFuturesOrderCancelRequest {
     symbol: string;
     orderId?: number;
     origClientOrderId?: string;
     recvWindow?: number;
     timestamp?: number;
 }
-export interface FuturesOrderStatusWSAPIRequest {
+export interface WSAPIFuturesOrderStatusRequest {
     symbol: string;
     orderId?: number;
     origClientOrderId?: string;
     recvWindow?: number;
     timestamp: number;
 }
-export interface FuturesPositionWSAPIRequest {
+export interface WSAPIFuturesPositionRequest {
     symbol?: string;
     recvWindow?: number;
     timestamp: number;
 }
-export interface FuturesPositionV2WSAPIRequest {
+export interface WSAPIFuturesPositionV2Request {
     symbol?: string;
     recvWindow?: number;
     timestamp: number;
 }
-export interface AccountStatusWSAPIRequest {
+export interface WSAPIAccountStatusRequest {
     omitZeroBalances?: boolean;
     recvWindow?: number;
     timestamp: number;
 }
-export interface AccountCommissionWSAPIRequest {
+export interface WSAPIAccountCommissionWSAPIRequest {
     symbol: string;
 }

package/lib/types/websockets/ws-api-responses.d.ts

@@ -7,7 +7,7 @@ export interface ErrorResponse {
     code: number;
     msg: string;
 }
-export interface WsAPISessionStatus {
+export interface WSAPISessionStatus {
     apiKey: string;
     authorizedSince: number;
     connectedSince: number;
@@ -18,18 +18,18 @@ export interface WsAPISessionStatus {
 /**
  * General response types
  */
-export interface TimeWSAPIResponse {
+export interface WSAPIServerTime {
     serverTime: number;
 }
 /**
  * Market data response types
  */
-export interface DepthWSAPIResponse {
+export interface WSAPIOrderBook {
     lastUpdateId: number;
     bids: [numberInString, numberInString][];
     asks: [numberInString, numberInString][];
 }
-export interface TradeWSAPIResponse {
+export interface WSAPITrade {
     id: number;
     price: numberInString;
     qty: numberInString;
@@ -38,7 +38,7 @@ export interface TradeWSAPIResponse {
     isBuyerMaker: boolean;
     isBestMatch: boolean;
 }
-export interface AggregateTradeWSAPIResponse {
+export interface WSAPIAggregateTrade {
     a: number;
     p: numberInString;
     q: numberInString;
@@ -48,7 +48,7 @@ export interface AggregateTradeWSAPIResponse {
     m: boolean;
     M: boolean;
 }
-export type KlineWSAPIResponse = [
+export type WSAPIKline = [
     number,
     numberInString,
     numberInString,
@@ -62,12 +62,12 @@ export type KlineWSAPIResponse = [
     numberInString,
     numberInString
 ];
-export interface AvgPriceWSAPIResponse {
+export interface WSAPIAvgPrice {
     mins: number;
     price: numberInString;
     closeTime: number;
 }
-export interface TickerFullWSAPIResponse {
+export interface WSAPIFullTicker {
     symbol: string;
     priceChange: numberInString;
     priceChangePercent: numberInString;
@@ -90,7 +90,7 @@ export interface TickerFullWSAPIResponse {
     lastId: number;
     count: number;
 }
-export interface TickerMiniWSAPIResponse {
+export interface WSAPIMiniTicker {
     symbol: string;
     openPrice: numberInString;
     highPrice: numberInString;
@@ -104,11 +104,11 @@ export interface TickerMiniWSAPIResponse {
     lastId: number;
     count: number;
 }
-export interface TickerPriceWSAPIResponse {
+export interface WSAPIPriceTicker {
     symbol: string;
     price: numberInString;
 }
-export interface TickerBookWSAPIResponse {
+export interface WSAPIBookTicker {
     symbol: string;
     bidPrice: numberInString;
     bidQty: numberInString;
@@ -118,19 +118,19 @@ export interface TickerBookWSAPIResponse {
 /**
  * Futures market data response types
  */
-export interface FuturesDepthWSAPIResponse {
+export interface WSAPIFuturesOrderBook {
     lastUpdateId: number;
     E: number;
     T: number;
     bids: [numberInString, numberInString][];
     asks: [numberInString, numberInString][];
 }
-export interface FuturesTickerPriceWSAPIResponse {
+export interface WSAPIFuturesPriceTicker {
     symbol: string;
     price: numberInString;
     time: number;
 }
-export interface FuturesTickerBookWSAPIResponse {
+export interface WSAPIFuturesBookTicker {
     lastUpdateId: number;
     symbol: string;
     bidPrice: numberInString;
@@ -142,7 +142,7 @@ export interface FuturesTickerBookWSAPIResponse {
 /**
  * Account response types
  */
-export interface AccountStatusWSAPIResponse {
+export interface WSAPIAccountStatus {
     makerCommission: number;
     takerCommission: number;
     buyerCommission: number;
@@ -169,7 +169,7 @@ export interface AccountStatusWSAPIResponse {
     permissions: string[];
     uid: number;
 }
-export interface AccountCommissionWSAPIResponse {
+export interface WSAPIAccountCommission {
     symbol: string;
     standardCommission: {
         maker: numberInString;
@@ -190,14 +190,14 @@ export interface AccountCommissionWSAPIResponse {
         discount: numberInString;
     };
 }
-export interface RateLimitWSAPIResponse {
+export interface WSAPIRateLimit {
     rateLimitType: string;
     interval: string;
     intervalNum: number;
     limit: number;
     count: number;
 }
-export interface OrderWSAPIResponse {
+export interface WSAPIOrder {
     symbol: string;
     orderId: number;
     orderListId: number;
@@ -221,7 +221,7 @@ export interface OrderWSAPIResponse {
     preventedMatchId?: number;
     preventedQuantity?: numberInString;
 }
-export interface OrderListWSAPIResponse {
+export interface WSAPIOrderList {
     orderListId: number;
     contingencyType: string;
     listStatusType: string;
@@ -235,7 +235,7 @@ export interface OrderListWSAPIResponse {
         clientOrderId: string;
     }[];
 }
-export interface TradeWSAPIResponse {
+export interface WSAPITrade {
     symbol: string;
     id: number;
     orderId: number;
@@ -250,7 +250,7 @@ export interface TradeWSAPIResponse {
     isMaker: boolean;
     isBestMatch: boolean;
 }
-export interface PreventedMatchWSAPIResponse {
+export interface WSAPIPreventedMatch {
     symbol: string;
     preventedMatchId: number;
     takerOrderId: number;
@@ -262,7 +262,7 @@ export interface PreventedMatchWSAPIResponse {
     makerPreventedQuantity: numberInString;
     transactTime: number;
 }
-export interface AllocationWSAPIResponse {
+export interface WSAPIAllocation {
     symbol: string;
     allocationId: number;
     allocationType: string;
@@ -281,10 +281,10 @@ export interface AllocationWSAPIResponse {
 /**
  * Trading response types
  */
-export interface OrderTestWSAPIResponse {
+export interface WSAPIOrderTestResponse {
     [key: string]: never;
 }
-export interface OrderTestWithCommissionWSAPIResponse {
+export interface WSAPIOrderTestWithCommission {
     standardCommissionForOrder: {
         maker: numberInString;
         taker: numberInString;
@@ -300,7 +300,7 @@ export interface OrderTestWithCommissionWSAPIResponse {
         discount: numberInString;
     };
 }
-export interface OrderCancelWSAPIResponse {
+export interface WSAPIOrderCancel {
     symbol: string;
     origClientOrderId: string;
     orderId: number;
@@ -324,13 +324,13 @@ export interface OrderCancelWSAPIResponse {
     strategyType?: number;
     selfTradePreventionMode: string;
 }
-export interface OrderCancelReplaceWSAPIResponse {
+export interface WSAPIOrderCancelReplaceResponse {
     cancelResult: 'SUCCESS' | 'FAILURE' | 'NOT_ATTEMPTED';
     newOrderResult: 'SUCCESS' | 'FAILURE' | 'NOT_ATTEMPTED';
-    cancelResponse: OrderCancelWSAPIResponse | ErrorResponse;
+    cancelResponse: WSAPIOrderCancel | ErrorResponse;
     newOrderResponse: OrderResponse | ErrorResponse | null;
 }
-export interface OrderListCancelWSAPIResponse {
+export interface WSAPIOrderListCancelResponse {
     orderListId: number;
     contingencyType: string;
     listStatusType: string;
@@ -343,12 +343,12 @@ export interface OrderListCancelWSAPIResponse {
         orderId: number;
         clientOrderId: string;
     }[];
-    orderReports: OrderCancelWSAPIResponse[];
+    orderReports: WSAPIOrderCancel[];
 }
 /**
  * Order list response types
  */
-export interface OrderListPlaceWSAPIResponse {
+export interface WSAPIOrderListPlaceResponse {
     orderListId: number;
     contingencyType: string;
     listStatusType: string;
@@ -363,7 +363,7 @@ export interface OrderListPlaceWSAPIResponse {
     }[];
     orderReports: OrderResponse[];
 }
-export interface OrderListStatusWSAPIResponse {
+export interface WSAPIOrderListStatusResponse {
     orderListId: number;
     contingencyType: string;
     listStatusType: string;
@@ -380,7 +380,7 @@ export interface OrderListStatusWSAPIResponse {
 /**
  * SOR response types
  */
-export interface SOROrderPlaceWSAPIResponse {
+export interface WSAPISOROrderPlaceResponse {
     symbol: string;
     orderId: number;
     orderListId: number;
@@ -409,10 +409,10 @@ export interface SOROrderPlaceWSAPIResponse {
     selfTradePreventionMode: string;
     usedSor: boolean;
 }
-export interface SOROrderTestWSAPIResponse {
+export interface WSAPISOROrderTestResponse {
     [key: string]: never;
 }
-export interface SOROrderTestWithCommissionWSAPIResponse {
+export interface WSAPISOROrderTestResponseWithCommission {
     standardCommissionForOrder: {
         maker: numberInString;
         taker: numberInString;
@@ -431,7 +431,7 @@ export interface SOROrderTestWithCommissionWSAPIResponse {
 /**
  * Futures trading response types
  */
-export interface FuturesOrderWSAPIResponse {
+export interface WSAPIFuturesOrder {
     orderId: number;
     symbol: string;
     status: string;
@@ -460,7 +460,7 @@ export interface FuturesOrderWSAPIResponse {
     activatePrice?: string;
     priceRate?: string;
 }
-export interface FuturesPositionWSAPIResponse {
+export interface WSAPIFuturesPosition {
     entryPrice: string;
     breakEvenPrice: string;
     marginType: string;
@@ -478,7 +478,7 @@ export interface FuturesPositionWSAPIResponse {
     positionSide: string;
     updateTime: number;
 }
-export interface FuturesPositionV2WSAPIResponse {
+export interface WSAPIFuturesPositionV2 {
     symbol: string;
     positionSide: string;
     positionAmt: string;
@@ -503,7 +503,7 @@ export interface FuturesPositionV2WSAPIResponse {
 /**
  * Futures account response types
  */
-export interface FuturesAccountBalanceItemWSAPIResponse {
+export interface WSAPIFuturesAccountBalanceItem {
     accountAlias: string;
     asset: string;
     balance: string;
@@ -514,7 +514,7 @@ export interface FuturesAccountBalanceItemWSAPIResponse {
     marginAvailable: boolean;
     updateTime: number;
 }
-export interface FuturesAccountAssetWSAPIResponse {
+export interface WSAPIFuturesAccountAsset {
     asset: string;
     walletBalance: string;
     unrealizedProfit: string;
@@ -530,7 +530,7 @@ export interface FuturesAccountAssetWSAPIResponse {
     marginAvailable?: boolean;
     updateTime: number;
 }
-export interface FuturesAccountPositionWSAPIResponse {
+export interface WSAPIFuturesAccountPosition {
     symbol: string;
     initialMargin?: string;
     maintMargin?: string;
@@ -548,7 +548,7 @@ export interface FuturesAccountPositionWSAPIResponse {
     positionAmt: string;
     updateTime: number;
 }
-export interface FuturesAccountStatusWSAPIResponse {
+export interface WSAPIFuturesAccountStatus {
     feeTier?: number;
     canTrade?: boolean;
     canDeposit?: boolean;
@@ -567,6 +567,6 @@ export interface FuturesAccountStatusWSAPIResponse {
     totalCrossUnPnl: string;
     availableBalance: string;
     maxWithdrawAmount: string;
-    assets: FuturesAccountAssetWSAPIResponse[];
-    positions: FuturesAccountPositionWSAPIResponse[];
+    assets: WSAPIFuturesAccountAsset[];
+    positions: WSAPIFuturesAccountPosition[];
 }