binance 2.15.14 → 3.0.0-beta.1

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

@@ -0,0 +1,201 @@
+import { WS_KEY_MAP, WsKey } from '../../util/websockets/websocket-util';
+import { FuturesAccountBalance, FuturesAccountInformation, FuturesExchangeInfo, NewFuturesOrderParams } from '../futures';
+import { numberInString } from '../shared';
+import { ExchangeInfo, NewSpotOrderParams, OrderResponse } from '../spot';
+import { WSAPIRecvWindowTimestamp } from './ws-api-requests';
+import { WsAPISessionStatus } from './ws-api-responses';
+/**
+ * Standard WS commands (for consumers)
+ */
+export type WsOperation = 'SUBSCRIBE' | 'UNSUBSCRIBE' | 'LIST_SUBSCRIPTIONS' | 'SET_PROPERTY' | 'GET_PROPERTY';
+/**
+ * WS API commands (for sending requests via WS)
+ */
+export declare const WS_API_Operations: readonly ["session.logon", "session.status", "session.logout", "ping", "time", "exchangeInfo", "depth", "v2/account.balance", "account.balance", "v2/account.status", "account.status", "order.place", "orderList.place", "sor.order.place"];
+export type WsAPIOperation = (typeof WS_API_Operations)[number];
+export interface WsRequestOperationBinance<TWSTopic extends string, TWSParams extends object = any> {
+    method: WsOperation | WsAPIOperation;
+    params?: (TWSTopic | string | number)[] | TWSParams;
+    id: number;
+}
+export interface WSAPIResponse<TResponseData extends object = object, TOperation extends WsAPIOperation = WsAPIOperation> {
+    /** Auto-generated */
+    id: string;
+    status: number;
+    result: TResponseData;
+    rateLimits: {
+        rateLimitType: 'REQUEST_WEIGHT';
+        interval: 'MINUTE';
+        intervalNum: number;
+        limit: number;
+        count: number;
+    }[];
+    wsKey: WsKey;
+    isWSAPIResponse: boolean;
+}
+export type Exact<T> = {} & {
+    [K in keyof T]: T[K];
+};
+/**
+ * List of operations supported for this WsKey (connection)
+ */
+export interface WsAPIWsKeyTopicMap {
+    [WS_KEY_MAP.main]: WsOperation;
+    [WS_KEY_MAP.main2]: WsOperation;
+    [WS_KEY_MAP.main3]: WsOperation;
+    [WS_KEY_MAP.mainTestnetPublic]: WsOperation;
+    [WS_KEY_MAP.mainTestnetUserData]: WsOperation;
+    [WS_KEY_MAP.marginRiskUserData]: WsOperation;
+    [WS_KEY_MAP.usdm]: WsOperation;
+    [WS_KEY_MAP.usdmTestnet]: WsOperation;
+    [WS_KEY_MAP.coinm]: WsOperation;
+    [WS_KEY_MAP.coinm2]: WsOperation;
+    [WS_KEY_MAP.coinmTestnet]: WsOperation;
+    [WS_KEY_MAP.eoptions]: WsOperation;
+    [WS_KEY_MAP.portfolioMarginUserData]: WsOperation;
+    [WS_KEY_MAP.portfolioMarginProUserData]: WsOperation;
+    [WS_KEY_MAP.mainWSAPI]: WsAPIOperation;
+    [WS_KEY_MAP.mainWSAPI2]: WsAPIOperation;
+    [WS_KEY_MAP.mainWSAPITestnet]: WsAPIOperation;
+    [WS_KEY_MAP.usdmWSAPI]: WsAPIOperation;
+    [WS_KEY_MAP.usdmWSAPITestnet]: WsAPIOperation;
+}
+/**
+ * Request parameters expected per operation.
+ *
+ * - Each "key" here is the name of the command/operation.
+ * - Each "value" here has the parameters required for the command.
+ *
+ * Make sure to add new topics to WS_API_Operations and the response param map too.
+ */
+export interface WsAPITopicRequestParamMap {
+    SUBSCRIBE: never;
+    UNSUBSCRIBE: never;
+    LIST_SUBSCRIPTIONS: never;
+    SET_PROPERTY: never;
+    GET_PROPERTY: never;
+    /**
+     * Authentication commands & parameters:
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/authentication-requests
+     */
+    'session.logon': {
+        apiKey: string;
+        signature: string;
+        timestamp: number;
+    };
+    'session.status': void;
+    'session.logout': void;
+    /**
+     * General requests & parameters:
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/general-requests
+     */
+    ping: void;
+    time: void;
+    exchangeInfo: void | {
+        symbol?: string;
+        symbols?: string[];
+        permissions?: string[];
+        showPermissionSets?: boolean;
+        symbolStatus?: string;
+    };
+    /**
+     * Market data requests & parameters:
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/market-data-requests
+     */
+    depth: {
+        symbol: string;
+        limit: number;
+    };
+    /**
+     * Account requests & parameters:
+     * - Spot:
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests
+     *
+     * - Futures:
+     * https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api
+     */
+    /**
+     * Spot:
+     */
+    /**
+     * Futures:
+     */
+    'v2/account.balance': WSAPIRecvWindowTimestamp;
+    'account.balance': WSAPIRecvWindowTimestamp;
+    'v2/account.status': WSAPIRecvWindowTimestamp;
+    'account.status': WSAPIRecvWindowTimestamp;
+    /**
+     * Trading requests & parameters:
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/trading-requests
+     */
+    'order.place': (NewSpotOrderParams | NewFuturesOrderParams) & {
+        timestamp?: number;
+    };
+    'orderList.place': any;
+    'sor.order.place': any;
+}
+/**
+ * Response structure expected for each operation
+ *
+ * - Each "key" here is a command/request supported by the WS API
+ * - Each "value" here is the response schema for that command.
+ */
+export interface WsAPIOperationResponseMap {
+    [key: string]: unknown;
+    SUBSCRIBE: never;
+    UNSUBSCRIBE: never;
+    LIST_SUBSCRIPTIONS: never;
+    SET_PROPERTY: never;
+    GET_PROPERTY: never;
+    /**
+     * Session authentication responses:
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/session-authentication
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/authentication-requests
+     */
+    'session.login': WSAPIResponse<WsAPISessionStatus>;
+    'session.status': WSAPIResponse<WsAPISessionStatus>;
+    'session.logout': WSAPIResponse<WsAPISessionStatus>;
+    /**
+     * General responses:
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/general-requests
+     */
+    ping: {};
+    time: WSAPIResponse<{
+        serverTime: number;
+    }>;
+    exchangeInfo: WSAPIResponse<FuturesExchangeInfo | ExchangeInfo>;
+    /**
+     * Market data responses
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/market-data-requests
+     */
+    depth: WSAPIResponse<{
+        lastUpdateId: number;
+        bids: [numberInString, numberInString][];
+        asks: [numberInString, numberInString][];
+    }>;
+    /**
+     * Account requests & parameters:
+     * - Spot:
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests
+     *
+     * - Futures:
+     * https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api
+     */
+    /**
+     * Spot:
+     */
+    /**
+     * Futures:
+     */
+    'v2/account.balance': WSAPIResponse<FuturesAccountBalance>;
+    'account.balance': WSAPIResponse<FuturesAccountBalance>;
+    'v2/account.status': WSAPIResponse<FuturesAccountInformation>;
+    'account.status': WSAPIResponse<FuturesAccountInformation>;
+    /**
+     * Trading responses
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/trading-requests
+     */
+    'order.place': WSAPIResponse<OrderResponse>;
+    'orderList.place': WSAPIResponse<any>;
+    'sor.order.place': WSAPIResponse<any>;
+}

package/lib/types/websockets/ws-api.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WS_API_Operations = void 0;
+const websocket_util_1 = require("../../util/websockets/websocket-util");
+/**
+ * WS API commands (for sending requests via WS)
+ */
+exports.WS_API_Operations = [
+    'session.logon',
+    'session.status',
+    'session.logout',
+    //// General commands
+    'ping',
+    'time',
+    'exchangeInfo',
+    //// Market data commands //TODO:
+    'depth',
+    //// Account commands
+    // Futures
+    'v2/account.balance',
+    'account.balance',
+    'v2/account.status',
+    'account.status',
+    //// Trading commands // TODO:
+    'order.place',
+    'orderList.place',
+    'sor.order.place',
+];
+//# sourceMappingURL=ws-api.js.map

package/lib/types/websockets/ws-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-api.js","sourceRoot":"","sources":["../../../src/types/websockets/ws-api.ts"],"names":[],"mappings":";;;AAAA,yEAAyE;AA2BzE;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,eAAe;IACf,gBAAgB;IAChB,gBAAgB;IAChB,qBAAqB;IACrB,MAAM;IACN,MAAM;IACN,cAAc;IACd,iCAAiC;IACjC,OAAO;IACP,qBAAqB;IACrB,UAAU;IACV,oBAAoB;IACpB,iBAAiB;IACjB,mBAAmB;IACnB,gBAAgB;IAChB,8BAA8B;IAC9B,aAAa;IACb,iBAAiB;IACjB,iBAAiB;CACT,CAAC"}