binance 2.13.19 → 2.14.0

package/lib/index.d.ts

@@ -8,7 +8,7 @@ export * from './types/shared';
 export * from './types/spot';
 export * from './types/websockets';
 export * from './usdm-client';
-export * from './util/proxy';
+export * from './portfolio-client';
 export * from './util/requestUtils';
 export * from './util/typeGuards';
 export * from './util/WsStore';

package/lib/index.js

@@ -24,7 +24,7 @@ __exportStar(require("./types/shared"), exports);
 __exportStar(require("./types/spot"), exports);
 __exportStar(require("./types/websockets"), exports);
 __exportStar(require("./usdm-client"), exports);
-__exportStar(require("./util/proxy"), exports);
+__exportStar(require("./portfolio-client"), exports);
 __exportStar(require("./util/requestUtils"), exports);
 __exportStar(require("./util/typeGuards"), exports);
 __exportStar(require("./util/WsStore"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qCAAmB;AACnB,iDAA+B;AAC/B,2CAAyB;AACzB,gDAA8B;AAC9B,+CAA6B;AAC7B,kDAAgC;AAChC,iDAA+B;AAC/B,+CAA6B;AAC7B,qDAAmC;AACnC,gDAA8B;AAC9B,+CAA6B;AAC7B,sDAAoC;AACpC,oDAAkC;AAClC,iDAA+B;AAC/B,8CAA4B;AAC5B,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qCAAmB;AACnB,iDAA+B;AAC/B,2CAAyB;AACzB,gDAA8B;AAC9B,+CAA6B;AAC7B,kDAAgC;AAChC,iDAA+B;AAC/B,+CAA6B;AAC7B,qDAAmC;AACnC,gDAA8B;AAC9B,qDAAmC;AACnC,sDAAoC;AACpC,oDAAkC;AAClC,iDAA+B;AAC/B,8CAA4B;AAC5B,qDAAmC"}

package/lib/portfolio-client.d.ts

@@ -0,0 +1,344 @@
+import { AxiosRequestConfig } from 'axios';
+import { BinanceBaseUrlKey } from './types/shared';
+import { RestClientOptions } from './util/requestUtils';
+import BaseRestClient from './util/BaseRestClient';
+import { CancelPortfolioCMConditionalOrderReq, CancelPortfolioCMOrderReq, CancelPortfolioMarginOCOReq, CancelPortfolioMarginOrderReq, CancelPortfolioUMConditionalOrderReq, CancelPortfolioUMOrderReq, ModifyPortfolioCMOrderReq, ModifyPortfolioUMOrderReq, NewPortfolioCMConditionalOrderReq, NewPortfolioCMOrderReq, NewPortfolioUMConditionalOrderReq, NewPortfolioMarginOCOReq, NewPortfolioMarginOrderReq, PortfolioADLQuantile, PortfolioCMCancelConditionalOrderResponse, PortfolioCMCancelOrderResponse, PortfolioCMConditionalHistoryOrder, PortfolioCMConditionalOrder, NewPortfolioCMConditionalOrderResponse, PortfolioCMForceOrder, PortfolioCMModifyOrderResponse, PortfolioCMOrderModificationHistory, PortfolioCMOrder, NewPortfolioCMOrderResponse, PortfolioCMTrade, NewPortfolioConditionalOrderResponse, PortfolioMarginCancelAllOrdersResponse, PortfolioMarginCancelOrderResponse, PortfolioMarginForceOrder, PortfolioMarginOCO, PortfolioMarginOCOCancelResponse, NewPortfolioMarginOCOResponse, PortfolioMarginOrder, NewPortfolioMarginOrderResponse, PortfolioMarginRepayDebtReq, PortfolioMarginRepayDebtResponse, PortfolioMarginTrade, PortfolioUMCancelConditionalOrderResponse, PortfolioUMCancelOrderResponse, PortfolioUMConditionalOrder, PortfolioUMForceOrder, PortfolioUMModifyOrderResponse, PortfolioUMOrderModificationHistory, PortfolioUMOrder, PortfolioUMTrade, QueryPortfolioAllCMConditionalOrdersReq, QueryPortfolioAllCMOrdersReq, QueryPortfolioAllUMConditionalOrdersReq, QueryPortfolioAllUMOrdersReq, QueryPortfolioCMConditionalOrderHistoryReq, QueryPortfolioCMForceOrdersReq, QueryPortfolioCMOpenOrderReq, QueryPortfolioCMOrderAmendmentReq, QueryPortfolioCMOrderReq, QueryPortfolioCMTradesReq, QueryPortfolioMarginAllOCOReq, QueryPortfolioMarginAllOrdersReq, QueryPortfolioMarginForceOrdersReq, QueryPortfolioMarginOCOReq, QueryPortfolioMarginOrderReq, QueryPortfolioMarginTradesReq, QueryPortfolioUMConditionalOrderHistoryReq, QueryPortfolioUMForceOrdersReq, QueryPortfolioUMOpenConditionalOrderReq, QueryPortfolioUMOpenOrderReq, QueryPortfolioUMOrderAmendmentReq, QueryPortfolioUMOrderReq, QueryPortfolioUMTradesReq, PortfolioBalance, PortfolioAccountInformation, PortfolioUMPosition, PortfolioCMPosition, PortfolioUMLeverageBracket, PortfolioCMLeverageBracket, PortfolioTradingStatus, PortfolioMarginLoanRecord, GetMarginLoanRecordsReq, GetMarginRepayRecordsReq, PortfolioMarginRepayRecord, PortfolioMarginInterestRecord, GetMarginInterestHistoryReq, GetPortfolioInterestHistoryReq, PortfolioNegativeBalanceInterestRecord, QueryPortfolioUMIncomeReq, PortfolioUMIncome, QueryPortfolioCMIncomeReq, PortfolioCMIncome, PortfolioUMAccountAsset, PortfolioUMAccountPosition, PortfolioCMAccountAsset, PortfolioCMAccountPosition, PortfolioUMAccountConfig, PortfolioUMSymbolConfig, PortfolioUMAccountAssetV2, PortfolioUMAccountPositionV2, DownloadLinkResponse, NewPortfolioUMOrderReq, NewPortfolioUMOrderResponse } from './types/portfolio-margin';
+/**
+ * REST client for Portfolio Margin APIs (papi)
+ *
+ * https://developers.binance.com/docs/derivatives/portfolio-margin/general-info
+ */
+export declare class PortfolioClient extends BaseRestClient {
+    private clientId;
+    constructor(restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig);
+    getClientId(): BinanceBaseUrlKey;
+    /**
+     * Abstraction required by each client to aid with time sync / drift handling
+     */
+    getServerTime(): Promise<number>;
+    /**
+     *
+     * Misc Endpoints
+     *
+     **/
+    testConnectivity(): Promise<{}>;
+    /**
+     *
+     * DERIVATIVES -TRADE endpoints
+     *
+     **/
+    submitNewUMOrder(params: NewPortfolioUMOrderReq): Promise<NewPortfolioUMOrderResponse>;
+    submitNewUMConditionalOrder(params: NewPortfolioUMConditionalOrderReq): Promise<NewPortfolioConditionalOrderResponse>;
+    submitNewCMOrder(params: NewPortfolioCMOrderReq): Promise<NewPortfolioCMOrderResponse>;
+    submitNewCMConditionalOrder(params: NewPortfolioCMConditionalOrderReq): Promise<NewPortfolioCMConditionalOrderResponse>;
+    submitNewMarginOrder(params: NewPortfolioMarginOrderReq): Promise<NewPortfolioMarginOrderResponse>;
+    submitMarginLoan(params: {
+        asset: string;
+        amount: string;
+    }): Promise<{
+        tranId: number;
+    }>;
+    submitMarginRepay(params: {
+        asset: string;
+        amount: string;
+    }): Promise<{
+        tranId: number;
+    }>;
+    submitNewMarginOCO(params: NewPortfolioMarginOCOReq): Promise<NewPortfolioMarginOCOResponse>;
+    cancelUMOrder(params: CancelPortfolioUMOrderReq): Promise<PortfolioUMCancelOrderResponse>;
+    cancelAllUMOrders(params: {
+        symbol: string;
+    }): Promise<{
+        code: number;
+        msg: string;
+    }>;
+    cancelUMConditionalOrder(params: CancelPortfolioUMConditionalOrderReq): Promise<PortfolioUMCancelConditionalOrderResponse>;
+    cancelAllUMConditionalOrders(params: {
+        symbol: string;
+    }): Promise<{
+        code: number;
+        msg: string;
+    }>;
+    cancelCMOrder(params: CancelPortfolioCMOrderReq): Promise<PortfolioCMCancelOrderResponse>;
+    cancelAllCMOrders(params: {
+        symbol: string;
+    }): Promise<{
+        code: number;
+        msg: string;
+    }>;
+    cancelCMConditionalOrder(params: CancelPortfolioCMConditionalOrderReq): Promise<PortfolioCMCancelConditionalOrderResponse>;
+    cancelAllCMConditionalOrders(params: {
+        symbol: string;
+    }): Promise<{
+        code: number;
+        msg: string;
+    }>;
+    cancelMarginOrder(params: CancelPortfolioMarginOrderReq): Promise<PortfolioMarginCancelOrderResponse>;
+    cancelMarginOCO(params: CancelPortfolioMarginOCOReq): Promise<PortfolioMarginOCOCancelResponse>;
+    cancelAllMarginOrders(params: {
+        symbol: string;
+    }): Promise<PortfolioMarginCancelAllOrdersResponse[]>;
+    modifyUMOrder(params: ModifyPortfolioUMOrderReq): Promise<PortfolioUMModifyOrderResponse>;
+    modifyCMOrder(params: ModifyPortfolioCMOrderReq): Promise<PortfolioCMModifyOrderResponse>;
+    getUMOrder(params: QueryPortfolioUMOrderReq): Promise<PortfolioUMOrder>;
+    getAllUMOrders(params: QueryPortfolioAllUMOrdersReq): Promise<PortfolioUMOrder[]>;
+    getUMOpenOrder(params: QueryPortfolioUMOpenOrderReq): Promise<PortfolioUMOrder>;
+    getAllUMOpenOrders(params: {
+        symbol?: string;
+    }): Promise<PortfolioUMOrder[]>;
+    getAllUMConditionalOrders(params: QueryPortfolioAllUMConditionalOrdersReq): Promise<PortfolioUMConditionalOrder[]>;
+    getUMOpenConditionalOrders(params: {
+        symbol?: string;
+    }): Promise<PortfolioUMConditionalOrder[]>;
+    getUMOpenConditionalOrder(params: QueryPortfolioUMOpenConditionalOrderReq): Promise<PortfolioUMConditionalOrder>;
+    getUMConditionalOrderHistory(params: QueryPortfolioUMConditionalOrderHistoryReq): Promise<PortfolioUMConditionalOrder>;
+    getCMOrder(params: QueryPortfolioCMOrderReq): Promise<PortfolioCMOrder>;
+    getAllCMOrders(params: QueryPortfolioAllCMOrdersReq): Promise<PortfolioCMOrder[]>;
+    getCMOpenOrder(params: QueryPortfolioCMOpenOrderReq): Promise<PortfolioCMOrder>;
+    getAllCMOpenOrders(params: {
+        symbol?: string;
+        pair?: string;
+    }): Promise<PortfolioCMOrder[]>;
+    getCMOpenConditionalOrders(params: {
+        symbol?: string;
+    }): Promise<PortfolioCMConditionalOrder[]>;
+    getCMOpenConditionalOrder(params: {
+        symbol: string;
+        strategyId?: number;
+        newClientStrategyId?: string;
+    }): Promise<PortfolioCMConditionalOrder>;
+    getAllCMConditionalOrders(params: QueryPortfolioAllCMConditionalOrdersReq): Promise<PortfolioCMConditionalOrder[]>;
+    getCMConditionalOrderHistory(params: QueryPortfolioCMConditionalOrderHistoryReq): Promise<PortfolioCMConditionalHistoryOrder>;
+    getUMForceOrders(params: QueryPortfolioUMForceOrdersReq): Promise<PortfolioUMForceOrder[]>;
+    getCMForceOrders(params: QueryPortfolioCMForceOrdersReq): Promise<PortfolioCMForceOrder[]>;
+    getUMOrderModificationHistory(params: QueryPortfolioUMOrderAmendmentReq): Promise<PortfolioUMOrderModificationHistory[]>;
+    getCMOrderModificationHistory(params: QueryPortfolioCMOrderAmendmentReq): Promise<PortfolioCMOrderModificationHistory[]>;
+    getMarginForceOrders(params: QueryPortfolioMarginForceOrdersReq): Promise<{
+        rows: PortfolioMarginForceOrder[];
+        total: number;
+    }>;
+    getUMTrades(params: QueryPortfolioUMTradesReq): Promise<PortfolioUMTrade[]>;
+    getCMTrades(params: QueryPortfolioCMTradesReq): Promise<PortfolioCMTrade[]>;
+    getUMADLQuantile(params: {
+        symbol?: string;
+    }): Promise<{
+        symbol: string;
+        adlQuantile: PortfolioADLQuantile;
+    }[]>;
+    getCMADLQuantile(params: {
+        symbol?: string;
+    }): Promise<{
+        symbol: string;
+        adlQuantile: PortfolioADLQuantile;
+    }[]>;
+    toggleUMFeeBurn(params: {
+        feeBurn: 'true' | 'false';
+    }): Promise<{
+        code: number;
+        msg: string;
+    }>;
+    getUMFeeBurnStatus(): Promise<{
+        feeBurn: boolean;
+    }>;
+    getMarginOrder(params: QueryPortfolioMarginOrderReq): Promise<PortfolioMarginOrder>;
+    getMarginOpenOrders(params: {
+        symbol: string;
+    }): Promise<PortfolioMarginOrder>;
+    getAllMarginOrders(params: QueryPortfolioMarginAllOrdersReq): Promise<PortfolioMarginOrder[]>;
+    getMarginOCO(params: QueryPortfolioMarginOCOReq): Promise<PortfolioMarginOCO>;
+    getAllMarginOCO(params: QueryPortfolioMarginAllOCOReq): Promise<PortfolioMarginOCO[]>;
+    getMarginOpenOCO(): Promise<PortfolioMarginOCO[]>;
+    getMarginTrades(params: QueryPortfolioMarginTradesReq): Promise<PortfolioMarginTrade[]>;
+    repayMarginDebt(params: PortfolioMarginRepayDebtReq): Promise<PortfolioMarginRepayDebtResponse>;
+    /**
+     *
+     * DERIVATIVES - ACCOUNT endpoints
+     *
+     **/
+    getBalance(params?: {
+        asset?: string;
+    }): Promise<PortfolioBalance>;
+    getAccountInfo(): Promise<PortfolioAccountInformation>;
+    getMarginMaxBorrow(params: {
+        asset: string;
+    }): Promise<{
+        amount: string;
+        borrowLimit: string;
+    }>;
+    getMarginMaxWithdraw(params: {
+        asset: string;
+    }): Promise<{
+        amount: string;
+    }>;
+    getUMPosition(params?: {
+        symbol?: string;
+    }): Promise<PortfolioUMPosition[]>;
+    getCMPosition(params?: {
+        marginAsset?: string;
+        pair?: string;
+    }): Promise<PortfolioCMPosition[]>;
+    updateUMLeverage(params: {
+        symbol: string;
+        leverage: number;
+    }): Promise<{
+        leverage: number;
+        maxNotionalValue: string;
+        symbol: string;
+    }>;
+    updateCMLeverage(params: {
+        symbol: string;
+        leverage: number;
+    }): Promise<{
+        leverage: number;
+        maxQty: string;
+        symbol: string;
+    }>;
+    updateUMPositionMode(params: {
+        dualSidePosition: 'true' | 'false';
+    }): Promise<{
+        code: number;
+        msg: string;
+    }>;
+    updateCMPositionMode(params: {
+        dualSidePosition: 'true' | 'false';
+    }): Promise<{
+        code: number;
+        msg: string;
+    }>;
+    getUMPositionMode(): Promise<{
+        dualSidePosition: boolean;
+    }>;
+    getCMPositionMode(): Promise<{
+        dualSidePosition: boolean;
+    }>;
+    getUMLeverageBrackets(params?: {
+        symbol?: string;
+    }): Promise<{
+        symbol: string;
+        notionalCoef: string;
+        brackets: PortfolioUMLeverageBracket[];
+    }[]>;
+    getCMLeverageBrackets(params?: {
+        symbol?: string;
+    }): Promise<{
+        symbol: string;
+        brackets: PortfolioCMLeverageBracket[];
+    }[]>;
+    getUMTradingStatus(params?: {
+        symbol?: string;
+    }): Promise<PortfolioTradingStatus>;
+    getUMCommissionRate(params: {
+        symbol: string;
+    }): Promise<{
+        symbol: string;
+        makerCommissionRate: string;
+        takerCommissionRate: string;
+    }>;
+    getCMCommissionRate(params: {
+        symbol: string;
+    }): Promise<{
+        symbol: string;
+        makerCommissionRate: string;
+        takerCommissionRate: string;
+    }>;
+    getMarginLoanRecords(params: GetMarginLoanRecordsReq): Promise<{
+        rows: PortfolioMarginLoanRecord[];
+        total: number;
+    }>;
+    getMarginRepayRecords(params: GetMarginRepayRecordsReq): Promise<{
+        rows: PortfolioMarginRepayRecord[];
+        total: number;
+    }>;
+    getAutoRepayFuturesStatus(): Promise<{
+        autoRepay: boolean;
+    }>;
+    updateAutoRepayFuturesStatus(params: {
+        autoRepay: 'true' | 'false';
+    }): Promise<{
+        msg: string;
+    }>;
+    getMarginInterestHistory(params?: GetMarginInterestHistoryReq): Promise<{
+        rows: PortfolioMarginInterestRecord[];
+        total: number;
+    }>;
+    repayFuturesNegativeBalance(): Promise<{
+        msg: string;
+    }>;
+    getPortfolioNegativeBalanceInterestHistory(params?: GetPortfolioInterestHistoryReq): Promise<PortfolioNegativeBalanceInterestRecord[]>;
+    autoCollectFunds(): Promise<{
+        msg: string;
+    }>;
+    transferAssetFuturesMargin(params: {
+        asset: string;
+    }): Promise<{
+        msg: string;
+    }>;
+    transferBNB(params: {
+        amount: string;
+        transferSide: 'TO_UM' | 'FROM_UM';
+    }): Promise<{
+        tranId: number;
+    }>;
+    getUMIncomeHistory(params?: QueryPortfolioUMIncomeReq): Promise<PortfolioUMIncome[]>;
+    getCMIncomeHistory(params?: QueryPortfolioCMIncomeReq): Promise<PortfolioCMIncome[]>;
+    getUMAccount(): Promise<{
+        assets: PortfolioUMAccountAsset[];
+        positions: PortfolioUMAccountPosition[];
+    }>;
+    getCMAccount(): Promise<{
+        assets: PortfolioCMAccountAsset[];
+        positions: PortfolioCMAccountPosition[];
+    }>;
+    getUMAccountConfig(): Promise<PortfolioUMAccountConfig>;
+    getUMSymbolConfig(params?: {
+        symbol?: string;
+    }): Promise<PortfolioUMSymbolConfig[]>;
+    getUMAccountV2(): Promise<{
+        assets: PortfolioUMAccountAssetV2[];
+        positions: PortfolioUMAccountPositionV2[];
+    }>;
+    getUMTradeHistoryDownloadId(params: {
+        startTime: number;
+        endTime: number;
+    }): Promise<{
+        avgCostTimestampOfLast30d: number;
+        downloadId: string;
+    }>;
+    getUMTradeDownloadLink(params: {
+        downloadId: string;
+    }): Promise<DownloadLinkResponse>;
+    getUMOrderHistoryDownloadId(params: {
+        startTime: number;
+        endTime: number;
+    }): Promise<{
+        avgCostTimestampOfLast30d: number;
+        downloadId: string;
+    }>;
+    getUMOrderDownloadLink(params: {
+        downloadId: string;
+    }): Promise<DownloadLinkResponse>;
+    getUMTransactionHistoryDownloadId(params: {
+        startTime: number;
+        endTime: number;
+    }): Promise<{
+        avgCostTimestampOfLast30d: number;
+        downloadId: string;
+    }>;
+    getUMTransactionDownloadLink(params: {
+        downloadId: string;
+    }): Promise<DownloadLinkResponse>;
+    /**
+     * Validate syntax meets requirements set by binance. Log warning if not.
+     */
+    private validateOrderId;
+    /**
+     *
+     * User Data Stream Endpoints
+     *
+     **/
+    getPMUserDataListenKey(): Promise<{
+        listenKey: string;
+    }>;
+    keepAlivePMUserDataListenKey(): Promise<{}>;
+    closePMUserDataListenKey(): Promise<{}>;
+}