binance 3.0.0-beta.2 → 3.0.0-beta.4

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

@@ -1,3 +1,12 @@
+import { numberInString } from '../shared';
+import { OrderResponse } from '../spot';
+/**
+ * Error response type
+ */
+export interface ErrorResponse {
+    code: number;
+    msg: string;
+}
 export interface WsAPISessionStatus {
     apiKey: string;
     authorizedSince: number;
@@ -6,3 +15,558 @@ export interface WsAPISessionStatus {
     serverTime: number;
     userDataStream: boolean;
 }
+/**
+ * General response types
+ */
+export interface TimeWSAPIResponse {
+    serverTime: number;
+}
+/**
+ * Market data response types
+ */
+export interface DepthWSAPIResponse {
+    lastUpdateId: number;
+    bids: [numberInString, numberInString][];
+    asks: [numberInString, numberInString][];
+}
+export interface TradeWSAPIResponse {
+    id: number;
+    price: numberInString;
+    qty: numberInString;
+    quoteQty: numberInString;
+    time: number;
+    isBuyerMaker: boolean;
+    isBestMatch: boolean;
+}
+export interface AggregateTradeWSAPIResponse {
+    a: number;
+    p: numberInString;
+    q: numberInString;
+    f: number;
+    l: number;
+    T: number;
+    m: boolean;
+    M: boolean;
+}
+export type KlineWSAPIResponse = [
+    number,
+    numberInString,
+    numberInString,
+    numberInString,
+    numberInString,
+    numberInString,
+    number,
+    numberInString,
+    number,
+    numberInString,
+    numberInString,
+    numberInString
+];
+export interface AvgPriceWSAPIResponse {
+    mins: number;
+    price: numberInString;
+    closeTime: number;
+}
+export interface TickerFullWSAPIResponse {
+    symbol: string;
+    priceChange: numberInString;
+    priceChangePercent: numberInString;
+    weightedAvgPrice: numberInString;
+    prevClosePrice: numberInString;
+    lastPrice: numberInString;
+    lastQty: numberInString;
+    bidPrice: numberInString;
+    bidQty: numberInString;
+    askPrice: numberInString;
+    askQty: numberInString;
+    openPrice: numberInString;
+    highPrice: numberInString;
+    lowPrice: numberInString;
+    volume: numberInString;
+    quoteVolume: numberInString;
+    openTime: number;
+    closeTime: number;
+    firstId: number;
+    lastId: number;
+    count: number;
+}
+export interface TickerMiniWSAPIResponse {
+    symbol: string;
+    openPrice: numberInString;
+    highPrice: numberInString;
+    lowPrice: numberInString;
+    lastPrice: numberInString;
+    volume: numberInString;
+    quoteVolume: numberInString;
+    openTime: number;
+    closeTime: number;
+    firstId: number;
+    lastId: number;
+    count: number;
+}
+export interface TickerPriceWSAPIResponse {
+    symbol: string;
+    price: numberInString;
+}
+export interface TickerBookWSAPIResponse {
+    symbol: string;
+    bidPrice: numberInString;
+    bidQty: numberInString;
+    askPrice: numberInString;
+    askQty: numberInString;
+}
+/**
+ * Futures market data response types
+ */
+export interface FuturesDepthWSAPIResponse {
+    lastUpdateId: number;
+    E: number;
+    T: number;
+    bids: [numberInString, numberInString][];
+    asks: [numberInString, numberInString][];
+}
+export interface FuturesTickerPriceWSAPIResponse {
+    symbol: string;
+    price: numberInString;
+    time: number;
+}
+export interface FuturesTickerBookWSAPIResponse {
+    lastUpdateId: number;
+    symbol: string;
+    bidPrice: numberInString;
+    bidQty: numberInString;
+    askPrice: numberInString;
+    askQty: numberInString;
+    time: number;
+}
+/**
+ * Account response types
+ */
+export interface AccountStatusWSAPIResponse {
+    makerCommission: number;
+    takerCommission: number;
+    buyerCommission: number;
+    sellerCommission: number;
+    canTrade: boolean;
+    canWithdraw: boolean;
+    canDeposit: boolean;
+    commissionRates: {
+        maker: numberInString;
+        taker: numberInString;
+        buyer: numberInString;
+        seller: numberInString;
+    };
+    brokered: boolean;
+    requireSelfTradePrevention: boolean;
+    preventSor: boolean;
+    updateTime: number;
+    accountType: string;
+    balances: {
+        asset: string;
+        free: numberInString;
+        locked: numberInString;
+    }[];
+    permissions: string[];
+    uid: number;
+}
+export interface AccountCommissionWSAPIResponse {
+    symbol: string;
+    standardCommission: {
+        maker: numberInString;
+        taker: numberInString;
+        buyer: numberInString;
+        seller: numberInString;
+    };
+    taxCommission: {
+        maker: numberInString;
+        taker: numberInString;
+        buyer: numberInString;
+        seller: numberInString;
+    };
+    discount: {
+        enabledForAccount: boolean;
+        enabledForSymbol: boolean;
+        discountAsset: string;
+        discount: numberInString;
+    };
+}
+export interface RateLimitWSAPIResponse {
+    rateLimitType: string;
+    interval: string;
+    intervalNum: number;
+    limit: number;
+    count: number;
+}
+export interface OrderWSAPIResponse {
+    symbol: string;
+    orderId: number;
+    orderListId: number;
+    clientOrderId: string;
+    price: numberInString;
+    origQty: numberInString;
+    executedQty: numberInString;
+    cummulativeQuoteQty: numberInString;
+    status: string;
+    timeInForce: string;
+    type: string;
+    side: string;
+    stopPrice: numberInString;
+    icebergQty: numberInString;
+    time: number;
+    updateTime: number;
+    isWorking: boolean;
+    workingTime: number;
+    origQuoteOrderQty: numberInString;
+    selfTradePreventionMode: string;
+    preventedMatchId?: number;
+    preventedQuantity?: numberInString;
+}
+export interface OrderListWSAPIResponse {
+    orderListId: number;
+    contingencyType: string;
+    listStatusType: string;
+    listOrderStatus: string;
+    listClientOrderId: string;
+    transactionTime: number;
+    symbol: string;
+    orders: {
+        symbol: string;
+        orderId: number;
+        clientOrderId: string;
+    }[];
+}
+export interface TradeWSAPIResponse {
+    symbol: string;
+    id: number;
+    orderId: number;
+    orderListId: number;
+    price: numberInString;
+    qty: numberInString;
+    quoteQty: numberInString;
+    commission: numberInString;
+    commissionAsset: string;
+    time: number;
+    isBuyer: boolean;
+    isMaker: boolean;
+    isBestMatch: boolean;
+}
+export interface PreventedMatchWSAPIResponse {
+    symbol: string;
+    preventedMatchId: number;
+    takerOrderId: number;
+    makerSymbol: string;
+    makerOrderId: number;
+    tradeGroupId: number;
+    selfTradePreventionMode: string;
+    price: numberInString;
+    makerPreventedQuantity: numberInString;
+    transactTime: number;
+}
+export interface AllocationWSAPIResponse {
+    symbol: string;
+    allocationId: number;
+    allocationType: string;
+    orderId: number;
+    orderListId: number;
+    price: numberInString;
+    qty: numberInString;
+    quoteQty: numberInString;
+    commission: numberInString;
+    commissionAsset: string;
+    time: number;
+    isBuyer: boolean;
+    isMaker: boolean;
+    isAllocator: boolean;
+}
+/**
+ * Trading response types
+ */
+export interface OrderTestWSAPIResponse {
+    [key: string]: never;
+}
+export interface OrderTestWithCommissionWSAPIResponse {
+    standardCommissionForOrder: {
+        maker: numberInString;
+        taker: numberInString;
+    };
+    taxCommissionForOrder: {
+        maker: numberInString;
+        taker: numberInString;
+    };
+    discount: {
+        enabledForAccount: boolean;
+        enabledForSymbol: boolean;
+        discountAsset: string;
+        discount: numberInString;
+    };
+}
+export interface OrderCancelWSAPIResponse {
+    symbol: string;
+    origClientOrderId: string;
+    orderId: number;
+    orderListId: number;
+    clientOrderId: string;
+    transactTime: number;
+    price: numberInString;
+    origQty: numberInString;
+    executedQty: numberInString;
+    origQuoteOrderQty: numberInString;
+    cummulativeQuoteQty: numberInString;
+    status: string;
+    timeInForce: string;
+    type: string;
+    side: string;
+    stopPrice?: numberInString;
+    trailingDelta?: number;
+    trailingTime?: number;
+    icebergQty?: numberInString;
+    strategyId?: number;
+    strategyType?: number;
+    selfTradePreventionMode: string;
+}
+export interface OrderCancelReplaceWSAPIResponse {
+    cancelResult: 'SUCCESS' | 'FAILURE' | 'NOT_ATTEMPTED';
+    newOrderResult: 'SUCCESS' | 'FAILURE' | 'NOT_ATTEMPTED';
+    cancelResponse: OrderCancelWSAPIResponse | ErrorResponse;
+    newOrderResponse: OrderResponse | ErrorResponse | null;
+}
+export interface OrderListCancelWSAPIResponse {
+    orderListId: number;
+    contingencyType: string;
+    listStatusType: string;
+    listOrderStatus: string;
+    listClientOrderId: string;
+    transactionTime: number;
+    symbol: string;
+    orders: {
+        symbol: string;
+        orderId: number;
+        clientOrderId: string;
+    }[];
+    orderReports: OrderCancelWSAPIResponse[];
+}
+/**
+ * Order list response types
+ */
+export interface OrderListPlaceWSAPIResponse {
+    orderListId: number;
+    contingencyType: string;
+    listStatusType: string;
+    listOrderStatus: string;
+    listClientOrderId: string;
+    transactionTime: number;
+    symbol: string;
+    orders: {
+        symbol: string;
+        orderId: number;
+        clientOrderId: string;
+    }[];
+    orderReports: OrderResponse[];
+}
+export interface OrderListStatusWSAPIResponse {
+    orderListId: number;
+    contingencyType: string;
+    listStatusType: string;
+    listOrderStatus: string;
+    listClientOrderId: string;
+    transactionTime: number;
+    symbol: string;
+    orders: {
+        symbol: string;
+        orderId: number;
+        clientOrderId: string;
+    }[];
+}
+/**
+ * SOR response types
+ */
+export interface SOROrderPlaceWSAPIResponse {
+    symbol: string;
+    orderId: number;
+    orderListId: number;
+    clientOrderId: string;
+    transactTime: number;
+    price: string;
+    origQty: string;
+    executedQty: string;
+    origQuoteOrderQty: string;
+    cummulativeQuoteQty: string;
+    status: string;
+    timeInForce: string;
+    type: string;
+    side: string;
+    workingTime: number;
+    fills: {
+        matchType: string;
+        price: string;
+        qty: string;
+        commission: string;
+        commissionAsset: string;
+        tradeId: number;
+        allocId: number;
+    }[];
+    workingFloor: string;
+    selfTradePreventionMode: string;
+    usedSor: boolean;
+}
+export interface SOROrderTestWSAPIResponse {
+    [key: string]: never;
+}
+export interface SOROrderTestWithCommissionWSAPIResponse {
+    standardCommissionForOrder: {
+        maker: numberInString;
+        taker: numberInString;
+    };
+    taxCommissionForOrder: {
+        maker: numberInString;
+        taker: numberInString;
+    };
+    discount: {
+        enabledForAccount: boolean;
+        enabledForSymbol: boolean;
+        discountAsset: string;
+        discount: numberInString;
+    };
+}
+/**
+ * Futures trading response types
+ */
+export interface FuturesOrderWSAPIResponse {
+    orderId: number;
+    symbol: string;
+    status: string;
+    clientOrderId: string;
+    price: string;
+    avgPrice: string;
+    origQty: string;
+    executedQty: string;
+    cumQty: string;
+    cumQuote: string;
+    timeInForce: string;
+    type: string;
+    reduceOnly: boolean;
+    closePosition: boolean;
+    side: string;
+    positionSide: string;
+    stopPrice: string;
+    workingType: string;
+    priceProtect: boolean;
+    origType: string;
+    priceMatch: string;
+    selfTradePreventionMode: string;
+    goodTillDate: number;
+    updateTime: number;
+    time?: number;
+    activatePrice?: string;
+    priceRate?: string;
+}
+export interface FuturesPositionWSAPIResponse {
+    entryPrice: string;
+    breakEvenPrice: string;
+    marginType: string;
+    isAutoAddMargin: string;
+    isolatedMargin: string;
+    leverage: string;
+    liquidationPrice: string;
+    markPrice: string;
+    maxNotionalValue: string;
+    positionAmt: string;
+    notional: string;
+    isolatedWallet: string;
+    symbol: string;
+    unRealizedProfit: string;
+    positionSide: string;
+    updateTime: number;
+}
+export interface FuturesPositionV2WSAPIResponse {
+    symbol: string;
+    positionSide: string;
+    positionAmt: string;
+    entryPrice: string;
+    breakEvenPrice: string;
+    markPrice: string;
+    unrealizedProfit: string;
+    liquidationPrice: string;
+    isolatedMargin: string;
+    notional: string;
+    marginAsset: string;
+    isolatedWallet: string;
+    initialMargin: string;
+    maintMargin: string;
+    positionInitialMargin: string;
+    openOrderInitialMargin: string;
+    adl: number;
+    bidNotional: string;
+    askNotional: string;
+    updateTime: number;
+}
+/**
+ * Futures account response types
+ */
+export interface FuturesAccountBalanceItemWSAPIResponse {
+    accountAlias: string;
+    asset: string;
+    balance: string;
+    crossWalletBalance: string;
+    crossUnPnl: string;
+    availableBalance: string;
+    maxWithdrawAmount: string;
+    marginAvailable: boolean;
+    updateTime: number;
+}
+export interface FuturesAccountAssetWSAPIResponse {
+    asset: string;
+    walletBalance: string;
+    unrealizedProfit: string;
+    marginBalance: string;
+    maintMargin: string;
+    initialMargin: string;
+    positionInitialMargin: string;
+    openOrderInitialMargin: string;
+    crossWalletBalance: string;
+    crossUnPnl: string;
+    availableBalance: string;
+    maxWithdrawAmount: string;
+    marginAvailable?: boolean;
+    updateTime: number;
+}
+export interface FuturesAccountPositionWSAPIResponse {
+    symbol: string;
+    initialMargin?: string;
+    maintMargin?: string;
+    unrealizedProfit: string;
+    positionInitialMargin?: string;
+    openOrderInitialMargin?: string;
+    leverage?: string;
+    isolated?: boolean;
+    entryPrice?: string;
+    breakEvenPrice?: string;
+    maxNotional?: string;
+    bidNotional?: string;
+    askNotional?: string;
+    positionSide: string;
+    positionAmt: string;
+    updateTime: number;
+}
+export interface FuturesAccountStatusWSAPIResponse {
+    feeTier?: number;
+    canTrade?: boolean;
+    canDeposit?: boolean;
+    canWithdraw?: boolean;
+    updateTime: number;
+    multiAssetsMargin: boolean;
+    tradeGroupId?: number;
+    totalInitialMargin: string;
+    totalMaintMargin: string;
+    totalWalletBalance: string;
+    totalUnrealizedProfit: string;
+    totalMarginBalance: string;
+    totalPositionInitialMargin: string;
+    totalOpenOrderInitialMargin: string;
+    totalCrossWalletBalance: string;
+    totalCrossUnPnl: string;
+    availableBalance: string;
+    maxWithdrawAmount: string;
+    assets: FuturesAccountAssetWSAPIResponse[];
+    positions: FuturesAccountPositionWSAPIResponse[];
+}