binance 3.5.4 → 3.5.5

package/lib/types/spot.d.ts

@@ -517,6 +517,53 @@ export interface CurrentAvgPrice {
     price: numberInString;
     closeTime: number;
 }
+/** Spot PRICE_RANGE execution rule (GET /api/v3/executionRules). */
+export interface SpotPriceRangeExecutionRule {
+    ruleType: 'PRICE_RANGE';
+    bidLimitMultUp: numberInString;
+    bidLimitMultDown: numberInString;
+    askLimitMultUp: numberInString;
+    askLimitMultDown: numberInString;
+}
+export interface SpotSymbolExecutionRules {
+    symbol: string;
+    rules: SpotPriceRangeExecutionRule[];
+}
+export interface SpotExecutionRulesResponse {
+    symbolRules: SpotSymbolExecutionRules[];
+}
+/** GET /api/v3/executionRules — only one of symbol, symbols, or symbolStatus per request. */
+export interface SpotExecutionRulesParams {
+    symbol?: string;
+    symbols?: string[];
+    symbolStatus?: 'TRADING' | 'HALT' | 'BREAK';
+}
+/** Successful GET /api/v3/referencePrice (referencePrice null = not currently set). */
+export interface SpotReferencePriceResponse {
+    symbol: string;
+    referencePrice: numberInString | null;
+    timestamp: number;
+}
+/** GET /api/v3/referencePrice or /referencePrice/calculation when no reference price has ever been set (code -2043). */
+export interface SpotReferencePriceNeverSetError {
+    code: -2043;
+    msg: string;
+}
+export type SpotReferencePriceResult = SpotReferencePriceResponse | SpotReferencePriceNeverSetError;
+/** Reference price is computed as an arithmetic mean in the matching engine. */
+export interface SpotReferencePriceCalculationArithmeticMean {
+    symbol: string;
+    calculationType: 'ARITHMETIC_MEAN';
+    bucketCount: number;
+    bucketWidthMs: number;
+}
+/** Reference price is computed outside the matching engine. */
+export interface SpotReferencePriceCalculationExternal {
+    symbol: string;
+    calculationType: 'EXTERNAL';
+    externalCalculationId: number;
+}
+export type SpotReferencePriceCalculationResponse = SpotReferencePriceCalculationArithmeticMean | SpotReferencePriceCalculationExternal | SpotReferencePriceNeverSetError;
 export interface DailyChangeStatistic {
     symbol: string;
     priceChange: numberInString;
@@ -570,6 +617,8 @@ export interface OrderResponseResult {
     side: OrderSide;
     workingTime: number;
     selfTradePreventionMode: SelfTradePreventionMode;
+    /** Present with newOrderRespType RESULT or FULL when the order has an expiry reason. */
+    expiryReason?: string;
 }
 export interface OrderFill {
     price: numberInString;
@@ -596,6 +645,8 @@ export interface OrderResponseFull {
     isIsolated?: boolean;
     workingTime: number;
     selfTradePreventionMode: SelfTradePreventionMode;
+    /** Present with newOrderRespType RESULT or FULL when the order has an expiry reason. */
+    expiryReason?: string;
     fills: OrderFill[];
 }
 export type OrderResponse = OrderResponseACK | OrderResponseResult | OrderResponseFull;
@@ -2943,6 +2994,7 @@ export interface DualInvestmentPosition {
     isExercised?: boolean;
     settleAsset?: string;
     settleAmount?: string;
+    subscriptionTime?: number;
 }
 export interface CheckDualInvestmentAccountsResponse {
     totalAmountInBTC: string;
@@ -3285,6 +3337,209 @@ export interface GetWbethRewardsHistoryResponse {
     rows: WbethRewardsHistory[];
     total: number;
 }
+/**
+ * BFUSD (sapi/v1/bfusd/*)
+ */
+export interface BfusdAccountResponse {
+    bfusdAmount: string;
+    usdtProfit: string;
+    bfusdProfit: string;
+}
+export interface BfusdSubscriptionQuota {
+    leftQuota: string;
+}
+export interface BfusdFastRedemptionQuota {
+    leftQuota: string;
+    minimum: string;
+    fee: string;
+    freeQuota: string;
+}
+export interface BfusdStandardRedemptionQuota {
+    leftQuota: string;
+    minimum: string;
+    fee: string;
+    redeemPeriod: number;
+}
+export interface BfusdQuotaResponse {
+    subscriptionQuota: BfusdSubscriptionQuota;
+    fastRedemptionQuota: BfusdFastRedemptionQuota;
+    standardRedemptionQuota: BfusdStandardRedemptionQuota;
+}
+export interface BfusdSubscribeParams {
+    asset: string;
+    amount: number;
+}
+export interface BfusdSubscribeResponse {
+    success: boolean;
+    bfusdAmount: string;
+}
+export interface BfusdRedeemParams {
+    amount: number;
+    type?: 'FAST' | 'STANDARD';
+}
+export interface BfusdRedeemResponse {
+    success: boolean;
+    receiveAmount: string;
+    fee: string;
+    arrivalTime: number;
+}
+export interface GetBfusdSubscriptionHistoryParams {
+    asset?: string;
+    startTime?: number;
+    endTime?: number;
+    current?: number;
+    size?: number;
+}
+export interface BfusdSubscriptionHistoryRow {
+    time: number;
+    asset: string;
+    amount: string;
+    receiveAsset: string;
+    receiveAmount: string;
+    status: 'PENDING' | 'SUCCESS';
+}
+export interface GetBfusdRedemptionHistoryParams {
+    startTime?: number;
+    endTime?: number;
+    current?: number;
+    size?: number;
+}
+export interface BfusdRedemptionHistoryRow {
+    time: number;
+    asset: string;
+    amount: string;
+    receiveAsset: string;
+    receiveAmount: string;
+    fee: string;
+    arrivalTime: number;
+    status: 'PENDING' | 'SUCCESS';
+}
+export interface GetBfusdRewardsHistoryParams {
+    startTime?: number;
+    endTime?: number;
+    current?: number;
+    size?: number;
+}
+export interface BfusdRewardsHistoryRow {
+    time: number;
+    rewardsAmount: string;
+    annualPercentageRate: string;
+    rewardAsset?: string;
+    /** API may return this casing per Binance docs. */
+    BFUSDPosition?: string;
+}
+export interface GetBfusdRateHistoryParams {
+    startTime?: number;
+    endTime?: number;
+    current?: number;
+    size?: number;
+}
+export interface BfusdRateHistoryRow {
+    annualPercentageRate: string;
+    time: number;
+}
+/**
+ * RWUSD (sapi/v1/rwusd/*)
+ */
+export interface RwusdAccountResponse {
+    rwusdAmount: string;
+    totalProfit: string;
+}
+export interface RwusdSubscriptionQuota {
+    assets: string[];
+    leftQuota: string;
+    minimum: string;
+}
+export interface RwusdFastRedemptionQuota {
+    leftQuota: string;
+    minimum: string;
+    fee: string;
+    freeQuota: string;
+}
+export interface RwusdStandardRedemptionQuota {
+    leftQuota: string;
+    minimum: string;
+    fee: string;
+    redeemPeriod: number;
+}
+export interface RwusdQuotaResponse {
+    subscriptionQuota: RwusdSubscriptionQuota;
+    fastRedemptionQuota: RwusdFastRedemptionQuota;
+    standardRedemptionQuota: RwusdStandardRedemptionQuota;
+    subscribeEnable: boolean;
+    redeemEnable: boolean;
+}
+export interface RwusdSubscribeParams {
+    asset: string;
+    amount: number;
+}
+export interface RwusdSubscribeResponse {
+    success: boolean;
+    rwusdAmount: string;
+}
+export interface RwusdRedeemParams {
+    amount: number;
+    type?: 'FAST' | 'STANDARD';
+}
+export interface RwusdRedeemResponse {
+    success: boolean;
+    receiveAmount: string;
+    fee: string;
+    arrivalTime: number;
+}
+export interface GetRwusdSubscriptionHistoryParams {
+    asset?: string;
+    startTime?: number;
+    endTime?: number;
+    current?: number;
+    size?: number;
+}
+export interface RwusdSubscriptionHistoryRow {
+    time: number;
+    asset: string;
+    amount: string;
+    receiveAsset: string;
+    receiveAmount: string;
+    status: 'PENDING' | 'SUCCESS';
+}
+export interface GetRwusdRedemptionHistoryParams {
+    startTime?: number;
+    endTime?: number;
+    current?: number;
+    size?: number;
+}
+export interface RwusdRedemptionHistoryRow {
+    time: number;
+    asset: string;
+    amount: string;
+    receiveAsset: string;
+    receiveAmount: string;
+    fee: string;
+    arrivalTime: number;
+    status: 'PENDING' | 'SUCCESS';
+}
+export interface GetRwusdRewardsHistoryParams {
+    startTime?: number;
+    endTime?: number;
+    current?: number;
+    size?: number;
+}
+export interface RwusdRewardsHistoryRow {
+    time: number;
+    rewardsAmount: string;
+    rwusdPosition: string;
+    annualPercentageRate: string;
+}
+export interface GetRwusdRateHistoryParams {
+    startTime?: number;
+    endTime?: number;
+    current?: number;
+    size?: number;
+}
+export interface RwusdRateHistoryRow {
+    annualPercentageRate: string;
+    time: number;
+}
 export interface GetMiningAlgoListResponse {
     algoName: string;
     algoId: number;
@@ -3765,6 +4020,16 @@ export interface GetPortfolioMarginAssetLeverageResponse {
     asset: string;
     leverage: number;
 }
+export interface SetPortfolioMarginMarginCallLevelParams {
+    marginCallLevel: number;
+}
+export interface PortfolioMarginMarginCallLevelResponse {
+    marginCallLevel: string;
+}
+export type PortfolioMarginMarginCallLevelGetResponse = PortfolioMarginMarginCallLevelResponse | Record<string, never>;
+export interface PortfolioMarginMarginCallLevelDeleteResponse {
+    msg: string;
+}
 export interface SubscribeBlvtParams {
     tokenName: string;
     cost: number;
@@ -5418,6 +5683,33 @@ export interface GetInstitutionalLoanBorrowRepayRecordsResponse {
     total: number;
     rows: InstitutionalLoanBorrowRepayRecord[];
 }
+export interface MarginInterestRebateBalanceResponse {
+    asset: string;
+    balance: string;
+    totalGranted: string;
+    totalConsumed: string;
+}
+export interface GetMarginInterestRebateBalanceRecordsParams {
+    type?: 0 | 1 | 2;
+    startTime?: number;
+    endTime?: number;
+    current?: number;
+    size?: number;
+}
+export interface MarginInterestRebateBalanceRecord {
+    type: 'ADD' | 'DEDUCT' | 'INTEREST_OFFSET';
+    rebateAsset: string;
+    delta: string;
+    createTime: number;
+    groupId?: number;
+    liabilityAsset?: string;
+    deductedInterest?: string;
+    exchangeRate?: string;
+}
+export interface MarginInterestRebateBalanceRecordsResponse {
+    total: number;
+    rows: MarginInterestRebateBalanceRecord[];
+}
 export interface OnchainYieldsLockedProductListParams {
     asset?: string;
     current?: number;
@@ -5715,6 +6007,26 @@ export type AlphaKline = [
 export interface AlphaTickerParams {
     symbol: string;
 }
+export type AlphaFullDepthLimit = 5 | 10 | 20 | 50 | 100 | 500 | 1000;
+export interface AlphaFullDepthParams {
+    symbol: string;
+    limit?: AlphaFullDepthLimit;
+}
+export interface AlphaFullDepthData {
+    lastUpdateId: number;
+    symbol: string;
+    bids: [string, string][];
+    asks: [string, string][];
+    E: number;
+    T: number;
+}
+export interface AlphaFullDepthResponse {
+    code: string;
+    message: string | null;
+    messageDetail: string | null;
+    success: boolean;
+    data: AlphaFullDepthData;
+}
 export interface AlphaTicker {
     symbol: string;
     priceChange: string;

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

@@ -64,6 +64,21 @@ export interface WSAPIKlinesRequest {
 export interface WSAPIAvgPriceRequest {
     symbol: string;
 }
+/**
+ * Query execution rules (e.g. PRICE_RANGE). Only one of symbol, symbols, or symbolStatus per request.
+ */
+export interface WSAPIExecutionRulesRequest {
+    symbol?: string;
+    symbols?: string[];
+    symbolStatus?: 'TRADING' | 'HALT' | 'BREAK';
+}
+export interface WSAPIReferencePriceRequest {
+    symbol: string;
+}
+export interface WSAPIReferencePriceCalculationRequest {
+    symbol: string;
+    symbolStatus?: 'TRADING' | 'HALT' | 'BREAK';
+}
 /**
  * Symbol for single symbol, or symbols for multiple symbols
  */

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

@@ -397,6 +397,8 @@ export interface WSAPISOROrderPlaceResponse {
     type: string;
     side: string;
     workingTime: number;
+    /** With newOrderRespType RESULT or FULL when the order has an expiry reason. */
+    expiryReason?: string;
     fills: {
         matchType: string;
         price: string;
@@ -622,6 +624,8 @@ export interface WSAPISpotOrderRESULT extends WSAPISpotOrderACK {
     side: string;
     workingTime: number;
     selfTradePreventionMode: string;
+    /** With newOrderRespType RESULT or FULL when the order has an expiry reason. */
+    expiryReason?: string;
 }
 export interface WSAPISpotOrderFill {
     price: numberInString;

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

@@ -1,7 +1,7 @@
 import { WS_KEY_MAP, WsKey } from '../../util/websockets/websocket-util';
 import { FuturesExchangeInfo } from '../futures';
-import { ExchangeInfo } from '../spot';
-import { WSAPIAccountCommissionWSAPIRequest, WSAPIAccountInformationRequest, WSAPIAllOrderListsRequest, WSAPIAllOrdersRequest, WSAPIAvgPriceRequest, WSAPIExchangeInfoRequest, WSAPIFuturesAlgoOrderCancelRequest, WSAPIFuturesOrderBookRequest, WSAPIFuturesOrderCancelRequest, WSAPIFuturesOrderModifyRequest, WSAPIFuturesOrderStatusRequest, WSAPIFuturesTickerBookRequest, WSAPIFuturesTickerPriceRequest, WSAPIKlinesRequest, WSAPIMyAllocationsRequest, WSAPIMyPreventedMatchesRequest, WSAPIMyTradesRequest, WSAPINewFuturesAlgoOrderRequest, WSAPINewFuturesOrderRequest, WSAPINewSpotOrderRequest, WSAPIOpenOrdersCancelAllRequest, WSAPIOpenOrdersStatusRequest, WSAPIOrderAmendKeepPriorityRequest, WSAPIOrderBookRequest, WSAPIOrderCancelReplaceRequest, WSAPIOrderCancelRequest, WSAPIOrderListCancelRequest, WSAPIOrderListPlaceOCORequest, WSAPIOrderListPlaceOPOCORequest, WSAPIOrderListPlaceOPORequest, WSAPIOrderListPlaceOTOCORequest, WSAPIOrderListPlaceOTORequest, WSAPIOrderListPlaceRequest, WSAPIOrderListStatusRequest, WSAPIOrderStatusRequest, WSAPIOrderTestRequest, WSAPIRecvWindowTimestamp, WSAPISessionLogonRequest, WSAPISOROrderPlaceRequest, WSAPISOROrderTestRequest, WSAPITicker24hrRequest, WSAPITickerBookRequest, WSAPITickerPriceRequest, WSAPITickerRequest, WSAPITickerTradingDayRequest, WSAPITradesAggregateRequest, WSAPITradesHistoricalRequest, WSAPITradesRecentRequest } from './ws-api-requests';
+import { ExchangeInfo, SpotExecutionRulesResponse, SpotReferencePriceCalculationResponse, SpotReferencePriceResult } from '../spot';
+import { WSAPIAccountCommissionWSAPIRequest, WSAPIAccountInformationRequest, WSAPIAllOrderListsRequest, WSAPIAllOrdersRequest, WSAPIAvgPriceRequest, WSAPIExchangeInfoRequest, WSAPIExecutionRulesRequest, WSAPIFuturesAlgoOrderCancelRequest, WSAPIFuturesOrderBookRequest, WSAPIFuturesOrderCancelRequest, WSAPIFuturesOrderModifyRequest, WSAPIFuturesOrderStatusRequest, WSAPIFuturesTickerBookRequest, WSAPIFuturesTickerPriceRequest, WSAPIKlinesRequest, WSAPIMyAllocationsRequest, WSAPIMyPreventedMatchesRequest, WSAPIMyTradesRequest, WSAPINewFuturesAlgoOrderRequest, WSAPINewFuturesOrderRequest, WSAPINewSpotOrderRequest, WSAPIOpenOrdersCancelAllRequest, WSAPIOpenOrdersStatusRequest, WSAPIOrderAmendKeepPriorityRequest, WSAPIOrderBookRequest, WSAPIOrderCancelReplaceRequest, WSAPIOrderCancelRequest, WSAPIOrderListCancelRequest, WSAPIOrderListPlaceOCORequest, WSAPIOrderListPlaceOPOCORequest, WSAPIOrderListPlaceOPORequest, WSAPIOrderListPlaceOTOCORequest, WSAPIOrderListPlaceOTORequest, WSAPIOrderListPlaceRequest, WSAPIOrderListStatusRequest, WSAPIOrderStatusRequest, WSAPIOrderTestRequest, WSAPIRecvWindowTimestamp, WSAPIReferencePriceCalculationRequest, WSAPIReferencePriceRequest, WSAPISessionLogonRequest, WSAPISOROrderPlaceRequest, WSAPISOROrderTestRequest, WSAPITicker24hrRequest, WSAPITickerBookRequest, WSAPITickerPriceRequest, WSAPITickerRequest, WSAPITickerTradingDayRequest, WSAPITradesAggregateRequest, WSAPITradesHistoricalRequest, WSAPITradesRecentRequest } from './ws-api-requests';
 import { WSAPIAccountCommission, WSAPIAccountInformation, WSAPIAggregateTrade, WSAPIAllocation, WSAPIAvgPrice, WSAPIBookTicker, WSAPIFullTicker, WSAPIFuturesAccountBalanceItem, WSAPIFuturesAccountStatus, WSAPIFuturesAlgoOrder, WSAPIFuturesAlgoOrderCancelResponse, WSAPIFuturesBookTicker, WSAPIFuturesOrder, WSAPIFuturesOrderBook, WSAPIFuturesPosition, WSAPIFuturesPositionV2, WSAPIFuturesPriceTicker, WSAPIKline, WSAPIMiniTicker, WSAPIOrder, WSAPIOrderBook, WSAPIOrderCancel, WSAPIOrderCancelReplaceResponse, WSAPIOrderListCancelResponse, WSAPIOrderListPlaceResponse, WSAPIOrderListStatusResponse, WSAPIOrderTestResponse, WSAPIOrderTestWithCommission, WSAPIPreventedMatch, WSAPIPriceTicker, WSAPIRateLimit, WSAPIServerTime, WSAPISessionStatus, WSAPISOROrderPlaceResponse, WSAPISOROrderTestResponse, WSAPISOROrderTestResponseWithCommission, WSAPISpotOrderResponse, WSAPITrade } from './ws-api-responses';
 /**
  * Standard WS commands (for consumers)
@@ -10,7 +10,7 @@ export type WsOperation = 'SUBSCRIBE' | 'UNSUBSCRIBE' | 'LIST_SUBSCRIPTIONS' | '
 /**
  * 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", "trades.recent", "trades.historical", "trades.aggregate", "klines", "uiKlines", "avgPrice", "ticker.24hr", "ticker.tradingDay", "ticker", "ticker.price", "ticker.book", "account.status", "account.commission", "account.rateLimits.orders", "allOrders", "allOrderLists", "myTrades", "myPreventedMatches", "myAllocations", "v2/account.balance", "account.balance", "v2/account.status", "account.position", "v2/account.position", "order.place", "order.test", "order.status", "order.cancel", "order.cancelReplace", "order.amend.keepPriority", "order.modify", "openOrders.status", "openOrders.cancelAll", "algoOrder.place", "algoOrder.cancel", "orderList.place", "orderList.place.oco", "orderList.place.oto", "orderList.place.otoco", "orderList.place.opo", "orderList.place.opoco", "orderList.status", "orderList.cancel", "openOrderLists.status", "sor.order.place", "sor.order.test", "userDataStream.start", "userDataStream.ping", "userDataStream.stop", "userDataStream.subscribe", "userDataStream.subscribe.signature", "userDataStream.unsubscribe", "userDataStream.subscribe.listenToken"];
+export declare const WS_API_Operations: readonly ["session.logon", "session.status", "session.logout", "ping", "time", "exchangeInfo", "depth", "trades.recent", "trades.historical", "trades.aggregate", "klines", "uiKlines", "avgPrice", "executionRules", "referencePrice", "referencePrice.calculation", "ticker.24hr", "ticker.tradingDay", "ticker", "ticker.price", "ticker.book", "account.status", "account.commission", "account.rateLimits.orders", "allOrders", "allOrderLists", "myTrades", "myPreventedMatches", "myAllocations", "v2/account.balance", "account.balance", "v2/account.status", "account.position", "v2/account.position", "order.place", "order.test", "order.status", "order.cancel", "order.cancelReplace", "order.amend.keepPriority", "order.modify", "openOrders.status", "openOrders.cancelAll", "algoOrder.place", "algoOrder.cancel", "orderList.place", "orderList.place.oco", "orderList.place.oto", "orderList.place.otoco", "orderList.place.opo", "orderList.place.opoco", "orderList.status", "orderList.cancel", "openOrderLists.status", "sor.order.place", "sor.order.test", "userDataStream.start", "userDataStream.ping", "userDataStream.stop", "userDataStream.subscribe", "userDataStream.subscribe.signature", "userDataStream.unsubscribe", "userDataStream.subscribe.listenToken"];
 export interface WSAPIUserDataListenKeyRequest {
     apiKey: string;
     listenKey: string;
@@ -111,6 +111,9 @@ export interface WsAPITopicRequestParamMap<TWSKey = WsKey> {
     klines: WSAPIKlinesRequest;
     uiKlines: WSAPIKlinesRequest;
     avgPrice: WSAPIAvgPriceRequest;
+    executionRules: void | WSAPIExecutionRulesRequest;
+    referencePrice: WSAPIReferencePriceRequest;
+    'referencePrice.calculation': WSAPIReferencePriceCalculationRequest;
     'ticker.24hr': void | WSAPITicker24hrRequest;
     'ticker.tradingDay': WSAPITickerTradingDayRequest;
     ticker: WSAPITickerRequest;
@@ -247,6 +250,9 @@ export interface WsAPIOperationResponseMap {
     klines: WSAPIResponse<WSAPIKline[]>;
     uiKlines: WSAPIResponse<WSAPIKline[]>;
     avgPrice: WSAPIResponse<WSAPIAvgPrice>;
+    executionRules: WSAPIResponse<SpotExecutionRulesResponse>;
+    referencePrice: WSAPIResponse<SpotReferencePriceResult>;
+    'referencePrice.calculation': WSAPIResponse<SpotReferencePriceCalculationResponse>;
     'ticker.24hr': WSAPIResponse<WSAPIFullTicker | WSAPIMiniTicker | WSAPIFullTicker[] | WSAPIMiniTicker[]>;
     'ticker.tradingDay': WSAPIResponse<WSAPIFullTicker | WSAPIMiniTicker | WSAPIFullTicker[] | WSAPIMiniTicker[]>;
     ticker: WSAPIResponse<WSAPIFullTicker | WSAPIMiniTicker | WSAPIFullTicker[] | WSAPIMiniTicker[]>;

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

@@ -21,6 +21,9 @@ exports.WS_API_Operations = [
     'klines',
     'uiKlines',
     'avgPrice',
+    'executionRules',
+    'referencePrice',
+    'referencePrice.calculation',
     'ticker.24hr',
     'ticker.tradingDay',
     'ticker',

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

@@ -1 +1 @@
-{"version":3,"file":"ws-api.js","sourceRoot":"","sources":["../../../src/types/websockets/ws-api.ts"],"names":[],"mappings":";;;AAAA,yEAAyE;AAwGzE;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,eAAe;IACf,gBAAgB;IAChB,gBAAgB;IAChB,qBAAqB;IACrB,MAAM;IACN,MAAM;IACN,cAAc;IACd,yBAAyB;IACzB,OAAO;IACP,eAAe;IACf,mBAAmB;IACnB,kBAAkB;IAClB,QAAQ;IACR,UAAU;IACV,UAAU;IACV,aAAa;IACb,mBAAmB;IACnB,QAAQ;IACR,cAAc;IACd,aAAa;IACb,qBAAqB;IACrB,OAAO;IACP,gBAAgB;IAChB,oBAAoB;IACpB,2BAA2B;IAC3B,WAAW;IACX,eAAe;IACf,UAAU;IACV,oBAAoB;IACpB,eAAe;IACf,UAAU;IACV,oBAAoB;IACpB,iBAAiB;IACjB,mBAAmB;IACnB,kBAAkB;IAClB,qBAAqB;IACrB,qBAAqB;IACrB,aAAa;IACb,YAAY;IACZ,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,0BAA0B;IAC1B,cAAc;IACd,mBAAmB;IACnB,sBAAsB;IACtB,iBAAiB;IACjB,kBAAkB;IAClB,sBAAsB;IACtB,iBAAiB;IACjB,qBAAqB;IACrB,qBAAqB;IACrB,uBAAuB;IACvB,qBAAqB;IACrB,uBAAuB;IACvB,kBAAkB;IAClB,kBAAkB;IAClB,uBAAuB;IACvB,eAAe;IACf,iBAAiB;IACjB,gBAAgB;IAChB,mBAAmB;IACnB,sBAAsB;IACtB,qBAAqB;IACrB,qBAAqB;IACrB,0BAA0B;IAC1B,oCAAoC;IACpC,4BAA4B;IAC5B,sCAAsC;CAC9B,CAAC"}
+{"version":3,"file":"ws-api.js","sourceRoot":"","sources":["../../../src/types/websockets/ws-api.ts"],"names":[],"mappings":";;;AAAA,yEAAyE;AAgHzE;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,eAAe;IACf,gBAAgB;IAChB,gBAAgB;IAChB,qBAAqB;IACrB,MAAM;IACN,MAAM;IACN,cAAc;IACd,yBAAyB;IACzB,OAAO;IACP,eAAe;IACf,mBAAmB;IACnB,kBAAkB;IAClB,QAAQ;IACR,UAAU;IACV,UAAU;IACV,gBAAgB;IAChB,gBAAgB;IAChB,4BAA4B;IAC5B,aAAa;IACb,mBAAmB;IACnB,QAAQ;IACR,cAAc;IACd,aAAa;IACb,qBAAqB;IACrB,OAAO;IACP,gBAAgB;IAChB,oBAAoB;IACpB,2BAA2B;IAC3B,WAAW;IACX,eAAe;IACf,UAAU;IACV,oBAAoB;IACpB,eAAe;IACf,UAAU;IACV,oBAAoB;IACpB,iBAAiB;IACjB,mBAAmB;IACnB,kBAAkB;IAClB,qBAAqB;IACrB,qBAAqB;IACrB,aAAa;IACb,YAAY;IACZ,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,0BAA0B;IAC1B,cAAc;IACd,mBAAmB;IACnB,sBAAsB;IACtB,iBAAiB;IACjB,kBAAkB;IAClB,sBAAsB;IACtB,iBAAiB;IACjB,qBAAqB;IACrB,qBAAqB;IACrB,uBAAuB;IACvB,qBAAqB;IACrB,uBAAuB;IACvB,kBAAkB;IAClB,kBAAkB;IAClB,uBAAuB;IACvB,eAAe;IACf,iBAAiB;IACjB,gBAAgB;IAChB,mBAAmB;IACnB,sBAAsB;IACtB,qBAAqB;IACrB,qBAAqB;IACrB,0BAA0B;IAC1B,oCAAoC;IACpC,4BAA4B;IAC5B,sCAAsC;CAC9B,CAAC"}

package/lib/types/websockets/ws-events-formatted.d.ts

@@ -230,6 +230,35 @@ export interface WsMessageSpotUserDataExecutionReportEventFormatted extends WsSh
     orderQuoteQty: number;
     workingTime: number;
     selfTradePreventionMode: SelfTradePreventionMode;
+    expiryReason?: string;
+    trailingDelta?: number;
+    preventedMatchId?: number;
+    trailingTime?: number;
+    strategyId?: number;
+    strategyType?: number;
+    tradeGroupId?: number;
+    counterOrderId?: number;
+    preventedQuantity?: number;
+    lastPreventedQuantity?: number;
+    counterSymbol?: string;
+    preventedExecutionQuantity?: number;
+    preventedExecutionPrice?: number;
+    preventedExecutionQuoteQty?: number;
+}
+export interface WsMessagePortfolioMarginProAccountUpdateFormatted extends WsSharedBase {
+    eventType: 'PM_PRO_ACCOUNT_UPDATE';
+    eventTime: number;
+    uniMMR: number;
+    accountEquity: number;
+    actualEquity: number;
+    initialMargin: number;
+    maintenanceMargin: number;
+    availableBalance: number;
+    virtualMaxWithdraw: number;
+}
+export interface WsMessageWsapiServerShutdownFormatted extends WsSharedBase {
+    eventType: 'serverShutdown';
+    eventTime: number;
 }
 export interface OrderObjectFormatted {
     symbol: string;
@@ -385,6 +414,8 @@ export interface WsMessageMarkPriceEventFormatted extends WsSharedBase {
     eventTime: number;
     symbol: string;
     markPrice: number;
+    /** Mark price moving average (USDⓈ-M). */
+    markPriceMovingAverage?: number;
     settlePriceEstimate: number;
     indexPrice?: number;
     /** Note this is in decimal format (e.g. 0.0004 === 0.04%). Multiply by 100 to get funding rate percent value */
@@ -491,6 +522,6 @@ export interface WsMessageFuturesUserDataAlgoUpdateFormatted extends WsSharedBas
 }
 export type WsMessageSpotUserDataEventFormatted = WsMessageSpotUserDataExecutionReportEventFormatted | WsMessageSpotOutboundAccountPositionFormatted | WsMessageSpotBalanceUpdateFormatted | WsMessageSpotUserDataListStatusEventFormatted;
 export type WsMessageFuturesUserDataEventFormatted = WsMessageFuturesUserDataAccountUpdateFormatted | WsMessageFuturesUserDataListenKeyExpiredFormatted | WsMessageFuturesUserDataMarginCallFormatted | WsMessageFuturesUserDataTradeUpdateEventFormatted | WsMessageFuturesUserDataAlgoUpdateFormatted | WsMessageFuturesUserDataAccountConfigUpdateEventFormatted | WsMessageFuturesUserDataCondOrderTriggerRejectEventFormatted | WsMessageFuturesUserDataTradeLiteEventFormatted | WsMessageFuturesUserDataStrategyUpdateFormatted | WsMessageFuturesUserDataGridUpdateFormatted | WsMessageFuturesUserDataContractInfoFormatted;
-export type WsUserDataEvents = WsMessageSpotUserDataEventFormatted | WsMessageFuturesUserDataEventFormatted;
-export type WsFormattedMessage = WsUserDataEvents | WsMessageKlineFormatted | WsMessageAggTradeFormatted | WsMessageTradeFormatted | WsMessage24hrMiniTickerFormatted | WsMessage24hrTickerFormatted | WsMessageBookTickerEventFormatted | WsMessagePartialBookDepthEventFormatted | WsMessageDiffBookDepthEventFormatted | WsMessageIndexPriceUpdateEventFormatted | WsMessageMarkPriceEventFormatted | WsMessageForceOrderFormatted | WsMessage24hrMiniTickerFormatted[] | WsMessage24hrTickerFormatted[] | WsMessageRollingWindowTickerFormatted[] | WsMessageMarkPriceEventFormatted[];
+export type WsUserDataEvents = WsMessageSpotUserDataEventFormatted | WsMessageFuturesUserDataEventFormatted | WsMessagePortfolioMarginProAccountUpdateFormatted;
+export type WsFormattedMessage = WsUserDataEvents | WsMessageWsapiServerShutdownFormatted | WsMessageKlineFormatted | WsMessageAggTradeFormatted | WsMessageTradeFormatted | WsMessage24hrMiniTickerFormatted | WsMessage24hrTickerFormatted | WsMessageBookTickerEventFormatted | WsMessagePartialBookDepthEventFormatted | WsMessageDiffBookDepthEventFormatted | WsMessageIndexPriceUpdateEventFormatted | WsMessageMarkPriceEventFormatted | WsMessageForceOrderFormatted | WsMessage24hrMiniTickerFormatted[] | WsMessage24hrTickerFormatted[] | WsMessageRollingWindowTickerFormatted[] | WsMessageMarkPriceEventFormatted[];
 export {};

package/lib/types/websockets/ws-events-raw.d.ts

@@ -190,6 +190,36 @@ export interface WsMessageSpotUserDataExecutionReportEventRaw extends WsSharedBa
     Q: numberInString;
     W: number;
     V: SelfTradePreventionMode;
+    /** Expiry reason when present (user data executionReport). */
+    eR?: string;
+    d?: number;
+    v?: number;
+    D?: number;
+    j?: number;
+    J?: number;
+    u?: number;
+    U?: number;
+    A?: numberInString;
+    B?: numberInString;
+    Cs?: string;
+    pl?: numberInString;
+    pL?: numberInString;
+    pY?: numberInString;
+}
+export interface WsMessagePortfolioMarginProAccountUpdateRaw extends WsSharedBase {
+    e: 'PM_PRO_ACCOUNT_UPDATE';
+    E: number;
+    u: numberInString;
+    eq: numberInString;
+    ae: numberInString;
+    im: numberInString;
+    mm: numberInString;
+    avb: numberInString;
+    vmw: numberInString;
+}
+export interface WsMessageWsapiServerShutdownRaw extends WsSharedBase {
+    e: 'serverShutdown';
+    E: number;
 }
 export interface OrderObjectRaw {
     s: string;
@@ -380,6 +410,8 @@ export interface WsMessageMarkPriceUpdateEventRaw extends WsSharedBase {
     E: number;
     s: string;
     p: string;
+    /** Mark price moving average (USDⓈ-M mark price stream). */
+    ap?: string;
     P: string;
     i: string;
     r: string;
@@ -453,6 +485,6 @@ export interface WsMessageFuturesUserDataContractInfoRaw extends WsSharedBase {
 }
 export type WsRawSpotUserDataEventRaw = WsMessageSpotUserDataExecutionReportEventRaw | WsMessageSpotOutboundAccountPositionRaw | WsMessageSpotBalanceUpdateRaw | WsMessageSpotUserDataListStatusEventRaw;
 export type WsMessageFuturesUserDataEventRaw = WsMessageFuturesUserDataAccountUpdateRaw | WsMessageFuturesUserDataListenKeyExpiredRaw | WsMessageFuturesUserDataMarginCallRaw | WsMessageFuturesUserDataOrderTradeUpdateEventRaw | WsMessageFuturesUserDataAlgoUpdateRaw | WsMessageFuturesUserDataAccountConfigUpdateEventRaw | WsMessageFuturesUserDataCondOrderTriggerRejectEventRaw | WsMessageFuturesUserDataTradeLiteEventRaw | WsMessageFuturesUserDataStrategyUpdateRaw | WsMessageFuturesUserDataGridUpdateRaw | WsMessageFuturesUserDataContractInfoRaw;
-export type WsUserDataEventsRaw = WsRawSpotUserDataEventRaw | WsMessageFuturesUserDataEventRaw;
-export type WsRawMessage = WsEventStreamTerminatedRaw | WsUserDataEventsRaw | WsMessageKlineRaw | WsMessageAggTradeRaw | WsMessageTradeRaw | WsMessage24hrMiniTickerRaw | WsMessage24hrMiniTickerRaw[] | WsMessage24hrTickerRaw | WsMessage24hrTickerRaw[] | WsMessageRollingWindowTickerRaw[] | WsMessageBookTickerEventRaw | WsMessagePartialBookDepthEventRaw | WsMessageDiffBookDepthEventRaw | WsMessageForceOrderRaw | WsMessageIndexPriceUpdateEventRaw;
+export type WsUserDataEventsRaw = WsRawSpotUserDataEventRaw | WsMessageFuturesUserDataEventRaw | WsMessagePortfolioMarginProAccountUpdateRaw;
+export type WsRawMessage = WsEventStreamTerminatedRaw | WsMessageWsapiServerShutdownRaw | WsUserDataEventsRaw | WsMessageKlineRaw | WsMessageAggTradeRaw | WsMessageTradeRaw | WsMessage24hrMiniTickerRaw | WsMessage24hrMiniTickerRaw[] | WsMessage24hrTickerRaw | WsMessage24hrTickerRaw[] | WsMessageRollingWindowTickerRaw[] | WsMessageBookTickerEventRaw | WsMessagePartialBookDepthEventRaw | WsMessageDiffBookDepthEventRaw | WsMessageForceOrderRaw | WsMessageIndexPriceUpdateEventRaw;
 export {};

package/lib/util/beautifier-maps.d.ts

@@ -217,6 +217,7 @@ export declare const BEAUTIFIER_EVENT_MAP: {
         E: string;
         s: string;
         p: string;
+        ap: string;
         i: string;
         P: string;
         r: string;
@@ -227,6 +228,7 @@ export declare const BEAUTIFIER_EVENT_MAP: {
         E: string;
         s: string;
         p: string;
+        ap: string;
         i: string;
         P: string;
         r: string;
@@ -238,6 +240,7 @@ export declare const BEAUTIFIER_EVENT_MAP: {
         E: string;
         s: string;
         p: string;
+        ap: string;
         i: string;
         P: string;
         r: string;
@@ -406,6 +409,10 @@ export declare const BEAUTIFIER_EVENT_MAP: {
         e: string;
         E: string;
     };
+    serverShutdownEvent: {
+        e: string;
+        E: string;
+    };
     updateData: {
         m: string;
         P: string;
@@ -468,6 +475,31 @@ export declare const BEAUTIFIER_EVENT_MAP: {
         Q: string;
         W: string;
         V: string;
+        eR: string;
+        d: string;
+        v: string;
+        D: string;
+        j: string;
+        J: string;
+        u: string;
+        U: string;
+        A: string;
+        B: string;
+        Cs: string;
+        pl: string;
+        pL: string;
+        pY: string;
+    };
+    PM_PRO_ACCOUNT_UPDATEEvent: {
+        e: string;
+        E: string;
+        u: string;
+        eq: string;
+        ae: string;
+        im: string;
+        mm: string;
+        avb: string;
+        vmw: string;
     };
     tradeEvent: {
         e: string;