import { BadRequestError, ConfigurationRestAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_TESTNET_URL, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, RestApiResponse, ServerError, TooManyRequestsError, UnauthorizedError, WebsocketStream, WebsocketStreamsBase } from "@binance/common"; //#region src/rest-api/types/accept-block-trade-order-response-legs-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 AcceptBlockTradeOrderResponseLegsInner */ interface AcceptBlockTradeOrderResponseLegsInner { /** * symbol * @type {string} * @memberof AcceptBlockTradeOrderResponseLegsInner */ symbol?: string; /** * side * @type {string} * @memberof AcceptBlockTradeOrderResponseLegsInner */ side?: string; /** * quantity * @type {string} * @memberof AcceptBlockTradeOrderResponseLegsInner */ quantity?: string; /** * price * @type {string} * @memberof AcceptBlockTradeOrderResponseLegsInner */ price?: string; } //#endregion //#region src/rest-api/types/accept-block-trade-order-response.d.ts /** * * @export * @interface AcceptBlockTradeOrderResponse */ interface AcceptBlockTradeOrderResponse { /** * block Trade Settlement Key * @type {string} * @memberof AcceptBlockTradeOrderResponse */ blockTradeSettlementKey?: string; /** * expire Time * @type {number | bigint} * @memberof AcceptBlockTradeOrderResponse */ expireTime?: number | bigint; /** * liquidity * @type {string} * @memberof AcceptBlockTradeOrderResponse */ liquidity?: string; /** * status * @type {string} * @memberof AcceptBlockTradeOrderResponse */ status?: string; /** * create Time * @type {number | bigint} * @memberof AcceptBlockTradeOrderResponse */ createTime?: number | bigint; /** * legs * @type {Array} * @memberof AcceptBlockTradeOrderResponse */ legs?: Array; } //#endregion //#region src/rest-api/types/account-block-trade-list-response-inner-legs-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 AccountBlockTradeListResponseInnerLegsInner */ interface AccountBlockTradeListResponseInnerLegsInner { /** * create Time * @type {number | bigint} * @memberof AccountBlockTradeListResponseInnerLegsInner */ createTime?: number | bigint; /** * update Time * @type {number | bigint} * @memberof AccountBlockTradeListResponseInnerLegsInner */ updateTime?: number | bigint; /** * symbol * @type {string} * @memberof AccountBlockTradeListResponseInnerLegsInner */ symbol?: string; /** * order Id * @type {string} * @memberof AccountBlockTradeListResponseInnerLegsInner */ orderId?: string; /** * order Price * @type {number} * @memberof AccountBlockTradeListResponseInnerLegsInner */ orderPrice?: number; /** * order Quantity * @type {number} * @memberof AccountBlockTradeListResponseInnerLegsInner */ orderQuantity?: number; /** * order Status * @type {string} * @memberof AccountBlockTradeListResponseInnerLegsInner */ orderStatus?: string; /** * executed Qty * @type {number} * @memberof AccountBlockTradeListResponseInnerLegsInner */ executedQty?: number; /** * executed Amount * @type {number} * @memberof AccountBlockTradeListResponseInnerLegsInner */ executedAmount?: number; /** * fee * @type {number} * @memberof AccountBlockTradeListResponseInnerLegsInner */ fee?: number; /** * order Type * @type {string} * @memberof AccountBlockTradeListResponseInnerLegsInner */ orderType?: string; /** * order Side * @type {string} * @memberof AccountBlockTradeListResponseInnerLegsInner */ orderSide?: string; /** * id * @type {string} * @memberof AccountBlockTradeListResponseInnerLegsInner */ id?: string; /** * trade Id * @type {number | bigint} * @memberof AccountBlockTradeListResponseInnerLegsInner */ tradeId?: number | bigint; /** * trade Price * @type {number} * @memberof AccountBlockTradeListResponseInnerLegsInner */ tradePrice?: number; /** * trade Qty * @type {number} * @memberof AccountBlockTradeListResponseInnerLegsInner */ tradeQty?: number; /** * trade Time * @type {number | bigint} * @memberof AccountBlockTradeListResponseInnerLegsInner */ tradeTime?: number | bigint; /** * liquidity * @type {string} * @memberof AccountBlockTradeListResponseInnerLegsInner */ liquidity?: string; /** * commission * @type {number} * @memberof AccountBlockTradeListResponseInnerLegsInner */ commission?: number; } //#endregion //#region src/rest-api/types/account-block-trade-list-response-inner.d.ts /** * * @export * @interface AccountBlockTradeListResponseInner */ interface AccountBlockTradeListResponseInner { /** * parent Order Id * @type {string} * @memberof AccountBlockTradeListResponseInner */ parentOrderId?: string; /** * cross Type * @type {string} * @memberof AccountBlockTradeListResponseInner */ crossType?: string; /** * legs * @type {Array} * @memberof AccountBlockTradeListResponseInner */ legs?: Array; /** * block Trade Settlement Key * @type {string} * @memberof AccountBlockTradeListResponseInner */ blockTradeSettlementKey?: string; } //#endregion //#region src/rest-api/types/account-block-trade-list-response.d.ts /** * * @export * @interface AccountBlockTradeListResponse */ interface AccountBlockTradeListResponse extends Array {} //#endregion //#region src/rest-api/types/account-funding-flow-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 AccountFundingFlowResponseInner */ interface AccountFundingFlowResponseInner { /** * id * @type {number | bigint} * @memberof AccountFundingFlowResponseInner */ id?: number | bigint; /** * Asset type * @type {string} * @memberof AccountFundingFlowResponseInner */ asset?: string; /** * Amount (positive numbers represent inflow, negative numbers represent outflow) * @type {string} * @memberof AccountFundingFlowResponseInner */ amount?: string; /** * type (fees) * @type {string} * @memberof AccountFundingFlowResponseInner */ type?: string; /** * Time * @type {number | bigint} * @memberof AccountFundingFlowResponseInner */ createDate?: number | bigint; } //#endregion //#region src/rest-api/types/account-funding-flow-response.d.ts /** * * @export * @interface AccountFundingFlowResponse */ interface AccountFundingFlowResponse extends Array {} //#endregion //#region src/rest-api/types/account-trade-list-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 { /** * unique id * @type {number | bigint} * @memberof AccountTradeListResponseInner */ id?: number | bigint; /** * trade id * @type {number | bigint} * @memberof AccountTradeListResponseInner */ tradeId?: number | bigint; /** * order id * @type {number | bigint} * @memberof AccountTradeListResponseInner */ orderId?: number | bigint; /** * option symbol * @type {string} * @memberof AccountTradeListResponseInner */ symbol?: string; /** * trade price * @type {string} * @memberof AccountTradeListResponseInner */ price?: string; /** * trade quantity * @type {string} * @memberof AccountTradeListResponseInner */ quantity?: string; /** * fee(negative is fee deduction) * @type {string} * @memberof AccountTradeListResponseInner */ fee?: string; /** * realized profit/loss * @type {string} * @memberof AccountTradeListResponseInner */ realizedProfit?: string; /** * order side * @type {string} * @memberof AccountTradeListResponseInner */ side?: string; /** * order type * @type {string} * @memberof AccountTradeListResponseInner */ type?: string; /** * TAKER or MAKER * @type {string} * @memberof AccountTradeListResponseInner */ liquidity?: string; /** * trade time * @type {number | bigint} * @memberof AccountTradeListResponseInner */ time?: number | bigint; /** * price Scale * @type {number | bigint} * @memberof AccountTradeListResponseInner */ priceScale?: number | bigint; /** * quantity Scale * @type {number | bigint} * @memberof AccountTradeListResponseInner */ quantityScale?: number | bigint; /** * option Side * @type {string} * @memberof AccountTradeListResponseInner */ optionSide?: string; /** * quote Asset * @type {string} * @memberof AccountTradeListResponseInner */ quoteAsset?: string; } //#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/auto-cancel-all-open-orders-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 { /** * underlyings * @type {Array} * @memberof AutoCancelAllOpenOrdersResponse */ underlyings?: Array; } //#endregion //#region src/rest-api/types/cancel-all-option-orders-by-underlying-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 CancelAllOptionOrdersByUnderlyingResponse */ interface CancelAllOptionOrdersByUnderlyingResponse { /** * code * @type {number | bigint} * @memberof CancelAllOptionOrdersByUnderlyingResponse */ code?: number | bigint; /** * msg * @type {string} * @memberof CancelAllOptionOrdersByUnderlyingResponse */ msg?: string; } //#endregion //#region src/rest-api/types/cancel-all-option-orders-on-specific-symbol-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 CancelAllOptionOrdersOnSpecificSymbolResponse */ interface CancelAllOptionOrdersOnSpecificSymbolResponse { /** * code * @type {string} * @memberof CancelAllOptionOrdersOnSpecificSymbolResponse */ code?: string; /** * msg * @type {string} * @memberof CancelAllOptionOrdersOnSpecificSymbolResponse */ msg?: string; } //#endregion //#region src/rest-api/types/cancel-multiple-option-orders-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 CancelMultipleOptionOrdersResponseInner */ interface CancelMultipleOptionOrdersResponseInner { /** * System order number * @type {number | bigint} * @memberof CancelMultipleOptionOrdersResponseInner */ orderId?: number | bigint; /** * Option trading pair * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ symbol?: string; /** * Order Price * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ price?: string; /** * Order Quantity * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ quantity?: string; /** * Number of completed quantity * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ executedQty?: string; /** * fee * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ fee?: string; /** * Buy/sell direction * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ side?: string; /** * Order type * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ type?: string; /** * Time in force method * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ timeInForce?: string; /** * Order is reduce only Y/N * @type {boolean} * @memberof CancelMultipleOptionOrdersResponseInner */ reduceOnly?: boolean; /** * Order Time * @type {number | bigint} * @memberof CancelMultipleOptionOrdersResponseInner */ createTime?: number | bigint; /** * Update time * @type {number | bigint} * @memberof CancelMultipleOptionOrdersResponseInner */ updateTime?: number | bigint; /** * Order status * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ status?: string; /** * Average price of completed trade * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ avgPrice?: string; /** * Client order ID * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ clientOrderId?: string; /** * price Scale * @type {number | bigint} * @memberof CancelMultipleOptionOrdersResponseInner */ priceScale?: number | bigint; /** * quantity Scale * @type {number | bigint} * @memberof CancelMultipleOptionOrdersResponseInner */ quantityScale?: number | bigint; /** * option Side * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ optionSide?: string; /** * quote Asset * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ quoteAsset?: string; /** * mmp * @type {boolean} * @memberof CancelMultipleOptionOrdersResponseInner */ mmp?: boolean; /** * * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ source?: string; /** * * @type {string} * @memberof CancelMultipleOptionOrdersResponseInner */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/cancel-multiple-option-orders-response.d.ts /** * * @export * @interface CancelMultipleOptionOrdersResponse */ interface CancelMultipleOptionOrdersResponse extends Array {} //#endregion //#region src/rest-api/types/cancel-option-order-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 CancelOptionOrderResponse */ interface CancelOptionOrderResponse { /** * System order number * @type {number | bigint} * @memberof CancelOptionOrderResponse */ orderId?: number | bigint; /** * Option trading pair * @type {string} * @memberof CancelOptionOrderResponse */ symbol?: string; /** * Order Price * @type {string} * @memberof CancelOptionOrderResponse */ price?: string; /** * Order Quantity * @type {string} * @memberof CancelOptionOrderResponse */ quantity?: string; /** * Number of executed quantity * @type {string} * @memberof CancelOptionOrderResponse */ executedQty?: string; /** * Buy/sell direction * @type {string} * @memberof CancelOptionOrderResponse */ side?: string; /** * Order type * @type {string} * @memberof CancelOptionOrderResponse */ type?: string; /** * Time in force method * @type {string} * @memberof CancelOptionOrderResponse */ timeInForce?: string; /** * Order is reduce only Y/N * @type {boolean} * @memberof CancelOptionOrderResponse */ reduceOnly?: boolean; /** * Order Time * @type {number | bigint} * @memberof CancelOptionOrderResponse */ createDate?: number | bigint; /** * Update time * @type {number | bigint} * @memberof CancelOptionOrderResponse */ updateTime?: number | bigint; /** * Order status * @type {string} * @memberof CancelOptionOrderResponse */ status?: string; /** * Average price of completed trade * @type {string} * @memberof CancelOptionOrderResponse */ avgPrice?: string; /** * source * @type {string} * @memberof CancelOptionOrderResponse */ source?: string; /** * Client order ID * @type {string} * @memberof CancelOptionOrderResponse */ clientOrderId?: string; /** * price Scale * @type {number | bigint} * @memberof CancelOptionOrderResponse */ priceScale?: number | bigint; /** * quantity Scale * @type {number | bigint} * @memberof CancelOptionOrderResponse */ quantityScale?: number | bigint; /** * option Side * @type {string} * @memberof CancelOptionOrderResponse */ optionSide?: string; /** * quote Asset * @type {string} * @memberof CancelOptionOrderResponse */ quoteAsset?: string; /** * mmp * @type {boolean} * @memberof CancelOptionOrderResponse */ mmp?: boolean; /** * * @type {string} * @memberof CancelOptionOrderResponse */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/check-server-time-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 { /** * server Time * @type {number | bigint} * @memberof CheckServerTimeResponse */ serverTime?: number | bigint; } //#endregion //#region src/rest-api/types/exchange-information-response-option-assets-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 ExchangeInformationResponseOptionAssetsInner */ interface ExchangeInformationResponseOptionAssetsInner { /** * Asset name * @type {string} * @memberof ExchangeInformationResponseOptionAssetsInner */ name?: string; } //#endregion //#region src/rest-api/types/exchange-information-response-option-contracts-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 ExchangeInformationResponseOptionContractsInner */ interface ExchangeInformationResponseOptionContractsInner { /** * Base currency * @type {string} * @memberof ExchangeInformationResponseOptionContractsInner */ baseAsset?: string; /** * Quotation asset * @type {string} * @memberof ExchangeInformationResponseOptionContractsInner */ quoteAsset?: string; /** * Name of the underlying asset of the option contract * @type {string} * @memberof ExchangeInformationResponseOptionContractsInner */ underlying?: string; /** * Settlement currency * @type {string} * @memberof ExchangeInformationResponseOptionContractsInner */ settleAsset?: string; } //#endregion //#region src/rest-api/types/exchange-information-response-option-symbols-inner-filters-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 ExchangeInformationResponseOptionSymbolsInnerFiltersInner */ interface ExchangeInformationResponseOptionSymbolsInnerFiltersInner { /** * filter Type * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInnerFiltersInner */ filterType?: string; /** * min Price * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInnerFiltersInner */ minPrice?: string; /** * max Price * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInnerFiltersInner */ maxPrice?: string; /** * tick Size * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInnerFiltersInner */ tickSize?: string; /** * Minimum order quantity * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInnerFiltersInner */ minQty?: string; /** * Maximum order quantity * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInnerFiltersInner */ maxQty?: string; /** * step Size * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInnerFiltersInner */ stepSize?: string; } //#endregion //#region src/rest-api/types/exchange-information-response-option-symbols-inner.d.ts /** * * @export * @interface ExchangeInformationResponseOptionSymbolsInner */ interface ExchangeInformationResponseOptionSymbolsInner { /** * expiry time * @type {number | bigint} * @memberof ExchangeInformationResponseOptionSymbolsInner */ expiryDate?: number | bigint; /** * filters * @type {Array} * @memberof ExchangeInformationResponseOptionSymbolsInner */ filters?: Array; /** * Trading pair name * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ symbol?: string; /** * Direction: CALL long, PUT short * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ side?: string; /** * Strike price * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ strikePrice?: string; /** * Name of the underlying asset of the option contract * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ underlying?: string; /** * Contract unit, the quantity of the underlying asset represented by a single contract. * @type {number | bigint} * @memberof ExchangeInformationResponseOptionSymbolsInner */ unit?: number | bigint; /** * liquidation fee rate * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ liquidationFeeRate?: string; /** * Minimum order quantity * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ minQty?: string; /** * Maximum order quantity * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ maxQty?: string; /** * Initial Magin Ratio * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ initialMargin?: string; /** * Maintenance Margin Ratio * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ maintenanceMargin?: string; /** * Min Initial Margin Ratio * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ minInitialMargin?: string; /** * Min Maintenance Margin Ratio * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ minMaintenanceMargin?: string; /** * price precision * @type {number | bigint} * @memberof ExchangeInformationResponseOptionSymbolsInner */ priceScale?: number | bigint; /** * quantity precision * @type {number | bigint} * @memberof ExchangeInformationResponseOptionSymbolsInner */ quantityScale?: number | bigint; /** * Quotation asset * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ quoteAsset?: string; /** * Contract type * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ contractType?: string; /** * Underlying type * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ underlyingType?: string; /** * Whether naked selling is allowed for this symbol * @type {boolean} * @memberof ExchangeInformationResponseOptionSymbolsInner */ nakedSell?: boolean; /** * Trading Status * @type {string} * @memberof ExchangeInformationResponseOptionSymbolsInner */ status?: string; } //#endregion //#region src/rest-api/types/exchange-information-response-rate-limits-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 Type * @type {string} * @memberof ExchangeInformationResponseRateLimitsInner */ rateLimitType?: string; /** * interval * @type {string} * @memberof ExchangeInformationResponseRateLimitsInner */ interval?: string; /** * interval Num * @type {number | bigint} * @memberof ExchangeInformationResponseRateLimitsInner */ intervalNum?: number | bigint; /** * limit * @type {number | bigint} * @memberof ExchangeInformationResponseRateLimitsInner */ limit?: number | bigint; } //#endregion //#region src/rest-api/types/exchange-information-response.d.ts /** * * @export * @interface ExchangeInformationResponse */ interface ExchangeInformationResponse { /** * Time zone used by the server * @type {string} * @memberof ExchangeInformationResponse */ timezone?: string; /** * Current system time * @type {number | bigint} * @memberof ExchangeInformationResponse */ serverTime?: number | bigint; /** * Option contract underlying asset info * @type {Array} * @memberof ExchangeInformationResponse */ optionContracts?: Array; /** * Option asset info * @type {Array} * @memberof ExchangeInformationResponse */ optionAssets?: Array; /** * Option trading pair info * @type {Array} * @memberof ExchangeInformationResponse */ optionSymbols?: Array; /** * rate Limits * @type {Array} * @memberof ExchangeInformationResponse */ rateLimits?: Array; } //#endregion //#region src/rest-api/types/extend-block-trade-order-response-legs-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 ExtendBlockTradeOrderResponseLegsInner */ interface ExtendBlockTradeOrderResponseLegsInner { /** * symbol * @type {string} * @memberof ExtendBlockTradeOrderResponseLegsInner */ symbol?: string; /** * side * @type {string} * @memberof ExtendBlockTradeOrderResponseLegsInner */ side?: string; /** * quantity * @type {string} * @memberof ExtendBlockTradeOrderResponseLegsInner */ quantity?: string; /** * price * @type {string} * @memberof ExtendBlockTradeOrderResponseLegsInner */ price?: string; } //#endregion //#region src/rest-api/types/extend-block-trade-order-response.d.ts /** * * @export * @interface ExtendBlockTradeOrderResponse */ interface ExtendBlockTradeOrderResponse { /** * block Trade Settlement Key * @type {string} * @memberof ExtendBlockTradeOrderResponse */ blockTradeSettlementKey?: string; /** * expire Time * @type {number | bigint} * @memberof ExtendBlockTradeOrderResponse */ expireTime?: number | bigint; /** * liquidity * @type {string} * @memberof ExtendBlockTradeOrderResponse */ liquidity?: string; /** * status * @type {string} * @memberof ExtendBlockTradeOrderResponse */ status?: string; /** * create Time * @type {number | bigint} * @memberof ExtendBlockTradeOrderResponse */ createTime?: number | bigint; /** * legs * @type {Array} * @memberof ExtendBlockTradeOrderResponse */ legs?: Array; } //#endregion //#region src/rest-api/types/get-auto-cancel-all-open-orders-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 GetAutoCancelAllOpenOrdersResponse */ interface GetAutoCancelAllOpenOrdersResponse { /** * underlying * @type {string} * @memberof GetAutoCancelAllOpenOrdersResponse */ underlying?: string; /** * countdown Time * @type {number | bigint} * @memberof GetAutoCancelAllOpenOrdersResponse */ countdownTime?: number | bigint; } //#endregion //#region src/rest-api/types/get-market-maker-protection-config-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 GetMarketMakerProtectionConfigResponse */ interface GetMarketMakerProtectionConfigResponse { /** * underlying Id * @type {number | bigint} * @memberof GetMarketMakerProtectionConfigResponse */ underlyingId?: number | bigint; /** * underlying * @type {string} * @memberof GetMarketMakerProtectionConfigResponse */ underlying?: string; /** * window Time In Milliseconds * @type {number | bigint} * @memberof GetMarketMakerProtectionConfigResponse */ windowTimeInMilliseconds?: number | bigint; /** * frozen Time In Milliseconds * @type {number | bigint} * @memberof GetMarketMakerProtectionConfigResponse */ frozenTimeInMilliseconds?: number | bigint; /** * qty Limit * @type {string} * @memberof GetMarketMakerProtectionConfigResponse */ qtyLimit?: string; /** * delta Limit * @type {string} * @memberof GetMarketMakerProtectionConfigResponse */ deltaLimit?: string; /** * last Trigger Time * @type {number | bigint} * @memberof GetMarketMakerProtectionConfigResponse */ lastTriggerTime?: number | bigint; } //#endregion //#region src/rest-api/types/historical-exercise-records-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 HistoricalExerciseRecordsResponseInner */ interface HistoricalExerciseRecordsResponseInner { /** * symbol * @type {string} * @memberof HistoricalExerciseRecordsResponseInner */ symbol?: string; /** * strike price * @type {string} * @memberof HistoricalExerciseRecordsResponseInner */ strikePrice?: string; /** * real strike price * @type {string} * @memberof HistoricalExerciseRecordsResponseInner */ realStrikePrice?: string; /** * Exercise time * @type {number | bigint} * @memberof HistoricalExerciseRecordsResponseInner */ expiryDate?: number | bigint; /** * strike result * @type {string} * @memberof HistoricalExerciseRecordsResponseInner */ strikeResult?: string; } //#endregion //#region src/rest-api/types/historical-exercise-records-response.d.ts /** * * @export * @interface HistoricalExerciseRecordsResponse */ interface HistoricalExerciseRecordsResponse extends Array {} //#endregion //#region src/rest-api/types/index-price-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 IndexPriceResponse */ interface IndexPriceResponse { /** * time * @type {number | bigint} * @memberof IndexPriceResponse */ time?: number | bigint; /** * index Price * @type {string} * @memberof IndexPriceResponse */ indexPrice?: string; } //#endregion //#region src/rest-api/types/kline-candlestick-data-item-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 KlineCandlestickDataItemInner */ type KlineCandlestickDataItemInner = number | 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/new-block-trade-order-legs-parameter-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 NewBlockTradeOrderLegsParameterInner */ interface NewBlockTradeOrderLegsParameterInner { /** * Option trading pair * @type {string} * @memberof NewBlockTradeOrderLegsParameterInner */ symbol: string; /** * Buy/sell direction * @type {string} * @memberof NewBlockTradeOrderLegsParameterInner */ side: NewBlockTradeOrderLegsParameterInnerSideEnum; /** * Order type * @type {string} * @memberof NewBlockTradeOrderLegsParameterInner */ type: NewBlockTradeOrderLegsParameterInnerTypeEnum; /** * Order quantity * @type {string} * @memberof NewBlockTradeOrderLegsParameterInner */ quantity: string; /** * Order price * @type {string} * @memberof NewBlockTradeOrderLegsParameterInner */ price?: string; } declare const NewBlockTradeOrderLegsParameterInnerSideEnum: { readonly BUY: "BUY"; readonly SELL: "SELL"; }; type NewBlockTradeOrderLegsParameterInnerSideEnum = (typeof NewBlockTradeOrderLegsParameterInnerSideEnum)[keyof typeof NewBlockTradeOrderLegsParameterInnerSideEnum]; declare const NewBlockTradeOrderLegsParameterInnerTypeEnum: { readonly LIMIT: "LIMIT"; }; type NewBlockTradeOrderLegsParameterInnerTypeEnum = (typeof NewBlockTradeOrderLegsParameterInnerTypeEnum)[keyof typeof NewBlockTradeOrderLegsParameterInnerTypeEnum]; //#endregion //#region src/rest-api/types/new-block-trade-order-response.d.ts /** * * @export * @interface NewBlockTradeOrderResponse */ interface NewBlockTradeOrderResponse { /** * block Trade Settlement Key * @type {string} * @memberof NewBlockTradeOrderResponse */ blockTradeSettlementKey?: string; /** * expire Time * @type {number | bigint} * @memberof NewBlockTradeOrderResponse */ expireTime?: number | bigint; /** * liquidity * @type {string} * @memberof NewBlockTradeOrderResponse */ liquidity?: string; /** * status * @type {string} * @memberof NewBlockTradeOrderResponse */ status?: string; /** * legs * @type {Array} * @memberof NewBlockTradeOrderResponse */ legs?: Array; } //#endregion //#region src/rest-api/types/new-order-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 { /** * System order number * @type {number | bigint} * @memberof NewOrderResponse */ orderId?: number | bigint; /** * Option trading pair * @type {string} * @memberof NewOrderResponse */ symbol?: string; /** * Order Price * @type {string} * @memberof NewOrderResponse */ price?: string; /** * Order Quantity * @type {string} * @memberof NewOrderResponse */ quantity?: string; /** * Number of executed quantity * @type {string} * @memberof NewOrderResponse */ executedQty?: string; /** * fee * @type {number | bigint} * @memberof NewOrderResponse */ fee?: number | bigint; /** * Buy/sell direction * @type {string} * @memberof NewOrderResponse */ side?: string; /** * Order type * @type {string} * @memberof NewOrderResponse */ type?: string; /** * Time in force method * @type {string} * @memberof NewOrderResponse */ timeInForce?: string; /** * Order is reduce only Y/N * @type {boolean} * @memberof NewOrderResponse */ reduceOnly?: boolean; /** * post Only * @type {boolean} * @memberof NewOrderResponse */ postOnly?: boolean; /** * Order Time * @type {number | bigint} * @memberof NewOrderResponse */ createTime?: number | bigint; /** * Update time * @type {number | bigint} * @memberof NewOrderResponse */ updateTime?: number | bigint; /** * Order status * @type {string} * @memberof NewOrderResponse */ status?: string; /** * Average price of completed trade * @type {string} * @memberof NewOrderResponse */ avgPrice?: string; /** * source * @type {string} * @memberof NewOrderResponse */ source?: string; /** * Client order ID * @type {string} * @memberof NewOrderResponse */ clientOrderId?: string; /** * price Scale * @type {number | bigint} * @memberof NewOrderResponse */ priceScale?: number | bigint; /** * quantity Scale * @type {number | bigint} * @memberof NewOrderResponse */ quantityScale?: number | bigint; /** * option Side * @type {string} * @memberof NewOrderResponse */ optionSide?: string; /** * quote Asset * @type {string} * @memberof NewOrderResponse */ quoteAsset?: string; /** * mmp * @type {boolean} * @memberof NewOrderResponse */ mmp?: boolean; /** * Self-trade prevention mode * @type {string} * @memberof NewOrderResponse */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/open-interest-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 OpenInterestResponseInner */ interface OpenInterestResponseInner$1 { /** * symbol * @type {string} * @memberof OpenInterestResponseInner */ symbol?: string; /** * sum Open Interest * @type {string} * @memberof OpenInterestResponseInner */ sumOpenInterest?: string; /** * sum Open Interest Usd * @type {string} * @memberof OpenInterestResponseInner */ sumOpenInterestUsd?: string; /** * timestamp * @type {string} * @memberof OpenInterestResponseInner */ timestamp?: string; } //#endregion //#region src/rest-api/types/open-interest-response.d.ts /** * * @export * @interface OpenInterestResponse */ interface OpenInterestResponse$1 extends Array {} //#endregion //#region src/rest-api/types/option-margin-account-information-response-asset-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 OptionMarginAccountInformationResponseAssetInner */ interface OptionMarginAccountInformationResponseAssetInner { /** * asset * @type {string} * @memberof OptionMarginAccountInformationResponseAssetInner */ asset?: string; /** * margin Balance * @type {string} * @memberof OptionMarginAccountInformationResponseAssetInner */ marginBalance?: string; /** * equity * @type {string} * @memberof OptionMarginAccountInformationResponseAssetInner */ equity?: string; /** * available * @type {string} * @memberof OptionMarginAccountInformationResponseAssetInner */ available?: string; /** * initial Margin * @type {string} * @memberof OptionMarginAccountInformationResponseAssetInner */ initialMargin?: string; /** * maint Margin * @type {string} * @memberof OptionMarginAccountInformationResponseAssetInner */ maintMargin?: string; /** * unrealized PNL * @type {string} * @memberof OptionMarginAccountInformationResponseAssetInner */ unrealizedPNL?: string; /** * adjusted Equity * @type {string} * @memberof OptionMarginAccountInformationResponseAssetInner */ adjustedEquity?: string; } //#endregion //#region src/rest-api/types/option-margin-account-information-response-greek-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 OptionMarginAccountInformationResponseGreekInner */ interface OptionMarginAccountInformationResponseGreekInner { /** * underlying * @type {string} * @memberof OptionMarginAccountInformationResponseGreekInner */ underlying?: string; /** * delta * @type {string} * @memberof OptionMarginAccountInformationResponseGreekInner */ delta?: string; /** * gamma * @type {string} * @memberof OptionMarginAccountInformationResponseGreekInner */ gamma?: string; /** * theta * @type {string} * @memberof OptionMarginAccountInformationResponseGreekInner */ theta?: string; /** * vega * @type {string} * @memberof OptionMarginAccountInformationResponseGreekInner */ vega?: string; } //#endregion //#region src/rest-api/types/option-margin-account-information-response.d.ts /** * * @export * @interface OptionMarginAccountInformationResponse */ interface OptionMarginAccountInformationResponse { /** * asset * @type {Array} * @memberof OptionMarginAccountInformationResponse */ asset?: Array; /** * greek * @type {Array} * @memberof OptionMarginAccountInformationResponse */ greek?: Array; /** * time * @type {number | bigint} * @memberof OptionMarginAccountInformationResponse */ time?: number | bigint; /** * can Trade * @type {boolean} * @memberof OptionMarginAccountInformationResponse */ canTrade?: boolean; /** * can Deposit * @type {boolean} * @memberof OptionMarginAccountInformationResponse */ canDeposit?: boolean; /** * can Withdraw * @type {boolean} * @memberof OptionMarginAccountInformationResponse */ canWithdraw?: boolean; /** * reduce Only * @type {boolean} * @memberof OptionMarginAccountInformationResponse */ reduceOnly?: boolean; /** * Trade group ID * @type {number | bigint} * @memberof OptionMarginAccountInformationResponse */ tradeGroupId?: number | bigint; } //#endregion //#region src/rest-api/types/option-mark-price-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 OptionMarkPriceResponseInner */ interface OptionMarkPriceResponseInner$1 { /** * symbol * @type {string} * @memberof OptionMarkPriceResponseInner */ symbol?: string; /** * Mark price * @type {string} * @memberof OptionMarkPriceResponseInner */ markPrice?: string; /** * Implied volatility Buy * @type {string} * @memberof OptionMarkPriceResponseInner */ bidIV?: string; /** * Implied volatility Sell * @type {string} * @memberof OptionMarkPriceResponseInner */ askIV?: string; /** * Implied volatility mark * @type {string} * @memberof OptionMarkPriceResponseInner */ markIV?: string; /** * delta * @type {string} * @memberof OptionMarkPriceResponseInner */ delta?: string; /** * theta * @type {string} * @memberof OptionMarkPriceResponseInner */ theta?: string; /** * gamma * @type {string} * @memberof OptionMarkPriceResponseInner */ gamma?: string; /** * vega * @type {string} * @memberof OptionMarkPriceResponseInner */ vega?: string; /** * Current highest buy price * @type {string} * @memberof OptionMarkPriceResponseInner */ highPriceLimit?: string; /** * Current lowest sell price * @type {string} * @memberof OptionMarkPriceResponseInner */ lowPriceLimit?: string; /** * risk free rate * @type {string} * @memberof OptionMarkPriceResponseInner */ riskFreeInterest?: string; } //#endregion //#region src/rest-api/types/option-mark-price-response.d.ts /** * * @export * @interface OptionMarkPriceResponse */ interface OptionMarkPriceResponse$1 extends Array {} //#endregion //#region src/rest-api/types/option-position-information-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 OptionPositionInformationResponseInner */ interface OptionPositionInformationResponseInner { /** * Average entry price * @type {string} * @memberof OptionPositionInformationResponseInner */ entryPrice?: string; /** * Option trading pair * @type {string} * @memberof OptionPositionInformationResponseInner */ symbol?: string; /** * Position direction * @type {string} * @memberof OptionPositionInformationResponseInner */ side?: string; /** * Number of positions (positive numbers represent long positions, negative number represent short positions) * @type {string} * @memberof OptionPositionInformationResponseInner */ quantity?: string; /** * Current market value * @type {string} * @memberof OptionPositionInformationResponseInner */ markValue?: string; /** * Unrealized profit/loss * @type {string} * @memberof OptionPositionInformationResponseInner */ unrealizedPNL?: string; /** * Mark price * @type {string} * @memberof OptionPositionInformationResponseInner */ markPrice?: string; /** * Strike price * @type {string} * @memberof OptionPositionInformationResponseInner */ strikePrice?: string; /** * Exercise time * @type {number | bigint} * @memberof OptionPositionInformationResponseInner */ expiryDate?: number | bigint; /** * price Scale * @type {number | bigint} * @memberof OptionPositionInformationResponseInner */ priceScale?: number | bigint; /** * quantity Scale * @type {number | bigint} * @memberof OptionPositionInformationResponseInner */ quantityScale?: number | bigint; /** * option type * @type {string} * @memberof OptionPositionInformationResponseInner */ optionSide?: string; /** * quote asset * @type {string} * @memberof OptionPositionInformationResponseInner */ quoteAsset?: string; /** * last update time * @type {number | bigint} * @memberof OptionPositionInformationResponseInner */ time?: number | bigint; /** * buy order qty * @type {string} * @memberof OptionPositionInformationResponseInner */ bidQuantity?: string; /** * sell order qty * @type {string} * @memberof OptionPositionInformationResponseInner */ askQuantity?: string; } //#endregion //#region src/rest-api/types/option-position-information-response.d.ts /** * * @export * @interface OptionPositionInformationResponse */ interface OptionPositionInformationResponse extends Array {} //#endregion //#region src/rest-api/types/order-book-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 { /** * 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>; /** * transaction time * @type {number | bigint} * @memberof OrderBookResponse */ T?: number | bigint; /** * update id * @type {number | bigint} * @memberof OrderBookResponse */ lastUpdateId?: number | bigint; } //#endregion //#region src/rest-api/types/place-multiple-orders-orders-parameter-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 PlaceMultipleOrdersOrdersParameterInner */ interface PlaceMultipleOrdersOrdersParameterInner { /** * * @type {string} * @memberof PlaceMultipleOrdersOrdersParameterInner */ symbol: string; /** * * @type {string} * @memberof PlaceMultipleOrdersOrdersParameterInner */ side: PlaceMultipleOrdersOrdersParameterInnerSideEnum; /** * * @type {string} * @memberof PlaceMultipleOrdersOrdersParameterInner */ type: PlaceMultipleOrdersOrdersParameterInnerTypeEnum; /** * Order Quantity * @type {number} * @memberof PlaceMultipleOrdersOrdersParameterInner */ quantity: number; /** * Order Price * @type {number} * @memberof PlaceMultipleOrdersOrdersParameterInner */ price?: number; /** * * @type {string} * @memberof PlaceMultipleOrdersOrdersParameterInner */ timeInForce?: PlaceMultipleOrdersOrdersParameterInnerTimeInForceEnum; /** * * @type {boolean} * @memberof PlaceMultipleOrdersOrdersParameterInner */ reduceOnly?: boolean; /** * * @type {boolean} * @memberof PlaceMultipleOrdersOrdersParameterInner */ postOnly?: boolean; /** * * @type {string} * @memberof PlaceMultipleOrdersOrdersParameterInner */ newOrderRespType?: PlaceMultipleOrdersOrdersParameterInnerNewOrderRespTypeEnum; /** * User-defined order ID cannot be repeated in pending orders * @type {string} * @memberof PlaceMultipleOrdersOrdersParameterInner */ clientOrderId?: string; /** * is market maker protection order * @type {boolean} * @memberof PlaceMultipleOrdersOrdersParameterInner */ isMmp?: boolean; /** * EXPIRE_TAKER:expire taker order when STP triggers/ EXPIRE_MAKER:expire maker order when STP triggers/ EXPIRE_BOTH:expire both orders when STP triggers; Default EXPIRE_MAKER * @type {string} * @memberof PlaceMultipleOrdersOrdersParameterInner */ selfTradePreventionMode?: PlaceMultipleOrdersOrdersParameterInnerSelfTradePreventionModeEnum; } declare const PlaceMultipleOrdersOrdersParameterInnerSideEnum: { readonly BUY: "BUY"; readonly SELL: "SELL"; }; type PlaceMultipleOrdersOrdersParameterInnerSideEnum = (typeof PlaceMultipleOrdersOrdersParameterInnerSideEnum)[keyof typeof PlaceMultipleOrdersOrdersParameterInnerSideEnum]; declare const PlaceMultipleOrdersOrdersParameterInnerTypeEnum: { readonly LIMIT: "LIMIT"; }; type PlaceMultipleOrdersOrdersParameterInnerTypeEnum = (typeof PlaceMultipleOrdersOrdersParameterInnerTypeEnum)[keyof typeof PlaceMultipleOrdersOrdersParameterInnerTypeEnum]; declare const PlaceMultipleOrdersOrdersParameterInnerTimeInForceEnum: { readonly GTC: "GTC"; readonly IOC: "IOC"; readonly FOK: "FOK"; readonly GTX: "GTX"; }; type PlaceMultipleOrdersOrdersParameterInnerTimeInForceEnum = (typeof PlaceMultipleOrdersOrdersParameterInnerTimeInForceEnum)[keyof typeof PlaceMultipleOrdersOrdersParameterInnerTimeInForceEnum]; declare const PlaceMultipleOrdersOrdersParameterInnerNewOrderRespTypeEnum: { readonly ACK: "ACK"; readonly RESULT: "RESULT"; }; type PlaceMultipleOrdersOrdersParameterInnerNewOrderRespTypeEnum = (typeof PlaceMultipleOrdersOrdersParameterInnerNewOrderRespTypeEnum)[keyof typeof PlaceMultipleOrdersOrdersParameterInnerNewOrderRespTypeEnum]; declare const PlaceMultipleOrdersOrdersParameterInnerSelfTradePreventionModeEnum: { readonly EXPIRE_TAKER: "EXPIRE_TAKER"; readonly EXPIRE_MAKER: "EXPIRE_MAKER"; readonly EXPIRE_BOTH: "EXPIRE_BOTH"; }; type PlaceMultipleOrdersOrdersParameterInnerSelfTradePreventionModeEnum = (typeof PlaceMultipleOrdersOrdersParameterInnerSelfTradePreventionModeEnum)[keyof typeof PlaceMultipleOrdersOrdersParameterInnerSelfTradePreventionModeEnum]; //#endregion //#region src/rest-api/types/place-multiple-orders-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 { /** * System order number * @type {number | bigint} * @memberof PlaceMultipleOrdersResponseInner */ orderId?: number | bigint; /** * Option trading pair * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ symbol?: string; /** * Order Price * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ price?: string; /** * Order Quantity * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ quantity?: string; /** * Number of executed quantity * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ executedQty?: string; /** * fee * @type {number | bigint} * @memberof PlaceMultipleOrdersResponseInner */ fee?: number | bigint; /** * Buy/sell direction * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ side?: string; /** * Order type * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ type?: string; /** * Time in force method * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ timeInForce?: string; /** * Order is reduce only Y/N * @type {boolean} * @memberof PlaceMultipleOrdersResponseInner */ reduceOnly?: boolean; /** * post Only * @type {boolean} * @memberof PlaceMultipleOrdersResponseInner */ postOnly?: boolean; /** * Order Time * @type {number | bigint} * @memberof PlaceMultipleOrdersResponseInner */ createTime?: number | bigint; /** * Update time * @type {number | bigint} * @memberof PlaceMultipleOrdersResponseInner */ updateTime?: number | bigint; /** * Order status * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ status?: string; /** * Average price of completed trade * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ avgPrice?: string; /** * Client order ID * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ clientOrderId?: string; /** * price Scale * @type {number | bigint} * @memberof PlaceMultipleOrdersResponseInner */ priceScale?: number | bigint; /** * quantity Scale * @type {number | bigint} * @memberof PlaceMultipleOrdersResponseInner */ quantityScale?: number | bigint; /** * option Side * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ optionSide?: string; /** * quote Asset * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ quoteAsset?: string; /** * mmp * @type {boolean} * @memberof PlaceMultipleOrdersResponseInner */ mmp?: boolean; /** * * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ selfTradePreventionMode?: string; /** * * @type {string} * @memberof PlaceMultipleOrdersResponseInner */ source?: 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/query-block-trade-details-response-legs-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 QueryBlockTradeDetailsResponseLegsInner */ interface QueryBlockTradeDetailsResponseLegsInner { /** * symbol * @type {string} * @memberof QueryBlockTradeDetailsResponseLegsInner */ symbol?: string; /** * side * @type {string} * @memberof QueryBlockTradeDetailsResponseLegsInner */ side?: string; /** * quantity * @type {string} * @memberof QueryBlockTradeDetailsResponseLegsInner */ quantity?: string; /** * price * @type {string} * @memberof QueryBlockTradeDetailsResponseLegsInner */ price?: string; } //#endregion //#region src/rest-api/types/query-block-trade-details-response.d.ts /** * * @export * @interface QueryBlockTradeDetailsResponse */ interface QueryBlockTradeDetailsResponse { /** * block Trade Settlement Key * @type {string} * @memberof QueryBlockTradeDetailsResponse */ blockTradeSettlementKey?: string; /** * expire Time * @type {number | bigint} * @memberof QueryBlockTradeDetailsResponse */ expireTime?: number | bigint; /** * liquidity * @type {string} * @memberof QueryBlockTradeDetailsResponse */ liquidity?: string; /** * status * @type {string} * @memberof QueryBlockTradeDetailsResponse */ status?: string; /** * create Time * @type {number | bigint} * @memberof QueryBlockTradeDetailsResponse */ createTime?: number | bigint; /** * legs * @type {Array} * @memberof QueryBlockTradeDetailsResponse */ legs?: Array; } //#endregion //#region src/rest-api/types/query-block-trade-order-response-inner.d.ts /** * * @export * @interface QueryBlockTradeOrderResponseInner */ interface QueryBlockTradeOrderResponseInner { /** * block Trade Settlement Key * @type {string} * @memberof QueryBlockTradeOrderResponseInner */ blockTradeSettlementKey?: string; /** * expire Time * @type {number | bigint} * @memberof QueryBlockTradeOrderResponseInner */ expireTime?: number | bigint; /** * liquidity * @type {string} * @memberof QueryBlockTradeOrderResponseInner */ liquidity?: string; /** * status * @type {string} * @memberof QueryBlockTradeOrderResponseInner */ status?: string; /** * create Time * @type {number | bigint} * @memberof QueryBlockTradeOrderResponseInner */ createTime?: number | bigint; /** * legs * @type {Array} * @memberof QueryBlockTradeOrderResponseInner */ legs?: Array; } //#endregion //#region src/rest-api/types/query-block-trade-order-response.d.ts /** * * @export * @interface QueryBlockTradeOrderResponse */ interface QueryBlockTradeOrderResponse extends Array {} //#endregion //#region src/rest-api/types/query-current-open-option-orders-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 QueryCurrentOpenOptionOrdersResponseInner */ interface QueryCurrentOpenOptionOrdersResponseInner { /** * System order number * @type {number | bigint} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ orderId?: number | bigint; /** * Option trading pair * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ symbol?: string; /** * Order Price * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ price?: string; /** * Order Quantity * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ quantity?: string; /** * Number of completed trades * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ executedQty?: string; /** * Buy/sell direction * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ side?: string; /** * Order type * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ type?: string; /** * Time in force method * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ timeInForce?: string; /** * Order is reduce only Y/N * @type {boolean} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ reduceOnly?: boolean; /** * Order Time * @type {number | bigint} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ createTime?: number | bigint; /** * Update Time * @type {number | bigint} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ updateTime?: number | bigint; /** * Order status * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ status?: string; /** * Average price of completed trade * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ avgPrice?: string; /** * Client order ID * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ clientOrderId?: string; /** * price Scale * @type {number | bigint} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ priceScale?: number | bigint; /** * quantity Scale * @type {number | bigint} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ quantityScale?: number | bigint; /** * option Side * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ optionSide?: string; /** * quote Asset * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ quoteAsset?: string; /** * mmp * @type {boolean} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ mmp?: boolean; /** * * @type {string} * @memberof QueryCurrentOpenOptionOrdersResponseInner */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/query-current-open-option-orders-response.d.ts /** * * @export * @interface QueryCurrentOpenOptionOrdersResponse */ interface QueryCurrentOpenOptionOrdersResponse extends Array {} //#endregion //#region src/rest-api/types/query-option-order-history-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 QueryOptionOrderHistoryResponseInner */ interface QueryOptionOrderHistoryResponseInner { /** * order Id * @type {number | bigint} * @memberof QueryOptionOrderHistoryResponseInner */ orderId?: number | bigint; /** * symbol * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ symbol?: string; /** * price * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ price?: string; /** * quantity * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ quantity?: string; /** * executed Qty * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ executedQty?: string; /** * side * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ side?: string; /** * type * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ type?: string; /** * time In Force * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ timeInForce?: string; /** * reduce Only * @type {boolean} * @memberof QueryOptionOrderHistoryResponseInner */ reduceOnly?: boolean; /** * create Time * @type {number | bigint} * @memberof QueryOptionOrderHistoryResponseInner */ createTime?: number | bigint; /** * update Time * @type {number | bigint} * @memberof QueryOptionOrderHistoryResponseInner */ updateTime?: number | bigint; /** * status * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ status?: string; /** * avg Price * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ avgPrice?: string; /** * client Order Id * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ clientOrderId?: string; /** * price Scale * @type {number | bigint} * @memberof QueryOptionOrderHistoryResponseInner */ priceScale?: number | bigint; /** * quantity Scale * @type {number | bigint} * @memberof QueryOptionOrderHistoryResponseInner */ quantityScale?: number | bigint; /** * option Side * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ optionSide?: string; /** * quote Asset * @type {string} * @memberof QueryOptionOrderHistoryResponseInner */ quoteAsset?: string; /** * mmp * @type {boolean} * @memberof QueryOptionOrderHistoryResponseInner */ mmp?: boolean; } //#endregion //#region src/rest-api/types/query-option-order-history-response.d.ts /** * * @export * @interface QueryOptionOrderHistoryResponse */ interface QueryOptionOrderHistoryResponse extends Array {} //#endregion //#region src/rest-api/types/query-single-order-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 QuerySingleOrderResponse */ interface QuerySingleOrderResponse { /** * System order id * @type {number | bigint} * @memberof QuerySingleOrderResponse */ orderId?: number | bigint; /** * Option trading pair * @type {string} * @memberof QuerySingleOrderResponse */ symbol?: string; /** * Order Price * @type {string} * @memberof QuerySingleOrderResponse */ price?: string; /** * Order Quantity * @type {string} * @memberof QuerySingleOrderResponse */ quantity?: string; /** * Number of executed quantity * @type {string} * @memberof QuerySingleOrderResponse */ executedQty?: string; /** * Buy/sell direction * @type {string} * @memberof QuerySingleOrderResponse */ side?: string; /** * Order type * @type {string} * @memberof QuerySingleOrderResponse */ type?: string; /** * Time in force method * @type {string} * @memberof QuerySingleOrderResponse */ timeInForce?: string; /** * Order is reduce only Y/N * @type {boolean} * @memberof QuerySingleOrderResponse */ reduceOnly?: boolean; /** * post Only * @type {boolean} * @memberof QuerySingleOrderResponse */ postOnly?: boolean; /** * Order Time * @type {number | bigint} * @memberof QuerySingleOrderResponse */ createTime?: number | bigint; /** * Update time * @type {number | bigint} * @memberof QuerySingleOrderResponse */ updateTime?: number | bigint; /** * Order status * @type {string} * @memberof QuerySingleOrderResponse */ status?: string; /** * Average price of completed trade * @type {string} * @memberof QuerySingleOrderResponse */ avgPrice?: string; /** * Client order ID * @type {string} * @memberof QuerySingleOrderResponse */ clientOrderId?: string; /** * price Scale * @type {number | bigint} * @memberof QuerySingleOrderResponse */ priceScale?: number | bigint; /** * quantity Scale * @type {number | bigint} * @memberof QuerySingleOrderResponse */ quantityScale?: number | bigint; /** * option Side * @type {string} * @memberof QuerySingleOrderResponse */ optionSide?: string; /** * quote Asset * @type {string} * @memberof QuerySingleOrderResponse */ quoteAsset?: string; /** * mmp * @type {boolean} * @memberof QuerySingleOrderResponse */ mmp?: boolean; /** * Self trade prevention mode. * @type {string} * @memberof QuerySingleOrderResponse */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/recent-block-trades-list-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 RecentBlockTradesListResponseInner */ interface RecentBlockTradesListResponseInner { /** * id * @type {number | bigint} * @memberof RecentBlockTradesListResponseInner */ id?: number | bigint; /** * trade Id * @type {number | bigint} * @memberof RecentBlockTradesListResponseInner */ tradeId?: number | bigint; /** * symbol * @type {string} * @memberof RecentBlockTradesListResponseInner */ symbol?: string; /** * price * @type {string} * @memberof RecentBlockTradesListResponseInner */ price?: string; /** * qty * @type {string} * @memberof RecentBlockTradesListResponseInner */ qty?: string; /** * quote Qty * @type {string} * @memberof RecentBlockTradesListResponseInner */ quoteQty?: string; /** * side * @type {number | bigint} * @memberof RecentBlockTradesListResponseInner */ side?: number | bigint; /** * time * @type {number | bigint} * @memberof RecentBlockTradesListResponseInner */ time?: number | bigint; } //#endregion //#region src/rest-api/types/recent-block-trades-list-response.d.ts /** * * @export * @interface RecentBlockTradesListResponse */ interface RecentBlockTradesListResponse extends Array {} //#endregion //#region src/rest-api/types/recent-trades-list-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 { /** * id * @type {number | bigint} * @memberof RecentTradesListResponseInner */ id?: number | bigint; /** * TradeId * @type {number | bigint} * @memberof RecentTradesListResponseInner */ tradeId?: number | bigint; /** * Option trading pair * @type {string} * @memberof RecentTradesListResponseInner */ symbol?: string; /** * Completed trade price * @type {string} * @memberof RecentTradesListResponseInner */ price?: string; /** * Completed trade quantity * @type {string} * @memberof RecentTradesListResponseInner */ qty?: string; /** * Completed trade amount * @type {string} * @memberof RecentTradesListResponseInner */ quoteQty?: string; /** * Completed trade direction(-1 Sell,1 Buy) * @type {number | bigint} * @memberof RecentTradesListResponseInner */ side?: number | bigint; /** * Time * @type {number | bigint} * @memberof RecentTradesListResponseInner */ time?: number | bigint; } //#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/reset-market-maker-protection-config-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 ResetMarketMakerProtectionConfigResponse */ interface ResetMarketMakerProtectionConfigResponse { /** * underlying Id * @type {number | bigint} * @memberof ResetMarketMakerProtectionConfigResponse */ underlyingId?: number | bigint; /** * underlying * @type {string} * @memberof ResetMarketMakerProtectionConfigResponse */ underlying?: string; /** * window Time In Milliseconds * @type {number | bigint} * @memberof ResetMarketMakerProtectionConfigResponse */ windowTimeInMilliseconds?: number | bigint; /** * frozen Time In Milliseconds * @type {number | bigint} * @memberof ResetMarketMakerProtectionConfigResponse */ frozenTimeInMilliseconds?: number | bigint; /** * qty Limit * @type {string} * @memberof ResetMarketMakerProtectionConfigResponse */ qtyLimit?: string; /** * delta Limit * @type {string} * @memberof ResetMarketMakerProtectionConfigResponse */ deltaLimit?: string; /** * last Trigger Time * @type {number | bigint} * @memberof ResetMarketMakerProtectionConfigResponse */ lastTriggerTime?: number | bigint; } //#endregion //#region src/rest-api/types/set-auto-cancel-all-open-orders-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 SetAutoCancelAllOpenOrdersResponse */ interface SetAutoCancelAllOpenOrdersResponse { /** * underlying * @type {string} * @memberof SetAutoCancelAllOpenOrdersResponse */ underlying?: string; /** * countdown Time * @type {number | bigint} * @memberof SetAutoCancelAllOpenOrdersResponse */ countdownTime?: number | bigint; } //#endregion //#region src/rest-api/types/set-market-maker-protection-config-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 SetMarketMakerProtectionConfigResponse */ interface SetMarketMakerProtectionConfigResponse { /** * underlying Id * @type {number | bigint} * @memberof SetMarketMakerProtectionConfigResponse */ underlyingId?: number | bigint; /** * underlying * @type {string} * @memberof SetMarketMakerProtectionConfigResponse */ underlying?: string; /** * window Time In Milliseconds * @type {number | bigint} * @memberof SetMarketMakerProtectionConfigResponse */ windowTimeInMilliseconds?: number | bigint; /** * frozen Time In Milliseconds * @type {number | bigint} * @memberof SetMarketMakerProtectionConfigResponse */ frozenTimeInMilliseconds?: number | bigint; /** * qty Limit * @type {string} * @memberof SetMarketMakerProtectionConfigResponse */ qtyLimit?: string; /** * delta Limit * @type {string} * @memberof SetMarketMakerProtectionConfigResponse */ deltaLimit?: string; /** * last Trigger Time * @type {number | bigint} * @memberof SetMarketMakerProtectionConfigResponse */ lastTriggerTime?: number | bigint; } //#endregion //#region src/rest-api/types/start-user-data-stream-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 { /** * listen Key * @type {string} * @memberof StartUserDataStreamResponse */ listenKey?: string; /** * Listen key expiration timestamp in milliseconds * @type {number | bigint} * @memberof StartUserDataStreamResponse */ expiration?: number | bigint; } //#endregion //#region src/rest-api/types/ticker24hr-price-change-statistics-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 { /** * symbol * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ symbol?: string; /** * 24-hour price change * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ priceChange?: string; /** * 24-hour percent price change * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ priceChangePercent?: string; /** * Last trade price * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ lastPrice?: string; /** * Last trade amount * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ lastQty?: string; /** * 24-hour open price * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ open?: string; /** * 24-hour high * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ high?: string; /** * 24-hour low * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ low?: string; /** * Trading volume(contracts) * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ volume?: string; /** * Trade amount(in quote asset) * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ amount?: string; /** * The best buy price * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ bidPrice?: string; /** * The best sell price * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ askPrice?: string; /** * Time the first trade occurred within the last 24 hours * @type {number | bigint} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ openTime?: number | bigint; /** * Time the last trade occurred within the last 24 hours * @type {number | bigint} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ closeTime?: number | bigint; /** * First trade ID * @type {number | bigint} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ firstTradeId?: number | bigint; /** * Number of trades * @type {number | bigint} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ tradeCount?: number | bigint; /** * Strike price * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ strikePrice?: string; /** * return estimated settlement price one hour before exercise, return index price at other times * @type {string} * @memberof Ticker24hrPriceChangeStatisticsResponseInner */ exercisePrice?: string; } //#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/tradfi-options-contract-response.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 TradfiOptionsContractResponse */ interface TradfiOptionsContractResponse { /** * * @type {number | bigint} * @memberof TradfiOptionsContractResponse */ code?: number | bigint; /** * * @type {string} * @memberof TradfiOptionsContractResponse */ msg?: string; } //#endregion //#region src/rest-api/types/user-commission-response-commissions-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 UserCommissionResponseCommissionsInner */ interface UserCommissionResponseCommissionsInner { /** * underlying * @type {string} * @memberof UserCommissionResponseCommissionsInner */ underlying?: string; /** * maker Fee * @type {string} * @memberof UserCommissionResponseCommissionsInner */ makerFee?: string; /** * taker Fee * @type {string} * @memberof UserCommissionResponseCommissionsInner */ takerFee?: string; } //#endregion //#region src/rest-api/types/user-commission-response.d.ts /** * * @export * @interface UserCommissionResponse */ interface UserCommissionResponse { /** * commissions * @type {Array} * @memberof UserCommissionResponse */ commissions?: Array; } //#endregion //#region src/rest-api/types/user-exercise-record-response-inner.d.ts /** * Options REST API * * Access market data, manage accounts, and trade Binance Options. * * 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 UserExerciseRecordResponseInner */ interface UserExerciseRecordResponseInner { /** * id * @type {string} * @memberof UserExerciseRecordResponseInner */ id?: string; /** * currency * @type {string} * @memberof UserExerciseRecordResponseInner */ currency?: string; /** * symbol * @type {string} * @memberof UserExerciseRecordResponseInner */ symbol?: string; /** * exercise Price * @type {string} * @memberof UserExerciseRecordResponseInner */ exercisePrice?: string; /** * quantity * @type {string} * @memberof UserExerciseRecordResponseInner */ quantity?: string; /** * amount * @type {string} * @memberof UserExerciseRecordResponseInner */ amount?: string; /** * fee * @type {string} * @memberof UserExerciseRecordResponseInner */ fee?: string; /** * create Date * @type {number | bigint} * @memberof UserExerciseRecordResponseInner */ createDate?: number | bigint; /** * price Scale * @type {number | bigint} * @memberof UserExerciseRecordResponseInner */ priceScale?: number | bigint; /** * quantity Scale * @type {number | bigint} * @memberof UserExerciseRecordResponseInner */ quantityScale?: number | bigint; /** * option Side * @type {string} * @memberof UserExerciseRecordResponseInner */ optionSide?: string; /** * position Side * @type {string} * @memberof UserExerciseRecordResponseInner */ positionSide?: string; /** * quote Asset * @type {string} * @memberof UserExerciseRecordResponseInner */ quoteAsset?: string; } //#endregion //#region src/rest-api/types/user-exercise-record-response.d.ts /** * * @export * @interface UserExerciseRecordResponse */ interface UserExerciseRecordResponse extends Array {} //#endregion //#region src/rest-api/modules/account-api.d.ts /** * AccountApi - interface * @interface AccountApi */ interface AccountApiInterface { /** * Query account funding flows. * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Only support querying data in the past 3 months * * @summary Account Funding Flow (USER_DATA) * @param {AccountFundingFlowRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ accountFundingFlow(requestParameters: AccountFundingFlowRequest): Promise>; /** * Get current account information. * * Weight(IP): 3 * * Security Type: USER_DATA * * @summary Option Margin Account Information (USER_DATA) * @param {OptionMarginAccountInformationRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ optionMarginAccountInformation(requestParameters?: OptionMarginAccountInformationRequest): Promise>; } /** * Request parameters for accountFundingFlow operation in AccountApi. * @interface AccountFundingFlowRequest */ interface AccountFundingFlowRequest { /** * Asset type, only support USDT as of now * @type {'USDT'} * @memberof AccountApiAccountFundingFlow */ readonly currency: AccountFundingFlowCurrencyEnum; /** * Return the recordId and subsequent data, the latest data is returned by default * @type {number | bigint} * @memberof AccountApiAccountFundingFlow */ readonly recordId?: number | bigint; /** * Start Time, e.g 1593511200000 * @type {number | bigint} * @memberof AccountApiAccountFundingFlow */ readonly startTime?: number | bigint; /** * End Time, e.g 1593512200000 * @type {number | bigint} * @memberof AccountApiAccountFundingFlow */ readonly endTime?: number | bigint; /** * Number of result sets returned * @type {number | bigint} * @memberof AccountApiAccountFundingFlow */ readonly limit?: number | bigint; /** * Recv Window. * @type {number | bigint} * @memberof AccountApiAccountFundingFlow */ readonly recvWindow?: number | bigint; } /** * Request parameters for optionMarginAccountInformation operation in AccountApi. * @interface OptionMarginAccountInformationRequest */ interface OptionMarginAccountInformationRequest { /** * Recv Window. * @type {number | bigint} * @memberof AccountApiOptionMarginAccountInformation */ readonly recvWindow?: number | bigint; } /** * AccountApi - object-oriented interface * @class AccountApi */ declare class AccountApi implements AccountApiInterface { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Query account funding flows. * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Only support querying data in the past 3 months * * @summary Account Funding Flow (USER_DATA) * @param {AccountFundingFlowRequest} 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-options/api/rest-api/account#account-funding-flow Binance API Documentation} */ accountFundingFlow(requestParameters: AccountFundingFlowRequest): Promise>; /** * Get current account information. * * Weight(IP): 3 * * Security Type: USER_DATA * * @summary Option Margin Account Information (USER_DATA) * @param {OptionMarginAccountInformationRequest} 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-options/api/rest-api/account#option-margin-account-information Binance API Documentation} */ optionMarginAccountInformation(requestParameters?: OptionMarginAccountInformationRequest): Promise>; } declare enum AccountFundingFlowCurrencyEnum { USDT = "USDT", } //#endregion //#region src/rest-api/modules/market-data-api.d.ts /** * MarketDataApi - interface * @interface MarketDataApi */ interface MarketDataApiInterface { /** * 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>; /** * 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 historical exercise records. * * REALISTIC_VALUE_STRICKEN -> Exercised * EXTRINSIC_VALUE_EXPIRED -> Expired OTM * * Weight(IP): 3 * * @summary Historical Exercise Records * @param {HistoricalExerciseRecordsRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ historicalExerciseRecords(requestParameters?: HistoricalExerciseRecordsRequest): Promise>; /** * Get spot index price for option underlying. * * Weight(IP): 1 * * @summary Index Price * @param {IndexPriceRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ indexPrice(requestParameters: IndexPriceRequest): Promise>; /** * Kline/candlestick bars for an option symbol. Klines are uniquely identified by their open time. * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent klines are returned. * * @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>; /** * Get open interest for specific underlying asset on specific expiration date. * * Weight(IP): 0 * * @summary Open Interest * @param {OpenInterestRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ openInterest(requestParameters: OpenInterestRequest$1): Promise>; /** * Option mark price and greek info. * * Weight(IP): 5 * * @summary Option Mark Price * @param {OptionMarkPriceRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ optionMarkPrice(requestParameters?: OptionMarkPriceRequest$1): Promise>; /** * Check orderbook depth on specific symbol * * Weight: limit | weight * ------------ | ------------ * 5, 10, 20, 50 | 1 * 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>; /** * Get recent block trades * * Weight(IP): 5 * * @summary Recent Block Trades List * @param {RecentBlockTradesListRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketDataApiInterface */ recentBlockTradesList(requestParameters?: RecentBlockTradesListRequest): Promise>; /** * Get recent market trades * * Weight(IP): 5 * * @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>; /** * 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 * * @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>; } /** * Request parameters for historicalExerciseRecords operation in MarketDataApi. * @interface HistoricalExerciseRecordsRequest */ interface HistoricalExerciseRecordsRequest { /** * Underlying asset. * @type {string} * @memberof MarketDataApiHistoricalExerciseRecords */ readonly underlying?: string; /** * Start Time, e.g 1593511200000 * @type {number | bigint} * @memberof MarketDataApiHistoricalExerciseRecords */ readonly startTime?: number | bigint; /** * End Time, e.g 1593512200000 * @type {number | bigint} * @memberof MarketDataApiHistoricalExerciseRecords */ readonly endTime?: number | bigint; /** * Number of result sets returned * @type {number | bigint} * @memberof MarketDataApiHistoricalExerciseRecords */ readonly limit?: number | bigint; } /** * Request parameters for indexPrice operation in MarketDataApi. * @interface IndexPriceRequest */ interface IndexPriceRequest { /** * Underlying asset. * @type {string} * @memberof MarketDataApiIndexPrice */ readonly underlying: string; } /** * Request parameters for klineCandlestickData operation in MarketDataApi. * @interface KlineCandlestickDataRequest */ interface KlineCandlestickDataRequest { /** * Option trading pair * @type {string} * @memberof MarketDataApiKlineCandlestickData */ readonly symbol: string; /** * Time interval * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof MarketDataApiKlineCandlestickData */ readonly interval: KlineCandlestickDataIntervalEnum; /** * Start Time, e.g 1593511200000 * @type {number | bigint} * @memberof MarketDataApiKlineCandlestickData */ readonly startTime?: number | bigint; /** * End Time, e.g 1593512200000 * @type {number | bigint} * @memberof MarketDataApiKlineCandlestickData */ readonly endTime?: number | bigint; /** * Number of result sets returned * @type {number | bigint} * @memberof MarketDataApiKlineCandlestickData */ readonly limit?: number | bigint; } /** * Request parameters for openInterest operation in MarketDataApi. * @interface OpenInterestRequest */ interface OpenInterestRequest$1 { /** * Underlying asset. * @type {string} * @memberof MarketDataApiOpenInterest */ readonly underlyingAsset: string; /** * expiration date * @type {string} * @memberof MarketDataApiOpenInterest */ readonly expiration: string; } /** * Request parameters for optionMarkPrice operation in MarketDataApi. * @interface OptionMarkPriceRequest */ interface OptionMarkPriceRequest$1 { /** * Option trading pair * @type {string} * @memberof MarketDataApiOptionMarkPrice */ readonly symbol?: string; } /** * Request parameters for orderBook operation in MarketDataApi. * @interface OrderBookRequest */ interface OrderBookRequest { /** * Option trading pair * @type {string} * @memberof MarketDataApiOrderBook */ readonly symbol: string; /** * Default:100 Max:1000.Optional value:[10, 20, 50, 100, 500, 1000] * @type {number | bigint} * @memberof MarketDataApiOrderBook */ readonly limit?: number | bigint; } /** * Request parameters for recentBlockTradesList operation in MarketDataApi. * @interface RecentBlockTradesListRequest */ interface RecentBlockTradesListRequest { /** * Option trading pair * @type {string} * @memberof MarketDataApiRecentBlockTradesList */ readonly symbol?: string; /** * Number of records * @type {number | bigint} * @memberof MarketDataApiRecentBlockTradesList */ readonly limit?: number | bigint; } /** * Request parameters for recentTradesList operation in MarketDataApi. * @interface RecentTradesListRequest */ interface RecentTradesListRequest { /** * Option trading pair * @type {string} * @memberof MarketDataApiRecentTradesList */ readonly symbol: string; /** * Number of result sets returned * @type {number | bigint} * @memberof MarketDataApiRecentTradesList */ readonly limit?: number | bigint; } /** * Request parameters for ticker24hrPriceChangeStatistics operation in MarketDataApi. * @interface Ticker24hrPriceChangeStatisticsRequest */ interface Ticker24hrPriceChangeStatisticsRequest { /** * Option trading pair * @type {string} * @memberof MarketDataApiTicker24hrPriceChangeStatistics */ readonly symbol?: string; } /** * MarketDataApi - object-oriented interface * @class MarketDataApi */ declare class MarketDataApi implements MarketDataApiInterface { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * 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-options/api/rest-api/market-data#check-server-time Binance API Documentation} */ checkServerTime(): 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-options/api/rest-api/market-data#exchange-information Binance API Documentation} */ exchangeInformation(): Promise>; /** * Get historical exercise records. * * REALISTIC_VALUE_STRICKEN -> Exercised * EXTRINSIC_VALUE_EXPIRED -> Expired OTM * * Weight(IP): 3 * * @summary Historical Exercise Records * @param {HistoricalExerciseRecordsRequest} 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-options/api/rest-api/market-data#historical-exercise-records Binance API Documentation} */ historicalExerciseRecords(requestParameters?: HistoricalExerciseRecordsRequest): Promise>; /** * Get spot index price for option underlying. * * Weight(IP): 1 * * @summary Index Price * @param {IndexPriceRequest} 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-options/api/rest-api/market-data#index-price Binance API Documentation} */ indexPrice(requestParameters: IndexPriceRequest): Promise>; /** * Kline/candlestick bars for an option symbol. Klines are uniquely identified by their open time. * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent klines are returned. * * @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-options/api/rest-api/market-data#kline-candlestick-data Binance API Documentation} */ klineCandlestickData(requestParameters: KlineCandlestickDataRequest): Promise>; /** * Get open interest for specific underlying asset on specific expiration date. * * Weight(IP): 0 * * @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-options/api/rest-api/market-data#open-interest Binance API Documentation} */ openInterest(requestParameters: OpenInterestRequest$1): Promise>; /** * Option mark price and greek info. * * Weight(IP): 5 * * @summary Option Mark Price * @param {OptionMarkPriceRequest} 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-options/api/rest-api/market-data#option-mark-price Binance API Documentation} */ optionMarkPrice(requestParameters?: OptionMarkPriceRequest$1): Promise>; /** * Check orderbook depth on specific symbol * * Weight: limit | weight * ------------ | ------------ * 5, 10, 20, 50 | 1 * 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-options/api/rest-api/market-data#order-book Binance API Documentation} */ orderBook(requestParameters: OrderBookRequest): Promise>; /** * Get recent block trades * * Weight(IP): 5 * * @summary Recent Block Trades List * @param {RecentBlockTradesListRequest} 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-options/api/rest-api/market-data#recent-block-trades-list Binance API Documentation} */ recentBlockTradesList(requestParameters?: RecentBlockTradesListRequest): Promise>; /** * Get recent market trades * * Weight(IP): 5 * * @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-options/api/rest-api/market-data#recent-trades-list Binance API Documentation} */ recentTradesList(requestParameters: RecentTradesListRequest): 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-options/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 * * @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-options/api/rest-api/market-data#ticker24hr-price-change-statistics Binance API Documentation} */ ticker24hrPriceChangeStatistics(requestParameters?: Ticker24hrPriceChangeStatisticsRequest): Promise>; } 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", } //#endregion //#region src/rest-api/modules/market-maker-block-trade-api.d.ts /** * MarketMakerBlockTradeApi - interface * @interface MarketMakerBlockTradeApi */ interface MarketMakerBlockTradeApiInterface { /** * Accept a block trade order * * Weight(IP): 5 * * Security Type: TRADE * * @summary Accept Block Trade Order (TRADE) * @param {AcceptBlockTradeOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApiInterface */ acceptBlockTradeOrder(requestParameters: AcceptBlockTradeOrderRequest): Promise>; /** * Gets block trades for a specific account. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Account Block Trade List (USER_DATA) * @param {AccountBlockTradeListRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApiInterface */ accountBlockTradeList(requestParameters?: AccountBlockTradeListRequest): Promise>; /** * Cancel a block trade order. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Cancel Block Trade Order (TRADE) * @param {CancelBlockTradeOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApiInterface */ cancelBlockTradeOrder(requestParameters: CancelBlockTradeOrderRequest): Promise>; /** * Extends a block trade expire time by 30 mins from the current time. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Extend Block Trade Order (TRADE) * @param {ExtendBlockTradeOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApiInterface */ extendBlockTradeOrder(requestParameters: ExtendBlockTradeOrderRequest): Promise>; /** * Send in a new block trade order. * * Weight(IP): 5 * * Security Type: TRADE * * @summary New Block Trade Order (TRADE) * @param {NewBlockTradeOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApiInterface */ newBlockTradeOrder(requestParameters: NewBlockTradeOrderRequest): Promise>; /** * Query block trade details; returns block trade details from counterparty's perspective. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Query Block Trade Details (USER_DATA) * @param {QueryBlockTradeDetailsRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApiInterface */ queryBlockTradeDetails(requestParameters: QueryBlockTradeDetailsRequest): Promise>; /** * Check block trade order status. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Query Block Trade Order (TRADE) * @param {QueryBlockTradeOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApiInterface */ queryBlockTradeOrder(requestParameters?: QueryBlockTradeOrderRequest): Promise>; } /** * Request parameters for acceptBlockTradeOrder operation in MarketMakerBlockTradeApi. * @interface AcceptBlockTradeOrderRequest */ interface AcceptBlockTradeOrderRequest { /** * * @type {string} * @memberof MarketMakerBlockTradeApiAcceptBlockTradeOrder */ readonly blockOrderMatchingKey: string; /** * * @type {number | bigint} * @memberof MarketMakerBlockTradeApiAcceptBlockTradeOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for accountBlockTradeList operation in MarketMakerBlockTradeApi. * @interface AccountBlockTradeListRequest */ interface AccountBlockTradeListRequest { /** * End Time, e.g 1593512200000 * @type {number | bigint} * @memberof MarketMakerBlockTradeApiAccountBlockTradeList */ readonly endTime?: number | bigint; /** * Start Time, e.g 1593511200000 * @type {number | bigint} * @memberof MarketMakerBlockTradeApiAccountBlockTradeList */ readonly startTime?: number | bigint; /** * Underlying asset. * @type {string} * @memberof MarketMakerBlockTradeApiAccountBlockTradeList */ readonly underlying?: string; /** * Recv Window. * @type {number | bigint} * @memberof MarketMakerBlockTradeApiAccountBlockTradeList */ readonly recvWindow?: number | bigint; } /** * Request parameters for cancelBlockTradeOrder operation in MarketMakerBlockTradeApi. * @interface CancelBlockTradeOrderRequest */ interface CancelBlockTradeOrderRequest { /** * Block trade matching key. * @type {string} * @memberof MarketMakerBlockTradeApiCancelBlockTradeOrder */ readonly blockOrderMatchingKey: string; /** * Recv Window. * @type {number | bigint} * @memberof MarketMakerBlockTradeApiCancelBlockTradeOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for extendBlockTradeOrder operation in MarketMakerBlockTradeApi. * @interface ExtendBlockTradeOrderRequest */ interface ExtendBlockTradeOrderRequest { /** * * @type {string} * @memberof MarketMakerBlockTradeApiExtendBlockTradeOrder */ readonly blockOrderMatchingKey: string; /** * * @type {number | bigint} * @memberof MarketMakerBlockTradeApiExtendBlockTradeOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for newBlockTradeOrder operation in MarketMakerBlockTradeApi. * @interface NewBlockTradeOrderRequest */ interface NewBlockTradeOrderRequest { /** * * @type {'MAKER' | 'TAKER'} * @memberof MarketMakerBlockTradeApiNewBlockTradeOrder */ readonly liquidity: NewBlockTradeOrderLiquidityEnum; /** * Max 1 (only single leg supported), list of legs parameters in JSON; example: eapi/v1/block/order/create?orders=[{"symbol":"BTC-210115-35000-C", "price":"100","quantity":"0.0002","side":"BUY","type":"LIMIT"}] * @type {Array} * @memberof MarketMakerBlockTradeApiNewBlockTradeOrder */ readonly legs: Array; /** * * @type {number | bigint} * @memberof MarketMakerBlockTradeApiNewBlockTradeOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for queryBlockTradeDetails operation in MarketMakerBlockTradeApi. * @interface QueryBlockTradeDetailsRequest */ interface QueryBlockTradeDetailsRequest { /** * Block trade matching key. * @type {string} * @memberof MarketMakerBlockTradeApiQueryBlockTradeDetails */ readonly blockOrderMatchingKey: string; /** * Recv Window. * @type {number | bigint} * @memberof MarketMakerBlockTradeApiQueryBlockTradeDetails */ readonly recvWindow?: number | bigint; } /** * Request parameters for queryBlockTradeOrder operation in MarketMakerBlockTradeApi. * @interface QueryBlockTradeOrderRequest */ interface QueryBlockTradeOrderRequest { /** * If specified, returns the specific block trade associated with the blockOrderMatchingKey * @type {string} * @memberof MarketMakerBlockTradeApiQueryBlockTradeOrder */ readonly blockOrderMatchingKey?: string; /** * End Time, e.g 1593512200000 * @type {number | bigint} * @memberof MarketMakerBlockTradeApiQueryBlockTradeOrder */ readonly endTime?: number | bigint; /** * Start Time, e.g 1593511200000 * @type {number | bigint} * @memberof MarketMakerBlockTradeApiQueryBlockTradeOrder */ readonly startTime?: number | bigint; /** * Underlying asset. * @type {string} * @memberof MarketMakerBlockTradeApiQueryBlockTradeOrder */ readonly underlying?: string; /** * Recv Window. * @type {number | bigint} * @memberof MarketMakerBlockTradeApiQueryBlockTradeOrder */ readonly recvWindow?: number | bigint; } /** * MarketMakerBlockTradeApi - object-oriented interface * @class MarketMakerBlockTradeApi */ declare class MarketMakerBlockTradeApi implements MarketMakerBlockTradeApiInterface { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Accept a block trade order * * Weight(IP): 5 * * Security Type: TRADE * * @summary Accept Block Trade Order (TRADE) * @param {AcceptBlockTradeOrderRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-block-trade#accept-block-trade-order Binance API Documentation} */ acceptBlockTradeOrder(requestParameters: AcceptBlockTradeOrderRequest): Promise>; /** * Gets block trades for a specific account. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Account Block Trade List (USER_DATA) * @param {AccountBlockTradeListRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-block-trade#account-block-trade-list Binance API Documentation} */ accountBlockTradeList(requestParameters?: AccountBlockTradeListRequest): Promise>; /** * Cancel a block trade order. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Cancel Block Trade Order (TRADE) * @param {CancelBlockTradeOrderRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-block-trade#cancel-block-trade-order Binance API Documentation} */ cancelBlockTradeOrder(requestParameters: CancelBlockTradeOrderRequest): Promise>; /** * Extends a block trade expire time by 30 mins from the current time. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Extend Block Trade Order (TRADE) * @param {ExtendBlockTradeOrderRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-block-trade#extend-block-trade-order Binance API Documentation} */ extendBlockTradeOrder(requestParameters: ExtendBlockTradeOrderRequest): Promise>; /** * Send in a new block trade order. * * Weight(IP): 5 * * Security Type: TRADE * * @summary New Block Trade Order (TRADE) * @param {NewBlockTradeOrderRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-block-trade#new-block-trade-order Binance API Documentation} */ newBlockTradeOrder(requestParameters: NewBlockTradeOrderRequest): Promise>; /** * Query block trade details; returns block trade details from counterparty's perspective. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Query Block Trade Details (USER_DATA) * @param {QueryBlockTradeDetailsRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-block-trade#query-block-trade-details Binance API Documentation} */ queryBlockTradeDetails(requestParameters: QueryBlockTradeDetailsRequest): Promise>; /** * Check block trade order status. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Query Block Trade Order (TRADE) * @param {QueryBlockTradeOrderRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerBlockTradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-block-trade#query-block-trade-order Binance API Documentation} */ queryBlockTradeOrder(requestParameters?: QueryBlockTradeOrderRequest): Promise>; } declare enum NewBlockTradeOrderLiquidityEnum { MAKER = "MAKER", TAKER = "TAKER", } //#endregion //#region src/rest-api/modules/market-maker-endpoints-api.d.ts /** * MarketMakerEndpointsApi - interface * @interface MarketMakerEndpointsApi */ interface MarketMakerEndpointsApiInterface { /** * This endpoint resets the time from which the countdown will begin to the time this messaged is received. It should be called repeatedly as heartbeats. Multiple heartbeats can be updated at once by specifying the underlying symbols as a list (ex. BTCUSDT,ETHUSDT) in the underlyings parameter. * * Weight(IP): 10 * * Security Type: TRADE * * Notes: * - The response will only include underlying symbols where the heartbeat has been successfully updated. * * @summary Auto-Cancel All Open Orders (Kill-Switch) Heartbeat (TRADE) * @param {AutoCancelAllOpenOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApiInterface */ autoCancelAllOpenOrders(requestParameters: AutoCancelAllOpenOrdersRequest): Promise>; /** * This endpoint returns the auto-cancel parameters for each underlying symbol. Note only active auto-cancel parameters will be returned, if countdownTime is set to 0 (ie. countdownTime has been turned off), the underlying symbol and corresponding countdownTime parameter will not be returned in the response. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - countdownTime = 0 means the function is disabled. * * @summary Get Auto-Cancel All Open Orders (Kill-Switch) Config (TRADE) * @param {GetAutoCancelAllOpenOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApiInterface */ getAutoCancelAllOpenOrders(requestParameters?: GetAutoCancelAllOpenOrdersRequest): Promise>; /** * Get config for MMP. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Get Market Maker Protection Config (TRADE) * @param {GetMarketMakerProtectionConfigRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApiInterface */ getMarketMakerProtectionConfig(requestParameters: GetMarketMakerProtectionConfigRequest): Promise>; /** * Reset MMP, start MMP order again. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Reset Market Maker Protection Config (TRADE) * @param {ResetMarketMakerProtectionConfigRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApiInterface */ resetMarketMakerProtectionConfig(requestParameters: ResetMarketMakerProtectionConfigRequest): Promise>; /** * This endpoint sets the parameters of the auto-cancel feature which cancels all open orders (both market maker protection and non market maker protection order types) of the underlying symbol at the end of the specified countdown time period if no heartbeat message is sent. After the countdown time period, all open orders will be cancelled and new orders will be rejected with error code -2010 until either a heartbeat message is sent or the auto-cancel feature is turned off by setting countdownTime to 0. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - This rest endpoint sets up the parameters to cancel your open orders in case of an outage or disconnection. * - Example usage: > Call this endpoint with a countdownTime value of 10000 (10 seconds) to turn on the auto-cancel feature. If the corresponding countdownCancelAllHeartBeat endpoint is not called within 10 seconds with the specified underlying symbol, all open 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. * - The system will check all countdowns approximately every 100 milliseconds, **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. * * @summary Set Auto-Cancel All Open Orders (Kill-Switch) Config (TRADE) * @param {SetAutoCancelAllOpenOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApiInterface */ setAutoCancelAllOpenOrders(requestParameters: SetAutoCancelAllOpenOrdersRequest): Promise>; /** * Set config for MMP. Market Maker Protection(MMP) is a set of protection mechanism for option market maker, this mechanism is able to prevent mass trading in short period time. Once market maker's account branches the threshold, the Market Maker Protection will be triggered. When Market Maker Protection triggers, all the current MMP orders will be canceled, new MMP orders will be rejected. Market maker can use this time to reevaluate market and modify order price. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Set Market Maker Protection Config (TRADE) * @param {SetMarketMakerProtectionConfigRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApiInterface */ setMarketMakerProtectionConfig(requestParameters: SetMarketMakerProtectionConfigRequest): Promise>; } /** * Request parameters for autoCancelAllOpenOrders operation in MarketMakerEndpointsApi. * @interface AutoCancelAllOpenOrdersRequest */ interface AutoCancelAllOpenOrdersRequest { /** * * @type {string} * @memberof MarketMakerEndpointsApiAutoCancelAllOpenOrders */ readonly underlyings: string; /** * * @type {number | bigint} * @memberof MarketMakerEndpointsApiAutoCancelAllOpenOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for getAutoCancelAllOpenOrders operation in MarketMakerEndpointsApi. * @interface GetAutoCancelAllOpenOrdersRequest */ interface GetAutoCancelAllOpenOrdersRequest { /** * Underlying asset. * @type {string} * @memberof MarketMakerEndpointsApiGetAutoCancelAllOpenOrders */ readonly underlying?: string; /** * Recv Window. * @type {number | bigint} * @memberof MarketMakerEndpointsApiGetAutoCancelAllOpenOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for getMarketMakerProtectionConfig operation in MarketMakerEndpointsApi. * @interface GetMarketMakerProtectionConfigRequest */ interface GetMarketMakerProtectionConfigRequest { /** * Underlying asset. * @type {string} * @memberof MarketMakerEndpointsApiGetMarketMakerProtectionConfig */ readonly underlying: string; /** * Recv Window. * @type {number | bigint} * @memberof MarketMakerEndpointsApiGetMarketMakerProtectionConfig */ readonly recvWindow?: number | bigint; } /** * Request parameters for resetMarketMakerProtectionConfig operation in MarketMakerEndpointsApi. * @interface ResetMarketMakerProtectionConfigRequest */ interface ResetMarketMakerProtectionConfigRequest { /** * * @type {string} * @memberof MarketMakerEndpointsApiResetMarketMakerProtectionConfig */ readonly underlying: string; /** * * @type {number | bigint} * @memberof MarketMakerEndpointsApiResetMarketMakerProtectionConfig */ readonly recvWindow?: number | bigint; } /** * Request parameters for setAutoCancelAllOpenOrders operation in MarketMakerEndpointsApi. * @interface SetAutoCancelAllOpenOrdersRequest */ interface SetAutoCancelAllOpenOrdersRequest { /** * * @type {string} * @memberof MarketMakerEndpointsApiSetAutoCancelAllOpenOrders */ readonly underlying: string; /** * Countdown time in milliseconds (ex. 1,000 for 1 second). 0 to disable the timer. Negative values (ex. -10000) are not accepted. Minimum acceptable value is 5,000 * @type {number | bigint} * @memberof MarketMakerEndpointsApiSetAutoCancelAllOpenOrders */ readonly countdownTime: number | bigint; /** * * @type {number | bigint} * @memberof MarketMakerEndpointsApiSetAutoCancelAllOpenOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for setMarketMakerProtectionConfig operation in MarketMakerEndpointsApi. * @interface SetMarketMakerProtectionConfigRequest */ interface SetMarketMakerProtectionConfigRequest { /** * * @type {string} * @memberof MarketMakerEndpointsApiSetMarketMakerProtectionConfig */ readonly underlying: string; /** * MMP Interval in milliseconds * @type {number | bigint} * @memberof MarketMakerEndpointsApiSetMarketMakerProtectionConfig */ readonly windowTimeInMilliseconds: number | bigint; /** * MMP frozen time in milliseconds, if set to 0 manual reset is required * @type {number | bigint} * @memberof MarketMakerEndpointsApiSetMarketMakerProtectionConfig */ readonly frozenTimeInMilliseconds: number | bigint; /** * quantity limit * @type {number} * @memberof MarketMakerEndpointsApiSetMarketMakerProtectionConfig */ readonly qtyLimit: number; /** * net delta limit * @type {number} * @memberof MarketMakerEndpointsApiSetMarketMakerProtectionConfig */ readonly deltaLimit: number; /** * * @type {number | bigint} * @memberof MarketMakerEndpointsApiSetMarketMakerProtectionConfig */ readonly recvWindow?: number | bigint; } /** * MarketMakerEndpointsApi - object-oriented interface * @class MarketMakerEndpointsApi */ declare class MarketMakerEndpointsApi implements MarketMakerEndpointsApiInterface { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * This endpoint resets the time from which the countdown will begin to the time this messaged is received. It should be called repeatedly as heartbeats. Multiple heartbeats can be updated at once by specifying the underlying symbols as a list (ex. BTCUSDT,ETHUSDT) in the underlyings parameter. * * Weight(IP): 10 * * Security Type: TRADE * * Notes: * - The response will only include underlying symbols where the heartbeat has been successfully updated. * * @summary Auto-Cancel All Open Orders (Kill-Switch) Heartbeat (TRADE) * @param {AutoCancelAllOpenOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-endpoints#auto-cancel-all-open-orders Binance API Documentation} */ autoCancelAllOpenOrders(requestParameters: AutoCancelAllOpenOrdersRequest): Promise>; /** * This endpoint returns the auto-cancel parameters for each underlying symbol. Note only active auto-cancel parameters will be returned, if countdownTime is set to 0 (ie. countdownTime has been turned off), the underlying symbol and corresponding countdownTime parameter will not be returned in the response. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - countdownTime = 0 means the function is disabled. * * @summary Get Auto-Cancel All Open Orders (Kill-Switch) Config (TRADE) * @param {GetAutoCancelAllOpenOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-endpoints#get-auto-cancel-all-open-orders Binance API Documentation} */ getAutoCancelAllOpenOrders(requestParameters?: GetAutoCancelAllOpenOrdersRequest): Promise>; /** * Get config for MMP. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Get Market Maker Protection Config (TRADE) * @param {GetMarketMakerProtectionConfigRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-endpoints#get-market-maker-protection-config Binance API Documentation} */ getMarketMakerProtectionConfig(requestParameters: GetMarketMakerProtectionConfigRequest): Promise>; /** * Reset MMP, start MMP order again. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Reset Market Maker Protection Config (TRADE) * @param {ResetMarketMakerProtectionConfigRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-endpoints#reset-market-maker-protection-config Binance API Documentation} */ resetMarketMakerProtectionConfig(requestParameters: ResetMarketMakerProtectionConfigRequest): Promise>; /** * This endpoint sets the parameters of the auto-cancel feature which cancels all open orders (both market maker protection and non market maker protection order types) of the underlying symbol at the end of the specified countdown time period if no heartbeat message is sent. After the countdown time period, all open orders will be cancelled and new orders will be rejected with error code -2010 until either a heartbeat message is sent or the auto-cancel feature is turned off by setting countdownTime to 0. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - This rest endpoint sets up the parameters to cancel your open orders in case of an outage or disconnection. * - Example usage: > Call this endpoint with a countdownTime value of 10000 (10 seconds) to turn on the auto-cancel feature. If the corresponding countdownCancelAllHeartBeat endpoint is not called within 10 seconds with the specified underlying symbol, all open 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. * - The system will check all countdowns approximately every 100 milliseconds, **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. * * @summary Set Auto-Cancel All Open Orders (Kill-Switch) Config (TRADE) * @param {SetAutoCancelAllOpenOrdersRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-endpoints#set-auto-cancel-all-open-orders Binance API Documentation} */ setAutoCancelAllOpenOrders(requestParameters: SetAutoCancelAllOpenOrdersRequest): Promise>; /** * Set config for MMP. Market Maker Protection(MMP) is a set of protection mechanism for option market maker, this mechanism is able to prevent mass trading in short period time. Once market maker's account branches the threshold, the Market Maker Protection will be triggered. When Market Maker Protection triggers, all the current MMP orders will be canceled, new MMP orders will be rejected. Market maker can use this time to reevaluate market and modify order price. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Set Market Maker Protection Config (TRADE) * @param {SetMarketMakerProtectionConfigRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketMakerEndpointsApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/rest-api/market-maker-endpoints#set-market-maker-protection-config Binance API Documentation} */ setMarketMakerProtectionConfig(requestParameters: SetMarketMakerProtectionConfigRequest): Promise>; } //#endregion //#region src/rest-api/modules/trade-api.d.ts /** * TradeApi - interface * @interface TradeApi */ interface TradeApiInterface { /** * Get trades for a specific account and symbol. * * Weight(IP): 5 * * Security Type: USER_DATA * * @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>; /** * Cancel all active orders on specified underlying. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Cancel All Option Orders By Underlying (TRADE) * @param {CancelAllOptionOrdersByUnderlyingRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ cancelAllOptionOrdersByUnderlying(requestParameters: CancelAllOptionOrdersByUnderlyingRequest): Promise>; /** * Cancel all active order on a symbol. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Cancel all Option orders on specific symbol (TRADE) * @param {CancelAllOptionOrdersOnSpecificSymbolRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ cancelAllOptionOrdersOnSpecificSymbol(requestParameters: CancelAllOptionOrdersOnSpecificSymbolRequest): Promise>; /** * Cancel multiple orders. * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * - At least one instance of `orderId` and `clientOrderId` must be sent. * * @summary Cancel Multiple Option Orders (TRADE) * @param {CancelMultipleOptionOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ cancelMultipleOptionOrders(requestParameters: CancelMultipleOptionOrdersRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - At least one instance of `orderId` and `clientOrderId` must be sent. * * @summary Cancel Option Order (TRADE) * @param {CancelOptionOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ cancelOptionOrder(requestParameters: CancelOptionOrderRequest): Promise>; /** * Send a new order. * * Weight(IP): 0 * * Security Type: TRADE * * Notes: * Some parameters are mandatory depending on the order type as follows: * * Type | Mandatory parameters * ------------ | ------------ * LIMIT | timeInForce, quantity, price * * @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): Promise>; /** * Get current position information. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Option Position Information (USER_DATA) * @param {OptionPositionInformationRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ optionPositionInformation(requestParameters?: OptionPositionInformationRequest): Promise>; /** * Send multiple option orders. * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * Some parameters are mandatory depending on the order type as follows: * * Type | Mandatory parameters * ------------ | ------------ * LIMIT | timeInForce, quantity, price * * - Parameter rules are same with New Order * - Batch orders are processed concurrently, and the order of matching is not guaranteed. * * @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 current all open orders, status: ACCEPTED PARTIALLY_FILLED * * Weight: 1 for a single symbol; 40 when the symbol parameter is omitted * * Security Type: USER_DATA * * @summary Query Current Open Option Orders (USER_DATA) * @param {QueryCurrentOpenOptionOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ queryCurrentOpenOptionOrders(requestParameters?: QueryCurrentOpenOptionOrdersRequest): Promise>; /** * Query all finished orders within 5 days, finished status: CANCELLED FILLED REJECTED. * * Weight(IP): 3 * * Security Type: TRADE * * @summary Query Option Order History (TRADE) * @param {QueryOptionOrderHistoryRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ queryOptionOrderHistory(requestParameters: QueryOptionOrderHistoryRequest): Promise>; /** * Check an order status. * * These orders will not be found: * order status is `CANCELED` or `REJECTED`, **AND** * order has NO filled trade, **AND** * created time + 3 days < current time * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `clientOrderId ` must be sent. * * @summary Query Single Order (TRADE) * @param {QuerySingleOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ querySingleOrder(requestParameters: QuerySingleOrderRequest): Promise>; /** * Sign TradFi Options agreement contract * * Weight(IP): 50 * * Security Type: USER_DATA * * @summary TradFi Options Contract (USER_DATA) * @param {TradfiOptionsContractRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ tradfiOptionsContract(requestParameters?: TradfiOptionsContractRequest): Promise>; /** * Get account commission. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary User Commission (USER_DATA) * @param {UserCommissionRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ userCommission(requestParameters?: UserCommissionRequest): Promise>; /** * Get account exercise records. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary User Exercise Record (USER_DATA) * @param {UserExerciseRecordRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ userExerciseRecord(requestParameters?: UserExerciseRecordRequest): Promise>; } /** * Request parameters for accountTradeList operation in TradeApi. * @interface AccountTradeListRequest */ interface AccountTradeListRequest { /** * Option trading pair. * @type {string} * @memberof TradeApiAccountTradeList */ readonly symbol: string; /** * Trade id to fetch from. Default gets most recent trades, e.g 4611875134427365376 * @type {number | bigint} * @memberof TradeApiAccountTradeList */ readonly fromId?: number | bigint; /** * Start Time, e.g 1593511200000 * @type {number | bigint} * @memberof TradeApiAccountTradeList */ readonly startTime?: number | bigint; /** * End Time, e.g 1593512200000 * @type {number | bigint} * @memberof TradeApiAccountTradeList */ readonly endTime?: number | bigint; /** * Number of result sets returned. * @type {number | bigint} * @memberof TradeApiAccountTradeList */ readonly limit?: number | bigint; /** * Recv Window. * @type {number | bigint} * @memberof TradeApiAccountTradeList */ readonly recvWindow?: number | bigint; } /** * Request parameters for cancelAllOptionOrdersByUnderlying operation in TradeApi. * @interface CancelAllOptionOrdersByUnderlyingRequest */ interface CancelAllOptionOrdersByUnderlyingRequest { /** * Underlying asset. * @type {string} * @memberof TradeApiCancelAllOptionOrdersByUnderlying */ readonly underlying: string; /** * Recv Window. * @type {number | bigint} * @memberof TradeApiCancelAllOptionOrdersByUnderlying */ readonly recvWindow?: number | bigint; } /** * Request parameters for cancelAllOptionOrdersOnSpecificSymbol operation in TradeApi. * @interface CancelAllOptionOrdersOnSpecificSymbolRequest */ interface CancelAllOptionOrdersOnSpecificSymbolRequest { /** * Option trading pair. * @type {string} * @memberof TradeApiCancelAllOptionOrdersOnSpecificSymbol */ readonly symbol: string; /** * Recv Window. * @type {number | bigint} * @memberof TradeApiCancelAllOptionOrdersOnSpecificSymbol */ readonly recvWindow?: number | bigint; } /** * Request parameters for cancelMultipleOptionOrders operation in TradeApi. * @interface CancelMultipleOptionOrdersRequest */ interface CancelMultipleOptionOrdersRequest { /** * Option trading pair. * @type {string} * @memberof TradeApiCancelMultipleOptionOrders */ readonly symbol: string; /** * Order ID list. * @type {Array} * @memberof TradeApiCancelMultipleOptionOrders */ readonly orderIds?: Array; /** * Client order ID list. * @type {Array} * @memberof TradeApiCancelMultipleOptionOrders */ readonly clientOrderIds?: Array; /** * Recv Window. * @type {number | bigint} * @memberof TradeApiCancelMultipleOptionOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for cancelOptionOrder operation in TradeApi. * @interface CancelOptionOrderRequest */ interface CancelOptionOrderRequest { /** * Option trading pair. * @type {string} * @memberof TradeApiCancelOptionOrder */ readonly symbol: string; /** * Order ID. * @type {number | bigint} * @memberof TradeApiCancelOptionOrder */ readonly orderId?: number | bigint; /** * clientOrderId * @type {string} * @memberof TradeApiCancelOptionOrder */ readonly clientOrderId?: string; /** * Recv Window. * @type {number | bigint} * @memberof TradeApiCancelOptionOrder */ 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; /** * * @type {'LIMIT'} * @memberof TradeApiNewOrder */ readonly type: NewOrderTypeEnum; /** * Order Quantity * @type {number} * @memberof TradeApiNewOrder */ readonly quantity: number; /** * Order Price * @type {number} * @memberof TradeApiNewOrder */ readonly price?: number; /** * * @type {'GTC' | 'IOC' | 'FOK' | 'GTX'} * @memberof TradeApiNewOrder */ readonly timeInForce?: NewOrderTimeInForceEnum; /** * * @type {boolean} * @memberof TradeApiNewOrder */ readonly reduceOnly?: boolean; /** * * @type {boolean} * @memberof TradeApiNewOrder */ readonly postOnly?: boolean; /** * * @type {'ACK' | 'RESULT'} * @memberof TradeApiNewOrder */ readonly newOrderRespType?: NewOrderNewOrderRespTypeEnum; /** * User-defined order ID cannot be repeated in pending orders * @type {string} * @memberof TradeApiNewOrder */ readonly clientOrderId?: string; /** * is market maker protection order * @type {boolean} * @memberof TradeApiNewOrder */ readonly isMmp?: boolean; /** * Self-trade prevention mode * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH'} * @memberof TradeApiNewOrder */ readonly selfTradePreventionMode?: NewOrderSelfTradePreventionModeEnum; /** * * @type {number | bigint} * @memberof TradeApiNewOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for optionPositionInformation operation in TradeApi. * @interface OptionPositionInformationRequest */ interface OptionPositionInformationRequest { /** * Option trading pair. * @type {string} * @memberof TradeApiOptionPositionInformation */ readonly symbol?: string; /** * Recv Window. * @type {number | bigint} * @memberof TradeApiOptionPositionInformation */ readonly recvWindow?: number | bigint; } /** * Request parameters for placeMultipleOrders operation in TradeApi. * @interface PlaceMultipleOrdersRequest */ interface PlaceMultipleOrdersRequest { /** * order list. Max 10 orders * @type {Array} * @memberof TradeApiPlaceMultipleOrders */ readonly orders: Array; /** * * @type {number | bigint} * @memberof TradeApiPlaceMultipleOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for queryCurrentOpenOptionOrders operation in TradeApi. * @interface QueryCurrentOpenOptionOrdersRequest */ interface QueryCurrentOpenOptionOrdersRequest { /** * Option trading pair. * @type {string} * @memberof TradeApiQueryCurrentOpenOptionOrders */ readonly symbol?: string; /** * Order ID. * @type {number | bigint} * @memberof TradeApiQueryCurrentOpenOptionOrders */ readonly orderId?: number | bigint; /** * Start Time, e.g 1593511200000 * @type {number | bigint} * @memberof TradeApiQueryCurrentOpenOptionOrders */ readonly startTime?: number | bigint; /** * End Time, e.g 1593512200000 * @type {number | bigint} * @memberof TradeApiQueryCurrentOpenOptionOrders */ readonly endTime?: number | bigint; /** * Recv Window. * @type {number | bigint} * @memberof TradeApiQueryCurrentOpenOptionOrders */ readonly recvWindow?: number | bigint; } /** * Request parameters for queryOptionOrderHistory operation in TradeApi. * @interface QueryOptionOrderHistoryRequest */ interface QueryOptionOrderHistoryRequest { /** * Option trading pair. * @type {string} * @memberof TradeApiQueryOptionOrderHistory */ readonly symbol: string; /** * Order ID. * @type {number | bigint} * @memberof TradeApiQueryOptionOrderHistory */ readonly orderId?: number | bigint; /** * Start Time, e.g 1593511200000 * @type {number | bigint} * @memberof TradeApiQueryOptionOrderHistory */ readonly startTime?: number | bigint; /** * End Time, e.g 1593512200000 * @type {number | bigint} * @memberof TradeApiQueryOptionOrderHistory */ readonly endTime?: number | bigint; /** * Number of result sets returned * @type {number | bigint} * @memberof TradeApiQueryOptionOrderHistory */ readonly limit?: number | bigint; /** * Recv Window. * @type {number | bigint} * @memberof TradeApiQueryOptionOrderHistory */ readonly recvWindow?: number | bigint; } /** * Request parameters for querySingleOrder operation in TradeApi. * @interface QuerySingleOrderRequest */ interface QuerySingleOrderRequest { /** * Option trading pair. * @type {string} * @memberof TradeApiQuerySingleOrder */ readonly symbol: string; /** * Order ID. * @type {number | bigint} * @memberof TradeApiQuerySingleOrder */ readonly orderId?: number | bigint; /** * User-defined order ID; cannot be duplicated among open orders. * @type {string} * @memberof TradeApiQuerySingleOrder */ readonly clientOrderId?: string; /** * Recv Window. * @type {number | bigint} * @memberof TradeApiQuerySingleOrder */ readonly recvWindow?: number | bigint; } /** * Request parameters for tradfiOptionsContract operation in TradeApi. * @interface TradfiOptionsContractRequest */ interface TradfiOptionsContractRequest { /** * * @type {number | bigint} * @memberof TradeApiTradfiOptionsContract */ readonly recvWindow?: number | bigint; } /** * Request parameters for userCommission operation in TradeApi. * @interface UserCommissionRequest */ interface UserCommissionRequest { /** * Recv Window. * @type {number | bigint} * @memberof TradeApiUserCommission */ readonly recvWindow?: number | bigint; } /** * Request parameters for userExerciseRecord operation in TradeApi. * @interface UserExerciseRecordRequest */ interface UserExerciseRecordRequest { /** * Option trading pair. * @type {string} * @memberof TradeApiUserExerciseRecord */ readonly symbol?: string; /** * Start Time, e.g 1593511200000 * @type {number | bigint} * @memberof TradeApiUserExerciseRecord */ readonly startTime?: number | bigint; /** * End Time, e.g 1593512200000 * @type {number | bigint} * @memberof TradeApiUserExerciseRecord */ readonly endTime?: number | bigint; /** * Number of result sets returned. * @type {number | bigint} * @memberof TradeApiUserExerciseRecord */ readonly limit?: number | bigint; /** * Recv Window. * @type {number | bigint} * @memberof TradeApiUserExerciseRecord */ readonly recvWindow?: number | bigint; } /** * TradeApi - object-oriented interface * @class TradeApi */ declare class TradeApi implements TradeApiInterface { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Get trades for a specific account and symbol. * * Weight(IP): 5 * * Security Type: USER_DATA * * @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-options/api/rest-api/trade#account-trade-list Binance API Documentation} */ accountTradeList(requestParameters: AccountTradeListRequest): Promise>; /** * Cancel all active orders on specified underlying. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Cancel All Option Orders By Underlying (TRADE) * @param {CancelAllOptionOrdersByUnderlyingRequest} 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-options/api/rest-api/trade#cancel-all-option-orders-by-underlying Binance API Documentation} */ cancelAllOptionOrdersByUnderlying(requestParameters: CancelAllOptionOrdersByUnderlyingRequest): Promise>; /** * Cancel all active order on a symbol. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Cancel all Option orders on specific symbol (TRADE) * @param {CancelAllOptionOrdersOnSpecificSymbolRequest} 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-options/api/rest-api/trade#cancel-all-option-orders-on-specific-symbol Binance API Documentation} */ cancelAllOptionOrdersOnSpecificSymbol(requestParameters: CancelAllOptionOrdersOnSpecificSymbolRequest): Promise>; /** * Cancel multiple orders. * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * - At least one instance of `orderId` and `clientOrderId` must be sent. * * @summary Cancel Multiple Option Orders (TRADE) * @param {CancelMultipleOptionOrdersRequest} 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-options/api/rest-api/trade#cancel-multiple-option-orders Binance API Documentation} */ cancelMultipleOptionOrders(requestParameters: CancelMultipleOptionOrdersRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - At least one instance of `orderId` and `clientOrderId` must be sent. * * @summary Cancel Option Order (TRADE) * @param {CancelOptionOrderRequest} 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-options/api/rest-api/trade#cancel-option-order Binance API Documentation} */ cancelOptionOrder(requestParameters: CancelOptionOrderRequest): Promise>; /** * Send a new order. * * Weight(IP): 0 * * Security Type: TRADE * * Notes: * Some parameters are mandatory depending on the order type as follows: * * Type | Mandatory parameters * ------------ | ------------ * LIMIT | timeInForce, quantity, price * * @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-options/api/rest-api/trade#new-order Binance API Documentation} */ newOrder(requestParameters: NewOrderRequest): Promise>; /** * Get current position information. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Option Position Information (USER_DATA) * @param {OptionPositionInformationRequest} 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-options/api/rest-api/trade#option-position-information Binance API Documentation} */ optionPositionInformation(requestParameters?: OptionPositionInformationRequest): Promise>; /** * Send multiple option orders. * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * Some parameters are mandatory depending on the order type as follows: * * Type | Mandatory parameters * ------------ | ------------ * LIMIT | timeInForce, quantity, price * * - Parameter rules are same with New Order * - Batch orders are processed concurrently, and the order of matching is not guaranteed. * * @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-options/api/rest-api/trade#place-multiple-orders Binance API Documentation} */ placeMultipleOrders(requestParameters: PlaceMultipleOrdersRequest): Promise>; /** * Query current all open orders, status: ACCEPTED PARTIALLY_FILLED * * Weight: 1 for a single symbol; 40 when the symbol parameter is omitted * * Security Type: USER_DATA * * @summary Query Current Open Option Orders (USER_DATA) * @param {QueryCurrentOpenOptionOrdersRequest} 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-options/api/rest-api/trade#query-current-open-option-orders Binance API Documentation} */ queryCurrentOpenOptionOrders(requestParameters?: QueryCurrentOpenOptionOrdersRequest): Promise>; /** * Query all finished orders within 5 days, finished status: CANCELLED FILLED REJECTED. * * Weight(IP): 3 * * Security Type: TRADE * * @summary Query Option Order History (TRADE) * @param {QueryOptionOrderHistoryRequest} 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-options/api/rest-api/trade#query-option-order-history Binance API Documentation} */ queryOptionOrderHistory(requestParameters: QueryOptionOrderHistoryRequest): Promise>; /** * Check an order status. * * These orders will not be found: * order status is `CANCELED` or `REJECTED`, **AND** * order has NO filled trade, **AND** * created time + 3 days < current time * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `clientOrderId ` must be sent. * * @summary Query Single Order (TRADE) * @param {QuerySingleOrderRequest} 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-options/api/rest-api/trade#query-single-order Binance API Documentation} */ querySingleOrder(requestParameters: QuerySingleOrderRequest): Promise>; /** * Sign TradFi Options agreement contract * * Weight(IP): 50 * * Security Type: USER_DATA * * @summary TradFi Options Contract (USER_DATA) * @param {TradfiOptionsContractRequest} 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-options/api/rest-api/trade#tradfi-options-contract Binance API Documentation} */ tradfiOptionsContract(requestParameters?: TradfiOptionsContractRequest): Promise>; /** * Get account commission. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary User Commission (USER_DATA) * @param {UserCommissionRequest} 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-options/api/rest-api/trade#user-commission Binance API Documentation} */ userCommission(requestParameters?: UserCommissionRequest): Promise>; /** * Get account exercise records. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary User Exercise Record (USER_DATA) * @param {UserExerciseRecordRequest} 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-options/api/rest-api/trade#user-exercise-record Binance API Documentation} */ userExerciseRecord(requestParameters?: UserExerciseRecordRequest): Promise>; } declare enum NewOrderSideEnum { BUY = "BUY", SELL = "SELL", } declare enum NewOrderTypeEnum { LIMIT = "LIMIT", } declare enum NewOrderTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", GTX = "GTX", } declare enum NewOrderNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", } declare enum NewOrderSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", } //#endregion //#region src/rest-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) * * @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. 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) * * @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 implements UserDataStreamsApiInterface { 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-options/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. 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) * @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-options/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-options/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 marketMakerBlockTradeApi; private marketMakerEndpointsApi; 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>; /** * Query account funding flows. * * Weight(IP): 1 * * Security Type: USER_DATA * * Notes: * - Only support querying data in the past 3 months * * @summary Account Funding Flow (USER_DATA) * @param {AccountFundingFlowRequest} 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-options/api/rest-api/account#account-funding-flow Binance API Documentation} */ accountFundingFlow(requestParameters: AccountFundingFlowRequest): Promise>; /** * Get current account information. * * Weight(IP): 3 * * Security Type: USER_DATA * * @summary Option Margin Account Information (USER_DATA) * @param {OptionMarginAccountInformationRequest} 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-options/api/rest-api/account#option-margin-account-information Binance API Documentation} */ optionMarginAccountInformation(requestParameters?: OptionMarginAccountInformationRequest): 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-options/api/rest-api/market-data#check-server-time Binance API Documentation} */ checkServerTime(): 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-options/api/rest-api/market-data#exchange-information Binance API Documentation} */ exchangeInformation(): Promise>; /** * Get historical exercise records. * * REALISTIC_VALUE_STRICKEN -> Exercised * EXTRINSIC_VALUE_EXPIRED -> Expired OTM * * Weight(IP): 3 * * @summary Historical Exercise Records * @param {HistoricalExerciseRecordsRequest} 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-options/api/rest-api/market-data#historical-exercise-records Binance API Documentation} */ historicalExerciseRecords(requestParameters?: HistoricalExerciseRecordsRequest): Promise>; /** * Get spot index price for option underlying. * * Weight(IP): 1 * * @summary Index Price * @param {IndexPriceRequest} 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-options/api/rest-api/market-data#index-price Binance API Documentation} */ indexPrice(requestParameters: IndexPriceRequest): Promise>; /** * Kline/candlestick bars for an option symbol. Klines are uniquely identified by their open time. * * Weight(IP): 1 * * Notes: * - If startTime and endTime are not sent, the most recent klines are returned. * * @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-options/api/rest-api/market-data#kline-candlestick-data Binance API Documentation} */ klineCandlestickData(requestParameters: KlineCandlestickDataRequest): Promise>; /** * Get open interest for specific underlying asset on specific expiration date. * * Weight(IP): 0 * * @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-options/api/rest-api/market-data#open-interest Binance API Documentation} */ openInterest(requestParameters: OpenInterestRequest$1): Promise>; /** * Option mark price and greek info. * * Weight(IP): 5 * * @summary Option Mark Price * @param {OptionMarkPriceRequest} 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-options/api/rest-api/market-data#option-mark-price Binance API Documentation} */ optionMarkPrice(requestParameters?: OptionMarkPriceRequest$1): Promise>; /** * Check orderbook depth on specific symbol * * Weight: limit | weight * ------------ | ------------ * 5, 10, 20, 50 | 1 * 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-options/api/rest-api/market-data#order-book Binance API Documentation} */ orderBook(requestParameters: OrderBookRequest): Promise>; /** * Get recent block trades * * Weight(IP): 5 * * @summary Recent Block Trades List * @param {RecentBlockTradesListRequest} 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-options/api/rest-api/market-data#recent-block-trades-list Binance API Documentation} */ recentBlockTradesList(requestParameters?: RecentBlockTradesListRequest): Promise>; /** * Get recent market trades * * Weight(IP): 5 * * @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-options/api/rest-api/market-data#recent-trades-list Binance API Documentation} */ recentTradesList(requestParameters: RecentTradesListRequest): 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-options/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 * * @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-options/api/rest-api/market-data#ticker24hr-price-change-statistics Binance API Documentation} */ ticker24hrPriceChangeStatistics(requestParameters?: Ticker24hrPriceChangeStatisticsRequest): Promise>; /** * Accept a block trade order * * Weight(IP): 5 * * Security Type: TRADE * * @summary Accept Block Trade Order (TRADE) * @param {AcceptBlockTradeOrderRequest} 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-options/api/rest-api/market-maker-block-trade#accept-block-trade-order Binance API Documentation} */ acceptBlockTradeOrder(requestParameters: AcceptBlockTradeOrderRequest): Promise>; /** * Gets block trades for a specific account. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Account Block Trade List (USER_DATA) * @param {AccountBlockTradeListRequest} 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-options/api/rest-api/market-maker-block-trade#account-block-trade-list Binance API Documentation} */ accountBlockTradeList(requestParameters?: AccountBlockTradeListRequest): Promise>; /** * Cancel a block trade order. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Cancel Block Trade Order (TRADE) * @param {CancelBlockTradeOrderRequest} 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-options/api/rest-api/market-maker-block-trade#cancel-block-trade-order Binance API Documentation} */ cancelBlockTradeOrder(requestParameters: CancelBlockTradeOrderRequest): Promise>; /** * Extends a block trade expire time by 30 mins from the current time. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Extend Block Trade Order (TRADE) * @param {ExtendBlockTradeOrderRequest} 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-options/api/rest-api/market-maker-block-trade#extend-block-trade-order Binance API Documentation} */ extendBlockTradeOrder(requestParameters: ExtendBlockTradeOrderRequest): Promise>; /** * Send in a new block trade order. * * Weight(IP): 5 * * Security Type: TRADE * * @summary New Block Trade Order (TRADE) * @param {NewBlockTradeOrderRequest} 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-options/api/rest-api/market-maker-block-trade#new-block-trade-order Binance API Documentation} */ newBlockTradeOrder(requestParameters: NewBlockTradeOrderRequest): Promise>; /** * Query block trade details; returns block trade details from counterparty's perspective. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Query Block Trade Details (USER_DATA) * @param {QueryBlockTradeDetailsRequest} 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-options/api/rest-api/market-maker-block-trade#query-block-trade-details Binance API Documentation} */ queryBlockTradeDetails(requestParameters: QueryBlockTradeDetailsRequest): Promise>; /** * Check block trade order status. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Query Block Trade Order (TRADE) * @param {QueryBlockTradeOrderRequest} 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-options/api/rest-api/market-maker-block-trade#query-block-trade-order Binance API Documentation} */ queryBlockTradeOrder(requestParameters?: QueryBlockTradeOrderRequest): Promise>; /** * This endpoint resets the time from which the countdown will begin to the time this messaged is received. It should be called repeatedly as heartbeats. Multiple heartbeats can be updated at once by specifying the underlying symbols as a list (ex. BTCUSDT,ETHUSDT) in the underlyings parameter. * * Weight(IP): 10 * * Security Type: TRADE * * Notes: * - The response will only include underlying symbols where the heartbeat has been successfully updated. * * @summary Auto-Cancel All Open Orders (Kill-Switch) Heartbeat (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-options/api/rest-api/market-maker-endpoints#auto-cancel-all-open-orders Binance API Documentation} */ autoCancelAllOpenOrders(requestParameters: AutoCancelAllOpenOrdersRequest): Promise>; /** * This endpoint returns the auto-cancel parameters for each underlying symbol. Note only active auto-cancel parameters will be returned, if countdownTime is set to 0 (ie. countdownTime has been turned off), the underlying symbol and corresponding countdownTime parameter will not be returned in the response. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - countdownTime = 0 means the function is disabled. * * @summary Get Auto-Cancel All Open Orders (Kill-Switch) Config (TRADE) * @param {GetAutoCancelAllOpenOrdersRequest} 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-options/api/rest-api/market-maker-endpoints#get-auto-cancel-all-open-orders Binance API Documentation} */ getAutoCancelAllOpenOrders(requestParameters?: GetAutoCancelAllOpenOrdersRequest): Promise>; /** * Get config for MMP. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Get Market Maker Protection Config (TRADE) * @param {GetMarketMakerProtectionConfigRequest} 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-options/api/rest-api/market-maker-endpoints#get-market-maker-protection-config Binance API Documentation} */ getMarketMakerProtectionConfig(requestParameters: GetMarketMakerProtectionConfigRequest): Promise>; /** * Reset MMP, start MMP order again. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Reset Market Maker Protection Config (TRADE) * @param {ResetMarketMakerProtectionConfigRequest} 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-options/api/rest-api/market-maker-endpoints#reset-market-maker-protection-config Binance API Documentation} */ resetMarketMakerProtectionConfig(requestParameters: ResetMarketMakerProtectionConfigRequest): Promise>; /** * This endpoint sets the parameters of the auto-cancel feature which cancels all open orders (both market maker protection and non market maker protection order types) of the underlying symbol at the end of the specified countdown time period if no heartbeat message is sent. After the countdown time period, all open orders will be cancelled and new orders will be rejected with error code -2010 until either a heartbeat message is sent or the auto-cancel feature is turned off by setting countdownTime to 0. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - This rest endpoint sets up the parameters to cancel your open orders in case of an outage or disconnection. * - Example usage: > Call this endpoint with a countdownTime value of 10000 (10 seconds) to turn on the auto-cancel feature. If the corresponding countdownCancelAllHeartBeat endpoint is not called within 10 seconds with the specified underlying symbol, all open 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. * - The system will check all countdowns approximately every 100 milliseconds, **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. * * @summary Set Auto-Cancel All Open Orders (Kill-Switch) Config (TRADE) * @param {SetAutoCancelAllOpenOrdersRequest} 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-options/api/rest-api/market-maker-endpoints#set-auto-cancel-all-open-orders Binance API Documentation} */ setAutoCancelAllOpenOrders(requestParameters: SetAutoCancelAllOpenOrdersRequest): Promise>; /** * Set config for MMP. Market Maker Protection(MMP) is a set of protection mechanism for option market maker, this mechanism is able to prevent mass trading in short period time. Once market maker's account branches the threshold, the Market Maker Protection will be triggered. When Market Maker Protection triggers, all the current MMP orders will be canceled, new MMP orders will be rejected. Market maker can use this time to reevaluate market and modify order price. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Set Market Maker Protection Config (TRADE) * @param {SetMarketMakerProtectionConfigRequest} 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-options/api/rest-api/market-maker-endpoints#set-market-maker-protection-config Binance API Documentation} */ setMarketMakerProtectionConfig(requestParameters: SetMarketMakerProtectionConfigRequest): Promise>; /** * Get trades for a specific account and symbol. * * Weight(IP): 5 * * Security Type: USER_DATA * * @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-options/api/rest-api/trade#account-trade-list Binance API Documentation} */ accountTradeList(requestParameters: AccountTradeListRequest): Promise>; /** * Cancel all active orders on specified underlying. * * Weight(IP): 5 * * Security Type: TRADE * * @summary Cancel All Option Orders By Underlying (TRADE) * @param {CancelAllOptionOrdersByUnderlyingRequest} 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-options/api/rest-api/trade#cancel-all-option-orders-by-underlying Binance API Documentation} */ cancelAllOptionOrdersByUnderlying(requestParameters: CancelAllOptionOrdersByUnderlyingRequest): Promise>; /** * Cancel all active order on a symbol. * * Weight(IP): 1 * * Security Type: TRADE * * @summary Cancel all Option orders on specific symbol (TRADE) * @param {CancelAllOptionOrdersOnSpecificSymbolRequest} 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-options/api/rest-api/trade#cancel-all-option-orders-on-specific-symbol Binance API Documentation} */ cancelAllOptionOrdersOnSpecificSymbol(requestParameters: CancelAllOptionOrdersOnSpecificSymbolRequest): Promise>; /** * Cancel multiple orders. * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * - At least one instance of `orderId` and `clientOrderId` must be sent. * * @summary Cancel Multiple Option Orders (TRADE) * @param {CancelMultipleOptionOrdersRequest} 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-options/api/rest-api/trade#cancel-multiple-option-orders Binance API Documentation} */ cancelMultipleOptionOrders(requestParameters: CancelMultipleOptionOrdersRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - At least one instance of `orderId` and `clientOrderId` must be sent. * * @summary Cancel Option Order (TRADE) * @param {CancelOptionOrderRequest} 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-options/api/rest-api/trade#cancel-option-order Binance API Documentation} */ cancelOptionOrder(requestParameters: CancelOptionOrderRequest): Promise>; /** * Send a new order. * * Weight(IP): 0 * * Security Type: TRADE * * Notes: * Some parameters are mandatory depending on the order type as follows: * * Type | Mandatory parameters * ------------ | ------------ * LIMIT | timeInForce, quantity, price * * @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-options/api/rest-api/trade#new-order Binance API Documentation} */ newOrder(requestParameters: NewOrderRequest): Promise>; /** * Get current position information. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary Option Position Information (USER_DATA) * @param {OptionPositionInformationRequest} 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-options/api/rest-api/trade#option-position-information Binance API Documentation} */ optionPositionInformation(requestParameters?: OptionPositionInformationRequest): Promise>; /** * Send multiple option orders. * * Weight(IP): 5 * * Security Type: TRADE * * Notes: * Some parameters are mandatory depending on the order type as follows: * * Type | Mandatory parameters * ------------ | ------------ * LIMIT | timeInForce, quantity, price * * - Parameter rules are same with New Order * - Batch orders are processed concurrently, and the order of matching is not guaranteed. * * @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-options/api/rest-api/trade#place-multiple-orders Binance API Documentation} */ placeMultipleOrders(requestParameters: PlaceMultipleOrdersRequest): Promise>; /** * Query current all open orders, status: ACCEPTED PARTIALLY_FILLED * * Weight: 1 for a single symbol; 40 when the symbol parameter is omitted * * Security Type: USER_DATA * * @summary Query Current Open Option Orders (USER_DATA) * @param {QueryCurrentOpenOptionOrdersRequest} 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-options/api/rest-api/trade#query-current-open-option-orders Binance API Documentation} */ queryCurrentOpenOptionOrders(requestParameters?: QueryCurrentOpenOptionOrdersRequest): Promise>; /** * Query all finished orders within 5 days, finished status: CANCELLED FILLED REJECTED. * * Weight(IP): 3 * * Security Type: TRADE * * @summary Query Option Order History (TRADE) * @param {QueryOptionOrderHistoryRequest} 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-options/api/rest-api/trade#query-option-order-history Binance API Documentation} */ queryOptionOrderHistory(requestParameters: QueryOptionOrderHistoryRequest): Promise>; /** * Check an order status. * * These orders will not be found: * order status is `CANCELED` or `REJECTED`, **AND** * order has NO filled trade, **AND** * created time + 3 days < current time * * Weight(IP): 1 * * Security Type: TRADE * * Notes: * - Either `orderId` or `clientOrderId ` must be sent. * * @summary Query Single Order (TRADE) * @param {QuerySingleOrderRequest} 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-options/api/rest-api/trade#query-single-order Binance API Documentation} */ querySingleOrder(requestParameters: QuerySingleOrderRequest): Promise>; /** * Sign TradFi Options agreement contract * * Weight(IP): 50 * * Security Type: USER_DATA * * @summary TradFi Options Contract (USER_DATA) * @param {TradfiOptionsContractRequest} 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-options/api/rest-api/trade#tradfi-options-contract Binance API Documentation} */ tradfiOptionsContract(requestParameters?: TradfiOptionsContractRequest): Promise>; /** * Get account commission. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary User Commission (USER_DATA) * @param {UserCommissionRequest} 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-options/api/rest-api/trade#user-commission Binance API Documentation} */ userCommission(requestParameters?: UserCommissionRequest): Promise>; /** * Get account exercise records. * * Weight(IP): 5 * * Security Type: USER_DATA * * @summary User Exercise Record (USER_DATA) * @param {UserExerciseRecordRequest} 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-options/api/rest-api/trade#user-exercise-record Binance API Documentation} */ userExerciseRecord(requestParameters?: UserExerciseRecordRequest): 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-options/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. 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) * * @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-options/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-options/api/rest-api/user-data-streams#start-user-data-stream Binance API Documentation} */ startUserDataStream(): Promise>; } declare namespace index_d_exports { export { AcceptBlockTradeOrderRequest, AcceptBlockTradeOrderResponse, AcceptBlockTradeOrderResponseLegsInner, AccountApi, AccountApiInterface, AccountBlockTradeListRequest, AccountBlockTradeListResponse, AccountBlockTradeListResponseInner, AccountBlockTradeListResponseInnerLegsInner, AccountFundingFlowCurrencyEnum, AccountFundingFlowRequest, AccountFundingFlowResponse, AccountFundingFlowResponseInner, AccountTradeListRequest, AccountTradeListResponse, AccountTradeListResponseInner, AutoCancelAllOpenOrdersRequest, AutoCancelAllOpenOrdersResponse, CancelAllOptionOrdersByUnderlyingRequest, CancelAllOptionOrdersByUnderlyingResponse, CancelAllOptionOrdersOnSpecificSymbolRequest, CancelAllOptionOrdersOnSpecificSymbolResponse, CancelBlockTradeOrderRequest, CancelMultipleOptionOrdersRequest, CancelMultipleOptionOrdersResponse, CancelMultipleOptionOrdersResponseInner, CancelOptionOrderRequest, CancelOptionOrderResponse, CheckServerTimeResponse, ExchangeInformationResponse, ExchangeInformationResponseOptionAssetsInner, ExchangeInformationResponseOptionContractsInner, ExchangeInformationResponseOptionSymbolsInner, ExchangeInformationResponseOptionSymbolsInnerFiltersInner, ExchangeInformationResponseRateLimitsInner, ExtendBlockTradeOrderRequest, ExtendBlockTradeOrderResponse, ExtendBlockTradeOrderResponseLegsInner, GetAutoCancelAllOpenOrdersRequest, GetAutoCancelAllOpenOrdersResponse, GetMarketMakerProtectionConfigRequest, GetMarketMakerProtectionConfigResponse, HistoricalExerciseRecordsRequest, HistoricalExerciseRecordsResponse, HistoricalExerciseRecordsResponseInner, IndexPriceRequest, IndexPriceResponse, KlineCandlestickDataIntervalEnum, KlineCandlestickDataItem, KlineCandlestickDataItemInner, KlineCandlestickDataRequest, KlineCandlestickDataResponse, MarketDataApi, MarketDataApiInterface, MarketMakerBlockTradeApi, MarketMakerBlockTradeApiInterface, MarketMakerEndpointsApi, MarketMakerEndpointsApiInterface, NewBlockTradeOrderLegsParameterInner, NewBlockTradeOrderLegsParameterInnerSideEnum, NewBlockTradeOrderLegsParameterInnerTypeEnum, NewBlockTradeOrderLiquidityEnum, NewBlockTradeOrderRequest, NewBlockTradeOrderResponse, NewOrderNewOrderRespTypeEnum, NewOrderRequest, NewOrderResponse, NewOrderSelfTradePreventionModeEnum, NewOrderSideEnum, NewOrderTimeInForceEnum, NewOrderTypeEnum, OpenInterestRequest$1 as OpenInterestRequest, OpenInterestResponse$1 as OpenInterestResponse, OpenInterestResponseInner$1 as OpenInterestResponseInner, OptionMarginAccountInformationRequest, OptionMarginAccountInformationResponse, OptionMarginAccountInformationResponseAssetInner, OptionMarginAccountInformationResponseGreekInner, OptionMarkPriceRequest$1 as OptionMarkPriceRequest, OptionMarkPriceResponse$1 as OptionMarkPriceResponse, OptionMarkPriceResponseInner$1 as OptionMarkPriceResponseInner, OptionPositionInformationRequest, OptionPositionInformationResponse, OptionPositionInformationResponseInner, OrderBookRequest, OrderBookResponse, PlaceMultipleOrdersOrdersParameterInner, PlaceMultipleOrdersOrdersParameterInnerNewOrderRespTypeEnum, PlaceMultipleOrdersOrdersParameterInnerSelfTradePreventionModeEnum, PlaceMultipleOrdersOrdersParameterInnerSideEnum, PlaceMultipleOrdersOrdersParameterInnerTimeInForceEnum, PlaceMultipleOrdersOrdersParameterInnerTypeEnum, PlaceMultipleOrdersRequest, PlaceMultipleOrdersResponse, PlaceMultipleOrdersResponseInner, QueryBlockTradeDetailsRequest, QueryBlockTradeDetailsResponse, QueryBlockTradeDetailsResponseLegsInner, QueryBlockTradeOrderRequest, QueryBlockTradeOrderResponse, QueryBlockTradeOrderResponseInner, QueryCurrentOpenOptionOrdersRequest, QueryCurrentOpenOptionOrdersResponse, QueryCurrentOpenOptionOrdersResponseInner, QueryOptionOrderHistoryRequest, QueryOptionOrderHistoryResponse, QueryOptionOrderHistoryResponseInner, QuerySingleOrderRequest, QuerySingleOrderResponse, RecentBlockTradesListRequest, RecentBlockTradesListResponse, RecentBlockTradesListResponseInner, RecentTradesListRequest, RecentTradesListResponse, RecentTradesListResponseInner, ResetMarketMakerProtectionConfigRequest, ResetMarketMakerProtectionConfigResponse, RestAPI, SetAutoCancelAllOpenOrdersRequest, SetAutoCancelAllOpenOrdersResponse, SetMarketMakerProtectionConfigRequest, SetMarketMakerProtectionConfigResponse, StartUserDataStreamResponse, Ticker24hrPriceChangeStatisticsRequest, Ticker24hrPriceChangeStatisticsResponse, Ticker24hrPriceChangeStatisticsResponseInner, TradeApi, TradeApiInterface, TradfiOptionsContractRequest, TradfiOptionsContractResponse, UserCommissionRequest, UserCommissionResponse, UserCommissionResponseCommissionsInner, UserDataStreamsApi, UserDataStreamsApiInterface, UserExerciseRecordRequest, UserExerciseRecordResponse, UserExerciseRecordResponseInner }; } //#endregion //#region src/websocket-streams/types/account-update.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 AccountUpdate */ interface AccountUpdate { /** * Event Time * @type {number | bigint} * @memberof AccountUpdate */ E?: number | bigint; /** * Transaction Time * @type {number | bigint} * @memberof AccountUpdate */ T?: number | bigint; /** * Account equity in USDT * @type {string} * @memberof AccountUpdate */ eq?: string; /** * Account adjusted equity in USDT * @type {string} * @memberof AccountUpdate */ aeq?: string; /** * Account wallet balance in USDT * @type {string} * @memberof AccountUpdate */ b?: string; /** * Position value * @type {string} * @memberof AccountUpdate */ m?: string; /** * Unrealized PnL * @type {string} * @memberof AccountUpdate */ u?: string; /** * Initial margin in USDT * @type {string} * @memberof AccountUpdate */ i?: string; /** * Maintenance margin in USDT * @type {string} * @memberof AccountUpdate */ M?: string; } //#endregion //#region src/websocket-streams/types/balance-position-update-binner.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 BalancePositionUpdateBInner */ interface BalancePositionUpdateBInner { /** * Margin asset * @type {string} * @memberof BalancePositionUpdateBInner */ a?: string; /** * Account balance * @type {string} * @memberof BalancePositionUpdateBInner */ b?: string; /** * Balance Change except PnL and Commission * @type {string} * @memberof BalancePositionUpdateBInner */ bc?: string; } //#endregion //#region src/websocket-streams/types/balance-position-update-pinner.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 BalancePositionUpdatePInner */ interface BalancePositionUpdatePInner { /** * Symbol * @type {string} * @memberof BalancePositionUpdatePInner */ s?: string; /** * Position quantity * @type {string} * @memberof BalancePositionUpdatePInner */ c?: string; /** * Position value * @type {string} * @memberof BalancePositionUpdatePInner */ p?: string; /** * Average entry price * @type {string} * @memberof BalancePositionUpdatePInner */ a?: string; } //#endregion //#region src/websocket-streams/types/balance-position-update.d.ts /** * * @export * @interface BalancePositionUpdate */ interface BalancePositionUpdate { /** * Event Time * @type {number | bigint} * @memberof BalancePositionUpdate */ E?: number | bigint; /** * Transaction Time * @type {number | bigint} * @memberof BalancePositionUpdate */ T?: number | bigint; /** * Event reason type * @type {string} * @memberof BalancePositionUpdate */ m?: string; /** * Balances * @type {Array} * @memberof BalancePositionUpdate */ B?: Array; /** * Positions * @type {Array} * @memberof BalancePositionUpdate */ P?: Array; } //#endregion //#region src/websocket-streams/types/diff-book-depth-streams-response.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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; /** * transaction time * @type {number | bigint} * @memberof DiffBookDepthStreamsResponse */ T?: number | bigint; /** * Option symbol * @type {string} * @memberof DiffBookDepthStreamsResponse */ s?: 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; /** * Buy order * @type {Array>} * @memberof DiffBookDepthStreamsResponse */ b?: Array>; /** * Sell order * @type {Array>} * @memberof DiffBookDepthStreamsResponse */ a?: Array>; } //#endregion //#region src/websocket-streams/types/greek-update-ginner.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 GreekUpdateGInner */ interface GreekUpdateGInner { /** * Underlying * @type {string} * @memberof GreekUpdateGInner */ u?: string; /** * Delta * @type {string} * @memberof GreekUpdateGInner */ d?: string; /** * Gamma * @type {string} * @memberof GreekUpdateGInner */ g?: string; /** * Theta * @type {string} * @memberof GreekUpdateGInner */ t?: string; /** * Vega * @type {string} * @memberof GreekUpdateGInner */ v?: string; } //#endregion //#region src/websocket-streams/types/greek-update.d.ts /** * * @export * @interface GreekUpdate */ interface GreekUpdate { /** * Event Time * @type {number | bigint} * @memberof GreekUpdate */ E?: number | bigint; /** * Transaction Time * @type {number | bigint} * @memberof GreekUpdate */ T?: number | bigint; /** * * @type {Array} * @memberof GreekUpdate */ G?: Array; } //#endregion //#region src/websocket-streams/types/hour24-ticker-response.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 Hour24TickerResponse */ interface Hour24TickerResponse { /** * Event type * @type {string} * @memberof Hour24TickerResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof Hour24TickerResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof Hour24TickerResponse */ s?: string; /** * Price change * @type {string} * @memberof Hour24TickerResponse */ p?: string; /** * Price change percent * @type {string} * @memberof Hour24TickerResponse */ P?: string; /** * Weighted average price * @type {string} * @memberof Hour24TickerResponse */ w?: string; /** * Last price * @type {string} * @memberof Hour24TickerResponse */ c?: string; /** * Last quantity * @type {string} * @memberof Hour24TickerResponse */ Q?: string; /** * Open price * @type {string} * @memberof Hour24TickerResponse */ o?: string; /** * High price * @type {string} * @memberof Hour24TickerResponse */ h?: string; /** * Low price * @type {string} * @memberof Hour24TickerResponse */ l?: string; /** * Trading volume(in contracts) * @type {string} * @memberof Hour24TickerResponse */ v?: string; /** * trade amount(in quote asset) * @type {string} * @memberof Hour24TickerResponse */ q?: string; /** * Statistics open time * @type {number | bigint} * @memberof Hour24TickerResponse */ O?: number | bigint; /** * Statistics close time * @type {number | bigint} * @memberof Hour24TickerResponse */ C?: number | bigint; /** * First trade ID * @type {number | bigint} * @memberof Hour24TickerResponse */ F?: number | bigint; /** * Last trade Id * @type {number | bigint} * @memberof Hour24TickerResponse */ L?: number | bigint; /** * Total number of trade * @type {number | bigint} * @memberof Hour24TickerResponse */ n?: number | bigint; } //#endregion //#region src/websocket-streams/types/index-price-streams-response-inner.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 IndexPriceStreamsResponseInner */ interface IndexPriceStreamsResponseInner { /** * event type * @type {string} * @memberof IndexPriceStreamsResponseInner */ e?: string; /** * time * @type {number | bigint} * @memberof IndexPriceStreamsResponseInner */ E?: number | bigint; /** * underlying symbol * @type {string} * @memberof IndexPriceStreamsResponseInner */ s?: string; /** * index price * @type {string} * @memberof IndexPriceStreamsResponseInner */ p?: string; } //#endregion //#region src/websocket-streams/types/index-price-streams-response.d.ts /** * * @export * @interface IndexPriceStreamsResponse */ interface IndexPriceStreamsResponse extends Array {} //#endregion //#region src/websocket-streams/types/individual-symbol-book-ticker-streams-response.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 updateId * @type {number | bigint} * @memberof IndividualSymbolBookTickerStreamsResponse */ u?: number | bigint; /** * symbol * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ s?: string; /** * best bid price * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ b?: string; /** * bid bid quantity * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ B?: string; /** * best ask price * @type {string} * @memberof IndividualSymbolBookTickerStreamsResponse */ a?: string; /** * best ask quantity * @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; } //#endregion //#region src/websocket-streams/types/kline-candlestick-streams-response-k.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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. */ /** * k * @export * @interface KlineCandlestickStreamsResponseK */ interface KlineCandlestickStreamsResponseK { /** * kline start time * @type {number | bigint} * @memberof KlineCandlestickStreamsResponseK */ t?: number | bigint; /** * kline end time * @type {number | bigint} * @memberof KlineCandlestickStreamsResponseK */ T?: number | bigint; /** * Option trading symbol * @type {string} * @memberof KlineCandlestickStreamsResponseK */ s?: string; /** * candle period * @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 * @type {string} * @memberof KlineCandlestickStreamsResponseK */ o?: string; /** * close * @type {string} * @memberof KlineCandlestickStreamsResponseK */ c?: string; /** * high * @type {string} * @memberof KlineCandlestickStreamsResponseK */ h?: string; /** * low * @type {string} * @memberof KlineCandlestickStreamsResponseK */ l?: string; /** * volume(in contracts) * @type {string} * @memberof KlineCandlestickStreamsResponseK */ v?: string; /** * number of trades * @type {number | bigint} * @memberof KlineCandlestickStreamsResponseK */ n?: number | bigint; /** * current candle has been completed Y/N * @type {boolean} * @memberof KlineCandlestickStreamsResponseK */ x?: boolean; /** * completed trade amount   (in quote asset) * @type {string} * @memberof KlineCandlestickStreamsResponseK */ q?: string; /** * taker completed trade volume (in contracts) * @type {string} * @memberof KlineCandlestickStreamsResponseK */ V?: string; /** * taker trade amount(in quote asset) * @type {string} * @memberof KlineCandlestickStreamsResponseK */ Q?: 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; /** * Option trading symbol * @type {string} * @memberof KlineCandlestickStreamsResponse */ s?: string; /** * * @type {KlineCandlestickStreamsResponseK} * @memberof KlineCandlestickStreamsResponse */ k?: KlineCandlestickStreamsResponseK; } //#endregion //#region src/websocket-streams/types/listen-key-expired.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 {string} * @memberof ListenKeyExpired */ E?: string; /** * * @type {string} * @memberof ListenKeyExpired */ listenKey?: string; } //#endregion //#region src/websocket-streams/types/new-symbol-info-response.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 NewSymbolInfoResponse */ interface NewSymbolInfoResponse { /** * Event Type * @type {string} * @memberof NewSymbolInfoResponse */ e?: string; /** * Event Time * @type {number | bigint} * @memberof NewSymbolInfoResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof NewSymbolInfoResponse */ s?: string; /** * Underlying index of the contract * @type {string} * @memberof NewSymbolInfoResponse */ ps?: string; /** * Quotation asset * @type {string} * @memberof NewSymbolInfoResponse */ qa?: string; /** * Option type * @type {string} * @memberof NewSymbolInfoResponse */ d?: string; /** * Strike price * @type {string} * @memberof NewSymbolInfoResponse */ sp?: string; /** * Delivery date time * @type {number | bigint} * @memberof NewSymbolInfoResponse */ dt?: number | bigint; /** * unit, the quantity of the underlying asset represented by a single contract. * @type {number | bigint} * @memberof NewSymbolInfoResponse */ u?: number | bigint; /** * onboard date time * @type {number | bigint} * @memberof NewSymbolInfoResponse */ ot?: number | bigint; /** * Contract status * @type {string} * @memberof NewSymbolInfoResponse */ cs?: string; } //#endregion //#region src/websocket-streams/types/open-interest-response-inner.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 OpenInterestResponseInner */ interface OpenInterestResponseInner { /** * Event type * @type {string} * @memberof OpenInterestResponseInner */ e?: string; /** * Event time * @type {number | bigint} * @memberof OpenInterestResponseInner */ E?: number | bigint; /** * Option symbol * @type {string} * @memberof OpenInterestResponseInner */ s?: string; /** * Open interest in contracts * @type {string} * @memberof OpenInterestResponseInner */ o?: string; /** * Open interest in USDT * @type {string} * @memberof OpenInterestResponseInner */ h?: string; } //#endregion //#region src/websocket-streams/types/open-interest-response.d.ts /** * * @export * @interface OpenInterestResponse */ interface OpenInterestResponse extends Array {} //#endregion //#region src/websocket-streams/types/option-mark-price-response-inner.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 OptionMarkPriceResponseInner */ interface OptionMarkPriceResponseInner { /** * Symbol * @type {string} * @memberof OptionMarkPriceResponseInner */ s?: string; /** * Mark price * @type {string} * @memberof OptionMarkPriceResponseInner */ mp?: string; /** * Event time * @type {number | bigint} * @memberof OptionMarkPriceResponseInner */ E?: number | bigint; /** * Event type * @type {string} * @memberof OptionMarkPriceResponseInner */ e?: string; /** * Index price * @type {string} * @memberof OptionMarkPriceResponseInner */ i?: string; /** * Estimated Settle Price, only useful in the 0.5 hour before the settlement starts * @type {string} * @memberof OptionMarkPriceResponseInner */ P?: string; /** * The best buy price * @type {string} * @memberof OptionMarkPriceResponseInner */ bo?: string; /** * The best sell price * @type {string} * @memberof OptionMarkPriceResponseInner */ ao?: string; /** * The best buy quantity * @type {string} * @memberof OptionMarkPriceResponseInner */ bq?: string; /** * The best sell quantity * @type {string} * @memberof OptionMarkPriceResponseInner */ aq?: string; /** * BuyImplied volatility * @type {string} * @memberof OptionMarkPriceResponseInner */ b?: string; /** * SellImplied volatility * @type {string} * @memberof OptionMarkPriceResponseInner */ a?: string; /** * Buy Maximum price * @type {string} * @memberof OptionMarkPriceResponseInner */ hl?: string; /** * Sell Minimum price * @type {string} * @memberof OptionMarkPriceResponseInner */ ll?: string; /** * volatility * @type {string} * @memberof OptionMarkPriceResponseInner */ vo?: string; /** * risk free rate * @type {string} * @memberof OptionMarkPriceResponseInner */ rf?: string; /** * delta * @type {string} * @memberof OptionMarkPriceResponseInner */ d?: string; /** * theta * @type {string} * @memberof OptionMarkPriceResponseInner */ t?: string; /** * gamma * @type {string} * @memberof OptionMarkPriceResponseInner */ g?: string; /** * vega * @type {string} * @memberof OptionMarkPriceResponseInner */ v?: string; } //#endregion //#region src/websocket-streams/types/option-mark-price-response.d.ts /** * * @export * @interface OptionMarkPriceResponse */ interface OptionMarkPriceResponse extends Array {} //#endregion //#region src/websocket-streams/types/order-trade-update-o.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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; /** * 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; /** * 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; /** * Commission Asset * @type {string} * @memberof OrderTradeUpdateO */ N?: string; /** * Commission, negative means fee charge * @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; /** * Bids qty * @type {string} * @memberof OrderTradeUpdateO */ b?: string; /** * Ask qty * @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; /** * Original Order Type * @type {string} * @memberof OrderTradeUpdateO */ ot?: string; /** * Realized Profit of the trade * @type {string} * @memberof OrderTradeUpdateO */ rp?: string; /** * STP mode * @type {string} * @memberof OrderTradeUpdateO */ V?: 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; /** * * @type {OrderTradeUpdateO} * @memberof OrderTradeUpdate */ o?: OrderTradeUpdateO; } //#endregion //#region src/websocket-streams/types/partial-book-depth-streams-response.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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; /** * Option symbol * @type {string} * @memberof PartialBookDepthStreamsResponse */ s?: string; /** * First update ID in event * @type {number | bigint} * @memberof PartialBookDepthStreamsResponse */ U?: number | bigint; /** * Final update ID in event * @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; /** * Buy order * @type {Array>} * @memberof PartialBookDepthStreamsResponse */ b?: Array>; /** * Sell order * @type {Array>} * @memberof PartialBookDepthStreamsResponse */ a?: Array>; } //#endregion //#region src/websocket-streams/types/risk-level-change.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 RiskLevelChange */ interface RiskLevelChange { /** * Event Time * @type {number | bigint} * @memberof RiskLevelChange */ E?: number | bigint; /** * Risk level. This feature only applies to VIP and Market Maker accounts. Risk level is re-evaluated on: funds transfer, trade fill, option expiry. * @type {string} * @memberof RiskLevelChange */ s?: string; /** * Margin balance * @type {string} * @memberof RiskLevelChange */ mb?: string; /** * Maintenance margin * @type {string} * @memberof RiskLevelChange */ mm?: string; } //#endregion //#region src/websocket-streams/types/trade-streams-response.d.ts /** * Options WebSocket Market Streams * * Access market data, manage accounts, and trade Binance Options. * * 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 TradeStreamsResponse */ interface TradeStreamsResponse { /** * event type * @type {string} * @memberof TradeStreamsResponse */ e?: string; /** * event time * @type {number | bigint} * @memberof TradeStreamsResponse */ E?: number | bigint; /** * trade completed time * @type {number | bigint} * @memberof TradeStreamsResponse */ T?: number | bigint; /** * Option trading symbol * @type {string} * @memberof TradeStreamsResponse */ s?: string; /** * trade ID * @type {number | bigint} * @memberof TradeStreamsResponse */ t?: number | bigint; /** * price * @type {string} * @memberof TradeStreamsResponse */ p?: string; /** * quantity, always positive * @type {string} * @memberof TradeStreamsResponse */ q?: string; /** * trade type enum, \"MARKET\" for Orderbook trading, \"BLOCK\" for Block trade * @type {string} * @memberof TradeStreamsResponse */ X?: string; /** * direction * @type {string} * @memberof TradeStreamsResponse */ S?: string; /** * Is the buyer the market maker? * @type {boolean} * @memberof TradeStreamsResponse */ m?: boolean; } //#endregion //#region src/websocket-streams/types/user-data-stream-events-response.d.ts /** * @type UserDataStreamEventsResponse */ type UserDataStreamEventsResponse = ({ e: 'ACCOUNT_UPDATE'; } & AccountUpdate) | ({ e: 'BALANCE_POSITION_UPDATE'; } & BalancePositionUpdate) | ({ e: 'GREEK_UPDATE'; } & GreekUpdate) | ({ e: 'ORDER_TRADE_UPDATE'; } & OrderTradeUpdate) | ({ e: 'RISK_LEVEL_CHANGE'; } & RiskLevelChange) | ({ e: 'listenKeyExpired'; } & ListenKeyExpired); //#endregion //#region src/websocket-streams/modules/market-api.d.ts /** * MarketApi - interface * @interface MarketApi */ interface MarketApiInterface { /** * Underlying(e.g ETHUSDT) index stream. * * Update Speed: 1000ms * * @summary Index Price Streams * @param {IndexPriceStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof MarketApiInterface */ indexPriceStreams(requestParameters?: IndexPriceStreamsRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current klines/candlestick every 1000 milliseconds (if existing). * * Update Speed: 1000ms * * @summary Kline/Candlestick Streams * @param {KlineCandlestickStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof MarketApiInterface */ klineCandlestickStreams(requestParameters: KlineCandlestickStreamsRequest): WebsocketStream; /** * New symbol listing stream. * * Update Speed: 50ms * * @summary New Symbol Info * @param {NewSymbolInfoRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof MarketApiInterface */ newSymbolInfo(requestParameters?: NewSymbolInfoRequest): WebsocketStream; /** * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125) * * Update Speed: 60s * * @summary Open Interest * @param {OpenInterestRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof MarketApiInterface */ openInterest(requestParameters: OpenInterestRequest): WebsocketStream; /** * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice) * * Update Speed: 1000ms * * @summary Option Mark Price * @param {OptionMarkPriceRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof MarketApiInterface */ optionMarkPrice(requestParameters: OptionMarkPriceRequest): WebsocketStream; } /** * Request parameters for indexPriceStreams operation in MarketApi. * @interface IndexPriceStreamsRequest */ interface IndexPriceStreamsRequest { /** * Unique WebSocket request ID. * @type {number} * @memberof MarketApiIndexPriceStreams */ readonly id?: number; } /** * Request parameters for klineCandlestickStreams operation in MarketApi. * @interface KlineCandlestickStreamsRequest */ interface KlineCandlestickStreamsRequest { /** * The symbol parameter * @type {string} * @memberof MarketApiKlineCandlestickStreams */ readonly symbol: string; /** * The interval parameter * @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '12h' | '1d' | '3d' | '1w'} * @memberof MarketApiKlineCandlestickStreams */ readonly interval: KlineCandlestickStreamsIntervalEnum; /** * Unique WebSocket request ID. * @type {number} * @memberof MarketApiKlineCandlestickStreams */ readonly id?: number; } /** * Request parameters for newSymbolInfo operation in MarketApi. * @interface NewSymbolInfoRequest */ interface NewSymbolInfoRequest { /** * Unique WebSocket request ID. * @type {number} * @memberof MarketApiNewSymbolInfo */ readonly id?: number; } /** * Request parameters for openInterest operation in MarketApi. * @interface OpenInterestRequest */ interface OpenInterestRequest { /** * The underlying parameter * @type {string} * @memberof MarketApiOpenInterest */ readonly underlying: string; /** * The expirationDate parameter * @type {string} * @memberof MarketApiOpenInterest */ readonly expirationDate: string; /** * Unique WebSocket request ID. * @type {number} * @memberof MarketApiOpenInterest */ readonly id?: number; } /** * Request parameters for optionMarkPrice operation in MarketApi. * @interface OptionMarkPriceRequest */ interface OptionMarkPriceRequest { /** * The underlying parameter * @type {string} * @memberof MarketApiOptionMarkPrice */ readonly underlying: string; /** * Unique WebSocket request ID. * @type {number} * @memberof MarketApiOptionMarkPrice */ readonly id?: number; } /** * MarketApi - interface * @class MarketApi * @extends {WebsocketStreamsBase} */ declare class MarketApi implements MarketApiInterface { private readonly websocketBase; private localVarParamCreator; constructor(websocketBase: WebsocketStreamsBase); /** * Underlying(e.g ETHUSDT) index stream. * * Update Speed: 1000ms * * @summary Index Price Streams * @param {IndexPriceStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/market#index-price-streams Binance API Documentation} */ indexPriceStreams(requestParameters?: IndexPriceStreamsRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current klines/candlestick every 1000 milliseconds (if existing). * * Update Speed: 1000ms * * @summary Kline/Candlestick Streams * @param {KlineCandlestickStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/market#kline-candlestick-streams Binance API Documentation} */ klineCandlestickStreams(requestParameters: KlineCandlestickStreamsRequest): WebsocketStream; /** * New symbol listing stream. * * Update Speed: 50ms * * @summary New Symbol Info * @param {NewSymbolInfoRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/market#new-symbol-info Binance API Documentation} */ newSymbolInfo(requestParameters?: NewSymbolInfoRequest): WebsocketStream; /** * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125) * * Update Speed: 60s * * @summary Open Interest * @param {OpenInterestRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/market#open-interest Binance API Documentation} */ openInterest(requestParameters: OpenInterestRequest): WebsocketStream; /** * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice) * * Update Speed: 1000ms * * @summary Option Mark Price * @param {OptionMarkPriceRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/market#option-mark-price Binance API Documentation} */ optionMarkPrice(requestParameters: OptionMarkPriceRequest): WebsocketStream; } 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_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", } //#endregion //#region src/websocket-streams/modules/public-api.d.ts /** * PublicApi - interface * @interface PublicApi */ interface PublicApiInterface { /** * Bids and asks, pushed every 500 milliseconds, 100 milliseconds (if existing) * * Update Speed: 100ms or 500ms * * @summary Diff Book Depth Streams * @param {DiffBookDepthStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof PublicApiInterface */ diffBookDepthStreams(requestParameters: DiffBookDepthStreamsRequest): WebsocketStream; /** * 24hr ticker info for all symbols. Only symbols whose ticker info changed will be sent. * * Update Speed: 1000ms * * @summary 24-hour TICKER * @param {Hour24TickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof PublicApiInterface */ hour24Ticker(requestParameters: Hour24TickerRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol. * * Update Speed: Real-Time * * @summary Individual Symbol Book Ticker Streams * @param {IndividualSymbolBookTickerStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof PublicApiInterface */ individualSymbolBookTickerStreams(requestParameters: IndividualSymbolBookTickerStreamsRequest): WebsocketStream; /** * Top bids and asks. Valid are 5, 10, 20. * * Update Speed: 100ms or 500ms * * @summary Partial Book Depth Streams * @param {PartialBookDepthStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof PublicApiInterface */ partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream; /** * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade) * * Update Speed: 50ms * * @summary Trade Streams * @param {TradeStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof PublicApiInterface */ tradeStreams(requestParameters: TradeStreamsRequest): WebsocketStream; } /** * Request parameters for diffBookDepthStreams operation in PublicApi. * @interface DiffBookDepthStreamsRequest */ interface DiffBookDepthStreamsRequest { /** * The symbol parameter * @type {string} * @memberof PublicApiDiffBookDepthStreams */ readonly symbol: string; /** * WebSocket stream update speed * @type {'100ms' | '500ms'} * @memberof PublicApiDiffBookDepthStreams */ readonly updateSpeed: DiffBookDepthStreamsUpdateSpeedEnum; /** * Unique WebSocket request ID. * @type {number} * @memberof PublicApiDiffBookDepthStreams */ readonly id?: number; } /** * Request parameters for hour24Ticker operation in PublicApi. * @interface Hour24TickerRequest */ interface Hour24TickerRequest { /** * The symbol parameter * @type {string} * @memberof PublicApiHour24Ticker */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {number} * @memberof PublicApiHour24Ticker */ readonly id?: number; /** * The expiration date parameter * @type {string} * @memberof PublicApiHour24Ticker */ readonly expirationDate?: string; } /** * Request parameters for individualSymbolBookTickerStreams operation in PublicApi. * @interface IndividualSymbolBookTickerStreamsRequest */ interface IndividualSymbolBookTickerStreamsRequest { /** * The symbol parameter * @type {string} * @memberof PublicApiIndividualSymbolBookTickerStreams */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {number} * @memberof PublicApiIndividualSymbolBookTickerStreams */ readonly id?: number; } /** * Request parameters for partialBookDepthStreams operation in PublicApi. * @interface PartialBookDepthStreamsRequest */ interface PartialBookDepthStreamsRequest { /** * The symbol parameter * @type {string} * @memberof PublicApiPartialBookDepthStreams */ readonly symbol: string; /** * The level parameter * @type {'5' | '10' | '20'} * @memberof PublicApiPartialBookDepthStreams */ readonly level: PartialBookDepthStreamsLevelEnum; /** * WebSocket stream update speed * @type {'100ms' | '500ms'} * @memberof PublicApiPartialBookDepthStreams */ readonly updateSpeed: PartialBookDepthStreamsUpdateSpeedEnum; /** * Unique WebSocket request ID. * @type {number} * @memberof PublicApiPartialBookDepthStreams */ readonly id?: number; } /** * Request parameters for tradeStreams operation in PublicApi. * @interface TradeStreamsRequest */ interface TradeStreamsRequest { /** * The symbol parameter * @type {string} * @memberof PublicApiTradeStreams */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {number} * @memberof PublicApiTradeStreams */ readonly id?: number; } /** * PublicApi - interface * @class PublicApi * @extends {WebsocketStreamsBase} */ declare class PublicApi implements PublicApiInterface { private readonly websocketBase; private localVarParamCreator; constructor(websocketBase: WebsocketStreamsBase); /** * Bids and asks, pushed every 500 milliseconds, 100 milliseconds (if existing) * * Update Speed: 100ms or 500ms * * @summary Diff Book Depth Streams * @param {DiffBookDepthStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof PublicApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/public#diff-book-depth-streams Binance API Documentation} */ diffBookDepthStreams(requestParameters: DiffBookDepthStreamsRequest): WebsocketStream; /** * 24hr ticker info for all symbols. Only symbols whose ticker info changed will be sent. * * Update Speed: 1000ms * * @summary 24-hour TICKER * @param {Hour24TickerRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof PublicApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/public#hour24-ticker Binance API Documentation} */ hour24Ticker(requestParameters: Hour24TickerRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol. * * Update Speed: Real-Time * * @summary Individual Symbol Book Ticker Streams * @param {IndividualSymbolBookTickerStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof PublicApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/public#individual-symbol-book-ticker-streams Binance API Documentation} */ individualSymbolBookTickerStreams(requestParameters: IndividualSymbolBookTickerStreamsRequest): WebsocketStream; /** * Top bids and asks. Valid are 5, 10, 20. * * Update Speed: 100ms or 500ms * * @summary Partial Book Depth Streams * @param {PartialBookDepthStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof PublicApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/public#partial-book-depth-streams Binance API Documentation} */ partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream; /** * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade) * * Update Speed: 50ms * * @summary Trade Streams * @param {TradeStreamsRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof PublicApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/public#trade-streams Binance API Documentation} */ tradeStreams(requestParameters: TradeStreamsRequest): WebsocketStream; } declare enum DiffBookDepthStreamsUpdateSpeedEnum { UPDATE_SPEED_100ms = "100ms", UPDATE_SPEED_500ms = "500ms", } declare enum PartialBookDepthStreamsLevelEnum { LEVEL_5 = "5", LEVEL_10 = "10", LEVEL_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 marketApi; private publicApi; 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?: number): 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?: number): 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; /** * Underlying(e.g ETHUSDT) index stream. * * Update Speed: 1000ms * * @summary Index Price Streams * @param {IndexPriceStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/market#index-price-streams Binance API Documentation} */ indexPriceStreams(requestParameters?: IndexPriceStreamsRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current klines/candlestick every 1000 milliseconds (if existing). * * Update Speed: 1000ms * * @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-options/api/ws-streams/market#kline-candlestick-streams Binance API Documentation} */ klineCandlestickStreams(requestParameters: KlineCandlestickStreamsRequest): WebsocketStream; /** * New symbol listing stream. * * Update Speed: 50ms * * @summary New Symbol Info * @param {NewSymbolInfoRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/market#new-symbol-info Binance API Documentation} */ newSymbolInfo(requestParameters?: NewSymbolInfoRequest): WebsocketStream; /** * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125) * * Update Speed: 60s * * @summary Open Interest * @param {OpenInterestRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/market#open-interest Binance API Documentation} */ openInterest(requestParameters: OpenInterestRequest): WebsocketStream; /** * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice) * * Update Speed: 1000ms * * @summary Option Mark Price * @param {OptionMarkPriceRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/market#option-mark-price Binance API Documentation} */ optionMarkPrice(requestParameters: OptionMarkPriceRequest): WebsocketStream; /** * Bids and asks, pushed every 500 milliseconds, 100 milliseconds (if existing) * * Update Speed: 100ms or 500ms * * @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-options/api/ws-streams/public#diff-book-depth-streams Binance API Documentation} */ diffBookDepthStreams(requestParameters: DiffBookDepthStreamsRequest): WebsocketStream; /** * 24hr ticker info for all symbols. Only symbols whose ticker info changed will be sent. * * Update Speed: 1000ms * * @summary 24-hour TICKER * @param {Hour24TickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/public#hour24-ticker Binance API Documentation} */ hour24Ticker(requestParameters: Hour24TickerRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol. * * 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-options/api/ws-streams/public#individual-symbol-book-ticker-streams Binance API Documentation} */ individualSymbolBookTickerStreams(requestParameters: IndividualSymbolBookTickerStreamsRequest): WebsocketStream; /** * Top bids and asks. Valid are 5, 10, 20. * * Update Speed: 100ms or 500ms * * @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-options/api/ws-streams/public#partial-book-depth-streams Binance API Documentation} */ partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream; /** * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade) * * Update Speed: 50ms * * @summary Trade Streams * @param {TradeStreamsRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-derivatives-trading-options/api/ws-streams/public#trade-streams Binance API Documentation} */ tradeStreams(requestParameters: TradeStreamsRequest): 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$1 { export { AccountUpdate, BalancePositionUpdate, BalancePositionUpdateBInner, BalancePositionUpdatePInner, DiffBookDepthStreamsRequest, DiffBookDepthStreamsResponse, DiffBookDepthStreamsUpdateSpeedEnum, GreekUpdate, GreekUpdateGInner, Hour24TickerRequest, Hour24TickerResponse, IndexPriceStreamsRequest, IndexPriceStreamsResponse, IndexPriceStreamsResponseInner, IndividualSymbolBookTickerStreamsRequest, IndividualSymbolBookTickerStreamsResponse, KlineCandlestickStreamsIntervalEnum, KlineCandlestickStreamsRequest, KlineCandlestickStreamsResponse, KlineCandlestickStreamsResponseK, ListenKeyExpired, MarketApi, MarketApiInterface, NewSymbolInfoRequest, NewSymbolInfoResponse, OpenInterestRequest, OpenInterestResponse, OpenInterestResponseInner, OptionMarkPriceRequest, OptionMarkPriceResponse, OptionMarkPriceResponseInner, OrderTradeUpdate, OrderTradeUpdateO, PartialBookDepthStreamsLevelEnum, PartialBookDepthStreamsRequest, PartialBookDepthStreamsResponse, PartialBookDepthStreamsUpdateSpeedEnum, PublicApi, PublicApiInterface, RiskLevelChange, TradeStreamsRequest, TradeStreamsResponse, UserDataStreamEventsResponse, WebsocketStreams, WebsocketStreamsConnection }; } //#endregion //#region src/derivatives-trading-options.d.ts interface ConfigurationDerivativesTradingOptions { configurationRestAPI?: ConfigurationRestAPI; configurationWebsocketStreams?: ConfigurationWebsocketStreams; } declare class DerivativesTradingOptions { restAPI: RestAPI; websocketStreams: WebsocketStreams; constructor(config: ConfigurationDerivativesTradingOptions); } //#endregion export { BadRequestError, type ConfigurationDerivativesTradingOptions, ConnectorClientError, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_TESTNET_URL, DerivativesTradingOptions, index_d_exports as DerivativesTradingOptionsRestAPI, index_d_exports$1 as DerivativesTradingOptionsWebsocketStreams, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError }; //# sourceMappingURL=index.d.mts.map