import { BadRequestError, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, RestApiResponse, ServerError, TooManyRequestsError, UnauthorizedError, WebsocketAPIBase, WebsocketApiResponse, WebsocketSendMsgOptions, WebsocketStream, WebsocketStreamsBase } from "@binance/common"; //#region rolldown:runtime //#endregion //#region src/rest-api/types/account-information-response-assets-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AccountInformationResponseAssetsInner */ interface AccountInformationResponseAssetsInner { /** * asset name * @type {string} * @memberof AccountInformationResponseAssetsInner */ asset?: string; /** * total wallet balance * @type {string} * @memberof AccountInformationResponseAssetsInner */ walletBalance?: string; /** * unrealized profit or loss * @type {string} * @memberof AccountInformationResponseAssetsInner */ unrealizedProfit?: string; /** * margin balance * @type {string} * @memberof AccountInformationResponseAssetsInner */ marginBalance?: string; /** * maintenance margin * @type {string} * @memberof AccountInformationResponseAssetsInner */ maintMargin?: string; /** * total intial margin required with the latest mark price * @type {string} * @memberof AccountInformationResponseAssetsInner */ initialMargin?: string; /** * positions margin required with the latest mark price * @type {string} * @memberof AccountInformationResponseAssetsInner */ positionInitialMargin?: string; /** * open orders intial margin required with the latest mark price * @type {string} * @memberof AccountInformationResponseAssetsInner */ openOrderInitialMargin?: string; /** * maximum amount for transfer out * @type {string} * @memberof AccountInformationResponseAssetsInner */ maxWithdrawAmount?: string; /** * wallet balance for crossed margin * @type {string} * @memberof AccountInformationResponseAssetsInner */ crossWalletBalance?: string; /** * total unrealized profit or loss of crossed positions * @type {string} * @memberof AccountInformationResponseAssetsInner */ crossUnPnl?: string; /** * available margin balance * @type {string} * @memberof AccountInformationResponseAssetsInner */ availableBalance?: string; /** * update time * @type {number | bigint} * @memberof AccountInformationResponseAssetsInner */ updateTime?: number | bigint; } //#endregion //#region src/rest-api/types/account-information-response-positions-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AccountInformationResponsePositionsInner */ interface AccountInformationResponsePositionsInner { /** * Trading symbol * @type {string} * @memberof AccountInformationResponsePositionsInner */ symbol?: string; /** * position amount * @type {string} * @memberof AccountInformationResponsePositionsInner */ positionAmt?: string; /** * total intial margin required with the latest mark price * @type {string} * @memberof AccountInformationResponsePositionsInner */ initialMargin?: string; /** * maintenance margin * @type {string} * @memberof AccountInformationResponsePositionsInner */ maintMargin?: string; /** * unrealized profit or loss * @type {string} * @memberof AccountInformationResponsePositionsInner */ unrealizedProfit?: string; /** * positions margin required with the latest mark price * @type {string} * @memberof AccountInformationResponsePositionsInner */ positionInitialMargin?: string; /** * open orders intial margin required with the latest mark price * @type {string} * @memberof AccountInformationResponsePositionsInner */ openOrderInitialMargin?: string; /** * Leverage value. * @type {string} * @memberof AccountInformationResponsePositionsInner */ leverage?: string; /** * Whether isolated margin mode is enabled. * @type {boolean} * @memberof AccountInformationResponsePositionsInner */ isolated?: boolean; /** * Position side * @type {string} * @memberof AccountInformationResponsePositionsInner */ positionSide?: string; /** * Position entry price. * @type {string} * @memberof AccountInformationResponsePositionsInner */ entryPrice?: string; /** * break-even price * @type {string} * @memberof AccountInformationResponsePositionsInner */ breakEvenPrice?: string; /** * maximum quantity of base asset * @type {string} * @memberof AccountInformationResponsePositionsInner */ maxQty?: string; /** * update time * @type {number | bigint} * @memberof AccountInformationResponsePositionsInner */ updateTime?: number | bigint; /** * Notional value. * @type {string} * @memberof AccountInformationResponsePositionsInner */ notionalValue?: string; } //#endregion //#region src/rest-api/types/account-information-response.d.ts /** * * @export * @interface AccountInformationResponse */ interface AccountInformationResponse$1 { /** * Supported assets. * @type {Array} * @memberof AccountInformationResponse */ assets?: Array; /** * Position list. * @type {Array} * @memberof AccountInformationResponse */ positions?: Array; /** * Whether deposits are enabled. * @type {boolean} * @memberof AccountInformationResponse */ canDeposit?: boolean; /** * Whether trading is enabled. * @type {boolean} * @memberof AccountInformationResponse */ canTrade?: boolean; /** * Whether withdrawals are enabled. * @type {boolean} * @memberof AccountInformationResponse */ canWithdraw?: boolean; /** * Fee tier level. * @type {number | bigint} * @memberof AccountInformationResponse */ feeTier?: number | bigint; /** * update time * @type {number | bigint} * @memberof AccountInformationResponse */ updateTime?: number | bigint; } //#endregion //#region src/rest-api/types/account-trade-list-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AccountTradeListResponseInner */ interface AccountTradeListResponseInner { /** * Trading symbol * @type {string} * @memberof AccountTradeListResponseInner */ symbol?: string; /** * positionId * @type {number | bigint} * @memberof AccountTradeListResponseInner */ id?: number | bigint; /** * Sub-order ID * @type {number | bigint} * @memberof AccountTradeListResponseInner */ orderId?: number | bigint; /** * Pair * @type {string} * @memberof AccountTradeListResponseInner */ pair?: string; /** * Trading side * @type {string} * @memberof AccountTradeListResponseInner */ side?: string; /** * Latest token price. * @type {string} * @memberof AccountTradeListResponseInner */ price?: string; /** * Quantity. * @type {string} * @memberof AccountTradeListResponseInner */ qty?: string; /** * Realized PnL. * @type {string} * @memberof AccountTradeListResponseInner */ realizedPnl?: string; /** * Margin asset. * @type {string} * @memberof AccountTradeListResponseInner */ marginAsset?: string; /** * Base asset quantity. * @type {string} * @memberof AccountTradeListResponseInner */ baseQty?: string; /** * Transaction Fee (in Crypto) * @type {string} * @memberof AccountTradeListResponseInner */ commission?: string; /** * Commission asset. * @type {string} * @memberof AccountTradeListResponseInner */ commissionAsset?: string; /** * Time * @type {number | bigint} * @memberof AccountTradeListResponseInner */ time?: number | bigint; /** * Position side * @type {string} * @memberof AccountTradeListResponseInner */ positionSide?: string; /** * Whether the trade is a buy side for the account. * @type {boolean} * @memberof AccountTradeListResponseInner */ buyer?: boolean; /** * Whether the account is maker in this trade. * @type {boolean} * @memberof AccountTradeListResponseInner */ maker?: boolean; } //#endregion //#region src/rest-api/types/account-trade-list-response.d.ts /** * * @export * @interface AccountTradeListResponse */ interface AccountTradeListResponse extends Array {} //#endregion //#region src/rest-api/types/all-orders-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AllOrdersResponseInner */ interface AllOrdersResponseInner { /** * Average execution price * @type {string} * @memberof AllOrdersResponseInner */ avgPrice?: string; /** * Client order ID. * @type {string} * @memberof AllOrdersResponseInner */ clientOrderId?: string; /** * Cumulative base asset amount. * @type {string} * @memberof AllOrdersResponseInner */ cumBase?: string; /** * Executed quantity * @type {string} * @memberof AllOrdersResponseInner */ executedQty?: string; /** * Sub-order ID * @type {number | bigint} * @memberof AllOrdersResponseInner */ orderId?: number | bigint; /** * Original order quantity * @type {string} * @memberof AllOrdersResponseInner */ origQty?: string; /** * Original order type. * @type {string} * @memberof AllOrdersResponseInner */ origType?: string; /** * Latest token price. * @type {string} * @memberof AllOrdersResponseInner */ price?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof AllOrdersResponseInner */ reduceOnly?: boolean; /** * Trading side * @type {string} * @memberof AllOrdersResponseInner */ side?: string; /** * Position side * @type {string} * @memberof AllOrdersResponseInner */ positionSide?: string; /** * Enum：completed，processing * @type {string} * @memberof AllOrdersResponseInner */ status?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof AllOrdersResponseInner */ stopPrice?: string; /** * if Close-All * @type {boolean} * @memberof AllOrdersResponseInner */ closePosition?: boolean; /** * Trading symbol * @type {string} * @memberof AllOrdersResponseInner */ symbol?: string; /** * Pair * @type {string} * @memberof AllOrdersResponseInner */ pair?: string; /** * Time * @type {number | bigint} * @memberof AllOrdersResponseInner */ time?: number | bigint; /** * Time in force * @type {string} * @memberof AllOrdersResponseInner */ timeInForce?: string; /** * Order type. * @type {string} * @memberof AllOrdersResponseInner */ type?: string; /** * activation price, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof AllOrdersResponseInner */ activatePrice?: string; /** * callback rate, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof AllOrdersResponseInner */ priceRate?: string; /** * update time * @type {number | bigint} * @memberof AllOrdersResponseInner */ updateTime?: number | bigint; /** * Stop trigger price type. * @type {string} * @memberof AllOrdersResponseInner */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof AllOrdersResponseInner */ priceProtect?: boolean; /** * price match mode * @type {string} * @memberof AllOrdersResponseInner */ priceMatch?: string; /** * self trading preventation mode * @type {string} * @memberof AllOrdersResponseInner */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/all-orders-response.d.ts /** * * @export * @interface AllOrdersResponse */ interface AllOrdersResponse extends Array {} //#endregion //#region src/rest-api/types/auto-cancel-all-open-orders-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AutoCancelAllOpenOrdersResponse */ interface AutoCancelAllOpenOrdersResponse { /** * Trading symbol * @type {string} * @memberof AutoCancelAllOpenOrdersResponse */ symbol?: string; /** * Countdown cancellation time in milliseconds. * @type {string} * @memberof AutoCancelAllOpenOrdersResponse */ countdownTime?: string; } //#endregion //#region src/rest-api/types/basis-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface BasisResponseInner */ interface BasisResponseInner { /** * index price * @type {string} * @memberof BasisResponseInner */ indexPrice?: string; /** * Contract type. * @type {string} * @memberof BasisResponseInner */ contractType?: string; /** * Basis rate. * @type {string} * @memberof BasisResponseInner */ basisRate?: string; /** * Futures price. * @type {string} * @memberof BasisResponseInner */ futuresPrice?: string; /** * Annualized basis rate. * @type {string} * @memberof BasisResponseInner */ annualizedBasisRate?: string; /** * Basis value. * @type {string} * @memberof BasisResponseInner */ basis?: string; /** * Pair * @type {string} * @memberof BasisResponseInner */ pair?: string; /** * Timestamp in milliseconds. * @type {number | bigint} * @memberof BasisResponseInner */ timestamp?: number | bigint; } //#endregion //#region src/rest-api/types/basis-response.d.ts /** * * @export * @interface BasisResponse */ interface BasisResponse extends Array {} //#endregion //#region src/rest-api/types/cancel-all-open-orders-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CancelAllOpenOrdersResponse */ interface CancelAllOpenOrdersResponse { /** * API response code. \"000000\" indicates success. * @type {number | bigint} * @memberof CancelAllOpenOrdersResponse */ code?: number | bigint; /** * Message details. * @type {string} * @memberof CancelAllOpenOrdersResponse */ msg?: string; } //#endregion //#region src/rest-api/types/cancel-multiple-orders-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CancelMultipleOrdersResponseInner */ interface CancelMultipleOrdersResponseInner { /** * Client order ID. * @type {string} * @memberof CancelMultipleOrdersResponseInner */ clientOrderId?: string; /** * Cumulative filled quantity. * @type {string} * @memberof CancelMultipleOrdersResponseInner */ cumQty?: string; /** * Executed quantity * @type {string} * @memberof CancelMultipleOrdersResponseInner */ executedQty?: string; /** * Sub-order ID * @type {number | bigint} * @memberof CancelMultipleOrdersResponseInner */ orderId?: number | bigint; /** * Original order quantity * @type {string} * @memberof CancelMultipleOrdersResponseInner */ origQty?: string; /** * Latest token price. * @type {string} * @memberof CancelMultipleOrdersResponseInner */ price?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof CancelMultipleOrdersResponseInner */ reduceOnly?: boolean; /** * Trading side * @type {string} * @memberof CancelMultipleOrdersResponseInner */ side?: string; /** * Position side * @type {string} * @memberof CancelMultipleOrdersResponseInner */ positionSide?: string; /** * Enum：completed，processing * @type {string} * @memberof CancelMultipleOrdersResponseInner */ status?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof CancelMultipleOrdersResponseInner */ stopPrice?: string; /** * if Close-All * @type {boolean} * @memberof CancelMultipleOrdersResponseInner */ closePosition?: boolean; /** * Trading symbol * @type {string} * @memberof CancelMultipleOrdersResponseInner */ symbol?: string; /** * Pair * @type {string} * @memberof CancelMultipleOrdersResponseInner */ pair?: string; /** * Time in force * @type {string} * @memberof CancelMultipleOrdersResponseInner */ timeInForce?: string; /** * Original order type. * @type {string} * @memberof CancelMultipleOrdersResponseInner */ origType?: string; /** * Order type. * @type {string} * @memberof CancelMultipleOrdersResponseInner */ type?: string; /** * activation price, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof CancelMultipleOrdersResponseInner */ activatePrice?: string; /** * callback rate, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof CancelMultipleOrdersResponseInner */ priceRate?: string; /** * Stop trigger price type. * @type {string} * @memberof CancelMultipleOrdersResponseInner */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof CancelMultipleOrdersResponseInner */ priceProtect?: boolean; /** * price match mode * @type {string} * @memberof CancelMultipleOrdersResponseInner */ priceMatch?: string; /** * self trading preventation mode * @type {string} * @memberof CancelMultipleOrdersResponseInner */ selfTradePreventionMode?: string; /** * update time * @type {number | bigint} * @memberof CancelMultipleOrdersResponseInner */ updateTime?: number | bigint; /** * API response code. \"000000\" indicates success. * @type {number | bigint} * @memberof CancelMultipleOrdersResponseInner */ code?: number | bigint; /** * Message details. * @type {string} * @memberof CancelMultipleOrdersResponseInner */ msg?: string; } //#endregion //#region src/rest-api/types/cancel-multiple-orders-response.d.ts /** * * @export * @interface CancelMultipleOrdersResponse */ interface CancelMultipleOrdersResponse extends Array {} //#endregion //#region src/rest-api/types/cancel-order-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CancelOrderResponse */ interface CancelOrderResponse$1 { /** * Client order ID. * @type {string} * @memberof CancelOrderResponse */ clientOrderId?: string; /** * Cumulative filled quantity. * @type {string} * @memberof CancelOrderResponse */ cumQty?: string; /** * Executed quantity * @type {string} * @memberof CancelOrderResponse */ executedQty?: string; /** * Sub-order ID * @type {number | bigint} * @memberof CancelOrderResponse */ orderId?: number | bigint; /** * Original order quantity * @type {string} * @memberof CancelOrderResponse */ origQty?: string; /** * Latest token price. * @type {string} * @memberof CancelOrderResponse */ price?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof CancelOrderResponse */ reduceOnly?: boolean; /** * Trading side * @type {string} * @memberof CancelOrderResponse */ side?: string; /** * Position side * @type {string} * @memberof CancelOrderResponse */ positionSide?: string; /** * Enum：completed，processing * @type {string} * @memberof CancelOrderResponse */ status?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof CancelOrderResponse */ stopPrice?: string; /** * if Close-All * @type {boolean} * @memberof CancelOrderResponse */ closePosition?: boolean; /** * Trading symbol * @type {string} * @memberof CancelOrderResponse */ symbol?: string; /** * Pair * @type {string} * @memberof CancelOrderResponse */ pair?: string; /** * Time in force * @type {string} * @memberof CancelOrderResponse */ timeInForce?: string; /** * Original order type. * @type {string} * @memberof CancelOrderResponse */ origType?: string; /** * Order type. * @type {string} * @memberof CancelOrderResponse */ type?: string; /** * activation price, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof CancelOrderResponse */ activatePrice?: string; /** * callback rate, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof CancelOrderResponse */ priceRate?: string; /** * update time * @type {number | bigint} * @memberof CancelOrderResponse */ updateTime?: number | bigint; /** * Stop trigger price type. * @type {string} * @memberof CancelOrderResponse */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof CancelOrderResponse */ priceProtect?: boolean; /** * price match mode * @type {string} * @memberof CancelOrderResponse */ priceMatch?: string; /** * self trading preventation mode * @type {string} * @memberof CancelOrderResponse */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/change-initial-leverage-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ChangeInitialLeverageResponse */ interface ChangeInitialLeverageResponse { /** * Leverage value. * @type {number | bigint} * @memberof ChangeInitialLeverageResponse */ leverage?: number | bigint; /** * maximum quantity of base asset * @type {string} * @memberof ChangeInitialLeverageResponse */ maxQty?: string; /** * Trading symbol * @type {string} * @memberof ChangeInitialLeverageResponse */ symbol?: string; } //#endregion //#region src/rest-api/types/change-margin-type-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ChangeMarginTypeResponse */ interface ChangeMarginTypeResponse { /** * API response code. \"000000\" indicates success. * @type {number | bigint} * @memberof ChangeMarginTypeResponse */ code?: number | bigint; /** * Message details. * @type {string} * @memberof ChangeMarginTypeResponse */ msg?: string; } //#endregion //#region src/rest-api/types/change-position-mode-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ChangePositionModeResponse */ interface ChangePositionModeResponse { /** * API response code. \"000000\" indicates success. * @type {number | bigint} * @memberof ChangePositionModeResponse */ code?: number | bigint; /** * Message details. * @type {string} * @memberof ChangePositionModeResponse */ msg?: string; } //#endregion //#region src/rest-api/types/check-server-time-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CheckServerTimeResponse */ interface CheckServerTimeResponse { /** * Ignore please. If you want to check current server time, please check via \"GET /dapi/v1/time\" * @type {number | bigint} * @memberof CheckServerTimeResponse */ serverTime?: number | bigint; } //#endregion //#region src/rest-api/types/compressed-aggregate-trades-list-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CompressedAggregateTradesListResponseInner */ interface CompressedAggregateTradesListResponseInner { /** * Aggregate tradeId * @type {number | bigint} * @memberof CompressedAggregateTradesListResponseInner */ a?: number | bigint; /** * Price * @type {string} * @memberof CompressedAggregateTradesListResponseInner */ p?: string; /** * Quantity * @type {string} * @memberof CompressedAggregateTradesListResponseInner */ q?: string; /** * First tradeId * @type {number | bigint} * @memberof CompressedAggregateTradesListResponseInner */ f?: number | bigint; /** * Last tradeId * @type {number | bigint} * @memberof CompressedAggregateTradesListResponseInner */ l?: number | bigint; /** * Timestamp * @type {number | bigint} * @memberof CompressedAggregateTradesListResponseInner */ T?: number | bigint; /** * Was the buyer the maker? * @type {boolean} * @memberof CompressedAggregateTradesListResponseInner */ m?: boolean; } //#endregion //#region src/rest-api/types/compressed-aggregate-trades-list-response.d.ts /** * * @export * @interface CompressedAggregateTradesListResponse */ interface CompressedAggregateTradesListResponse extends Array {} //#endregion //#region src/rest-api/types/continuous-contract-kline-candlestick-data-item-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * @type ContinuousContractKlineCandlestickDataItemInner */ type ContinuousContractKlineCandlestickDataItemInner = number | string; //#endregion //#region src/rest-api/types/continuous-contract-kline-candlestick-data-item.d.ts /** * * @export * @interface ContinuousContractKlineCandlestickDataItem */ interface ContinuousContractKlineCandlestickDataItem extends Array {} //#endregion //#region src/rest-api/types/continuous-contract-kline-candlestick-data-response.d.ts /** * * @export * @interface ContinuousContractKlineCandlestickDataResponse */ interface ContinuousContractKlineCandlestickDataResponse extends Array {} //#endregion //#region src/rest-api/types/current-all-open-orders-response.d.ts /** * * @export * @interface CurrentAllOpenOrdersResponse */ interface CurrentAllOpenOrdersResponse extends Array {} //#endregion //#region src/rest-api/types/exchange-information-response-rate-limits-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ExchangeInformationResponseRateLimitsInner */ interface ExchangeInformationResponseRateLimitsInner { /** * Rate limit interval. * @type {string} * @memberof ExchangeInformationResponseRateLimitsInner */ interval?: string; /** * Rate limit interval multiplier. * @type {number | bigint} * @memberof ExchangeInformationResponseRateLimitsInner */ intervalNum?: number | bigint; /** * Maximum allowed orders for this rule. * @type {number | bigint} * @memberof ExchangeInformationResponseRateLimitsInner */ limit?: number | bigint; /** * Rate limit type. * @type {string} * @memberof ExchangeInformationResponseRateLimitsInner */ rateLimitType?: string; } //#endregion //#region src/rest-api/types/exchange-information-response-symbols-inner-filters-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ExchangeInformationResponseSymbolsInnerFiltersInner */ interface ExchangeInformationResponseSymbolsInnerFiltersInner { /** * Filter type. * @type {string} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ filterType?: string; /** * Maximum price. * @type {string} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ maxPrice?: string; /** * Minimum price. * @type {string} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ minPrice?: string; /** * Tick size. * @type {string} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ tickSize?: string; /** * maximum quantity of base asset * @type {string} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ maxQty?: string; /** * Minimum quantity. * @type {string} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ minQty?: string; /** * Step size. * @type {string} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ stepSize?: string; /** * Maximum allowed orders for this rule. * @type {number | bigint} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ limit?: number | bigint; /** * Upper multiplier bound. * @type {string} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ multiplierUp?: string; /** * Lower multiplier bound. * @type {string} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ multiplierDown?: string; /** * Multiplier decimal precision. * @type {string} * @memberof ExchangeInformationResponseSymbolsInnerFiltersInner */ multiplierDecimal?: string; } //#endregion //#region src/rest-api/types/exchange-information-response-symbols-inner.d.ts /** * * @export * @interface ExchangeInformationResponseSymbolsInner */ interface ExchangeInformationResponseSymbolsInner { /** * Trading filters and constraints. * @type {Array} * @memberof ExchangeInformationResponseSymbolsInner */ filters?: Array; /** * Supported order types. * @type {Array} * @memberof ExchangeInformationResponseSymbolsInner */ orderTypes?: Array; /** * Time in force * @type {Array} * @memberof ExchangeInformationResponseSymbolsInner */ timeInForce?: Array; /** * liquidation fee rate * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ liquidationFee?: string; /** * the max price difference rate( from mark price) a market order can make * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ marketTakeBound?: string; /** * Trading symbol * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ symbol?: string; /** * Pair * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ pair?: string; /** * Contract type. * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ contractType?: string; /** * Delivery timestamp. * @type {number | bigint} * @memberof ExchangeInformationResponseSymbolsInner */ deliveryDate?: number | bigint; /** * Onboard timestamp. * @type {number | bigint} * @memberof ExchangeInformationResponseSymbolsInner */ onboardDate?: number | bigint; /** * Contract status. * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ contractStatus?: string; /** * Contract size. * @type {number | bigint} * @memberof ExchangeInformationResponseSymbolsInner */ contractSize?: number | bigint; /** * Quote asset symbol. * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ quoteAsset?: string; /** * Base asset symbol. * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ baseAsset?: string; /** * Margin asset. * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ marginAsset?: string; /** * please do not use it as tickSize * @type {number | bigint} * @memberof ExchangeInformationResponseSymbolsInner */ pricePrecision?: number | bigint; /** * please do not use it as stepSize * @type {number | bigint} * @memberof ExchangeInformationResponseSymbolsInner */ quantityPrecision?: number | bigint; /** * Base asset precision. * @type {number | bigint} * @memberof ExchangeInformationResponseSymbolsInner */ baseAssetPrecision?: number | bigint; /** * Quote asset precision. * @type {number | bigint} * @memberof ExchangeInformationResponseSymbolsInner */ quotePrecision?: number | bigint; /** * ignore * @type {number | bigint} * @memberof ExchangeInformationResponseSymbolsInner */ equalQtyPrecision?: number | bigint; /** * threshold for algo order with \"priceProtect\" * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ triggerProtect?: string; /** * ignore * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ maintMarginPercent?: string; /** * ignore * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ requiredMarginPercent?: string; /** * Underlying asset type. * @type {string} * @memberof ExchangeInformationResponseSymbolsInner */ underlyingType?: string; /** * Underlying asset sub-type. * @type {Array} * @memberof ExchangeInformationResponseSymbolsInner */ underlyingSubType?: Array; } //#endregion //#region src/rest-api/types/exchange-information-response.d.ts /** * * @export * @interface ExchangeInformationResponse */ interface ExchangeInformationResponse { /** * Exchange filters. * @type {Array} * @memberof ExchangeInformationResponse */ exchangeFilters?: Array; /** * Rate limit definitions. * @type {Array} * @memberof ExchangeInformationResponse */ rateLimits?: Array; /** * Ignore please. If you want to check current server time, please check via \"GET /dapi/v1/time\" * @type {number | bigint} * @memberof ExchangeInformationResponse */ serverTime?: number | bigint; /** * Supported trading symbols. * @type {Array} * @memberof ExchangeInformationResponse */ symbols?: Array; /** * Timezone of market data. * @type {string} * @memberof ExchangeInformationResponse */ timezone?: string; } //#endregion //#region src/rest-api/types/futures-account-balance-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface FuturesAccountBalanceResponseInner */ interface FuturesAccountBalanceResponseInner { /** * unique account code * @type {string} * @memberof FuturesAccountBalanceResponseInner */ accountAlias?: string; /** * asset name * @type {string} * @memberof FuturesAccountBalanceResponseInner */ asset?: string; /** * Account balance. * @type {string} * @memberof FuturesAccountBalanceResponseInner */ balance?: string; /** * Available amount for withdrawal. * @type {string} * @memberof FuturesAccountBalanceResponseInner */ withdrawAvailable?: string; /** * wallet balance for crossed margin * @type {string} * @memberof FuturesAccountBalanceResponseInner */ crossWalletBalance?: string; /** * total unrealized profit or loss of crossed positions * @type {string} * @memberof FuturesAccountBalanceResponseInner */ crossUnPnl?: string; /** * available margin balance * @type {string} * @memberof FuturesAccountBalanceResponseInner */ availableBalance?: string; /** * update time * @type {number | bigint} * @memberof FuturesAccountBalanceResponseInner */ updateTime?: number | bigint; } //#endregion //#region src/rest-api/types/futures-account-balance-response.d.ts /** * * @export * @interface FuturesAccountBalanceResponse */ interface FuturesAccountBalanceResponse$1 extends Array {} //#endregion //#region src/rest-api/types/get-current-position-mode-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetCurrentPositionModeResponse */ interface GetCurrentPositionModeResponse { /** * Whether dual-side position mode is enabled. * @type {boolean} * @memberof GetCurrentPositionModeResponse */ dualSidePosition?: boolean; } //#endregion //#region src/rest-api/types/get-download-id-for-futures-order-history-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetDownloadIdForFuturesOrderHistoryResponse */ interface GetDownloadIdForFuturesOrderHistoryResponse { /** * Average time taken for data download in the past 30 days * @type {number | bigint} * @memberof GetDownloadIdForFuturesOrderHistoryResponse */ avgCostTimestampOfLast30d?: number | bigint; /** * Download task ID. * @type {string} * @memberof GetDownloadIdForFuturesOrderHistoryResponse */ downloadId?: string; } //#endregion //#region src/rest-api/types/get-download-id-for-futures-trade-history-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetDownloadIdForFuturesTradeHistoryResponse */ interface GetDownloadIdForFuturesTradeHistoryResponse { /** * Average time taken for data download in the past 30 days * @type {number | bigint} * @memberof GetDownloadIdForFuturesTradeHistoryResponse */ avgCostTimestampOfLast30d?: number | bigint; /** * Download task ID. * @type {string} * @memberof GetDownloadIdForFuturesTradeHistoryResponse */ downloadId?: string; } //#endregion //#region src/rest-api/types/get-download-id-for-futures-transaction-history-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetDownloadIdForFuturesTransactionHistoryResponse */ interface GetDownloadIdForFuturesTransactionHistoryResponse { /** * Average time taken for data download in the past 30 days * @type {number | bigint} * @memberof GetDownloadIdForFuturesTransactionHistoryResponse */ avgCostTimestampOfLast30d?: number | bigint; /** * Download task ID. * @type {string} * @memberof GetDownloadIdForFuturesTransactionHistoryResponse */ downloadId?: string; } //#endregion //#region src/rest-api/types/get-funding-rate-history-of-perpetual-futures-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetFundingRateHistoryOfPerpetualFuturesResponseInner */ interface GetFundingRateHistoryOfPerpetualFuturesResponseInner { /** * Trading symbol * @type {string} * @memberof GetFundingRateHistoryOfPerpetualFuturesResponseInner */ symbol?: string; /** * Funding time. * @type {number | bigint} * @memberof GetFundingRateHistoryOfPerpetualFuturesResponseInner */ fundingTime?: number | bigint; /** * Funding rate. * @type {string} * @memberof GetFundingRateHistoryOfPerpetualFuturesResponseInner */ fundingRate?: string; } //#endregion //#region src/rest-api/types/get-funding-rate-history-of-perpetual-futures-response.d.ts /** * * @export * @interface GetFundingRateHistoryOfPerpetualFuturesResponse */ interface GetFundingRateHistoryOfPerpetualFuturesResponse extends Array {} //#endregion //#region src/rest-api/types/get-funding-rate-info-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetFundingRateInfoResponseInner */ interface GetFundingRateInfoResponseInner { /** * Trading symbol * @type {string} * @memberof GetFundingRateInfoResponseInner */ symbol?: string; /** * Adjusted funding rate cap. * @type {string} * @memberof GetFundingRateInfoResponseInner */ adjustedFundingRateCap?: string; /** * Adjusted funding rate floor. * @type {string} * @memberof GetFundingRateInfoResponseInner */ adjustedFundingRateFloor?: string; /** * Funding interval in hours. * @type {number | bigint} * @memberof GetFundingRateInfoResponseInner */ fundingIntervalHours?: number | bigint; /** * Disclaimer text. * @type {boolean} * @memberof GetFundingRateInfoResponseInner */ disclaimer?: boolean; } //#endregion //#region src/rest-api/types/get-funding-rate-info-response.d.ts /** * * @export * @interface GetFundingRateInfoResponse */ interface GetFundingRateInfoResponse extends Array {} //#endregion //#region src/rest-api/types/get-futures-order-history-download-link-by-id-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetFuturesOrderHistoryDownloadLinkByIdResponse */ interface GetFuturesOrderHistoryDownloadLinkByIdResponse { /** * Download task ID. * @type {string} * @memberof GetFuturesOrderHistoryDownloadLinkByIdResponse */ downloadId?: string; /** * Enum：completed，processing * @type {string} * @memberof GetFuturesOrderHistoryDownloadLinkByIdResponse */ status?: string; /** * The link is mapped to download id * @type {string} * @memberof GetFuturesOrderHistoryDownloadLinkByIdResponse */ url?: string; /** * ignore * @type {boolean} * @memberof GetFuturesOrderHistoryDownloadLinkByIdResponse */ notified?: boolean; /** * The link would expire after this timestamp * @type {number | bigint} * @memberof GetFuturesOrderHistoryDownloadLinkByIdResponse */ expirationTimestamp?: number | bigint; /** * Whether the record is expired. * @type {string} * @memberof GetFuturesOrderHistoryDownloadLinkByIdResponse */ isExpired?: string; } //#endregion //#region src/rest-api/types/get-futures-trade-download-link-by-id-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetFuturesTradeDownloadLinkByIdResponse */ interface GetFuturesTradeDownloadLinkByIdResponse { /** * Download task ID. * @type {string} * @memberof GetFuturesTradeDownloadLinkByIdResponse */ downloadId?: string; /** * Enum：completed，processing * @type {string} * @memberof GetFuturesTradeDownloadLinkByIdResponse */ status?: string; /** * The link is mapped to download id * @type {string} * @memberof GetFuturesTradeDownloadLinkByIdResponse */ url?: string; /** * ignore * @type {boolean} * @memberof GetFuturesTradeDownloadLinkByIdResponse */ notified?: boolean; /** * The link would expire after this timestamp * @type {number | bigint} * @memberof GetFuturesTradeDownloadLinkByIdResponse */ expirationTimestamp?: number | bigint; /** * Whether the record is expired. * @type {string} * @memberof GetFuturesTradeDownloadLinkByIdResponse */ isExpired?: string; } //#endregion //#region src/rest-api/types/get-futures-transaction-history-download-link-by-id-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetFuturesTransactionHistoryDownloadLinkByIdResponse */ interface GetFuturesTransactionHistoryDownloadLinkByIdResponse { /** * Download task ID. * @type {string} * @memberof GetFuturesTransactionHistoryDownloadLinkByIdResponse */ downloadId?: string; /** * Enum：completed，processing * @type {string} * @memberof GetFuturesTransactionHistoryDownloadLinkByIdResponse */ status?: string; /** * The link is mapped to download id * @type {string} * @memberof GetFuturesTransactionHistoryDownloadLinkByIdResponse */ url?: string; /** * ignore * @type {boolean} * @memberof GetFuturesTransactionHistoryDownloadLinkByIdResponse */ notified?: boolean; /** * The link would expire after this timestamp * @type {number | bigint} * @memberof GetFuturesTransactionHistoryDownloadLinkByIdResponse */ expirationTimestamp?: number | bigint; /** * Whether the record is expired. * @type {string} * @memberof GetFuturesTransactionHistoryDownloadLinkByIdResponse */ isExpired?: string; } //#endregion //#region src/rest-api/types/get-income-history-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetIncomeHistoryResponseInner */ interface GetIncomeHistoryResponseInner { /** * Trading symbol * @type {string} * @memberof GetIncomeHistoryResponseInner */ symbol?: string; /** * income type * @type {string} * @memberof GetIncomeHistoryResponseInner */ incomeType?: string; /** * income amount * @type {string} * @memberof GetIncomeHistoryResponseInner */ income?: string; /** * asset name * @type {string} * @memberof GetIncomeHistoryResponseInner */ asset?: string; /** * extra information * @type {string} * @memberof GetIncomeHistoryResponseInner */ info?: string; /** * Time * @type {number | bigint} * @memberof GetIncomeHistoryResponseInner */ time?: number | bigint; /** * transaction id * @type {string} * @memberof GetIncomeHistoryResponseInner */ tranId?: string; /** * Trade ID. * @type {string} * @memberof GetIncomeHistoryResponseInner */ tradeId?: string; } //#endregion //#region src/rest-api/types/get-income-history-response.d.ts /** * * @export * @interface GetIncomeHistoryResponse */ interface GetIncomeHistoryResponse extends Array {} //#endregion //#region src/rest-api/types/get-order-modify-history-response-inner-amendment-orig-qty.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Original order quantity * @export * @interface GetOrderModifyHistoryResponseInnerAmendmentOrigQty */ interface GetOrderModifyHistoryResponseInnerAmendmentOrigQty { /** * Before value. * @type {string} * @memberof GetOrderModifyHistoryResponseInnerAmendmentOrigQty */ before?: string; /** * After value. * @type {string} * @memberof GetOrderModifyHistoryResponseInnerAmendmentOrigQty */ after?: string; } //#endregion //#region src/rest-api/types/get-order-modify-history-response-inner-amendment-price.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Latest token price. * @export * @interface GetOrderModifyHistoryResponseInnerAmendmentPrice */ interface GetOrderModifyHistoryResponseInnerAmendmentPrice { /** * Before value. * @type {string} * @memberof GetOrderModifyHistoryResponseInnerAmendmentPrice */ before?: string; /** * After value. * @type {string} * @memberof GetOrderModifyHistoryResponseInnerAmendmentPrice */ after?: string; } //#endregion //#region src/rest-api/types/get-order-modify-history-response-inner-amendment.d.ts /** * Order amendment details. * @export * @interface GetOrderModifyHistoryResponseInnerAmendment */ interface GetOrderModifyHistoryResponseInnerAmendment { /** * * @type {GetOrderModifyHistoryResponseInnerAmendmentPrice} * @memberof GetOrderModifyHistoryResponseInnerAmendment */ price?: GetOrderModifyHistoryResponseInnerAmendmentPrice; /** * * @type {GetOrderModifyHistoryResponseInnerAmendmentOrigQty} * @memberof GetOrderModifyHistoryResponseInnerAmendment */ origQty?: GetOrderModifyHistoryResponseInnerAmendmentOrigQty; /** * Total number of trades in the 24h window. * @type {number | bigint} * @memberof GetOrderModifyHistoryResponseInnerAmendment */ count?: number | bigint; /** * user-defined modification identifier, only returned if provided in the request * @type {number | bigint} * @memberof GetOrderModifyHistoryResponseInnerAmendment */ modifyId?: number | bigint; } //#endregion //#region src/rest-api/types/get-order-modify-history-response-inner.d.ts /** * * @export * @interface GetOrderModifyHistoryResponseInner */ interface GetOrderModifyHistoryResponseInner { /** * Order modification ID * @type {number | bigint} * @memberof GetOrderModifyHistoryResponseInner */ amendmentId?: number | bigint; /** * Trading symbol * @type {string} * @memberof GetOrderModifyHistoryResponseInner */ symbol?: string; /** * Pair * @type {string} * @memberof GetOrderModifyHistoryResponseInner */ pair?: string; /** * Sub-order ID * @type {number | bigint} * @memberof GetOrderModifyHistoryResponseInner */ orderId?: number | bigint; /** * Client order ID. * @type {string} * @memberof GetOrderModifyHistoryResponseInner */ clientOrderId?: string; /** * Time * @type {number | bigint} * @memberof GetOrderModifyHistoryResponseInner */ time?: number | bigint; /** * * @type {GetOrderModifyHistoryResponseInnerAmendment} * @memberof GetOrderModifyHistoryResponseInner */ amendment?: GetOrderModifyHistoryResponseInnerAmendment; } //#endregion //#region src/rest-api/types/get-order-modify-history-response.d.ts /** * * @export * @interface GetOrderModifyHistoryResponse */ interface GetOrderModifyHistoryResponse extends Array {} //#endregion //#region src/rest-api/types/get-position-margin-change-history-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetPositionMarginChangeHistoryResponseInner */ interface GetPositionMarginChangeHistoryResponseInner { /** * Amount. * @type {string} * @memberof GetPositionMarginChangeHistoryResponseInner */ amount?: string; /** * asset name * @type {string} * @memberof GetPositionMarginChangeHistoryResponseInner */ asset?: string; /** * Trading symbol * @type {string} * @memberof GetPositionMarginChangeHistoryResponseInner */ symbol?: string; /** * Time * @type {number | bigint} * @memberof GetPositionMarginChangeHistoryResponseInner */ time?: number | bigint; /** * Order type. * @type {number | bigint} * @memberof GetPositionMarginChangeHistoryResponseInner */ type?: number | bigint; /** * Position side * @type {string} * @memberof GetPositionMarginChangeHistoryResponseInner */ positionSide?: string; } //#endregion //#region src/rest-api/types/get-position-margin-change-history-response.d.ts /** * * @export * @interface GetPositionMarginChangeHistoryResponse */ interface GetPositionMarginChangeHistoryResponse extends Array {} //#endregion //#region src/rest-api/types/index-price-and-mark-price-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface IndexPriceAndMarkPriceResponseInner */ interface IndexPriceAndMarkPriceResponseInner { /** * Trading symbol * @type {string} * @memberof IndexPriceAndMarkPriceResponseInner */ symbol?: string; /** * Pair * @type {string} * @memberof IndexPriceAndMarkPriceResponseInner */ pair?: string; /** * mark price * @type {string} * @memberof IndexPriceAndMarkPriceResponseInner */ markPrice?: string; /** * index price * @type {string} * @memberof IndexPriceAndMarkPriceResponseInner */ indexPrice?: string; /** * Estimated Settle Price, only useful in the last hour before the settlement starts. * @type {string} * @memberof IndexPriceAndMarkPriceResponseInner */ estimatedSettlePrice?: string; /** * the lasted funding rate, for perpetual contract symbols only. For delivery symbols, \"\" will be shown. * @type {string} * @memberof IndexPriceAndMarkPriceResponseInner */ lastFundingRate?: string; /** * the base asset interest rate, for perpetual contract symbols only. For delivery symbols, \"\" will be shown. * @type {string} * @memberof IndexPriceAndMarkPriceResponseInner */ interestRate?: string; /** * For perpetual contract symbols only. For delivery symbols, 0 will be shown * @type {number | bigint} * @memberof IndexPriceAndMarkPriceResponseInner */ nextFundingTime?: number | bigint; /** * Time * @type {number | bigint} * @memberof IndexPriceAndMarkPriceResponseInner */ time?: number | bigint; } //#endregion //#region src/rest-api/types/index-price-and-mark-price-response.d.ts /** * * @export * @interface IndexPriceAndMarkPriceResponse */ interface IndexPriceAndMarkPriceResponse extends Array {} //#endregion //#region src/rest-api/types/index-price-kline-candlestick-data-item-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * @type IndexPriceKlineCandlestickDataItemInner */ type IndexPriceKlineCandlestickDataItemInner = number | string; //#endregion //#region src/rest-api/types/index-price-kline-candlestick-data-item.d.ts /** * * @export * @interface IndexPriceKlineCandlestickDataItem */ interface IndexPriceKlineCandlestickDataItem extends Array {} //#endregion //#region src/rest-api/types/index-price-kline-candlestick-data-response.d.ts /** * * @export * @interface IndexPriceKlineCandlestickDataResponse */ interface IndexPriceKlineCandlestickDataResponse extends Array {} //#endregion //#region src/rest-api/types/keepalive-user-data-stream-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface KeepaliveUserDataStreamResponse */ interface KeepaliveUserDataStreamResponse$1 { /** * Listen key. * @type {string} * @memberof KeepaliveUserDataStreamResponse */ listenKey?: string; } //#endregion //#region src/rest-api/types/kline-candlestick-data-item.d.ts /** * * @export * @interface KlineCandlestickDataItem */ interface KlineCandlestickDataItem extends Array {} //#endregion //#region src/rest-api/types/kline-candlestick-data-response.d.ts /** * * @export * @interface KlineCandlestickDataResponse */ interface KlineCandlestickDataResponse extends Array {} //#endregion //#region src/rest-api/types/long-short-ratio-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface LongShortRatioResponseInner */ interface LongShortRatioResponseInner { /** * Pair * @type {string} * @memberof LongShortRatioResponseInner */ pair?: string; /** * Long/short ratio. * @type {string} * @memberof LongShortRatioResponseInner */ longShortRatio?: string; /** * 64.42% * @type {string} * @memberof LongShortRatioResponseInner */ longAccount?: string; /** * 35.58% * @type {string} * @memberof LongShortRatioResponseInner */ shortAccount?: string; /** * Timestamp in milliseconds. * @type {number | bigint} * @memberof LongShortRatioResponseInner */ timestamp?: number | bigint; } //#endregion //#region src/rest-api/types/long-short-ratio-response.d.ts /** * * @export * @interface LongShortRatioResponse */ interface LongShortRatioResponse extends Array {} //#endregion //#region src/rest-api/types/mark-price-kline-candlestick-data-item.d.ts /** * * @export * @interface MarkPriceKlineCandlestickDataItem */ interface MarkPriceKlineCandlestickDataItem extends Array {} //#endregion //#region src/rest-api/types/mark-price-kline-candlestick-data-response.d.ts /** * * @export * @interface MarkPriceKlineCandlestickDataResponse */ interface MarkPriceKlineCandlestickDataResponse extends Array {} //#endregion //#region src/rest-api/types/modify-isolated-position-margin-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ModifyIsolatedPositionMarginResponse */ interface ModifyIsolatedPositionMarginResponse { /** * Amount. * @type {number} * @memberof ModifyIsolatedPositionMarginResponse */ amount?: number; /** * API response code. \"000000\" indicates success. * @type {number | bigint} * @memberof ModifyIsolatedPositionMarginResponse */ code?: number | bigint; /** * Message details. * @type {string} * @memberof ModifyIsolatedPositionMarginResponse */ msg?: string; /** * Order type. * @type {number | bigint} * @memberof ModifyIsolatedPositionMarginResponse */ type?: number | bigint; } //#endregion //#region src/rest-api/types/modify-multiple-orders-batch-orders-parameter-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ModifyMultipleOrdersBatchOrdersParameterInner */ interface ModifyMultipleOrdersBatchOrdersParameterInner { /** * Sub-order ID, required when clientOrderId is not sent. * @type {number | bigint} * @memberof ModifyMultipleOrdersBatchOrdersParameterInner */ orderId?: number | bigint; /** * Client order ID, required when orderId is not sent. Only support letters, numbers and underscores, and must be unique within 24 hours. * @type {string} * @memberof ModifyMultipleOrdersBatchOrdersParameterInner */ origClientOrderId?: string; /** * Trading symbol * @type {string} * @memberof ModifyMultipleOrdersBatchOrdersParameterInner */ symbol: string; /** * Trading side * @type {string} * @memberof ModifyMultipleOrdersBatchOrdersParameterInner */ side: ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum; /** * Order quantity, cannot be sent with closePosition=true. **After CM migration, this parameter becomes mandatory** (each batch element must send both `price` and `quantity`). * @type {number} * @memberof ModifyMultipleOrdersBatchOrdersParameterInner */ quantity?: number; /** * Latest token price. **After CM migration, this parameter becomes mandatory** (each batch element must send both `price` and `quantity`). * @type {number} * @memberof ModifyMultipleOrdersBatchOrdersParameterInner */ price?: number; /** * User-defined modification identifier, returned as-is in the response. Optional; not validated for uniqueness. * @type {number | bigint} * @memberof ModifyMultipleOrdersBatchOrdersParameterInner */ modifyId?: number | bigint; /** * * @type {number | bigint} * @memberof ModifyMultipleOrdersBatchOrdersParameterInner */ recvWindow?: number | bigint; /** * Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints. * @type {number | bigint} * @memberof ModifyMultipleOrdersBatchOrdersParameterInner */ timestamp: number | bigint; } declare const ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum: { readonly BUY: "BUY"; readonly SELL: "SELL"; }; type ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum = (typeof ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum)[keyof typeof ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum]; //#endregion //#region src/rest-api/types/modify-multiple-orders-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ModifyMultipleOrdersResponseInner */ interface ModifyMultipleOrdersResponseInner { /** * Sub-order ID * @type {number | bigint} * @memberof ModifyMultipleOrdersResponseInner */ orderId?: number | bigint; /** * Trading symbol * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ symbol?: string; /** * Pair * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ pair?: string; /** * Enum：completed，processing * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ status?: string; /** * Client order ID. * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ clientOrderId?: string; /** * user-defined modification identifier, only returned if provided in the request * @type {number | bigint} * @memberof ModifyMultipleOrdersResponseInner */ modifyId?: number | bigint; /** * Latest token price. * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ price?: string; /** * Original order quantity * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ origQty?: string; /** * Executed quantity * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ executedQty?: string; /** * Cumulative filled quantity. * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ cumQty?: string; /** * Time in force * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ timeInForce?: string; /** * Order type. * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ type?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof ModifyMultipleOrdersResponseInner */ reduceOnly?: boolean; /** * if Close-All * @type {boolean} * @memberof ModifyMultipleOrdersResponseInner */ closePosition?: boolean; /** * Trading side * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ side?: string; /** * Position side * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ positionSide?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ stopPrice?: string; /** * Stop trigger price type. * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof ModifyMultipleOrdersResponseInner */ priceProtect?: boolean; /** * Original order type. * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ origType?: string; /** * price match mode * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ priceMatch?: string; /** * self trading preventation mode * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ selfTradePreventionMode?: string; /** * update time * @type {number | bigint} * @memberof ModifyMultipleOrdersResponseInner */ updateTime?: number | bigint; /** * API response code. \"000000\" indicates success. * @type {number | bigint} * @memberof ModifyMultipleOrdersResponseInner */ code?: number | bigint; /** * Message details. * @type {string} * @memberof ModifyMultipleOrdersResponseInner */ msg?: string; } //#endregion //#region src/rest-api/types/modify-multiple-orders-response.d.ts /** * * @export * @interface ModifyMultipleOrdersResponse */ interface ModifyMultipleOrdersResponse extends Array {} //#endregion //#region src/rest-api/types/modify-order-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ModifyOrderResponse */ interface ModifyOrderResponse$1 { /** * Sub-order ID * @type {number | bigint} * @memberof ModifyOrderResponse */ orderId?: number | bigint; /** * Trading symbol * @type {string} * @memberof ModifyOrderResponse */ symbol?: string; /** * Pair * @type {string} * @memberof ModifyOrderResponse */ pair?: string; /** * Enum：completed，processing * @type {string} * @memberof ModifyOrderResponse */ status?: string; /** * Client order ID. * @type {string} * @memberof ModifyOrderResponse */ clientOrderId?: string; /** * user-defined modification identifier, only returned if provided in the request * @type {number | bigint} * @memberof ModifyOrderResponse */ modifyId?: number | bigint; /** * Latest token price. * @type {string} * @memberof ModifyOrderResponse */ price?: string; /** * Original order quantity * @type {string} * @memberof ModifyOrderResponse */ origQty?: string; /** * Executed quantity * @type {string} * @memberof ModifyOrderResponse */ executedQty?: string; /** * Cumulative filled quantity. * @type {string} * @memberof ModifyOrderResponse */ cumQty?: string; /** * Time in force * @type {string} * @memberof ModifyOrderResponse */ timeInForce?: string; /** * Order type. * @type {string} * @memberof ModifyOrderResponse */ type?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof ModifyOrderResponse */ reduceOnly?: boolean; /** * if Close-All * @type {boolean} * @memberof ModifyOrderResponse */ closePosition?: boolean; /** * Trading side * @type {string} * @memberof ModifyOrderResponse */ side?: string; /** * Position side * @type {string} * @memberof ModifyOrderResponse */ positionSide?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof ModifyOrderResponse */ stopPrice?: string; /** * Stop trigger price type. * @type {string} * @memberof ModifyOrderResponse */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof ModifyOrderResponse */ priceProtect?: boolean; /** * Original order type. * @type {string} * @memberof ModifyOrderResponse */ origType?: string; /** * price match mode * @type {string} * @memberof ModifyOrderResponse */ priceMatch?: string; /** * self trading preventation mode * @type {string} * @memberof ModifyOrderResponse */ selfTradePreventionMode?: string; /** * update time * @type {number | bigint} * @memberof ModifyOrderResponse */ updateTime?: number | bigint; } //#endregion //#region src/rest-api/types/new-order-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface NewOrderResponse */ interface NewOrderResponse$1 { /** * Client order ID. * @type {string} * @memberof NewOrderResponse */ clientOrderId?: string; /** * Cumulative filled quantity. * @type {string} * @memberof NewOrderResponse */ cumQty?: string; /** * Executed quantity * @type {string} * @memberof NewOrderResponse */ executedQty?: string; /** * Sub-order ID * @type {number | bigint} * @memberof NewOrderResponse */ orderId?: number | bigint; /** * Original order quantity * @type {string} * @memberof NewOrderResponse */ origQty?: string; /** * Latest token price. * @type {string} * @memberof NewOrderResponse */ price?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof NewOrderResponse */ reduceOnly?: boolean; /** * if Close-All * @type {boolean} * @memberof NewOrderResponse */ closePosition?: boolean; /** * Trading side * @type {string} * @memberof NewOrderResponse */ side?: string; /** * Position side * @type {string} * @memberof NewOrderResponse */ positionSide?: string; /** * Enum：completed，processing * @type {string} * @memberof NewOrderResponse */ status?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof NewOrderResponse */ stopPrice?: string; /** * Trading symbol * @type {string} * @memberof NewOrderResponse */ symbol?: string; /** * Pair * @type {string} * @memberof NewOrderResponse */ pair?: string; /** * Time in force * @type {string} * @memberof NewOrderResponse */ timeInForce?: string; /** * Order type. * @type {string} * @memberof NewOrderResponse */ type?: string; /** * Original order type. * @type {string} * @memberof NewOrderResponse */ origType?: string; /** * activation price, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof NewOrderResponse */ activatePrice?: string; /** * callback rate, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof NewOrderResponse */ priceRate?: string; /** * update time * @type {number | bigint} * @memberof NewOrderResponse */ updateTime?: number | bigint; /** * Stop trigger price type. * @type {string} * @memberof NewOrderResponse */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof NewOrderResponse */ priceProtect?: boolean; /** * price match mode * @type {string} * @memberof NewOrderResponse */ priceMatch?: string; /** * self trading preventation mode * @type {string} * @memberof NewOrderResponse */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/notional-bracket-for-pair-response-inner-brackets-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface NotionalBracketForPairResponseInnerBracketsInner */ interface NotionalBracketForPairResponseInnerBracketsInner { /** * bracket level * @type {number | bigint} * @memberof NotionalBracketForPairResponseInnerBracketsInner */ bracket?: number | bigint; /** * the maximum leverage * @type {number | bigint} * @memberof NotionalBracketForPairResponseInnerBracketsInner */ initialLeverage?: number | bigint; /** * upper edge of base asset quantity * @type {number | bigint} * @memberof NotionalBracketForPairResponseInnerBracketsInner */ qtyCap?: number | bigint; /** * lower edge of base asset quantity * @type {number | bigint} * @memberof NotionalBracketForPairResponseInnerBracketsInner */ qtylFloor?: number | bigint; /** * Maintenance margin ratio. * @type {number} * @memberof NotionalBracketForPairResponseInnerBracketsInner */ maintMarginRatio?: number; /** * Cumulative value. * @type {number} * @memberof NotionalBracketForPairResponseInnerBracketsInner */ cum?: number; } //#endregion //#region src/rest-api/types/notional-bracket-for-pair-response-inner.d.ts /** * * @export * @interface NotionalBracketForPairResponseInner */ interface NotionalBracketForPairResponseInner { /** * Pair * @type {string} * @memberof NotionalBracketForPairResponseInner */ pair?: string; /** * Leverage bracket details. * @type {Array} * @memberof NotionalBracketForPairResponseInner */ brackets?: Array; } //#endregion //#region src/rest-api/types/notional-bracket-for-pair-response.d.ts /** * * @export * @interface NotionalBracketForPairResponse */ interface NotionalBracketForPairResponse extends Array {} //#endregion //#region src/rest-api/types/notional-bracket-for-symbol-response-inner.d.ts /** * * @export * @interface NotionalBracketForSymbolResponseInner */ interface NotionalBracketForSymbolResponseInner { /** * Trading symbol * @type {string} * @memberof NotionalBracketForSymbolResponseInner */ symbol?: string; /** * user symbol bracket multiplier, only appears when user\'s symbol bracket is adjusted * @type {number} * @memberof NotionalBracketForSymbolResponseInner */ notionalCoef?: number; /** * Leverage bracket details. * @type {Array} * @memberof NotionalBracketForSymbolResponseInner */ brackets?: Array; } //#endregion //#region src/rest-api/types/notional-bracket-for-symbol-response.d.ts /** * * @export * @interface NotionalBracketForSymbolResponse */ interface NotionalBracketForSymbolResponse extends Array {} //#endregion //#region src/rest-api/types/old-trades-lookup-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface OldTradesLookupResponseInner */ interface OldTradesLookupResponseInner { /** * positionId * @type {number | bigint} * @memberof OldTradesLookupResponseInner */ id?: number | bigint; /** * Latest token price. * @type {string} * @memberof OldTradesLookupResponseInner */ price?: string; /** * Quantity. * @type {string} * @memberof OldTradesLookupResponseInner */ qty?: string; /** * Base asset quantity. * @type {string} * @memberof OldTradesLookupResponseInner */ baseQty?: string; /** * Time * @type {number | bigint} * @memberof OldTradesLookupResponseInner */ time?: number | bigint; /** * Whether buyer is market maker. * @type {boolean} * @memberof OldTradesLookupResponseInner */ isBuyerMaker?: boolean; } //#endregion //#region src/rest-api/types/old-trades-lookup-response.d.ts /** * * @export * @interface OldTradesLookupResponse */ interface OldTradesLookupResponse extends Array {} //#endregion //#region src/rest-api/types/open-interest-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface OpenInterestResponse */ interface OpenInterestResponse { /** * Trading symbol * @type {string} * @memberof OpenInterestResponse */ symbol?: string; /** * Pair * @type {string} * @memberof OpenInterestResponse */ pair?: string; /** * Open interest. * @type {string} * @memberof OpenInterestResponse */ openInterest?: string; /** * Contract type. * @type {string} * @memberof OpenInterestResponse */ contractType?: string; /** * Time * @type {number | bigint} * @memberof OpenInterestResponse */ time?: number | bigint; } //#endregion //#region src/rest-api/types/open-interest-statistics-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface OpenInterestStatisticsResponseInner */ interface OpenInterestStatisticsResponseInner { /** * Pair * @type {string} * @memberof OpenInterestStatisticsResponseInner */ pair?: string; /** * Contract type. * @type {string} * @memberof OpenInterestStatisticsResponseInner */ contractType?: string; /** * unit: cont * @type {string} * @memberof OpenInterestStatisticsResponseInner */ sumOpenInterest?: string; /** * unit: base asset * @type {string} * @memberof OpenInterestStatisticsResponseInner */ sumOpenInterestValue?: string; /** * Timestamp in milliseconds. * @type {number | bigint} * @memberof OpenInterestStatisticsResponseInner */ timestamp?: number | bigint; } //#endregion //#region src/rest-api/types/open-interest-statistics-response.d.ts /** * * @export * @interface OpenInterestStatisticsResponse */ interface OpenInterestStatisticsResponse extends Array {} //#endregion //#region src/rest-api/types/order-book-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface OrderBookResponse */ interface OrderBookResponse { /** * Last update ID. * @type {number | bigint} * @memberof OrderBookResponse */ lastUpdateId?: number | bigint; /** * Trading symbol * @type {string} * @memberof OrderBookResponse */ symbol?: string; /** * Pair * @type {string} * @memberof OrderBookResponse */ pair?: string; /** * Message output time * @type {number | bigint} * @memberof OrderBookResponse */ E?: number | bigint; /** * Transaction time * @type {number | bigint} * @memberof OrderBookResponse */ T?: number | bigint; /** * Bid orders. Each entry is [price, quantity]. * @type {Array>} * @memberof OrderBookResponse */ bids?: Array>; /** * Ask orders. Each entry is [price, quantity]. * @type {Array>} * @memberof OrderBookResponse */ asks?: Array>; } //#endregion //#region src/rest-api/types/place-multiple-orders-batch-orders-parameter-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface PlaceMultipleOrdersBatchOrdersParameterInner */ interface PlaceMultipleOrdersBatchOrdersParameterInner { /** * Symbol * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ symbol: string; /** * * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ side: PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum; /** * Default `BOTH` for One-way Mode ; `LONG` or `SHORT` for Hedge Mode. It must be sent with Hedge Mode. * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ positionSide?: PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum; /** * **After CM migration, stop-type values (`STOP`, `STOP_MARKET`, `TAKE_PROFIT`, `TAKE_PROFIT_MARKET`, `TRAILING_STOP_MARKET`) are no longer accepted on a per-element basis and will return element-level `-4120`. Use the new `/dapi/v1/algoOrder` endpoint instead.** * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ type: PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum; /** * * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ timeInForce?: PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum; /** * quantity measured by contract number * @type {number} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ quantity: number; /** * * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ reduceOnly?: PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum; /** * Order price * @type {number} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ price?: number; /** * A unique id among open orders. Automatically generated if not sent. Can only be string following the rule: `^[\\.A-Z\\:/a-z0-9_-]{1,36}$` * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ newClientOrderId?: string; /** * Used with `STOP/STOP_MARKET` or `TAKE_PROFIT/TAKE_PROFIT_MARKET` orders. * @type {number} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ stopPrice?: number; /** * Used with `TRAILING_STOP_MARKET` orders, default as the latest price(supporting different `workingType`) * @type {number} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ activationPrice?: number; /** * Used with `TRAILING_STOP_MARKET` orders, min 0.1, max 4 where 1 for 1% * @type {number} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ callbackRate?: number; /** * * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ workingType?: PlaceMultipleOrdersBatchOrdersParameterInnerWorkingTypeEnum; /** * Used with `STOP/STOP_MARKET` or `TAKE_PROFIT/TAKE_PROFIT_MARKET` orders. * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ priceProtect?: PlaceMultipleOrdersBatchOrdersParameterInnerPriceProtectEnum; /** * * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ newOrderRespType?: PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum; /** * only avaliable for `LIMIT`/`STOP`/`TAKE_PROFIT` order; can\'t be passed together with `price` * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ priceMatch?: PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum; /** * `EXPIRE_TAKER`:expire taker order when STP triggers/ `EXPIRE_MAKER`:expire taker order when STP triggers/ `EXPIRE_BOTH`:expire both orders when STP triggers * @type {string} * @memberof PlaceMultipleOrdersBatchOrdersParameterInner */ selfTradePreventionMode?: PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum; } declare const PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum: { readonly BUY: "BUY"; readonly SELL: "SELL"; }; type PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum = (typeof PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum]; declare const PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum: { readonly BOTH: "BOTH"; readonly LONG: "LONG"; readonly SHORT: "SHORT"; }; type PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum = (typeof PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum]; declare const PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum: { readonly LIMIT: "LIMIT"; readonly MARKET: "MARKET"; readonly STOP: "STOP"; readonly STOP_MARKET: "STOP_MARKET"; readonly TAKE_PROFIT: "TAKE_PROFIT"; readonly TAKE_PROFIT_MARKET: "TAKE_PROFIT_MARKET"; readonly TRAILING_STOP_MARKET: "TRAILING_STOP_MARKET"; }; type PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum = (typeof PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum]; declare const PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum: { readonly GTC: "GTC"; readonly IOC: "IOC"; readonly FOK: "FOK"; readonly GTX: "GTX"; }; type PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum = (typeof PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum]; declare const PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum: { readonly TRUE: "true"; readonly FALSE: "false"; }; type PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum = (typeof PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum]; declare const PlaceMultipleOrdersBatchOrdersParameterInnerWorkingTypeEnum: { readonly MARK_PRICE: "MARK_PRICE"; readonly CONTRACT_PRICE: "CONTRACT_PRICE"; }; type PlaceMultipleOrdersBatchOrdersParameterInnerWorkingTypeEnum = (typeof PlaceMultipleOrdersBatchOrdersParameterInnerWorkingTypeEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerWorkingTypeEnum]; declare const PlaceMultipleOrdersBatchOrdersParameterInnerPriceProtectEnum: { readonly TRUE: "true"; readonly FALSE: "false"; }; type PlaceMultipleOrdersBatchOrdersParameterInnerPriceProtectEnum = (typeof PlaceMultipleOrdersBatchOrdersParameterInnerPriceProtectEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerPriceProtectEnum]; declare const PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum: { readonly ACK: "ACK"; readonly RESULT: "RESULT"; }; type PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum = (typeof PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum]; declare const PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum: { readonly OPPONENT: "OPPONENT"; readonly OPPONENT_5: "OPPONENT_5"; readonly OPPONENT_10: "OPPONENT_10"; readonly OPPONENT_20: "OPPONENT_20"; readonly QUEUE: "QUEUE"; readonly QUEUE_5: "QUEUE_5"; readonly QUEUE_10: "QUEUE_10"; readonly QUEUE_20: "QUEUE_20"; }; type PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum = (typeof PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum]; declare const PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum: { readonly EXPIRE_TAKER: "EXPIRE_TAKER"; readonly EXPIRE_MAKER: "EXPIRE_MAKER"; readonly EXPIRE_BOTH: "EXPIRE_BOTH"; }; type PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum = (typeof PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum]; //#endregion //#region src/rest-api/types/place-multiple-orders-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface PlaceMultipleOrdersResponseInner */ interface PlaceMultipleOrdersResponseInner { /** * Client order ID. * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ clientOrderId?: string; /** * Cumulative filled quantity. * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ cumQty?: string; /** * Executed quantity * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ executedQty?: string; /** * Sub-order ID * @type {number | bigint} * @memberof PlaceMultipleOrdersResponseInner */ orderId?: number | bigint; /** * Original order quantity * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ origQty?: string; /** * Latest token price. * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ price?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof PlaceMultipleOrdersResponseInner */ reduceOnly?: boolean; /** * Trading side * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ side?: string; /** * Position side * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ positionSide?: string; /** * Enum：completed，processing * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ status?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ stopPrice?: string; /** * if Close-All * @type {boolean} * @memberof PlaceMultipleOrdersResponseInner */ closePosition?: boolean; /** * Trading symbol * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ symbol?: string; /** * Pair * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ pair?: string; /** * Time in force * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ timeInForce?: string; /** * Order type. * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ type?: string; /** * Original order type. * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ origType?: string; /** * activation price, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ activatePrice?: string; /** * callback rate, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ priceRate?: string; /** * update time * @type {number | bigint} * @memberof PlaceMultipleOrdersResponseInner */ updateTime?: number | bigint; /** * Stop trigger price type. * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof PlaceMultipleOrdersResponseInner */ priceProtect?: boolean; /** * price match mode * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ priceMatch?: string; /** * self trading preventation mode * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ selfTradePreventionMode?: string; /** * API response code. \"000000\" indicates success. * @type {number | bigint} * @memberof PlaceMultipleOrdersResponseInner */ code?: number | bigint; /** * Message details. * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ msg?: string; } //#endregion //#region src/rest-api/types/place-multiple-orders-response.d.ts /** * * @export * @interface PlaceMultipleOrdersResponse */ interface PlaceMultipleOrdersResponse extends Array {} //#endregion //#region src/rest-api/types/position-adl-quantile-estimation-response-inner-adl-quantile.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * ADL quantile information. * @export * @interface PositionAdlQuantileEstimationResponseInnerAdlQuantile */ interface PositionAdlQuantileEstimationResponseInnerAdlQuantile { /** * adl quantile for \"LONG\" position in hedge mode * @type {number | bigint} * @memberof PositionAdlQuantileEstimationResponseInnerAdlQuantile */ LONG?: number | bigint; /** * adl qauntile for \"SHORT\" position in hedge mode * @type {number | bigint} * @memberof PositionAdlQuantileEstimationResponseInnerAdlQuantile */ SHORT?: number | bigint; /** * Hedge mode ADL quantile. * @type {number | bigint} * @memberof PositionAdlQuantileEstimationResponseInnerAdlQuantile */ HEDGE?: number | bigint; /** * One-way mode ADL quantile. * @type {number | bigint} * @memberof PositionAdlQuantileEstimationResponseInnerAdlQuantile */ BOTH?: number | bigint; } //#endregion //#region src/rest-api/types/position-adl-quantile-estimation-response-inner.d.ts /** * * @export * @interface PositionAdlQuantileEstimationResponseInner */ interface PositionAdlQuantileEstimationResponseInner { /** * Trading symbol * @type {string} * @memberof PositionAdlQuantileEstimationResponseInner */ symbol?: string; /** * * @type {PositionAdlQuantileEstimationResponseInnerAdlQuantile} * @memberof PositionAdlQuantileEstimationResponseInner */ adlQuantile?: PositionAdlQuantileEstimationResponseInnerAdlQuantile; } //#endregion //#region src/rest-api/types/position-adl-quantile-estimation-response.d.ts /** * * @export * @interface PositionAdlQuantileEstimationResponse */ interface PositionAdlQuantileEstimationResponse extends Array {} //#endregion //#region src/rest-api/types/position-information-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface PositionInformationResponseInner */ interface PositionInformationResponseInner { /** * Trading symbol * @type {string} * @memberof PositionInformationResponseInner */ symbol?: string; /** * position amount * @type {string} * @memberof PositionInformationResponseInner */ positionAmt?: string; /** * Position entry price. * @type {string} * @memberof PositionInformationResponseInner */ entryPrice?: string; /** * break-even price * @type {string} * @memberof PositionInformationResponseInner */ breakEvenPrice?: string; /** * mark price * @type {string} * @memberof PositionInformationResponseInner */ markPrice?: string; /** * Unrealized profit. * @type {string} * @memberof PositionInformationResponseInner */ unRealizedProfit?: string; /** * Liquidation price. * @type {string} * @memberof PositionInformationResponseInner */ liquidationPrice?: string; /** * Leverage value. * @type {string} * @memberof PositionInformationResponseInner */ leverage?: string; /** * maximum quantity of base asset * @type {string} * @memberof PositionInformationResponseInner */ maxQty?: string; /** * Margin type. * @type {string} * @memberof PositionInformationResponseInner */ marginType?: string; /** * Isolated margin amount. * @type {string} * @memberof PositionInformationResponseInner */ isolatedMargin?: string; /** * Whether auto-add margin is enabled. * @type {string} * @memberof PositionInformationResponseInner */ isAutoAddMargin?: string; /** * Position side * @type {string} * @memberof PositionInformationResponseInner */ positionSide?: string; /** * update time * @type {number | bigint} * @memberof PositionInformationResponseInner */ updateTime?: number | bigint; } //#endregion //#region src/rest-api/types/position-information-response.d.ts /** * * @export * @interface PositionInformationResponse */ interface PositionInformationResponse$1 extends Array {} //#endregion //#region src/rest-api/types/premium-index-kline-data-item-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * @type PremiumIndexKlineDataItemInner */ type PremiumIndexKlineDataItemInner = number | string; //#endregion //#region src/rest-api/types/premium-index-kline-data-item.d.ts /** * * @export * @interface PremiumIndexKlineDataItem */ interface PremiumIndexKlineDataItem extends Array {} //#endregion //#region src/rest-api/types/premium-index-kline-data-response.d.ts /** * * @export * @interface PremiumIndexKlineDataResponse */ interface PremiumIndexKlineDataResponse extends Array {} //#endregion //#region src/rest-api/types/query-current-open-order-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface QueryCurrentOpenOrderResponse */ interface QueryCurrentOpenOrderResponse { /** * Average execution price * @type {string} * @memberof QueryCurrentOpenOrderResponse */ avgPrice?: string; /** * Client order ID. * @type {string} * @memberof QueryCurrentOpenOrderResponse */ clientOrderId?: string; /** * Cumulative base asset amount. * @type {string} * @memberof QueryCurrentOpenOrderResponse */ cumBase?: string; /** * Executed quantity * @type {string} * @memberof QueryCurrentOpenOrderResponse */ executedQty?: string; /** * Sub-order ID * @type {number | bigint} * @memberof QueryCurrentOpenOrderResponse */ orderId?: number | bigint; /** * Original order quantity * @type {string} * @memberof QueryCurrentOpenOrderResponse */ origQty?: string; /** * Original order type. * @type {string} * @memberof QueryCurrentOpenOrderResponse */ origType?: string; /** * Latest token price. * @type {string} * @memberof QueryCurrentOpenOrderResponse */ price?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof QueryCurrentOpenOrderResponse */ reduceOnly?: boolean; /** * Trading side * @type {string} * @memberof QueryCurrentOpenOrderResponse */ side?: string; /** * Position side * @type {string} * @memberof QueryCurrentOpenOrderResponse */ positionSide?: string; /** * Enum：completed，processing * @type {string} * @memberof QueryCurrentOpenOrderResponse */ status?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof QueryCurrentOpenOrderResponse */ stopPrice?: string; /** * if Close-All * @type {boolean} * @memberof QueryCurrentOpenOrderResponse */ closePosition?: boolean; /** * Trading symbol * @type {string} * @memberof QueryCurrentOpenOrderResponse */ symbol?: string; /** * Pair * @type {string} * @memberof QueryCurrentOpenOrderResponse */ pair?: string; /** * Time * @type {number | bigint} * @memberof QueryCurrentOpenOrderResponse */ time?: number | bigint; /** * Time in force * @type {string} * @memberof QueryCurrentOpenOrderResponse */ timeInForce?: string; /** * Order type. * @type {string} * @memberof QueryCurrentOpenOrderResponse */ type?: string; /** * activation price, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof QueryCurrentOpenOrderResponse */ activatePrice?: string; /** * callback rate, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof QueryCurrentOpenOrderResponse */ priceRate?: string; /** * update time * @type {number | bigint} * @memberof QueryCurrentOpenOrderResponse */ updateTime?: number | bigint; /** * Stop trigger price type. * @type {string} * @memberof QueryCurrentOpenOrderResponse */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof QueryCurrentOpenOrderResponse */ priceProtect?: boolean; /** * price match mode * @type {string} * @memberof QueryCurrentOpenOrderResponse */ priceMatch?: string; /** * self trading preventation mode * @type {string} * @memberof QueryCurrentOpenOrderResponse */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/query-index-price-constituents-response-constituents-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface QueryIndexPriceConstituentsResponseConstituentsInner */ interface QueryIndexPriceConstituentsResponseConstituentsInner { /** * Exchange identifier. * @type {string} * @memberof QueryIndexPriceConstituentsResponseConstituentsInner */ exchange?: string; /** * Trading symbol * @type {string} * @memberof QueryIndexPriceConstituentsResponseConstituentsInner */ symbol?: string; /** * Price * @type {string} * @memberof QueryIndexPriceConstituentsResponseConstituentsInner */ price?: string; /** * Weight * @type {string} * @memberof QueryIndexPriceConstituentsResponseConstituentsInner */ weight?: string; } //#endregion //#region src/rest-api/types/query-index-price-constituents-response.d.ts /** * * @export * @interface QueryIndexPriceConstituentsResponse */ interface QueryIndexPriceConstituentsResponse { /** * Trading symbol * @type {string} * @memberof QueryIndexPriceConstituentsResponse */ symbol?: string; /** * Time * @type {number | bigint} * @memberof QueryIndexPriceConstituentsResponse */ time?: number | bigint; /** * Constituent list. * @type {Array} * @memberof QueryIndexPriceConstituentsResponse */ constituents?: Array; } //#endregion //#region src/rest-api/types/query-order-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface QueryOrderResponse */ interface QueryOrderResponse$1 { /** * Average execution price * @type {string} * @memberof QueryOrderResponse */ avgPrice?: string; /** * Client order ID. * @type {string} * @memberof QueryOrderResponse */ clientOrderId?: string; /** * Cumulative base asset amount. * @type {string} * @memberof QueryOrderResponse */ cumBase?: string; /** * Executed quantity * @type {string} * @memberof QueryOrderResponse */ executedQty?: string; /** * Sub-order ID * @type {number | bigint} * @memberof QueryOrderResponse */ orderId?: number | bigint; /** * Original order quantity * @type {string} * @memberof QueryOrderResponse */ origQty?: string; /** * Original order type. * @type {string} * @memberof QueryOrderResponse */ origType?: string; /** * Latest token price. * @type {string} * @memberof QueryOrderResponse */ price?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof QueryOrderResponse */ reduceOnly?: boolean; /** * Trading side * @type {string} * @memberof QueryOrderResponse */ side?: string; /** * Position side * @type {string} * @memberof QueryOrderResponse */ positionSide?: string; /** * Enum：completed，processing * @type {string} * @memberof QueryOrderResponse */ status?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof QueryOrderResponse */ stopPrice?: string; /** * if Close-All * @type {boolean} * @memberof QueryOrderResponse */ closePosition?: boolean; /** * Trading symbol * @type {string} * @memberof QueryOrderResponse */ symbol?: string; /** * Pair * @type {string} * @memberof QueryOrderResponse */ pair?: string; /** * Time * @type {number | bigint} * @memberof QueryOrderResponse */ time?: number | bigint; /** * Time in force * @type {string} * @memberof QueryOrderResponse */ timeInForce?: string; /** * Order type. * @type {string} * @memberof QueryOrderResponse */ type?: string; /** * activation price, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof QueryOrderResponse */ activatePrice?: string; /** * callback rate, only return with TRAILING_STOP_MARKET order * @type {string} * @memberof QueryOrderResponse */ priceRate?: string; /** * update time * @type {number | bigint} * @memberof QueryOrderResponse */ updateTime?: number | bigint; /** * Stop trigger price type. * @type {string} * @memberof QueryOrderResponse */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof QueryOrderResponse */ priceProtect?: boolean; /** * price match mode * @type {string} * @memberof QueryOrderResponse */ priceMatch?: string; /** * self trading preventation mode * @type {string} * @memberof QueryOrderResponse */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/recent-trades-list-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface RecentTradesListResponseInner */ interface RecentTradesListResponseInner { /** * positionId * @type {number | bigint} * @memberof RecentTradesListResponseInner */ id?: number | bigint; /** * Latest token price. * @type {string} * @memberof RecentTradesListResponseInner */ price?: string; /** * Quantity. * @type {string} * @memberof RecentTradesListResponseInner */ qty?: string; /** * Base asset quantity. * @type {string} * @memberof RecentTradesListResponseInner */ baseQty?: string; /** * Time * @type {number | bigint} * @memberof RecentTradesListResponseInner */ time?: number | bigint; /** * Whether buyer is market maker. * @type {boolean} * @memberof RecentTradesListResponseInner */ isBuyerMaker?: boolean; } //#endregion //#region src/rest-api/types/recent-trades-list-response.d.ts /** * * @export * @interface RecentTradesListResponse */ interface RecentTradesListResponse extends Array {} //#endregion //#region src/rest-api/types/start-user-data-stream-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface StartUserDataStreamResponse */ interface StartUserDataStreamResponse$1 { /** * Listen key. * @type {string} * @memberof StartUserDataStreamResponse */ listenKey?: string; } //#endregion //#region src/rest-api/types/symbol-order-book-ticker-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface SymbolOrderBookTickerResponseInner */ interface SymbolOrderBookTickerResponseInner { /** * Last update ID. * @type {number | bigint} * @memberof SymbolOrderBookTickerResponseInner */ lastUpdateId?: number | bigint; /** * Trading symbol * @type {string} * @memberof SymbolOrderBookTickerResponseInner */ symbol?: string; /** * Pair * @type {string} * @memberof SymbolOrderBookTickerResponseInner */ pair?: string; /** * Best bid price. * @type {string} * @memberof SymbolOrderBookTickerResponseInner */ bidPrice?: string; /** * Best bid quantity. * @type {string} * @memberof SymbolOrderBookTickerResponseInner */ bidQty?: string; /** * Best ask price. * @type {string} * @memberof SymbolOrderBookTickerResponseInner */ askPrice?: string; /** * Best ask quantity. * @type {string} * @memberof SymbolOrderBookTickerResponseInner */ askQty?: string; /** * Time * @type {number | bigint} * @memberof SymbolOrderBookTickerResponseInner */ time?: number | bigint; } //#endregion //#region src/rest-api/types/symbol-order-book-ticker-response.d.ts /** * * @export * @interface SymbolOrderBookTickerResponse */ interface SymbolOrderBookTickerResponse extends Array {} //#endregion //#region src/rest-api/types/symbol-price-ticker-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface SymbolPriceTickerResponseInner */ interface SymbolPriceTickerResponseInner { /** * Trading symbol * @type {string} * @memberof SymbolPriceTickerResponseInner */ symbol?: string; /** * Pair * @type {string} * @memberof SymbolPriceTickerResponseInner */ ps?: string; /** * Latest token price. * @type {string} * @memberof SymbolPriceTickerResponseInner */ price?: string; /** * Time * @type {number | bigint} * @memberof SymbolPriceTickerResponseInner */ time?: number | bigint; } //#endregion //#region src/rest-api/types/symbol-price-ticker-response.d.ts /** * * @export * @interface SymbolPriceTickerResponse */ interface SymbolPriceTickerResponse extends Array {} //#endregion //#region src/rest-api/types/taker-buy-sell-volume-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface TakerBuySellVolumeResponseInner */ interface TakerBuySellVolumeResponseInner { /** * Pair * @type {string} * @memberof TakerBuySellVolumeResponseInner */ pair?: string; /** * Contract type. * @type {string} * @memberof TakerBuySellVolumeResponseInner */ contractType?: string; /** * unit: cont * @type {string} * @memberof TakerBuySellVolumeResponseInner */ takerBuyVol?: string; /** * unit: cont * @type {string} * @memberof TakerBuySellVolumeResponseInner */ takerSellVol?: string; /** * unit: base asset * @type {string} * @memberof TakerBuySellVolumeResponseInner */ takerBuyVolValue?: string; /** * unit: base asset * @type {string} * @memberof TakerBuySellVolumeResponseInner */ takerSellVolValue?: string; /** * Timestamp in milliseconds. * @type {number | bigint} * @memberof TakerBuySellVolumeResponseInner */ timestamp?: number | bigint; } //#endregion //#region src/rest-api/types/taker-buy-sell-volume-response.d.ts /** * * @export * @interface TakerBuySellVolumeResponse */ interface TakerBuySellVolumeResponse extends Array {} //#endregion //#region src/rest-api/types/ticker24hr-price-change-statistics-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Ticker24hrPriceChangeStatisticsResponseInner */ interface Ticker24hrPriceChangeStatisticsResponseInner { /** * Trading symbol * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ symbol?: string; /** * Pair * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ pair?: string; /** * Absolute price change in the 24h window. * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ priceChange?: string; /** * Percentage price change in the 24h window. * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ priceChangePercent?: string; /** * Weighted average price in the 24h window. * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ weightedAvgPrice?: string; /** * Latest traded price. * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ lastPrice?: string; /** * Quantity of the latest trade. * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ lastQty?: string; /** * Opening price of the 24h window. * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ openPrice?: string; /** * Highest price in the 24h window. * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ highPrice?: string; /** * Lowest price in the 24h window. * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ lowPrice?: string; /** * Base asset volume in the 24h window. * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ volume?: string; /** * Base asset volume. * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ baseVolume?: string; /** * Start time of the 24h window (milliseconds). * @type {number | bigint} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ openTime?: number | bigint; /** * End time of the 24h window (milliseconds). * @type {number | bigint} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ closeTime?: number | bigint; /** * First tradeId * @type {number | bigint} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ firstId?: number | bigint; /** * Last tradeId * @type {number | bigint} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ lastId?: number | bigint; /** * Total number of trades in the 24h window. * @type {number | bigint} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ count?: number | bigint; } //#endregion //#region src/rest-api/types/ticker24hr-price-change-statistics-response.d.ts /** * * @export * @interface Ticker24hrPriceChangeStatisticsResponse */ interface Ticker24hrPriceChangeStatisticsResponse extends Array {} //#endregion //#region src/rest-api/types/top-trader-long-short-ratio-accounts-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface TopTraderLongShortRatioAccountsResponseInner */ interface TopTraderLongShortRatioAccountsResponseInner { /** * Pair * @type {string} * @memberof TopTraderLongShortRatioAccountsResponseInner */ pair?: string; /** * Long/short ratio. * @type {string} * @memberof TopTraderLongShortRatioAccountsResponseInner */ longShortRatio?: string; /** * 64.42% * @type {string} * @memberof TopTraderLongShortRatioAccountsResponseInner */ longAccount?: string; /** * 35.58% * @type {string} * @memberof TopTraderLongShortRatioAccountsResponseInner */ shortAccount?: string; /** * Timestamp in milliseconds. * @type {number | bigint} * @memberof TopTraderLongShortRatioAccountsResponseInner */ timestamp?: number | bigint; } //#endregion //#region src/rest-api/types/top-trader-long-short-ratio-accounts-response.d.ts /** * * @export * @interface TopTraderLongShortRatioAccountsResponse */ interface TopTraderLongShortRatioAccountsResponse extends Array {} //#endregion //#region src/rest-api/types/top-trader-long-short-ratio-positions-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface TopTraderLongShortRatioPositionsResponseInner */ interface TopTraderLongShortRatioPositionsResponseInner { /** * Pair * @type {string} * @memberof TopTraderLongShortRatioPositionsResponseInner */ pair?: string; /** * Long/short ratio. * @type {string} * @memberof TopTraderLongShortRatioPositionsResponseInner */ longShortRatio?: string; /** * 64.42% * @type {string} * @memberof TopTraderLongShortRatioPositionsResponseInner */ longPosition?: string; /** * 44.04% * @type {string} * @memberof TopTraderLongShortRatioPositionsResponseInner */ shortPosition?: string; /** * Timestamp in milliseconds. * @type {number | bigint} * @memberof TopTraderLongShortRatioPositionsResponseInner */ timestamp?: number | bigint; } //#endregion //#region src/rest-api/types/top-trader-long-short-ratio-positions-response.d.ts /** * * @export * @interface TopTraderLongShortRatioPositionsResponse */ interface TopTraderLongShortRatioPositionsResponse extends Array {} //#endregion //#region src/rest-api/types/user-commission-rate-response.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface UserCommissionRateResponse */ interface UserCommissionRateResponse { /** * Trading symbol * @type {string} * @memberof UserCommissionRateResponse */ symbol?: string; /** * 0.015% * @type {string} * @memberof UserCommissionRateResponse */ makerCommissionRate?: string; /** * Taker commission rate. * @type {string} * @memberof UserCommissionRateResponse */ takerCommissionRate?: string; } //#endregion //#region src/rest-api/types/users-force-orders-response-inner.d.ts /** * Futures (COIN-M) REST API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface UsersForceOrdersResponseInner */ interface UsersForceOrdersResponseInner { /** * Sub-order ID * @type {number | bigint} * @memberof UsersForceOrdersResponseInner */ orderId?: number | bigint; /** * Trading symbol * @type {string} * @memberof UsersForceOrdersResponseInner */ symbol?: string; /** * Pair * @type {string} * @memberof UsersForceOrdersResponseInner */ pair?: string; /** * Enum：completed，processing * @type {string} * @memberof UsersForceOrdersResponseInner */ status?: string; /** * Client order ID. * @type {string} * @memberof UsersForceOrdersResponseInner */ clientOrderId?: string; /** * Latest token price. * @type {string} * @memberof UsersForceOrdersResponseInner */ price?: string; /** * Average execution price * @type {string} * @memberof UsersForceOrdersResponseInner */ avgPrice?: string; /** * Original order quantity * @type {string} * @memberof UsersForceOrdersResponseInner */ origQty?: string; /** * Executed quantity * @type {string} * @memberof UsersForceOrdersResponseInner */ executedQty?: string; /** * Cumulative base asset amount. * @type {string} * @memberof UsersForceOrdersResponseInner */ cumBase?: string; /** * Time in force * @type {string} * @memberof UsersForceOrdersResponseInner */ timeInForce?: string; /** * Order type. * @type {string} * @memberof UsersForceOrdersResponseInner */ type?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof UsersForceOrdersResponseInner */ reduceOnly?: boolean; /** * if Close-All * @type {boolean} * @memberof UsersForceOrdersResponseInner */ closePosition?: boolean; /** * Trading side * @type {string} * @memberof UsersForceOrdersResponseInner */ side?: string; /** * Position side * @type {string} * @memberof UsersForceOrdersResponseInner */ positionSide?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof UsersForceOrdersResponseInner */ stopPrice?: string; /** * Stop trigger price type. * @type {string} * @memberof UsersForceOrdersResponseInner */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof UsersForceOrdersResponseInner */ priceProtect?: boolean; /** * Original order type. * @type {string} * @memberof UsersForceOrdersResponseInner */ origType?: string; /** * Time * @type {number | bigint} * @memberof UsersForceOrdersResponseInner */ time?: number | bigint; /** * update time * @type {number | bigint} * @memberof UsersForceOrdersResponseInner */ updateTime?: number | bigint; } //#endregion //#region src/rest-api/types/users-force-orders-response.d.ts /** * * @export * @interface UsersForceOrdersResponse */ interface UsersForceOrdersResponse extends Array {} //#endregion //#region src/rest-api/modules/account-api.d.ts /** * AccountApi - interface * @interface AccountApi */ interface AccountApiInterface$1 { /** * Get current account information. * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - for One-way Mode user, the "positions" will only show the "BOTH" positions * - for Hedge Mode user, the "positions" will show "BOTH", "LONG", and "SHORT" positions. * * @summary Account Information (USER_DATA) * @param {AccountInformationRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ accountInformation(requestParameters?: AccountInformationRequest$1): Promise>; /** * Check futures account balance * * Weight(IP): 1 * * Security Type: USER_DATA * * @summary Futures Account Balance (USER_DATA) * @param {FuturesAccountBalanceRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ futuresAccountBalance(requestParameters?: FuturesAccountBalanceRequest$1): Promise>; /** * Get user's position mode (Hedge Mode or One-way Mode ) on ***EVERY symbol*** * * Weight(IP): 30 * * Security Type: USER_DATA * * @summary Get Current Position Mode (USER_DATA) * @param {GetCurrentPositionModeRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getCurrentPositionMode(requestParameters?: GetCurrentPositionModeRequest): Promise>; /** * Get Download Id For Futures Order History * * Weight(IP): 1000 * * Security Type: USER_DATA * * Notes: * - Request Limitation is 8 times per month, shared by front end download page and rest api * - This endpoint uses the IP rate limit bucket and costs 1000 weight per call. The maximum is 2 calls per minute; the 3rd call within the same minute will trigger a ban. * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Download Id For Futures Order History (USER_DATA) * @param {GetDownloadIdForFuturesOrderHistoryRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getDownloadIdForFuturesOrderHistory(requestParameters: GetDownloadIdForFuturesOrderHistoryRequest): Promise>; /** * Get download id for futures trade history * * Weight(IP): 1000 * * Security Type: USER_DATA * * Notes: * - Request Limitation is 8 times per month, shared by front end download page and rest api * - This endpoint uses the IP rate limit bucket and costs 1000 weight per call. The maximum is 2 calls per minute; the 3rd call within the same minute will trigger a ban. * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Download Id For Futures Trade History (USER_DATA) * @param {GetDownloadIdForFuturesTradeHistoryRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getDownloadIdForFuturesTradeHistory(requestParameters: GetDownloadIdForFuturesTradeHistoryRequest): Promise>; /** * Get download id for futures transaction history * * Weight(IP): 1000 * * Security Type: USER_DATA * * Notes: * - Request Limitation is 8 times per month, shared by front end download page and rest api * - This endpoint uses the IP rate limit bucket and costs 1000 weight per call. The maximum is 2 calls per minute; the 3rd call within the same minute will trigger a ban. * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Download Id For Futures Transaction History (USER_DATA) * @param {GetDownloadIdForFuturesTransactionHistoryRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getDownloadIdForFuturesTransactionHistory(requestParameters: GetDownloadIdForFuturesTransactionHistoryRequest): Promise>; /** * Get futures order history download link by Id * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Download link expiration: 7 days * * @summary Get Futures Order History Download Link by Id (USER_DATA) * @param {GetFuturesOrderHistoryDownloadLinkByIdRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getFuturesOrderHistoryDownloadLinkById(requestParameters: GetFuturesOrderHistoryDownloadLinkByIdRequest): Promise>; /** * Get futures trade download link by Id * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Download link expiration: 7 days * * @summary Get Futures Trade Download Link by Id (USER_DATA) * @param {GetFuturesTradeDownloadLinkByIdRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getFuturesTradeDownloadLinkById(requestParameters: GetFuturesTradeDownloadLinkByIdRequest): Promise>; /** * Get futures transaction history download link by Id * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Download link expiration: 7 days * * @summary Get Futures Transaction History Download Link by Id (USER_DATA) * @param {GetFuturesTransactionHistoryDownloadLinkByIdRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getFuturesTransactionHistoryDownloadLinkById(requestParameters: GetFuturesTransactionHistoryDownloadLinkByIdRequest): Promise>; /** * Get income history * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: * - If `incomeType ` is not sent, all kinds of flow will be returned * - "trandId" is unique in the same "incomeType" for a user * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Income History (USER_DATA) * @param {GetIncomeHistoryRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getIncomeHistory(requestParameters?: GetIncomeHistoryRequest): Promise>; /** * **Not recommended to continue using this v1 endpoint** * * Get the pair's default notional bracket list, may return ambiguous * values when there have been multiple different `symbol` brackets under * the `pair`, suggest using the following `GET /dapi/v2/leverageBracket` * query instead to get the specific `symbol` notional bracket list. * * Weight(IP): 1 * * Security Type: USER_DATA * * @summary Notional Bracket for Pair (USER_DATA) * @param {NotionalBracketForPairRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ notionalBracketForPair(requestParameters?: NotionalBracketForPairRequest): Promise>; /** * Get the symbol's notional bracket list. * * Weight: 1 (after CM migration: 1 with `symbol` / 2 without `symbol`) * * Security Type: USER_DATA * * @summary Notional Bracket for Symbol (USER_DATA) * @param {NotionalBracketForSymbolRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ notionalBracketForSymbol(requestParameters?: NotionalBracketForSymbolRequest): Promise>; /** * Query user commission rate * * Weight(IP): 20 * * Security Type: USER_DATA * * @summary User Commission Rate (USER_DATA) * @param {UserCommissionRateRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ userCommissionRate(requestParameters: UserCommissionRateRequest): Promise>; } /** * Request parameters for accountInformation operation in AccountApi. * @interface AccountInformationRequest */ interface AccountInformationRequest$1 { /** * * @type {number | bigint} * @memberof AccountApiAccountInformation */ readonly recvWindow?: number | bigint; } /** * Request parameters for futuresAccountBalance operation in AccountApi. * @interface FuturesAccountBalanceRequest */ interface FuturesAccountBalanceRequest$1 { /** * * @type {number | bigint} * @memberof AccountApiFuturesAccountBalance */ readonly recvWindow?: number | bigint; } /** * Request parameters for getCurrentPositionMode operation in AccountApi. * @interface GetCurrentPositionModeRequest */ interface GetCurrentPositionModeRequest { /** * * @type {number | bigint} * @memberof AccountApiGetCurrentPositionMode */ readonly recvWindow?: number | bigint; } /** * Request parameters for getDownloadIdForFuturesOrderHistory operation in AccountApi. * @interface GetDownloadIdForFuturesOrderHistoryRequest */ interface GetDownloadIdForFuturesOrderHistoryRequest { /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiGetDownloadIdForFuturesOrderHistory */ readonly startTime: number | bigint; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiGetDownloadIdForFuturesOrderHistory */ readonly endTime: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiGetDownloadIdForFuturesOrderHistory */ readonly recvWindow?: number | bigint; } /** * Request parameters for getDownloadIdForFuturesTradeHistory operation in AccountApi. * @interface GetDownloadIdForFuturesTradeHistoryRequest */ interface GetDownloadIdForFuturesTradeHistoryRequest { /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiGetDownloadIdForFuturesTradeHistory */ readonly startTime: number | bigint; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiGetDownloadIdForFuturesTradeHistory */ readonly endTime: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiGetDownloadIdForFuturesTradeHistory */ readonly recvWindow?: number | bigint; } /** * Request parameters for getDownloadIdForFuturesTransactionHistory operation in AccountApi. * @interface GetDownloadIdForFuturesTransactionHistoryRequest */ interface GetDownloadIdForFuturesTransactionHistoryRequest { /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiGetDownloadIdForFuturesTransactionHistory */ readonly startTime: number | bigint; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiGetDownloadIdForFuturesTransactionHistory */ readonly endTime: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiGetDownloadIdForFuturesTransactionHistory */ readonly recvWindow?: number | bigint; } /** * Request parameters for getFuturesOrderHistoryDownloadLinkById operation in AccountApi. * @interface GetFuturesOrderHistoryDownloadLinkByIdRequest */ interface GetFuturesOrderHistoryDownloadLinkByIdRequest { /** * get by download id api * @type {string} * @memberof AccountApiGetFuturesOrderHistoryDownloadLinkById */ readonly downloadId: string; /** * * @type {number | bigint} * @memberof AccountApiGetFuturesOrderHistoryDownloadLinkById */ readonly recvWindow?: number | bigint; } /** * Request parameters for getFuturesTradeDownloadLinkById operation in AccountApi. * @interface GetFuturesTradeDownloadLinkByIdRequest */ interface GetFuturesTradeDownloadLinkByIdRequest { /** * get by download id api * @type {string} * @memberof AccountApiGetFuturesTradeDownloadLinkById */ readonly downloadId: string; /** * * @type {number | bigint} * @memberof AccountApiGetFuturesTradeDownloadLinkById */ readonly recvWindow?: number | bigint; } /** * Request parameters for getFuturesTransactionHistoryDownloadLinkById operation in AccountApi. * @interface GetFuturesTransactionHistoryDownloadLinkByIdRequest */ interface GetFuturesTransactionHistoryDownloadLinkByIdRequest { /** * get by download id api * @type {string} * @memberof AccountApiGetFuturesTransactionHistoryDownloadLinkById */ readonly downloadId: string; /** * * @type {number | bigint} * @memberof AccountApiGetFuturesTransactionHistoryDownloadLinkById */ readonly recvWindow?: number | bigint; } /** * Request parameters for getIncomeHistory operation in AccountApi. * @interface GetIncomeHistoryRequest */ interface GetIncomeHistoryRequest { /** * Symbol * @type {string} * @memberof AccountApiGetIncomeHistory */ readonly symbol?: string; /** * Income type. * @type {'TRANSFER' | 'WELCOME_BONUS' | 'FUNDING_FEE' | 'REALIZED_PNL' | 'COMMISSION' | 'INSURANCE_CLEAR' | 'DELIVERED_SETTELMENT'} * @memberof AccountApiGetIncomeHistory */ readonly incomeType?: GetIncomeHistoryIncomeTypeEnum; /** * Timestamp in ms to get funding from INCLUSIVE. * @type {number | bigint} * @memberof AccountApiGetIncomeHistory */ readonly startTime?: number | bigint; /** * Timestamp in ms to get funding until INCLUSIVE. * @type {number | bigint} * @memberof AccountApiGetIncomeHistory */ readonly endTime?: number | bigint; /** * Page number * @type {number | bigint} * @memberof AccountApiGetIncomeHistory */ readonly page?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof AccountApiGetIncomeHistory */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiGetIncomeHistory */ readonly recvWindow?: number | bigint; } /** * Request parameters for notionalBracketForPair operation in AccountApi. * @interface NotionalBracketForPairRequest */ interface NotionalBracketForPairRequest { /** * * @type {string} * @memberof AccountApiNotionalBracketForPair */ readonly pair?: string; /** * * @type {number | bigint} * @memberof AccountApiNotionalBracketForPair */ readonly recvWindow?: number | bigint; } /** * Request parameters for notionalBracketForSymbol operation in AccountApi. * @interface NotionalBracketForSymbolRequest */ interface NotionalBracketForSymbolRequest { /** * * @type {string} * @memberof AccountApiNotionalBracketForSymbol */ readonly symbol?: string; /** * * @type {number | bigint} * @memberof AccountApiNotionalBracketForSymbol */ readonly recvWindow?: number | bigint; } /** * Request parameters for userCommissionRate operation in AccountApi. * @interface UserCommissionRateRequest */ interface UserCommissionRateRequest { /** * Symbol * @type {string} * @memberof AccountApiUserCommissionRate */ readonly symbol: string; /** * * @type {number | bigint} * @memberof AccountApiUserCommissionRate */ readonly recvWindow?: number | bigint; } /** * AccountApi - object-oriented interface * @class AccountApi */ declare class AccountApi$1 implements AccountApiInterface$1 { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Get current account information. * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - for One-way Mode user, the "positions" will only show the "BOTH" positions * - for Hedge Mode user, the "positions" will show "BOTH", "LONG", and "SHORT" positions. * * @summary Account Information (USER_DATA) * @param {AccountInformationRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#account-information Binance API Documentation} */ accountInformation(requestParameters?: AccountInformationRequest$1): Promise>; /** * Check futures account balance * * Weight(IP): 1 * * Security Type: USER_DATA * * @summary Futures Account Balance (USER_DATA) * @param {FuturesAccountBalanceRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#futures-account-balance Binance API Documentation} */ futuresAccountBalance(requestParameters?: FuturesAccountBalanceRequest$1): Promise>; /** * Get user's position mode (Hedge Mode or One-way Mode ) on ***EVERY symbol*** * * Weight(IP): 30 * * Security Type: USER_DATA * * @summary Get Current Position Mode (USER_DATA) * @param {GetCurrentPositionModeRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-current-position-mode Binance API Documentation} */ getCurrentPositionMode(requestParameters?: GetCurrentPositionModeRequest): Promise>; /** * Get Download Id For Futures Order History * * Weight(IP): 1000 * * Security Type: USER_DATA * * Notes: * - Request Limitation is 8 times per month, shared by front end download page and rest api * - This endpoint uses the IP rate limit bucket and costs 1000 weight per call. The maximum is 2 calls per minute; the 3rd call within the same minute will trigger a ban. * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Download Id For Futures Order History (USER_DATA) * @param {GetDownloadIdForFuturesOrderHistoryRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-download-id-for-futures-order-history Binance API Documentation} */ getDownloadIdForFuturesOrderHistory(requestParameters: GetDownloadIdForFuturesOrderHistoryRequest): Promise>; /** * Get download id for futures trade history * * Weight(IP): 1000 * * Security Type: USER_DATA * * Notes: * - Request Limitation is 8 times per month, shared by front end download page and rest api * - This endpoint uses the IP rate limit bucket and costs 1000 weight per call. The maximum is 2 calls per minute; the 3rd call within the same minute will trigger a ban. * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Download Id For Futures Trade History (USER_DATA) * @param {GetDownloadIdForFuturesTradeHistoryRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-download-id-for-futures-trade-history Binance API Documentation} */ getDownloadIdForFuturesTradeHistory(requestParameters: GetDownloadIdForFuturesTradeHistoryRequest): Promise>; /** * Get download id for futures transaction history * * Weight(IP): 1000 * * Security Type: USER_DATA * * Notes: * - Request Limitation is 8 times per month, shared by front end download page and rest api * - This endpoint uses the IP rate limit bucket and costs 1000 weight per call. The maximum is 2 calls per minute; the 3rd call within the same minute will trigger a ban. * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Download Id For Futures Transaction History (USER_DATA) * @param {GetDownloadIdForFuturesTransactionHistoryRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-download-id-for-futures-transaction-history Binance API Documentation} */ getDownloadIdForFuturesTransactionHistory(requestParameters: GetDownloadIdForFuturesTransactionHistoryRequest): Promise>; /** * Get futures order history download link by Id * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Download link expiration: 7 days * * @summary Get Futures Order History Download Link by Id (USER_DATA) * @param {GetFuturesOrderHistoryDownloadLinkByIdRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-futures-order-history-download-link-by-id Binance API Documentation} */ getFuturesOrderHistoryDownloadLinkById(requestParameters: GetFuturesOrderHistoryDownloadLinkByIdRequest): Promise>; /** * Get futures trade download link by Id * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Download link expiration: 7 days * * @summary Get Futures Trade Download Link by Id (USER_DATA) * @param {GetFuturesTradeDownloadLinkByIdRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-futures-trade-download-link-by-id Binance API Documentation} */ getFuturesTradeDownloadLinkById(requestParameters: GetFuturesTradeDownloadLinkByIdRequest): Promise>; /** * Get futures transaction history download link by Id * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Download link expiration: 7 days * * @summary Get Futures Transaction History Download Link by Id (USER_DATA) * @param {GetFuturesTransactionHistoryDownloadLinkByIdRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-futures-transaction-history-download-link-by-id Binance API Documentation} */ getFuturesTransactionHistoryDownloadLinkById(requestParameters: GetFuturesTransactionHistoryDownloadLinkByIdRequest): Promise>; /** * Get income history * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: * - If `incomeType ` is not sent, all kinds of flow will be returned * - "trandId" is unique in the same "incomeType" for a user * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Income History (USER_DATA) * @param {GetIncomeHistoryRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-income-history Binance API Documentation} */ getIncomeHistory(requestParameters?: GetIncomeHistoryRequest): Promise>; /** * **Not recommended to continue using this v1 endpoint** * * Get the pair's default notional bracket list, may return ambiguous * values when there have been multiple different `symbol` brackets under * the `pair`, suggest using the following `GET /dapi/v2/leverageBracket` * query instead to get the specific `symbol` notional bracket list. * * Weight(IP): 1 * * Security Type: USER_DATA * * @summary Notional Bracket for Pair (USER_DATA) * @param {NotionalBracketForPairRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#notional-bracket-for-pair Binance API Documentation} */ notionalBracketForPair(requestParameters?: NotionalBracketForPairRequest): Promise>; /** * Get the symbol's notional bracket list. * * Weight: 1 (after CM migration: 1 with `symbol` / 2 without `symbol`) * * Security Type: USER_DATA * * @summary Notional Bracket for Symbol (USER_DATA) * @param {NotionalBracketForSymbolRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#notional-bracket-for-symbol Binance API Documentation} */ notionalBracketForSymbol(requestParameters?: NotionalBracketForSymbolRequest): Promise>; /** * Query user commission rate * * Weight(IP): 20 * * Security Type: USER_DATA * * @summary User Commission Rate (USER_DATA) * @param {UserCommissionRateRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#user-commission-rate Binance API Documentation} */ userCommissionRate(requestParameters: UserCommissionRateRequest): Promise>; } declare enum GetIncomeHistoryIncomeTypeEnum { TRANSFER = "TRANSFER", WELCOME_BONUS = "WELCOME_BONUS", FUNDING_FEE = "FUNDING_FEE", REALIZED_PNL = "REALIZED_PNL", COMMISSION = "COMMISSION", INSURANCE_CLEAR = "INSURANCE_CLEAR", DELIVERED_SETTELMENT = "DELIVERED_SETTELMENT", } //#endregion //#region src/rest-api/modules/market-data-api.d.ts /** * MarketDataApi - interface * @interface MarketDataApi */ interface MarketDataApiInterface { /** * Query basis * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Basis * @param {BasisRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ basis(requestParameters: BasisRequest): Promise>; /** * Test connectivity to the Rest API and get the current server time. * * Weight(IP): 1 * * @summary Check Server time * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ checkServerTime(): Promise>; /** * Get compressed, aggregate trades. Market trades that fill in 100ms with * the same price and the same taking side will have the quantity * aggregated. * * Weight(IP): 20 * * Notes: * - support querying futures trade histories that are not older than 24 hours * - If both `startTime` and `endTime` are sent, time between `startTime` and `endTime` must be less than 1 hour. * - If `fromId`, `startTime`, and `endTime` are not sent, the most recent aggregate trades will be returned. * - Only market trades will be aggregated and returned, which means the insurance fund trades and ADL trades won't be aggregated. * - Sending both `startTime`/`endTime` and `fromId` might cause response timeout, please send either `fromId` or `startTime`/`endTime` * * @summary Compressed/Aggregate Trades List * @param {CompressedAggregateTradesListRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ compressedAggregateTradesList(requestParameters: CompressedAggregateTradesListRequest): Promise>; /** * Kline/candlestick bars for a specific contract type. Klines are uniquely identified by their open time. * * Weight: based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Continuous Contract Kline/Candlestick Data * @param {ContinuousContractKlineCandlestickDataRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ continuousContractKlineCandlestickData(requestParameters: ContinuousContractKlineCandlestickDataRequest): Promise>; /** * Current exchange trading rules and symbol information * * Weight(IP): 1 * * @summary Exchange Information * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ exchangeInformation(): Promise>; /** * Get Funding Rate History of Perpetual Futures * * Weight(IP): 1 * * Notes: * - empty array will be returned for delivery symbols. * * @summary Get Funding Rate History of Perpetual Futures * @param {GetFundingRateHistoryOfPerpetualFuturesRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ getFundingRateHistoryOfPerpetualFutures(requestParameters: GetFundingRateHistoryOfPerpetualFuturesRequest): Promise>; /** * Query funding rate info for symbols that had FundingRateCap/FundingRateFloor/fundingIntervalHours adjustment * * @summary Get Funding Rate Info * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ getFundingRateInfo(): Promise>; /** * Query index price and mark price * * Weight(IP): 10 * * @summary Index Price and Mark Price * @param {IndexPriceAndMarkPriceRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ indexPriceAndMarkPrice(requestParameters?: IndexPriceAndMarkPriceRequest): Promise>; /** * Kline/candlestick bars for the index price of a pair. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Index Price Kline/Candlestick Data * @param {IndexPriceKlineCandlestickDataRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ indexPriceKlineCandlestickData(requestParameters: IndexPriceKlineCandlestickDataRequest): Promise>; /** * Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Kline/Candlestick Data * @param {KlineCandlestickDataRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ klineCandlestickData(requestParameters: KlineCandlestickDataRequest): Promise>; /** * Query symbol Long/Short Ratio * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Long/Short Ratio * @param {LongShortRatioRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ longShortRatio(requestParameters: LongShortRatioRequest): Promise>; /** * Kline/candlestick bars for the mark price of a symbol. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Mark Price Kline/Candlestick Data * @param {MarkPriceKlineCandlestickDataRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ markPriceKlineCandlestickData(requestParameters: MarkPriceKlineCandlestickDataRequest): Promise>; /** * Get older market historical trades. * * Weight(IP): 20 * * Security Type: MARKET_DATA * * Notes: * - Market trades means trades filled in the order book. Only market trades will be returned, which means the insurance fund trades and ADL trades won't be returned. * - Only supports data from within the last one month * * @summary Old Trades Lookup (MARKET_DATA) * @param {OldTradesLookupRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ oldTradesLookup(requestParameters: OldTradesLookupRequest): Promise>; /** * Get present open interest of a specific symbol. * * Weight(IP): 1 * * @summary Open Interest * @param {OpenInterestRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ openInterest(requestParameters: OpenInterestRequest): Promise>; /** * Query open interest stats * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Open Interest Statistics * @param {OpenInterestStatisticsRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ openInterestStatistics(requestParameters: OpenInterestStatisticsRequest): Promise>; /** * Query orderbook on specific symbol * * Weight: Adjusted based on the limit: * * | Limit | Weight | * | ------------ | ------------ | * | 5, 10, 20, 50 | 2 | * | 100 | 5 | * | 500 | 10 | * | 1000 | 20 | * * @summary Order Book * @param {OrderBookRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ orderBook(requestParameters: OrderBookRequest): Promise>; /** * Premium index kline bars of a symbol. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | ----------- | ------ | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - If startTime and endTime are not sent, the most recent klines are returned. * * @summary Premium index Kline Data * @param {PremiumIndexKlineDataRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ premiumIndexKlineData(requestParameters: PremiumIndexKlineDataRequest): Promise>; /** * Query index price constituents * * Weight(IP): 1 * * @summary Query Index Price Constituents * @param {QueryIndexPriceConstituentsRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ queryIndexPriceConstituents(requestParameters: QueryIndexPriceConstituentsRequest): Promise>; /** * Get recent market trades * * Weight(IP): 5 * * Notes: * - Market trades means trades filled in the order book. Only market trades will be returned, which means the insurance fund trades and ADL trades won't be returned. * * @summary Recent Trades List * @param {RecentTradesListRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ recentTradesList(requestParameters: RecentTradesListRequest): Promise>; /** * Best price/qty on the order book for a symbol or symbols. * * Weight: **2** for a single symbol, **5** when the symbol parameter is omitted * * Notes: * - Symbol and pair cannot be sent together * - If a pair is sent,tickers for all symbols of the pair will be returned * - If either a pair or symbol is sent, tickers for all symbols of all pairs will be returned * * @summary Symbol Order Book Ticker * @param {SymbolOrderBookTickerRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ symbolOrderBookTicker(requestParameters?: SymbolOrderBookTickerRequest): Promise>; /** * Latest price for a symbol or symbols. * * Weight: **1** for a single symbol, **2** when the symbol parameter is omitted * * Notes: * - Symbol and pair cannot be sent together * - If a pair is sent,tickers for all symbols of the pair will be returned * - If either a pair or symbol is sent, tickers for all symbols of all pairs will be returned * * @summary Symbol Price Ticker * @param {SymbolPriceTickerRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ symbolPriceTicker(requestParameters?: SymbolPriceTickerRequest): Promise>; /** * Taker Buy Volume: the total volume of buy orders filled by takers within * the period. * * Taker Sell Volume: the total volume of sell orders filled by takers * within the period. * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Taker Buy/Sell Volume * @param {TakerBuySellVolumeRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ takerBuySellVolume(requestParameters: TakerBuySellVolumeRequest): Promise>; /** * Test connectivity to the Rest API. * * Weight(IP): 1 * * @summary Test Connectivity * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ testConnectivity(): Promise>; /** * 24 hour rolling window price change statistics. * * Weight: **1** for a single symbol, **40** when the symbol parameter is omitted **Careful** when accessing this with no symbol. * * Notes: * - Symbol and pair cannot be sent together * - If a pair is sent,tickers for all symbols of the pair will be returned * - If either a pair or symbol is sent, tickers for all symbols of all pairs will be returned * * @summary 24hr Ticker Price Change Statistics * @param {Ticker24hrPriceChangeStatisticsRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ ticker24hrPriceChangeStatistics(requestParameters?: Ticker24hrPriceChangeStatisticsRequest): Promise>; /** * The proportion of net long and net short accounts to total accounts of * the top 20% users with the highest margin balance. Each account is * counted once only. * * Long Account % = Accounts of top traders with net long positions / Total * accounts of top traders with open positions * * Short Account % = Accounts of top traders with net short positions / * Total accounts of top traders with open positions * * Long/Short Ratio (Accounts) = Long Account % / Short Account % * * Weight(IP): 1 * * Security Type: Accounts * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Top Trader Long/Short Account Ratio * @param {TopTraderLongShortRatioAccountsRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ topTraderLongShortRatioAccounts(requestParameters: TopTraderLongShortRatioAccountsRequest): Promise>; /** * The proportion of net long and net short positions to total open * positions of the top 20% users with the highest margin balance. * * Long Position % = Long positions of top traders / Total open positions * of top traders * * Short Position % = Short positions of top traders / Total open positions * of top traders * * Long/Short Ratio (Positions) = Long Position % / Short Position % * * Weight(IP): 1 * * Security Type: Positions * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Top Trader Long/Short Position Ratio * @param {TopTraderLongShortRatioPositionsRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ topTraderLongShortRatioPositions(requestParameters: TopTraderLongShortRatioPositionsRequest): Promise>; } /** * Request parameters for basis operation in MarketDataApi. * @interface BasisRequest */ interface BasisRequest { /** * Pair. * @type {string} * @memberof MarketDataApiBasis */ readonly pair: string; /** * Contract type. * @type {'PERPETUAL' | 'CURRENT_QUARTER' | 'NEXT_QUARTER'} * @memberof MarketDataApiBasis */ readonly contractType: BasisContractTypeEnum; /** * Period interval. * @type {'5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '12h' | '1d'} * @memberof MarketDataApiBasis */ readonly period: BasisPeriodEnum; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiBasis */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiBasis */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiBasis */ readonly endTime?: number | bigint; } /** * Request parameters for compressedAggregateTradesList operation in MarketDataApi. * @interface CompressedAggregateTradesListRequest */ interface CompressedAggregateTradesListRequest { /** * Symbol * @type {string} * @memberof MarketDataApiCompressedAggregateTradesList */ readonly symbol: string; /** * ID to get aggregate trades from INCLUSIVE. * @type {number | bigint} * @memberof MarketDataApiCompressedAggregateTradesList */ readonly fromId?: number | bigint; /** * Timestamp in ms to get aggregate trades from INCLUSIVE. * @type {number | bigint} * @memberof MarketDataApiCompressedAggregateTradesList */ readonly startTime?: number | bigint; /** * Timestamp in ms to get aggregate trades until INCLUSIVE. * @type {number | bigint} * @memberof MarketDataApiCompressedAggregateTradesList */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiCompressedAggregateTradesList */ readonly limit?: number | bigint; } /** * Request parameters for continuousContractKlineCandlestickData operation in MarketDataApi. * @interface ContinuousContractKlineCandlestickDataRequest */ interface ContinuousContractKlineCandlestickDataRequest { /** * After CM migration, accepts both CM and UM pair values. * @type {string} * @memberof MarketDataApiContinuousContractKlineCandlestickData */ readonly pair: string; /** * * @type {'PERPETUAL' | 'CURRENT_QUARTER' | 'NEXT_QUARTER'} * @memberof MarketDataApiContinuousContractKlineCandlestickData */ readonly contractType: ContinuousContractKlineCandlestickDataContractTypeEnum; /** * Interval * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof MarketDataApiContinuousContractKlineCandlestickData */ readonly interval: ContinuousContractKlineCandlestickDataIntervalEnum; /** * Start time * @type {number | bigint} * @memberof MarketDataApiContinuousContractKlineCandlestickData */ readonly startTime?: number | bigint; /** * End time * @type {number | bigint} * @memberof MarketDataApiContinuousContractKlineCandlestickData */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiContinuousContractKlineCandlestickData */ readonly limit?: number | bigint; } /** * Request parameters for getFundingRateHistoryOfPerpetualFutures operation in MarketDataApi. * @interface GetFundingRateHistoryOfPerpetualFuturesRequest */ interface GetFundingRateHistoryOfPerpetualFuturesRequest { /** * Symbol * @type {string} * @memberof MarketDataApiGetFundingRateHistoryOfPerpetualFutures */ readonly symbol: string; /** * Timestamp in ms to get funding rate from INCLUSIVE. * @type {number | bigint} * @memberof MarketDataApiGetFundingRateHistoryOfPerpetualFutures */ readonly startTime?: number | bigint; /** * Timestamp in ms to get funding rate until INCLUSIVE. * @type {number | bigint} * @memberof MarketDataApiGetFundingRateHistoryOfPerpetualFutures */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiGetFundingRateHistoryOfPerpetualFutures */ readonly limit?: number | bigint; } /** * Request parameters for indexPriceAndMarkPrice operation in MarketDataApi. * @interface IndexPriceAndMarkPriceRequest */ interface IndexPriceAndMarkPriceRequest { /** * * @type {string} * @memberof MarketDataApiIndexPriceAndMarkPrice */ readonly symbol?: string; /** * * @type {string} * @memberof MarketDataApiIndexPriceAndMarkPrice */ readonly pair?: string; } /** * Request parameters for indexPriceKlineCandlestickData operation in MarketDataApi. * @interface IndexPriceKlineCandlestickDataRequest */ interface IndexPriceKlineCandlestickDataRequest { /** * After CM migration, accepts both CM and UM pair values. * @type {string} * @memberof MarketDataApiIndexPriceKlineCandlestickData */ readonly pair: string; /** * Interval * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof MarketDataApiIndexPriceKlineCandlestickData */ readonly interval: IndexPriceKlineCandlestickDataIntervalEnum; /** * Start time * @type {number | bigint} * @memberof MarketDataApiIndexPriceKlineCandlestickData */ readonly startTime?: number | bigint; /** * End time * @type {number | bigint} * @memberof MarketDataApiIndexPriceKlineCandlestickData */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiIndexPriceKlineCandlestickData */ readonly limit?: number | bigint; } /** * Request parameters for klineCandlestickData operation in MarketDataApi. * @interface KlineCandlestickDataRequest */ interface KlineCandlestickDataRequest { /** * After CM migration, accepts both CM and UM symbols. * @type {string} * @memberof MarketDataApiKlineCandlestickData */ readonly symbol: string; /** * Interval * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof MarketDataApiKlineCandlestickData */ readonly interval: KlineCandlestickDataIntervalEnum; /** * Start time * @type {number | bigint} * @memberof MarketDataApiKlineCandlestickData */ readonly startTime?: number | bigint; /** * End time * @type {number | bigint} * @memberof MarketDataApiKlineCandlestickData */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiKlineCandlestickData */ readonly limit?: number | bigint; } /** * Request parameters for longShortRatio operation in MarketDataApi. * @interface LongShortRatioRequest */ interface LongShortRatioRequest { /** * BTCUSD * @type {string} * @memberof MarketDataApiLongShortRatio */ readonly pair: string; /** * * @type {'5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '12h' | '1d'} * @memberof MarketDataApiLongShortRatio */ readonly period: LongShortRatioPeriodEnum; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiLongShortRatio */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiLongShortRatio */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiLongShortRatio */ readonly endTime?: number | bigint; } /** * Request parameters for markPriceKlineCandlestickData operation in MarketDataApi. * @interface MarkPriceKlineCandlestickDataRequest */ interface MarkPriceKlineCandlestickDataRequest { /** * After CM migration, accepts both CM and UM symbols. * @type {string} * @memberof MarketDataApiMarkPriceKlineCandlestickData */ readonly symbol: string; /** * Interval * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof MarketDataApiMarkPriceKlineCandlestickData */ readonly interval: MarkPriceKlineCandlestickDataIntervalEnum; /** * Start time * @type {number | bigint} * @memberof MarketDataApiMarkPriceKlineCandlestickData */ readonly startTime?: number | bigint; /** * End time * @type {number | bigint} * @memberof MarketDataApiMarkPriceKlineCandlestickData */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiMarkPriceKlineCandlestickData */ readonly limit?: number | bigint; } /** * Request parameters for oldTradesLookup operation in MarketDataApi. * @interface OldTradesLookupRequest */ interface OldTradesLookupRequest { /** * Symbol * @type {string} * @memberof MarketDataApiOldTradesLookup */ readonly symbol: string; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiOldTradesLookup */ readonly limit?: number | bigint; /** * TradeId to fetch from. Default gets most recent trades. * @type {number | bigint} * @memberof MarketDataApiOldTradesLookup */ readonly fromId?: number | bigint; } /** * Request parameters for openInterest operation in MarketDataApi. * @interface OpenInterestRequest */ interface OpenInterestRequest { /** * Symbol * @type {string} * @memberof MarketDataApiOpenInterest */ readonly symbol: string; } /** * Request parameters for openInterestStatistics operation in MarketDataApi. * @interface OpenInterestStatisticsRequest */ interface OpenInterestStatisticsRequest { /** * * @type {string} * @memberof MarketDataApiOpenInterestStatistics */ readonly pair: string; /** * * @type {'ALL' | 'PERPETUAL' | 'CURRENT_QUARTER' | 'NEXT_QUARTER'} * @memberof MarketDataApiOpenInterestStatistics */ readonly contractType: OpenInterestStatisticsContractTypeEnum; /** * * @type {'5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '12h' | '1d'} * @memberof MarketDataApiOpenInterestStatistics */ readonly period: OpenInterestStatisticsPeriodEnum; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiOpenInterestStatistics */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiOpenInterestStatistics */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiOpenInterestStatistics */ readonly endTime?: number | bigint; } /** * Request parameters for orderBook operation in MarketDataApi. * @interface OrderBookRequest */ interface OrderBookRequest { /** * Symbol * @type {string} * @memberof MarketDataApiOrderBook */ readonly symbol: string; /** * Valid limits:[5, 10, 20, 50, 100, 500, 1000]. * @type {number | bigint} * @memberof MarketDataApiOrderBook */ readonly limit?: number | bigint; } /** * Request parameters for premiumIndexKlineData operation in MarketDataApi. * @interface PremiumIndexKlineDataRequest */ interface PremiumIndexKlineDataRequest { /** * After CM migration, accepts both CM and UM symbols. * @type {string} * @memberof MarketDataApiPremiumIndexKlineData */ readonly symbol: string; /** * Interval * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof MarketDataApiPremiumIndexKlineData */ readonly interval: PremiumIndexKlineDataIntervalEnum; /** * Start time * @type {number | bigint} * @memberof MarketDataApiPremiumIndexKlineData */ readonly startTime?: number | bigint; /** * End time * @type {number | bigint} * @memberof MarketDataApiPremiumIndexKlineData */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiPremiumIndexKlineData */ readonly limit?: number | bigint; } /** * Request parameters for queryIndexPriceConstituents operation in MarketDataApi. * @interface QueryIndexPriceConstituentsRequest */ interface QueryIndexPriceConstituentsRequest { /** * Symbol * @type {string} * @memberof MarketDataApiQueryIndexPriceConstituents */ readonly symbol: string; } /** * Request parameters for recentTradesList operation in MarketDataApi. * @interface RecentTradesListRequest */ interface RecentTradesListRequest { /** * Symbol * @type {string} * @memberof MarketDataApiRecentTradesList */ readonly symbol: string; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiRecentTradesList */ readonly limit?: number | bigint; } /** * Request parameters for symbolOrderBookTicker operation in MarketDataApi. * @interface SymbolOrderBookTickerRequest */ interface SymbolOrderBookTickerRequest { /** * Symbol * @type {string} * @memberof MarketDataApiSymbolOrderBookTicker */ readonly symbol?: string; /** * Symbol * @type {string} * @memberof MarketDataApiSymbolOrderBookTicker */ readonly pair?: string; } /** * Request parameters for symbolPriceTicker operation in MarketDataApi. * @interface SymbolPriceTickerRequest */ interface SymbolPriceTickerRequest { /** * Symbol * @type {string} * @memberof MarketDataApiSymbolPriceTicker */ readonly symbol?: string; /** * Pair * @type {string} * @memberof MarketDataApiSymbolPriceTicker */ readonly pair?: string; } /** * Request parameters for takerBuySellVolume operation in MarketDataApi. * @interface TakerBuySellVolumeRequest */ interface TakerBuySellVolumeRequest { /** * * @type {string} * @memberof MarketDataApiTakerBuySellVolume */ readonly pair: string; /** * * @type {'ALL' | 'PERPETUAL' | 'CURRENT_QUARTER' | 'NEXT_QUARTER'} * @memberof MarketDataApiTakerBuySellVolume */ readonly contractType: TakerBuySellVolumeContractTypeEnum; /** * * @type {'5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '12h' | '1d'} * @memberof MarketDataApiTakerBuySellVolume */ readonly period: TakerBuySellVolumePeriodEnum; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiTakerBuySellVolume */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiTakerBuySellVolume */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiTakerBuySellVolume */ readonly endTime?: number | bigint; } /** * Request parameters for ticker24hrPriceChangeStatistics operation in MarketDataApi. * @interface Ticker24hrPriceChangeStatisticsRequest */ interface Ticker24hrPriceChangeStatisticsRequest { /** * Symbol * @type {string} * @memberof MarketDataApiTicker24hrPriceChangeStatistics */ readonly symbol?: string; /** * Pair * @type {string} * @memberof MarketDataApiTicker24hrPriceChangeStatistics */ readonly pair?: string; } /** * Request parameters for topTraderLongShortRatioAccounts operation in MarketDataApi. * @interface TopTraderLongShortRatioAccountsRequest */ interface TopTraderLongShortRatioAccountsRequest { /** * Symbol * @type {string} * @memberof MarketDataApiTopTraderLongShortRatioAccounts */ readonly symbol: string; /** * * @type {'5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '12h' | '1d'} * @memberof MarketDataApiTopTraderLongShortRatioAccounts */ readonly period: TopTraderLongShortRatioAccountsPeriodEnum; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiTopTraderLongShortRatioAccounts */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiTopTraderLongShortRatioAccounts */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiTopTraderLongShortRatioAccounts */ readonly endTime?: number | bigint; } /** * Request parameters for topTraderLongShortRatioPositions operation in MarketDataApi. * @interface TopTraderLongShortRatioPositionsRequest */ interface TopTraderLongShortRatioPositionsRequest { /** * * @type {string} * @memberof MarketDataApiTopTraderLongShortRatioPositions */ readonly pair: string; /** * * @type {'5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '12h' | '1d'} * @memberof MarketDataApiTopTraderLongShortRatioPositions */ readonly period: TopTraderLongShortRatioPositionsPeriodEnum; /** * Maximum number of records to return. * @type {number | bigint} * @memberof MarketDataApiTopTraderLongShortRatioPositions */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiTopTraderLongShortRatioPositions */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof MarketDataApiTopTraderLongShortRatioPositions */ readonly endTime?: number | bigint; } /** * MarketDataApi - object-oriented interface * @class MarketDataApi */ declare class MarketDataApi implements MarketDataApiInterface { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Query basis * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Basis * @param {BasisRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#basis Binance API Documentation} */ basis(requestParameters: BasisRequest): Promise>; /** * Test connectivity to the Rest API and get the current server time. * * Weight(IP): 1 * * @summary Check Server time * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#check-server-time Binance API Documentation} */ checkServerTime(): Promise>; /** * Get compressed, aggregate trades. Market trades that fill in 100ms with * the same price and the same taking side will have the quantity * aggregated. * * Weight(IP): 20 * * Notes: * - support querying futures trade histories that are not older than 24 hours * - If both `startTime` and `endTime` are sent, time between `startTime` and `endTime` must be less than 1 hour. * - If `fromId`, `startTime`, and `endTime` are not sent, the most recent aggregate trades will be returned. * - Only market trades will be aggregated and returned, which means the insurance fund trades and ADL trades won't be aggregated. * - Sending both `startTime`/`endTime` and `fromId` might cause response timeout, please send either `fromId` or `startTime`/`endTime` * * @summary Compressed/Aggregate Trades List * @param {CompressedAggregateTradesListRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#compressed-aggregate-trades-list Binance API Documentation} */ compressedAggregateTradesList(requestParameters: CompressedAggregateTradesListRequest): Promise>; /** * Kline/candlestick bars for a specific contract type. Klines are uniquely identified by their open time. * * Weight: based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Continuous Contract Kline/Candlestick Data * @param {ContinuousContractKlineCandlestickDataRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#continuous-contract-kline-candlestick-data Binance API Documentation} */ continuousContractKlineCandlestickData(requestParameters: ContinuousContractKlineCandlestickDataRequest): Promise>; /** * Current exchange trading rules and symbol information * * Weight(IP): 1 * * @summary Exchange Information * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#exchange-information Binance API Documentation} */ exchangeInformation(): Promise>; /** * Get Funding Rate History of Perpetual Futures * * Weight(IP): 1 * * Notes: * - empty array will be returned for delivery symbols. * * @summary Get Funding Rate History of Perpetual Futures * @param {GetFundingRateHistoryOfPerpetualFuturesRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#get-funding-rate-history-of-perpetual-futures Binance API Documentation} */ getFundingRateHistoryOfPerpetualFutures(requestParameters: GetFundingRateHistoryOfPerpetualFuturesRequest): Promise>; /** * Query funding rate info for symbols that had FundingRateCap/FundingRateFloor/fundingIntervalHours adjustment * * @summary Get Funding Rate Info * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#get-funding-rate-info Binance API Documentation} */ getFundingRateInfo(): Promise>; /** * Query index price and mark price * * Weight(IP): 10 * * @summary Index Price and Mark Price * @param {IndexPriceAndMarkPriceRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#index-price-and-mark-price Binance API Documentation} */ indexPriceAndMarkPrice(requestParameters?: IndexPriceAndMarkPriceRequest): Promise>; /** * Kline/candlestick bars for the index price of a pair. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Index Price Kline/Candlestick Data * @param {IndexPriceKlineCandlestickDataRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#index-price-kline-candlestick-data Binance API Documentation} */ indexPriceKlineCandlestickData(requestParameters: IndexPriceKlineCandlestickDataRequest): Promise>; /** * Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Kline/Candlestick Data * @param {KlineCandlestickDataRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#kline-candlestick-data Binance API Documentation} */ klineCandlestickData(requestParameters: KlineCandlestickDataRequest): Promise>; /** * Query symbol Long/Short Ratio * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Long/Short Ratio * @param {LongShortRatioRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#long-short-ratio Binance API Documentation} */ longShortRatio(requestParameters: LongShortRatioRequest): Promise>; /** * Kline/candlestick bars for the mark price of a symbol. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Mark Price Kline/Candlestick Data * @param {MarkPriceKlineCandlestickDataRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#mark-price-kline-candlestick-data Binance API Documentation} */ markPriceKlineCandlestickData(requestParameters: MarkPriceKlineCandlestickDataRequest): Promise>; /** * Get older market historical trades. * * Weight(IP): 20 * * Security Type: MARKET_DATA * * Notes: * - Market trades means trades filled in the order book. Only market trades will be returned, which means the insurance fund trades and ADL trades won't be returned. * - Only supports data from within the last one month * * @summary Old Trades Lookup (MARKET_DATA) * @param {OldTradesLookupRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#old-trades-lookup Binance API Documentation} */ oldTradesLookup(requestParameters: OldTradesLookupRequest): Promise>; /** * Get present open interest of a specific symbol. * * Weight(IP): 1 * * @summary Open Interest * @param {OpenInterestRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#open-interest Binance API Documentation} */ openInterest(requestParameters: OpenInterestRequest): Promise>; /** * Query open interest stats * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Open Interest Statistics * @param {OpenInterestStatisticsRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#open-interest-statistics Binance API Documentation} */ openInterestStatistics(requestParameters: OpenInterestStatisticsRequest): Promise>; /** * Query orderbook on specific symbol * * Weight: Adjusted based on the limit: * * | Limit | Weight | * | ------------ | ------------ | * | 5, 10, 20, 50 | 2 | * | 100 | 5 | * | 500 | 10 | * | 1000 | 20 | * * @summary Order Book * @param {OrderBookRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#order-book Binance API Documentation} */ orderBook(requestParameters: OrderBookRequest): Promise>; /** * Premium index kline bars of a symbol. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | ----------- | ------ | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - If startTime and endTime are not sent, the most recent klines are returned. * * @summary Premium index Kline Data * @param {PremiumIndexKlineDataRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#premium-index-kline-data Binance API Documentation} */ premiumIndexKlineData(requestParameters: PremiumIndexKlineDataRequest): Promise>; /** * Query index price constituents * * Weight(IP): 1 * * @summary Query Index Price Constituents * @param {QueryIndexPriceConstituentsRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#query-index-price-constituents Binance API Documentation} */ queryIndexPriceConstituents(requestParameters: QueryIndexPriceConstituentsRequest): Promise>; /** * Get recent market trades * * Weight(IP): 5 * * Notes: * - Market trades means trades filled in the order book. Only market trades will be returned, which means the insurance fund trades and ADL trades won't be returned. * * @summary Recent Trades List * @param {RecentTradesListRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#recent-trades-list Binance API Documentation} */ recentTradesList(requestParameters: RecentTradesListRequest): Promise>; /** * Best price/qty on the order book for a symbol or symbols. * * Weight: **2** for a single symbol, **5** when the symbol parameter is omitted * * Notes: * - Symbol and pair cannot be sent together * - If a pair is sent,tickers for all symbols of the pair will be returned * - If either a pair or symbol is sent, tickers for all symbols of all pairs will be returned * * @summary Symbol Order Book Ticker * @param {SymbolOrderBookTickerRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#symbol-order-book-ticker Binance API Documentation} */ symbolOrderBookTicker(requestParameters?: SymbolOrderBookTickerRequest): Promise>; /** * Latest price for a symbol or symbols. * * Weight: **1** for a single symbol, **2** when the symbol parameter is omitted * * Notes: * - Symbol and pair cannot be sent together * - If a pair is sent,tickers for all symbols of the pair will be returned * - If either a pair or symbol is sent, tickers for all symbols of all pairs will be returned * * @summary Symbol Price Ticker * @param {SymbolPriceTickerRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#symbol-price-ticker Binance API Documentation} */ symbolPriceTicker(requestParameters?: SymbolPriceTickerRequest): Promise>; /** * Taker Buy Volume: the total volume of buy orders filled by takers within * the period. * * Taker Sell Volume: the total volume of sell orders filled by takers * within the period. * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Taker Buy/Sell Volume * @param {TakerBuySellVolumeRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#taker-buy-sell-volume Binance API Documentation} */ takerBuySellVolume(requestParameters: TakerBuySellVolumeRequest): Promise>; /** * Test connectivity to the Rest API. * * Weight(IP): 1 * * @summary Test Connectivity * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#test-connectivity Binance API Documentation} */ testConnectivity(): Promise>; /** * 24 hour rolling window price change statistics. * * Weight: **1** for a single symbol, **40** when the symbol parameter is omitted **Careful** when accessing this with no symbol. * * Notes: * - Symbol and pair cannot be sent together * - If a pair is sent,tickers for all symbols of the pair will be returned * - If either a pair or symbol is sent, tickers for all symbols of all pairs will be returned * * @summary 24hr Ticker Price Change Statistics * @param {Ticker24hrPriceChangeStatisticsRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#ticker24hr-price-change-statistics Binance API Documentation} */ ticker24hrPriceChangeStatistics(requestParameters?: Ticker24hrPriceChangeStatisticsRequest): Promise>; /** * The proportion of net long and net short accounts to total accounts of * the top 20% users with the highest margin balance. Each account is * counted once only. * * Long Account % = Accounts of top traders with net long positions / Total * accounts of top traders with open positions * * Short Account % = Accounts of top traders with net short positions / * Total accounts of top traders with open positions * * Long/Short Ratio (Accounts) = Long Account % / Short Account % * * Weight(IP): 1 * * Security Type: Accounts * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Top Trader Long/Short Account Ratio * @param {TopTraderLongShortRatioAccountsRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#top-trader-long-short-ratio-accounts Binance API Documentation} */ topTraderLongShortRatioAccounts(requestParameters: TopTraderLongShortRatioAccountsRequest): Promise>; /** * The proportion of net long and net short positions to total open * positions of the top 20% users with the highest margin balance. * * Long Position % = Long positions of top traders / Total open positions * of top traders * * Short Position % = Short positions of top traders / Total open positions * of top traders * * Long/Short Ratio (Positions) = Long Position % / Short Position % * * Weight(IP): 1 * * Security Type: Positions * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Top Trader Long/Short Position Ratio * @param {TopTraderLongShortRatioPositionsRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#top-trader-long-short-ratio-positions Binance API Documentation} */ topTraderLongShortRatioPositions(requestParameters: TopTraderLongShortRatioPositionsRequest): Promise>; } declare enum BasisContractTypeEnum { PERPETUAL = "PERPETUAL", CURRENT_QUARTER = "CURRENT_QUARTER", NEXT_QUARTER = "NEXT_QUARTER", } declare enum BasisPeriodEnum { PERIOD_5m = "5m", PERIOD_15m = "15m", PERIOD_30m = "30m", PERIOD_1h = "1h", PERIOD_2h = "2h", PERIOD_4h = "4h", PERIOD_6h = "6h", PERIOD_12h = "12h", PERIOD_1d = "1d", } declare enum ContinuousContractKlineCandlestickDataContractTypeEnum { PERPETUAL = "PERPETUAL", CURRENT_QUARTER = "CURRENT_QUARTER", NEXT_QUARTER = "NEXT_QUARTER", } declare enum ContinuousContractKlineCandlestickDataIntervalEnum { INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum IndexPriceKlineCandlestickDataIntervalEnum { INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum KlineCandlestickDataIntervalEnum { INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum LongShortRatioPeriodEnum { PERIOD_5m = "5m", PERIOD_15m = "15m", PERIOD_30m = "30m", PERIOD_1h = "1h", PERIOD_2h = "2h", PERIOD_4h = "4h", PERIOD_6h = "6h", PERIOD_12h = "12h", PERIOD_1d = "1d", } declare enum MarkPriceKlineCandlestickDataIntervalEnum { INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum OpenInterestStatisticsContractTypeEnum { ALL = "ALL", PERPETUAL = "PERPETUAL", CURRENT_QUARTER = "CURRENT_QUARTER", NEXT_QUARTER = "NEXT_QUARTER", } declare enum OpenInterestStatisticsPeriodEnum { PERIOD_5m = "5m", PERIOD_15m = "15m", PERIOD_30m = "30m", PERIOD_1h = "1h", PERIOD_2h = "2h", PERIOD_4h = "4h", PERIOD_6h = "6h", PERIOD_12h = "12h", PERIOD_1d = "1d", } declare enum PremiumIndexKlineDataIntervalEnum { INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum TakerBuySellVolumeContractTypeEnum { ALL = "ALL", PERPETUAL = "PERPETUAL", CURRENT_QUARTER = "CURRENT_QUARTER", NEXT_QUARTER = "NEXT_QUARTER", } declare enum TakerBuySellVolumePeriodEnum { PERIOD_5m = "5m", PERIOD_15m = "15m", PERIOD_30m = "30m", PERIOD_1h = "1h", PERIOD_2h = "2h", PERIOD_4h = "4h", PERIOD_6h = "6h", PERIOD_12h = "12h", PERIOD_1d = "1d", } declare enum TopTraderLongShortRatioAccountsPeriodEnum { PERIOD_5m = "5m", PERIOD_15m = "15m", PERIOD_30m = "30m", PERIOD_1h = "1h", PERIOD_2h = "2h", PERIOD_4h = "4h", PERIOD_6h = "6h", PERIOD_12h = "12h", PERIOD_1d = "1d", } declare enum TopTraderLongShortRatioPositionsPeriodEnum { PERIOD_5m = "5m", PERIOD_15m = "15m", PERIOD_30m = "30m", PERIOD_1h = "1h", PERIOD_2h = "2h", PERIOD_4h = "4h", PERIOD_6h = "6h", PERIOD_12h = "12h", PERIOD_1d = "1d", } //#endregion //#region src/rest-api/modules/trade-api.d.ts /** * TradeApi - interface * @interface TradeApi */ interface TradeApiInterface$1 { /** * Get trades for a specific account and symbol. * * Weight: **20** with symbol，**40** with pair (after CM migration: **5** flat) * * Security Type: USER_DATA * * Notes: * - Either symbol or pair must be sent * - Symbol and pair cannot be sent together * - Pair and fromId cannot be sent together * - OrderId can only be sent together with symbol * - If a pair is sent,tickers for all symbols of the pair will be returned * - The parameter `fromId` cannot be sent with `startTime` or `endTime` * - If startTime and endTime are both not sent, then the last 7 days' data will be returned. * - The time between startTime and endTime cannot be longer than 7 days. * * @summary Account Trade List (USER_DATA) * @param {AccountTradeListRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ accountTradeList(requestParameters?: AccountTradeListRequest): Promise>; /** * Get all account orders; active, canceled, or filled. * * These orders will not be found: * order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time * order create time + 90 days < current time * * Weight: **20** with symbol, **40** with pair (after CM migration: **5** flat) * * Security Type: USER_DATA * * Notes: * - Either `symbol` or `pair` must be sent. * - `pair` can't be sent with `orderId` * - If `orderId` is set, it will get orders >= that `orderId`. Otherwise most recent orders are returned. * - If orderId is set, it will get orders >= that orderId. Otherwise most recent orders are returned. * - The query time period must be less then 7 days( default as the recent 7 days). * * @summary All Orders (USER_DATA) * @param {AllOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ allOrders(requestParameters?: AllOrdersRequest): Promise>; /** * Cancel all open orders of the specified symbol at the end of the * specified countdown. This rest endpoint means to ensure your open orders * are canceled in case of an outage. The endpoint should be called * repeatedly as heartbeats so that the existing countdown time can be * canceled and repalced by a new one. The system will check all countdowns **approximately every 10 milliseconds**, so please note that sufficient * redundancy should be considered when using this function. We do not * recommend setting the countdown time to be too precise or too small. * * * Example usage: * * Call this endpoint at 30s intervals with an countdownTime of 120000 * (120s). * * If this endpoint is not called within 120 seconds, all your orders of * the specified symbol will be automatically canceled. * * If this endpoint is called with an countdownTime of 0, the countdown * timer will be stopped. * * Weight(IP): 10 * * Security Type: TRADE * * @summary Auto-Cancel All Open Orders (TRADE) * @param {AutoCancelAllOpenOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ autoCancelAllOpenOrders(requestParameters: AutoCancelAllOpenOrdersRequest): Promise>; /** * Cancel All Open Orders * * Weight(IP): 1 * * Security Type: TRADE * * @summary Cancel All Open Orders (TRADE) * @param {CancelAllOpenOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ cancelAllOpenOrders(requestParameters: CancelAllOpenOrdersRequest): Promise>; /** * Cancel Multiple Orders * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderIdList` or `origClientOrderIdList ` must be sent. * * @summary Cancel Multiple Orders (TRADE) * @param {CancelMultipleOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ cancelMultipleOrders(requestParameters: CancelMultipleOrdersRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Cancel Order (TRADE) * @param {CancelOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ cancelOrder(requestParameters: CancelOrderRequest$1): Promise>; /** * Change user's initial leverage in the specific symbol market. * * For Hedge Mode, LONG and SHORT positions of one symbol use the same * initial leverage and share a total notional value. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Change Initial Leverage (TRADE) * @param {ChangeInitialLeverageRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ changeInitialLeverage(requestParameters: ChangeInitialLeverageRequest): Promise>; /** * Change user's margin type in the specific symbol market.For Hedge Mode, * LONG and SHORT positions of one symbol use the same margin type. * * With ISOLATED margin type, margins of the LONG and SHORT positions are * isolated from each other. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Change Margin Type (TRADE) * @param {ChangeMarginTypeRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ changeMarginType(requestParameters: ChangeMarginTypeRequest): Promise>; /** * Change user's position mode (Hedge Mode or One-way Mode ) on ***EVERY symbol***. * **After CM migration**, UM and CM share the **same** `dualSidePosition` setting. Calling this endpoint flips both UM and CM at once. If either side has any open order or open position, the change is rejected: * - `-4067` (open orders exist) * - `-4068` (open position exists) * * Weight(IP): 1 * * Security Type: TRADE * * @summary Change Position Mode (TRADE) * @param {ChangePositionModeRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ changePositionMode(requestParameters: ChangePositionModeRequest): Promise>; /** * Get all open orders on a symbol. **Careful** when accessing this with no symbol. * * Weight(IP): null * * Weight: **1** for a single symbol, **40** for mutltiple symbols * * Security Type: USER_DATA * * @summary Current All Open Orders (USER_DATA) * @param {CurrentAllOpenOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ currentAllOpenOrders(requestParameters?: CurrentAllOpenOrdersRequest): Promise>; /** * Get order modification history * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either `orderId` or `origClientOrderId` must be sent, and the `orderId` will prevail if both are sent. * - Order modify history longer than 3 month is not avaliable * * @summary Get Order Modify History (USER_DATA) * @param {GetOrderModifyHistoryRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ getOrderModifyHistory(requestParameters: GetOrderModifyHistoryRequest): Promise>; /** * Get position margin change history * * Weight(IP): 1 * * Security Type: TRADE * * @summary Get Position Margin Change History (TRADE) * @param {GetPositionMarginChangeHistoryRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ getPositionMarginChangeHistory(requestParameters: GetPositionMarginChangeHistoryRequest): Promise>; /** * Modify Isolated Position Margin * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Only for isolated symbol * * @summary Modify Isolated Position Margin (TRADE) * @param {ModifyIsolatedPositionMarginRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ modifyIsolatedPositionMargin(requestParameters: ModifyIsolatedPositionMarginRequest): Promise>; /** * Modify Multiple Orders * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * - Parameter rules are same with `Modify Order` * - Batch modify orders are processed concurrently, and the order of matching is not guaranteed. * - The order of returned contents for batch modify orders is the same as the order of the order list. * - One order can only be modfied for less than 10000 times * - `modifyId` is an optional user-defined identifier passed through as-is; the server does not validate its uniqueness. If omitted, it is not included in the response. * * @summary Modify Multiple Orders (TRADE) * @param {ModifyMultipleOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ modifyMultipleOrders(requestParameters: ModifyMultipleOrdersRequest): Promise>; /** * Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent, and the `orderId` will prevail if both are sent. * - Either `quantity` or `price` must be sent. *(After CM migration, both `quantity` and `price` are required.)* * - When the new `quantity` or `price` doesn't satisfy PRICE_FILTER / PERCENT_FILTER / LOT_SIZE, amendment will be rejected and the order will stay as it is. * - However the order will be cancelled by the amendment in the following situations: * - when the order is in partially filled status and the new `quantity` * - When the order is `GTX` and the new price will cause it to be executed immediately * - One order can only be modfied for less than 10000 times * * @summary Modify Order (TRADE) * @param {ModifyOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ modifyOrder(requestParameters: ModifyOrderRequest$1): Promise>; /** * Send in a new order. * * Weight: 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M) * 0 on IP rate limit(x-mbx-used-weight-1m) * * Security Type: TRADE * * Notes: * - Additional mandatory parameters based on `type`: * - Order with type `STOP`, parameter `timeInForce` can be sent ( default `GTC`). * - Order with type `TAKE_PROFIT`, parameter `timeInForce` can be sent ( default `GTC`). * - Condition orders will be triggered when: * - If parameter`priceProtect`is sent as true: * - when price reaches the `stopPrice` ，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol * - "triggerProtect" of a symbol can be got from `GET /dapi/v1/exchangeInfo` * - `STOP`, `STOP_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") * -`TAKE_PROFIT`, `TAKE_PROFIT_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - `TRAILING_STOP_MARKET`: * - BUY: the lowest price after order placed ``= the lowest price * (1 + `callbackRate`) * - SELL: the highest price after order placed >= `activationPrice`, and the latest price * * - For `TRAILING_STOP_MARKET`, if you got such error code. > `{"code": -2021, "msg": "Order would immediately trigger."}` > means that the parameters you send do not meet the following requirements: * - BUY: `activationPrice` should be smaller than latest price. * - SELL: `activationPrice` should be larger than latest price. * - If `newOrderRespType ` is sent as `RESULT` : * - `MARKET` order: the final FILLED result of the order will be return directly. * - `LIMIT` order with special `timeInForce`: the final status result of the order(FILLED or EXPIRED) will be returned directly. * - `STOP_MARKET`, `TAKE_PROFIT_MARKET` with `closePosition`=`true`: * - Follow the same rules for condition orders. * - If triggered,**close all** current long position( if `SELL`) or current short position( if `BUY`). * - Cannot be used with `quantity` parameter * - Cannot be used with `reduceOnly` parameter * - In Hedge Mode,cannot be used with `BUY` orders in `LONG` position side. and cannot be used with `SELL` orders in `SHORT` position side * * - `selfTradePreventionMode` is only effective when `timeInForce` set to `IOC` or `GTC`. * * @summary New Order (TRADE) * @param {NewOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ newOrder(requestParameters: NewOrderRequest$1): Promise>; /** * Place multiple orders * * Parameter rules are same with `New Order` * Batch orders are processed concurrently, and the order of matching is not guaranteed. * The order of returned contents for batch orders is the same as the order of the order list. * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * - `batchOrders` must be a JSON array of order parameter objects. * - Example: * `/dapi/v1/batchOrders?batchOrders=[{"type":"LIMIT","timeInForce":"GTC","symbol":"BTCUSD_PERP","side":"BUY","price":"10001","quantity":"1"}]` * * @summary Place Multiple Orders (TRADE) * @param {PlaceMultipleOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ placeMultipleOrders(requestParameters: PlaceMultipleOrdersRequest): Promise>; /** * Query position ADL quantile estimation * * Values update every 30s. * Values 0, 1, 2, 3, 4 shows the queue position and possibility of ADL from low to high. * For positions of the symbol are in One-way Mode or isolated margined in Hedge Mode, "LONG", "SHORT", and "BOTH" will be returned to show the positions' adl quantiles of different position sides. * If the positions of the symbol are crossed margined in Hedge Mode: * "HEDGE" as a sign will be returned instead of "BOTH"; * A same value caculated on unrealized pnls on long and short sides' positions will be shown for "LONG" and "SHORT" when there are positions in both of long and short sides. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Position ADL Quantile Estimation (USER_DATA) * @param {PositionAdlQuantileEstimationRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ positionAdlQuantileEstimation(requestParameters?: PositionAdlQuantileEstimationRequest): Promise>; /** * Get current account information. * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - If neither `marginAsset` nor `pair` is sent, positions of all symbols with `TRADING` status will be returned. * - for One-way Mode user, the response will only show the "BOTH" positions * - for Hedge Mode user, the response will show "BOTH", "LONG", and "SHORT" positions. **Note** > Please use with user data stream `ACCOUNT_UPDATE` to meet your timeliness and accuracy needs. * - Please use with user data stream ACCOUNT_UPDATE to meet your timeliness and accuracy needs. * * @summary Position Information (USER_DATA) * @param {PositionInformationRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ positionInformation(requestParameters?: PositionInformationRequest$1): Promise>; /** * Query Current Open Order * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either`orderId` or `origClientOrderId` must be sent * - If the queried order has been filled or cancelled, the error message "Order does not exist" will be returned. * * @summary Query Current Open Order (USER_DATA) * @param {QueryCurrentOpenOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ queryCurrentOpenOrder(requestParameters: QueryCurrentOpenOrderRequest): Promise>; /** * Check an order's status. * * These orders will not be found: * order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time * order create time + 90 days < current time * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Query Order (USER_DATA) * @param {QueryOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ queryOrder(requestParameters: QueryOrderRequest$1): Promise>; /** * User's Force Orders * * Weight: **20** (after CM migration: **20** with symbol / **50** without symbol) * * Security Type: USER_DATA * * Notes: * - If "autoCloseType" is not sent, orders with both of the types will be returned * - Only support querying data in the past 90 days * * @summary User\'s Force Orders (USER_DATA) * @param {UsersForceOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ usersForceOrders(requestParameters?: UsersForceOrdersRequest): Promise>; } /** * Request parameters for accountTradeList operation in TradeApi. * @interface AccountTradeListRequest */ interface AccountTradeListRequest { /** * Symbol * @type {string} * @memberof TradeApiAccountTradeList */ readonly symbol?: string; /** * pair * @type {string} * @memberof TradeApiAccountTradeList */ readonly pair?: string; /** * Order ID * @type {string} * @memberof TradeApiAccountTradeList */ readonly orderId?: string; /** * Start time * @type {number | bigint} * @memberof TradeApiAccountTradeList */ readonly startTime?: number | bigint; /** * End time * @type {number | bigint} * @memberof TradeApiAccountTradeList */ readonly endTime?: number | bigint; /** * Trade id to fetch from. Default gets most recent trades. * @type {number | bigint} * @memberof TradeApiAccountTradeList */ readonly fromId?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof TradeApiAccountTradeList */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof TradeApiAccountTradeList */ readonly recvWindow?: number | bigint; } /** * Request parameters for allOrders operation in TradeApi. * @interface AllOrdersRequest */ interface AllOrdersRequest { /** * Symbol * @type {string} * @memberof TradeApiAllOrders */ readonly symbol?: string; /** * Pair * @type {string} * @memberof TradeApiAllOrders */ readonly pair?: string; /** * * @type {number | bigint} * @memberof TradeApiAllOrders */ readonly orderId?: number | bigint; /** * Start time * @type {number | bigint} * @memberof TradeApiAllOrders */ readonly startTime?: number | bigint; /** * End time * @type {number | bigint} * @memberof TradeApiAllOrders */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof TradeApiAllOrders */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof TradeApiAllOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for autoCancelAllOpenOrders operation in TradeApi. * @interface AutoCancelAllOpenOrdersRequest */ interface AutoCancelAllOpenOrdersRequest { /** * * @type {string} * @memberof TradeApiAutoCancelAllOpenOrders */ readonly symbol: string; /** * countdown time, 1000 for 1 second. 0 to cancel the timer * @type {number | bigint} * @memberof TradeApiAutoCancelAllOpenOrders */ readonly countdownTime: number | bigint; /** * * @type {number | bigint} * @memberof TradeApiAutoCancelAllOpenOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for cancelAllOpenOrders operation in TradeApi. * @interface CancelAllOpenOrdersRequest */ interface CancelAllOpenOrdersRequest { /** * Symbol * @type {string} * @memberof TradeApiCancelAllOpenOrders */ readonly symbol: string; /** * * @type {number | bigint} * @memberof TradeApiCancelAllOpenOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for cancelMultipleOrders operation in TradeApi. * @interface CancelMultipleOrdersRequest */ interface CancelMultipleOrdersRequest { /** * Symbol * @type {string} * @memberof TradeApiCancelMultipleOrders */ readonly symbol: string; /** * Order IDs to cancel. * @type {Array} * @memberof TradeApiCancelMultipleOrders */ readonly orderIdList?: Array; /** * Original client order IDs to cancel. * @type {Array} * @memberof TradeApiCancelMultipleOrders */ readonly origClientOrderIdList?: Array; /** * * @type {number | bigint} * @memberof TradeApiCancelMultipleOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for cancelOrder operation in TradeApi. * @interface CancelOrderRequest */ interface CancelOrderRequest$1 { /** * Symbol * @type {string} * @memberof TradeApiCancelOrder */ readonly symbol: string; /** * Order ID * @type {number | bigint} * @memberof TradeApiCancelOrder */ readonly orderId?: number | bigint; /** * Client order ID * @type {string} * @memberof TradeApiCancelOrder */ readonly origClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiCancelOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for changeInitialLeverage operation in TradeApi. * @interface ChangeInitialLeverageRequest */ interface ChangeInitialLeverageRequest { /** * Symbol * @type {string} * @memberof TradeApiChangeInitialLeverage */ readonly symbol: string; /** * target initial leverage: int from 1 to 125 * @type {number | bigint} * @memberof TradeApiChangeInitialLeverage */ readonly leverage: number | bigint; /** * * @type {number | bigint} * @memberof TradeApiChangeInitialLeverage */ readonly recvWindow?: number | bigint; } /** * Request parameters for changeMarginType operation in TradeApi. * @interface ChangeMarginTypeRequest */ interface ChangeMarginTypeRequest { /** * Symbol * @type {string} * @memberof TradeApiChangeMarginType */ readonly symbol: string; /** * * @type {'ISOLATED' | 'CROSSED'} * @memberof TradeApiChangeMarginType */ readonly marginType: ChangeMarginTypeMarginTypeEnum; /** * * @type {number | bigint} * @memberof TradeApiChangeMarginType */ readonly recvWindow?: number | bigint; } /** * Request parameters for changePositionMode operation in TradeApi. * @interface ChangePositionModeRequest */ interface ChangePositionModeRequest { /** * "true": Hedge Mode; "false": One-way Mode * @type {string} * @memberof TradeApiChangePositionMode */ readonly dualSidePosition: string; /** * * @type {number | bigint} * @memberof TradeApiChangePositionMode */ readonly recvWindow?: number | bigint; } /** * Request parameters for currentAllOpenOrders operation in TradeApi. * @interface CurrentAllOpenOrdersRequest */ interface CurrentAllOpenOrdersRequest { /** * Symbol. **After CM migration, an invalid `symbol` returns `-1121` (previously a silent `200`).** * @type {string} * @memberof TradeApiCurrentAllOpenOrders */ readonly symbol?: string; /** * Pair * @type {string} * @memberof TradeApiCurrentAllOpenOrders */ readonly pair?: string; /** * * @type {number | bigint} * @memberof TradeApiCurrentAllOpenOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for getOrderModifyHistory operation in TradeApi. * @interface GetOrderModifyHistoryRequest */ interface GetOrderModifyHistoryRequest { /** * Symbol * @type {string} * @memberof TradeApiGetOrderModifyHistory */ readonly symbol: string; /** * Order ID * @type {number | bigint} * @memberof TradeApiGetOrderModifyHistory */ readonly orderId?: number | bigint; /** * Client order ID * @type {string} * @memberof TradeApiGetOrderModifyHistory */ readonly origClientOrderId?: string; /** * Timestamp in ms to get modification history from INCLUSIVE * @type {number | bigint} * @memberof TradeApiGetOrderModifyHistory */ readonly startTime?: number | bigint; /** * Timestamp in ms to get modification history until INCLUSIVE * @type {number | bigint} * @memberof TradeApiGetOrderModifyHistory */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof TradeApiGetOrderModifyHistory */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof TradeApiGetOrderModifyHistory */ readonly recvWindow?: number | bigint; } /** * Request parameters for getPositionMarginChangeHistory operation in TradeApi. * @interface GetPositionMarginChangeHistoryRequest */ interface GetPositionMarginChangeHistoryRequest { /** * * @type {string} * @memberof TradeApiGetPositionMarginChangeHistory */ readonly symbol: string; /** * 1: Add position margin,2: Reduce position margin * @type {number | bigint} * @memberof TradeApiGetPositionMarginChangeHistory */ readonly type?: number | bigint; /** * Start time * @type {number | bigint} * @memberof TradeApiGetPositionMarginChangeHistory */ readonly startTime?: number | bigint; /** * End time * @type {number | bigint} * @memberof TradeApiGetPositionMarginChangeHistory */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof TradeApiGetPositionMarginChangeHistory */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof TradeApiGetPositionMarginChangeHistory */ readonly recvWindow?: number | bigint; } /** * Request parameters for modifyIsolatedPositionMargin operation in TradeApi. * @interface ModifyIsolatedPositionMarginRequest */ interface ModifyIsolatedPositionMarginRequest { /** * Symbol * @type {string} * @memberof TradeApiModifyIsolatedPositionMargin */ readonly symbol: string; /** * Margin asset * @type {number} * @memberof TradeApiModifyIsolatedPositionMargin */ readonly amount: number; /** * 1: Add position margin,2: Reduce position margin * @type {number | bigint} * @memberof TradeApiModifyIsolatedPositionMargin */ readonly type: number | bigint; /** * Default `BOTH` for One-way Mode ; `LONG` or `SHORT` for Hedge Mode. It must be sent with Hedge Mode. * @type {'BOTH' | 'LONG' | 'SHORT'} * @memberof TradeApiModifyIsolatedPositionMargin */ readonly positionSide?: ModifyIsolatedPositionMarginPositionSideEnum; /** * * @type {number | bigint} * @memberof TradeApiModifyIsolatedPositionMargin */ readonly recvWindow?: number | bigint; } /** * Request parameters for modifyMultipleOrders operation in TradeApi. * @interface ModifyMultipleOrdersRequest */ interface ModifyMultipleOrdersRequest { /** * order list. Max 5 orders * @type {Array} * @memberof TradeApiModifyMultipleOrders */ readonly batchOrders: Array; /** * * @type {number | bigint} * @memberof TradeApiModifyMultipleOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for modifyOrder operation in TradeApi. * @interface ModifyOrderRequest */ interface ModifyOrderRequest$1 { /** * Symbol * @type {string} * @memberof TradeApiModifyOrder */ readonly symbol: string; /** * * @type {'BUY' | 'SELL'} * @memberof TradeApiModifyOrder */ readonly side: ModifyOrderSideEnum$1; /** * Order ID * @type {number | bigint} * @memberof TradeApiModifyOrder */ readonly orderId?: number | bigint; /** * Client order ID * @type {string} * @memberof TradeApiModifyOrder */ readonly origClientOrderId?: string; /** * Order quantity, cannot be sent with `closePosition=true`. **After CM migration, this parameter becomes mandatory** (must be sent together with `price`). * @type {number} * @memberof TradeApiModifyOrder */ readonly quantity?: number; /** * Order price. **After CM migration, this parameter becomes mandatory** (must be sent together with `quantity`). * @type {number} * @memberof TradeApiModifyOrder */ readonly price?: number; /** * only avaliable for `LIMIT`/`STOP`/`TAKE_PROFIT` order; Can't be passed together with `price` * @type {'OPPONENT' | 'OPPONENT_5' | 'OPPONENT_10' | 'OPPONENT_20' | 'QUEUE' | 'QUEUE_5' | 'QUEUE_10' | 'QUEUE_20'} * @memberof TradeApiModifyOrder */ readonly priceMatch?: ModifyOrderPriceMatchEnum$1; /** * User-defined modification identifier, returned as-is in the response. Optional; not validated for uniqueness. * @type {number | bigint} * @memberof TradeApiModifyOrder */ readonly modifyId?: number | bigint; /** * * @type {number | bigint} * @memberof TradeApiModifyOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for newOrder operation in TradeApi. * @interface NewOrderRequest */ interface NewOrderRequest$1 { /** * Symbol * @type {string} * @memberof TradeApiNewOrder */ readonly symbol: string; /** * * @type {'BUY' | 'SELL'} * @memberof TradeApiNewOrder */ readonly side: NewOrderSideEnum$1; /** * **After CM migration, stop-type values (`STOP`, `STOP_MARKET`, `TAKE_PROFIT`, `TAKE_PROFIT_MARKET`, `TRAILING_STOP_MARKET`) are no longer accepted by this endpoint and will return `-4120`. Use the new `/dapi/v1/algoOrder` endpoint instead.** * @type {'LIMIT' | 'MARKET' | 'STOP' | 'STOP_MARKET' | 'TAKE_PROFIT' | 'TAKE_PROFIT_MARKET' | 'TRAILING_STOP_MARKET'} * @memberof TradeApiNewOrder */ readonly type: NewOrderTypeEnum$1; /** * Default `BOTH` for One-way Mode ; `LONG` or `SHORT` for Hedge Mode. It must be sent in Hedge Mode. * @type {'BOTH' | 'LONG' | 'SHORT'} * @memberof TradeApiNewOrder */ readonly positionSide?: NewOrderPositionSideEnum$1; /** * "true" or "false". Cannot be sent in Hedge * Mode; cannot be sent with `closePosition`=`true`(Close-All) * @type {'true' | 'false'} * @memberof TradeApiNewOrder */ readonly reduceOnly?: NewOrderReduceOnlyEnum$1; /** * quantity measured by contract number, Cannot be sent with `closePosition`=`true` * @type {number} * @memberof TradeApiNewOrder */ readonly quantity?: number; /** * Order price * @type {number} * @memberof TradeApiNewOrder */ readonly price?: number; /** * A unique id among open orders. Automatically generated if * not sent. Can only be string following the rule: * `^[\.A-Z\:/a-z0-9_-]{1,36}$` * @type {string} * @memberof TradeApiNewOrder */ readonly newClientOrderId?: string; /** * Used with `STOP/STOP_MARKET` or `TAKE_PROFIT/TAKE_PROFIT_MARKET` orders. * @type {number} * @memberof TradeApiNewOrder */ readonly stopPrice?: number; /** * `true`, `false`；Close-All,used with `STOP_MARKET` or `TAKE_PROFIT_MARKET`. * @type {string} * @memberof TradeApiNewOrder */ readonly closePosition?: string; /** * Used with `TRAILING_STOP_MARKET` orders, default as the * latest price(supporting different `workingType`) * @type {number} * @memberof TradeApiNewOrder */ readonly activationPrice?: number; /** * Used with `TRAILING_STOP_MARKET` orders, min 0.1, max 10 where 1 for 1% * @type {number} * @memberof TradeApiNewOrder */ readonly callbackRate?: number; /** * * @type {'GTC' | 'IOC' | 'FOK' | 'GTX'} * @memberof TradeApiNewOrder */ readonly timeInForce?: NewOrderTimeInForceEnum$1; /** * 'stopPrice triggered by: "MARK_PRICE", "CONTRACT_PRICE". * @type {'MARK_PRICE' | 'CONTRACT_PRICE'} * @memberof TradeApiNewOrder */ readonly workingType?: NewOrderWorkingTypeEnum$1; /** * "true" or "false". Used with * `STOP/STOP_MARKET` or `TAKE_PROFIT/TAKE_PROFIT_MARKET` * orders. * @type {'true' | 'false'} * @memberof TradeApiNewOrder */ readonly priceProtect?: NewOrderPriceProtectEnum$1; /** * * @type {'ACK' | 'RESULT'} * @memberof TradeApiNewOrder */ readonly newOrderRespType?: NewOrderNewOrderRespTypeEnum$1; /** * only avaliable for `LIMIT`/`STOP`/`TAKE_PROFIT` order; * Can't be passed together with `price` * @type {'OPPONENT' | 'OPPONENT_5' | 'OPPONENT_10' | 'OPPONENT_20' | 'QUEUE' | 'QUEUE_5' | 'QUEUE_10' | 'QUEUE_20'} * @memberof TradeApiNewOrder */ readonly priceMatch?: NewOrderPriceMatchEnum$1; /** * `EXPIRE_TAKER`:expire taker order when STP triggers/ * `EXPIRE_MAKER`:expire taker order when STP triggers/ * `EXPIRE_BOTH`:expire both orders when STP triggers * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_BOTH' | 'EXPIRE_MAKER'} * @memberof TradeApiNewOrder */ readonly selfTradePreventionMode?: NewOrderSelfTradePreventionModeEnum$1; /** * * @type {number | bigint} * @memberof TradeApiNewOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for placeMultipleOrders operation in TradeApi. * @interface PlaceMultipleOrdersRequest */ interface PlaceMultipleOrdersRequest { /** * order list. Max 5 orders * @type {Array} * @memberof TradeApiPlaceMultipleOrders */ readonly batchOrders: Array; /** * * @type {number | bigint} * @memberof TradeApiPlaceMultipleOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for positionAdlQuantileEstimation operation in TradeApi. * @interface PositionAdlQuantileEstimationRequest */ interface PositionAdlQuantileEstimationRequest { /** * * @type {string} * @memberof TradeApiPositionAdlQuantileEstimation */ readonly symbol?: string; /** * * @type {number | bigint} * @memberof TradeApiPositionAdlQuantileEstimation */ readonly recvWindow?: number | bigint; } /** * Request parameters for positionInformation operation in TradeApi. * @interface PositionInformationRequest */ interface PositionInformationRequest$1 { /** * * @type {string} * @memberof TradeApiPositionInformation */ readonly marginAsset?: string; /** * * @type {string} * @memberof TradeApiPositionInformation */ readonly pair?: string; /** * * @type {number | bigint} * @memberof TradeApiPositionInformation */ readonly recvWindow?: number | bigint; } /** * Request parameters for queryCurrentOpenOrder operation in TradeApi. * @interface QueryCurrentOpenOrderRequest */ interface QueryCurrentOpenOrderRequest { /** * Symbol * @type {string} * @memberof TradeApiQueryCurrentOpenOrder */ readonly symbol: string; /** * Order ID * @type {number | bigint} * @memberof TradeApiQueryCurrentOpenOrder */ readonly orderId?: number | bigint; /** * Client order ID * @type {string} * @memberof TradeApiQueryCurrentOpenOrder */ readonly origClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiQueryCurrentOpenOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for queryOrder operation in TradeApi. * @interface QueryOrderRequest */ interface QueryOrderRequest$1 { /** * Symbol * @type {string} * @memberof TradeApiQueryOrder */ readonly symbol: string; /** * Order ID * @type {number | bigint} * @memberof TradeApiQueryOrder */ readonly orderId?: number | bigint; /** * Client order ID * @type {string} * @memberof TradeApiQueryOrder */ readonly origClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiQueryOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for usersForceOrders operation in TradeApi. * @interface UsersForceOrdersRequest */ interface UsersForceOrdersRequest { /** * * @type {string} * @memberof TradeApiUsersForceOrders */ readonly symbol?: string; /** * * @type {'LIQUIDATION' | 'ADL'} * @memberof TradeApiUsersForceOrders */ readonly autoCloseType?: UsersForceOrdersAutoCloseTypeEnum; /** * * @type {number | bigint} * @memberof TradeApiUsersForceOrders */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof TradeApiUsersForceOrders */ readonly endTime?: number | bigint; /** * Maximum number of records to return. * @type {number | bigint} * @memberof TradeApiUsersForceOrders */ readonly limit?: number | bigint; /** * * @type {number | bigint} * @memberof TradeApiUsersForceOrders */ readonly recvWindow?: number | bigint; } /** * TradeApi - object-oriented interface * @class TradeApi */ declare class TradeApi$1 implements TradeApiInterface$1 { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Get trades for a specific account and symbol. * * Weight: **20** with symbol，**40** with pair (after CM migration: **5** flat) * * Security Type: USER_DATA * * Notes: * - Either symbol or pair must be sent * - Symbol and pair cannot be sent together * - Pair and fromId cannot be sent together * - OrderId can only be sent together with symbol * - If a pair is sent,tickers for all symbols of the pair will be returned * - The parameter `fromId` cannot be sent with `startTime` or `endTime` * - If startTime and endTime are both not sent, then the last 7 days' data will be returned. * - The time between startTime and endTime cannot be longer than 7 days. * * @summary Account Trade List (USER_DATA) * @param {AccountTradeListRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#account-trade-list Binance API Documentation} */ accountTradeList(requestParameters?: AccountTradeListRequest): Promise>; /** * Get all account orders; active, canceled, or filled. * * These orders will not be found: * order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time * order create time + 90 days < current time * * Weight: **20** with symbol, **40** with pair (after CM migration: **5** flat) * * Security Type: USER_DATA * * Notes: * - Either `symbol` or `pair` must be sent. * - `pair` can't be sent with `orderId` * - If `orderId` is set, it will get orders >= that `orderId`. Otherwise most recent orders are returned. * - If orderId is set, it will get orders >= that orderId. Otherwise most recent orders are returned. * - The query time period must be less then 7 days( default as the recent 7 days). * * @summary All Orders (USER_DATA) * @param {AllOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#all-orders Binance API Documentation} */ allOrders(requestParameters?: AllOrdersRequest): Promise>; /** * Cancel all open orders of the specified symbol at the end of the * specified countdown. This rest endpoint means to ensure your open orders * are canceled in case of an outage. The endpoint should be called * repeatedly as heartbeats so that the existing countdown time can be * canceled and repalced by a new one. The system will check all countdowns **approximately every 10 milliseconds**, so please note that sufficient * redundancy should be considered when using this function. We do not * recommend setting the countdown time to be too precise or too small. * * * Example usage: * * Call this endpoint at 30s intervals with an countdownTime of 120000 * (120s). * * If this endpoint is not called within 120 seconds, all your orders of * the specified symbol will be automatically canceled. * * If this endpoint is called with an countdownTime of 0, the countdown * timer will be stopped. * * Weight(IP): 10 * * Security Type: TRADE * * @summary Auto-Cancel All Open Orders (TRADE) * @param {AutoCancelAllOpenOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#auto-cancel-all-open-orders Binance API Documentation} */ autoCancelAllOpenOrders(requestParameters: AutoCancelAllOpenOrdersRequest): Promise>; /** * Cancel All Open Orders * * Weight(IP): 1 * * Security Type: TRADE * * @summary Cancel All Open Orders (TRADE) * @param {CancelAllOpenOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#cancel-all-open-orders Binance API Documentation} */ cancelAllOpenOrders(requestParameters: CancelAllOpenOrdersRequest): Promise>; /** * Cancel Multiple Orders * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderIdList` or `origClientOrderIdList ` must be sent. * * @summary Cancel Multiple Orders (TRADE) * @param {CancelMultipleOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#cancel-multiple-orders Binance API Documentation} */ cancelMultipleOrders(requestParameters: CancelMultipleOrdersRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Cancel Order (TRADE) * @param {CancelOrderRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#cancel-order Binance API Documentation} */ cancelOrder(requestParameters: CancelOrderRequest$1): Promise>; /** * Change user's initial leverage in the specific symbol market. * * For Hedge Mode, LONG and SHORT positions of one symbol use the same * initial leverage and share a total notional value. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Change Initial Leverage (TRADE) * @param {ChangeInitialLeverageRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#change-initial-leverage Binance API Documentation} */ changeInitialLeverage(requestParameters: ChangeInitialLeverageRequest): Promise>; /** * Change user's margin type in the specific symbol market.For Hedge Mode, * LONG and SHORT positions of one symbol use the same margin type. * * With ISOLATED margin type, margins of the LONG and SHORT positions are * isolated from each other. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Change Margin Type (TRADE) * @param {ChangeMarginTypeRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#change-margin-type Binance API Documentation} */ changeMarginType(requestParameters: ChangeMarginTypeRequest): Promise>; /** * Change user's position mode (Hedge Mode or One-way Mode ) on ***EVERY symbol***. * **After CM migration**, UM and CM share the **same** `dualSidePosition` setting. Calling this endpoint flips both UM and CM at once. If either side has any open order or open position, the change is rejected: * - `-4067` (open orders exist) * - `-4068` (open position exists) * * Weight(IP): 1 * * Security Type: TRADE * * @summary Change Position Mode (TRADE) * @param {ChangePositionModeRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#change-position-mode Binance API Documentation} */ changePositionMode(requestParameters: ChangePositionModeRequest): Promise>; /** * Get all open orders on a symbol. **Careful** when accessing this with no symbol. * * Weight(IP): null * * Weight: **1** for a single symbol, **40** for mutltiple symbols * * Security Type: USER_DATA * * @summary Current All Open Orders (USER_DATA) * @param {CurrentAllOpenOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#current-all-open-orders Binance API Documentation} */ currentAllOpenOrders(requestParameters?: CurrentAllOpenOrdersRequest): Promise>; /** * Get order modification history * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either `orderId` or `origClientOrderId` must be sent, and the `orderId` will prevail if both are sent. * - Order modify history longer than 3 month is not avaliable * * @summary Get Order Modify History (USER_DATA) * @param {GetOrderModifyHistoryRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#get-order-modify-history Binance API Documentation} */ getOrderModifyHistory(requestParameters: GetOrderModifyHistoryRequest): Promise>; /** * Get position margin change history * * Weight(IP): 1 * * Security Type: TRADE * * @summary Get Position Margin Change History (TRADE) * @param {GetPositionMarginChangeHistoryRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#get-position-margin-change-history Binance API Documentation} */ getPositionMarginChangeHistory(requestParameters: GetPositionMarginChangeHistoryRequest): Promise>; /** * Modify Isolated Position Margin * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Only for isolated symbol * * @summary Modify Isolated Position Margin (TRADE) * @param {ModifyIsolatedPositionMarginRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#modify-isolated-position-margin Binance API Documentation} */ modifyIsolatedPositionMargin(requestParameters: ModifyIsolatedPositionMarginRequest): Promise>; /** * Modify Multiple Orders * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * - Parameter rules are same with `Modify Order` * - Batch modify orders are processed concurrently, and the order of matching is not guaranteed. * - The order of returned contents for batch modify orders is the same as the order of the order list. * - One order can only be modfied for less than 10000 times * - `modifyId` is an optional user-defined identifier passed through as-is; the server does not validate its uniqueness. If omitted, it is not included in the response. * * @summary Modify Multiple Orders (TRADE) * @param {ModifyMultipleOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#modify-multiple-orders Binance API Documentation} */ modifyMultipleOrders(requestParameters: ModifyMultipleOrdersRequest): Promise>; /** * Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent, and the `orderId` will prevail if both are sent. * - Either `quantity` or `price` must be sent. *(After CM migration, both `quantity` and `price` are required.)* * - When the new `quantity` or `price` doesn't satisfy PRICE_FILTER / PERCENT_FILTER / LOT_SIZE, amendment will be rejected and the order will stay as it is. * - However the order will be cancelled by the amendment in the following situations: * - when the order is in partially filled status and the new `quantity` * - When the order is `GTX` and the new price will cause it to be executed immediately * - One order can only be modfied for less than 10000 times * * @summary Modify Order (TRADE) * @param {ModifyOrderRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#modify-order Binance API Documentation} */ modifyOrder(requestParameters: ModifyOrderRequest$1): Promise>; /** * Send in a new order. * * Weight: 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M) * 0 on IP rate limit(x-mbx-used-weight-1m) * * Security Type: TRADE * * Notes: * - Additional mandatory parameters based on `type`: * - Order with type `STOP`, parameter `timeInForce` can be sent ( default `GTC`). * - Order with type `TAKE_PROFIT`, parameter `timeInForce` can be sent ( default `GTC`). * - Condition orders will be triggered when: * - If parameter`priceProtect`is sent as true: * - when price reaches the `stopPrice` ，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol * - "triggerProtect" of a symbol can be got from `GET /dapi/v1/exchangeInfo` * - `STOP`, `STOP_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") * -`TAKE_PROFIT`, `TAKE_PROFIT_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - `TRAILING_STOP_MARKET`: * - BUY: the lowest price after order placed ``= the lowest price * (1 + `callbackRate`) * - SELL: the highest price after order placed >= `activationPrice`, and the latest price * * - For `TRAILING_STOP_MARKET`, if you got such error code. > `{"code": -2021, "msg": "Order would immediately trigger."}` > means that the parameters you send do not meet the following requirements: * - BUY: `activationPrice` should be smaller than latest price. * - SELL: `activationPrice` should be larger than latest price. * - If `newOrderRespType ` is sent as `RESULT` : * - `MARKET` order: the final FILLED result of the order will be return directly. * - `LIMIT` order with special `timeInForce`: the final status result of the order(FILLED or EXPIRED) will be returned directly. * - `STOP_MARKET`, `TAKE_PROFIT_MARKET` with `closePosition`=`true`: * - Follow the same rules for condition orders. * - If triggered,**close all** current long position( if `SELL`) or current short position( if `BUY`). * - Cannot be used with `quantity` parameter * - Cannot be used with `reduceOnly` parameter * - In Hedge Mode,cannot be used with `BUY` orders in `LONG` position side. and cannot be used with `SELL` orders in `SHORT` position side * * - `selfTradePreventionMode` is only effective when `timeInForce` set to `IOC` or `GTC`. * * @summary New Order (TRADE) * @param {NewOrderRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#new-order Binance API Documentation} */ newOrder(requestParameters: NewOrderRequest$1): Promise>; /** * Place multiple orders * * Parameter rules are same with `New Order` * Batch orders are processed concurrently, and the order of matching is not guaranteed. * The order of returned contents for batch orders is the same as the order of the order list. * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * - `batchOrders` must be a JSON array of order parameter objects. * - Example: * `/dapi/v1/batchOrders?batchOrders=[{"type":"LIMIT","timeInForce":"GTC","symbol":"BTCUSD_PERP","side":"BUY","price":"10001","quantity":"1"}]` * * @summary Place Multiple Orders (TRADE) * @param {PlaceMultipleOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#place-multiple-orders Binance API Documentation} */ placeMultipleOrders(requestParameters: PlaceMultipleOrdersRequest): Promise>; /** * Query position ADL quantile estimation * * Values update every 30s. * Values 0, 1, 2, 3, 4 shows the queue position and possibility of ADL from low to high. * For positions of the symbol are in One-way Mode or isolated margined in Hedge Mode, "LONG", "SHORT", and "BOTH" will be returned to show the positions' adl quantiles of different position sides. * If the positions of the symbol are crossed margined in Hedge Mode: * "HEDGE" as a sign will be returned instead of "BOTH"; * A same value caculated on unrealized pnls on long and short sides' positions will be shown for "LONG" and "SHORT" when there are positions in both of long and short sides. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Position ADL Quantile Estimation (USER_DATA) * @param {PositionAdlQuantileEstimationRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#position-adl-quantile-estimation Binance API Documentation} */ positionAdlQuantileEstimation(requestParameters?: PositionAdlQuantileEstimationRequest): Promise>; /** * Get current account information. * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - If neither `marginAsset` nor `pair` is sent, positions of all symbols with `TRADING` status will be returned. * - for One-way Mode user, the response will only show the "BOTH" positions * - for Hedge Mode user, the response will show "BOTH", "LONG", and "SHORT" positions. **Note** > Please use with user data stream `ACCOUNT_UPDATE` to meet your timeliness and accuracy needs. * - Please use with user data stream ACCOUNT_UPDATE to meet your timeliness and accuracy needs. * * @summary Position Information (USER_DATA) * @param {PositionInformationRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#position-information Binance API Documentation} */ positionInformation(requestParameters?: PositionInformationRequest$1): Promise>; /** * Query Current Open Order * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either`orderId` or `origClientOrderId` must be sent * - If the queried order has been filled or cancelled, the error message "Order does not exist" will be returned. * * @summary Query Current Open Order (USER_DATA) * @param {QueryCurrentOpenOrderRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#query-current-open-order Binance API Documentation} */ queryCurrentOpenOrder(requestParameters: QueryCurrentOpenOrderRequest): Promise>; /** * Check an order's status. * * These orders will not be found: * order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time * order create time + 90 days < current time * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Query Order (USER_DATA) * @param {QueryOrderRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#query-order Binance API Documentation} */ queryOrder(requestParameters: QueryOrderRequest$1): Promise>; /** * User's Force Orders * * Weight: **20** (after CM migration: **20** with symbol / **50** without symbol) * * Security Type: USER_DATA * * Notes: * - If "autoCloseType" is not sent, orders with both of the types will be returned * - Only support querying data in the past 90 days * * @summary User\'s Force Orders (USER_DATA) * @param {UsersForceOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#users-force-orders Binance API Documentation} */ usersForceOrders(requestParameters?: UsersForceOrdersRequest): Promise>; } declare enum ChangeMarginTypeMarginTypeEnum { ISOLATED = "ISOLATED", CROSSED = "CROSSED", } declare enum ModifyIsolatedPositionMarginPositionSideEnum { BOTH = "BOTH", LONG = "LONG", SHORT = "SHORT", } declare enum ModifyOrderSideEnum$1 { BUY = "BUY", SELL = "SELL", } declare enum ModifyOrderPriceMatchEnum$1 { OPPONENT = "OPPONENT", OPPONENT_5 = "OPPONENT_5", OPPONENT_10 = "OPPONENT_10", OPPONENT_20 = "OPPONENT_20", QUEUE = "QUEUE", QUEUE_5 = "QUEUE_5", QUEUE_10 = "QUEUE_10", QUEUE_20 = "QUEUE_20", } declare enum NewOrderSideEnum$1 { BUY = "BUY", SELL = "SELL", } declare enum NewOrderTypeEnum$1 { LIMIT = "LIMIT", MARKET = "MARKET", STOP = "STOP", STOP_MARKET = "STOP_MARKET", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_MARKET = "TAKE_PROFIT_MARKET", TRAILING_STOP_MARKET = "TRAILING_STOP_MARKET", } declare enum NewOrderPositionSideEnum$1 { BOTH = "BOTH", LONG = "LONG", SHORT = "SHORT", } declare enum NewOrderReduceOnlyEnum$1 { TRUE = "true", FALSE = "false", } declare enum NewOrderTimeInForceEnum$1 { GTC = "GTC", IOC = "IOC", FOK = "FOK", GTX = "GTX", } declare enum NewOrderWorkingTypeEnum$1 { MARK_PRICE = "MARK_PRICE", CONTRACT_PRICE = "CONTRACT_PRICE", } declare enum NewOrderPriceProtectEnum$1 { TRUE = "true", FALSE = "false", } declare enum NewOrderNewOrderRespTypeEnum$1 { ACK = "ACK", RESULT = "RESULT", } declare enum NewOrderPriceMatchEnum$1 { OPPONENT = "OPPONENT", OPPONENT_5 = "OPPONENT_5", OPPONENT_10 = "OPPONENT_10", OPPONENT_20 = "OPPONENT_20", QUEUE = "QUEUE", QUEUE_5 = "QUEUE_5", QUEUE_10 = "QUEUE_10", QUEUE_20 = "QUEUE_20", } declare enum NewOrderSelfTradePreventionModeEnum$1 { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_BOTH = "EXPIRE_BOTH", EXPIRE_MAKER = "EXPIRE_MAKER", } declare enum UsersForceOrdersAutoCloseTypeEnum { LIQUIDATION = "LIQUIDATION", ADL = "ADL", } //#endregion //#region src/rest-api/modules/user-data-streams-api.d.ts /** * UserDataStreamsApi - interface * @interface UserDataStreamsApi */ interface UserDataStreamsApiInterface$1 { /** * Close out a user data stream. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Close User Data Stream (USER_STREAM) * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof UserDataStreamsApiInterface */ closeUserDataStream(): Promise>; /** * Keepalive a user data stream to prevent a time out. User data streams * will close after 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Keepalive User Data Stream (USER_STREAM) * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof UserDataStreamsApiInterface */ keepaliveUserDataStream(): Promise>; /** * Start a new user data stream. The stream will close after 60 minutes * unless a keepalive is sent. If the account has an active `listenKey`, * that `listenKey` will be returned and its validity will be extended for * 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Start User Data Stream (USER_STREAM) * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof UserDataStreamsApiInterface */ startUserDataStream(): Promise>; } /** * UserDataStreamsApi - object-oriented interface * @class UserDataStreamsApi */ declare class UserDataStreamsApi$1 implements UserDataStreamsApiInterface$1 { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Close out a user data stream. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Close User Data Stream (USER_STREAM) * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof UserDataStreamsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/user-data-streams#close-user-data-stream Binance API Documentation} */ closeUserDataStream(): Promise>; /** * Keepalive a user data stream to prevent a time out. User data streams * will close after 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Keepalive User Data Stream (USER_STREAM) * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof UserDataStreamsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/user-data-streams#keepalive-user-data-stream Binance API Documentation} */ keepaliveUserDataStream(): Promise>; /** * Start a new user data stream. The stream will close after 60 minutes * unless a keepalive is sent. If the account has an active `listenKey`, * that `listenKey` will be returned and its validity will be extended for * 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Start User Data Stream (USER_STREAM) * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof UserDataStreamsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/user-data-streams#start-user-data-stream Binance API Documentation} */ startUserDataStream(): Promise>; } //#endregion //#region src/rest-api/rest-api.d.ts declare class RestAPI { private configuration; private accountApi; private marketDataApi; private tradeApi; private userDataStreamsApi; constructor(configuration: ConfigurationRestAPI); /** * Generic function to send a request. * @param endpoint - The API endpoint to call. * @param method - HTTP method to use (GET, POST, DELETE, etc.). * @param queryParams - Query parameters for the request. * @param bodyParams - Body parameters for the request. * * @returns A promise resolving to the response data object. */ sendRequest(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', queryParams?: Record, bodyParams?: Record): Promise>; /** * Generic function to send a signed request. * @param endpoint - The API endpoint to call. * @param method - HTTP method to use (GET, POST, DELETE, etc.). * @param queryParams - Query parameters for the request. * @param bodyParams - Body parameters for the request. * * @returns A promise resolving to the response data object. */ sendSignedRequest(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', queryParams?: Record, bodyParams?: Record): Promise>; /** * Get current account information. * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - for One-way Mode user, the "positions" will only show the "BOTH" positions * - for Hedge Mode user, the "positions" will show "BOTH", "LONG", and "SHORT" positions. * * @summary Account Information (USER_DATA) * @param {AccountInformationRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#account-information Binance API Documentation} */ accountInformation(requestParameters?: AccountInformationRequest$1): Promise>; /** * Check futures account balance * * Weight(IP): 1 * * Security Type: USER_DATA * * @summary Futures Account Balance (USER_DATA) * @param {FuturesAccountBalanceRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#futures-account-balance Binance API Documentation} */ futuresAccountBalance(requestParameters?: FuturesAccountBalanceRequest$1): Promise>; /** * Get user's position mode (Hedge Mode or One-way Mode ) on ***EVERY symbol*** * * Weight(IP): 30 * * Security Type: USER_DATA * * @summary Get Current Position Mode (USER_DATA) * @param {GetCurrentPositionModeRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-current-position-mode Binance API Documentation} */ getCurrentPositionMode(requestParameters?: GetCurrentPositionModeRequest): Promise>; /** * Get Download Id For Futures Order History * * Weight(IP): 1000 * * Security Type: USER_DATA * * Notes: * - Request Limitation is 8 times per month, shared by front end download page and rest api * - This endpoint uses the IP rate limit bucket and costs 1000 weight per call. The maximum is 2 calls per minute; the 3rd call within the same minute will trigger a ban. * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Download Id For Futures Order History (USER_DATA) * @param {GetDownloadIdForFuturesOrderHistoryRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-download-id-for-futures-order-history Binance API Documentation} */ getDownloadIdForFuturesOrderHistory(requestParameters: GetDownloadIdForFuturesOrderHistoryRequest): Promise>; /** * Get download id for futures trade history * * Weight(IP): 1000 * * Security Type: USER_DATA * * Notes: * - Request Limitation is 8 times per month, shared by front end download page and rest api * - This endpoint uses the IP rate limit bucket and costs 1000 weight per call. The maximum is 2 calls per minute; the 3rd call within the same minute will trigger a ban. * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Download Id For Futures Trade History (USER_DATA) * @param {GetDownloadIdForFuturesTradeHistoryRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-download-id-for-futures-trade-history Binance API Documentation} */ getDownloadIdForFuturesTradeHistory(requestParameters: GetDownloadIdForFuturesTradeHistoryRequest): Promise>; /** * Get download id for futures transaction history * * Weight(IP): 1000 * * Security Type: USER_DATA * * Notes: * - Request Limitation is 8 times per month, shared by front end download page and rest api * - This endpoint uses the IP rate limit bucket and costs 1000 weight per call. The maximum is 2 calls per minute; the 3rd call within the same minute will trigger a ban. * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Download Id For Futures Transaction History (USER_DATA) * @param {GetDownloadIdForFuturesTransactionHistoryRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-download-id-for-futures-transaction-history Binance API Documentation} */ getDownloadIdForFuturesTransactionHistory(requestParameters: GetDownloadIdForFuturesTransactionHistoryRequest): Promise>; /** * Get futures order history download link by Id * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Download link expiration: 7 days * * @summary Get Futures Order History Download Link by Id (USER_DATA) * @param {GetFuturesOrderHistoryDownloadLinkByIdRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-futures-order-history-download-link-by-id Binance API Documentation} */ getFuturesOrderHistoryDownloadLinkById(requestParameters: GetFuturesOrderHistoryDownloadLinkByIdRequest): Promise>; /** * Get futures trade download link by Id * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Download link expiration: 7 days * * @summary Get Futures Trade Download Link by Id (USER_DATA) * @param {GetFuturesTradeDownloadLinkByIdRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-futures-trade-download-link-by-id Binance API Documentation} */ getFuturesTradeDownloadLinkById(requestParameters: GetFuturesTradeDownloadLinkByIdRequest): Promise>; /** * Get futures transaction history download link by Id * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Download link expiration: 7 days * * @summary Get Futures Transaction History Download Link by Id (USER_DATA) * @param {GetFuturesTransactionHistoryDownloadLinkByIdRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-futures-transaction-history-download-link-by-id Binance API Documentation} */ getFuturesTransactionHistoryDownloadLinkById(requestParameters: GetFuturesTransactionHistoryDownloadLinkByIdRequest): Promise>; /** * Get income history * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: * - If `incomeType ` is not sent, all kinds of flow will be returned * - "trandId" is unique in the same "incomeType" for a user * - The time between `startTime` and `endTime` can not be longer than 1 year * * @summary Get Income History (USER_DATA) * @param {GetIncomeHistoryRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#get-income-history Binance API Documentation} */ getIncomeHistory(requestParameters?: GetIncomeHistoryRequest): Promise>; /** * **Not recommended to continue using this v1 endpoint** * * Get the pair's default notional bracket list, may return ambiguous * values when there have been multiple different `symbol` brackets under * the `pair`, suggest using the following `GET /dapi/v2/leverageBracket` * query instead to get the specific `symbol` notional bracket list. * * Weight(IP): 1 * * Security Type: USER_DATA * * @summary Notional Bracket for Pair (USER_DATA) * @param {NotionalBracketForPairRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#notional-bracket-for-pair Binance API Documentation} */ notionalBracketForPair(requestParameters?: NotionalBracketForPairRequest): Promise>; /** * Get the symbol's notional bracket list. * * Weight: 1 (after CM migration: 1 with `symbol` / 2 without `symbol`) * * Security Type: USER_DATA * * @summary Notional Bracket for Symbol (USER_DATA) * @param {NotionalBracketForSymbolRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#notional-bracket-for-symbol Binance API Documentation} */ notionalBracketForSymbol(requestParameters?: NotionalBracketForSymbolRequest): Promise>; /** * Query user commission rate * * Weight(IP): 20 * * Security Type: USER_DATA * * @summary User Commission Rate (USER_DATA) * @param {UserCommissionRateRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/account#user-commission-rate Binance API Documentation} */ userCommissionRate(requestParameters: UserCommissionRateRequest): Promise>; /** * Query basis * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Basis * @param {BasisRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#basis Binance API Documentation} */ basis(requestParameters: BasisRequest): Promise>; /** * Test connectivity to the Rest API and get the current server time. * * Weight(IP): 1 * * @summary Check Server time * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#check-server-time Binance API Documentation} */ checkServerTime(): Promise>; /** * Get compressed, aggregate trades. Market trades that fill in 100ms with * the same price and the same taking side will have the quantity * aggregated. * * Weight(IP): 20 * * Notes: * - support querying futures trade histories that are not older than 24 hours * - If both `startTime` and `endTime` are sent, time between `startTime` and `endTime` must be less than 1 hour. * - If `fromId`, `startTime`, and `endTime` are not sent, the most recent aggregate trades will be returned. * - Only market trades will be aggregated and returned, which means the insurance fund trades and ADL trades won't be aggregated. * - Sending both `startTime`/`endTime` and `fromId` might cause response timeout, please send either `fromId` or `startTime`/`endTime` * * @summary Compressed/Aggregate Trades List * @param {CompressedAggregateTradesListRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#compressed-aggregate-trades-list Binance API Documentation} */ compressedAggregateTradesList(requestParameters: CompressedAggregateTradesListRequest): Promise>; /** * Kline/candlestick bars for a specific contract type. Klines are uniquely identified by their open time. * * Weight: based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Continuous Contract Kline/Candlestick Data * @param {ContinuousContractKlineCandlestickDataRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#continuous-contract-kline-candlestick-data Binance API Documentation} */ continuousContractKlineCandlestickData(requestParameters: ContinuousContractKlineCandlestickDataRequest): Promise>; /** * Current exchange trading rules and symbol information * * Weight(IP): 1 * * @summary Exchange Information * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#exchange-information Binance API Documentation} */ exchangeInformation(): Promise>; /** * Get Funding Rate History of Perpetual Futures * * Weight(IP): 1 * * Notes: * - empty array will be returned for delivery symbols. * * @summary Get Funding Rate History of Perpetual Futures * @param {GetFundingRateHistoryOfPerpetualFuturesRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#get-funding-rate-history-of-perpetual-futures Binance API Documentation} */ getFundingRateHistoryOfPerpetualFutures(requestParameters: GetFundingRateHistoryOfPerpetualFuturesRequest): Promise>; /** * Query funding rate info for symbols that had FundingRateCap/FundingRateFloor/fundingIntervalHours adjustment * * @summary Get Funding Rate Info * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#get-funding-rate-info Binance API Documentation} */ getFundingRateInfo(): Promise>; /** * Query index price and mark price * * Weight(IP): 10 * * @summary Index Price and Mark Price * @param {IndexPriceAndMarkPriceRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#index-price-and-mark-price Binance API Documentation} */ indexPriceAndMarkPrice(requestParameters?: IndexPriceAndMarkPriceRequest): Promise>; /** * Kline/candlestick bars for the index price of a pair. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Index Price Kline/Candlestick Data * @param {IndexPriceKlineCandlestickDataRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#index-price-kline-candlestick-data Binance API Documentation} */ indexPriceKlineCandlestickData(requestParameters: IndexPriceKlineCandlestickDataRequest): Promise>; /** * Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Kline/Candlestick Data * @param {KlineCandlestickDataRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#kline-candlestick-data Binance API Documentation} */ klineCandlestickData(requestParameters: KlineCandlestickDataRequest): Promise>; /** * Query symbol Long/Short Ratio * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Long/Short Ratio * @param {LongShortRatioRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#long-short-ratio Binance API Documentation} */ longShortRatio(requestParameters: LongShortRatioRequest): Promise>; /** * Kline/candlestick bars for the mark price of a symbol. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | --- | --- | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - The difference between `startTime` and `endTime` can only be up to 200 days * - Between `startTime` and `endTime`, the most recent `limit` data from `endTime` will be returned: * - If `startTime` and `endTime` are not sent, current timestamp will be set as `endTime`, and the most recent data will be returned. * - If `startTime` is sent only, the timestamp of 200 days after `startTime` will be set as `endTime`(up to the current time) * - If `endTime` is sent only, the timestamp of 200 days before `endTime` will be set as `startTime` * * @summary Mark Price Kline/Candlestick Data * @param {MarkPriceKlineCandlestickDataRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#mark-price-kline-candlestick-data Binance API Documentation} */ markPriceKlineCandlestickData(requestParameters: MarkPriceKlineCandlestickDataRequest): Promise>; /** * Get older market historical trades. * * Weight(IP): 20 * * Security Type: MARKET_DATA * * Notes: * - Market trades means trades filled in the order book. Only market trades will be returned, which means the insurance fund trades and ADL trades won't be returned. * - Only supports data from within the last one month * * @summary Old Trades Lookup (MARKET_DATA) * @param {OldTradesLookupRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#old-trades-lookup Binance API Documentation} */ oldTradesLookup(requestParameters: OldTradesLookupRequest): Promise>; /** * Get present open interest of a specific symbol. * * Weight(IP): 1 * * @summary Open Interest * @param {OpenInterestRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#open-interest Binance API Documentation} */ openInterest(requestParameters: OpenInterestRequest): Promise>; /** * Query open interest stats * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Open Interest Statistics * @param {OpenInterestStatisticsRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#open-interest-statistics Binance API Documentation} */ openInterestStatistics(requestParameters: OpenInterestStatisticsRequest): Promise>; /** * Query orderbook on specific symbol * * Weight: Adjusted based on the limit: * * | Limit | Weight | * | ------------ | ------------ | * | 5, 10, 20, 50 | 2 | * | 100 | 5 | * | 500 | 10 | * | 1000 | 20 | * * @summary Order Book * @param {OrderBookRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#order-book Binance API Documentation} */ orderBook(requestParameters: OrderBookRequest): Promise>; /** * Premium index kline bars of a symbol. Klines are uniquely identified by their open time. * * Weight: Based on parameter `LIMIT` * * | LIMIT | weight | * | ----------- | ------ | * | [1,100) | 1 | * | [100, 500) | 2 | * | [500, 1000] | 5 | * | > 1000 | 10 | * * Notes: * - If startTime and endTime are not sent, the most recent klines are returned. * * @summary Premium index Kline Data * @param {PremiumIndexKlineDataRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#premium-index-kline-data Binance API Documentation} */ premiumIndexKlineData(requestParameters: PremiumIndexKlineDataRequest): Promise>; /** * Query index price constituents * * Weight(IP): 1 * * @summary Query Index Price Constituents * @param {QueryIndexPriceConstituentsRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#query-index-price-constituents Binance API Documentation} */ queryIndexPriceConstituents(requestParameters: QueryIndexPriceConstituentsRequest): Promise>; /** * Get recent market trades * * Weight(IP): 5 * * Notes: * - Market trades means trades filled in the order book. Only market trades will be returned, which means the insurance fund trades and ADL trades won't be returned. * * @summary Recent Trades List * @param {RecentTradesListRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#recent-trades-list Binance API Documentation} */ recentTradesList(requestParameters: RecentTradesListRequest): Promise>; /** * Best price/qty on the order book for a symbol or symbols. * * Weight: **2** for a single symbol, **5** when the symbol parameter is omitted * * Notes: * - Symbol and pair cannot be sent together * - If a pair is sent,tickers for all symbols of the pair will be returned * - If either a pair or symbol is sent, tickers for all symbols of all pairs will be returned * * @summary Symbol Order Book Ticker * @param {SymbolOrderBookTickerRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#symbol-order-book-ticker Binance API Documentation} */ symbolOrderBookTicker(requestParameters?: SymbolOrderBookTickerRequest): Promise>; /** * Latest price for a symbol or symbols. * * Weight: **1** for a single symbol, **2** when the symbol parameter is omitted * * Notes: * - Symbol and pair cannot be sent together * - If a pair is sent,tickers for all symbols of the pair will be returned * - If either a pair or symbol is sent, tickers for all symbols of all pairs will be returned * * @summary Symbol Price Ticker * @param {SymbolPriceTickerRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#symbol-price-ticker Binance API Documentation} */ symbolPriceTicker(requestParameters?: SymbolPriceTickerRequest): Promise>; /** * Taker Buy Volume: the total volume of buy orders filled by takers within * the period. * * Taker Sell Volume: the total volume of sell orders filled by takers * within the period. * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Taker Buy/Sell Volume * @param {TakerBuySellVolumeRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#taker-buy-sell-volume Binance API Documentation} */ takerBuySellVolume(requestParameters: TakerBuySellVolumeRequest): Promise>; /** * Test connectivity to the Rest API. * * Weight(IP): 1 * * @summary Test Connectivity * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#test-connectivity Binance API Documentation} */ testConnectivity(): Promise>; /** * 24 hour rolling window price change statistics. * * Weight: **1** for a single symbol, **40** when the symbol parameter is omitted **Careful** when accessing this with no symbol. * * Notes: * - Symbol and pair cannot be sent together * - If a pair is sent,tickers for all symbols of the pair will be returned * - If either a pair or symbol is sent, tickers for all symbols of all pairs will be returned * * @summary 24hr Ticker Price Change Statistics * @param {Ticker24hrPriceChangeStatisticsRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#ticker24hr-price-change-statistics Binance API Documentation} */ ticker24hrPriceChangeStatistics(requestParameters?: Ticker24hrPriceChangeStatisticsRequest): Promise>; /** * The proportion of net long and net short accounts to total accounts of * the top 20% users with the highest margin balance. Each account is * counted once only. * * Long Account % = Accounts of top traders with net long positions / Total * accounts of top traders with open positions * * Short Account % = Accounts of top traders with net short positions / * Total accounts of top traders with open positions * * Long/Short Ratio (Accounts) = Long Account % / Short Account % * * Weight(IP): 1 * * Security Type: Accounts * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Top Trader Long/Short Account Ratio * @param {TopTraderLongShortRatioAccountsRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#top-trader-long-short-ratio-accounts Binance API Documentation} */ topTraderLongShortRatioAccounts(requestParameters: TopTraderLongShortRatioAccountsRequest): Promise>; /** * The proportion of net long and net short positions to total open * positions of the top 20% users with the highest margin balance. * * Long Position % = Long positions of top traders / Total open positions * of top traders * * Short Position % = Short positions of top traders / Total open positions * of top traders * * Long/Short Ratio (Positions) = Long Position % / Short Position % * * Weight(IP): 1 * * Security Type: Positions * * Notes: * - If startTime and endTime are not sent, the most recent data is returned. * - Only the data of the latest 30 days is available. * * @summary Top Trader Long/Short Position Ratio * @param {TopTraderLongShortRatioPositionsRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/market-data#top-trader-long-short-ratio-positions Binance API Documentation} */ topTraderLongShortRatioPositions(requestParameters: TopTraderLongShortRatioPositionsRequest): Promise>; /** * Get trades for a specific account and symbol. * * Weight: **20** with symbol，**40** with pair (after CM migration: **5** flat) * * Security Type: USER_DATA * * Notes: * - Either symbol or pair must be sent * - Symbol and pair cannot be sent together * - Pair and fromId cannot be sent together * - OrderId can only be sent together with symbol * - If a pair is sent,tickers for all symbols of the pair will be returned * - The parameter `fromId` cannot be sent with `startTime` or `endTime` * - If startTime and endTime are both not sent, then the last 7 days' data will be returned. * - The time between startTime and endTime cannot be longer than 7 days. * * @summary Account Trade List (USER_DATA) * @param {AccountTradeListRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#account-trade-list Binance API Documentation} */ accountTradeList(requestParameters?: AccountTradeListRequest): Promise>; /** * Get all account orders; active, canceled, or filled. * * These orders will not be found: * order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time * order create time + 90 days < current time * * Weight: **20** with symbol, **40** with pair (after CM migration: **5** flat) * * Security Type: USER_DATA * * Notes: * - Either `symbol` or `pair` must be sent. * - `pair` can't be sent with `orderId` * - If `orderId` is set, it will get orders >= that `orderId`. Otherwise most recent orders are returned. * - If orderId is set, it will get orders >= that orderId. Otherwise most recent orders are returned. * - The query time period must be less then 7 days( default as the recent 7 days). * * @summary All Orders (USER_DATA) * @param {AllOrdersRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#all-orders Binance API Documentation} */ allOrders(requestParameters?: AllOrdersRequest): Promise>; /** * Cancel all open orders of the specified symbol at the end of the * specified countdown. This rest endpoint means to ensure your open orders * are canceled in case of an outage. The endpoint should be called * repeatedly as heartbeats so that the existing countdown time can be * canceled and repalced by a new one. The system will check all countdowns **approximately every 10 milliseconds**, so please note that sufficient * redundancy should be considered when using this function. We do not * recommend setting the countdown time to be too precise or too small. * * * Example usage: * * Call this endpoint at 30s intervals with an countdownTime of 120000 * (120s). * * If this endpoint is not called within 120 seconds, all your orders of * the specified symbol will be automatically canceled. * * If this endpoint is called with an countdownTime of 0, the countdown * timer will be stopped. * * Weight(IP): 10 * * Security Type: TRADE * * @summary Auto-Cancel All Open Orders (TRADE) * @param {AutoCancelAllOpenOrdersRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#auto-cancel-all-open-orders Binance API Documentation} */ autoCancelAllOpenOrders(requestParameters: AutoCancelAllOpenOrdersRequest): Promise>; /** * Cancel All Open Orders * * Weight(IP): 1 * * Security Type: TRADE * * @summary Cancel All Open Orders (TRADE) * @param {CancelAllOpenOrdersRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#cancel-all-open-orders Binance API Documentation} */ cancelAllOpenOrders(requestParameters: CancelAllOpenOrdersRequest): Promise>; /** * Cancel Multiple Orders * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderIdList` or `origClientOrderIdList ` must be sent. * * @summary Cancel Multiple Orders (TRADE) * @param {CancelMultipleOrdersRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#cancel-multiple-orders Binance API Documentation} */ cancelMultipleOrders(requestParameters: CancelMultipleOrdersRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Cancel Order (TRADE) * @param {CancelOrderRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#cancel-order Binance API Documentation} */ cancelOrder(requestParameters: CancelOrderRequest$1): Promise>; /** * Change user's initial leverage in the specific symbol market. * * For Hedge Mode, LONG and SHORT positions of one symbol use the same * initial leverage and share a total notional value. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Change Initial Leverage (TRADE) * @param {ChangeInitialLeverageRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#change-initial-leverage Binance API Documentation} */ changeInitialLeverage(requestParameters: ChangeInitialLeverageRequest): Promise>; /** * Change user's margin type in the specific symbol market.For Hedge Mode, * LONG and SHORT positions of one symbol use the same margin type. * * With ISOLATED margin type, margins of the LONG and SHORT positions are * isolated from each other. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Change Margin Type (TRADE) * @param {ChangeMarginTypeRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#change-margin-type Binance API Documentation} */ changeMarginType(requestParameters: ChangeMarginTypeRequest): Promise>; /** * Change user's position mode (Hedge Mode or One-way Mode ) on ***EVERY symbol***. * **After CM migration**, UM and CM share the **same** `dualSidePosition` setting. Calling this endpoint flips both UM and CM at once. If either side has any open order or open position, the change is rejected: * - `-4067` (open orders exist) * - `-4068` (open position exists) * * Weight(IP): 1 * * Security Type: TRADE * * @summary Change Position Mode (TRADE) * @param {ChangePositionModeRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#change-position-mode Binance API Documentation} */ changePositionMode(requestParameters: ChangePositionModeRequest): Promise>; /** * Get all open orders on a symbol. **Careful** when accessing this with no symbol. * * Weight(IP): null * * Weight: **1** for a single symbol, **40** for mutltiple symbols * * Security Type: USER_DATA * * @summary Current All Open Orders (USER_DATA) * @param {CurrentAllOpenOrdersRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#current-all-open-orders Binance API Documentation} */ currentAllOpenOrders(requestParameters?: CurrentAllOpenOrdersRequest): Promise>; /** * Get order modification history * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either `orderId` or `origClientOrderId` must be sent, and the `orderId` will prevail if both are sent. * - Order modify history longer than 3 month is not avaliable * * @summary Get Order Modify History (USER_DATA) * @param {GetOrderModifyHistoryRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#get-order-modify-history Binance API Documentation} */ getOrderModifyHistory(requestParameters: GetOrderModifyHistoryRequest): Promise>; /** * Get position margin change history * * Weight(IP): 1 * * Security Type: TRADE * * @summary Get Position Margin Change History (TRADE) * @param {GetPositionMarginChangeHistoryRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#get-position-margin-change-history Binance API Documentation} */ getPositionMarginChangeHistory(requestParameters: GetPositionMarginChangeHistoryRequest): Promise>; /** * Modify Isolated Position Margin * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Only for isolated symbol * * @summary Modify Isolated Position Margin (TRADE) * @param {ModifyIsolatedPositionMarginRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#modify-isolated-position-margin Binance API Documentation} */ modifyIsolatedPositionMargin(requestParameters: ModifyIsolatedPositionMarginRequest): Promise>; /** * Modify Multiple Orders * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * - Parameter rules are same with `Modify Order` * - Batch modify orders are processed concurrently, and the order of matching is not guaranteed. * - The order of returned contents for batch modify orders is the same as the order of the order list. * - One order can only be modfied for less than 10000 times * - `modifyId` is an optional user-defined identifier passed through as-is; the server does not validate its uniqueness. If omitted, it is not included in the response. * * @summary Modify Multiple Orders (TRADE) * @param {ModifyMultipleOrdersRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#modify-multiple-orders Binance API Documentation} */ modifyMultipleOrders(requestParameters: ModifyMultipleOrdersRequest): Promise>; /** * Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent, and the `orderId` will prevail if both are sent. * - Either `quantity` or `price` must be sent. *(After CM migration, both `quantity` and `price` are required.)* * - When the new `quantity` or `price` doesn't satisfy PRICE_FILTER / PERCENT_FILTER / LOT_SIZE, amendment will be rejected and the order will stay as it is. * - However the order will be cancelled by the amendment in the following situations: * - when the order is in partially filled status and the new `quantity` * - When the order is `GTX` and the new price will cause it to be executed immediately * - One order can only be modfied for less than 10000 times * * @summary Modify Order (TRADE) * @param {ModifyOrderRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#modify-order Binance API Documentation} */ modifyOrder(requestParameters: ModifyOrderRequest$1): Promise>; /** * Send in a new order. * * Weight: 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M) * 0 on IP rate limit(x-mbx-used-weight-1m) * * Security Type: TRADE * * Notes: * - Additional mandatory parameters based on `type`: * - Order with type `STOP`, parameter `timeInForce` can be sent ( default `GTC`). * - Order with type `TAKE_PROFIT`, parameter `timeInForce` can be sent ( default `GTC`). * - Condition orders will be triggered when: * - If parameter`priceProtect`is sent as true: * - when price reaches the `stopPrice` ，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol * - "triggerProtect" of a symbol can be got from `GET /dapi/v1/exchangeInfo` * - `STOP`, `STOP_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") * -`TAKE_PROFIT`, `TAKE_PROFIT_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - `TRAILING_STOP_MARKET`: * - BUY: the lowest price after order placed ``= the lowest price * (1 + `callbackRate`) * - SELL: the highest price after order placed >= `activationPrice`, and the latest price * * - For `TRAILING_STOP_MARKET`, if you got such error code. > `{"code": -2021, "msg": "Order would immediately trigger."}` > means that the parameters you send do not meet the following requirements: * - BUY: `activationPrice` should be smaller than latest price. * - SELL: `activationPrice` should be larger than latest price. * - If `newOrderRespType ` is sent as `RESULT` : * - `MARKET` order: the final FILLED result of the order will be return directly. * - `LIMIT` order with special `timeInForce`: the final status result of the order(FILLED or EXPIRED) will be returned directly. * - `STOP_MARKET`, `TAKE_PROFIT_MARKET` with `closePosition`=`true`: * - Follow the same rules for condition orders. * - If triggered,**close all** current long position( if `SELL`) or current short position( if `BUY`). * - Cannot be used with `quantity` parameter * - Cannot be used with `reduceOnly` parameter * - In Hedge Mode,cannot be used with `BUY` orders in `LONG` position side. and cannot be used with `SELL` orders in `SHORT` position side * * - `selfTradePreventionMode` is only effective when `timeInForce` set to `IOC` or `GTC`. * * @summary New Order (TRADE) * @param {NewOrderRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#new-order Binance API Documentation} */ newOrder(requestParameters: NewOrderRequest$1): Promise>; /** * Place multiple orders * * Parameter rules are same with `New Order` * Batch orders are processed concurrently, and the order of matching is not guaranteed. * The order of returned contents for batch orders is the same as the order of the order list. * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * - `batchOrders` must be a JSON array of order parameter objects. * - Example: * `/dapi/v1/batchOrders?batchOrders=[{"type":"LIMIT","timeInForce":"GTC","symbol":"BTCUSD_PERP","side":"BUY","price":"10001","quantity":"1"}]` * * @summary Place Multiple Orders (TRADE) * @param {PlaceMultipleOrdersRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#place-multiple-orders Binance API Documentation} */ placeMultipleOrders(requestParameters: PlaceMultipleOrdersRequest): Promise>; /** * Query position ADL quantile estimation * * Values update every 30s. * Values 0, 1, 2, 3, 4 shows the queue position and possibility of ADL from low to high. * For positions of the symbol are in One-way Mode or isolated margined in Hedge Mode, "LONG", "SHORT", and "BOTH" will be returned to show the positions' adl quantiles of different position sides. * If the positions of the symbol are crossed margined in Hedge Mode: * "HEDGE" as a sign will be returned instead of "BOTH"; * A same value caculated on unrealized pnls on long and short sides' positions will be shown for "LONG" and "SHORT" when there are positions in both of long and short sides. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Position ADL Quantile Estimation (USER_DATA) * @param {PositionAdlQuantileEstimationRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#position-adl-quantile-estimation Binance API Documentation} */ positionAdlQuantileEstimation(requestParameters?: PositionAdlQuantileEstimationRequest): Promise>; /** * Get current account information. * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - If neither `marginAsset` nor `pair` is sent, positions of all symbols with `TRADING` status will be returned. * - for One-way Mode user, the response will only show the "BOTH" positions * - for Hedge Mode user, the response will show "BOTH", "LONG", and "SHORT" positions. **Note** > Please use with user data stream `ACCOUNT_UPDATE` to meet your timeliness and accuracy needs. * - Please use with user data stream ACCOUNT_UPDATE to meet your timeliness and accuracy needs. * * @summary Position Information (USER_DATA) * @param {PositionInformationRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#position-information Binance API Documentation} */ positionInformation(requestParameters?: PositionInformationRequest$1): Promise>; /** * Query Current Open Order * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either`orderId` or `origClientOrderId` must be sent * - If the queried order has been filled or cancelled, the error message "Order does not exist" will be returned. * * @summary Query Current Open Order (USER_DATA) * @param {QueryCurrentOpenOrderRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#query-current-open-order Binance API Documentation} */ queryCurrentOpenOrder(requestParameters: QueryCurrentOpenOrderRequest): Promise>; /** * Check an order's status. * * These orders will not be found: * order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time * order create time + 90 days < current time * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Query Order (USER_DATA) * @param {QueryOrderRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#query-order Binance API Documentation} */ queryOrder(requestParameters: QueryOrderRequest$1): Promise>; /** * User's Force Orders * * Weight: **20** (after CM migration: **20** with symbol / **50** without symbol) * * Security Type: USER_DATA * * Notes: * - If "autoCloseType" is not sent, orders with both of the types will be returned * - Only support querying data in the past 90 days * * @summary User\'s Force Orders (USER_DATA) * @param {UsersForceOrdersRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/trade#users-force-orders Binance API Documentation} */ usersForceOrders(requestParameters?: UsersForceOrdersRequest): Promise>; /** * Close out a user data stream. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Close User Data Stream (USER_STREAM) * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/user-data-streams#close-user-data-stream Binance API Documentation} */ closeUserDataStream(): Promise>; /** * Keepalive a user data stream to prevent a time out. User data streams * will close after 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Keepalive User Data Stream (USER_STREAM) * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/user-data-streams#keepalive-user-data-stream Binance API Documentation} */ keepaliveUserDataStream(): Promise>; /** * Start a new user data stream. The stream will close after 60 minutes * unless a keepalive is sent. If the account has an active `listenKey`, * that `listenKey` will be returned and its validity will be extended for * 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Start User Data Stream (USER_STREAM) * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/rest-api/user-data-streams#start-user-data-stream Binance API Documentation} */ startUserDataStream(): Promise>; } declare namespace index_d_exports { export { AccountApi$1 as AccountApi, AccountApiInterface$1 as AccountApiInterface, AccountInformationRequest$1 as AccountInformationRequest, AccountInformationResponse$1 as AccountInformationResponse, AccountInformationResponseAssetsInner, AccountInformationResponsePositionsInner, AccountTradeListRequest, AccountTradeListResponse, AccountTradeListResponseInner, AllOrdersRequest, AllOrdersResponse, AllOrdersResponseInner, AutoCancelAllOpenOrdersRequest, AutoCancelAllOpenOrdersResponse, BasisContractTypeEnum, BasisPeriodEnum, BasisRequest, BasisResponse, BasisResponseInner, CancelAllOpenOrdersRequest, CancelAllOpenOrdersResponse, CancelMultipleOrdersRequest, CancelMultipleOrdersResponse, CancelMultipleOrdersResponseInner, CancelOrderRequest$1 as CancelOrderRequest, CancelOrderResponse$1 as CancelOrderResponse, ChangeInitialLeverageRequest, ChangeInitialLeverageResponse, ChangeMarginTypeMarginTypeEnum, ChangeMarginTypeRequest, ChangeMarginTypeResponse, ChangePositionModeRequest, ChangePositionModeResponse, CheckServerTimeResponse, CompressedAggregateTradesListRequest, CompressedAggregateTradesListResponse, CompressedAggregateTradesListResponseInner, ContinuousContractKlineCandlestickDataContractTypeEnum, ContinuousContractKlineCandlestickDataIntervalEnum, ContinuousContractKlineCandlestickDataItem, ContinuousContractKlineCandlestickDataItemInner, ContinuousContractKlineCandlestickDataRequest, ContinuousContractKlineCandlestickDataResponse, CurrentAllOpenOrdersRequest, CurrentAllOpenOrdersResponse, ExchangeInformationResponse, ExchangeInformationResponseRateLimitsInner, ExchangeInformationResponseSymbolsInner, ExchangeInformationResponseSymbolsInnerFiltersInner, FuturesAccountBalanceRequest$1 as FuturesAccountBalanceRequest, FuturesAccountBalanceResponse$1 as FuturesAccountBalanceResponse, FuturesAccountBalanceResponseInner, GetCurrentPositionModeRequest, GetCurrentPositionModeResponse, GetDownloadIdForFuturesOrderHistoryRequest, GetDownloadIdForFuturesOrderHistoryResponse, GetDownloadIdForFuturesTradeHistoryRequest, GetDownloadIdForFuturesTradeHistoryResponse, GetDownloadIdForFuturesTransactionHistoryRequest, GetDownloadIdForFuturesTransactionHistoryResponse, GetFundingRateHistoryOfPerpetualFuturesRequest, GetFundingRateHistoryOfPerpetualFuturesResponse, GetFundingRateHistoryOfPerpetualFuturesResponseInner, GetFundingRateInfoResponse, GetFundingRateInfoResponseInner, GetFuturesOrderHistoryDownloadLinkByIdRequest, GetFuturesOrderHistoryDownloadLinkByIdResponse, GetFuturesTradeDownloadLinkByIdRequest, GetFuturesTradeDownloadLinkByIdResponse, GetFuturesTransactionHistoryDownloadLinkByIdRequest, GetFuturesTransactionHistoryDownloadLinkByIdResponse, GetIncomeHistoryIncomeTypeEnum, GetIncomeHistoryRequest, GetIncomeHistoryResponse, GetIncomeHistoryResponseInner, GetOrderModifyHistoryRequest, GetOrderModifyHistoryResponse, GetOrderModifyHistoryResponseInner, GetOrderModifyHistoryResponseInnerAmendment, GetOrderModifyHistoryResponseInnerAmendmentOrigQty, GetOrderModifyHistoryResponseInnerAmendmentPrice, GetPositionMarginChangeHistoryRequest, GetPositionMarginChangeHistoryResponse, GetPositionMarginChangeHistoryResponseInner, IndexPriceAndMarkPriceRequest, IndexPriceAndMarkPriceResponse, IndexPriceAndMarkPriceResponseInner, IndexPriceKlineCandlestickDataIntervalEnum, IndexPriceKlineCandlestickDataItem, IndexPriceKlineCandlestickDataItemInner, IndexPriceKlineCandlestickDataRequest, IndexPriceKlineCandlestickDataResponse, KeepaliveUserDataStreamResponse$1 as KeepaliveUserDataStreamResponse, KlineCandlestickDataIntervalEnum, KlineCandlestickDataItem, KlineCandlestickDataRequest, KlineCandlestickDataResponse, LongShortRatioPeriodEnum, LongShortRatioRequest, LongShortRatioResponse, LongShortRatioResponseInner, MarkPriceKlineCandlestickDataIntervalEnum, MarkPriceKlineCandlestickDataItem, MarkPriceKlineCandlestickDataRequest, MarkPriceKlineCandlestickDataResponse, MarketDataApi, MarketDataApiInterface, ModifyIsolatedPositionMarginPositionSideEnum, ModifyIsolatedPositionMarginRequest, ModifyIsolatedPositionMarginResponse, ModifyMultipleOrdersBatchOrdersParameterInner, ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum, ModifyMultipleOrdersRequest, ModifyMultipleOrdersResponse, ModifyMultipleOrdersResponseInner, ModifyOrderPriceMatchEnum$1 as ModifyOrderPriceMatchEnum, ModifyOrderRequest$1 as ModifyOrderRequest, ModifyOrderResponse$1 as ModifyOrderResponse, ModifyOrderSideEnum$1 as ModifyOrderSideEnum, NewOrderNewOrderRespTypeEnum$1 as NewOrderNewOrderRespTypeEnum, NewOrderPositionSideEnum$1 as NewOrderPositionSideEnum, NewOrderPriceMatchEnum$1 as NewOrderPriceMatchEnum, NewOrderPriceProtectEnum$1 as NewOrderPriceProtectEnum, NewOrderReduceOnlyEnum$1 as NewOrderReduceOnlyEnum, NewOrderRequest$1 as NewOrderRequest, NewOrderResponse$1 as NewOrderResponse, NewOrderSelfTradePreventionModeEnum$1 as NewOrderSelfTradePreventionModeEnum, NewOrderSideEnum$1 as NewOrderSideEnum, NewOrderTimeInForceEnum$1 as NewOrderTimeInForceEnum, NewOrderTypeEnum$1 as NewOrderTypeEnum, NewOrderWorkingTypeEnum$1 as NewOrderWorkingTypeEnum, NotionalBracketForPairRequest, NotionalBracketForPairResponse, NotionalBracketForPairResponseInner, NotionalBracketForPairResponseInnerBracketsInner, NotionalBracketForSymbolRequest, NotionalBracketForSymbolResponse, NotionalBracketForSymbolResponseInner, OldTradesLookupRequest, OldTradesLookupResponse, OldTradesLookupResponseInner, OpenInterestRequest, OpenInterestResponse, OpenInterestStatisticsContractTypeEnum, OpenInterestStatisticsPeriodEnum, OpenInterestStatisticsRequest, OpenInterestStatisticsResponse, OpenInterestStatisticsResponseInner, OrderBookRequest, OrderBookResponse, PlaceMultipleOrdersBatchOrdersParameterInner, PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum, PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum, PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum, PlaceMultipleOrdersBatchOrdersParameterInnerPriceProtectEnum, PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum, PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum, PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum, PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum, PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum, PlaceMultipleOrdersBatchOrdersParameterInnerWorkingTypeEnum, PlaceMultipleOrdersRequest, PlaceMultipleOrdersResponse, PlaceMultipleOrdersResponseInner, PositionAdlQuantileEstimationRequest, PositionAdlQuantileEstimationResponse, PositionAdlQuantileEstimationResponseInner, PositionAdlQuantileEstimationResponseInnerAdlQuantile, PositionInformationRequest$1 as PositionInformationRequest, PositionInformationResponse$1 as PositionInformationResponse, PositionInformationResponseInner, PremiumIndexKlineDataIntervalEnum, PremiumIndexKlineDataItem, PremiumIndexKlineDataItemInner, PremiumIndexKlineDataRequest, PremiumIndexKlineDataResponse, QueryCurrentOpenOrderRequest, QueryCurrentOpenOrderResponse, QueryIndexPriceConstituentsRequest, QueryIndexPriceConstituentsResponse, QueryIndexPriceConstituentsResponseConstituentsInner, QueryOrderRequest$1 as QueryOrderRequest, QueryOrderResponse$1 as QueryOrderResponse, RecentTradesListRequest, RecentTradesListResponse, RecentTradesListResponseInner, RestAPI, StartUserDataStreamResponse$1 as StartUserDataStreamResponse, SymbolOrderBookTickerRequest, SymbolOrderBookTickerResponse, SymbolOrderBookTickerResponseInner, SymbolPriceTickerRequest, SymbolPriceTickerResponse, SymbolPriceTickerResponseInner, TakerBuySellVolumeContractTypeEnum, TakerBuySellVolumePeriodEnum, TakerBuySellVolumeRequest, TakerBuySellVolumeResponse, TakerBuySellVolumeResponseInner, Ticker24hrPriceChangeStatisticsRequest, Ticker24hrPriceChangeStatisticsResponse, Ticker24hrPriceChangeStatisticsResponseInner, TopTraderLongShortRatioAccountsPeriodEnum, TopTraderLongShortRatioAccountsRequest, TopTraderLongShortRatioAccountsResponse, TopTraderLongShortRatioAccountsResponseInner, TopTraderLongShortRatioPositionsPeriodEnum, TopTraderLongShortRatioPositionsRequest, TopTraderLongShortRatioPositionsResponse, TopTraderLongShortRatioPositionsResponseInner, TradeApi$1 as TradeApi, TradeApiInterface$1 as TradeApiInterface, UserCommissionRateRequest, UserCommissionRateResponse, UserDataStreamsApi$1 as UserDataStreamsApi, UserDataStreamsApiInterface$1 as UserDataStreamsApiInterface, UsersForceOrdersAutoCloseTypeEnum, UsersForceOrdersRequest, UsersForceOrdersResponse, UsersForceOrdersResponseInner }; } //#endregion //#region src/websocket-api/types/account-information-response-rate-limits-inner.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AccountInformationResponseRateLimitsInner */ interface AccountInformationResponseRateLimitsInner { /** * Rate limit type. * @type {string} * @memberof AccountInformationResponseRateLimitsInner */ rateLimitType?: string; /** * Rate limit interval. * @type {string} * @memberof AccountInformationResponseRateLimitsInner */ interval?: string; /** * Rate limit interval multiplier. * @type {number | bigint} * @memberof AccountInformationResponseRateLimitsInner */ intervalNum?: number | bigint; /** * Maximum allowed orders for this rule. * @type {number | bigint} * @memberof AccountInformationResponseRateLimitsInner */ limit?: number | bigint; /** * Total number of trades in the 24h window. * @type {number | bigint} * @memberof AccountInformationResponseRateLimitsInner */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/account-information-response-result-assets-inner.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AccountInformationResponseResultAssetsInner */ interface AccountInformationResponseResultAssetsInner { /** * asset name * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ asset?: string; /** * total wallet balance * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ walletBalance?: string; /** * unrealized profit or loss * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ unrealizedProfit?: string; /** * margin balance * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ marginBalance?: string; /** * maintenance margin * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ maintMargin?: string; /** * total intial margin required with the latest mark price * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ initialMargin?: string; /** * positions margin required with the latest mark price * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ positionInitialMargin?: string; /** * open orders intial margin required with the latest mark price * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ openOrderInitialMargin?: string; /** * maximum amount for transfer out * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ maxWithdrawAmount?: string; /** * wallet balance for crossed margin * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ crossWalletBalance?: string; /** * total unrealized profit or loss of crossed positions * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ crossUnPnl?: string; /** * available margin balance * @type {string} * @memberof AccountInformationResponseResultAssetsInner */ availableBalance?: string; /** * update time * @type {number | bigint} * @memberof AccountInformationResponseResultAssetsInner */ updateTime?: number | bigint; } //#endregion //#region src/websocket-api/types/account-information-response-result-positions-inner.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AccountInformationResponseResultPositionsInner */ interface AccountInformationResponseResultPositionsInner { /** * Trading symbol * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ symbol?: string; /** * total intial margin required with the latest mark price * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ initialMargin?: string; /** * maintenance margin * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ maintMargin?: string; /** * unrealized profit or loss * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ unrealizedProfit?: string; /** * positions margin required with the latest mark price * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ positionInitialMargin?: string; /** * open orders intial margin required with the latest mark price * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ openOrderInitialMargin?: string; /** * Leverage value. * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ leverage?: string; /** * Whether isolated margin mode is enabled. * @type {boolean} * @memberof AccountInformationResponseResultPositionsInner */ isolated?: boolean; /** * Position side * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ positionSide?: string; /** * Position entry price. * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ entryPrice?: string; /** * maximum quantity of base asset * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ maxQty?: string; /** * Notional value. * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ notionalValue?: string; /** * Isolated wallet balance. * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ isolatedWallet?: string; /** * update time * @type {number | bigint} * @memberof AccountInformationResponseResultPositionsInner */ updateTime?: number | bigint; /** * position amount * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ positionAmt?: string; /** * break-even price * @type {string} * @memberof AccountInformationResponseResultPositionsInner */ breakEvenPrice?: string; } //#endregion //#region src/websocket-api/types/account-information-response-result.d.ts /** * Indicates that combined is set to true. * @export * @interface AccountInformationResponseResult */ interface AccountInformationResponseResult { /** * Fee tier level. * @type {number | bigint} * @memberof AccountInformationResponseResult */ feeTier?: number | bigint; /** * Whether trading is enabled. * @type {boolean} * @memberof AccountInformationResponseResult */ canTrade?: boolean; /** * Whether deposits are enabled. * @type {boolean} * @memberof AccountInformationResponseResult */ canDeposit?: boolean; /** * Whether withdrawals are enabled. * @type {boolean} * @memberof AccountInformationResponseResult */ canWithdraw?: boolean; /** * update time * @type {number | bigint} * @memberof AccountInformationResponseResult */ updateTime?: number | bigint; /** * Supported assets. * @type {Array} * @memberof AccountInformationResponseResult */ assets?: Array; /** * Position list. * @type {Array} * @memberof AccountInformationResponseResult */ positions?: Array; } //#endregion //#region src/websocket-api/types/account-information-response.d.ts /** * * @export * @interface AccountInformationResponse */ interface AccountInformationResponse { /** * positionId * @type {string} * @memberof AccountInformationResponse */ id?: string; /** * Enum：completed，processing * @type {number | bigint} * @memberof AccountInformationResponse */ status?: number | bigint; /** * * @type {AccountInformationResponseResult} * @memberof AccountInformationResponse */ result?: AccountInformationResponseResult; /** * Rate limit definitions. * @type {Array} * @memberof AccountInformationResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/cancel-order-response-rate-limits-inner.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CancelOrderResponseRateLimitsInner */ interface CancelOrderResponseRateLimitsInner { /** * Rate limit type. * @type {string} * @memberof CancelOrderResponseRateLimitsInner */ rateLimitType?: string; /** * Rate limit interval. * @type {string} * @memberof CancelOrderResponseRateLimitsInner */ interval?: string; /** * Rate limit interval multiplier. * @type {number | bigint} * @memberof CancelOrderResponseRateLimitsInner */ intervalNum?: number | bigint; /** * Maximum allowed orders for this rule. * @type {number | bigint} * @memberof CancelOrderResponseRateLimitsInner */ limit?: number | bigint; /** * Total number of trades in the 24h window. * @type {number | bigint} * @memberof CancelOrderResponseRateLimitsInner */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/cancel-order-response-result.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates that combined is set to true. * @export * @interface CancelOrderResponseResult */ interface CancelOrderResponseResult { /** * Sub-order ID * @type {number | bigint} * @memberof CancelOrderResponseResult */ orderId?: number | bigint; /** * Trading symbol * @type {string} * @memberof CancelOrderResponseResult */ symbol?: string; /** * Pair * @type {string} * @memberof CancelOrderResponseResult */ pair?: string; /** * Enum：completed，processing * @type {string} * @memberof CancelOrderResponseResult */ status?: string; /** * Client order ID. * @type {string} * @memberof CancelOrderResponseResult */ clientOrderId?: string; /** * Latest token price. * @type {string} * @memberof CancelOrderResponseResult */ price?: string; /** * Original order quantity * @type {string} * @memberof CancelOrderResponseResult */ origQty?: string; /** * Executed quantity * @type {string} * @memberof CancelOrderResponseResult */ executedQty?: string; /** * Cumulative filled quantity. * @type {string} * @memberof CancelOrderResponseResult */ cumQty?: string; /** * Time in force * @type {string} * @memberof CancelOrderResponseResult */ timeInForce?: string; /** * Order type. * @type {string} * @memberof CancelOrderResponseResult */ type?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof CancelOrderResponseResult */ reduceOnly?: boolean; /** * if Close-All * @type {boolean} * @memberof CancelOrderResponseResult */ closePosition?: boolean; /** * Trading side * @type {string} * @memberof CancelOrderResponseResult */ side?: string; /** * Position side * @type {string} * @memberof CancelOrderResponseResult */ positionSide?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof CancelOrderResponseResult */ stopPrice?: string; /** * Stop trigger price type. * @type {string} * @memberof CancelOrderResponseResult */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof CancelOrderResponseResult */ priceProtect?: boolean; /** * Original order type. * @type {string} * @memberof CancelOrderResponseResult */ origType?: string; /** * update time * @type {number | bigint} * @memberof CancelOrderResponseResult */ updateTime?: number | bigint; } //#endregion //#region src/websocket-api/types/cancel-order-response.d.ts /** * * @export * @interface CancelOrderResponse */ interface CancelOrderResponse { /** * positionId * @type {string} * @memberof CancelOrderResponse */ id?: string; /** * Enum：completed，processing * @type {number | bigint} * @memberof CancelOrderResponse */ status?: number | bigint; /** * * @type {CancelOrderResponseResult} * @memberof CancelOrderResponse */ result?: CancelOrderResponseResult; /** * Rate limit definitions. * @type {Array} * @memberof CancelOrderResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/close-user-data-stream-response-rate-limits-inner.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CloseUserDataStreamResponseRateLimitsInner */ interface CloseUserDataStreamResponseRateLimitsInner { /** * Rate limit type. * @type {string} * @memberof CloseUserDataStreamResponseRateLimitsInner */ rateLimitType?: string; /** * Rate limit interval. * @type {string} * @memberof CloseUserDataStreamResponseRateLimitsInner */ interval?: string; /** * Rate limit interval multiplier. * @type {number | bigint} * @memberof CloseUserDataStreamResponseRateLimitsInner */ intervalNum?: number | bigint; /** * Maximum allowed orders for this rule. * @type {number | bigint} * @memberof CloseUserDataStreamResponseRateLimitsInner */ limit?: number | bigint; /** * Total number of trades in the 24h window. * @type {number | bigint} * @memberof CloseUserDataStreamResponseRateLimitsInner */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/close-user-data-stream-response.d.ts /** * * @export * @interface CloseUserDataStreamResponse */ interface CloseUserDataStreamResponse { /** * positionId * @type {string} * @memberof CloseUserDataStreamResponse */ id?: string; /** * Enum：completed，processing * @type {number | bigint} * @memberof CloseUserDataStreamResponse */ status?: number | bigint; /** * Indicates that combined is set to true. * @type {object} * @memberof CloseUserDataStreamResponse */ result?: object; /** * Rate limit definitions. * @type {Array} * @memberof CloseUserDataStreamResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/futures-account-balance-response-result-inner.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface FuturesAccountBalanceResponseResultInner */ interface FuturesAccountBalanceResponseResultInner { /** * unique account code * @type {string} * @memberof FuturesAccountBalanceResponseResultInner */ accountAlias?: string; /** * asset name * @type {string} * @memberof FuturesAccountBalanceResponseResultInner */ asset?: string; /** * Account balance. * @type {string} * @memberof FuturesAccountBalanceResponseResultInner */ balance?: string; /** * Available amount for withdrawal. * @type {string} * @memberof FuturesAccountBalanceResponseResultInner */ withdrawAvailable?: string; /** * wallet balance for crossed margin * @type {string} * @memberof FuturesAccountBalanceResponseResultInner */ crossWalletBalance?: string; /** * total unrealized profit or loss of crossed positions * @type {string} * @memberof FuturesAccountBalanceResponseResultInner */ crossUnPnl?: string; /** * available margin balance * @type {string} * @memberof FuturesAccountBalanceResponseResultInner */ availableBalance?: string; /** * update time * @type {number | bigint} * @memberof FuturesAccountBalanceResponseResultInner */ updateTime?: number | bigint; } //#endregion //#region src/websocket-api/types/futures-account-balance-response.d.ts /** * * @export * @interface FuturesAccountBalanceResponse */ interface FuturesAccountBalanceResponse { /** * positionId * @type {string} * @memberof FuturesAccountBalanceResponse */ id?: string; /** * Enum：completed，processing * @type {number | bigint} * @memberof FuturesAccountBalanceResponse */ status?: number | bigint; /** * Indicates that combined is set to true. * @type {Array} * @memberof FuturesAccountBalanceResponse */ result?: Array; /** * Rate limit definitions. * @type {Array} * @memberof FuturesAccountBalanceResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/keepalive-user-data-stream-response-result.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates that combined is set to true. * @export * @interface KeepaliveUserDataStreamResponseResult */ interface KeepaliveUserDataStreamResponseResult { /** * Listen key. * @type {string} * @memberof KeepaliveUserDataStreamResponseResult */ listenKey?: string; } //#endregion //#region src/websocket-api/types/keepalive-user-data-stream-response.d.ts /** * * @export * @interface KeepaliveUserDataStreamResponse */ interface KeepaliveUserDataStreamResponse { /** * positionId * @type {string} * @memberof KeepaliveUserDataStreamResponse */ id?: string; /** * Enum：completed，processing * @type {number | bigint} * @memberof KeepaliveUserDataStreamResponse */ status?: number | bigint; /** * * @type {KeepaliveUserDataStreamResponseResult} * @memberof KeepaliveUserDataStreamResponse */ result?: KeepaliveUserDataStreamResponseResult; /** * Rate limit definitions. * @type {Array} * @memberof KeepaliveUserDataStreamResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/modify-order-response-result.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates that combined is set to true. * @export * @interface ModifyOrderResponseResult */ interface ModifyOrderResponseResult { /** * Sub-order ID * @type {number | bigint} * @memberof ModifyOrderResponseResult */ orderId?: number | bigint; /** * Trading symbol * @type {string} * @memberof ModifyOrderResponseResult */ symbol?: string; /** * Pair * @type {string} * @memberof ModifyOrderResponseResult */ pair?: string; /** * Enum：completed，processing * @type {string} * @memberof ModifyOrderResponseResult */ status?: string; /** * Client order ID. * @type {string} * @memberof ModifyOrderResponseResult */ clientOrderId?: string; /** * user-defined modification identifier, only returned if provided in the request * @type {number | bigint} * @memberof ModifyOrderResponseResult */ modifyId?: number | bigint; /** * Latest token price. * @type {string} * @memberof ModifyOrderResponseResult */ price?: string; /** * Original order quantity * @type {string} * @memberof ModifyOrderResponseResult */ origQty?: string; /** * Executed quantity * @type {string} * @memberof ModifyOrderResponseResult */ executedQty?: string; /** * Cumulative filled quantity. * @type {string} * @memberof ModifyOrderResponseResult */ cumQty?: string; /** * Time in force * @type {string} * @memberof ModifyOrderResponseResult */ timeInForce?: string; /** * Order type. * @type {string} * @memberof ModifyOrderResponseResult */ type?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof ModifyOrderResponseResult */ reduceOnly?: boolean; /** * if Close-All * @type {boolean} * @memberof ModifyOrderResponseResult */ closePosition?: boolean; /** * Trading side * @type {string} * @memberof ModifyOrderResponseResult */ side?: string; /** * Position side * @type {string} * @memberof ModifyOrderResponseResult */ positionSide?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof ModifyOrderResponseResult */ stopPrice?: string; /** * Stop trigger price type. * @type {string} * @memberof ModifyOrderResponseResult */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof ModifyOrderResponseResult */ priceProtect?: boolean; /** * Original order type. * @type {string} * @memberof ModifyOrderResponseResult */ origType?: string; /** * update time * @type {number | bigint} * @memberof ModifyOrderResponseResult */ updateTime?: number | bigint; } //#endregion //#region src/websocket-api/types/modify-order-response.d.ts /** * * @export * @interface ModifyOrderResponse */ interface ModifyOrderResponse { /** * positionId * @type {string} * @memberof ModifyOrderResponse */ id?: string; /** * Enum：completed，processing * @type {number | bigint} * @memberof ModifyOrderResponse */ status?: number | bigint; /** * * @type {ModifyOrderResponseResult} * @memberof ModifyOrderResponse */ result?: ModifyOrderResponseResult; /** * Rate limit definitions. * @type {Array} * @memberof ModifyOrderResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/new-order-response-result.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates that combined is set to true. * @export * @interface NewOrderResponseResult */ interface NewOrderResponseResult { /** * Sub-order ID * @type {number | bigint} * @memberof NewOrderResponseResult */ orderId?: number | bigint; /** * Trading symbol * @type {string} * @memberof NewOrderResponseResult */ symbol?: string; /** * Pair * @type {string} * @memberof NewOrderResponseResult */ pair?: string; /** * Enum：completed，processing * @type {string} * @memberof NewOrderResponseResult */ status?: string; /** * Client order ID. * @type {string} * @memberof NewOrderResponseResult */ clientOrderId?: string; /** * Latest token price. * @type {string} * @memberof NewOrderResponseResult */ price?: string; /** * Original order quantity * @type {string} * @memberof NewOrderResponseResult */ origQty?: string; /** * Executed quantity * @type {string} * @memberof NewOrderResponseResult */ executedQty?: string; /** * Cumulative filled quantity. * @type {string} * @memberof NewOrderResponseResult */ cumQty?: string; /** * Time in force * @type {string} * @memberof NewOrderResponseResult */ timeInForce?: string; /** * Order type. * @type {string} * @memberof NewOrderResponseResult */ type?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof NewOrderResponseResult */ reduceOnly?: boolean; /** * if Close-All * @type {boolean} * @memberof NewOrderResponseResult */ closePosition?: boolean; /** * Trading side * @type {string} * @memberof NewOrderResponseResult */ side?: string; /** * Position side * @type {string} * @memberof NewOrderResponseResult */ positionSide?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof NewOrderResponseResult */ stopPrice?: string; /** * Stop trigger price type. * @type {string} * @memberof NewOrderResponseResult */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof NewOrderResponseResult */ priceProtect?: boolean; /** * Original order type. * @type {string} * @memberof NewOrderResponseResult */ origType?: string; /** * update time * @type {number | bigint} * @memberof NewOrderResponseResult */ updateTime?: number | bigint; } //#endregion //#region src/websocket-api/types/new-order-response.d.ts /** * * @export * @interface NewOrderResponse */ interface NewOrderResponse { /** * positionId * @type {string} * @memberof NewOrderResponse */ id?: string; /** * Enum：completed，processing * @type {number | bigint} * @memberof NewOrderResponse */ status?: number | bigint; /** * * @type {NewOrderResponseResult} * @memberof NewOrderResponse */ result?: NewOrderResponseResult; /** * Rate limit definitions. * @type {Array} * @memberof NewOrderResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/position-information-response-result-inner.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface PositionInformationResponseResultInner */ interface PositionInformationResponseResultInner { /** * Trading symbol * @type {string} * @memberof PositionInformationResponseResultInner */ symbol?: string; /** * position amount * @type {string} * @memberof PositionInformationResponseResultInner */ positionAmt?: string; /** * Position entry price. * @type {string} * @memberof PositionInformationResponseResultInner */ entryPrice?: string; /** * mark price * @type {string} * @memberof PositionInformationResponseResultInner */ markPrice?: string; /** * Unrealized profit. * @type {string} * @memberof PositionInformationResponseResultInner */ unRealizedProfit?: string; /** * Liquidation price. * @type {string} * @memberof PositionInformationResponseResultInner */ liquidationPrice?: string; /** * Leverage value. * @type {string} * @memberof PositionInformationResponseResultInner */ leverage?: string; /** * maximum quantity of base asset * @type {string} * @memberof PositionInformationResponseResultInner */ maxQty?: string; /** * Margin type. * @type {string} * @memberof PositionInformationResponseResultInner */ marginType?: string; /** * Isolated margin amount. * @type {string} * @memberof PositionInformationResponseResultInner */ isolatedMargin?: string; /** * Whether auto-add margin is enabled. * @type {string} * @memberof PositionInformationResponseResultInner */ isAutoAddMargin?: string; /** * Position side * @type {string} * @memberof PositionInformationResponseResultInner */ positionSide?: string; /** * Notional value. * @type {string} * @memberof PositionInformationResponseResultInner */ notionalValue?: string; /** * Isolated wallet balance. * @type {string} * @memberof PositionInformationResponseResultInner */ isolatedWallet?: string; /** * update time * @type {number | bigint} * @memberof PositionInformationResponseResultInner */ updateTime?: number | bigint; /** * break-even price * @type {string} * @memberof PositionInformationResponseResultInner */ breakEvenPrice?: string; } //#endregion //#region src/websocket-api/types/position-information-response.d.ts /** * * @export * @interface PositionInformationResponse */ interface PositionInformationResponse { /** * positionId * @type {string} * @memberof PositionInformationResponse */ id?: string; /** * Enum：completed，processing * @type {number | bigint} * @memberof PositionInformationResponse */ status?: number | bigint; /** * Indicates that combined is set to true. * @type {Array} * @memberof PositionInformationResponse */ result?: Array; /** * Rate limit definitions. * @type {Array} * @memberof PositionInformationResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/query-order-response-result.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates that combined is set to true. * @export * @interface QueryOrderResponseResult */ interface QueryOrderResponseResult { /** * Sub-order ID * @type {number | bigint} * @memberof QueryOrderResponseResult */ orderId?: number | bigint; /** * Trading symbol * @type {string} * @memberof QueryOrderResponseResult */ symbol?: string; /** * Pair * @type {string} * @memberof QueryOrderResponseResult */ pair?: string; /** * Enum：completed，processing * @type {string} * @memberof QueryOrderResponseResult */ status?: string; /** * Client order ID. * @type {string} * @memberof QueryOrderResponseResult */ clientOrderId?: string; /** * Latest token price. * @type {string} * @memberof QueryOrderResponseResult */ price?: string; /** * Average execution price * @type {string} * @memberof QueryOrderResponseResult */ avgPrice?: string; /** * Original order quantity * @type {string} * @memberof QueryOrderResponseResult */ origQty?: string; /** * Executed quantity * @type {string} * @memberof QueryOrderResponseResult */ executedQty?: string; /** * Cumulative filled quantity. * @type {string} * @memberof QueryOrderResponseResult */ cumQty?: string; /** * Cumulative base asset amount. * @type {string} * @memberof QueryOrderResponseResult */ cumBase?: string; /** * Time in force * @type {string} * @memberof QueryOrderResponseResult */ timeInForce?: string; /** * Order type. * @type {string} * @memberof QueryOrderResponseResult */ type?: string; /** * Whether the order is reduce-only. * @type {boolean} * @memberof QueryOrderResponseResult */ reduceOnly?: boolean; /** * if Close-All * @type {boolean} * @memberof QueryOrderResponseResult */ closePosition?: boolean; /** * Trading side * @type {string} * @memberof QueryOrderResponseResult */ side?: string; /** * Position side * @type {string} * @memberof QueryOrderResponseResult */ positionSide?: string; /** * please ignore when order type is TRAILING_STOP_MARKET * @type {string} * @memberof QueryOrderResponseResult */ stopPrice?: string; /** * Stop trigger price type. * @type {string} * @memberof QueryOrderResponseResult */ workingType?: string; /** * if conditional order trigger is protected * @type {boolean} * @memberof QueryOrderResponseResult */ priceProtect?: boolean; /** * Original order type. * @type {string} * @memberof QueryOrderResponseResult */ origType?: string; /** * self trading preventation mode * @type {string} * @memberof QueryOrderResponseResult */ selfTradePreventionMode?: string; /** * Time * @type {number | bigint} * @memberof QueryOrderResponseResult */ time?: number | bigint; /** * update time * @type {number | bigint} * @memberof QueryOrderResponseResult */ updateTime?: number | bigint; /** * price match mode * @type {string} * @memberof QueryOrderResponseResult */ priceMatch?: string; } //#endregion //#region src/websocket-api/types/query-order-response.d.ts /** * * @export * @interface QueryOrderResponse */ interface QueryOrderResponse { /** * positionId * @type {string} * @memberof QueryOrderResponse */ id?: string; /** * Enum：completed，processing * @type {number | bigint} * @memberof QueryOrderResponse */ status?: number | bigint; /** * * @type {QueryOrderResponseResult} * @memberof QueryOrderResponse */ result?: QueryOrderResponseResult; /** * Rate limit definitions. * @type {Array} * @memberof QueryOrderResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/start-user-data-stream-response-result.d.ts /** * Futures (COIN-M) WebSocket API * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates that combined is set to true. * @export * @interface StartUserDataStreamResponseResult */ interface StartUserDataStreamResponseResult { /** * Listen key. * @type {string} * @memberof StartUserDataStreamResponseResult */ listenKey?: string; } //#endregion //#region src/websocket-api/types/start-user-data-stream-response.d.ts /** * * @export * @interface StartUserDataStreamResponse */ interface StartUserDataStreamResponse { /** * positionId * @type {string} * @memberof StartUserDataStreamResponse */ id?: string; /** * Enum：completed，processing * @type {number | bigint} * @memberof StartUserDataStreamResponse */ status?: number | bigint; /** * * @type {StartUserDataStreamResponseResult} * @memberof StartUserDataStreamResponse */ result?: StartUserDataStreamResponseResult; /** * Rate limit definitions. * @type {Array} * @memberof StartUserDataStreamResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/modules/account-api.d.ts /** * AccountApi - interface * * @interface AccountApi */ interface AccountApiInterface { /** * Get current account information. User in single-asset/ multi-assets mode * will see different value, see comments in response section for detail. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Account Information (USER_DATA) * @param {AccountInformationRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ accountInformation(requestParameters?: AccountInformationRequest): Promise>; /** * Futures Account Balance * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Futures Account Balance (USER_DATA) * @param {FuturesAccountBalanceRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ futuresAccountBalance(requestParameters?: FuturesAccountBalanceRequest): Promise>; } /** * Request parameters for accountInformation operation in AccountApi. * @interface AccountInformationRequest */ interface AccountInformationRequest { /** * * @type {string} * @memberof AccountApiAccountInformation */ readonly id?: string; /** * * @type {number | bigint} * @memberof AccountApiAccountInformation */ readonly recvWindow?: number | bigint; } /** * Request parameters for futuresAccountBalance operation in AccountApi. * @interface FuturesAccountBalanceRequest */ interface FuturesAccountBalanceRequest { /** * * @type {string} * @memberof AccountApiFuturesAccountBalance */ readonly id?: string; /** * * @type {number | bigint} * @memberof AccountApiFuturesAccountBalance */ readonly recvWindow?: number | bigint; } /** * AccountApi - object-oriented interface * @class AccountApi * @extends {WebsocketAPIBase} */ declare class AccountApi implements AccountApiInterface { private readonly websocketBase; constructor(websocketBase: WebsocketAPIBase); /** * Get current account information. User in single-asset/ multi-assets mode * will see different value, see comments in response section for detail. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Account Information (USER_DATA) * @param {AccountInformationRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/account#account-information Binance API Documentation} */ accountInformation(requestParameters?: AccountInformationRequest): Promise>; /** * Futures Account Balance * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Futures Account Balance (USER_DATA) * @param {FuturesAccountBalanceRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/account#futures-account-balance Binance API Documentation} */ futuresAccountBalance(requestParameters?: FuturesAccountBalanceRequest): Promise>; } //#endregion //#region src/websocket-api/modules/trade-api.d.ts /** * TradeApi - interface * * @interface TradeApi */ interface TradeApiInterface { /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Cancel Order (TRADE) * @param {CancelOrderRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ cancelOrder(requestParameters: CancelOrderRequest): Promise>; /** * Order modify function, currently only LIMIT order modification is * supported, modified orders will be reordered in the match queue * * Weight: 1 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); * 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); * 1 on IP rate limit(x-mbx-used-weight-1m) * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent, and the `orderId` will prevail if both are sent. * - Both `quantity` and `price` must be sent. * - When the new `quantity` or `price` doesn't satisfy `PRICE_FILTER` / `PERCENT_FILTER` / `LOT_SIZE`, amendment will be rejected and the order will stay as it is. * - However the order will be cancelled by the amendment in the following situations: * - when the order is in partially filled status and the new `quantity` <= `executedQty` * - When the order is `GTX` and the new price will cause it to be executed immediately * - One order can only be modified for less than 10000 times. * * @summary Modify Order (TRADE) * @param {ModifyOrderRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ modifyOrder(requestParameters: ModifyOrderRequest): Promise>; /** * Send in a new order. * * Weight(IP): 0 * * Security Type: TRADE * * Notes: * - Additional mandatory parameters based on `type`: * | Type | Additional mandatory parameters | | :---: | --- | | `LIMIT` | `timeInForce`, `quantity`, `price` | | `MARKET` | `quantity` | | `STOP/TAKE_PROFIT` | `quantity`, `price`, `stopPrice` | | `STOP_MARKET/TAKE_PROFIT_MARKET` | `stopPrice` | | `TRAILING_STOP_MARKET` | `callbackRate` | * - Order with type `STOP`, parameter `timeInForce` can be sent ( default `GTC`). * Order with type `TAKE_PROFIT`, parameter `timeInForce` can be sent ( default `GTC`). * Condition orders will be triggered when: * - If parameter `priceProtect` is sent as true: * - when price reaches the `stopPrice`，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol * - "triggerProtect" of a symbol can be got from `GET /dapi/v1/exchangeInfo` * - `STOP`, `STOP_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= `stopPrice` * - `TAKE_PROFIT`, `TAKE_PROFIT_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= `stopPrice` * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - `TRAILING_STOP_MARKET`: * - BUY: the lowest price after order placed <= `activationPrice`, and the latest price >= the lowest price * (1 + `callbackRate`) * - SELL: the highest price after order placed >= `activationPrice`, and the latest price <= the highest price * (1 - `callbackRate`) * - For `TRAILING_STOP_MARKET`, if you got such error code. * - BUY: `activationPrice` should be smaller than latest price. * - SELL: `activationPrice` should be larger than latest price. * - If `newOrderRespType` is sent as `RESULT`: * - `MARKET` order: the final FILLED result of the order will be return directly. * - `LIMIT` order with special `timeInForce`: the final status result of the order(FILLED or EXPIRED) will be returned directly. * - `STOP_MARKET`, `TAKE_PROFIT_MARKET` with `closePosition=true`: * - Follow the same rules for condition orders. * - If triggered，**close all** current long position(if `SELL`) or current short position(if `BUY`). * - Cannot be used with `quantity` parameter * - Cannot be used with `reduceOnly` parameter * - In Hedge Mode, cannot be used with `BUY` orders in `LONG` position side. and cannot be used with `SELL` orders in `SHORT` position side * * @summary New Order (TRADE) * @param {NewOrderRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ newOrder(requestParameters: NewOrderRequest): Promise>; /** * Get current position information. * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Please use with user data stream `ACCOUNT_UPDATE` to meet your timeliness and accuracy needs. * * @summary Position Information (USER_DATA) * @param {PositionInformationRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ positionInformation(requestParameters?: PositionInformationRequest): Promise>; /** * Check an order's status. * * These orders will not be found: * order status is `CANCELED` or `EXPIRED` **AND** order has NO filled trade **AND** created time + 3 days < current time * order create time + 90 days < current time * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Query Order (USER_DATA) * @param {QueryOrderRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ queryOrder(requestParameters: QueryOrderRequest): Promise>; } /** * Request parameters for cancelOrder operation in TradeApi. * @interface CancelOrderRequest */ interface CancelOrderRequest { /** * * @type {string} * @memberof TradeApiCancelOrder */ readonly symbol: string; /** * * @type {string} * @memberof TradeApiCancelOrder */ readonly id?: string; /** * * @type {number | bigint} * @memberof TradeApiCancelOrder */ readonly orderId?: number | bigint; /** * * @type {string} * @memberof TradeApiCancelOrder */ readonly origClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiCancelOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for modifyOrder operation in TradeApi. * @interface ModifyOrderRequest */ interface ModifyOrderRequest { /** * * @type {string} * @memberof TradeApiModifyOrder */ readonly symbol: string; /** * * @type {'BUY' | 'SELL'} * @memberof TradeApiModifyOrder */ readonly side: ModifyOrderSideEnum; /** * Order quantity, cannot be sent with `closePosition=true` * @type {number} * @memberof TradeApiModifyOrder */ readonly quantity: number; /** * * @type {number} * @memberof TradeApiModifyOrder */ readonly price: number; /** * * @type {string} * @memberof TradeApiModifyOrder */ readonly id?: string; /** * * @type {number | bigint} * @memberof TradeApiModifyOrder */ readonly orderId?: number | bigint; /** * * @type {string} * @memberof TradeApiModifyOrder */ readonly origClientOrderId?: string; /** * only avaliable for `LIMIT`/`STOP`/`TAKE_PROFIT` order; Can't be passed together with `price` * @type {'OPPONENT' | 'OPPONENT_5' | 'OPPONENT_10' | 'OPPONENT_20' | 'QUEUE' | 'QUEUE_5' | 'QUEUE_10' | 'QUEUE_20'} * @memberof TradeApiModifyOrder */ readonly priceMatch?: ModifyOrderPriceMatchEnum; /** * User-defined modification identifier, returned as-is in the response. Optional; not validated for uniqueness. * @type {number | bigint} * @memberof TradeApiModifyOrder */ readonly modifyId?: number | bigint; /** * * @type {number | bigint} * @memberof TradeApiModifyOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for newOrder operation in TradeApi. * @interface NewOrderRequest */ interface NewOrderRequest { /** * * @type {string} * @memberof TradeApiNewOrder */ readonly symbol: string; /** * * @type {'BUY' | 'SELL'} * @memberof TradeApiNewOrder */ readonly side: NewOrderSideEnum; /** * **After CM migration, stop-type values (`STOP`, `STOP_MARKET`, `TAKE_PROFIT`, `TAKE_PROFIT_MARKET`, `TRAILING_STOP_MARKET`) are no longer accepted and will return `-4120`. Use the REST `/dapi/v1/algoOrder` endpoint instead.** * @type {'LIMIT' | 'MARKET' | 'STOP' | 'STOP_MARKET' | 'TAKE_PROFIT' | 'TAKE_PROFIT_MARKET' | 'TRAILING_STOP_MARKET'} * @memberof TradeApiNewOrder */ readonly type: NewOrderTypeEnum; /** * * @type {string} * @memberof TradeApiNewOrder */ readonly id?: string; /** * Default `BOTH` for One-way Mode; `LONG` or `SHORT` for Hedge Mode. It must be sent in Hedge Mode. * @type {'BOTH' | 'LONG' | 'SHORT'} * @memberof TradeApiNewOrder */ readonly positionSide?: NewOrderPositionSideEnum; /** * * @type {'GTC' | 'IOC' | 'FOK' | 'GTX'} * @memberof TradeApiNewOrder */ readonly timeInForce?: NewOrderTimeInForceEnum; /** * Quantity measured by contract number, Cannot be sent with `closePosition`=`true` * @type {number} * @memberof TradeApiNewOrder */ readonly quantity?: number; /** * Cannot be sent in Hedge Mode; cannot be sent with `closePosition`=`true` (Close-All)" * @type {'true' | 'false'} * @memberof TradeApiNewOrder */ readonly reduceOnly?: NewOrderReduceOnlyEnum; /** * * @type {number} * @memberof TradeApiNewOrder */ readonly price?: number; /** * A unique id among open orders. Automatically generated if not sent. Can only be string following the rule: `^[\.A-Z\:/a-z0-9_-]{1,36}$` * @type {string} * @memberof TradeApiNewOrder */ readonly newClientOrderId?: string; /** * Used with `STOP/STOP_MARKET` or `TAKE_PROFIT/TAKE_PROFIT_MARKET` orders. * @type {number} * @memberof TradeApiNewOrder */ readonly stopPrice?: number; /** * `true`, `false`；Close-All，used with `STOP_MARKET` or `TAKE_PROFIT_MARKET`. * @type {'true' | 'false'} * @memberof TradeApiNewOrder */ readonly closePosition?: NewOrderClosePositionEnum; /** * Used with `TRAILING_STOP_MARKET` orders, default as the latest price(supporting different workingType) * @type {number} * @memberof TradeApiNewOrder */ readonly activationPrice?: number; /** * Used with `TRAILING_STOP_MARKET` orders, min 0.1, max 10 where 1 for 1% * @type {number} * @memberof TradeApiNewOrder */ readonly callbackRate?: number; /** * stopPrice triggered by: "MARK_PRICE", "CONTRACT_PRICE". Default "CONTRACT_PRICE" * @type {'MARK_PRICE' | 'CONTRACT_PRICE'} * @memberof TradeApiNewOrder */ readonly workingType?: NewOrderWorkingTypeEnum; /** * Used with `STOP/STOP_MARKET` or `TAKE_PROFIT/TAKE_PROFIT_MARKET` orders.' * @type {'true' | 'false'} * @memberof TradeApiNewOrder */ readonly priceProtect?: NewOrderPriceProtectEnum; /** * * @type {'ACK' | 'RESULT'} * @memberof TradeApiNewOrder */ readonly newOrderRespType?: NewOrderNewOrderRespTypeEnum; /** * only available for `LIMIT`/`STOP`/`TAKE_PROFIT` order; Can't be passed together with `price` * @type {'OPPONENT' | 'OPPONENT_5' | 'OPPONENT_10' | 'OPPONENT_20' | 'QUEUE' | 'QUEUE_5' | 'QUEUE_10' | 'QUEUE_20'} * @memberof TradeApiNewOrder */ readonly priceMatch?: NewOrderPriceMatchEnum; /** * `NONE`: No STP / `EXPIRE_TAKER`:expire taker order when STP triggers/ `EXPIRE_MAKER`:expire taker order when STP triggers/ `EXPIRE_BOTH`:expire both orders when STP triggers * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_BOTH' | 'EXPIRE_MAKER'} * @memberof TradeApiNewOrder */ readonly selfTradePreventionMode?: NewOrderSelfTradePreventionModeEnum; /** * * @type {number | bigint} * @memberof TradeApiNewOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for positionInformation operation in TradeApi. * @interface PositionInformationRequest */ interface PositionInformationRequest { /** * * @type {string} * @memberof TradeApiPositionInformation */ readonly id?: string; /** * * @type {string} * @memberof TradeApiPositionInformation */ readonly marginAsset?: string; /** * * @type {string} * @memberof TradeApiPositionInformation */ readonly pair?: string; /** * * @type {number | bigint} * @memberof TradeApiPositionInformation */ readonly recvWindow?: number | bigint; } /** * Request parameters for queryOrder operation in TradeApi. * @interface QueryOrderRequest */ interface QueryOrderRequest { /** * * @type {string} * @memberof TradeApiQueryOrder */ readonly symbol: string; /** * * @type {string} * @memberof TradeApiQueryOrder */ readonly id?: string; /** * * @type {number | bigint} * @memberof TradeApiQueryOrder */ readonly orderId?: number | bigint; /** * * @type {string} * @memberof TradeApiQueryOrder */ readonly origClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiQueryOrder */ readonly recvWindow?: number | bigint; } /** * TradeApi - object-oriented interface * @class TradeApi * @extends {WebsocketAPIBase} */ declare class TradeApi implements TradeApiInterface { private readonly websocketBase; constructor(websocketBase: WebsocketAPIBase); /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Cancel Order (TRADE) * @param {CancelOrderRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/trade#cancel-order Binance API Documentation} */ cancelOrder(requestParameters: CancelOrderRequest): Promise>; /** * Order modify function, currently only LIMIT order modification is * supported, modified orders will be reordered in the match queue * * Weight: 1 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); * 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); * 1 on IP rate limit(x-mbx-used-weight-1m) * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent, and the `orderId` will prevail if both are sent. * - Both `quantity` and `price` must be sent. * - When the new `quantity` or `price` doesn't satisfy `PRICE_FILTER` / `PERCENT_FILTER` / `LOT_SIZE`, amendment will be rejected and the order will stay as it is. * - However the order will be cancelled by the amendment in the following situations: * - when the order is in partially filled status and the new `quantity` <= `executedQty` * - When the order is `GTX` and the new price will cause it to be executed immediately * - One order can only be modified for less than 10000 times. * * @summary Modify Order (TRADE) * @param {ModifyOrderRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/trade#modify-order Binance API Documentation} */ modifyOrder(requestParameters: ModifyOrderRequest): Promise>; /** * Send in a new order. * * Weight(IP): 0 * * Security Type: TRADE * * Notes: * - Additional mandatory parameters based on `type`: * | Type | Additional mandatory parameters | | :---: | --- | | `LIMIT` | `timeInForce`, `quantity`, `price` | | `MARKET` | `quantity` | | `STOP/TAKE_PROFIT` | `quantity`, `price`, `stopPrice` | | `STOP_MARKET/TAKE_PROFIT_MARKET` | `stopPrice` | | `TRAILING_STOP_MARKET` | `callbackRate` | * - Order with type `STOP`, parameter `timeInForce` can be sent ( default `GTC`). * Order with type `TAKE_PROFIT`, parameter `timeInForce` can be sent ( default `GTC`). * Condition orders will be triggered when: * - If parameter `priceProtect` is sent as true: * - when price reaches the `stopPrice`，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol * - "triggerProtect" of a symbol can be got from `GET /dapi/v1/exchangeInfo` * - `STOP`, `STOP_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= `stopPrice` * - `TAKE_PROFIT`, `TAKE_PROFIT_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= `stopPrice` * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - `TRAILING_STOP_MARKET`: * - BUY: the lowest price after order placed <= `activationPrice`, and the latest price >= the lowest price * (1 + `callbackRate`) * - SELL: the highest price after order placed >= `activationPrice`, and the latest price <= the highest price * (1 - `callbackRate`) * - For `TRAILING_STOP_MARKET`, if you got such error code. * - BUY: `activationPrice` should be smaller than latest price. * - SELL: `activationPrice` should be larger than latest price. * - If `newOrderRespType` is sent as `RESULT`: * - `MARKET` order: the final FILLED result of the order will be return directly. * - `LIMIT` order with special `timeInForce`: the final status result of the order(FILLED or EXPIRED) will be returned directly. * - `STOP_MARKET`, `TAKE_PROFIT_MARKET` with `closePosition=true`: * - Follow the same rules for condition orders. * - If triggered，**close all** current long position(if `SELL`) or current short position(if `BUY`). * - Cannot be used with `quantity` parameter * - Cannot be used with `reduceOnly` parameter * - In Hedge Mode, cannot be used with `BUY` orders in `LONG` position side. and cannot be used with `SELL` orders in `SHORT` position side * * @summary New Order (TRADE) * @param {NewOrderRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/trade#new-order Binance API Documentation} */ newOrder(requestParameters: NewOrderRequest): Promise>; /** * Get current position information. * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Please use with user data stream `ACCOUNT_UPDATE` to meet your timeliness and accuracy needs. * * @summary Position Information (USER_DATA) * @param {PositionInformationRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/trade#position-information Binance API Documentation} */ positionInformation(requestParameters?: PositionInformationRequest): Promise>; /** * Check an order's status. * * These orders will not be found: * order status is `CANCELED` or `EXPIRED` **AND** order has NO filled trade **AND** created time + 3 days < current time * order create time + 90 days < current time * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Query Order (USER_DATA) * @param {QueryOrderRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/trade#query-order Binance API Documentation} */ queryOrder(requestParameters: QueryOrderRequest): Promise>; } declare enum ModifyOrderSideEnum { BUY = "BUY", SELL = "SELL", } declare enum ModifyOrderPriceMatchEnum { OPPONENT = "OPPONENT", OPPONENT_5 = "OPPONENT_5", OPPONENT_10 = "OPPONENT_10", OPPONENT_20 = "OPPONENT_20", QUEUE = "QUEUE", QUEUE_5 = "QUEUE_5", QUEUE_10 = "QUEUE_10", QUEUE_20 = "QUEUE_20", } declare enum NewOrderSideEnum { BUY = "BUY", SELL = "SELL", } declare enum NewOrderTypeEnum { LIMIT = "LIMIT", MARKET = "MARKET", STOP = "STOP", STOP_MARKET = "STOP_MARKET", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_MARKET = "TAKE_PROFIT_MARKET", TRAILING_STOP_MARKET = "TRAILING_STOP_MARKET", } declare enum NewOrderPositionSideEnum { BOTH = "BOTH", LONG = "LONG", SHORT = "SHORT", } declare enum NewOrderTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", GTX = "GTX", } declare enum NewOrderReduceOnlyEnum { TRUE = "true", FALSE = "false", } declare enum NewOrderClosePositionEnum { TRUE = "true", FALSE = "false", } declare enum NewOrderWorkingTypeEnum { MARK_PRICE = "MARK_PRICE", CONTRACT_PRICE = "CONTRACT_PRICE", } declare enum NewOrderPriceProtectEnum { TRUE = "true", FALSE = "false", } declare enum NewOrderNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", } declare enum NewOrderPriceMatchEnum { OPPONENT = "OPPONENT", OPPONENT_5 = "OPPONENT_5", OPPONENT_10 = "OPPONENT_10", OPPONENT_20 = "OPPONENT_20", QUEUE = "QUEUE", QUEUE_5 = "QUEUE_5", QUEUE_10 = "QUEUE_10", QUEUE_20 = "QUEUE_20", } declare enum NewOrderSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_BOTH = "EXPIRE_BOTH", EXPIRE_MAKER = "EXPIRE_MAKER", } //#endregion //#region src/websocket-api/modules/user-data-streams-api.d.ts /** * UserDataStreamsApi - interface * * @interface UserDataStreamsApi */ interface UserDataStreamsApiInterface { /** * Close out a user data stream. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Close User Data Stream (USER_STREAM) * @param {CloseUserDataStreamRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof UserDataStreamsApiInterface */ closeUserDataStream(requestParameters?: CloseUserDataStreamRequest): Promise>; /** * Keepalive a user data stream to prevent a time out. User data streams * will close after 60 minutes. It's recommended to send a ping about every * 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Keepalive User Data Stream (USER_STREAM) * @param {KeepaliveUserDataStreamRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof UserDataStreamsApiInterface */ keepaliveUserDataStream(requestParameters?: KeepaliveUserDataStreamRequest): Promise>; /** * Start a new user data stream. The stream will close after 60 minutes * unless a keepalive is sent. If the account has an active `listenKey`, * that `listenKey` will be returned and its validity will be extended for * 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Start User Data Stream (USER_STREAM) * @param {StartUserDataStreamRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof UserDataStreamsApiInterface */ startUserDataStream(requestParameters?: StartUserDataStreamRequest): Promise>; } /** * Request parameters for closeUserDataStream operation in UserDataStreamsApi. * @interface CloseUserDataStreamRequest */ interface CloseUserDataStreamRequest { /** * * @type {string} * @memberof UserDataStreamsApiCloseUserDataStream */ readonly id?: string; } /** * Request parameters for keepaliveUserDataStream operation in UserDataStreamsApi. * @interface KeepaliveUserDataStreamRequest */ interface KeepaliveUserDataStreamRequest { /** * * @type {string} * @memberof UserDataStreamsApiKeepaliveUserDataStream */ readonly id?: string; } /** * Request parameters for startUserDataStream operation in UserDataStreamsApi. * @interface StartUserDataStreamRequest */ interface StartUserDataStreamRequest { /** * * @type {string} * @memberof UserDataStreamsApiStartUserDataStream */ readonly id?: string; } /** * UserDataStreamsApi - object-oriented interface * @class UserDataStreamsApi * @extends {WebsocketAPIBase} */ declare class UserDataStreamsApi implements UserDataStreamsApiInterface { private readonly websocketBase; constructor(websocketBase: WebsocketAPIBase); /** * Close out a user data stream. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Close User Data Stream (USER_STREAM) * @param {CloseUserDataStreamRequest} requestParameters Request parameters. * @returns {Promise} * @memberof UserDataStreamsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/user-data-streams#close-user-data-stream Binance API Documentation} */ closeUserDataStream(requestParameters?: CloseUserDataStreamRequest): Promise>; /** * Keepalive a user data stream to prevent a time out. User data streams * will close after 60 minutes. It's recommended to send a ping about every * 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Keepalive User Data Stream (USER_STREAM) * @param {KeepaliveUserDataStreamRequest} requestParameters Request parameters. * @returns {Promise} * @memberof UserDataStreamsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/user-data-streams#keepalive-user-data-stream Binance API Documentation} */ keepaliveUserDataStream(requestParameters?: KeepaliveUserDataStreamRequest): Promise>; /** * Start a new user data stream. The stream will close after 60 minutes * unless a keepalive is sent. If the account has an active `listenKey`, * that `listenKey` will be returned and its validity will be extended for * 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Start User Data Stream (USER_STREAM) * @param {StartUserDataStreamRequest} requestParameters Request parameters. * @returns {Promise} * @memberof UserDataStreamsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/user-data-streams#start-user-data-stream Binance API Documentation} */ startUserDataStream(requestParameters?: StartUserDataStreamRequest): Promise>; } //#endregion //#region src/websocket-api/websocket-api-connection.d.ts declare class WebsocketAPIConnection { private websocketBase; private accountApi; private tradeApi; private userDataStreamsApi; constructor(websocketBase: WebsocketAPIBase); on(event: 'open' | 'message' | 'error' | 'close' | 'ping' | 'pong', listener: (...args: any[]) => void): void; off(event: 'open' | 'message' | 'error' | 'close' | 'ping' | 'pong', listener: (...args: any[]) => void): void; /** * Disconnects from the WebSocket server. * If there is no active connection, a warning is logged. * Otherwise, all connections in the connection pool are closed gracefully, * and a message is logged indicating that the connection has been disconnected. * @returns A Promise that resolves when all connections have been closed. * @throws Error if the WebSocket client is not set. */ disconnect(): Promise; /** * Checks if the WebSocket connection is currently open. * @returns `true` if the connection is open, `false` otherwise. */ isConnected(): boolean; /** * Sends a ping message to all connected Websocket servers in the pool. * If no connections are ready, a warning is logged. * For each active connection, the ping message is sent, and debug logs provide details. * @throws Error if a Websocket client is not set for a connection. */ pingServer(): void; /** * Sends an unsigned message to the WebSocket server * @param method The API method to call * @param payload Message parameters and options * @returns Promise that resolves with the server response * @throws Error if not connected */ sendMessage(method: string, payload?: WebsocketSendMsgOptions): Promise>; /** * Sends a signed message to the WebSocket server with authentication * @param method The API method to call * @param payload Message parameters and options * @returns Promise that resolves with the server response * @throws Error if not connected */ sendSignedMessage(method: string, payload?: WebsocketSendMsgOptions): Promise>; /** * Get current account information. User in single-asset/ multi-assets mode * will see different value, see comments in response section for detail. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Account Information (USER_DATA) * @param {AccountInformationRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/account#account-information Binance API Documentation} */ accountInformation(requestParameters?: AccountInformationRequest): Promise>; /** * Futures Account Balance * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Futures Account Balance (USER_DATA) * @param {FuturesAccountBalanceRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/account#futures-account-balance Binance API Documentation} */ futuresAccountBalance(requestParameters?: FuturesAccountBalanceRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Cancel Order (TRADE) * @param {CancelOrderRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/trade#cancel-order Binance API Documentation} */ cancelOrder(requestParameters: CancelOrderRequest): Promise>; /** * Order modify function, currently only LIMIT order modification is * supported, modified orders will be reordered in the match queue * * Weight: 1 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); * 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); * 1 on IP rate limit(x-mbx-used-weight-1m) * * Security Type: TRADE * * Notes: * - Either `orderId` or `origClientOrderId` must be sent, and the `orderId` will prevail if both are sent. * - Both `quantity` and `price` must be sent. * - When the new `quantity` or `price` doesn't satisfy `PRICE_FILTER` / `PERCENT_FILTER` / `LOT_SIZE`, amendment will be rejected and the order will stay as it is. * - However the order will be cancelled by the amendment in the following situations: * - when the order is in partially filled status and the new `quantity` <= `executedQty` * - When the order is `GTX` and the new price will cause it to be executed immediately * - One order can only be modified for less than 10000 times. * * @summary Modify Order (TRADE) * @param {ModifyOrderRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/trade#modify-order Binance API Documentation} */ modifyOrder(requestParameters: ModifyOrderRequest): Promise>; /** * Send in a new order. * * Weight(IP): 0 * * Security Type: TRADE * * Notes: * - Additional mandatory parameters based on `type`: * | Type | Additional mandatory parameters | | :---: | --- | | `LIMIT` | `timeInForce`, `quantity`, `price` | | `MARKET` | `quantity` | | `STOP/TAKE_PROFIT` | `quantity`, `price`, `stopPrice` | | `STOP_MARKET/TAKE_PROFIT_MARKET` | `stopPrice` | | `TRAILING_STOP_MARKET` | `callbackRate` | * - Order with type `STOP`, parameter `timeInForce` can be sent ( default `GTC`). * Order with type `TAKE_PROFIT`, parameter `timeInForce` can be sent ( default `GTC`). * Condition orders will be triggered when: * - If parameter `priceProtect` is sent as true: * - when price reaches the `stopPrice`，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol * - "triggerProtect" of a symbol can be got from `GET /dapi/v1/exchangeInfo` * - `STOP`, `STOP_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= `stopPrice` * - `TAKE_PROFIT`, `TAKE_PROFIT_MARKET`: * - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= `stopPrice` * - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= `stopPrice` * - `TRAILING_STOP_MARKET`: * - BUY: the lowest price after order placed <= `activationPrice`, and the latest price >= the lowest price * (1 + `callbackRate`) * - SELL: the highest price after order placed >= `activationPrice`, and the latest price <= the highest price * (1 - `callbackRate`) * - For `TRAILING_STOP_MARKET`, if you got such error code. * - BUY: `activationPrice` should be smaller than latest price. * - SELL: `activationPrice` should be larger than latest price. * - If `newOrderRespType` is sent as `RESULT`: * - `MARKET` order: the final FILLED result of the order will be return directly. * - `LIMIT` order with special `timeInForce`: the final status result of the order(FILLED or EXPIRED) will be returned directly. * - `STOP_MARKET`, `TAKE_PROFIT_MARKET` with `closePosition=true`: * - Follow the same rules for condition orders. * - If triggered，**close all** current long position(if `SELL`) or current short position(if `BUY`). * - Cannot be used with `quantity` parameter * - Cannot be used with `reduceOnly` parameter * - In Hedge Mode, cannot be used with `BUY` orders in `LONG` position side. and cannot be used with `SELL` orders in `SHORT` position side * * @summary New Order (TRADE) * @param {NewOrderRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/trade#new-order Binance API Documentation} */ newOrder(requestParameters: NewOrderRequest): Promise>; /** * Get current position information. * * Weight(IP): 5 * * Security Type: USER_DATA * * Notes: * - Please use with user data stream `ACCOUNT_UPDATE` to meet your timeliness and accuracy needs. * * @summary Position Information (USER_DATA) * @param {PositionInformationRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/trade#position-information Binance API Documentation} */ positionInformation(requestParameters?: PositionInformationRequest): Promise>; /** * Check an order's status. * * These orders will not be found: * order status is `CANCELED` or `EXPIRED` **AND** order has NO filled trade **AND** created time + 3 days < current time * order create time + 90 days < current time * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Either `orderId` or `origClientOrderId` must be sent. * * @summary Query Order (USER_DATA) * @param {QueryOrderRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/trade#query-order Binance API Documentation} */ queryOrder(requestParameters: QueryOrderRequest): Promise>; /** * Close out a user data stream. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Close User Data Stream (USER_STREAM) * @param {CloseUserDataStreamRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/user-data-streams#close-user-data-stream Binance API Documentation} */ closeUserDataStream(requestParameters?: CloseUserDataStreamRequest): Promise>; /** * Keepalive a user data stream to prevent a time out. User data streams * will close after 60 minutes. It's recommended to send a ping about every * 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Keepalive User Data Stream (USER_STREAM) * @param {KeepaliveUserDataStreamRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/user-data-streams#keepalive-user-data-stream Binance API Documentation} */ keepaliveUserDataStream(requestParameters?: KeepaliveUserDataStreamRequest): Promise>; /** * Start a new user data stream. The stream will close after 60 minutes * unless a keepalive is sent. If the account has an active `listenKey`, * that `listenKey` will be returned and its validity will be extended for * 60 minutes. * * Weight(IP): 1 * * Security Type: USER_STREAM * * @summary Start User Data Stream (USER_STREAM) * @param {StartUserDataStreamRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-api/user-data-streams#start-user-data-stream Binance API Documentation} */ startUserDataStream(requestParameters?: StartUserDataStreamRequest): Promise>; } //#endregion //#region src/websocket-api/websocket-api.d.ts declare class WebsocketAPI { private configuration; constructor(configuration: ConfigurationWebsocketAPI); /** * Connects to the Binance WebSocket API and returns a `WebsocketAPIConnection` instance. * * @param {object} [options] - Optional connection options. * @param {string} [options.mode='single'] - The connection mode, either 'single' or 'pool'. Overrides the `mode` property in the configuration. * @param {number} [options.poolSize=1] - The number of connections to use in pool mode. Overrides the `poolSize` property in the configuration. * @returns {Promise} - A promise that resolves to a `WebsocketAPIConnection` instance. */ connect({ mode, poolSize }?: { mode?: 'single' | 'pool'; poolSize?: number; }): Promise; } declare namespace index_d_exports$1 { export { AccountApi, AccountApiInterface, AccountInformationRequest, AccountInformationResponse, AccountInformationResponseRateLimitsInner, AccountInformationResponseResult, AccountInformationResponseResultAssetsInner, AccountInformationResponseResultPositionsInner, CancelOrderRequest, CancelOrderResponse, CancelOrderResponseRateLimitsInner, CancelOrderResponseResult, CloseUserDataStreamRequest, CloseUserDataStreamResponse, CloseUserDataStreamResponseRateLimitsInner, FuturesAccountBalanceRequest, FuturesAccountBalanceResponse, FuturesAccountBalanceResponseResultInner, KeepaliveUserDataStreamRequest, KeepaliveUserDataStreamResponse, KeepaliveUserDataStreamResponseResult, ModifyOrderPriceMatchEnum, ModifyOrderRequest, ModifyOrderResponse, ModifyOrderResponseResult, ModifyOrderSideEnum, NewOrderClosePositionEnum, NewOrderNewOrderRespTypeEnum, NewOrderPositionSideEnum, NewOrderPriceMatchEnum, NewOrderPriceProtectEnum, NewOrderReduceOnlyEnum, NewOrderRequest, NewOrderResponse, NewOrderResponseResult, NewOrderSelfTradePreventionModeEnum, NewOrderSideEnum, NewOrderTimeInForceEnum, NewOrderTypeEnum, NewOrderWorkingTypeEnum, PositionInformationRequest, PositionInformationResponse, PositionInformationResponseResultInner, QueryOrderRequest, QueryOrderResponse, QueryOrderResponseResult, StartUserDataStreamRequest, StartUserDataStreamResponse, StartUserDataStreamResponseResult, TradeApi, TradeApiInterface, UserDataStreamsApi, UserDataStreamsApiInterface, WebsocketAPI, WebsocketAPIConnection }; } //#endregion //#region src/websocket-streams/types/account-config-update-ac.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AccountConfigUpdateAc */ interface AccountConfigUpdateAc { /** * Symbol * @type {string} * @memberof AccountConfigUpdateAc */ s?: string; /** * Leverage * @type {number | bigint} * @memberof AccountConfigUpdateAc */ l?: number | bigint; } //#endregion //#region src/websocket-streams/types/account-config-update.d.ts /** * * @export * @interface AccountConfigUpdate */ interface AccountConfigUpdate { /** * Event Time * @type {number | bigint} * @memberof AccountConfigUpdate */ E?: number | bigint; /** * Transaction Time * @type {number | bigint} * @memberof AccountConfigUpdate */ T?: number | bigint; /** * * @type {AccountConfigUpdateAc} * @memberof AccountConfigUpdate */ ac?: AccountConfigUpdateAc; } //#endregion //#region src/websocket-streams/types/account-update-abinner.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AccountUpdateABInner */ interface AccountUpdateABInner { /** * Asset * @type {string} * @memberof AccountUpdateABInner */ a?: string; /** * Wallet Balance * @type {string} * @memberof AccountUpdateABInner */ wb?: string; /** * Cross Wallet Balance * @type {string} * @memberof AccountUpdateABInner */ cw?: string; /** * Balance Change except PnL and Commission * @type {string} * @memberof AccountUpdateABInner */ bc?: string; } //#endregion //#region src/websocket-streams/types/account-update-apinner.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AccountUpdateAPInner */ interface AccountUpdateAPInner { /** * Symbol * @type {string} * @memberof AccountUpdateAPInner */ s?: string; /** * Position Amount * @type {string} * @memberof AccountUpdateAPInner */ pa?: string; /** * Entry Price * @type {string} * @memberof AccountUpdateAPInner */ ep?: string; /** * Break-Even Price * @type {string} * @memberof AccountUpdateAPInner */ bep?: string; /** * (Pre-fee) Accumulated Realized * @type {string} * @memberof AccountUpdateAPInner */ cr?: string; /** * Unrealized PnL * @type {string} * @memberof AccountUpdateAPInner */ up?: string; /** * Margin Type * @type {string} * @memberof AccountUpdateAPInner */ mt?: string; /** * Isolated Wallet (if isolated position) * @type {string} * @memberof AccountUpdateAPInner */ iw?: string; /** * Position Side * @type {string} * @memberof AccountUpdateAPInner */ ps?: string; } //#endregion //#region src/websocket-streams/types/account-update-a.d.ts /** * Update Data * @export * @interface AccountUpdateA */ interface AccountUpdateA { /** * Event reason type * @type {string} * @memberof AccountUpdateA */ m?: string; /** * Balances * @type {Array} * @memberof AccountUpdateA */ B?: Array; /** * * @type {Array} * @memberof AccountUpdateA */ P?: Array; } //#endregion //#region src/websocket-streams/types/account-update.d.ts /** * * @export * @interface AccountUpdate */ interface AccountUpdate { /** * Event Time * @type {number | bigint} * @memberof AccountUpdate */ E?: number | bigint; /** * Transaction * @type {number | bigint} * @memberof AccountUpdate */ T?: number | bigint; /** * Account Alias * @type {string} * @memberof AccountUpdate */ i?: string; /** * * @type {AccountUpdateA} * @memberof AccountUpdate */ a?: AccountUpdateA; } //#endregion //#region src/websocket-streams/types/aggregate-trade-streams-response.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AggregateTradeStreamsResponse */ interface AggregateTradeStreamsResponse { /** * Event type * @type {string} * @memberof AggregateTradeStreamsResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof AggregateTradeStreamsResponse */ E?: number | bigint; /** * Aggregate trade ID * @type {number | bigint} * @memberof AggregateTradeStreamsResponse */ a?: number | bigint; /** * Symbol * @type {string} * @memberof AggregateTradeStreamsResponse */ s?: string; /** * Price * @type {string} * @memberof AggregateTradeStreamsResponse */ p?: string; /** * Quantity * @type {string} * @memberof AggregateTradeStreamsResponse */ q?: string; /** * First trade ID * @type {number | bigint} * @memberof AggregateTradeStreamsResponse */ f?: number | bigint; /** * Last trade ID * @type {number | bigint} * @memberof AggregateTradeStreamsResponse */ l?: number | bigint; /** * Trade time * @type {number | bigint} * @memberof AggregateTradeStreamsResponse */ T?: number | bigint; /** * Is the buyer the market maker? * @type {boolean} * @memberof AggregateTradeStreamsResponse */ m?: boolean; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof AggregateTradeStreamsResponse */ st?: number; } //#endregion //#region src/websocket-streams/types/all-book-tickers-stream-response.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AllBookTickersStreamResponse */ interface AllBookTickersStreamResponse { /** * Event type * @type {string} * @memberof AllBookTickersStreamResponse */ e?: string; /** * Order book update Id * @type {number | bigint} * @memberof AllBookTickersStreamResponse */ u?: number | bigint; /** * Symbol * @type {string} * @memberof AllBookTickersStreamResponse */ s?: string; /** * Best bid price * @type {string} * @memberof AllBookTickersStreamResponse */ b?: string; /** * Best bid qty * @type {string} * @memberof AllBookTickersStreamResponse */ B?: string; /** * Best ask price * @type {string} * @memberof AllBookTickersStreamResponse */ a?: string; /** * Best ask qty * @type {string} * @memberof AllBookTickersStreamResponse */ A?: string; /** * Transaction time * @type {number | bigint} * @memberof AllBookTickersStreamResponse */ T?: number | bigint; /** * Event time * @type {number | bigint} * @memberof AllBookTickersStreamResponse */ E?: number | bigint; /** * Pair * @type {string} * @memberof AllBookTickersStreamResponse */ ps?: string; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof AllBookTickersStreamResponse */ st?: number; } //#endregion //#region src/websocket-streams/types/all-market-liquidation-order-streams-response-o.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Order Type * @export * @interface AllMarketLiquidationOrderStreamsResponseO */ interface AllMarketLiquidationOrderStreamsResponseO { /** * Symbol * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ s?: string; /** * Pair * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ ps?: string; /** * Side * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ S?: string; /** * Order Type * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ o?: string; /** * Time in Force * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ f?: string; /** * Original Quantity * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ q?: string; /** * Price * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ p?: string; /** * Average Price * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ ap?: string; /** * Order Status * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ X?: string; /** * Order Last Filled Quantity * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ l?: string; /** * Order Filled Accumulated Quantity * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponseO */ z?: string; /** * Order Trade Time * @type {number | bigint} * @memberof AllMarketLiquidationOrderStreamsResponseO */ T?: number | bigint; } //#endregion //#region src/websocket-streams/types/all-market-liquidation-order-streams-response.d.ts /** * * @export * @interface AllMarketLiquidationOrderStreamsResponse */ interface AllMarketLiquidationOrderStreamsResponse { /** * Event Type * @type {string} * @memberof AllMarketLiquidationOrderStreamsResponse */ e?: string; /** * Event Time * @type {number | bigint} * @memberof AllMarketLiquidationOrderStreamsResponse */ E?: number | bigint; /** * * @type {AllMarketLiquidationOrderStreamsResponseO} * @memberof AllMarketLiquidationOrderStreamsResponse */ o?: AllMarketLiquidationOrderStreamsResponseO; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof AllMarketLiquidationOrderStreamsResponse */ st?: number; } //#endregion //#region src/websocket-streams/types/all-market-mini-tickers-stream-response-inner.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AllMarketMiniTickersStreamResponseInner */ interface AllMarketMiniTickersStreamResponseInner { /** * Event type * @type {string} * @memberof AllMarketMiniTickersStreamResponseInner */ e?: string; /** * Event time * @type {number | bigint} * @memberof AllMarketMiniTickersStreamResponseInner */ E?: number | bigint; /** * Symbol * @type {string} * @memberof AllMarketMiniTickersStreamResponseInner */ s?: string; /** * Pair * @type {string} * @memberof AllMarketMiniTickersStreamResponseInner */ ps?: string; /** * Close price * @type {string} * @memberof AllMarketMiniTickersStreamResponseInner */ c?: string; /** * Open price * @type {string} * @memberof AllMarketMiniTickersStreamResponseInner */ o?: string; /** * High price * @type {string} * @memberof AllMarketMiniTickersStreamResponseInner */ h?: string; /** * Low price * @type {string} * @memberof AllMarketMiniTickersStreamResponseInner */ l?: string; /** * Total traded volume * @type {string} * @memberof AllMarketMiniTickersStreamResponseInner */ v?: string; /** * Total traded base asset volume * @type {string} * @memberof AllMarketMiniTickersStreamResponseInner */ q?: string; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof AllMarketMiniTickersStreamResponseInner */ st?: number; } //#endregion //#region src/websocket-streams/types/all-market-mini-tickers-stream-response.d.ts /** * * @export * @interface AllMarketMiniTickersStreamResponse */ interface AllMarketMiniTickersStreamResponse extends Array {} //#endregion //#region src/websocket-streams/types/all-market-tickers-streams-response-inner.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AllMarketTickersStreamsResponseInner */ interface AllMarketTickersStreamsResponseInner { /** * Event type * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ e?: string; /** * Event time * @type {number | bigint} * @memberof AllMarketTickersStreamsResponseInner */ E?: number | bigint; /** * Symbol * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ s?: string; /** * Price change * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ p?: string; /** * Price change percent * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ P?: string; /** * Weighted average price * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ w?: string; /** * Last price * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ c?: string; /** * Last quantity * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ Q?: string; /** * Open price * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ o?: string; /** * High price * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ h?: string; /** * Low price * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ l?: string; /** * Total traded volume * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ v?: string; /** * Total traded base asset volume * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ q?: string; /** * Statistics open time * @type {number | bigint} * @memberof AllMarketTickersStreamsResponseInner */ O?: number | bigint; /** * Statistics close time * @type {number | bigint} * @memberof AllMarketTickersStreamsResponseInner */ C?: number | bigint; /** * First trade ID * @type {number | bigint} * @memberof AllMarketTickersStreamsResponseInner */ F?: number | bigint; /** * Last trade Id * @type {number | bigint} * @memberof AllMarketTickersStreamsResponseInner */ L?: number | bigint; /** * Total number of trades * @type {number | bigint} * @memberof AllMarketTickersStreamsResponseInner */ n?: number | bigint; /** * Pair * @type {string} * @memberof AllMarketTickersStreamsResponseInner */ ps?: string; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof AllMarketTickersStreamsResponseInner */ st?: number; } //#endregion //#region src/websocket-streams/types/all-market-tickers-streams-response.d.ts /** * * @export * @interface AllMarketTickersStreamsResponse */ interface AllMarketTickersStreamsResponse extends Array {} //#endregion //#region src/websocket-streams/types/continuous-contract-kline-candlestick-streams-response-k.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Kline payload * @export * @interface ContinuousContractKlineCandlestickStreamsResponseK */ interface ContinuousContractKlineCandlestickStreamsResponseK { /** * Kline start time * @type {number | bigint} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ t?: number | bigint; /** * transactionTime * @type {number | bigint} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ T?: number | bigint; /** * interval * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ i?: string; /** * First update ID * @type {number | bigint} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ f?: number | bigint; /** * Last update ID * @type {number | bigint} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ L?: number | bigint; /** * openPrice * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ o?: string; /** * closePrice * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ c?: string; /** * highPrice * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ h?: string; /** * lowPrice * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ l?: string; /** * volume * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ v?: string; /** * tradeNum * @type {number | bigint} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ n?: number | bigint; /** * Is this kline closed? * @type {boolean} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ x?: boolean; /** * quoteVolume * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ q?: string; /** * Taker buy volume * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ V?: string; /** * lastTradeVolume * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ Q?: string; /** * Best bid qty * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponseK */ B?: string; } //#endregion //#region src/websocket-streams/types/continuous-contract-kline-candlestick-streams-response.d.ts /** * * @export * @interface ContinuousContractKlineCandlestickStreamsResponse */ interface ContinuousContractKlineCandlestickStreamsResponse { /** * eventType * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponse */ e?: string; /** * eventTime * @type {number | bigint} * @memberof ContinuousContractKlineCandlestickStreamsResponse */ E?: number | bigint; /** * Pair * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponse */ ps?: string; /** * Contract type * @type {string} * @memberof ContinuousContractKlineCandlestickStreamsResponse */ ct?: string; /** * * @type {ContinuousContractKlineCandlestickStreamsResponseK} * @memberof ContinuousContractKlineCandlestickStreamsResponse */ k?: ContinuousContractKlineCandlestickStreamsResponseK; } //#endregion //#region src/websocket-streams/types/contract-info-stream-response-bks-inner.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ContractInfoStreamResponseBksInner */ interface ContractInfoStreamResponseBksInner { /** * Notional bracket * @type {number | bigint} * @memberof ContractInfoStreamResponseBksInner */ bs?: number | bigint; /** * Floor notional of this bracket * @type {number | bigint} * @memberof ContractInfoStreamResponseBksInner */ bnf?: number | bigint; /** * Cap notional of this bracket * @type {number | bigint} * @memberof ContractInfoStreamResponseBksInner */ bnc?: number | bigint; /** * Maintenance ratio for this bracket * @type {number} * @memberof ContractInfoStreamResponseBksInner */ mmr?: number; /** * Auxiliary number for quick calculation * @type {number | bigint} * @memberof ContractInfoStreamResponseBksInner */ cf?: number | bigint; /** * Min leverage for this bracket * @type {number | bigint} * @memberof ContractInfoStreamResponseBksInner */ mi?: number | bigint; /** * Max leverage for this bracket * @type {number | bigint} * @memberof ContractInfoStreamResponseBksInner */ ma?: number | bigint; } //#endregion //#region src/websocket-streams/types/contract-info-stream-response.d.ts /** * * @export * @interface ContractInfoStreamResponse */ interface ContractInfoStreamResponse { /** * Event Type * @type {string} * @memberof ContractInfoStreamResponse */ e?: string; /** * Event Time * @type {number | bigint} * @memberof ContractInfoStreamResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof ContractInfoStreamResponse */ s?: string; /** * Pair * @type {string} * @memberof ContractInfoStreamResponse */ ps?: string; /** * Contract type * @type {string} * @memberof ContractInfoStreamResponse */ ct?: string; /** * Delivery date time * @type {number | bigint} * @memberof ContractInfoStreamResponse */ dt?: number | bigint; /** * onboard date time * @type {number | bigint} * @memberof ContractInfoStreamResponse */ ot?: number | bigint; /** * Contract status * @type {string} * @memberof ContractInfoStreamResponse */ cs?: string; /** * Bracket list. * @type {Array} * @memberof ContractInfoStreamResponse */ bks?: Array; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof ContractInfoStreamResponse */ st?: number; } //#endregion //#region src/websocket-streams/types/diff-book-depth-streams-response.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface DiffBookDepthStreamsResponse */ interface DiffBookDepthStreamsResponse { /** * Event type * @type {string} * @memberof DiffBookDepthStreamsResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof DiffBookDepthStreamsResponse */ E?: number | bigint; /** * Transction time * @type {number | bigint} * @memberof DiffBookDepthStreamsResponse */ T?: number | bigint; /** * Symbol * @type {string} * @memberof DiffBookDepthStreamsResponse */ s?: string; /** * Pair * @type {string} * @memberof DiffBookDepthStreamsResponse */ ps?: string; /** * First update ID in event * @type {number | bigint} * @memberof DiffBookDepthStreamsResponse */ U?: number | bigint; /** * Final update ID in event * @type {number | bigint} * @memberof DiffBookDepthStreamsResponse */ u?: number | bigint; /** * Final update Id in last stream(ie `u` in last stream) * @type {number | bigint} * @memberof DiffBookDepthStreamsResponse */ pu?: number | bigint; /** * Bids to be updated * @type {Array>} * @memberof DiffBookDepthStreamsResponse */ b?: Array>; /** * Asks to be updated * @type {Array>} * @memberof DiffBookDepthStreamsResponse */ a?: Array>; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof DiffBookDepthStreamsResponse */ st?: number; } //#endregion //#region src/websocket-streams/types/grid-update-gu.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GridUpdateGu */ interface GridUpdateGu { /** * Strategy ID * @type {number | bigint} * @memberof GridUpdateGu */ si?: number | bigint; /** * Strategy Type * @type {string} * @memberof GridUpdateGu */ st?: string; /** * Strategy Status * @type {string} * @memberof GridUpdateGu */ ss?: string; /** * Symbol * @type {string} * @memberof GridUpdateGu */ s?: string; /** * Realized PNL * @type {string} * @memberof GridUpdateGu */ r?: string; /** * Unmatched Average Price * @type {string} * @memberof GridUpdateGu */ up?: string; /** * Unmatched Qty * @type {string} * @memberof GridUpdateGu */ uq?: string; /** * Unmatched Fee * @type {string} * @memberof GridUpdateGu */ uf?: string; /** * Matched PNL * @type {string} * @memberof GridUpdateGu */ mp?: string; /** * Update Time * @type {number | bigint} * @memberof GridUpdateGu */ ut?: number | bigint; } //#endregion //#region src/websocket-streams/types/grid-update.d.ts /** * * @export * @interface GridUpdate */ interface GridUpdate { /** * Transaction Time * @type {number | bigint} * @memberof GridUpdate */ T?: number | bigint; /** * Event Time * @type {number | bigint} * @memberof GridUpdate */ E?: number | bigint; /** * * @type {GridUpdateGu} * @memberof GridUpdate */ gu?: GridUpdateGu; } //#endregion //#region src/websocket-streams/types/index-kline-candlestick-streams-response-k.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Kline payload * @export * @interface IndexKlineCandlestickStreamsResponseK */ interface IndexKlineCandlestickStreamsResponseK { /** * Kline start time * @type {number | bigint} * @memberof IndexKlineCandlestickStreamsResponseK */ t?: number | bigint; /** * transactionTime * @type {number | bigint} * @memberof IndexKlineCandlestickStreamsResponseK */ T?: number | bigint; /** * symbol * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ s?: string; /** * interval * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ i?: string; /** * Ignore * @type {number | bigint} * @memberof IndexKlineCandlestickStreamsResponseK */ f?: number | bigint; /** * Ignore * @type {number | bigint} * @memberof IndexKlineCandlestickStreamsResponseK */ L?: number | bigint; /** * openPrice * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ o?: string; /** * closePrice * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ c?: string; /** * highPrice * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ h?: string; /** * lowPrice * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ l?: string; /** * volume * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ v?: string; /** * tradeNum * @type {number | bigint} * @memberof IndexKlineCandlestickStreamsResponseK */ n?: number | bigint; /** * Is this kline closed? * @type {boolean} * @memberof IndexKlineCandlestickStreamsResponseK */ x?: boolean; /** * quoteVolume * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ q?: string; /** * Taker buy volume * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ V?: string; /** * lastTradeVolume * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ Q?: string; /** * Best bid qty * @type {string} * @memberof IndexKlineCandlestickStreamsResponseK */ B?: string; } //#endregion //#region src/websocket-streams/types/index-kline-candlestick-streams-response.d.ts /** * * @export * @interface IndexKlineCandlestickStreamsResponse */ interface IndexKlineCandlestickStreamsResponse { /** * eventType * @type {string} * @memberof IndexKlineCandlestickStreamsResponse */ e?: string; /** * eventTime * @type {number | bigint} * @memberof IndexKlineCandlestickStreamsResponse */ E?: number | bigint; /** * Pair * @type {string} * @memberof IndexKlineCandlestickStreamsResponse */ ps?: string; /** * * @type {IndexKlineCandlestickStreamsResponseK} * @memberof IndexKlineCandlestickStreamsResponse */ k?: IndexKlineCandlestickStreamsResponseK; } //#endregion //#region src/websocket-streams/types/index-price-stream-response.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface IndexPriceStreamResponse */ interface IndexPriceStreamResponse { /** * Event type * @type {string} * @memberof IndexPriceStreamResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof IndexPriceStreamResponse */ E?: number | bigint; /** * Pair * @type {string} * @memberof IndexPriceStreamResponse */ i?: string; /** * Index Price * @type {string} * @memberof IndexPriceStreamResponse */ p?: string; } //#endregion //#region src/websocket-streams/types/individual-symbol-book-ticker-streams-response.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface IndividualSymbolBookTickerStreamsResponse */ interface IndividualSymbolBookTickerStreamsResponse { /** * Event type * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ e?: string; /** * Order book update Id * @type {number | bigint} * @memberof IndividualSymbolBookTickerStreamsResponse */ u?: number | bigint; /** * Symbol * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ s?: string; /** * Best bid price * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ b?: string; /** * Best bid qty * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ B?: string; /** * Best ask price * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ a?: string; /** * Best ask qty * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ A?: string; /** * Transaction time * @type {number | bigint} * @memberof IndividualSymbolBookTickerStreamsResponse */ T?: number | bigint; /** * Event time * @type {number | bigint} * @memberof IndividualSymbolBookTickerStreamsResponse */ E?: number | bigint; /** * Pair * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ ps?: string; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof IndividualSymbolBookTickerStreamsResponse */ st?: number; } //#endregion //#region src/websocket-streams/types/individual-symbol-mini-ticker-stream-response.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface IndividualSymbolMiniTickerStreamResponse */ interface IndividualSymbolMiniTickerStreamResponse { /** * Event type * @type {string} * @memberof IndividualSymbolMiniTickerStreamResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof IndividualSymbolMiniTickerStreamResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof IndividualSymbolMiniTickerStreamResponse */ s?: string; /** * Pair * @type {string} * @memberof IndividualSymbolMiniTickerStreamResponse */ ps?: string; /** * Close price * @type {string} * @memberof IndividualSymbolMiniTickerStreamResponse */ c?: string; /** * Open price * @type {string} * @memberof IndividualSymbolMiniTickerStreamResponse */ o?: string; /** * High price * @type {string} * @memberof IndividualSymbolMiniTickerStreamResponse */ h?: string; /** * Low price * @type {string} * @memberof IndividualSymbolMiniTickerStreamResponse */ l?: string; /** * Total traded volume * @type {string} * @memberof IndividualSymbolMiniTickerStreamResponse */ v?: string; /** * Total traded base asset volume * @type {string} * @memberof IndividualSymbolMiniTickerStreamResponse */ q?: string; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof IndividualSymbolMiniTickerStreamResponse */ st?: number; } //#endregion //#region src/websocket-streams/types/individual-symbol-ticker-streams-response.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface IndividualSymbolTickerStreamsResponse */ interface IndividualSymbolTickerStreamsResponse { /** * Event type * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof IndividualSymbolTickerStreamsResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ s?: string; /** * Price change * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ p?: string; /** * Price change percent * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ P?: string; /** * Weighted average price * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ w?: string; /** * Last price * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ c?: string; /** * Last quantity * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ Q?: string; /** * Open price * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ o?: string; /** * High price * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ h?: string; /** * Low price * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ l?: string; /** * Total traded volume * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ v?: string; /** * Total traded base asset volume * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ q?: string; /** * Statistics open time * @type {number | bigint} * @memberof IndividualSymbolTickerStreamsResponse */ O?: number | bigint; /** * Statistics close time * @type {number | bigint} * @memberof IndividualSymbolTickerStreamsResponse */ C?: number | bigint; /** * First trade ID * @type {number | bigint} * @memberof IndividualSymbolTickerStreamsResponse */ F?: number | bigint; /** * Last trade Id * @type {number | bigint} * @memberof IndividualSymbolTickerStreamsResponse */ L?: number | bigint; /** * Total number of trades * @type {number | bigint} * @memberof IndividualSymbolTickerStreamsResponse */ n?: number | bigint; /** * Pair * @type {string} * @memberof IndividualSymbolTickerStreamsResponse */ ps?: string; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof IndividualSymbolTickerStreamsResponse */ st?: number; } //#endregion //#region src/websocket-streams/types/kline-candlestick-streams-response-k.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Kline payload * @export * @interface KlineCandlestickStreamsResponseK */ interface KlineCandlestickStreamsResponseK { /** * Kline start time * @type {number | bigint} * @memberof KlineCandlestickStreamsResponseK */ t?: number | bigint; /** * Kline close time * @type {number | bigint} * @memberof KlineCandlestickStreamsResponseK */ T?: number | bigint; /** * Symbol * @type {string} * @memberof KlineCandlestickStreamsResponseK */ s?: string; /** * Interval * @type {string} * @memberof KlineCandlestickStreamsResponseK */ i?: string; /** * First trade ID * @type {number | bigint} * @memberof KlineCandlestickStreamsResponseK */ f?: number | bigint; /** * Last trade ID * @type {number | bigint} * @memberof KlineCandlestickStreamsResponseK */ L?: number | bigint; /** * Open price * @type {string} * @memberof KlineCandlestickStreamsResponseK */ o?: string; /** * Close price * @type {string} * @memberof KlineCandlestickStreamsResponseK */ c?: string; /** * High price * @type {string} * @memberof KlineCandlestickStreamsResponseK */ h?: string; /** * Low price * @type {string} * @memberof KlineCandlestickStreamsResponseK */ l?: string; /** * volume * @type {string} * @memberof KlineCandlestickStreamsResponseK */ v?: string; /** * Number of trades * @type {number | bigint} * @memberof KlineCandlestickStreamsResponseK */ n?: number | bigint; /** * Is this kline closed? * @type {boolean} * @memberof KlineCandlestickStreamsResponseK */ x?: boolean; /** * Base asset volume * @type {string} * @memberof KlineCandlestickStreamsResponseK */ q?: string; /** * Taker buy volume * @type {string} * @memberof KlineCandlestickStreamsResponseK */ V?: string; /** * Taker buy base asset volume * @type {string} * @memberof KlineCandlestickStreamsResponseK */ Q?: string; /** * Ignore * @type {string} * @memberof KlineCandlestickStreamsResponseK */ B?: string; } //#endregion //#region src/websocket-streams/types/kline-candlestick-streams-response.d.ts /** * * @export * @interface KlineCandlestickStreamsResponse */ interface KlineCandlestickStreamsResponse { /** * Event type * @type {string} * @memberof KlineCandlestickStreamsResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof KlineCandlestickStreamsResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof KlineCandlestickStreamsResponse */ s?: string; /** * * @type {KlineCandlestickStreamsResponseK} * @memberof KlineCandlestickStreamsResponse */ k?: KlineCandlestickStreamsResponseK; } //#endregion //#region src/websocket-streams/types/listen-key-expired.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ListenKeyExpired */ interface ListenKeyExpired { /** * Event Time * @type {number | bigint} * @memberof ListenKeyExpired */ E?: number | bigint; /** * * @type {string} * @memberof ListenKeyExpired */ listenKey?: string; } //#endregion //#region src/websocket-streams/types/margin-call-pinner.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface MarginCallPInner */ interface MarginCallPInner { /** * Symbol * @type {string} * @memberof MarginCallPInner */ s?: string; /** * Position Side * @type {string} * @memberof MarginCallPInner */ ps?: string; /** * Position Amount * @type {string} * @memberof MarginCallPInner */ pa?: string; /** * Margin Type * @type {string} * @memberof MarginCallPInner */ mt?: string; /** * Isolated Wallet (if isolated position) * @type {string} * @memberof MarginCallPInner */ iw?: string; /** * Mark Price * @type {string} * @memberof MarginCallPInner */ mp?: string; /** * Unrealized PnL * @type {string} * @memberof MarginCallPInner */ up?: string; /** * Maintenance Margin Required * @type {string} * @memberof MarginCallPInner */ mm?: string; } //#endregion //#region src/websocket-streams/types/margin-call.d.ts /** * * @export * @interface MarginCall */ interface MarginCall { /** * Event Time * @type {number | bigint} * @memberof MarginCall */ E?: number | bigint; /** * Account Alias * @type {string} * @memberof MarginCall */ i?: string; /** * Cross Wallet Balance. Only pushed with crossed position margin call * @type {string} * @memberof MarginCall */ cw?: string; /** * Position(s) of Margin Call * @type {Array} * @memberof MarginCall */ p?: Array; } //#endregion //#region src/websocket-streams/types/mark-price-kline-candlestick-streams-response-k.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Kline payload * @export * @interface MarkPriceKlineCandlestickStreamsResponseK */ interface MarkPriceKlineCandlestickStreamsResponseK { /** * Kline start time * @type {number | bigint} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ t?: number | bigint; /** * Kline close time * @type {number | bigint} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ T?: number | bigint; /** * Symbol * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ s?: string; /** * Interval * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ i?: string; /** * ignore * @type {number | bigint} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ f?: number | bigint; /** * ignore * @type {number | bigint} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ L?: number | bigint; /** * Open price * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ o?: string; /** * Close price * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ c?: string; /** * High price * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ h?: string; /** * Low price * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ l?: string; /** * ignore * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ v?: string; /** * Number of basic data * @type {number | bigint} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ n?: number | bigint; /** * Is this kline closed? * @type {boolean} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ x?: boolean; /** * ignore * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ q?: string; /** * ignore * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ V?: string; /** * ignore * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ Q?: string; /** * ignore * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponseK */ B?: string; } //#endregion //#region src/websocket-streams/types/mark-price-kline-candlestick-streams-response.d.ts /** * * @export * @interface MarkPriceKlineCandlestickStreamsResponse */ interface MarkPriceKlineCandlestickStreamsResponse { /** * Event Name * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponse */ e?: string; /** * Event Time * @type {number | bigint} * @memberof MarkPriceKlineCandlestickStreamsResponse */ E?: number | bigint; /** * Pair * @type {string} * @memberof MarkPriceKlineCandlestickStreamsResponse */ ps?: string; /** * * @type {MarkPriceKlineCandlestickStreamsResponseK} * @memberof MarkPriceKlineCandlestickStreamsResponse */ k?: MarkPriceKlineCandlestickStreamsResponseK; } //#endregion //#region src/websocket-streams/types/mark-price-of-all-symbols-of-apair-response-inner.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface MarkPriceOfAllSymbolsOfAPairResponseInner */ interface MarkPriceOfAllSymbolsOfAPairResponseInner { /** * Event type * @type {string} * @memberof MarkPriceOfAllSymbolsOfAPairResponseInner */ e?: string; /** * Event time * @type {number | bigint} * @memberof MarkPriceOfAllSymbolsOfAPairResponseInner */ E?: number | bigint; /** * Symbol * @type {string} * @memberof MarkPriceOfAllSymbolsOfAPairResponseInner */ s?: string; /** * Mark Price * @type {string} * @memberof MarkPriceOfAllSymbolsOfAPairResponseInner */ p?: string; /** * Estimated Settle Price, only useful in the last hour before the settlement starts. * @type {string} * @memberof MarkPriceOfAllSymbolsOfAPairResponseInner */ P?: string; /** * Index Price * @type {string} * @memberof MarkPriceOfAllSymbolsOfAPairResponseInner */ i?: string; /** * funding rate for perpetual symbol, \"\" will be shown for delivery symbol * @type {string} * @memberof MarkPriceOfAllSymbolsOfAPairResponseInner */ r?: string; /** * next funding time for perpetual symbol, 0 will be shown for delivery symbol * @type {number | bigint} * @memberof MarkPriceOfAllSymbolsOfAPairResponseInner */ T?: number | bigint; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof MarkPriceOfAllSymbolsOfAPairResponseInner */ st?: number; } //#endregion //#region src/websocket-streams/types/mark-price-of-all-symbols-of-apair-response.d.ts /** * * @export * @interface MarkPriceOfAllSymbolsOfAPairResponse */ interface MarkPriceOfAllSymbolsOfAPairResponse extends Array {} //#endregion //#region src/websocket-streams/types/mark-price-stream-response.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface MarkPriceStreamResponse */ interface MarkPriceStreamResponse { /** * Event type * @type {string} * @memberof MarkPriceStreamResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof MarkPriceStreamResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof MarkPriceStreamResponse */ s?: string; /** * Mark Price * @type {string} * @memberof MarkPriceStreamResponse */ p?: string; /** * Estimated Settle Price, only useful in the last hour before the settlement starts. * @type {string} * @memberof MarkPriceStreamResponse */ P?: string; /** * Index Price * @type {string} * @memberof MarkPriceStreamResponse */ i?: string; /** * funding rate for perpetual symbol, \"\" will be shown for delivery symbol * @type {string} * @memberof MarkPriceStreamResponse */ r?: string; /** * next funding time for perpetual symbol, 0 will be shown for delivery symbol * @type {number | bigint} * @memberof MarkPriceStreamResponse */ T?: number | bigint; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof MarkPriceStreamResponse */ st?: number; } //#endregion //#region src/websocket-streams/types/market-liquidation-order-streams-response.d.ts /** * * @export * @interface MarketLiquidationOrderStreamsResponse */ interface MarketLiquidationOrderStreamsResponse { /** * Event Type * @type {string} * @memberof MarketLiquidationOrderStreamsResponse */ e?: string; /** * Event Time * @type {number | bigint} * @memberof MarketLiquidationOrderStreamsResponse */ E?: number | bigint; /** * * @type {AllMarketLiquidationOrderStreamsResponseO} * @memberof MarketLiquidationOrderStreamsResponse */ o?: AllMarketLiquidationOrderStreamsResponseO; } //#endregion //#region src/websocket-streams/types/order-trade-update-o.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface OrderTradeUpdateO */ interface OrderTradeUpdateO { /** * Symbol * @type {string} * @memberof OrderTradeUpdateO */ s?: string; /** * Client Order Id * @type {string} * @memberof OrderTradeUpdateO */ c?: string; /** * Side * @type {string} * @memberof OrderTradeUpdateO */ S?: string; /** * Order Type * @type {string} * @memberof OrderTradeUpdateO */ o?: string; /** * Time in Force * @type {string} * @memberof OrderTradeUpdateO */ f?: string; /** * Original Quantity * @type {string} * @memberof OrderTradeUpdateO */ q?: string; /** * Original Price * @type {string} * @memberof OrderTradeUpdateO */ p?: string; /** * Average Price * @type {string} * @memberof OrderTradeUpdateO */ ap?: string; /** * Stop Price. Please ignore with TRAILING_STOP_MARKET order * @type {string} * @memberof OrderTradeUpdateO */ sp?: string; /** * Execution Type * @type {string} * @memberof OrderTradeUpdateO */ x?: string; /** * Order Status * @type {string} * @memberof OrderTradeUpdateO */ X?: string; /** * Order Id * @type {number | bigint} * @memberof OrderTradeUpdateO */ i?: number | bigint; /** * modifyId, only pushed for AMENDMENT (order modification) events when a modifyId was provided in the request * @type {string} * @memberof OrderTradeUpdateO */ M?: string; /** * Order Last Filled Quantity * @type {string} * @memberof OrderTradeUpdateO */ l?: string; /** * Order Filled Accumulated Quantity * @type {string} * @memberof OrderTradeUpdateO */ z?: string; /** * Last Filled Price * @type {string} * @memberof OrderTradeUpdateO */ L?: string; /** * Margin Asset * @type {string} * @memberof OrderTradeUpdateO */ ma?: string; /** * Commission Asset * @type {string} * @memberof OrderTradeUpdateO */ N?: string; /** * Commission * @type {string} * @memberof OrderTradeUpdateO */ n?: string; /** * Order Trade Time * @type {number | bigint} * @memberof OrderTradeUpdateO */ T?: number | bigint; /** * Trade Id * @type {number | bigint} * @memberof OrderTradeUpdateO */ t?: number | bigint; /** * Realized Profit of the trade * @type {string} * @memberof OrderTradeUpdateO */ rp?: string; /** * Bid quantity of base asset * @type {string} * @memberof OrderTradeUpdateO */ b?: string; /** * Ask quantity of base asset * @type {string} * @memberof OrderTradeUpdateO */ a?: string; /** * Is this trade the maker side? * @type {boolean} * @memberof OrderTradeUpdateO */ m?: boolean; /** * Is this reduce only * @type {boolean} * @memberof OrderTradeUpdateO */ R?: boolean; /** * Stop Price Working Type * @type {string} * @memberof OrderTradeUpdateO */ wt?: string; /** * Original Order Type * @type {string} * @memberof OrderTradeUpdateO */ ot?: string; /** * Position Side * @type {string} * @memberof OrderTradeUpdateO */ ps?: string; /** * If Close-All, pushed with conditional order * @type {boolean} * @memberof OrderTradeUpdateO */ cp?: boolean; /** * Activation Price, only pushed with TRAILING_STOP_MARKET order * @type {string} * @memberof OrderTradeUpdateO */ AP?: string; /** * Callback Rate, only pushed with TRAILING_STOP_MARKET order * @type {string} * @memberof OrderTradeUpdateO */ cr?: string; /** * If conditional order trigger is protected * @type {boolean} * @memberof OrderTradeUpdateO */ pP?: boolean; /** * STP mode * @type {string} * @memberof OrderTradeUpdateO */ V?: string; /** * Price match mode * @type {string} * @memberof OrderTradeUpdateO */ pm?: string; /** * Expiry Reason * @type {string} * @memberof OrderTradeUpdateO */ er?: string; } //#endregion //#region src/websocket-streams/types/order-trade-update.d.ts /** * * @export * @interface OrderTradeUpdate */ interface OrderTradeUpdate { /** * Event Time * @type {number | bigint} * @memberof OrderTradeUpdate */ E?: number | bigint; /** * Transaction Time * @type {number | bigint} * @memberof OrderTradeUpdate */ T?: number | bigint; /** * Account Alias * @type {string} * @memberof OrderTradeUpdate */ i?: string; /** * * @type {OrderTradeUpdateO} * @memberof OrderTradeUpdate */ o?: OrderTradeUpdateO; } //#endregion //#region src/websocket-streams/types/partial-book-depth-streams-response.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface PartialBookDepthStreamsResponse */ interface PartialBookDepthStreamsResponse { /** * Event type * @type {string} * @memberof PartialBookDepthStreamsResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof PartialBookDepthStreamsResponse */ E?: number | bigint; /** * Transaction time * @type {number | bigint} * @memberof PartialBookDepthStreamsResponse */ T?: number | bigint; /** * Symbol * @type {string} * @memberof PartialBookDepthStreamsResponse */ s?: string; /** * Pair * @type {string} * @memberof PartialBookDepthStreamsResponse */ ps?: string; /** * First update ID in event * @type {number | bigint} * @memberof PartialBookDepthStreamsResponse */ U?: number | bigint; /** * updateId * @type {number | bigint} * @memberof PartialBookDepthStreamsResponse */ u?: number | bigint; /** * Final update Id in last stream(ie `u` in last stream) * @type {number | bigint} * @memberof PartialBookDepthStreamsResponse */ pu?: number | bigint; /** * Bids to be updated * @type {Array>} * @memberof PartialBookDepthStreamsResponse */ b?: Array>; /** * Asks to be updated * @type {Array>} * @memberof PartialBookDepthStreamsResponse */ a?: Array>; /** * (After CM migration) Symbol type: 1 = UM, 2 = CM * @type {number} * @memberof PartialBookDepthStreamsResponse */ st?: number; } //#endregion //#region src/websocket-streams/types/strategy-update-su.d.ts /** * Futures (COIN-M) WebSocket Market Streams * * Access market data, manage accounts, and trade COIN-M perpetual and delivery futures. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface StrategyUpdateSu */ interface StrategyUpdateSu { /** * Strategy ID * @type {number | bigint} * @memberof StrategyUpdateSu */ si?: number | bigint; /** * Strategy Type * @type {string} * @memberof StrategyUpdateSu */ st?: string; /** * Strategy Status * @type {string} * @memberof StrategyUpdateSu */ ss?: string; /** * Symbol * @type {string} * @memberof StrategyUpdateSu */ s?: string; /** * Update Time * @type {number | bigint} * @memberof StrategyUpdateSu */ ut?: number | bigint; /** * opCode * @type {number | bigint} * @memberof StrategyUpdateSu */ c?: number | bigint; } //#endregion //#region src/websocket-streams/types/strategy-update.d.ts /** * * @export * @interface StrategyUpdate */ interface StrategyUpdate { /** * Transaction Time * @type {number | bigint} * @memberof StrategyUpdate */ T?: number | bigint; /** * Event Time * @type {number | bigint} * @memberof StrategyUpdate */ E?: number | bigint; /** * * @type {StrategyUpdateSu} * @memberof StrategyUpdate */ su?: StrategyUpdateSu; } //#endregion //#region src/websocket-streams/types/user-data-stream-events-response.d.ts /** * @type UserDataStreamEventsResponse */ type UserDataStreamEventsResponse = ({ e: 'ACCOUNT_CONFIG_UPDATE'; } & AccountConfigUpdate) | ({ e: 'ACCOUNT_UPDATE'; } & AccountUpdate) | ({ e: 'GRID_UPDATE'; } & GridUpdate) | ({ e: 'MARGIN_CALL'; } & MarginCall) | ({ e: 'ORDER_TRADE_UPDATE'; } & OrderTradeUpdate) | ({ e: 'STRATEGY_UPDATE'; } & StrategyUpdate) | ({ e: 'listenKeyExpired'; } & ListenKeyExpired); //#endregion //#region src/websocket-streams/modules/api.d.ts /** * Api - interface * @interface Api */ interface ApiInterface { /** * The Aggregate Trade Streams push market trade information that is aggregated for fills with same price and taking side every 100 milliseconds. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 100ms * * @summary Aggregate Trade Streams * @param {AggregateTradeStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ aggregateTradeStreams(requestParameters: AggregateTradeStreamsRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in real-time for all symbols. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: Real-time * * @summary All Book Tickers Stream * @param {AllBookTickersStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ allBookTickersStream(requestParameters?: AllBookTickersStreamRequest): WebsocketStream; /** * The All Liquidation Order Snapshot Streams push force liquidation order information for all symbols in the market. For each symbol，only the latest one liquidation order within 1000ms will be pushed as the snapshot. If no liquidation happens in the interval of 1000ms, no stream will be pushed. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 1000ms * * @summary All Market Liquidation Order Streams * @param {AllMarketLiquidationOrderStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ allMarketLiquidationOrderStreams(requestParameters?: AllMarketLiquidationOrderStreamsRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics for all symbols. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. Note that only tickers that have changed will be present in the array. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 1000ms * * @summary All Market Mini Tickers Stream * @param {AllMarketMiniTickersStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ allMarketMiniTickersStream(requestParameters?: AllMarketMiniTickersStreamRequest): WebsocketStream; /** * 24hr rolling window ticker statistics for all symbols. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. Note that only tickers that have changed will be present in the array. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 1000ms * * @summary All Market Tickers Streams * @param {AllMarketTickersStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ allMarketTickersStreams(requestParameters?: AllMarketTickersStreamsRequest): WebsocketStream; /** * Kline update every second * * > **After CM migration**, both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 250ms * * @summary Continuous Contract Kline/Candlestick Streams * @param {ContinuousContractKlineCandlestickStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ continuousContractKlineCandlestickStreams(requestParameters: ContinuousContractKlineCandlestickStreamsRequest): WebsocketStream; /** * ContractInfo stream pushes when contract info updates(listing/settlement/contract bracket update). bks field only shows up when bracket gets updated. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: Real-time * * @summary Contract Info Stream * @param {ContractInfoStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ contractInfoStream(requestParameters?: ContractInfoStreamRequest): WebsocketStream; /** * Bids and asks, pushed every 250 milliseconds, 500 milliseconds, or 100 milliseconds * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 250ms or 500ms or 100ms * * @summary Diff. Book Depth Streams * @param {DiffBookDepthStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ diffBookDepthStreams(requestParameters: DiffBookDepthStreamsRequest): WebsocketStream; /** * Index Kline/Candlestick Streams * * > **After CM migration**, both `fstream` and `dstream` may subscribe to CM symbols on this stream. * * Update Speed: 250ms * * @summary Index Kline/Candlestick Streams * @param {IndexKlineCandlestickStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ indexKlineCandlestickStreams(requestParameters: IndexKlineCandlestickStreamsRequest): WebsocketStream; /** * Index Price Stream * * Update Speed: 3000ms OR 1000ms * * @summary Index Price Stream * @param {IndexPriceStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ indexPriceStream(requestParameters: IndexPriceStreamRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: Real-time * * @summary Individual Symbol Book Ticker Streams * @param {IndividualSymbolBookTickerStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ individualSymbolBookTickerStreams(requestParameters: IndividualSymbolBookTickerStreamsRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 500ms * * @summary Individual Symbol Mini Ticker Stream * @param {IndividualSymbolMiniTickerStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ individualSymbolMiniTickerStream(requestParameters: IndividualSymbolMiniTickerStreamRequest): WebsocketStream; /** * 24hr rolling window ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 500ms * * @summary Individual Symbol Ticker Streams * @param {IndividualSymbolTickerStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ individualSymbolTickerStreams(requestParameters: IndividualSymbolTickerStreamsRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current klines/candlestick every 250 milliseconds (if existing). * * > **After CM migration**, both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 250ms * * @summary Kline/Candlestick Streams * @param {KlineCandlestickStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ klineCandlestickStreams(requestParameters: KlineCandlestickStreamsRequest): WebsocketStream; /** * Mark Price Kline/Candlestick Streams * * > **After CM migration**, both `fstream` and `dstream` may subscribe to CM symbols on this stream. * * Update Speed: 250ms * * @summary Mark Price Kline/Candlestick Streams * @param {MarkPriceKlineCandlestickStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ markPriceKlineCandlestickStreams(requestParameters: MarkPriceKlineCandlestickStreamsRequest): WebsocketStream; /** * Mark Price of All Symbols of a Pair * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM); both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 3000ms OR 1000ms * * @summary Mark Price of All Symbols of a Pair * @param {MarkPriceOfAllSymbolsOfAPairRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ markPriceOfAllSymbolsOfAPair(requestParameters: MarkPriceOfAllSymbolsOfAPairRequest): WebsocketStream; /** * Mark price update stream * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM); both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 3000ms OR 1000ms * * @summary Mark Price Stream * @param {MarkPriceStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ markPriceStream(requestParameters: MarkPriceStreamRequest): WebsocketStream; /** * The Liquidation Order Snapshot Streams push force liquidation order information for specific symbol. For each symbol，only the latest one liquidation order within 1000ms will be pushed as the snapshot. If no liquidation happens in the interval of 1000ms, no stream will be pushed. * * Update Speed: 1000ms * * @summary Market Liquidation Order Streams * @param {MarketLiquidationOrderStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ marketLiquidationOrderStreams(requestParameters: MarketLiquidationOrderStreamsRequest): WebsocketStream; /** * Top levels bids and asks. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 250ms, 500ms or 100ms * * @summary Partial Book Depth Streams * @param {PartialBookDepthStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream; } /** * Request parameters for aggregateTradeStreams operation in Api. * @interface AggregateTradeStreamsRequest */ interface AggregateTradeStreamsRequest { /** * The symbol parameter * @type {string} * @memberof ApiAggregateTradeStreams */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiAggregateTradeStreams */ readonly id?: string; } /** * Request parameters for allBookTickersStream operation in Api. * @interface AllBookTickersStreamRequest */ interface AllBookTickersStreamRequest { /** * Unique WebSocket request ID. * @type {string} * @memberof ApiAllBookTickersStream */ readonly id?: string; } /** * Request parameters for allMarketLiquidationOrderStreams operation in Api. * @interface AllMarketLiquidationOrderStreamsRequest */ interface AllMarketLiquidationOrderStreamsRequest { /** * Unique WebSocket request ID. * @type {string} * @memberof ApiAllMarketLiquidationOrderStreams */ readonly id?: string; } /** * Request parameters for allMarketMiniTickersStream operation in Api. * @interface AllMarketMiniTickersStreamRequest */ interface AllMarketMiniTickersStreamRequest { /** * Unique WebSocket request ID. * @type {string} * @memberof ApiAllMarketMiniTickersStream */ readonly id?: string; } /** * Request parameters for allMarketTickersStreams operation in Api. * @interface AllMarketTickersStreamsRequest */ interface AllMarketTickersStreamsRequest { /** * Unique WebSocket request ID. * @type {string} * @memberof ApiAllMarketTickersStreams */ readonly id?: string; } /** * Request parameters for continuousContractKlineCandlestickStreams operation in Api. * @interface ContinuousContractKlineCandlestickStreamsRequest */ interface ContinuousContractKlineCandlestickStreamsRequest { /** * The pair parameter * @type {string} * @memberof ApiContinuousContractKlineCandlestickStreams */ readonly pair: string; /** * The contractType parameter * @type {'perpetual' | 'current_quarter' | 'next_quarter'} * @memberof ApiContinuousContractKlineCandlestickStreams */ readonly contractType: ContinuousContractKlineCandlestickStreamsContractTypeEnum; /** * The interval parameter * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof ApiContinuousContractKlineCandlestickStreams */ readonly interval: ContinuousContractKlineCandlestickStreamsIntervalEnum; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiContinuousContractKlineCandlestickStreams */ readonly id?: string; } /** * Request parameters for contractInfoStream operation in Api. * @interface ContractInfoStreamRequest */ interface ContractInfoStreamRequest { /** * Unique WebSocket request ID. * @type {string} * @memberof ApiContractInfoStream */ readonly id?: string; } /** * Request parameters for diffBookDepthStreams operation in Api. * @interface DiffBookDepthStreamsRequest */ interface DiffBookDepthStreamsRequest { /** * The symbol parameter * @type {string} * @memberof ApiDiffBookDepthStreams */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiDiffBookDepthStreams */ readonly id?: string; /** * WebSocket stream update speed * @type {'100ms' | '500ms'} * @memberof ApiDiffBookDepthStreams */ readonly updateSpeed?: DiffBookDepthStreamsUpdateSpeedEnum; } /** * Request parameters for indexKlineCandlestickStreams operation in Api. * @interface IndexKlineCandlestickStreamsRequest */ interface IndexKlineCandlestickStreamsRequest { /** * The pair parameter * @type {string} * @memberof ApiIndexKlineCandlestickStreams */ readonly pair: string; /** * The interval parameter * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof ApiIndexKlineCandlestickStreams */ readonly interval: IndexKlineCandlestickStreamsIntervalEnum; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiIndexKlineCandlestickStreams */ readonly id?: string; } /** * Request parameters for indexPriceStream operation in Api. * @interface IndexPriceStreamRequest */ interface IndexPriceStreamRequest { /** * The pair parameter * @type {string} * @memberof ApiIndexPriceStream */ readonly pair: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiIndexPriceStream */ readonly id?: string; /** * WebSocket stream update speed * @type {'1s'} * @memberof ApiIndexPriceStream */ readonly updateSpeed?: IndexPriceStreamUpdateSpeedEnum; } /** * Request parameters for individualSymbolBookTickerStreams operation in Api. * @interface IndividualSymbolBookTickerStreamsRequest */ interface IndividualSymbolBookTickerStreamsRequest { /** * The symbol parameter * @type {string} * @memberof ApiIndividualSymbolBookTickerStreams */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiIndividualSymbolBookTickerStreams */ readonly id?: string; } /** * Request parameters for individualSymbolMiniTickerStream operation in Api. * @interface IndividualSymbolMiniTickerStreamRequest */ interface IndividualSymbolMiniTickerStreamRequest { /** * The symbol parameter * @type {string} * @memberof ApiIndividualSymbolMiniTickerStream */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiIndividualSymbolMiniTickerStream */ readonly id?: string; } /** * Request parameters for individualSymbolTickerStreams operation in Api. * @interface IndividualSymbolTickerStreamsRequest */ interface IndividualSymbolTickerStreamsRequest { /** * The symbol parameter * @type {string} * @memberof ApiIndividualSymbolTickerStreams */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiIndividualSymbolTickerStreams */ readonly id?: string; } /** * Request parameters for klineCandlestickStreams operation in Api. * @interface KlineCandlestickStreamsRequest */ interface KlineCandlestickStreamsRequest { /** * The symbol parameter * @type {string} * @memberof ApiKlineCandlestickStreams */ readonly symbol: string; /** * The interval parameter * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof ApiKlineCandlestickStreams */ readonly interval: KlineCandlestickStreamsIntervalEnum; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiKlineCandlestickStreams */ readonly id?: string; } /** * Request parameters for markPriceKlineCandlestickStreams operation in Api. * @interface MarkPriceKlineCandlestickStreamsRequest */ interface MarkPriceKlineCandlestickStreamsRequest { /** * The symbol parameter * @type {string} * @memberof ApiMarkPriceKlineCandlestickStreams */ readonly symbol: string; /** * The interval parameter * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof ApiMarkPriceKlineCandlestickStreams */ readonly interval: MarkPriceKlineCandlestickStreamsIntervalEnum; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiMarkPriceKlineCandlestickStreams */ readonly id?: string; } /** * Request parameters for markPriceOfAllSymbolsOfAPair operation in Api. * @interface MarkPriceOfAllSymbolsOfAPairRequest */ interface MarkPriceOfAllSymbolsOfAPairRequest { /** * The pair parameter * @type {string} * @memberof ApiMarkPriceOfAllSymbolsOfAPair */ readonly pair: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiMarkPriceOfAllSymbolsOfAPair */ readonly id?: string; /** * WebSocket stream update speed * @type {'1s'} * @memberof ApiMarkPriceOfAllSymbolsOfAPair */ readonly updateSpeed?: MarkPriceOfAllSymbolsOfAPairUpdateSpeedEnum; } /** * Request parameters for markPriceStream operation in Api. * @interface MarkPriceStreamRequest */ interface MarkPriceStreamRequest { /** * The symbol parameter * @type {string} * @memberof ApiMarkPriceStream */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiMarkPriceStream */ readonly id?: string; /** * WebSocket stream update speed * @type {'1s'} * @memberof ApiMarkPriceStream */ readonly updateSpeed?: MarkPriceStreamUpdateSpeedEnum; } /** * Request parameters for marketLiquidationOrderStreams operation in Api. * @interface MarketLiquidationOrderStreamsRequest */ interface MarketLiquidationOrderStreamsRequest { /** * The symbol parameter * @type {string} * @memberof ApiMarketLiquidationOrderStreams */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiMarketLiquidationOrderStreams */ readonly id?: string; } /** * Request parameters for partialBookDepthStreams operation in Api. * @interface PartialBookDepthStreamsRequest */ interface PartialBookDepthStreamsRequest { /** * The symbol parameter * @type {string} * @memberof ApiPartialBookDepthStreams */ readonly symbol: string; /** * The levels parameter * @type {'5' | '10' | '20'} * @memberof ApiPartialBookDepthStreams */ readonly levels: PartialBookDepthStreamsLevelsEnum; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiPartialBookDepthStreams */ readonly id?: string; /** * WebSocket stream update speed * @type {'100ms' | '500ms'} * @memberof ApiPartialBookDepthStreams */ readonly updateSpeed?: PartialBookDepthStreamsUpdateSpeedEnum; } /** * Api - interface * @class Api * @extends {WebsocketStreamsBase} */ declare class Api implements ApiInterface { private readonly websocketBase; private localVarParamCreator; constructor(websocketBase: WebsocketStreamsBase); /** * The Aggregate Trade Streams push market trade information that is aggregated for fills with same price and taking side every 100 milliseconds. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 100ms * * @summary Aggregate Trade Streams * @param {AggregateTradeStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#aggregate-trade-streams Binance API Documentation} */ aggregateTradeStreams(requestParameters: AggregateTradeStreamsRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in real-time for all symbols. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: Real-time * * @summary All Book Tickers Stream * @param {AllBookTickersStreamRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#all-book-tickers-stream Binance API Documentation} */ allBookTickersStream(requestParameters?: AllBookTickersStreamRequest): WebsocketStream; /** * The All Liquidation Order Snapshot Streams push force liquidation order information for all symbols in the market. For each symbol，only the latest one liquidation order within 1000ms will be pushed as the snapshot. If no liquidation happens in the interval of 1000ms, no stream will be pushed. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 1000ms * * @summary All Market Liquidation Order Streams * @param {AllMarketLiquidationOrderStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#all-market-liquidation-order-streams Binance API Documentation} */ allMarketLiquidationOrderStreams(requestParameters?: AllMarketLiquidationOrderStreamsRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics for all symbols. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. Note that only tickers that have changed will be present in the array. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 1000ms * * @summary All Market Mini Tickers Stream * @param {AllMarketMiniTickersStreamRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#all-market-mini-tickers-stream Binance API Documentation} */ allMarketMiniTickersStream(requestParameters?: AllMarketMiniTickersStreamRequest): WebsocketStream; /** * 24hr rolling window ticker statistics for all symbols. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. Note that only tickers that have changed will be present in the array. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 1000ms * * @summary All Market Tickers Streams * @param {AllMarketTickersStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#all-market-tickers-streams Binance API Documentation} */ allMarketTickersStreams(requestParameters?: AllMarketTickersStreamsRequest): WebsocketStream; /** * Kline update every second * * > **After CM migration**, both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 250ms * * @summary Continuous Contract Kline/Candlestick Streams * @param {ContinuousContractKlineCandlestickStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#continuous-contract-kline-candlestick-streams Binance API Documentation} */ continuousContractKlineCandlestickStreams(requestParameters: ContinuousContractKlineCandlestickStreamsRequest): WebsocketStream; /** * ContractInfo stream pushes when contract info updates(listing/settlement/contract bracket update). bks field only shows up when bracket gets updated. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: Real-time * * @summary Contract Info Stream * @param {ContractInfoStreamRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#contract-info-stream Binance API Documentation} */ contractInfoStream(requestParameters?: ContractInfoStreamRequest): WebsocketStream; /** * Bids and asks, pushed every 250 milliseconds, 500 milliseconds, or 100 milliseconds * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 250ms or 500ms or 100ms * * @summary Diff. Book Depth Streams * @param {DiffBookDepthStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#diff-book-depth-streams Binance API Documentation} */ diffBookDepthStreams(requestParameters: DiffBookDepthStreamsRequest): WebsocketStream; /** * Index Kline/Candlestick Streams * * > **After CM migration**, both `fstream` and `dstream` may subscribe to CM symbols on this stream. * * Update Speed: 250ms * * @summary Index Kline/Candlestick Streams * @param {IndexKlineCandlestickStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#index-kline-candlestick-streams Binance API Documentation} */ indexKlineCandlestickStreams(requestParameters: IndexKlineCandlestickStreamsRequest): WebsocketStream; /** * Index Price Stream * * Update Speed: 3000ms OR 1000ms * * @summary Index Price Stream * @param {IndexPriceStreamRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#index-price-stream Binance API Documentation} */ indexPriceStream(requestParameters: IndexPriceStreamRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: Real-time * * @summary Individual Symbol Book Ticker Streams * @param {IndividualSymbolBookTickerStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#individual-symbol-book-ticker-streams Binance API Documentation} */ individualSymbolBookTickerStreams(requestParameters: IndividualSymbolBookTickerStreamsRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 500ms * * @summary Individual Symbol Mini Ticker Stream * @param {IndividualSymbolMiniTickerStreamRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#individual-symbol-mini-ticker-stream Binance API Documentation} */ individualSymbolMiniTickerStream(requestParameters: IndividualSymbolMiniTickerStreamRequest): WebsocketStream; /** * 24hr rolling window ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 500ms * * @summary Individual Symbol Ticker Streams * @param {IndividualSymbolTickerStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#individual-symbol-ticker-streams Binance API Documentation} */ individualSymbolTickerStreams(requestParameters: IndividualSymbolTickerStreamsRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current klines/candlestick every 250 milliseconds (if existing). * * > **After CM migration**, both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 250ms * * @summary Kline/Candlestick Streams * @param {KlineCandlestickStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#kline-candlestick-streams Binance API Documentation} */ klineCandlestickStreams(requestParameters: KlineCandlestickStreamsRequest): WebsocketStream; /** * Mark Price Kline/Candlestick Streams * * > **After CM migration**, both `fstream` and `dstream` may subscribe to CM symbols on this stream. * * Update Speed: 250ms * * @summary Mark Price Kline/Candlestick Streams * @param {MarkPriceKlineCandlestickStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#mark-price-kline-candlestick-streams Binance API Documentation} */ markPriceKlineCandlestickStreams(requestParameters: MarkPriceKlineCandlestickStreamsRequest): WebsocketStream; /** * Mark Price of All Symbols of a Pair * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM); both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 3000ms OR 1000ms * * @summary Mark Price of All Symbols of a Pair * @param {MarkPriceOfAllSymbolsOfAPairRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#mark-price-of-all-symbols-of-apair Binance API Documentation} */ markPriceOfAllSymbolsOfAPair(requestParameters: MarkPriceOfAllSymbolsOfAPairRequest): WebsocketStream; /** * Mark price update stream * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM); both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 3000ms OR 1000ms * * @summary Mark Price Stream * @param {MarkPriceStreamRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#mark-price-stream Binance API Documentation} */ markPriceStream(requestParameters: MarkPriceStreamRequest): WebsocketStream; /** * The Liquidation Order Snapshot Streams push force liquidation order information for specific symbol. For each symbol，only the latest one liquidation order within 1000ms will be pushed as the snapshot. If no liquidation happens in the interval of 1000ms, no stream will be pushed. * * Update Speed: 1000ms * * @summary Market Liquidation Order Streams * @param {MarketLiquidationOrderStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#market-liquidation-order-streams Binance API Documentation} */ marketLiquidationOrderStreams(requestParameters: MarketLiquidationOrderStreamsRequest): WebsocketStream; /** * Top levels bids and asks. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 250ms, 500ms or 100ms * * @summary Partial Book Depth Streams * @param {PartialBookDepthStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#partial-book-depth-streams Binance API Documentation} */ partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream; } declare enum ContinuousContractKlineCandlestickStreamsContractTypeEnum { perpetual = "perpetual", current_quarter = "current_quarter", next_quarter = "next_quarter", } declare enum ContinuousContractKlineCandlestickStreamsIntervalEnum { INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum DiffBookDepthStreamsUpdateSpeedEnum { UPDATE_SPEED_100ms = "100ms", UPDATE_SPEED_500ms = "500ms", } declare enum IndexKlineCandlestickStreamsIntervalEnum { INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum IndexPriceStreamUpdateSpeedEnum { UPDATE_SPEED_1s = "1s", } declare enum KlineCandlestickStreamsIntervalEnum { INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum MarkPriceKlineCandlestickStreamsIntervalEnum { INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum MarkPriceOfAllSymbolsOfAPairUpdateSpeedEnum { UPDATE_SPEED_1s = "1s", } declare enum MarkPriceStreamUpdateSpeedEnum { UPDATE_SPEED_1s = "1s", } declare enum PartialBookDepthStreamsLevelsEnum { LEVELS_5 = "5", LEVELS_10 = "10", LEVELS_20 = "20", } declare enum PartialBookDepthStreamsUpdateSpeedEnum { UPDATE_SPEED_100ms = "100ms", UPDATE_SPEED_500ms = "500ms", } //#endregion //#region src/websocket-streams/websocket-streams-connection.d.ts declare class WebsocketStreamsConnection { private websocketBase; private api; constructor(websocketBase: WebsocketStreamsBase); /** * Adds an event listener for the specified WebSocket event. * @param event - The WebSocket event to listen for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'. * @param listener - The callback function to be executed when the event is triggered. The function can accept any number of arguments. */ on(event: 'open' | 'message' | 'error' | 'close' | 'ping' | 'pong', listener: (...args: any[]) => void): void; /** * Removes an event listener for the specified WebSocket event. * @param event - The WebSocket event to stop listening for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'. * @param listener - The callback function that was previously added as the event listener. */ off(event: 'open' | 'message' | 'error' | 'close' | 'ping' | 'pong', listener: (...args: any[]) => void): void; /** * Disconnects from the WebSocket server. * If there is no active connection, a warning is logged. * Otherwise, all connections in the connection pool are closed gracefully, * and a message is logged indicating that the connection has been disconnected. * @returns A Promise that resolves when all connections have been closed. * @throws Error if the WebSocket client is not set. */ disconnect(): Promise; /** * Checks if the WebSocket connection is currently open. * @returns `true` if the connection is open, `false` otherwise. */ isConnected(): boolean; /** * Sends a ping message to all connected Websocket servers in the pool. * If no connections are ready, a warning is logged. * For each active connection, the ping message is sent, and debug logs provide details. * @throws Error if a Websocket client is not set for a connection. */ pingServer(): void; /** * Subscribes to one or multiple WebSocket streams * Handles both single and pool modes * @param stream Single stream name or array of stream names to subscribe to * @param id Optional subscription ID * @returns void */ subscribe(stream: string | string[], id?: string): void; /** * Unsubscribes from one or multiple WebSocket streams * Handles both single and pool modes * @param stream Single stream name or array of stream names to unsubscribe from * @param id Optional unsubscription ID * @returns void */ unsubscribe(stream: string | string[], id?: string): void; /** * Checks if the WebSocket connection is subscribed to the specified stream. * @param stream The name of the WebSocket stream to check. * @returns `true` if the connection is subscribed to the stream, `false` otherwise. */ isSubscribed(stream: string): boolean; /** * Subscribes to the user data WebSocket stream using the provided listen key. * @param listenKey - The listen key for the user data WebSocket stream. * @param id - Optional user data stream ID * @returns A WebSocket stream handler for the user data stream. */ userData(listenKey: string, id?: string): WebsocketStream; /** * The Aggregate Trade Streams push market trade information that is aggregated for fills with same price and taking side every 100 milliseconds. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 100ms * * @summary Aggregate Trade Streams * @param {AggregateTradeStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#aggregate-trade-streams Binance API Documentation} */ aggregateTradeStreams(requestParameters: AggregateTradeStreamsRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in real-time for all symbols. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: Real-time * * @summary All Book Tickers Stream * @param {AllBookTickersStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#all-book-tickers-stream Binance API Documentation} */ allBookTickersStream(requestParameters?: AllBookTickersStreamRequest): WebsocketStream; /** * The All Liquidation Order Snapshot Streams push force liquidation order information for all symbols in the market. For each symbol，only the latest one liquidation order within 1000ms will be pushed as the snapshot. If no liquidation happens in the interval of 1000ms, no stream will be pushed. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 1000ms * * @summary All Market Liquidation Order Streams * @param {AllMarketLiquidationOrderStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#all-market-liquidation-order-streams Binance API Documentation} */ allMarketLiquidationOrderStreams(requestParameters?: AllMarketLiquidationOrderStreamsRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics for all symbols. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. Note that only tickers that have changed will be present in the array. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 1000ms * * @summary All Market Mini Tickers Stream * @param {AllMarketMiniTickersStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#all-market-mini-tickers-stream Binance API Documentation} */ allMarketMiniTickersStream(requestParameters?: AllMarketMiniTickersStreamRequest): WebsocketStream; /** * 24hr rolling window ticker statistics for all symbols. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. Note that only tickers that have changed will be present in the array. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 1000ms * * @summary All Market Tickers Streams * @param {AllMarketTickersStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#all-market-tickers-streams Binance API Documentation} */ allMarketTickersStreams(requestParameters?: AllMarketTickersStreamsRequest): WebsocketStream; /** * Kline update every second * * > **After CM migration**, both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 250ms * * @summary Continuous Contract Kline/Candlestick Streams * @param {ContinuousContractKlineCandlestickStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#continuous-contract-kline-candlestick-streams Binance API Documentation} */ continuousContractKlineCandlestickStreams(requestParameters: ContinuousContractKlineCandlestickStreamsRequest): WebsocketStream; /** * ContractInfo stream pushes when contract info updates(listing/settlement/contract bracket update). bks field only shows up when bracket gets updated. * * > **After CM migration**, this stream pushes the merged UM + CM universe (subscribable on both `fstream` and `dstream`); each payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: Real-time * * @summary Contract Info Stream * @param {ContractInfoStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#contract-info-stream Binance API Documentation} */ contractInfoStream(requestParameters?: ContractInfoStreamRequest): WebsocketStream; /** * Bids and asks, pushed every 250 milliseconds, 500 milliseconds, or 100 milliseconds * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 250ms or 500ms or 100ms * * @summary Diff. Book Depth Streams * @param {DiffBookDepthStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#diff-book-depth-streams Binance API Documentation} */ diffBookDepthStreams(requestParameters: DiffBookDepthStreamsRequest): WebsocketStream; /** * Index Kline/Candlestick Streams * * > **After CM migration**, both `fstream` and `dstream` may subscribe to CM symbols on this stream. * * Update Speed: 250ms * * @summary Index Kline/Candlestick Streams * @param {IndexKlineCandlestickStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#index-kline-candlestick-streams Binance API Documentation} */ indexKlineCandlestickStreams(requestParameters: IndexKlineCandlestickStreamsRequest): WebsocketStream; /** * Index Price Stream * * Update Speed: 3000ms OR 1000ms * * @summary Index Price Stream * @param {IndexPriceStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#index-price-stream Binance API Documentation} */ indexPriceStream(requestParameters: IndexPriceStreamRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: Real-time * * @summary Individual Symbol Book Ticker Streams * @param {IndividualSymbolBookTickerStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#individual-symbol-book-ticker-streams Binance API Documentation} */ individualSymbolBookTickerStreams(requestParameters: IndividualSymbolBookTickerStreamsRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 500ms * * @summary Individual Symbol Mini Ticker Stream * @param {IndividualSymbolMiniTickerStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#individual-symbol-mini-ticker-stream Binance API Documentation} */ individualSymbolMiniTickerStream(requestParameters: IndividualSymbolMiniTickerStreamRequest): WebsocketStream; /** * 24hr rolling window ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 500ms * * @summary Individual Symbol Ticker Streams * @param {IndividualSymbolTickerStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#individual-symbol-ticker-streams Binance API Documentation} */ individualSymbolTickerStreams(requestParameters: IndividualSymbolTickerStreamsRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current klines/candlestick every 250 milliseconds (if existing). * * > **After CM migration**, both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 250ms * * @summary Kline/Candlestick Streams * @param {KlineCandlestickStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#kline-candlestick-streams Binance API Documentation} */ klineCandlestickStreams(requestParameters: KlineCandlestickStreamsRequest): WebsocketStream; /** * Mark Price Kline/Candlestick Streams * * > **After CM migration**, both `fstream` and `dstream` may subscribe to CM symbols on this stream. * * Update Speed: 250ms * * @summary Mark Price Kline/Candlestick Streams * @param {MarkPriceKlineCandlestickStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#mark-price-kline-candlestick-streams Binance API Documentation} */ markPriceKlineCandlestickStreams(requestParameters: MarkPriceKlineCandlestickStreamsRequest): WebsocketStream; /** * Mark Price of All Symbols of a Pair * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM); both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 3000ms OR 1000ms * * @summary Mark Price of All Symbols of a Pair * @param {MarkPriceOfAllSymbolsOfAPairRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#mark-price-of-all-symbols-of-apair Binance API Documentation} */ markPriceOfAllSymbolsOfAPair(requestParameters: MarkPriceOfAllSymbolsOfAPairRequest): WebsocketStream; /** * Mark price update stream * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM); both `fstream` and `dstream` may subscribe to either UM or CM symbols on this stream. * * Update Speed: 3000ms OR 1000ms * * @summary Mark Price Stream * @param {MarkPriceStreamRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#mark-price-stream Binance API Documentation} */ markPriceStream(requestParameters: MarkPriceStreamRequest): WebsocketStream; /** * The Liquidation Order Snapshot Streams push force liquidation order information for specific symbol. For each symbol，only the latest one liquidation order within 1000ms will be pushed as the snapshot. If no liquidation happens in the interval of 1000ms, no stream will be pushed. * * Update Speed: 1000ms * * @summary Market Liquidation Order Streams * @param {MarketLiquidationOrderStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#market-liquidation-order-streams Binance API Documentation} */ marketLiquidationOrderStreams(requestParameters: MarketLiquidationOrderStreamsRequest): WebsocketStream; /** * Top levels bids and asks. * * > **After CM migration**, the payload is appended with a new `st` field (`1` = UM, `2` = CM). * * Update Speed: 250ms, 500ms or 100ms * * @summary Partial Book Depth Streams * @param {PartialBookDepthStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-coin-m-futures/api/ws-streams/~#partial-book-depth-streams Binance API Documentation} */ partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream; } //#endregion //#region src/websocket-streams/websocket-streams.d.ts declare class WebsocketStreams { private configuration; constructor(configuration: ConfigurationWebsocketStreams); /** * Connects to the Binance WebSocket streams and returns a `WebsocketStreamsConnection` instance. * * @param {object} [options] - Optional connection options. * @param {string|string[]} [options.stream] - The stream(s) to connect to. * @param {'single'|'pool'} [options.mode] - The connection mode, either 'single' or 'pool'. Overwrite the `mode` option in the configuration. * @param {number} [options.poolSize] - The number of connections to use in pool mode. Overwrite the `poolSize` option in the configuration. * @returns {Promise} - A promise that resolves to a `WebsocketStreamsConnection` instance. */ connect({ stream, mode, poolSize }?: { stream?: string | string[]; mode?: 'single' | 'pool'; poolSize?: number; }): Promise; } declare namespace index_d_exports$2 { export { AccountConfigUpdate, AccountConfigUpdateAc, AccountUpdate, AccountUpdateA, AccountUpdateABInner, AccountUpdateAPInner, AggregateTradeStreamsRequest, AggregateTradeStreamsResponse, AllBookTickersStreamRequest, AllBookTickersStreamResponse, AllMarketLiquidationOrderStreamsRequest, AllMarketLiquidationOrderStreamsResponse, AllMarketLiquidationOrderStreamsResponseO, AllMarketMiniTickersStreamRequest, AllMarketMiniTickersStreamResponse, AllMarketMiniTickersStreamResponseInner, AllMarketTickersStreamsRequest, AllMarketTickersStreamsResponse, AllMarketTickersStreamsResponseInner, Api, ApiInterface, ContinuousContractKlineCandlestickStreamsContractTypeEnum, ContinuousContractKlineCandlestickStreamsIntervalEnum, ContinuousContractKlineCandlestickStreamsRequest, ContinuousContractKlineCandlestickStreamsResponse, ContinuousContractKlineCandlestickStreamsResponseK, ContractInfoStreamRequest, ContractInfoStreamResponse, ContractInfoStreamResponseBksInner, DiffBookDepthStreamsRequest, DiffBookDepthStreamsResponse, DiffBookDepthStreamsUpdateSpeedEnum, GridUpdate, GridUpdateGu, IndexKlineCandlestickStreamsIntervalEnum, IndexKlineCandlestickStreamsRequest, IndexKlineCandlestickStreamsResponse, IndexKlineCandlestickStreamsResponseK, IndexPriceStreamRequest, IndexPriceStreamResponse, IndexPriceStreamUpdateSpeedEnum, IndividualSymbolBookTickerStreamsRequest, IndividualSymbolBookTickerStreamsResponse, IndividualSymbolMiniTickerStreamRequest, IndividualSymbolMiniTickerStreamResponse, IndividualSymbolTickerStreamsRequest, IndividualSymbolTickerStreamsResponse, KlineCandlestickStreamsIntervalEnum, KlineCandlestickStreamsRequest, KlineCandlestickStreamsResponse, KlineCandlestickStreamsResponseK, ListenKeyExpired, MarginCall, MarginCallPInner, MarkPriceKlineCandlestickStreamsIntervalEnum, MarkPriceKlineCandlestickStreamsRequest, MarkPriceKlineCandlestickStreamsResponse, MarkPriceKlineCandlestickStreamsResponseK, MarkPriceOfAllSymbolsOfAPairRequest, MarkPriceOfAllSymbolsOfAPairResponse, MarkPriceOfAllSymbolsOfAPairResponseInner, MarkPriceOfAllSymbolsOfAPairUpdateSpeedEnum, MarkPriceStreamRequest, MarkPriceStreamResponse, MarkPriceStreamUpdateSpeedEnum, MarketLiquidationOrderStreamsRequest, MarketLiquidationOrderStreamsResponse, OrderTradeUpdate, OrderTradeUpdateO, PartialBookDepthStreamsLevelsEnum, PartialBookDepthStreamsRequest, PartialBookDepthStreamsResponse, PartialBookDepthStreamsUpdateSpeedEnum, StrategyUpdate, StrategyUpdateSu, UserDataStreamEventsResponse, WebsocketStreams, WebsocketStreamsConnection }; } //#endregion //#region src/derivatives-trading-coin-futures.d.ts interface ConfigurationDerivativesTradingCoinFutures { configurationRestAPI?: ConfigurationRestAPI; configurationWebsocketAPI?: ConfigurationWebsocketAPI; configurationWebsocketStreams?: ConfigurationWebsocketStreams; } declare class DerivativesTradingCoinFutures { restAPI: RestAPI; websocketAPI: WebsocketAPI; websocketStreams: WebsocketStreams; constructor(config: ConfigurationDerivativesTradingCoinFutures); } //#endregion export { BadRequestError, type ConfigurationDerivativesTradingCoinFutures, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DerivativesTradingCoinFutures, index_d_exports as DerivativesTradingCoinFuturesRestAPI, index_d_exports$1 as DerivativesTradingCoinFuturesWebsocketAPI, index_d_exports$2 as DerivativesTradingCoinFuturesWebsocketStreams, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError }; //# sourceMappingURL=index.d.ts.map