UNPKG

@binance/derivatives-trading-usds-futures

Version:

Official Binance Derivatives Trading (COIN-M Futures) Connector - A lightweight library that provides a convenient interface to Binance's COINN-M Futures REST API, WebSocket API and WebSocket Streams.

1 lines 1.01 MB
{"version":3,"file":"index.mjs","names":["localVarQueryParameter: Record<string, unknown>","localVarBodyParameter: Record<string, unknown>","localVarHeaderParameter: Record<string, unknown>","_timeUnit: TimeUnit | undefined","AccountApi","localVarQueryParameter: Record<string, unknown>","localVarBodyParameter: Record<string, unknown>","localVarHeaderParameter: Record<string, unknown>","_timeUnit: TimeUnit | undefined","localVarQueryParameter: Record<string, unknown>","localVarBodyParameter: Record<string, unknown>","localVarHeaderParameter: Record<string, unknown>","_timeUnit: TimeUnit | undefined","MarketDataApi","localVarQueryParameter: Record<string, unknown>","localVarBodyParameter: Record<string, unknown>","localVarHeaderParameter: Record<string, unknown>","_timeUnit: TimeUnit | undefined","localVarQueryParameter: Record<string, unknown>","localVarBodyParameter: Record<string, unknown>","localVarHeaderParameter: Record<string, unknown>","_timeUnit: TimeUnit | undefined","TradeApi","ModifyOrderSideEnum","ModifyOrderPriceMatchEnum","NewAlgoOrderAlgoTypeEnum","NewAlgoOrderSideEnum","NewAlgoOrderTypeEnum","NewAlgoOrderTimeInForceEnum","NewAlgoOrderWorkingTypeEnum","NewAlgoOrderPriceMatchEnum","NewAlgoOrderClosePositionEnum","NewAlgoOrderPriceProtectEnum","NewAlgoOrderReduceOnlyEnum","NewAlgoOrderNewOrderRespTypeEnum","NewAlgoOrderSelfTradePreventionModeEnum","NewOrderSideEnum","NewOrderTypeEnum","NewOrderTimeInForceEnum","NewOrderReduceOnlyEnum","NewOrderNewOrderRespTypeEnum","NewOrderPriceMatchEnum","NewOrderSelfTradePreventionModeEnum","localVarQueryParameter: Record<string, unknown>","localVarBodyParameter: Record<string, unknown>","localVarHeaderParameter: Record<string, unknown>","_timeUnit: TimeUnit | undefined","UserDataStreamsApi","AccountApi","MarketDataApi","TradeApi","UserDataStreamsApi","DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL","DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL","DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL"],"sources":["../package.json","../src/rest-api/types/modify-multiple-orders-batch-orders-parameter-inner.ts","../src/rest-api/types/place-multiple-orders-batch-orders-parameter-inner.ts","../src/rest-api/modules/account-api.ts","../src/rest-api/modules/convert-api.ts","../src/rest-api/modules/market-data-api.ts","../src/rest-api/modules/portfolio-margin-endpoints-api.ts","../src/rest-api/modules/trade-api.ts","../src/rest-api/modules/user-data-streams-api.ts","../src/rest-api/rest-api.ts","../src/rest-api/index.ts","../src/websocket-api/modules/account-api.ts","../src/websocket-api/modules/market-data-api.ts","../src/websocket-api/modules/trade-api.ts","../src/websocket-api/modules/user-data-streams-api.ts","../src/websocket-api/websocket-api-connection.ts","../src/websocket-api/websocket-api.ts","../src/websocket-api/index.ts","../src/websocket-streams/modules/market-api.ts","../src/websocket-streams/modules/public-api.ts","../src/websocket-streams/websocket-streams-connection.ts","../src/websocket-streams/websocket-streams.ts","../src/websocket-streams/index.ts","../src/derivatives-trading-usds-futures.ts"],"sourcesContent":["{\n \"name\": \"@binance/derivatives-trading-usds-futures\",\n \"description\": \"Official Binance Derivatives Trading (COIN-M Futures) Connector - A lightweight library that provides a convenient interface to Binance's COINN-M Futures REST API, WebSocket API and WebSocket Streams.\",\n \"version\": \"36.0.0\",\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"exports\": {\n \".\": {\n \"require\": \"./dist/index.js\",\n \"import\": \"./dist/index.mjs\"\n }\n },\n \"scripts\": {\n \"prepublishOnly\": \"npm run build\",\n \"build\": \"npm run clean && tsdown\",\n \"typecheck\": \"tsc --noEmit\",\n \"clean\": \"rm -rf dist\",\n \"test\": \"npx jest --maxWorkers=4 --bail\",\n \"test:watch\": \"npx jest --watch\",\n \"format\": \"npx prettier --ignore-path .prettierignore --write .\",\n \"lint\": \"npx eslint '**/*.ts' --fix\"\n },\n \"keywords\": [\n \"Binance\",\n \"API\",\n \"Derivatives\",\n \"Futures\",\n \"Coin-M\",\n \"Connector\",\n \"REST\",\n \"WebSocket\",\n \"Trading\"\n ],\n \"author\": \"Binance\",\n \"license\": \"MIT\",\n \"files\": [\n \"dist\"\n ],\n \"devDependencies\": {\n \"@types/jest\": \"^29.5.4\",\n \"@types/node\": \"^20.17.24\",\n \"eslint\": \"8.57.0\",\n \"jest\": \"^29.6.4\",\n \"json-with-bigint\": \"^3.5.8\",\n \"prettier\": \"^3.3.3\",\n \"ts-jest\": \"^29.1.1\",\n \"ts-node\": \"^10.9.1\",\n \"tsdown\": \"^0.16.5\",\n \"typescript\": \"^5.7.2\",\n \"typescript-eslint\": \"^8.24.0\"\n },\n \"dependencies\": {\n \"@binance/common\": \"2.4.5\",\n \"@types/ws\": \"^8.5.5\",\n \"axios\": \"^1.7.4\",\n \"ws\": \"^8.17.1\"\n }\n}\n","/* tslint:disable */\n\n/**\n * Futures (USDⓈ-M) REST API\n *\n * Access market data, manage accounts, and trade USDⓈ-M perpetual futures.\n *\n * The version of the OpenAPI document: 1.0.0\n *\n *\n * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).\n * https://openapi-generator.tech\n * Do not edit the class manually.\n */\n\n/**\n *\n * @export\n * @interface ModifyMultipleOrdersBatchOrdersParameterInner\n */\nexport interface ModifyMultipleOrdersBatchOrdersParameterInner {\n /**\n *\n * @type {number | bigint}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n orderId?: number | bigint;\n /**\n *\n * @type {string}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n origClientOrderId?: string;\n /**\n *\n * @type {string}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n symbol?: string;\n /**\n *\n * @type {string}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n side?: ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum;\n /**\n * Order quantity, cannot be sent with closePosition=true\n * @type {number}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n quantity?: number;\n /**\n *\n * @type {number}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n price?: number;\n /**\n * Only avaliable for LIMIT/STOP/TAKE_PROFIT order; Cannot be sent together with `price`.\n * @type {string}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n priceMatch?: ModifyMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum;\n /**\n * stop price, only STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET need\n * @type {number}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n stopPrice?: number;\n /**\n * User-defined modification identifier, returned as-is in the response. Optional; not validated for uniqueness.\n * @type {number | bigint}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n modifyId?: number | bigint;\n /**\n * Validity window in milliseconds.\n * @type {number | bigint}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n recvWindow?: number | bigint;\n /**\n * Unix timestamp in milliseconds.\n * @type {number | bigint}\n * @memberof ModifyMultipleOrdersBatchOrdersParameterInner\n */\n timestamp?: number | bigint;\n}\n\nexport const ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum = {\n BUY: 'BUY',\n SELL: 'SELL',\n} as const;\n\nexport type ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum =\n (typeof ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum)[keyof typeof ModifyMultipleOrdersBatchOrdersParameterInnerSideEnum];\nexport const ModifyMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum = {\n OPPONENT: 'OPPONENT',\n OPPONENT_5: 'OPPONENT_5',\n OPPONENT_10: 'OPPONENT_10',\n OPPONENT_20: 'OPPONENT_20',\n QUEUE: 'QUEUE',\n QUEUE_5: 'QUEUE_5',\n QUEUE_10: 'QUEUE_10',\n QUEUE_20: 'QUEUE_20',\n} as const;\n\nexport type ModifyMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum =\n (typeof ModifyMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum)[keyof typeof ModifyMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum];\n","/* tslint:disable */\n\n/**\n * Futures (USDⓈ-M) REST API\n *\n * Access market data, manage accounts, and trade USDⓈ-M perpetual futures.\n *\n * The version of the OpenAPI document: 1.0.0\n *\n *\n * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).\n * https://openapi-generator.tech\n * Do not edit the class manually.\n */\n\n/**\n *\n * @export\n * @interface PlaceMultipleOrdersBatchOrdersParameterInner\n */\nexport interface PlaceMultipleOrdersBatchOrdersParameterInner {\n /**\n *\n * @type {string}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n symbol?: string;\n /**\n *\n * @type {string}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n side?: PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum;\n /**\n * Default `BOTH` for One-way Mode; `LONG` or `SHORT` for Hedge Mode.\n * @type {string}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n positionSide?: PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum;\n /**\n *\n * @type {string}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n type?: PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum;\n /**\n *\n * @type {string}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n timeInForce?: PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum;\n /**\n *\n * @type {number}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n quantity?: number;\n /**\n *\n * @type {string}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n reduceOnly?: PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum;\n /**\n *\n * @type {number}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n price?: number;\n /**\n *\n * @type {string}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n newClientOrderId?: string;\n /**\n *\n * @type {string}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n newOrderRespType?: PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum;\n /**\n * only avaliable for LIMIT/STOP/TAKE_PROFIT order; Can\\'t be passed together with price\n * @type {string}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n priceMatch?: PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum;\n /**\n * EXPIRE_TAKER:expire taker order when STP triggers/ EXPIRE_MAKER:expire taker order when STP triggers/ EXPIRE_BOTH:expire both orders when STP triggers; default NONE\n * @type {string}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n selfTradePreventionMode?: PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum;\n /**\n * Auto-cancel time for `GTD` orders.\n * @type {number | bigint}\n * @memberof PlaceMultipleOrdersBatchOrdersParameterInner\n */\n goodTillDate?: number | bigint;\n}\n\nexport const PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum = {\n BUY: 'BUY',\n SELL: 'SELL',\n} as const;\n\nexport type PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum =\n (typeof PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerSideEnum];\nexport const PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum = {\n BOTH: 'BOTH',\n LONG: 'LONG',\n SHORT: 'SHORT',\n} as const;\n\nexport type PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum =\n (typeof PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerPositionSideEnum];\nexport const PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum = {\n LIMIT: 'LIMIT',\n MARKET: 'MARKET',\n STOP: 'STOP',\n STOP_MARKET: 'STOP_MARKET',\n TAKE_PROFIT: 'TAKE_PROFIT',\n TAKE_PROFIT_MARKET: 'TAKE_PROFIT_MARKET',\n TRAILING_STOP_MARKET: 'TRAILING_STOP_MARKET',\n} as const;\n\nexport type PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum =\n (typeof PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerTypeEnum];\nexport const PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum = {\n GTC: 'GTC',\n IOC: 'IOC',\n FOK: 'FOK',\n GTX: 'GTX',\n GTD: 'GTD',\n RPI: 'RPI',\n} as const;\n\nexport type PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum =\n (typeof PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerTimeInForceEnum];\nexport const PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum = {\n TRUE: 'true',\n FALSE: 'false',\n} as const;\n\nexport type PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum =\n (typeof PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerReduceOnlyEnum];\nexport const PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum = {\n ACK: 'ACK',\n RESULT: 'RESULT',\n} as const;\n\nexport type PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum =\n (typeof PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerNewOrderRespTypeEnum];\nexport const PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum = {\n OPPONENT: 'OPPONENT',\n OPPONENT_5: 'OPPONENT_5',\n OPPONENT_10: 'OPPONENT_10',\n OPPONENT_20: 'OPPONENT_20',\n QUEUE: 'QUEUE',\n QUEUE_5: 'QUEUE_5',\n QUEUE_10: 'QUEUE_10',\n QUEUE_20: 'QUEUE_20',\n} as const;\n\nexport type PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum =\n (typeof PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerPriceMatchEnum];\nexport const PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum = {\n NONE: 'NONE',\n EXPIRE_TAKER: 'EXPIRE_TAKER',\n EXPIRE_BOTH: 'EXPIRE_BOTH',\n EXPIRE_MAKER: 'EXPIRE_MAKER',\n} as const;\n\nexport type PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum =\n (typeof PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum)[keyof typeof PlaceMultipleOrdersBatchOrdersParameterInnerSelfTradePreventionModeEnum];\n","/**\n * Futures (USDⓈ-M) REST API\n *\n * Access market data, manage accounts, and trade USDⓈ-M perpetual futures.\n *\n * The version of the OpenAPI document: 1.0.0\n *\n *\n * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).\n * https://openapi-generator.tech\n * Do not edit the class manually.\n */\nimport {\n ConfigurationRestAPI,\n TimeUnit,\n RestApiResponse,\n assertParamExists,\n sendRequest,\n type RequestArgs,\n} from '@binance/common';\nimport type {\n AccountInformationV2Response,\n AccountInformationV3Response,\n FuturesAccountBalanceV2Response,\n FuturesAccountBalanceV3Response,\n FuturesAccountConfigurationResponse,\n FuturesTradingQuantitativeRulesIndicatorsResponse,\n GetBnbBurnStatusResponse,\n GetCurrentMultiAssetsModeResponse,\n GetCurrentPositionModeResponse,\n GetDownloadIdForFuturesOrderHistoryResponse,\n GetDownloadIdForFuturesTradeHistoryResponse,\n GetDownloadIdForFuturesTransactionHistoryResponse,\n GetFuturesOrderHistoryDownloadLinkByIdResponse,\n GetFuturesTradeDownloadLinkByIdResponse,\n GetFuturesTransactionHistoryDownloadLinkByIdResponse,\n GetIncomeHistoryResponse,\n NotionalAndLeverageBracketsResponse,\n QueryUserRateLimitResponse,\n SymbolConfigurationResponse,\n ToggleBnbBurnOnFuturesTradeResponse,\n UserCommissionRateResponse,\n} from '../types';\n\n/**\n * AccountApi - axios parameter creator\n */\nconst AccountApiAxiosParamCreator = function (configuration: ConfigurationRestAPI) {\n return {\n /**\n * Get current account information. User in single-asset/ multi-assets mode will see different value, see comments in response section for detail.\n *\n * Weight(IP): 5\n *\n * Security Type: USER_DATA\n *\n * @summary Account Information V2 (USER_DATA)\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n accountInformationV2: async (recvWindow?: number | bigint): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v2/account',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get current account information. User in single-asset/ multi-assets mode will see different value, see comments in response section for detail.\n *\n * Weight(IP): 5\n *\n * Security Type: USER_DATA\n *\n * @summary Account Information V3 (USER_DATA)\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n accountInformationV3: async (recvWindow?: number | bigint): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v3/account',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Query account balance information.\n *\n * Weight(IP): 5\n *\n * Security Type: USER_DATA\n *\n * @summary Futures Account Balance V2 (USER_DATA)\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n futuresAccountBalanceV2: async (recvWindow?: number | bigint): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v2/balance',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Query account balance information.\n *\n * Weight(IP): 5\n *\n * Security Type: USER_DATA\n *\n * @summary Futures Account Balance V3 (USER_DATA)\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n futuresAccountBalanceV3: async (recvWindow?: number | bigint): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v3/balance',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Query account configuration\n *\n * Weight(IP): 5\n *\n * Security Type: USER_DATA\n *\n * @summary Futures Account Configuration (USER_DATA)\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n futuresAccountConfiguration: async (recvWindow?: number | bigint): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/accountConfig',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Futures trading quantitative rules indicators, for more information on this, please refer to the [Futures Trading Quantitative Rules](https://www.binance.com/en/support/faq/4f462ebe6ff445d4a170be7d9e897272)\n *\n * Weight: - **1** for a single symbol\n * - **10** when the symbol parameter is omitted\n *\n * Security Type: USER_DATA\n *\n * @summary Futures Trading Quantitative Rules Indicators (USER_DATA)\n * @param {string} [symbol]\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n futuresTradingQuantitativeRulesIndicators: async (\n symbol?: string,\n recvWindow?: number | bigint\n ): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (symbol !== undefined && symbol !== null) {\n localVarQueryParameter['symbol'] = symbol;\n }\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/apiTradingStatus',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get user's BNB Fee Discount (Fee Discount On or Fee Discount Off )\n *\n * Weight(IP): 30\n *\n * Security Type: USER_DATA\n *\n * @summary Get BNB Burn Status (USER_DATA)\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getBnbBurnStatus: async (recvWindow?: number | bigint): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/feeBurn',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get user's Multi-Assets mode (Multi-Assets Mode or Single-Asset Mode) on ***Every symbol***\n *\n * Weight(IP): 30\n *\n * Security Type: USER_DATA\n *\n * @summary Get Current Multi-Assets Mode (USER_DATA)\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getCurrentMultiAssetsMode: async (recvWindow?: number | bigint): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/multiAssetsMargin',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get user's position mode (Hedge Mode or One-way Mode ) on ***EVERY symbol***\n *\n * Weight(IP): 30\n *\n * Security Type: USER_DATA\n *\n * @summary Get Current Position Mode (USER_DATA)\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getCurrentPositionMode: async (recvWindow?: number | bigint): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/positionSide/dual',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get Download Id For Futures Order History\n *\n * Weight(IP): 1000\n *\n * Security Type: USER_DATA\n *\n * Notes:\n * - Request Limitation is 10 times per month, shared by front end download page and rest api\n * - The time between `startTime` and `endTime` can not be longer than 1 year\n *\n * @summary Get Download Id For Futures Order History (USER_DATA)\n * @param {number | bigint} startTime Timestamp in ms\n * @param {number | bigint} endTime Timestamp in ms\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getDownloadIdForFuturesOrderHistory: async (\n startTime: number | bigint,\n endTime: number | bigint,\n recvWindow?: number | bigint\n ): Promise<RequestArgs> => {\n // verify required parameter 'startTime' is not null or undefined\n assertParamExists('getDownloadIdForFuturesOrderHistory', 'startTime', startTime);\n // verify required parameter 'endTime' is not null or undefined\n assertParamExists('getDownloadIdForFuturesOrderHistory', 'endTime', endTime);\n\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (startTime !== undefined && startTime !== null) {\n localVarQueryParameter['startTime'] = startTime;\n }\n if (endTime !== undefined && endTime !== null) {\n localVarQueryParameter['endTime'] = endTime;\n }\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/order/asyn',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get download id for futures trade history\n *\n * Weight(IP): 1000\n *\n * Security Type: USER_DATA\n *\n * Notes:\n * - Request Limitation is 5 times per month, shared by front end download page and rest api\n * - The time between `startTime` and `endTime` can not be longer than 1 year\n *\n * @summary Get Download Id For Futures Trade History (USER_DATA)\n * @param {number | bigint} startTime Timestamp in ms\n * @param {number | bigint} endTime Timestamp in ms\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getDownloadIdForFuturesTradeHistory: async (\n startTime: number | bigint,\n endTime: number | bigint,\n recvWindow?: number | bigint\n ): Promise<RequestArgs> => {\n // verify required parameter 'startTime' is not null or undefined\n assertParamExists('getDownloadIdForFuturesTradeHistory', 'startTime', startTime);\n // verify required parameter 'endTime' is not null or undefined\n assertParamExists('getDownloadIdForFuturesTradeHistory', 'endTime', endTime);\n\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (startTime !== undefined && startTime !== null) {\n localVarQueryParameter['startTime'] = startTime;\n }\n if (endTime !== undefined && endTime !== null) {\n localVarQueryParameter['endTime'] = endTime;\n }\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/trade/asyn',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get download id for futures transaction history\n *\n * Weight(IP): 1000\n *\n * Security Type: USER_DATA\n *\n * Notes:\n * - Request Limitation is 5 times per month, shared by front end download page and rest api\n * - The time between `startTime` and `endTime` can not be longer than 1 year\n *\n * @summary Get Download Id For Futures Transaction History (USER_DATA)\n * @param {number | bigint} startTime Timestamp in ms\n * @param {number | bigint} endTime Timestamp in ms\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getDownloadIdForFuturesTransactionHistory: async (\n startTime: number | bigint,\n endTime: number | bigint,\n recvWindow?: number | bigint\n ): Promise<RequestArgs> => {\n // verify required parameter 'startTime' is not null or undefined\n assertParamExists('getDownloadIdForFuturesTransactionHistory', 'startTime', startTime);\n // verify required parameter 'endTime' is not null or undefined\n assertParamExists('getDownloadIdForFuturesTransactionHistory', 'endTime', endTime);\n\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (startTime !== undefined && startTime !== null) {\n localVarQueryParameter['startTime'] = startTime;\n }\n if (endTime !== undefined && endTime !== null) {\n localVarQueryParameter['endTime'] = endTime;\n }\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/income/asyn',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get futures order history download link by Id\n *\n * Weight(IP): 10\n *\n * Security Type: USER_DATA\n *\n * Notes:\n * - Download link expiration: 7 days\n *\n * @summary Get Futures Order History Download Link by Id (USER_DATA)\n * @param {string} downloadId get by download id api\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getFuturesOrderHistoryDownloadLinkById: async (\n downloadId: string,\n recvWindow?: number | bigint\n ): Promise<RequestArgs> => {\n // verify required parameter 'downloadId' is not null or undefined\n assertParamExists('getFuturesOrderHistoryDownloadLinkById', 'downloadId', downloadId);\n\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (downloadId !== undefined && downloadId !== null) {\n localVarQueryParameter['downloadId'] = downloadId;\n }\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/order/asyn/id',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get futures trade download link by Id\n *\n * Weight(IP): 10\n *\n * Security Type: USER_DATA\n *\n * Notes:\n * - Download link expiration: 7 days\n *\n * @summary Get Futures Trade Download Link by Id (USER_DATA)\n * @param {string} downloadId get by download id api\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getFuturesTradeDownloadLinkById: async (\n downloadId: string,\n recvWindow?: number | bigint\n ): Promise<RequestArgs> => {\n // verify required parameter 'downloadId' is not null or undefined\n assertParamExists('getFuturesTradeDownloadLinkById', 'downloadId', downloadId);\n\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (downloadId !== undefined && downloadId !== null) {\n localVarQueryParameter['downloadId'] = downloadId;\n }\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/trade/asyn/id',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get futures transaction history download link by Id\n *\n * Weight(IP): 10\n *\n * Security Type: USER_DATA\n *\n * Notes:\n * - Download link expiration: 7 days\n *\n * @summary Get Futures Transaction History Download Link by Id (USER_DATA)\n * @param {string} downloadId get by download id api\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getFuturesTransactionHistoryDownloadLinkById: async (\n downloadId: string,\n recvWindow?: number | bigint\n ): Promise<RequestArgs> => {\n // verify required parameter 'downloadId' is not null or undefined\n assertParamExists(\n 'getFuturesTransactionHistoryDownloadLinkById',\n 'downloadId',\n downloadId\n );\n\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (downloadId !== undefined && downloadId !== null) {\n localVarQueryParameter['downloadId'] = downloadId;\n }\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/income/asyn/id',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Query income history\n *\n * Weight(IP): 30\n *\n * Security Type: USER_DATA\n *\n * Notes:\n * - If `incomeType ` is not sent, all kinds of flow will be returned\n * - If `startTime` and `endTime` are not sent, the recent 7-day data will be returned.\n * - `trandId` is unique in the same `incomeType` for a user.\n * - Income history only contains data for the last three months.\n *\n * @summary Get Income History (USER_DATA)\n * @param {string} [symbol] Trading symbol.\n * @param {GetIncomeHistoryIncomeTypeEnum} [incomeType] Income type.\n * @param {number | bigint} [startTime] Timestamp in milliseconds (inclusive start).\n * @param {number | bigint} [endTime] Timestamp in milliseconds (inclusive end).\n * @param {number | bigint} [page] Pagination page number.\n * @param {number | bigint} [limit] Maximum number of records to return.\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getIncomeHistory: async (\n symbol?: string,\n incomeType?: GetIncomeHistoryIncomeTypeEnum,\n startTime?: number | bigint,\n endTime?: number | bigint,\n page?: number | bigint,\n limit?: number | bigint,\n recvWindow?: number | bigint\n ): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (symbol !== undefined && symbol !== null) {\n localVarQueryParameter['symbol'] = symbol;\n }\n if (incomeType !== undefined && incomeType !== null) {\n localVarQueryParameter['incomeType'] = incomeType;\n }\n if (startTime !== undefined && startTime !== null) {\n localVarQueryParameter['startTime'] = startTime;\n }\n if (endTime !== undefined && endTime !== null) {\n localVarQueryParameter['endTime'] = endTime;\n }\n if (page !== undefined && page !== null) {\n localVarQueryParameter['page'] = page;\n }\n if (limit !== undefined && limit !== null) {\n localVarQueryParameter['limit'] = limit;\n }\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/income',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Query user notional and leverage bracket on speicfic symbol\n *\n * Weight(IP): 1\n *\n * Security Type: USER_DATA\n *\n * @summary Notional and Leverage Brackets (USER_DATA)\n * @param {string} [symbol]\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n notionalAndLeverageBrackets: async (\n symbol?: string,\n recvWindow?: number | bigint\n ): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (symbol !== undefined && symbol !== null) {\n localVarQueryParameter['symbol'] = symbol;\n }\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/leverageBracket',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Query User Rate Limit\n *\n * Weight(IP): 1\n *\n * Security Type: USER_DATA\n *\n * @summary Query User Rate Limit (USER_DATA)\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n queryUserRateLimit: async (recvWindow?: number | bigint): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/rateLimit/order',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Get current account symbol configuration.\n *\n * Weight(IP): 5\n *\n * Security Type: USER_DATA\n *\n * @summary Symbol Configuration (USER_DATA)\n * @param {string} [symbol] Symbol\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n symbolConfiguration: async (\n symbol?: string,\n recvWindow?: number | bigint\n ): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n const localVarBodyParameter: Record<string, unknown> = {};\n const localVarHeaderParameter: Record<string, unknown> = {};\n\n if (symbol !== undefined && symbol !== null) {\n localVarQueryParameter['symbol'] = symbol;\n }\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/fapi/v1/symbolConfig',\n method: 'GET',\n queryParams: localVarQueryParameter,\n bodyParams: localVarBodyParameter,\n headerParams: localVarHeaderParameter,\n timeUnit: _timeUnit,\n };\n },\n /**\n * Change user's BNB Fee Discount (Fee Discount On or Fee Discount Off ) on ***EVERY symbol***\n *\n * Weight(IP): 1\n *\n * Security Type: TRADE\n *\n * @summary Toggle BNB Burn On Futures Trade (TRADE)\n * @param {string} feeBurn \"true\": Fee Discount On; \"false\": Fee Discount Off\n * @param {number | bigint} [recvWindow]\n *\n * @throws {RequiredError}\n */\n toggleBnbBurnOnFuturesTrade: async (\n feeBurn: string,\n recvWindow?: number | bigint\n ): Pro