import { BadRequestError, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, RestApiResponse, SPOT_REST_API_DEMO_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_DEMO_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_DEMO_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, ServerError, TimeUnit, TimeUnit as TimeUnit$1, TooManyRequestsError, UnauthorizedError, WebsocketAPIBase, WebsocketApiResponse, WebsocketSendMsgOptions, WebsocketStream, WebsocketStreamsBase } from "@binance/common"; //#region rolldown:runtime //#endregion //#region src/rest-api/types/account-commission-response-discount.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Discount commission when paying in BNB * @export * @interface AccountCommissionResponseDiscount */ interface AccountCommissionResponseDiscount { /** * * @type {boolean} * @memberof AccountCommissionResponseDiscount */ enabledForAccount?: boolean; /** * * @type {boolean} * @memberof AccountCommissionResponseDiscount */ enabledForSymbol?: boolean; /** * * @type {string} * @memberof AccountCommissionResponseDiscount */ discountAsset?: string; /** * Standard commission is reduced by this rate when paying commission in BNB. * @type {string} * @memberof AccountCommissionResponseDiscount */ discount?: string; } //#endregion //#region src/rest-api/types/account-commission-response-special-commission.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Special commission rates from the order. * @export * @interface AccountCommissionResponseSpecialCommission */ interface AccountCommissionResponseSpecialCommission { /** * * @type {string} * @memberof AccountCommissionResponseSpecialCommission */ maker?: string; /** * * @type {string} * @memberof AccountCommissionResponseSpecialCommission */ taker?: string; /** * * @type {string} * @memberof AccountCommissionResponseSpecialCommission */ buyer?: string; /** * * @type {string} * @memberof AccountCommissionResponseSpecialCommission */ seller?: string; } //#endregion //#region src/rest-api/types/account-commission-response-standard-commission.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Commission rates on trades from the order. * @export * @interface AccountCommissionResponseStandardCommission */ interface AccountCommissionResponseStandardCommission { /** * * @type {string} * @memberof AccountCommissionResponseStandardCommission */ maker?: string; /** * * @type {string} * @memberof AccountCommissionResponseStandardCommission */ taker?: string; /** * * @type {string} * @memberof AccountCommissionResponseStandardCommission */ buyer?: string; /** * * @type {string} * @memberof AccountCommissionResponseStandardCommission */ seller?: string; } //#endregion //#region src/rest-api/types/account-commission-response-tax-commission.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Tax commission rates for trades from the order. * @export * @interface AccountCommissionResponseTaxCommission */ interface AccountCommissionResponseTaxCommission { /** * * @type {string} * @memberof AccountCommissionResponseTaxCommission */ maker?: string; /** * * @type {string} * @memberof AccountCommissionResponseTaxCommission */ taker?: string; /** * * @type {string} * @memberof AccountCommissionResponseTaxCommission */ buyer?: string; /** * * @type {string} * @memberof AccountCommissionResponseTaxCommission */ seller?: string; } //#endregion //#region src/rest-api/types/account-commission-response.d.ts /** * * @export * @interface AccountCommissionResponse */ interface AccountCommissionResponse$1 { /** * * @type {string} * @memberof AccountCommissionResponse */ symbol?: string; /** * * @type {AccountCommissionResponseStandardCommission} * @memberof AccountCommissionResponse */ standardCommission?: AccountCommissionResponseStandardCommission; /** * * @type {AccountCommissionResponseSpecialCommission} * @memberof AccountCommissionResponse */ specialCommission?: AccountCommissionResponseSpecialCommission; /** * * @type {AccountCommissionResponseTaxCommission} * @memberof AccountCommissionResponse */ taxCommission?: AccountCommissionResponseTaxCommission; /** * * @type {AccountCommissionResponseDiscount} * @memberof AccountCommissionResponse */ discount?: AccountCommissionResponseDiscount; } //#endregion //#region src/rest-api/types/agg-trades-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AggTradesResponseInner */ interface AggTradesResponseInner { /** * Aggregate tradeId * @type {number | bigint} * @memberof AggTradesResponseInner */ a?: number | bigint; /** * Price * @type {string} * @memberof AggTradesResponseInner */ p?: string; /** * Quantity * @type {string} * @memberof AggTradesResponseInner */ q?: string; /** * First tradeId * @type {number | bigint} * @memberof AggTradesResponseInner */ f?: number | bigint; /** * Last tradeId * @type {number | bigint} * @memberof AggTradesResponseInner */ l?: number | bigint; /** * Timestamp * @type {number | bigint} * @memberof AggTradesResponseInner */ T?: number | bigint; /** * Was the buyer the maker? * @type {boolean} * @memberof AggTradesResponseInner */ m?: boolean; /** * Was the trade the best price match? * @type {boolean} * @memberof AggTradesResponseInner */ M?: boolean; } //#endregion //#region src/rest-api/types/agg-trades-response.d.ts /** * * @export * @interface AggTradesResponse */ interface AggTradesResponse extends Array {} //#endregion //#region src/rest-api/types/all-order-list-response-inner-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AllOrderListResponseInnerOrdersInner */ interface AllOrderListResponseInnerOrdersInner { /** * * @type {string} * @memberof AllOrderListResponseInnerOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof AllOrderListResponseInnerOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof AllOrderListResponseInnerOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/all-order-list-response-inner.d.ts /** * * @export * @interface AllOrderListResponseInner */ interface AllOrderListResponseInner { /** * * @type {number | bigint} * @memberof AllOrderListResponseInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof AllOrderListResponseInner */ contingencyType?: string; /** * * @type {string} * @memberof AllOrderListResponseInner */ listStatusType?: string; /** * * @type {string} * @memberof AllOrderListResponseInner */ listOrderStatus?: string; /** * * @type {string} * @memberof AllOrderListResponseInner */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof AllOrderListResponseInner */ transactionTime?: number | bigint; /** * * @type {string} * @memberof AllOrderListResponseInner */ symbol?: string; /** * * @type {Array} * @memberof AllOrderListResponseInner */ orders?: Array; } //#endregion //#region src/rest-api/types/all-order-list-response.d.ts /** * * @export * @interface AllOrderListResponse */ interface AllOrderListResponse extends Array {} //#endregion //#region src/rest-api/types/all-orders-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AllOrdersResponseInner */ interface AllOrdersResponseInner { /** * * @type {string} * @memberof AllOrdersResponseInner */ symbol?: string; /** * * @type {number | bigint} * @memberof AllOrdersResponseInner */ orderId?: number | bigint; /** * Unless it\'s part of an order list, value will be -1 * @type {number | bigint} * @memberof AllOrdersResponseInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof AllOrdersResponseInner */ clientOrderId?: string; /** * * @type {string} * @memberof AllOrdersResponseInner */ price?: string; /** * * @type {string} * @memberof AllOrdersResponseInner */ origQty?: string; /** * * @type {string} * @memberof AllOrdersResponseInner */ executedQty?: string; /** * * @type {string} * @memberof AllOrdersResponseInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof AllOrdersResponseInner */ status?: string; /** * * @type {string} * @memberof AllOrdersResponseInner */ timeInForce?: string; /** * * @type {string} * @memberof AllOrdersResponseInner */ type?: string; /** * * @type {string} * @memberof AllOrdersResponseInner */ side?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof AllOrdersResponseInner */ stopPrice?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof AllOrdersResponseInner */ icebergQty?: string; /** * * @type {number | bigint} * @memberof AllOrdersResponseInner */ time?: number | bigint; /** * * @type {number | bigint} * @memberof AllOrdersResponseInner */ updateTime?: number | bigint; /** * * @type {boolean} * @memberof AllOrdersResponseInner */ isWorking?: boolean; /** * * @type {string} * @memberof AllOrdersResponseInner */ origQuoteOrderQty?: string; /** * * @type {number | bigint} * @memberof AllOrdersResponseInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof AllOrdersResponseInner */ selfTradePreventionMode?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof AllOrdersResponseInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof AllOrdersResponseInner */ preventedQuantity?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof AllOrdersResponseInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof AllOrdersResponseInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof AllOrdersResponseInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof AllOrdersResponseInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof AllOrdersResponseInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof AllOrdersResponseInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof AllOrdersResponseInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof AllOrdersResponseInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof AllOrdersResponseInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof AllOrdersResponseInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof AllOrdersResponseInner */ expiryReason?: string; } //#endregion //#region src/rest-api/types/all-orders-response.d.ts /** * * @export * @interface AllOrdersResponse */ interface AllOrdersResponse$1 extends Array {} //#endregion //#region src/rest-api/types/avg-price-response.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AvgPriceResponse */ interface AvgPriceResponse$2 { /** * Average price interval (in minutes) * @type {number | bigint} * @memberof AvgPriceResponse */ mins?: number | bigint; /** * Average price * @type {string} * @memberof AvgPriceResponse */ price?: string; /** * Last trade time * @type {number | bigint} * @memberof AvgPriceResponse */ closeTime?: number | bigint; } //#endregion //#region src/rest-api/types/delete-open-orders-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 DeleteOpenOrdersResponseInner */ interface DeleteOpenOrdersResponseInner { /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ symbol?: string; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ origClientOrderId?: string; /** * * @type {number | bigint} * @memberof DeleteOpenOrdersResponseInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof DeleteOpenOrdersResponseInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof DeleteOpenOrdersResponseInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ price?: string; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ origQty?: string; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ executedQty?: string; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ status?: string; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ timeInForce?: string; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ type?: string; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ side?: string; /** * * @type {string} * @memberof DeleteOpenOrdersResponseInner */ selfTradePreventionMode?: string; } //#endregion //#region src/rest-api/types/delete-open-orders-response.d.ts /** * * @export * @interface DeleteOpenOrdersResponse */ interface DeleteOpenOrdersResponse extends Array {} //#endregion //#region src/rest-api/types/delete-order-list-response-order-reports-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 DeleteOrderListResponseOrderReportsInner */ interface DeleteOrderListResponseOrderReportsInner { /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ symbol?: string; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ origClientOrderId?: string; /** * * @type {number | bigint} * @memberof DeleteOrderListResponseOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof DeleteOrderListResponseOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof DeleteOrderListResponseOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ price?: string; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ status?: string; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ type?: string; /** * * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ side?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof DeleteOrderListResponseOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof DeleteOrderListResponseOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof DeleteOrderListResponseOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof DeleteOrderListResponseOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof DeleteOrderListResponseOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof DeleteOrderListResponseOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof DeleteOrderListResponseOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof DeleteOrderListResponseOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/rest-api/types/delete-order-list-response-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 DeleteOrderListResponseOrdersInner */ interface DeleteOrderListResponseOrdersInner { /** * * @type {string} * @memberof DeleteOrderListResponseOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof DeleteOrderListResponseOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof DeleteOrderListResponseOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/delete-order-list-response.d.ts /** * * @export * @interface DeleteOrderListResponse */ interface DeleteOrderListResponse { /** * * @type {number | bigint} * @memberof DeleteOrderListResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof DeleteOrderListResponse */ contingencyType?: string; /** * * @type {string} * @memberof DeleteOrderListResponse */ listStatusType?: string; /** * * @type {string} * @memberof DeleteOrderListResponse */ listOrderStatus?: string; /** * * @type {string} * @memberof DeleteOrderListResponse */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof DeleteOrderListResponse */ transactionTime?: number | bigint; /** * * @type {string} * @memberof DeleteOrderListResponse */ symbol?: string; /** * * @type {Array} * @memberof DeleteOrderListResponse */ orders?: Array; /** * * @type {Array} * @memberof DeleteOrderListResponse */ orderReports?: Array; } //#endregion //#region src/rest-api/types/delete-order-response.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 DeleteOrderResponse */ interface DeleteOrderResponse { /** * * @type {string} * @memberof DeleteOrderResponse */ symbol?: string; /** * * @type {number | bigint} * @memberof DeleteOrderResponse */ orderId?: number | bigint; /** * Unless it\'s part of an order list, value will be -1 * @type {number | bigint} * @memberof DeleteOrderResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof DeleteOrderResponse */ origClientOrderId?: string; /** * * @type {string} * @memberof DeleteOrderResponse */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof DeleteOrderResponse */ transactTime?: number | bigint; /** * * @type {string} * @memberof DeleteOrderResponse */ price?: string; /** * * @type {string} * @memberof DeleteOrderResponse */ origQty?: string; /** * * @type {string} * @memberof DeleteOrderResponse */ executedQty?: string; /** * * @type {string} * @memberof DeleteOrderResponse */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof DeleteOrderResponse */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof DeleteOrderResponse */ status?: string; /** * * @type {string} * @memberof DeleteOrderResponse */ timeInForce?: string; /** * * @type {string} * @memberof DeleteOrderResponse */ type?: string; /** * * @type {string} * @memberof DeleteOrderResponse */ side?: string; /** * * @type {string} * @memberof DeleteOrderResponse */ selfTradePreventionMode?: string; /** * Quantity for the iceberg order. Appears only if the parameter `icebergQty` was sent in the request. * @type {string} * @memberof DeleteOrderResponse */ icebergQty?: string; /** * When used together with `symbol`, can be used to query a prevented match. Appears only if the order expired due to STP. * @type {number | bigint} * @memberof DeleteOrderResponse */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. Appears only if the order expired due to STP. * @type {string} * @memberof DeleteOrderResponse */ preventedQuantity?: string; /** * Price when the algorithmic order will be triggered. Appears for `STOP_LOSS`, `TAKE_PROFIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` orders. * @type {string} * @memberof DeleteOrderResponse */ stopPrice?: string; /** * Can be used to label an order that\'s part of an order strategy. Appears if the parameter was populated in the request. * @type {number | bigint} * @memberof DeleteOrderResponse */ strategyId?: number | bigint; /** * Can be used to label an order that is using an order strategy. Appears if the parameter was populated in the request. * @type {number | bigint} * @memberof DeleteOrderResponse */ strategyType?: number | bigint; /** * Delta price change required before order activation. Appears for trailing stop orders. * @type {number | bigint} * @memberof DeleteOrderResponse */ trailingDelta?: number | bigint; /** * Time when the trailing order becomes active and starts tracking price changes. Appears only for trailing stop orders. * @type {number | bigint} * @memberof DeleteOrderResponse */ trailingTime?: number | bigint; /** * Indicates whether the order used SOR. Appears when placing orders using SOR. * @type {boolean} * @memberof DeleteOrderResponse */ usedSor?: boolean; /** * Indicates whether the order is being filled by SOR or by the order book to which it was submitted. Appears when placing orders using SOR. * @type {string} * @memberof DeleteOrderResponse */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof DeleteOrderResponse */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof DeleteOrderResponse */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof DeleteOrderResponse */ pegOffsetValue?: number | bigint; /** * Current price the order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof DeleteOrderResponse */ peggedPrice?: string; /** * Cause of the order\'s expiration. Returned when an order has expired. * @type {string} * @memberof DeleteOrderResponse */ expiryReason?: string; } //#endregion //#region src/rest-api/types/depth-response.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 DepthResponse */ interface DepthResponse$1 { /** * * @type {number | bigint} * @memberof DepthResponse */ lastUpdateId?: number | bigint; /** * Bid orders. Each entry is [price, quantity]. * @type {Array>} * @memberof DepthResponse */ bids?: Array>; /** * Ask orders. Each entry is [price, quantity]. * @type {Array>} * @memberof DepthResponse */ asks?: Array>; } //#endregion //#region src/rest-api/types/exchange-max-num-algo-orders-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExchangeMaxNumAlgoOrdersFilter */ interface ExchangeMaxNumAlgoOrdersFilter$1 { /** * * @type {string} * @memberof ExchangeMaxNumAlgoOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof ExchangeMaxNumAlgoOrdersFilter */ maxNumAlgoOrders?: number | bigint; } //#endregion //#region src/rest-api/types/exchange-max-num-iceberg-orders-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExchangeMaxNumIcebergOrdersFilter */ interface ExchangeMaxNumIcebergOrdersFilter$1 { /** * * @type {string} * @memberof ExchangeMaxNumIcebergOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof ExchangeMaxNumIcebergOrdersFilter */ maxNumIcebergOrders?: number | bigint; } //#endregion //#region src/rest-api/types/exchange-max-num-order-lists-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExchangeMaxNumOrderListsFilter */ interface ExchangeMaxNumOrderListsFilter$1 { /** * * @type {string} * @memberof ExchangeMaxNumOrderListsFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof ExchangeMaxNumOrderListsFilter */ maxNumOrderLists?: number | bigint; } //#endregion //#region src/rest-api/types/exchange-max-num-orders-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExchangeMaxNumOrdersFilter */ interface ExchangeMaxNumOrdersFilter$1 { /** * * @type {string} * @memberof ExchangeMaxNumOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof ExchangeMaxNumOrdersFilter */ maxNumOrders?: number | bigint; } //#endregion //#region src/rest-api/types/exchange-filters.d.ts /** * @type ExchangeFilters */ type ExchangeFilters$1 = ({ filterType: 'EXCHANGE_MAX_NUM_ALGO_ORDERS'; } & ExchangeMaxNumAlgoOrdersFilter$1) | ({ filterType: 'EXCHANGE_MAX_NUM_ICEBERG_ORDERS'; } & ExchangeMaxNumIcebergOrdersFilter$1) | ({ filterType: 'EXCHANGE_MAX_NUM_ORDERS'; } & ExchangeMaxNumOrdersFilter$1) | ({ filterType: 'EXCHANGE_MAX_NUM_ORDER_LISTS'; } & ExchangeMaxNumOrderListsFilter$1); //#endregion //#region src/rest-api/types/exchange-info-response-sors-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExchangeInfoResponseSorsInner */ interface ExchangeInfoResponseSorsInner$1 { /** * * @type {string} * @memberof ExchangeInfoResponseSorsInner */ baseAsset?: string; /** * * @type {Array} * @memberof ExchangeInfoResponseSorsInner */ symbols?: Array; } //#endregion //#region src/rest-api/types/iceberg-parts-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 IcebergPartsFilter */ interface IcebergPartsFilter$1 { /** * * @type {string} * @memberof IcebergPartsFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof IcebergPartsFilter */ limit?: number | bigint; } //#endregion //#region src/rest-api/types/lot-size-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 LotSizeFilter */ interface LotSizeFilter$1 { /** * * @type {string} * @memberof LotSizeFilter */ filterType?: string; /** * * @type {number} * @memberof LotSizeFilter */ qtyExponent?: number; /** * * @type {string} * @memberof LotSizeFilter */ minQty?: string; /** * * @type {string} * @memberof LotSizeFilter */ maxQty?: string; /** * * @type {string} * @memberof LotSizeFilter */ stepSize?: string; } //#endregion //#region src/rest-api/types/market-lot-size-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MarketLotSizeFilter */ interface MarketLotSizeFilter$1 { /** * * @type {string} * @memberof MarketLotSizeFilter */ filterType?: string; /** * * @type {number} * @memberof MarketLotSizeFilter */ qtyExponent?: number; /** * * @type {string} * @memberof MarketLotSizeFilter */ minQty?: string; /** * * @type {string} * @memberof MarketLotSizeFilter */ maxQty?: string; /** * * @type {string} * @memberof MarketLotSizeFilter */ stepSize?: string; } //#endregion //#region src/rest-api/types/max-num-algo-orders-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxNumAlgoOrdersFilter */ interface MaxNumAlgoOrdersFilter$1 { /** * * @type {string} * @memberof MaxNumAlgoOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof MaxNumAlgoOrdersFilter */ maxNumAlgoOrders?: number | bigint; } //#endregion //#region src/rest-api/types/max-num-iceberg-orders-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxNumIcebergOrdersFilter */ interface MaxNumIcebergOrdersFilter$1 { /** * * @type {string} * @memberof MaxNumIcebergOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof MaxNumIcebergOrdersFilter */ maxNumIcebergOrders?: number | bigint; } //#endregion //#region src/rest-api/types/max-num-order-amends-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxNumOrderAmendsFilter */ interface MaxNumOrderAmendsFilter$1 { /** * * @type {string} * @memberof MaxNumOrderAmendsFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof MaxNumOrderAmendsFilter */ maxNumOrderAmends?: number | bigint; } //#endregion //#region src/rest-api/types/max-num-order-lists-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxNumOrderListsFilter */ interface MaxNumOrderListsFilter$1 { /** * * @type {string} * @memberof MaxNumOrderListsFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof MaxNumOrderListsFilter */ maxNumOrderLists?: number | bigint; } //#endregion //#region src/rest-api/types/max-num-orders-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxNumOrdersFilter */ interface MaxNumOrdersFilter$1 { /** * * @type {string} * @memberof MaxNumOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof MaxNumOrdersFilter */ maxNumOrders?: number | bigint; } //#endregion //#region src/rest-api/types/max-position-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxPositionFilter */ interface MaxPositionFilter$1 { /** * * @type {string} * @memberof MaxPositionFilter */ filterType?: string; /** * * @type {number} * @memberof MaxPositionFilter */ qtyExponent?: number; /** * * @type {string} * @memberof MaxPositionFilter */ maxPosition?: string; } //#endregion //#region src/rest-api/types/min-notional-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MinNotionalFilter */ interface MinNotionalFilter$1 { /** * * @type {string} * @memberof MinNotionalFilter */ filterType?: string; /** * * @type {number} * @memberof MinNotionalFilter */ priceExponent?: number; /** * * @type {string} * @memberof MinNotionalFilter */ minNotional?: string; /** * * @type {boolean} * @memberof MinNotionalFilter */ applyToMarket?: boolean; /** * * @type {number} * @memberof MinNotionalFilter */ avgPriceMins?: number; } //#endregion //#region src/rest-api/types/notional-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 NotionalFilter */ interface NotionalFilter$1 { /** * * @type {string} * @memberof NotionalFilter */ filterType?: string; /** * * @type {number} * @memberof NotionalFilter */ priceExponent?: number; /** * * @type {string} * @memberof NotionalFilter */ minNotional?: string; /** * * @type {boolean} * @memberof NotionalFilter */ applyMinToMarket?: boolean; /** * * @type {string} * @memberof NotionalFilter */ maxNotional?: string; /** * * @type {boolean} * @memberof NotionalFilter */ applyMaxToMarket?: boolean; /** * * @type {number} * @memberof NotionalFilter */ avgPriceMins?: number; } //#endregion //#region src/rest-api/types/percent-price-by-side-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 PercentPriceBySideFilter */ interface PercentPriceBySideFilter$1 { /** * * @type {string} * @memberof PercentPriceBySideFilter */ filterType?: string; /** * * @type {number} * @memberof PercentPriceBySideFilter */ multiplierExponent?: number; /** * * @type {string} * @memberof PercentPriceBySideFilter */ bidMultiplierUp?: string; /** * * @type {string} * @memberof PercentPriceBySideFilter */ bidMultiplierDown?: string; /** * * @type {string} * @memberof PercentPriceBySideFilter */ askMultiplierUp?: string; /** * * @type {string} * @memberof PercentPriceBySideFilter */ askMultiplierDown?: string; /** * * @type {number} * @memberof PercentPriceBySideFilter */ avgPriceMins?: number; } //#endregion //#region src/rest-api/types/percent-price-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 PercentPriceFilter */ interface PercentPriceFilter$1 { /** * * @type {string} * @memberof PercentPriceFilter */ filterType?: string; /** * * @type {number} * @memberof PercentPriceFilter */ multiplierExponent?: number; /** * * @type {string} * @memberof PercentPriceFilter */ multiplierUp?: string; /** * * @type {string} * @memberof PercentPriceFilter */ multiplierDown?: string; /** * * @type {number} * @memberof PercentPriceFilter */ avgPriceMins?: number; } //#endregion //#region src/rest-api/types/price-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 PriceFilter */ interface PriceFilter$1 { /** * * @type {string} * @memberof PriceFilter */ filterType?: string; /** * * @type {number} * @memberof PriceFilter */ priceExponent?: number; /** * * @type {string} * @memberof PriceFilter */ minPrice?: string; /** * * @type {string} * @memberof PriceFilter */ maxPrice?: string; /** * * @type {string} * @memberof PriceFilter */ tickSize?: string; } //#endregion //#region src/rest-api/types/tplus-sell-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TPlusSellFilter */ interface TPlusSellFilter$1 { /** * * @type {string} * @memberof TPlusSellFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof TPlusSellFilter */ endTime?: number | bigint; } //#endregion //#region src/rest-api/types/trailing-delta-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TrailingDeltaFilter */ interface TrailingDeltaFilter$1 { /** * * @type {string} * @memberof TrailingDeltaFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof TrailingDeltaFilter */ minTrailingAboveDelta?: number | bigint; /** * * @type {number | bigint} * @memberof TrailingDeltaFilter */ maxTrailingAboveDelta?: number | bigint; /** * * @type {number | bigint} * @memberof TrailingDeltaFilter */ minTrailingBelowDelta?: number | bigint; /** * * @type {number | bigint} * @memberof TrailingDeltaFilter */ maxTrailingBelowDelta?: number | bigint; } //#endregion //#region src/rest-api/types/my-filters-response-symbol-filters-inner.d.ts /** * @type MyFiltersResponseSymbolFiltersInner */ type MyFiltersResponseSymbolFiltersInner = ({ filterType: 'ICEBERG_PARTS'; } & IcebergPartsFilter$1) | ({ filterType: 'LOT_SIZE'; } & LotSizeFilter$1) | ({ filterType: 'MARKET_LOT_SIZE'; } & MarketLotSizeFilter$1) | ({ filterType: 'MAX_NUM_ALGO_ORDERS'; } & MaxNumAlgoOrdersFilter$1) | ({ filterType: 'MAX_NUM_ICEBERG_ORDERS'; } & MaxNumIcebergOrdersFilter$1) | ({ filterType: 'MAX_NUM_ORDERS'; } & MaxNumOrdersFilter$1) | ({ filterType: 'MAX_NUM_ORDER_AMENDS'; } & MaxNumOrderAmendsFilter$1) | ({ filterType: 'MAX_NUM_ORDER_LISTS'; } & MaxNumOrderListsFilter$1) | ({ filterType: 'MAX_POSITION'; } & MaxPositionFilter$1) | ({ filterType: 'MIN_NOTIONAL'; } & MinNotionalFilter$1) | ({ filterType: 'NOTIONAL'; } & NotionalFilter$1) | ({ filterType: 'PERCENT_PRICE'; } & PercentPriceFilter$1) | ({ filterType: 'PERCENT_PRICE_BY_SIDE'; } & PercentPriceBySideFilter$1) | ({ filterType: 'PRICE_FILTER'; } & PriceFilter$1) | ({ filterType: 'TRAILING_DELTA'; } & TrailingDeltaFilter$1) | ({ filterType: 'T_PLUS_SELL'; } & TPlusSellFilter$1); //#endregion //#region src/rest-api/types/exchange-info-response-symbols-inner.d.ts /** * * @export * @interface ExchangeInfoResponseSymbolsInner */ interface ExchangeInfoResponseSymbolsInner$1 { /** * * @type {string} * @memberof ExchangeInfoResponseSymbolsInner */ symbol?: string; /** * * @type {string} * @memberof ExchangeInfoResponseSymbolsInner */ status?: string; /** * * @type {string} * @memberof ExchangeInfoResponseSymbolsInner */ baseAsset?: string; /** * * @type {number | bigint} * @memberof ExchangeInfoResponseSymbolsInner */ baseAssetPrecision?: number | bigint; /** * * @type {string} * @memberof ExchangeInfoResponseSymbolsInner */ quoteAsset?: string; /** * * @type {number | bigint} * @memberof ExchangeInfoResponseSymbolsInner */ quotePrecision?: number | bigint; /** * * @type {number | bigint} * @memberof ExchangeInfoResponseSymbolsInner */ quoteAssetPrecision?: number | bigint; /** * * @type {number | bigint} * @memberof ExchangeInfoResponseSymbolsInner */ baseCommissionPrecision?: number | bigint; /** * * @type {number | bigint} * @memberof ExchangeInfoResponseSymbolsInner */ quoteCommissionPrecision?: number | bigint; /** * * @type {Array} * @memberof ExchangeInfoResponseSymbolsInner */ orderTypes?: Array; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ icebergAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ ocoAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ otoAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ opoAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ quoteOrderQtyMarketAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ allowTrailingStop?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ cancelReplaceAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ amendAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ pegInstructionsAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ isSpotTradingAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ isMarginTradingAllowed?: boolean; /** * * @type {Array} * @memberof ExchangeInfoResponseSymbolsInner */ filters?: Array; /** * * @type {Array} * @memberof ExchangeInfoResponseSymbolsInner */ permissions?: Array; /** * * @type {Array>} * @memberof ExchangeInfoResponseSymbolsInner */ permissionSets?: Array>; /** * * @type {string} * @memberof ExchangeInfoResponseSymbolsInner */ defaultSelfTradePreventionMode?: string; /** * * @type {Array} * @memberof ExchangeInfoResponseSymbolsInner */ allowedSelfTradePreventionModes?: Array; } //#endregion //#region src/rest-api/types/my-filters-response-exchange-filters-inner.d.ts /** * @type MyFiltersResponseExchangeFiltersInner */ type MyFiltersResponseExchangeFiltersInner = ({ filterType: 'EXCHANGE_MAX_NUM_ALGO_ORDERS'; } & ExchangeMaxNumAlgoOrdersFilter$1) | ({ filterType: 'EXCHANGE_MAX_NUM_ICEBERG_ORDERS'; } & ExchangeMaxNumIcebergOrdersFilter$1) | ({ filterType: 'EXCHANGE_MAX_NUM_ORDERS'; } & ExchangeMaxNumOrdersFilter$1) | ({ filterType: 'EXCHANGE_MAX_NUM_ORDER_LISTS'; } & ExchangeMaxNumOrderListsFilter$1); //#endregion //#region src/rest-api/types/my-filters-response-rate-limits-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MyFiltersResponseRateLimitsInner */ interface MyFiltersResponseRateLimitsInner { /** * * @type {string} * @memberof MyFiltersResponseRateLimitsInner */ rateLimitType?: string; /** * * @type {string} * @memberof MyFiltersResponseRateLimitsInner */ interval?: string; /** * * @type {number | bigint} * @memberof MyFiltersResponseRateLimitsInner */ intervalNum?: number | bigint; /** * * @type {number | bigint} * @memberof MyFiltersResponseRateLimitsInner */ limit?: number | bigint; /** * * @type {number | bigint} * @memberof MyFiltersResponseRateLimitsInner */ count?: number | bigint; } //#endregion //#region src/rest-api/types/exchange-info-response.d.ts /** * * @export * @interface ExchangeInfoResponse */ interface ExchangeInfoResponse$1 { /** * * @type {string} * @memberof ExchangeInfoResponse */ timezone?: string; /** * * @type {number | bigint} * @memberof ExchangeInfoResponse */ serverTime?: number | bigint; /** * * @type {Array} * @memberof ExchangeInfoResponse */ rateLimits?: Array; /** * * @type {Array} * @memberof ExchangeInfoResponse */ exchangeFilters?: Array; /** * * @type {Array} * @memberof ExchangeInfoResponse */ symbols?: Array; /** * Optional. Present only when SOR is available. * @type {Array} * @memberof ExchangeInfoResponse */ sors?: Array; } //#endregion //#region src/rest-api/types/execution-rules-response-symbol-rules-inner-rules-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExecutionRulesResponseSymbolRulesInnerRulesInner */ interface ExecutionRulesResponseSymbolRulesInnerRulesInner { /** * * @type {string} * @memberof ExecutionRulesResponseSymbolRulesInnerRulesInner */ ruleType?: string; /** * * @type {string} * @memberof ExecutionRulesResponseSymbolRulesInnerRulesInner */ bidLimitMultUp?: string; /** * * @type {string} * @memberof ExecutionRulesResponseSymbolRulesInnerRulesInner */ bidLimitMultDown?: string; /** * * @type {string} * @memberof ExecutionRulesResponseSymbolRulesInnerRulesInner */ askLimitMultUp?: string; /** * * @type {string} * @memberof ExecutionRulesResponseSymbolRulesInnerRulesInner */ askLimitMultDown?: string; } //#endregion //#region src/rest-api/types/execution-rules-response-symbol-rules-inner.d.ts /** * * @export * @interface ExecutionRulesResponseSymbolRulesInner */ interface ExecutionRulesResponseSymbolRulesInner { /** * * @type {string} * @memberof ExecutionRulesResponseSymbolRulesInner */ symbol?: string; /** * * @type {Array} * @memberof ExecutionRulesResponseSymbolRulesInner */ rules?: Array; } //#endregion //#region src/rest-api/types/execution-rules-response.d.ts /** * * @export * @interface ExecutionRulesResponse */ interface ExecutionRulesResponse$1 { /** * * @type {Array} * @memberof ExecutionRulesResponse */ symbolRules?: Array; } //#endregion //#region src/rest-api/types/get-account-response-balances-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 GetAccountResponseBalancesInner */ interface GetAccountResponseBalancesInner { /** * * @type {string} * @memberof GetAccountResponseBalancesInner */ asset?: string; /** * * @type {string} * @memberof GetAccountResponseBalancesInner */ free?: string; /** * * @type {string} * @memberof GetAccountResponseBalancesInner */ locked?: string; } //#endregion //#region src/rest-api/types/get-account-response-commission-rates.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 GetAccountResponseCommissionRates */ interface GetAccountResponseCommissionRates { /** * * @type {string} * @memberof GetAccountResponseCommissionRates */ maker?: string; /** * * @type {string} * @memberof GetAccountResponseCommissionRates */ taker?: string; /** * * @type {string} * @memberof GetAccountResponseCommissionRates */ buyer?: string; /** * * @type {string} * @memberof GetAccountResponseCommissionRates */ seller?: string; } //#endregion //#region src/rest-api/types/get-account-response.d.ts /** * * @export * @interface GetAccountResponse */ interface GetAccountResponse { /** * * @type {number | bigint} * @memberof GetAccountResponse */ makerCommission?: number | bigint; /** * * @type {number | bigint} * @memberof GetAccountResponse */ takerCommission?: number | bigint; /** * * @type {number | bigint} * @memberof GetAccountResponse */ buyerCommission?: number | bigint; /** * * @type {number | bigint} * @memberof GetAccountResponse */ sellerCommission?: number | bigint; /** * * @type {GetAccountResponseCommissionRates} * @memberof GetAccountResponse */ commissionRates?: GetAccountResponseCommissionRates; /** * * @type {boolean} * @memberof GetAccountResponse */ canTrade?: boolean; /** * * @type {boolean} * @memberof GetAccountResponse */ canWithdraw?: boolean; /** * * @type {boolean} * @memberof GetAccountResponse */ canDeposit?: boolean; /** * * @type {boolean} * @memberof GetAccountResponse */ brokered?: boolean; /** * * @type {boolean} * @memberof GetAccountResponse */ requireSelfTradePrevention?: boolean; /** * * @type {boolean} * @memberof GetAccountResponse */ preventSor?: boolean; /** * * @type {number | bigint} * @memberof GetAccountResponse */ updateTime?: number | bigint; /** * * @type {string} * @memberof GetAccountResponse */ accountType?: string; /** * * @type {Array} * @memberof GetAccountResponse */ balances?: Array; /** * * @type {Array} * @memberof GetAccountResponse */ permissions?: Array; /** * * @type {number | bigint} * @memberof GetAccountResponse */ uid?: number | bigint; } //#endregion //#region src/rest-api/types/get-open-orders-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 GetOpenOrdersResponseInner */ interface GetOpenOrdersResponseInner { /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ symbol?: string; /** * * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ orderId?: number | bigint; /** * Unless it\'s part of an order list, value will be -1 * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ clientOrderId?: string; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ price?: string; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ origQty?: string; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ executedQty?: string; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ status?: string; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ timeInForce?: string; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ type?: string; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ side?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof GetOpenOrdersResponseInner */ stopPrice?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof GetOpenOrdersResponseInner */ icebergQty?: string; /** * * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ time?: number | bigint; /** * * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ updateTime?: number | bigint; /** * * @type {boolean} * @memberof GetOpenOrdersResponseInner */ isWorking?: boolean; /** * * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof GetOpenOrdersResponseInner */ selfTradePreventionMode?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof GetOpenOrdersResponseInner */ preventedQuantity?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof GetOpenOrdersResponseInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof GetOpenOrdersResponseInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof GetOpenOrdersResponseInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof GetOpenOrdersResponseInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof GetOpenOrdersResponseInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof GetOpenOrdersResponseInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof GetOpenOrdersResponseInner */ expiryReason?: string; } //#endregion //#region src/rest-api/types/get-open-orders-response.d.ts /** * * @export * @interface GetOpenOrdersResponse */ interface GetOpenOrdersResponse extends Array {} //#endregion //#region src/rest-api/types/get-order-list-response-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 GetOrderListResponseOrdersInner */ interface GetOrderListResponseOrdersInner { /** * * @type {string} * @memberof GetOrderListResponseOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof GetOrderListResponseOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof GetOrderListResponseOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/get-order-list-response.d.ts /** * * @export * @interface GetOrderListResponse */ interface GetOrderListResponse { /** * * @type {number | bigint} * @memberof GetOrderListResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof GetOrderListResponse */ contingencyType?: string; /** * * @type {string} * @memberof GetOrderListResponse */ listStatusType?: string; /** * * @type {string} * @memberof GetOrderListResponse */ listOrderStatus?: string; /** * * @type {string} * @memberof GetOrderListResponse */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof GetOrderListResponse */ transactionTime?: number | bigint; /** * * @type {string} * @memberof GetOrderListResponse */ symbol?: string; /** * * @type {Array} * @memberof GetOrderListResponse */ orders?: Array; } //#endregion //#region src/rest-api/types/get-order-response.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 GetOrderResponse */ interface GetOrderResponse { /** * symbol. * @type {string} * @memberof GetOrderResponse */ symbol?: string; /** * order Id. * @type {number | bigint} * @memberof GetOrderResponse */ orderId?: number | bigint; /** * This field will always have a value of -1 if not an order list. * @type {number | bigint} * @memberof GetOrderResponse */ orderListId?: number | bigint; /** * client Order Id. * @type {string} * @memberof GetOrderResponse */ clientOrderId?: string; /** * price. * @type {string} * @memberof GetOrderResponse */ price?: string; /** * orig Qty. * @type {string} * @memberof GetOrderResponse */ origQty?: string; /** * executed Qty. * @type {string} * @memberof GetOrderResponse */ executedQty?: string; /** * orig Quote Order Qty. * @type {string} * @memberof GetOrderResponse */ origQuoteOrderQty?: string; /** * cummulative Quote Qty. * @type {string} * @memberof GetOrderResponse */ cummulativeQuoteQty?: string; /** * status. * @type {string} * @memberof GetOrderResponse */ status?: string; /** * time In Force. * @type {string} * @memberof GetOrderResponse */ timeInForce?: string; /** * type. * @type {string} * @memberof GetOrderResponse */ type?: string; /** * side. * @type {string} * @memberof GetOrderResponse */ side?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof GetOrderResponse */ stopPrice?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof GetOrderResponse */ icebergQty?: string; /** * time. * @type {number | bigint} * @memberof GetOrderResponse */ time?: number | bigint; /** * update Time. * @type {number | bigint} * @memberof GetOrderResponse */ updateTime?: number | bigint; /** * is Working. * @type {boolean} * @memberof GetOrderResponse */ isWorking?: boolean; /** * working Time. * @type {number | bigint} * @memberof GetOrderResponse */ workingTime?: number | bigint; /** * self Trade Prevention Mode. * @type {string} * @memberof GetOrderResponse */ selfTradePreventionMode?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof GetOrderResponse */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof GetOrderResponse */ preventedQuantity?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof GetOrderResponse */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof GetOrderResponse */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof GetOrderResponse */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof GetOrderResponse */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof GetOrderResponse */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof GetOrderResponse */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof GetOrderResponse */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof GetOrderResponse */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof GetOrderResponse */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof GetOrderResponse */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof GetOrderResponse */ expiryReason?: string; } //#endregion //#region src/rest-api/types/get-trades-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 GetTradesResponseInner */ interface GetTradesResponseInner { /** * * @type {number | bigint} * @memberof GetTradesResponseInner */ id?: number | bigint; /** * * @type {string} * @memberof GetTradesResponseInner */ price?: string; /** * * @type {string} * @memberof GetTradesResponseInner */ qty?: string; /** * * @type {string} * @memberof GetTradesResponseInner */ quoteQty?: string; /** * * @type {number | bigint} * @memberof GetTradesResponseInner */ time?: number | bigint; /** * * @type {boolean} * @memberof GetTradesResponseInner */ isBuyerMaker?: boolean; /** * * @type {boolean} * @memberof GetTradesResponseInner */ isBestMatch?: boolean; } //#endregion //#region src/rest-api/types/get-trades-response.d.ts /** * * @export * @interface GetTradesResponse */ interface GetTradesResponse extends Array {} //#endregion //#region src/rest-api/types/historical-block-trades-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 HistoricalBlockTradesResponseInner */ interface HistoricalBlockTradesResponseInner { /** * * @type {number | bigint} * @memberof HistoricalBlockTradesResponseInner */ id?: number | bigint; /** * * @type {string} * @memberof HistoricalBlockTradesResponseInner */ price?: string; /** * * @type {string} * @memberof HistoricalBlockTradesResponseInner */ qty?: string; /** * * @type {string} * @memberof HistoricalBlockTradesResponseInner */ quoteQty?: string; /** * * @type {number | bigint} * @memberof HistoricalBlockTradesResponseInner */ time?: number | bigint; /** * * @type {boolean} * @memberof HistoricalBlockTradesResponseInner */ isBuyerMaker?: boolean; } //#endregion //#region src/rest-api/types/historical-block-trades-response.d.ts /** * * @export * @interface HistoricalBlockTradesResponse */ interface HistoricalBlockTradesResponse extends Array {} //#endregion //#region src/rest-api/types/historical-trades-response.d.ts /** * * @export * @interface HistoricalTradesResponse */ interface HistoricalTradesResponse extends Array {} //#endregion //#region src/rest-api/types/klines-item-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 KlinesItemInner */ type KlinesItemInner = number | string; //#endregion //#region src/rest-api/types/klines-item.d.ts /** * * @export * @interface KlinesItem */ interface KlinesItem extends Array {} //#endregion //#region src/rest-api/types/klines-response.d.ts /** * * @export * @interface KlinesResponse */ interface KlinesResponse$1 extends Array {} //#endregion //#region src/rest-api/types/max-asset-filter.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxAssetFilter */ interface MaxAssetFilter$1 { /** * * @type {string} * @memberof MaxAssetFilter */ filterType?: string; /** * * @type {number} * @memberof MaxAssetFilter */ qtyExponent?: number; /** * * @type {string} * @memberof MaxAssetFilter */ limit?: string; /** * * @type {string} * @memberof MaxAssetFilter */ asset?: string; } //#endregion //#region src/rest-api/types/my-allocations-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MyAllocationsResponseInner */ interface MyAllocationsResponseInner { /** * * @type {string} * @memberof MyAllocationsResponseInner */ symbol?: string; /** * * @type {number | bigint} * @memberof MyAllocationsResponseInner */ allocationId?: number | bigint; /** * * @type {string} * @memberof MyAllocationsResponseInner */ allocationType?: string; /** * * @type {number | bigint} * @memberof MyAllocationsResponseInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof MyAllocationsResponseInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof MyAllocationsResponseInner */ price?: string; /** * * @type {string} * @memberof MyAllocationsResponseInner */ qty?: string; /** * * @type {string} * @memberof MyAllocationsResponseInner */ quoteQty?: string; /** * * @type {string} * @memberof MyAllocationsResponseInner */ commission?: string; /** * * @type {string} * @memberof MyAllocationsResponseInner */ commissionAsset?: string; /** * * @type {number | bigint} * @memberof MyAllocationsResponseInner */ time?: number | bigint; /** * * @type {boolean} * @memberof MyAllocationsResponseInner */ isBuyer?: boolean; /** * * @type {boolean} * @memberof MyAllocationsResponseInner */ isMaker?: boolean; /** * * @type {boolean} * @memberof MyAllocationsResponseInner */ isAllocator?: boolean; } //#endregion //#region src/rest-api/types/my-allocations-response.d.ts /** * * @export * @interface MyAllocationsResponse */ interface MyAllocationsResponse$1 extends Array {} //#endregion //#region src/rest-api/types/my-filters-response-asset-filters-inner.d.ts /** * @type MyFiltersResponseAssetFiltersInner */ type MyFiltersResponseAssetFiltersInner = { filterType: 'MAX_ASSET'; } & MaxAssetFilter$1; //#endregion //#region src/rest-api/types/my-filters-response.d.ts /** * * @export * @interface MyFiltersResponse */ interface MyFiltersResponse$1 { /** * * @type {Array} * @memberof MyFiltersResponse */ exchangeFilters?: Array; /** * * @type {Array} * @memberof MyFiltersResponse */ symbolFilters?: Array; /** * * @type {Array} * @memberof MyFiltersResponse */ assetFilters?: Array; /** * * @type {Array} * @memberof MyFiltersResponse */ rateLimits?: Array; } //#endregion //#region src/rest-api/types/my-prevented-matches-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MyPreventedMatchesResponseInner */ interface MyPreventedMatchesResponseInner { /** * * @type {string} * @memberof MyPreventedMatchesResponseInner */ symbol?: string; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponseInner */ preventedMatchId?: number | bigint; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponseInner */ takerOrderId?: number | bigint; /** * * @type {string} * @memberof MyPreventedMatchesResponseInner */ makerSymbol?: string; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponseInner */ makerOrderId?: number | bigint; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponseInner */ tradeGroupId?: number | bigint; /** * * @type {string} * @memberof MyPreventedMatchesResponseInner */ selfTradePreventionMode?: string; /** * * @type {string} * @memberof MyPreventedMatchesResponseInner */ price?: string; /** * * @type {string} * @memberof MyPreventedMatchesResponseInner */ makerPreventedQuantity?: string; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponseInner */ transactTime?: number | bigint; } //#endregion //#region src/rest-api/types/my-prevented-matches-response.d.ts /** * * @export * @interface MyPreventedMatchesResponse */ interface MyPreventedMatchesResponse$1 extends Array {} //#endregion //#region src/rest-api/types/my-trades-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MyTradesResponseInner */ interface MyTradesResponseInner { /** * * @type {string} * @memberof MyTradesResponseInner */ symbol?: string; /** * * @type {number | bigint} * @memberof MyTradesResponseInner */ id?: number | bigint; /** * * @type {number | bigint} * @memberof MyTradesResponseInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof MyTradesResponseInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof MyTradesResponseInner */ price?: string; /** * * @type {string} * @memberof MyTradesResponseInner */ qty?: string; /** * * @type {string} * @memberof MyTradesResponseInner */ quoteQty?: string; /** * * @type {string} * @memberof MyTradesResponseInner */ commission?: string; /** * * @type {string} * @memberof MyTradesResponseInner */ commissionAsset?: string; /** * * @type {number | bigint} * @memberof MyTradesResponseInner */ time?: number | bigint; /** * * @type {boolean} * @memberof MyTradesResponseInner */ isBuyer?: boolean; /** * * @type {boolean} * @memberof MyTradesResponseInner */ isMaker?: boolean; /** * * @type {boolean} * @memberof MyTradesResponseInner */ isBestMatch?: boolean; } //#endregion //#region src/rest-api/types/my-trades-response.d.ts /** * * @export * @interface MyTradesResponse */ interface MyTradesResponse$1 extends Array {} //#endregion //#region src/rest-api/types/new-order-response-fills-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 NewOrderResponseFillsInner */ interface NewOrderResponseFillsInner { /** * * @type {string} * @memberof NewOrderResponseFillsInner */ price?: string; /** * * @type {string} * @memberof NewOrderResponseFillsInner */ qty?: string; /** * * @type {string} * @memberof NewOrderResponseFillsInner */ commission?: string; /** * * @type {string} * @memberof NewOrderResponseFillsInner */ commissionAsset?: string; /** * * @type {number | bigint} * @memberof NewOrderResponseFillsInner */ tradeId?: number | bigint; } //#endregion //#region src/rest-api/types/new-order-response.d.ts /** * * @export * @interface NewOrderResponse */ interface NewOrderResponse { /** * * @type {string} * @memberof NewOrderResponse */ symbol?: string; /** * * @type {number | bigint} * @memberof NewOrderResponse */ orderId?: number | bigint; /** * Unless it\'s part of an order list, value will be -1 * @type {number | bigint} * @memberof NewOrderResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof NewOrderResponse */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof NewOrderResponse */ transactTime?: number | bigint; /** * * @type {string} * @memberof NewOrderResponse */ price?: string; /** * * @type {string} * @memberof NewOrderResponse */ origQty?: string; /** * * @type {string} * @memberof NewOrderResponse */ executedQty?: string; /** * * @type {string} * @memberof NewOrderResponse */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof NewOrderResponse */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof NewOrderResponse */ status?: string; /** * * @type {string} * @memberof NewOrderResponse */ timeInForce?: string; /** * * @type {string} * @memberof NewOrderResponse */ type?: string; /** * * @type {string} * @memberof NewOrderResponse */ side?: string; /** * * @type {number | bigint} * @memberof NewOrderResponse */ workingTime?: number | bigint; /** * * @type {string} * @memberof NewOrderResponse */ selfTradePreventionMode?: string; /** * * @type {Array} * @memberof NewOrderResponse */ fills?: Array; } //#endregion //#region src/rest-api/types/open-order-list-response-inner-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OpenOrderListResponseInnerOrdersInner */ interface OpenOrderListResponseInnerOrdersInner { /** * * @type {string} * @memberof OpenOrderListResponseInnerOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OpenOrderListResponseInnerOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OpenOrderListResponseInnerOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/open-order-list-response-inner.d.ts /** * * @export * @interface OpenOrderListResponseInner */ interface OpenOrderListResponseInner { /** * * @type {number | bigint} * @memberof OpenOrderListResponseInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OpenOrderListResponseInner */ contingencyType?: string; /** * * @type {string} * @memberof OpenOrderListResponseInner */ listStatusType?: string; /** * * @type {string} * @memberof OpenOrderListResponseInner */ listOrderStatus?: string; /** * * @type {string} * @memberof OpenOrderListResponseInner */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OpenOrderListResponseInner */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OpenOrderListResponseInner */ symbol?: string; /** * * @type {Array} * @memberof OpenOrderListResponseInner */ orders?: Array; } //#endregion //#region src/rest-api/types/open-order-list-response.d.ts /** * * @export * @interface OpenOrderListResponse */ interface OpenOrderListResponse extends Array {} //#endregion //#region src/rest-api/types/order-amend-keep-priority-response-amended-order.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderAmendKeepPriorityResponseAmendedOrder */ interface OrderAmendKeepPriorityResponseAmendedOrder { /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ origClientOrderId?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ clientOrderId?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ price?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ qty?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ executedQty?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ preventedQty?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ quoteOrderQty?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ cumulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ status?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ timeInForce?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ type?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ side?: string; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderAmendKeepPriorityResponseAmendedOrder */ expiryReason?: string; } //#endregion //#region src/rest-api/types/order-amend-keep-priority-response-list-status-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderAmendKeepPriorityResponseListStatusOrdersInner */ interface OrderAmendKeepPriorityResponseListStatusOrdersInner { /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseListStatusOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseListStatusOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseListStatusOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/order-amend-keep-priority-response-list-status.d.ts /** * * @export * @interface OrderAmendKeepPriorityResponseListStatus */ interface OrderAmendKeepPriorityResponseListStatus { /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseListStatus */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseListStatus */ contingencyType?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseListStatus */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseListStatus */ listClientOrderId?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseListStatus */ symbol?: string; /** * * @type {Array} * @memberof OrderAmendKeepPriorityResponseListStatus */ orders?: Array; } //#endregion //#region src/rest-api/types/order-amend-keep-priority-response.d.ts /** * * @export * @interface OrderAmendKeepPriorityResponse */ interface OrderAmendKeepPriorityResponse$1 { /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponse */ transactTime?: number | bigint; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponse */ executionId?: number | bigint; /** * * @type {OrderAmendKeepPriorityResponseAmendedOrder} * @memberof OrderAmendKeepPriorityResponse */ amendedOrder?: OrderAmendKeepPriorityResponseAmendedOrder; /** * * @type {OrderAmendKeepPriorityResponseListStatus} * @memberof OrderAmendKeepPriorityResponse */ listStatus?: OrderAmendKeepPriorityResponseListStatus; } //#endregion //#region src/rest-api/types/order-amendments-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderAmendmentsResponseInner */ interface OrderAmendmentsResponseInner { /** * * @type {string} * @memberof OrderAmendmentsResponseInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderAmendmentsResponseInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderAmendmentsResponseInner */ executionId?: number | bigint; /** * * @type {string} * @memberof OrderAmendmentsResponseInner */ origClientOrderId?: string; /** * * @type {string} * @memberof OrderAmendmentsResponseInner */ newClientOrderId?: string; /** * * @type {string} * @memberof OrderAmendmentsResponseInner */ origQty?: string; /** * * @type {string} * @memberof OrderAmendmentsResponseInner */ newQty?: string; /** * * @type {number | bigint} * @memberof OrderAmendmentsResponseInner */ time?: number | bigint; } //#endregion //#region src/rest-api/types/order-amendments-response.d.ts /** * * @export * @interface OrderAmendmentsResponse */ interface OrderAmendmentsResponse$1 extends Array {} //#endregion //#region src/rest-api/types/order-cancel-replace-response-cancel-response.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderCancelReplaceResponseCancelResponse */ interface OrderCancelReplaceResponseCancelResponse { /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ symbol?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ origClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseCancelResponse */ orderId?: number | bigint; /** * Unless it\'s part of an order list, value will be -1 * @type {number | bigint} * @memberof OrderCancelReplaceResponseCancelResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseCancelResponse */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ price?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ origQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ executedQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ status?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ timeInForce?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ type?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ side?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderCancelReplaceResponseCancelResponse */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderCancelReplaceResponseCancelResponse */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderCancelReplaceResponseCancelResponse */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderCancelReplaceResponseCancelResponse */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderCancelReplaceResponseCancelResponse */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderCancelReplaceResponseCancelResponse */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderCancelReplaceResponseCancelResponse */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderCancelReplaceResponseCancelResponse */ expiryReason?: string; } //#endregion //#region src/rest-api/types/order-cancel-replace-response-new-order-response-fills-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderCancelReplaceResponseNewOrderResponseFillsInner */ interface OrderCancelReplaceResponseNewOrderResponseFillsInner { /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponseFillsInner */ price?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponseFillsInner */ qty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponseFillsInner */ commission?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponseFillsInner */ commissionAsset?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponseFillsInner */ tradeId?: number | bigint; } //#endregion //#region src/rest-api/types/order-cancel-replace-response-new-order-response.d.ts /** * * @export * @interface OrderCancelReplaceResponseNewOrderResponse */ interface OrderCancelReplaceResponseNewOrderResponse { /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponse */ orderId?: number | bigint; /** * Unless it\'s part of an order list, value will be -1 * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponse */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ price?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ origQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ executedQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ status?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ timeInForce?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ type?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ side?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponse */ workingTime?: number | bigint; /** * * @type {Array} * @memberof OrderCancelReplaceResponseNewOrderResponse */ fills?: Array; /** * * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponse */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponse */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponse */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponse */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponse */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderCancelReplaceResponseNewOrderResponse */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderCancelReplaceResponseNewOrderResponse */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderCancelReplaceResponseNewOrderResponse */ expiryReason?: string; } //#endregion //#region src/rest-api/types/order-cancel-replace-response.d.ts /** * * @export * @interface OrderCancelReplaceResponse */ interface OrderCancelReplaceResponse$1 { /** * * @type {string} * @memberof OrderCancelReplaceResponse */ cancelResult?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponse */ newOrderResult?: string; /** * * @type {OrderCancelReplaceResponseCancelResponse} * @memberof OrderCancelReplaceResponse */ cancelResponse?: OrderCancelReplaceResponseCancelResponse; /** * * @type {OrderCancelReplaceResponseNewOrderResponse} * @memberof OrderCancelReplaceResponse */ newOrderResponse?: OrderCancelReplaceResponseNewOrderResponse; } //#endregion //#region src/rest-api/types/order-list-oco-response-order-reports-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListOcoResponseOrderReportsInner */ interface OrderListOcoResponseOrderReportsInner { /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListOcoResponseOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListOcoResponseOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListOcoResponseOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListOcoResponseOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ selfTradePreventionMode?: string; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ stopPrice?: string; /** * * @type {string} * @memberof OrderListOcoResponseOrderReportsInner */ icebergQty?: string; } //#endregion //#region src/rest-api/types/order-list-oco-response-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListOcoResponseOrdersInner */ interface OrderListOcoResponseOrdersInner { /** * * @type {string} * @memberof OrderListOcoResponseOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListOcoResponseOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderListOcoResponseOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/order-list-oco-response.d.ts /** * * @export * @interface OrderListOcoResponse */ interface OrderListOcoResponse { /** * * @type {number | bigint} * @memberof OrderListOcoResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListOcoResponse */ contingencyType?: string; /** * * @type {string} * @memberof OrderListOcoResponse */ listStatusType?: string; /** * * @type {string} * @memberof OrderListOcoResponse */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListOcoResponse */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListOcoResponse */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListOcoResponse */ symbol?: string; /** * * @type {Array} * @memberof OrderListOcoResponse */ orders?: Array; /** * * @type {Array} * @memberof OrderListOcoResponse */ orderReports?: Array; } //#endregion //#region src/rest-api/types/order-list-opo-response-order-reports-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListOpoResponseOrderReportsInner */ interface OrderListOpoResponseOrderReportsInner { /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListOpoResponseOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListOpoResponseOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListOpoResponseOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListOpoResponseOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ selfTradePreventionMode?: string; /** * * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ origQty?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListOpoResponseOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListOpoResponseOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListOpoResponseOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListOpoResponseOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListOpoResponseOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListOpoResponseOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListOpoResponseOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListOpoResponseOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/rest-api/types/order-list-opo-response-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListOpoResponseOrdersInner */ interface OrderListOpoResponseOrdersInner { /** * * @type {string} * @memberof OrderListOpoResponseOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListOpoResponseOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderListOpoResponseOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/order-list-opo-response.d.ts /** * * @export * @interface OrderListOpoResponse */ interface OrderListOpoResponse { /** * * @type {number | bigint} * @memberof OrderListOpoResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListOpoResponse */ contingencyType?: string; /** * * @type {string} * @memberof OrderListOpoResponse */ listStatusType?: string; /** * * @type {string} * @memberof OrderListOpoResponse */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListOpoResponse */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListOpoResponse */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListOpoResponse */ symbol?: string; /** * * @type {Array} * @memberof OrderListOpoResponse */ orders?: Array; /** * * @type {Array} * @memberof OrderListOpoResponse */ orderReports?: Array; } //#endregion //#region src/rest-api/types/order-list-opoco-response-order-reports-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListOpocoResponseOrderReportsInner */ interface OrderListOpocoResponseOrderReportsInner { /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListOpocoResponseOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListOpocoResponseOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListOpocoResponseOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListOpocoResponseOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ selfTradePreventionMode?: string; /** * * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ origQty?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListOpocoResponseOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListOpocoResponseOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListOpocoResponseOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListOpocoResponseOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListOpocoResponseOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListOpocoResponseOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListOpocoResponseOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListOpocoResponseOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/rest-api/types/order-list-opoco-response-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListOpocoResponseOrdersInner */ interface OrderListOpocoResponseOrdersInner { /** * * @type {string} * @memberof OrderListOpocoResponseOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListOpocoResponseOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderListOpocoResponseOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/order-list-opoco-response.d.ts /** * * @export * @interface OrderListOpocoResponse */ interface OrderListOpocoResponse { /** * * @type {number | bigint} * @memberof OrderListOpocoResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListOpocoResponse */ contingencyType?: string; /** * * @type {string} * @memberof OrderListOpocoResponse */ listStatusType?: string; /** * * @type {string} * @memberof OrderListOpocoResponse */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListOpocoResponse */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListOpocoResponse */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListOpocoResponse */ symbol?: string; /** * * @type {Array} * @memberof OrderListOpocoResponse */ orders?: Array; /** * * @type {Array} * @memberof OrderListOpocoResponse */ orderReports?: Array; } //#endregion //#region src/rest-api/types/order-list-oto-response-order-reports-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListOtoResponseOrderReportsInner */ interface OrderListOtoResponseOrderReportsInner { /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListOtoResponseOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListOtoResponseOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListOtoResponseOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListOtoResponseOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListOtoResponseOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListOtoResponseOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListOtoResponseOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListOtoResponseOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListOtoResponseOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListOtoResponseOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListOtoResponseOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListOtoResponseOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/rest-api/types/order-list-oto-response-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListOtoResponseOrdersInner */ interface OrderListOtoResponseOrdersInner { /** * * @type {string} * @memberof OrderListOtoResponseOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListOtoResponseOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderListOtoResponseOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/order-list-oto-response.d.ts /** * * @export * @interface OrderListOtoResponse */ interface OrderListOtoResponse { /** * * @type {number | bigint} * @memberof OrderListOtoResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListOtoResponse */ contingencyType?: string; /** * * @type {string} * @memberof OrderListOtoResponse */ listStatusType?: string; /** * * @type {string} * @memberof OrderListOtoResponse */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListOtoResponse */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListOtoResponse */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListOtoResponse */ symbol?: string; /** * * @type {Array} * @memberof OrderListOtoResponse */ orders?: Array; /** * * @type {Array} * @memberof OrderListOtoResponse */ orderReports?: Array; } //#endregion //#region src/rest-api/types/order-list-otoco-response-order-reports-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListOtocoResponseOrderReportsInner */ interface OrderListOtocoResponseOrderReportsInner { /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListOtocoResponseOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListOtocoResponseOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListOtocoResponseOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListOtocoResponseOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListOtocoResponseOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListOtocoResponseOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListOtocoResponseOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListOtocoResponseOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListOtocoResponseOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListOtocoResponseOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListOtocoResponseOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListOtocoResponseOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/rest-api/types/order-list-otoco-response-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListOtocoResponseOrdersInner */ interface OrderListOtocoResponseOrdersInner { /** * * @type {string} * @memberof OrderListOtocoResponseOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListOtocoResponseOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderListOtocoResponseOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/order-list-otoco-response.d.ts /** * * @export * @interface OrderListOtocoResponse */ interface OrderListOtocoResponse { /** * * @type {number | bigint} * @memberof OrderListOtocoResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListOtocoResponse */ contingencyType?: string; /** * * @type {string} * @memberof OrderListOtocoResponse */ listStatusType?: string; /** * * @type {string} * @memberof OrderListOtocoResponse */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListOtocoResponse */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListOtocoResponse */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListOtocoResponse */ symbol?: string; /** * * @type {Array} * @memberof OrderListOtocoResponse */ orders?: Array; /** * * @type {Array} * @memberof OrderListOtocoResponse */ orderReports?: Array; } //#endregion //#region src/rest-api/types/order-oco-response-order-reports-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderOcoResponseOrderReportsInner */ interface OrderOcoResponseOrderReportsInner { /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderOcoResponseOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderOcoResponseOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderOcoResponseOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderOcoResponseOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ selfTradePreventionMode?: string; /** * * @type {string} * @memberof OrderOcoResponseOrderReportsInner */ stopPrice?: string; } //#endregion //#region src/rest-api/types/order-oco-response-orders-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderOcoResponseOrdersInner */ interface OrderOcoResponseOrdersInner { /** * * @type {string} * @memberof OrderOcoResponseOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderOcoResponseOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderOcoResponseOrdersInner */ clientOrderId?: string; } //#endregion //#region src/rest-api/types/order-oco-response.d.ts /** * * @export * @interface OrderOcoResponse */ interface OrderOcoResponse { /** * * @type {number | bigint} * @memberof OrderOcoResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderOcoResponse */ contingencyType?: string; /** * * @type {string} * @memberof OrderOcoResponse */ listStatusType?: string; /** * * @type {string} * @memberof OrderOcoResponse */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderOcoResponse */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderOcoResponse */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderOcoResponse */ symbol?: string; /** * * @type {Array} * @memberof OrderOcoResponse */ orders?: Array; /** * * @type {Array} * @memberof OrderOcoResponse */ orderReports?: Array; } //#endregion //#region src/rest-api/types/order-test-response-discount.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Discount on standard commissions when paying in BNB. * @export * @interface OrderTestResponseDiscount */ interface OrderTestResponseDiscount { /** * * @type {boolean} * @memberof OrderTestResponseDiscount */ enabledForAccount?: boolean; /** * * @type {boolean} * @memberof OrderTestResponseDiscount */ enabledForSymbol?: boolean; /** * * @type {string} * @memberof OrderTestResponseDiscount */ discountAsset?: string; /** * * @type {string} * @memberof OrderTestResponseDiscount */ discount?: string; } //#endregion //#region src/rest-api/types/order-test-response-special-commission-for-order.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Special commission rates on trades from the order. * @export * @interface OrderTestResponseSpecialCommissionForOrder */ interface OrderTestResponseSpecialCommissionForOrder { /** * * @type {string} * @memberof OrderTestResponseSpecialCommissionForOrder */ maker?: string; /** * * @type {string} * @memberof OrderTestResponseSpecialCommissionForOrder */ taker?: string; } //#endregion //#region src/rest-api/types/order-test-response-standard-commission-for-order.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Standard commission rates on trades from the order. * @export * @interface OrderTestResponseStandardCommissionForOrder */ interface OrderTestResponseStandardCommissionForOrder { /** * * @type {string} * @memberof OrderTestResponseStandardCommissionForOrder */ maker?: string; /** * * @type {string} * @memberof OrderTestResponseStandardCommissionForOrder */ taker?: string; } //#endregion //#region src/rest-api/types/order-test-response-tax-commission-for-order.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Tax commission rates for trades from the order. * @export * @interface OrderTestResponseTaxCommissionForOrder */ interface OrderTestResponseTaxCommissionForOrder { /** * * @type {string} * @memberof OrderTestResponseTaxCommissionForOrder */ maker?: string; /** * * @type {string} * @memberof OrderTestResponseTaxCommissionForOrder */ taker?: string; } //#endregion //#region src/rest-api/types/order-test-response.d.ts /** * * @export * @interface OrderTestResponse */ interface OrderTestResponse$1 { /** * * @type {OrderTestResponseStandardCommissionForOrder} * @memberof OrderTestResponse */ standardCommissionForOrder?: OrderTestResponseStandardCommissionForOrder; /** * * @type {OrderTestResponseSpecialCommissionForOrder} * @memberof OrderTestResponse */ specialCommissionForOrder?: OrderTestResponseSpecialCommissionForOrder; /** * * @type {OrderTestResponseTaxCommissionForOrder} * @memberof OrderTestResponse */ taxCommissionForOrder?: OrderTestResponseTaxCommissionForOrder; /** * * @type {OrderTestResponseDiscount} * @memberof OrderTestResponse */ discount?: OrderTestResponseDiscount; } //#endregion //#region src/rest-api/types/rate-limit-order-response-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 RateLimitOrderResponseInner */ interface RateLimitOrderResponseInner { /** * * @type {string} * @memberof RateLimitOrderResponseInner */ rateLimitType?: string; /** * * @type {string} * @memberof RateLimitOrderResponseInner */ interval?: string; /** * * @type {number | bigint} * @memberof RateLimitOrderResponseInner */ intervalNum?: number | bigint; /** * * @type {number | bigint} * @memberof RateLimitOrderResponseInner */ limit?: number | bigint; /** * * @type {number | bigint} * @memberof RateLimitOrderResponseInner */ count?: number | bigint; } //#endregion //#region src/rest-api/types/rate-limit-order-response.d.ts /** * * @export * @interface RateLimitOrderResponse */ interface RateLimitOrderResponse extends Array {} //#endregion //#region src/rest-api/types/rate-limits.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 RateLimits */ interface RateLimits$1 { /** * * @type {string} * @memberof RateLimits */ rateLimitType?: string; /** * * @type {string} * @memberof RateLimits */ interval?: string; /** * * @type {number | bigint} * @memberof RateLimits */ intervalNum?: number | bigint; /** * * @type {number | bigint} * @memberof RateLimits */ limit?: number | bigint; /** * * @type {number | bigint} * @memberof RateLimits */ count?: number | bigint; } //#endregion //#region src/rest-api/types/reference-price-calculation-response.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ReferencePriceCalculationResponse */ interface ReferencePriceCalculationResponse$1 { /** * * @type {string} * @memberof ReferencePriceCalculationResponse */ symbol?: string; /** * Either `ARITHMETIC_MEAN` or `EXTERNAL`. * @type {string} * @memberof ReferencePriceCalculationResponse */ calculationType?: string; /** * Present when calculationType is ARITHMETIC_MEAN. * @type {number | bigint} * @memberof ReferencePriceCalculationResponse */ bucketCount?: number | bigint; /** * Present when calculationType is ARITHMETIC_MEAN. * @type {number | bigint} * @memberof ReferencePriceCalculationResponse */ bucketWidthMs?: number | bigint; /** * Present when calculationType is EXTERNAL. * @type {number | bigint} * @memberof ReferencePriceCalculationResponse */ externalCalculationId?: number | bigint; } //#endregion //#region src/rest-api/types/reference-price-response.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ReferencePriceResponse */ interface ReferencePriceResponse$2 { /** * * @type {string} * @memberof ReferencePriceResponse */ symbol?: string; /** * Reference price. Can be `null` if no reference price is set. * @type {string} * @memberof ReferencePriceResponse */ referencePrice?: string; /** * Timestamp when reference price was valid. * @type {number | bigint} * @memberof ReferencePriceResponse */ timestamp?: number | bigint; } //#endregion //#region src/rest-api/types/sor-order-response-fills-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 SorOrderResponseFillsInner */ interface SorOrderResponseFillsInner { /** * * @type {string} * @memberof SorOrderResponseFillsInner */ matchType?: string; /** * * @type {string} * @memberof SorOrderResponseFillsInner */ price?: string; /** * * @type {string} * @memberof SorOrderResponseFillsInner */ qty?: string; /** * * @type {string} * @memberof SorOrderResponseFillsInner */ commission?: string; /** * * @type {string} * @memberof SorOrderResponseFillsInner */ commissionAsset?: string; /** * * @type {number | bigint} * @memberof SorOrderResponseFillsInner */ tradeId?: number | bigint; /** * * @type {number | bigint} * @memberof SorOrderResponseFillsInner */ allocId?: number | bigint; } //#endregion //#region src/rest-api/types/sor-order-response.d.ts /** * * @export * @interface SorOrderResponse */ interface SorOrderResponse { /** * * @type {string} * @memberof SorOrderResponse */ symbol?: string; /** * * @type {number | bigint} * @memberof SorOrderResponse */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof SorOrderResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof SorOrderResponse */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof SorOrderResponse */ transactTime?: number | bigint; /** * * @type {string} * @memberof SorOrderResponse */ price?: string; /** * * @type {string} * @memberof SorOrderResponse */ origQty?: string; /** * * @type {string} * @memberof SorOrderResponse */ executedQty?: string; /** * * @type {string} * @memberof SorOrderResponse */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof SorOrderResponse */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof SorOrderResponse */ status?: string; /** * * @type {string} * @memberof SorOrderResponse */ timeInForce?: string; /** * * @type {string} * @memberof SorOrderResponse */ type?: string; /** * * @type {string} * @memberof SorOrderResponse */ side?: string; /** * * @type {number | bigint} * @memberof SorOrderResponse */ workingTime?: number | bigint; /** * * @type {Array} * @memberof SorOrderResponse */ fills?: Array; /** * * @type {string} * @memberof SorOrderResponse */ workingFloor?: string; /** * * @type {string} * @memberof SorOrderResponse */ selfTradePreventionMode?: string; /** * * @type {boolean} * @memberof SorOrderResponse */ usedSor?: boolean; } //#endregion //#region src/rest-api/types/sor-order-test-response.d.ts /** * * @export * @interface SorOrderTestResponse */ interface SorOrderTestResponse$1 { /** * * @type {OrderTestResponseStandardCommissionForOrder} * @memberof SorOrderTestResponse */ standardCommissionForOrder?: OrderTestResponseStandardCommissionForOrder; /** * * @type {OrderTestResponseTaxCommissionForOrder} * @memberof SorOrderTestResponse */ taxCommissionForOrder?: OrderTestResponseTaxCommissionForOrder; /** * * @type {OrderTestResponseDiscount} * @memberof SorOrderTestResponse */ discount?: OrderTestResponseDiscount; } //#endregion //#region src/rest-api/types/symbol-filters.d.ts /** * @type SymbolFilters */ type SymbolFilters$1 = ({ filterType: 'ICEBERG_PARTS'; } & IcebergPartsFilter$1) | ({ filterType: 'LOT_SIZE'; } & LotSizeFilter$1) | ({ filterType: 'MARKET_LOT_SIZE'; } & MarketLotSizeFilter$1) | ({ filterType: 'MAX_NUM_ALGO_ORDERS'; } & MaxNumAlgoOrdersFilter$1) | ({ filterType: 'MAX_NUM_ICEBERG_ORDERS'; } & MaxNumIcebergOrdersFilter$1) | ({ filterType: 'MAX_NUM_ORDERS'; } & MaxNumOrdersFilter$1) | ({ filterType: 'MAX_NUM_ORDER_AMENDS'; } & MaxNumOrderAmendsFilter$1) | ({ filterType: 'MAX_NUM_ORDER_LISTS'; } & MaxNumOrderListsFilter$1) | ({ filterType: 'MAX_POSITION'; } & MaxPositionFilter$1) | ({ filterType: 'MIN_NOTIONAL'; } & MinNotionalFilter$1) | ({ filterType: 'NOTIONAL'; } & NotionalFilter$1) | ({ filterType: 'PERCENT_PRICE'; } & PercentPriceFilter$1) | ({ filterType: 'PERCENT_PRICE_BY_SIDE'; } & PercentPriceBySideFilter$1) | ({ filterType: 'PRICE_FILTER'; } & PriceFilter$1) | ({ filterType: 'TRAILING_DELTA'; } & TrailingDeltaFilter$1) | ({ filterType: 'T_PLUS_SELL'; } & TPlusSellFilter$1); //#endregion //#region src/rest-api/types/ticker24hr-response1.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 Ticker24hrResponse1 */ interface Ticker24hrResponse1$1 { /** * Symbol Name * @type {string} * @memberof Ticker24hrResponse1 */ symbol?: string; /** * * @type {string} * @memberof Ticker24hrResponse1 */ priceChange?: string; /** * * @type {string} * @memberof Ticker24hrResponse1 */ priceChangePercent?: string; /** * * @type {string} * @memberof Ticker24hrResponse1 */ weightedAvgPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse1 */ prevClosePrice?: string; /** * Closing price of the interval * @type {string} * @memberof Ticker24hrResponse1 */ lastPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse1 */ lastQty?: string; /** * * @type {string} * @memberof Ticker24hrResponse1 */ bidPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse1 */ bidQty?: string; /** * * @type {string} * @memberof Ticker24hrResponse1 */ askPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse1 */ askQty?: string; /** * Opening price of the Interval * @type {string} * @memberof Ticker24hrResponse1 */ openPrice?: string; /** * Highest price in the interval * @type {string} * @memberof Ticker24hrResponse1 */ highPrice?: string; /** * Lowest price in the interval * @type {string} * @memberof Ticker24hrResponse1 */ lowPrice?: string; /** * Total trade volume (in base asset) * @type {string} * @memberof Ticker24hrResponse1 */ volume?: string; /** * Total trade volume (in quote asset) * @type {string} * @memberof Ticker24hrResponse1 */ quoteVolume?: string; /** * Start of the ticker interval * @type {number | bigint} * @memberof Ticker24hrResponse1 */ openTime?: number | bigint; /** * End of the ticker interval * @type {number | bigint} * @memberof Ticker24hrResponse1 */ closeTime?: number | bigint; /** * First tradeId * @type {number | bigint} * @memberof Ticker24hrResponse1 */ firstId?: number | bigint; /** * Last tradeId * @type {number | bigint} * @memberof Ticker24hrResponse1 */ lastId?: number | bigint; /** * Trade count * @type {number | bigint} * @memberof Ticker24hrResponse1 */ count?: number | bigint; } //#endregion //#region src/rest-api/types/ticker24hr-response2-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 Ticker24hrResponse2Inner */ interface Ticker24hrResponse2Inner { /** * Symbol Name * @type {string} * @memberof Ticker24hrResponse2Inner */ symbol?: string; /** * * @type {string} * @memberof Ticker24hrResponse2Inner */ priceChange?: string; /** * * @type {string} * @memberof Ticker24hrResponse2Inner */ priceChangePercent?: string; /** * * @type {string} * @memberof Ticker24hrResponse2Inner */ weightedAvgPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse2Inner */ prevClosePrice?: string; /** * Closing price of the interval * @type {string} * @memberof Ticker24hrResponse2Inner */ lastPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse2Inner */ lastQty?: string; /** * * @type {string} * @memberof Ticker24hrResponse2Inner */ bidPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse2Inner */ bidQty?: string; /** * * @type {string} * @memberof Ticker24hrResponse2Inner */ askPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse2Inner */ askQty?: string; /** * Opening price of the Interval * @type {string} * @memberof Ticker24hrResponse2Inner */ openPrice?: string; /** * Highest price in the interval * @type {string} * @memberof Ticker24hrResponse2Inner */ highPrice?: string; /** * Lowest price in the interval * @type {string} * @memberof Ticker24hrResponse2Inner */ lowPrice?: string; /** * Total trade volume (in base asset) * @type {string} * @memberof Ticker24hrResponse2Inner */ volume?: string; /** * Total trade volume (in quote asset) * @type {string} * @memberof Ticker24hrResponse2Inner */ quoteVolume?: string; /** * Start of the ticker interval * @type {number | bigint} * @memberof Ticker24hrResponse2Inner */ openTime?: number | bigint; /** * End of the ticker interval * @type {number | bigint} * @memberof Ticker24hrResponse2Inner */ closeTime?: number | bigint; /** * First tradeId * @type {number | bigint} * @memberof Ticker24hrResponse2Inner */ firstId?: number | bigint; /** * Last tradeId * @type {number | bigint} * @memberof Ticker24hrResponse2Inner */ lastId?: number | bigint; /** * Trade count * @type {number | bigint} * @memberof Ticker24hrResponse2Inner */ count?: number | bigint; } //#endregion //#region src/rest-api/types/ticker24hr-response2.d.ts /** * * @export * @interface Ticker24hrResponse2 */ interface Ticker24hrResponse2$1 extends Array {} //#endregion //#region src/rest-api/types/ticker24hr-response.d.ts /** * @type Ticker24hrResponse */ type Ticker24hrResponse$1 = Ticker24hrResponse1$1 | Ticker24hrResponse2$1; //#endregion //#region src/rest-api/types/ticker-book-ticker-response1.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerBookTickerResponse1 */ interface TickerBookTickerResponse1 { /** * * @type {string} * @memberof TickerBookTickerResponse1 */ symbol?: string; /** * best bid price. * @type {string} * @memberof TickerBookTickerResponse1 */ bidPrice?: string; /** * bid/ask qty. * @type {string} * @memberof TickerBookTickerResponse1 */ bidQty?: string; /** * best ask price. * @type {string} * @memberof TickerBookTickerResponse1 */ askPrice?: string; /** * bid/ask qty. * @type {string} * @memberof TickerBookTickerResponse1 */ askQty?: string; } //#endregion //#region src/rest-api/types/ticker-book-ticker-response2-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerBookTickerResponse2Inner */ interface TickerBookTickerResponse2Inner { /** * * @type {string} * @memberof TickerBookTickerResponse2Inner */ symbol?: string; /** * best bid price. * @type {string} * @memberof TickerBookTickerResponse2Inner */ bidPrice?: string; /** * bid/ask qty. * @type {string} * @memberof TickerBookTickerResponse2Inner */ bidQty?: string; /** * best ask price. * @type {string} * @memberof TickerBookTickerResponse2Inner */ askPrice?: string; /** * bid/ask qty. * @type {string} * @memberof TickerBookTickerResponse2Inner */ askQty?: string; } //#endregion //#region src/rest-api/types/ticker-book-ticker-response2.d.ts /** * * @export * @interface TickerBookTickerResponse2 */ interface TickerBookTickerResponse2 extends Array {} //#endregion //#region src/rest-api/types/ticker-book-ticker-response.d.ts /** * @type TickerBookTickerResponse */ type TickerBookTickerResponse = TickerBookTickerResponse1 | TickerBookTickerResponse2; //#endregion //#region src/rest-api/types/ticker-price-response1.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerPriceResponse1 */ interface TickerPriceResponse1$1 { /** * * @type {string} * @memberof TickerPriceResponse1 */ symbol?: string; /** * * @type {string} * @memberof TickerPriceResponse1 */ price?: string; } //#endregion //#region src/rest-api/types/ticker-price-response2-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerPriceResponse2Inner */ interface TickerPriceResponse2Inner { /** * * @type {string} * @memberof TickerPriceResponse2Inner */ symbol?: string; /** * * @type {string} * @memberof TickerPriceResponse2Inner */ price?: string; } //#endregion //#region src/rest-api/types/ticker-price-response2.d.ts /** * * @export * @interface TickerPriceResponse2 */ interface TickerPriceResponse2$1 extends Array {} //#endregion //#region src/rest-api/types/ticker-price-response.d.ts /** * @type TickerPriceResponse */ type TickerPriceResponse$1 = TickerPriceResponse1$1 | TickerPriceResponse2$1; //#endregion //#region src/rest-api/types/ticker-response1.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerResponse1 */ interface TickerResponse1$1 { /** * * @type {string} * @memberof TickerResponse1 */ symbol?: string; /** * Absolute price change * @type {string} * @memberof TickerResponse1 */ priceChange?: string; /** * Relative price change in percent * @type {string} * @memberof TickerResponse1 */ priceChangePercent?: string; /** * QuoteVolume / Volume * @type {string} * @memberof TickerResponse1 */ weightedAvgPrice?: string; /** * * @type {string} * @memberof TickerResponse1 */ openPrice?: string; /** * * @type {string} * @memberof TickerResponse1 */ highPrice?: string; /** * * @type {string} * @memberof TickerResponse1 */ lowPrice?: string; /** * * @type {string} * @memberof TickerResponse1 */ lastPrice?: string; /** * * @type {string} * @memberof TickerResponse1 */ volume?: string; /** * Sum of (price * volume) for all trades * @type {string} * @memberof TickerResponse1 */ quoteVolume?: string; /** * Open time for ticker window * @type {number | bigint} * @memberof TickerResponse1 */ openTime?: number | bigint; /** * Close time for ticker window * @type {number | bigint} * @memberof TickerResponse1 */ closeTime?: number | bigint; /** * Trade IDs * @type {number | bigint} * @memberof TickerResponse1 */ firstId?: number | bigint; /** * * @type {number | bigint} * @memberof TickerResponse1 */ lastId?: number | bigint; /** * Number of trades in the interval * @type {number | bigint} * @memberof TickerResponse1 */ count?: number | bigint; } //#endregion //#region src/rest-api/types/ticker-response2-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerResponse2Inner */ interface TickerResponse2Inner { /** * * @type {string} * @memberof TickerResponse2Inner */ symbol?: string; /** * Absolute price change * @type {string} * @memberof TickerResponse2Inner */ priceChange?: string; /** * Relative price change in percent * @type {string} * @memberof TickerResponse2Inner */ priceChangePercent?: string; /** * QuoteVolume / Volume * @type {string} * @memberof TickerResponse2Inner */ weightedAvgPrice?: string; /** * * @type {string} * @memberof TickerResponse2Inner */ openPrice?: string; /** * * @type {string} * @memberof TickerResponse2Inner */ highPrice?: string; /** * * @type {string} * @memberof TickerResponse2Inner */ lowPrice?: string; /** * * @type {string} * @memberof TickerResponse2Inner */ lastPrice?: string; /** * * @type {string} * @memberof TickerResponse2Inner */ volume?: string; /** * Sum of (price * volume) for all trades * @type {string} * @memberof TickerResponse2Inner */ quoteVolume?: string; /** * Open time for ticker window * @type {number | bigint} * @memberof TickerResponse2Inner */ openTime?: number | bigint; /** * Close time for ticker window * @type {number | bigint} * @memberof TickerResponse2Inner */ closeTime?: number | bigint; /** * Trade IDs * @type {number | bigint} * @memberof TickerResponse2Inner */ firstId?: number | bigint; /** * * @type {number | bigint} * @memberof TickerResponse2Inner */ lastId?: number | bigint; /** * Number of trades in the interval * @type {number | bigint} * @memberof TickerResponse2Inner */ count?: number | bigint; } //#endregion //#region src/rest-api/types/ticker-response2.d.ts /** * * @export * @interface TickerResponse2 */ interface TickerResponse2$1 extends Array {} //#endregion //#region src/rest-api/types/ticker-response.d.ts /** * @type TickerResponse */ type TickerResponse$2 = TickerResponse1$1 | TickerResponse2$1; //#endregion //#region src/rest-api/types/ticker-trading-day-response1.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerTradingDayResponse1 */ interface TickerTradingDayResponse1 { /** * * @type {string} * @memberof TickerTradingDayResponse1 */ symbol?: string; /** * Absolute price change * @type {string} * @memberof TickerTradingDayResponse1 */ priceChange?: string; /** * Relative price change in percent * @type {string} * @memberof TickerTradingDayResponse1 */ priceChangePercent?: string; /** * quoteVolume / volume * @type {string} * @memberof TickerTradingDayResponse1 */ weightedAvgPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponse1 */ openPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponse1 */ highPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponse1 */ lowPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponse1 */ lastPrice?: string; /** * Volume in base asset * @type {string} * @memberof TickerTradingDayResponse1 */ volume?: string; /** * Volume in quote asset * @type {string} * @memberof TickerTradingDayResponse1 */ quoteVolume?: string; /** * * @type {number | bigint} * @memberof TickerTradingDayResponse1 */ openTime?: number | bigint; /** * * @type {number | bigint} * @memberof TickerTradingDayResponse1 */ closeTime?: number | bigint; /** * Trade ID of the first trade in the interval * @type {number | bigint} * @memberof TickerTradingDayResponse1 */ firstId?: number | bigint; /** * Trade ID of the last trade in the interval * @type {number | bigint} * @memberof TickerTradingDayResponse1 */ lastId?: number | bigint; /** * Number of trades in the interval * @type {number | bigint} * @memberof TickerTradingDayResponse1 */ count?: number | bigint; } //#endregion //#region src/rest-api/types/ticker-trading-day-response2-inner.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerTradingDayResponse2Inner */ interface TickerTradingDayResponse2Inner { /** * * @type {string} * @memberof TickerTradingDayResponse2Inner */ symbol?: string; /** * Absolute price change * @type {string} * @memberof TickerTradingDayResponse2Inner */ priceChange?: string; /** * Relative price change in percent * @type {string} * @memberof TickerTradingDayResponse2Inner */ priceChangePercent?: string; /** * quoteVolume / volume * @type {string} * @memberof TickerTradingDayResponse2Inner */ weightedAvgPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponse2Inner */ openPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponse2Inner */ highPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponse2Inner */ lowPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponse2Inner */ lastPrice?: string; /** * Volume in base asset * @type {string} * @memberof TickerTradingDayResponse2Inner */ volume?: string; /** * Volume in quote asset * @type {string} * @memberof TickerTradingDayResponse2Inner */ quoteVolume?: string; /** * * @type {number | bigint} * @memberof TickerTradingDayResponse2Inner */ openTime?: number | bigint; /** * * @type {number | bigint} * @memberof TickerTradingDayResponse2Inner */ closeTime?: number | bigint; /** * Trade ID of the first trade in the interval * @type {number | bigint} * @memberof TickerTradingDayResponse2Inner */ firstId?: number | bigint; /** * Trade ID of the last trade in the interval * @type {number | bigint} * @memberof TickerTradingDayResponse2Inner */ lastId?: number | bigint; /** * Number of trades in the interval * @type {number | bigint} * @memberof TickerTradingDayResponse2Inner */ count?: number | bigint; } //#endregion //#region src/rest-api/types/ticker-trading-day-response2.d.ts /** * * @export * @interface TickerTradingDayResponse2 */ interface TickerTradingDayResponse2 extends Array {} //#endregion //#region src/rest-api/types/ticker-trading-day-response.d.ts /** * @type TickerTradingDayResponse */ type TickerTradingDayResponse$1 = TickerTradingDayResponse1 | TickerTradingDayResponse2; //#endregion //#region src/rest-api/types/time-response.d.ts /** * Spot REST API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TimeResponse */ interface TimeResponse$1 { /** * * @type {number | bigint} * @memberof TimeResponse */ serverTime?: number | bigint; } //#endregion //#region src/rest-api/types/ui-klines-item.d.ts /** * * @export * @interface UiKlinesItem */ interface UiKlinesItem extends Array {} //#endregion //#region src/rest-api/types/ui-klines-response.d.ts /** * * @export * @interface UiKlinesResponse */ interface UiKlinesResponse$1 extends Array {} //#endregion //#region src/rest-api/modules/account-api.d.ts /** * AccountApi - interface * @interface AccountApi */ interface AccountApiInterface$1 { /** * Get current account commission rates. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Commission Rates (USER_DATA) * @param {AccountCommissionRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ accountCommission(requestParameters: AccountCommissionRequest$1): Promise>; /** * Retrieves all order lists based on provided optional parameters. * * Note that the time between `startTime` and `endTime` can't be longer * than 24 hours. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query all Order lists (USER_DATA) * @param {AllOrderListRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ allOrderList(requestParameters?: AllOrderListRequest): Promise>; /** * Get all account orders; active, canceled, or filled. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * - If `orderId` is set, it will get orders >= that `orderId`. Otherwise most recent orders are returned. * - For some historical orders `cummulativeQuoteQty` will be < 0, meaning the data is not available at this time. * - If `startTime` and/or `endTime` provided, `orderId` is not required. * - The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary All orders (USER_DATA) * @param {AllOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ allOrders(requestParameters: AllOrdersRequest$1): Promise>; /** * Get current account information. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * @summary Account information (USER_DATA) * @param {GetAccountRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getAccount(requestParameters?: GetAccountRequest): Promise>; /** * Get all open orders on a symbol. **Careful** when accessing this with no symbol. * * Weight: 6 for a single symbol; 80 when the symbol parameter is omitted * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * - If the symbol is not sent, orders for all symbols will be returned in an array. * * @summary Current open orders (USER_DATA) * @param {GetOpenOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getOpenOrders(requestParameters?: GetOpenOrdersRequest): Promise>; /** * Check an order's status. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * - Either `orderId` or `origClientOrderId` must be sent. * - If both `orderId` and `origClientOrderId` are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * - For some historical orders `cummulativeQuoteQty` will be < 0, meaning the data is not available at this time. * * @summary Query order (USER_DATA) * @param {GetOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getOrder(requestParameters: GetOrderRequest): Promise>; /** * Retrieves a specific order list based on provided optional parameters. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Order list (USER_DATA) * @param {GetOrderListRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ getOrderList(requestParameters?: GetOrderListRequest): Promise>; /** * Retrieves allocations resulting from SOR order placement. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database" * * Supported parameter combinations: * * Parameters | Response | * ------------------------------------------- | -------- | * `symbol` | allocations from oldest to newest | * `symbol` + `startTime` | oldest allocations since `startTime` | * `symbol` + `endTime` | newest allocations until `endTime` | * `symbol` + `startTime` + `endTime` | allocations within the time range | * `symbol` + `fromAllocationId` | allocations by allocation ID | * `symbol` + `orderId` | allocations related to an order starting with oldest | * `symbol` + `orderId` + `fromAllocationId` | allocations related to an order by allocation ID | * **Note:** The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Query Allocations (USER_DATA) * @param {MyAllocationsRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ myAllocations(requestParameters: MyAllocationsRequest$1): Promise>; /** * Retrieves the list of filters relevant to an account on a given symbol. This is the only endpoint that shows if an account has `MAX_ASSET` filters applied to it. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Query relevant filters (USER_DATA) * @param {MyFiltersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ myFilters(requestParameters: MyFiltersRequest$1): Promise>; /** * Displays the list of orders that were expired due to STP. * * These are the combinations supported: * - `symbol` + `preventedMatchId` * - `symbol` + `orderId` * - `symbol` + `orderId` + `fromPreventedMatchId` (`limit` will default to 500) * - `symbol` + `orderId` + `fromPreventedMatchId` + `limit` * * Weight: Case | Weight * ---- | ----- * If `symbol` is invalid | 2 * Querying by `preventedMatchId` | 2 * Querying by `orderId` | 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Prevented Matches (USER_DATA) * @param {MyPreventedMatchesRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ myPreventedMatches(requestParameters: MyPreventedMatchesRequest$1): Promise>; /** * Get trades for a specific account and symbol. * * Weight: Condition| Weight| * ---| --- * |Without orderId|20| * |With orderId|5| * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * **Notes:**: * - If `fromId` is set, it will get trades >= that `fromId`. Otherwise most recent trades are returned. * - The time between `startTime` and `endTime` can't be longer than 24 hours. * - These are the supported combinations of all parameters: * - `symbol` * - `symbol` + `orderId` * - `symbol` + `startTime` * - `symbol` + `endTime` * - `symbol` + `fromId` * - `symbol` + `startTime` + `endTime` * - `symbol`+ `orderId` + `fromId` * * @summary Account trade list (USER_DATA) * @param {MyTradesRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ myTrades(requestParameters: MyTradesRequest$1): Promise>; /** * Query Open Order lists * * Weight(IP): 6 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory -> Database * * @summary Query Open Order lists (USER_DATA) * @param {OpenOrderListRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ openOrderList(requestParameters?: OpenOrderListRequest): Promise>; /** * Queries all amendments of a single order. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Order Amendments (USER_DATA) * @param {OrderAmendmentsRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ orderAmendments(requestParameters: OrderAmendmentsRequest$1): Promise>; /** * Displays the user's unfilled order count for all intervals. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Query Unfilled Order Count (USER_DATA) * @param {RateLimitOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof AccountApiInterface */ rateLimitOrder(requestParameters?: RateLimitOrderRequest): Promise>; } /** * Request parameters for accountCommission operation in AccountApi. * @interface AccountCommissionRequest */ interface AccountCommissionRequest$1 { /** * * @type {string} * @memberof AccountApiAccountCommission */ readonly symbol: string; } /** * Request parameters for allOrderList operation in AccountApi. * @interface AllOrderListRequest */ interface AllOrderListRequest { /** * If supplied, neither startTime or endTime can be provided * @type {number | bigint} * @memberof AccountApiAllOrderList */ readonly fromId?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiAllOrderList */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiAllOrderList */ readonly endTime?: number | bigint; /** * * @type {number} * @memberof AccountApiAllOrderList */ readonly limit?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiAllOrderList */ readonly recvWindow?: number; } /** * Request parameters for allOrders operation in AccountApi. * @interface AllOrdersRequest */ interface AllOrdersRequest$1 { /** * * @type {string} * @memberof AccountApiAllOrders */ readonly symbol: string; /** * * @type {number | bigint} * @memberof AccountApiAllOrders */ readonly orderId?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiAllOrders */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiAllOrders */ readonly endTime?: number | bigint; /** * * @type {number} * @memberof AccountApiAllOrders */ readonly limit?: number; /** * The value cannot be greater than `60000`.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiAllOrders */ readonly recvWindow?: number; } /** * Request parameters for getAccount operation in AccountApi. * @interface GetAccountRequest */ interface GetAccountRequest { /** * When set to `true`, emits only the non-zero balances of an account. * @type {boolean} * @memberof AccountApiGetAccount */ readonly omitZeroBalances?: boolean; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiGetAccount */ readonly recvWindow?: number; } /** * Request parameters for getOpenOrders operation in AccountApi. * @interface GetOpenOrdersRequest */ interface GetOpenOrdersRequest { /** * * @type {string} * @memberof AccountApiGetOpenOrders */ readonly symbol?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiGetOpenOrders */ readonly recvWindow?: number; } /** * Request parameters for getOrder operation in AccountApi. * @interface GetOrderRequest */ interface GetOrderRequest { /** * * @type {string} * @memberof AccountApiGetOrder */ readonly symbol: string; /** * * @type {number | bigint} * @memberof AccountApiGetOrder */ readonly orderId?: number | bigint; /** * * @type {string} * @memberof AccountApiGetOrder */ readonly origClientOrderId?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiGetOrder */ readonly recvWindow?: number; } /** * Request parameters for getOrderList operation in AccountApi. * @interface GetOrderListRequest */ interface GetOrderListRequest { /** * Query order list by `orderListId`. `orderListId` or `origClientOrderId` must be provided. * @type {number | bigint} * @memberof AccountApiGetOrderList */ readonly orderListId?: number | bigint; /** * Query order list by `listClientOrderId`. `orderListId` or `origClientOrderId` must be provided. * @type {string} * @memberof AccountApiGetOrderList */ readonly origClientOrderId?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiGetOrderList */ readonly recvWindow?: number; } /** * Request parameters for myAllocations operation in AccountApi. * @interface MyAllocationsRequest */ interface MyAllocationsRequest$1 { /** * * @type {string} * @memberof AccountApiMyAllocations */ readonly symbol: string; /** * * @type {number | bigint} * @memberof AccountApiMyAllocations */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiMyAllocations */ readonly endTime?: number | bigint; /** * * @type {number} * @memberof AccountApiMyAllocations */ readonly fromAllocationId?: number; /** * * @type {number} * @memberof AccountApiMyAllocations */ readonly limit?: number; /** * * @type {number | bigint} * @memberof AccountApiMyAllocations */ readonly orderId?: number | bigint; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiMyAllocations */ readonly recvWindow?: number; } /** * Request parameters for myFilters operation in AccountApi. * @interface MyFiltersRequest */ interface MyFiltersRequest$1 { /** * * @type {string} * @memberof AccountApiMyFilters */ readonly symbol: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiMyFilters */ readonly recvWindow?: number; } /** * Request parameters for myPreventedMatches operation in AccountApi. * @interface MyPreventedMatchesRequest */ interface MyPreventedMatchesRequest$1 { /** * * @type {string} * @memberof AccountApiMyPreventedMatches */ readonly symbol: string; /** * * @type {number | bigint} * @memberof AccountApiMyPreventedMatches */ readonly preventedMatchId?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiMyPreventedMatches */ readonly orderId?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiMyPreventedMatches */ readonly fromPreventedMatchId?: number | bigint; /** * * @type {number} * @memberof AccountApiMyPreventedMatches */ readonly limit?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiMyPreventedMatches */ readonly recvWindow?: number; } /** * Request parameters for myTrades operation in AccountApi. * @interface MyTradesRequest */ interface MyTradesRequest$1 { /** * * @type {string} * @memberof AccountApiMyTrades */ readonly symbol: string; /** * This can only be used in combination with `symbol`. * @type {number | bigint} * @memberof AccountApiMyTrades */ readonly orderId?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiMyTrades */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiMyTrades */ readonly endTime?: number | bigint; /** * TradeId to fetch from. Default gets most recent trades. * @type {number | bigint} * @memberof AccountApiMyTrades */ readonly fromId?: number | bigint; /** * * @type {number} * @memberof AccountApiMyTrades */ readonly limit?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiMyTrades */ readonly recvWindow?: number; } /** * Request parameters for openOrderList operation in AccountApi. * @interface OpenOrderListRequest */ interface OpenOrderListRequest { /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiOpenOrderList */ readonly recvWindow?: number; } /** * Request parameters for orderAmendments operation in AccountApi. * @interface OrderAmendmentsRequest */ interface OrderAmendmentsRequest$1 { /** * * @type {string} * @memberof AccountApiOrderAmendments */ readonly symbol: string; /** * * @type {number | bigint} * @memberof AccountApiOrderAmendments */ readonly orderId: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiOrderAmendments */ readonly fromExecutionId?: number | bigint; /** * * @type {number | bigint} * @memberof AccountApiOrderAmendments */ readonly limit?: number | bigint; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiOrderAmendments */ readonly recvWindow?: number; } /** * Request parameters for rateLimitOrder operation in AccountApi. * @interface RateLimitOrderRequest */ interface RateLimitOrderRequest { /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiRateLimitOrder */ readonly recvWindow?: number; } /** * AccountApi - object-oriented interface * @class AccountApi */ declare class AccountApi$1 implements AccountApiInterface$1 { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Get current account commission rates. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Commission Rates (USER_DATA) * @param {AccountCommissionRequest} 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-spot-trading/api/rest-api/account#account-commission Binance API Documentation} */ accountCommission(requestParameters: AccountCommissionRequest$1): Promise>; /** * Retrieves all order lists based on provided optional parameters. * * Note that the time between `startTime` and `endTime` can't be longer * than 24 hours. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query all Order lists (USER_DATA) * @param {AllOrderListRequest} 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-spot-trading/api/rest-api/account#all-order-list Binance API Documentation} */ allOrderList(requestParameters?: AllOrderListRequest): Promise>; /** * Get all account orders; active, canceled, or filled. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * - If `orderId` is set, it will get orders >= that `orderId`. Otherwise most recent orders are returned. * - For some historical orders `cummulativeQuoteQty` will be < 0, meaning the data is not available at this time. * - If `startTime` and/or `endTime` provided, `orderId` is not required. * - The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary All orders (USER_DATA) * @param {AllOrdersRequest} 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-spot-trading/api/rest-api/account#all-orders Binance API Documentation} */ allOrders(requestParameters: AllOrdersRequest$1): Promise>; /** * Get current account information. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * @summary Account information (USER_DATA) * @param {GetAccountRequest} 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-spot-trading/api/rest-api/account#get-account Binance API Documentation} */ getAccount(requestParameters?: GetAccountRequest): Promise>; /** * Get all open orders on a symbol. **Careful** when accessing this with no symbol. * * Weight: 6 for a single symbol; 80 when the symbol parameter is omitted * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * - If the symbol is not sent, orders for all symbols will be returned in an array. * * @summary Current open orders (USER_DATA) * @param {GetOpenOrdersRequest} 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-spot-trading/api/rest-api/account#get-open-orders Binance API Documentation} */ getOpenOrders(requestParameters?: GetOpenOrdersRequest): Promise>; /** * Check an order's status. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * - Either `orderId` or `origClientOrderId` must be sent. * - If both `orderId` and `origClientOrderId` are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * - For some historical orders `cummulativeQuoteQty` will be < 0, meaning the data is not available at this time. * * @summary Query order (USER_DATA) * @param {GetOrderRequest} 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-spot-trading/api/rest-api/account#get-order Binance API Documentation} */ getOrder(requestParameters: GetOrderRequest): Promise>; /** * Retrieves a specific order list based on provided optional parameters. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Order list (USER_DATA) * @param {GetOrderListRequest} 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-spot-trading/api/rest-api/account#get-order-list Binance API Documentation} */ getOrderList(requestParameters?: GetOrderListRequest): Promise>; /** * Retrieves allocations resulting from SOR order placement. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database" * * Supported parameter combinations: * * Parameters | Response | * ------------------------------------------- | -------- | * `symbol` | allocations from oldest to newest | * `symbol` + `startTime` | oldest allocations since `startTime` | * `symbol` + `endTime` | newest allocations until `endTime` | * `symbol` + `startTime` + `endTime` | allocations within the time range | * `symbol` + `fromAllocationId` | allocations by allocation ID | * `symbol` + `orderId` | allocations related to an order starting with oldest | * `symbol` + `orderId` + `fromAllocationId` | allocations related to an order by allocation ID | * **Note:** The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Query Allocations (USER_DATA) * @param {MyAllocationsRequest} 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-spot-trading/api/rest-api/account#my-allocations Binance API Documentation} */ myAllocations(requestParameters: MyAllocationsRequest$1): Promise>; /** * Retrieves the list of filters relevant to an account on a given symbol. This is the only endpoint that shows if an account has `MAX_ASSET` filters applied to it. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Query relevant filters (USER_DATA) * @param {MyFiltersRequest} 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-spot-trading/api/rest-api/account#my-filters Binance API Documentation} */ myFilters(requestParameters: MyFiltersRequest$1): Promise>; /** * Displays the list of orders that were expired due to STP. * * These are the combinations supported: * - `symbol` + `preventedMatchId` * - `symbol` + `orderId` * - `symbol` + `orderId` + `fromPreventedMatchId` (`limit` will default to 500) * - `symbol` + `orderId` + `fromPreventedMatchId` + `limit` * * Weight: Case | Weight * ---- | ----- * If `symbol` is invalid | 2 * Querying by `preventedMatchId` | 2 * Querying by `orderId` | 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Prevented Matches (USER_DATA) * @param {MyPreventedMatchesRequest} 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-spot-trading/api/rest-api/account#my-prevented-matches Binance API Documentation} */ myPreventedMatches(requestParameters: MyPreventedMatchesRequest$1): Promise>; /** * Get trades for a specific account and symbol. * * Weight: Condition| Weight| * ---| --- * |Without orderId|20| * |With orderId|5| * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * **Notes:**: * - If `fromId` is set, it will get trades >= that `fromId`. Otherwise most recent trades are returned. * - The time between `startTime` and `endTime` can't be longer than 24 hours. * - These are the supported combinations of all parameters: * - `symbol` * - `symbol` + `orderId` * - `symbol` + `startTime` * - `symbol` + `endTime` * - `symbol` + `fromId` * - `symbol` + `startTime` + `endTime` * - `symbol`+ `orderId` + `fromId` * * @summary Account trade list (USER_DATA) * @param {MyTradesRequest} 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-spot-trading/api/rest-api/account#my-trades Binance API Documentation} */ myTrades(requestParameters: MyTradesRequest$1): Promise>; /** * Query Open Order lists * * Weight(IP): 6 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory -> Database * * @summary Query Open Order lists (USER_DATA) * @param {OpenOrderListRequest} 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-spot-trading/api/rest-api/account#open-order-list Binance API Documentation} */ openOrderList(requestParameters?: OpenOrderListRequest): Promise>; /** * Queries all amendments of a single order. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Order Amendments (USER_DATA) * @param {OrderAmendmentsRequest} 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-spot-trading/api/rest-api/account#order-amendments Binance API Documentation} */ orderAmendments(requestParameters: OrderAmendmentsRequest$1): Promise>; /** * Displays the user's unfilled order count for all intervals. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Query Unfilled Order Count (USER_DATA) * @param {RateLimitOrderRequest} 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-spot-trading/api/rest-api/account#rate-limit-order Binance API Documentation} */ rateLimitOrder(requestParameters?: RateLimitOrderRequest): Promise>; } //#endregion //#region src/rest-api/modules/general-api.d.ts /** * GeneralApi - interface * @interface GeneralApi */ interface GeneralApiInterface$1 { /** * Current exchange trading rules and symbol information * * Weight(IP): 20 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Notes:** * If the value provided to `symbol` or `symbols` do not exist, the endpoint will throw an error saying the symbol is invalid. * All parameters are optional. * `permissions` can support single or multiple values (e.g. `SPOT`, `["MARGIN","LEVERAGED"]`). This cannot be used in combination with `symbol` or `symbols`. * If `permissions` parameter not provided, all symbols that have either `SPOT`, `MARGIN`, or `LEVERAGED` permission will be exposed. * To display symbols with any permission you need to specify them explicitly in `permissions`: (e.g. `["SPOT","MARGIN",...]`.). See Account and Symbol Permissions for the full list. * **Examples of Symbol Permissions Interpretation from the Response:** * * `[["A","B"]]` means you may place an order if your account has either permission "A" **or** permission "B". * `[["A"],["B"]]` means you can place an order if your account has permission "A" **and** permission "B". * `[["A"],["B","C"]]` means you can place an order if your account has permission "A" **and** permission "B" or permission "C". (Inclusive or is applied here, not exclusive or, so your account may have both permission "B" and permission "C".) * * @summary Exchange information * @param {ExchangeInfoRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof GeneralApiInterface */ exchangeInfo(requestParameters?: ExchangeInfoRequest$1): Promise>; /** * Query execution rules for symbols. * * Weight: Parameter | Weight * --- | --- * `symbol` | 2 * `symbols` | 2 for each `symbol`, capped at a max of 40 * `symbolStatus` | 40 * None | 40 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Note:**: No combination of multiple parameters is allowed. * * @summary Query Execution Rules * @param {ExecutionRulesRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof GeneralApiInterface */ executionRules(requestParameters?: ExecutionRulesRequest$1): Promise>; /** * Test connectivity to the Rest API. * * Weight(IP): 1 * * Security Type: NONE * * @summary Test connectivity * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof GeneralApiInterface */ ping(): Promise>; /** * Test connectivity to the Rest API and get the current server time. * * Weight(IP): 1 * * Security Type: NONE * * @summary Check server time * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof GeneralApiInterface */ time(): Promise>; } /** * Request parameters for exchangeInfo operation in GeneralApi. * @interface ExchangeInfoRequest */ interface ExchangeInfoRequest$1 { /** * Example: curl -X GET "https://api.binance.com/api/v3/exchangeInfo?symbol=BNBBTC" * @type {string} * @memberof GeneralApiExchangeInfo */ readonly symbol?: string; /** * Examples: curl -X GET "https://api.binance.com/api/v3/exchangeInfo?symbols=%5B%22BNBBTC%22,%22BTCUSDT%22%5D" or curl -g -X GET 'https://api.binance.com/api/v3/exchangeInfo?symbols=["BTCUSDT","BNBBTC"]' * @type {Array} * @memberof GeneralApiExchangeInfo */ readonly symbols?: Array; /** * Examples: curl -X GET "https://api.binance.com/api/v3/exchangeInfo?permissions=SPOT" * * curl -X GET "https://api.binance.com/api/v3/exchangeInfo?permissions=%5B%22MARGIN%22%2C%22LEVERAGED%22%5D" * or * curl -g -X GET 'https://api.binance.com/api/v3/exchangeInfo?permissions=["MARGIN","LEVERAGED"]' * @type {Array<'SPOT' | 'MARGIN' | 'LEVERAGED' | 'TRD_GRP_002' | 'TRD_GRP_003' | 'TRD_GRP_004' | 'TRD_GRP_005' | 'TRD_GRP_006' | 'TRD_GRP_007' | 'TRD_GRP_008' | 'TRD_GRP_009' | 'TRD_GRP_010' | 'TRD_GRP_011' | 'TRD_GRP_012' | 'TRD_GRP_013' | 'TRD_GRP_014' | 'TRD_GRP_015' | 'TRD_GRP_016' | 'TRD_GRP_017' | 'TRD_GRP_018' | 'TRD_GRP_019' | 'TRD_GRP_020' | 'TRD_GRP_021' | 'TRD_GRP_022' | 'TRD_GRP_023' | 'TRD_GRP_024' | 'TRD_GRP_025'>} * @memberof GeneralApiExchangeInfo */ readonly permissions?: Array; /** * Controls whether the content of the `permissionSets` field is populated or not. * @type {boolean} * @memberof GeneralApiExchangeInfo */ readonly showPermissionSets?: boolean; /** * Filters for symbols that have this `tradingStatus`. Cannot be used in combination with `symbols` or `symbol`. * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof GeneralApiExchangeInfo */ readonly symbolStatus?: ExchangeInfoSymbolStatusEnum$1; } /** * Request parameters for executionRules operation in GeneralApi. * @interface ExecutionRulesRequest */ interface ExecutionRulesRequest$1 { /** * Query for specified symbol. * @type {string} * @memberof GeneralApiExecutionRules */ readonly symbol?: string; /** * Query for multiple symbols. * @type {Array} * @memberof GeneralApiExecutionRules */ readonly symbols?: Array; /** * Query for all symbols with the specified status. * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof GeneralApiExecutionRules */ readonly symbolStatus?: ExecutionRulesSymbolStatusEnum$1; } /** * GeneralApi - object-oriented interface * @class GeneralApi */ declare class GeneralApi$1 implements GeneralApiInterface$1 { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Current exchange trading rules and symbol information * * Weight(IP): 20 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Notes:** * If the value provided to `symbol` or `symbols` do not exist, the endpoint will throw an error saying the symbol is invalid. * All parameters are optional. * `permissions` can support single or multiple values (e.g. `SPOT`, `["MARGIN","LEVERAGED"]`). This cannot be used in combination with `symbol` or `symbols`. * If `permissions` parameter not provided, all symbols that have either `SPOT`, `MARGIN`, or `LEVERAGED` permission will be exposed. * To display symbols with any permission you need to specify them explicitly in `permissions`: (e.g. `["SPOT","MARGIN",...]`.). See Account and Symbol Permissions for the full list. * **Examples of Symbol Permissions Interpretation from the Response:** * * `[["A","B"]]` means you may place an order if your account has either permission "A" **or** permission "B". * `[["A"],["B"]]` means you can place an order if your account has permission "A" **and** permission "B". * `[["A"],["B","C"]]` means you can place an order if your account has permission "A" **and** permission "B" or permission "C". (Inclusive or is applied here, not exclusive or, so your account may have both permission "B" and permission "C".) * * @summary Exchange information * @param {ExchangeInfoRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof GeneralApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/general#exchange-info Binance API Documentation} */ exchangeInfo(requestParameters?: ExchangeInfoRequest$1): Promise>; /** * Query execution rules for symbols. * * Weight: Parameter | Weight * --- | --- * `symbol` | 2 * `symbols` | 2 for each `symbol`, capped at a max of 40 * `symbolStatus` | 40 * None | 40 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Note:**: No combination of multiple parameters is allowed. * * @summary Query Execution Rules * @param {ExecutionRulesRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof GeneralApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/general#execution-rules Binance API Documentation} */ executionRules(requestParameters?: ExecutionRulesRequest$1): Promise>; /** * Test connectivity to the Rest API. * * Weight(IP): 1 * * Security Type: NONE * * @summary Test connectivity * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof GeneralApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/general#ping Binance API Documentation} */ ping(): Promise>; /** * Test connectivity to the Rest API and get the current server time. * * Weight(IP): 1 * * Security Type: NONE * * @summary Check server time * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof GeneralApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/general#time Binance API Documentation} */ time(): Promise>; } declare enum ExchangeInfoPermissionsEnum { SPOT = "SPOT", MARGIN = "MARGIN", LEVERAGED = "LEVERAGED", TRD_GRP_002 = "TRD_GRP_002", TRD_GRP_003 = "TRD_GRP_003", TRD_GRP_004 = "TRD_GRP_004", TRD_GRP_005 = "TRD_GRP_005", TRD_GRP_006 = "TRD_GRP_006", TRD_GRP_007 = "TRD_GRP_007", TRD_GRP_008 = "TRD_GRP_008", TRD_GRP_009 = "TRD_GRP_009", TRD_GRP_010 = "TRD_GRP_010", TRD_GRP_011 = "TRD_GRP_011", TRD_GRP_012 = "TRD_GRP_012", TRD_GRP_013 = "TRD_GRP_013", TRD_GRP_014 = "TRD_GRP_014", TRD_GRP_015 = "TRD_GRP_015", TRD_GRP_016 = "TRD_GRP_016", TRD_GRP_017 = "TRD_GRP_017", TRD_GRP_018 = "TRD_GRP_018", TRD_GRP_019 = "TRD_GRP_019", TRD_GRP_020 = "TRD_GRP_020", TRD_GRP_021 = "TRD_GRP_021", TRD_GRP_022 = "TRD_GRP_022", TRD_GRP_023 = "TRD_GRP_023", TRD_GRP_024 = "TRD_GRP_024", TRD_GRP_025 = "TRD_GRP_025", } declare enum ExchangeInfoSymbolStatusEnum$1 { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum ExecutionRulesSymbolStatusEnum$1 { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } //#endregion //#region src/rest-api/modules/market-api.d.ts /** * MarketApi - interface * @interface MarketApi */ interface MarketApiInterface$1 { /** * Get compressed, aggregate trades. Trades that fill at the time, from the same taker order, with the same price will have the quantity aggregated. * * Weight(IP): 4 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If fromId, startTime, and endTime are not sent, the most recent aggregate trades will be returned. * * @summary Compressed/Aggregate trades list * @param {AggTradesRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ aggTrades(requestParameters: AggTradesRequest): Promise>; /** * Current average price for a symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Current average price * @param {AvgPriceRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ avgPrice(requestParameters: AvgPriceRequest$2): Promise>; /** * Order book * * Weight: Adjusted based on the limit: * * |Limit|Request Weight * ------|------- * 1-100| 5 * 101-500| 25 * 501-1000| 50 * 1001-5000| 250 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Order book * @param {DepthRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ depth(requestParameters: DepthRequest$1): Promise>; /** * Get recent trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Recent trades list * @param {GetTradesRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ getTrades(requestParameters: GetTradesRequest): Promise>; /** * Get block trades. * * Weight(IP): 25 * * Security Type: MARKET_DATA * * Notes: * - Data Source: Database * * @summary Historical Block Trades (MARKET_DATA) * @param {HistoricalBlockTradesRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ historicalBlockTrades(requestParameters: HistoricalBlockTradesRequest): Promise>; /** * Get older trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Database * * @summary Old trade lookup * @param {HistoricalTradesRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ historicalTrades(requestParameters: HistoricalTradesRequest): Promise>; /** * Kline/candlestick bars for a symbol. * Klines are uniquely identified by their open time. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * Supported kline intervals (case-sensitive): * * Interval | `interval` value * --------- | ---------------- * seconds | `1s` * minutes | `1m`, `3m`, `5m`, `15m`, `30m` * hours | `1h`, `2h`, `4h`, `6h`, `8h`, `12h` * days | `1d`, `3d` * weeks | `1w` * months | `1M` * **Notes:** * * If `startTime` and `endTime` are not sent, the most recent klines are returned. * Supported values for `timeZone`: * Hours and minutes (e.g. `-1:00`, `05:45`) * Only hours (e.g. `0`, `8`, `4`) * Accepted range is strictly [-12:00 to +14:00] inclusive * If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary Kline/Candlestick data * @param {KlinesRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ klines(requestParameters: KlinesRequest$1): Promise>; /** * Query the reference price for a symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price * @param {ReferencePriceRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ referencePrice(requestParameters: ReferencePriceRequest$2): Promise>; /** * Describes how reference price is calculated for a given symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price Calculation * @param {ReferencePriceCalculationRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ referencePriceCalculation(requestParameters: ReferencePriceCalculationRequest$1): Promise>; /** * **Note:** This endpoint differs from `GET /api/v3/ticker/24hr`. * * The statistical time range of this endpoint can be up to 59999ms longer * than the requested `windowSize`. * * `openTime` starts at the beginning of a minute, while the end time is * the current time. Therefore, the actual interval can be up to 59999ms * longer than the requested window. * * For example, if `closeTime` is 1641287867099 (January 04, 2022 * 09:17:47:099 UTC) and `windowSize` is `1d`, then `openTime` is * 1641201420000 (January 3, 2022, 09:17:00 UTC). * * Weight: 4 for each requested symbol regardless of windowSize. * * The weight for this request will cap at 200 once the number of `symbols` in the request is more than 50. * * Security Type: NONE * * Notes: **Data Source:** Database * * @summary Rolling window price change statistics * @param {TickerRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ ticker(requestParameters?: TickerRequest$2): Promise>; /** * 24 hour rolling window price change statistics. **Careful** when accessing this with no symbol. * * Weight: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
ParameterSymbols ProvidedWeight
symbol12
symbol parameter is omitted80
symbols1-202
21-10040
101 or more80
symbols parameter is omitted80
* * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary 24hr ticker price change statistics * @param {Ticker24hrRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ ticker24hr(requestParameters?: Ticker24hrRequest$1): Promise>; /** * Best price/qty on the order book for a symbol or symbols. * * Weight: |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Symbol order book ticker * @param {TickerBookTickerRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ tickerBookTicker(requestParameters?: TickerBookTickerRequest): Promise>; /** * Latest price for a symbol or symbols. * * Weight: |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Symbol price ticker * @param {TickerPriceRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ tickerPrice(requestParameters?: TickerPriceRequest$1): Promise>; /** * Price change statistics for a trading day. * * Weight: 4 for each requested symbol. The weight for this request will cap at 200 once the number of symbols in the request is more than 50. * * Security Type: NONE * * Notes: **Data Source:** Database * **Notes:**: * - Supported values for `timeZone`: * - Hours and minutes (e.g. `-1:00`, `05:45`) * - Only hours (e.g. `0`, `8`, `4`) * * @summary Trading Day Ticker * @param {TickerTradingDayRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ tickerTradingDay(requestParameters?: TickerTradingDayRequest$1): Promise>; /** * The request is similar to klines having the same parameters and * response. * * `uiKlines` return modified kline data, optimized for presentation of * candlestick charts. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If `startTime` and `endTime` are not sent, the most recent klines are returned. * - Supported values for `timeZone`: * - Hours and minutes (e.g. `-1:00`, `05:45`) * - Only hours (e.g. `0`, `8`, `4`) * - Accepted range is strictly [-12:00 to +14:00] inclusive * - If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * - Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary UIKlines * @param {UiKlinesRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApiInterface */ uiKlines(requestParameters: UiKlinesRequest$1): Promise>; } /** * Request parameters for aggTrades operation in MarketApi. * @interface AggTradesRequest */ interface AggTradesRequest { /** * * @type {string} * @memberof MarketApiAggTrades */ readonly symbol: string; /** * ID to get aggregate trades from INCLUSIVE. * @type {number | bigint} * @memberof MarketApiAggTrades */ readonly fromId?: number | bigint; /** * Timestamp in ms to get aggregate trades from INCLUSIVE. * @type {number | bigint} * @memberof MarketApiAggTrades */ readonly startTime?: number | bigint; /** * Timestamp in ms to get aggregate trades until INCLUSIVE. * @type {number | bigint} * @memberof MarketApiAggTrades */ readonly endTime?: number | bigint; /** * * @type {number} * @memberof MarketApiAggTrades */ readonly limit?: number; } /** * Request parameters for avgPrice operation in MarketApi. * @interface AvgPriceRequest */ interface AvgPriceRequest$2 { /** * * @type {string} * @memberof MarketApiAvgPrice */ readonly symbol: string; } /** * Request parameters for depth operation in MarketApi. * @interface DepthRequest */ interface DepthRequest$1 { /** * * @type {string} * @memberof MarketApiDepth */ readonly symbol: string; /** * If limit > 5000, only 5000 entries will be returned. * @type {number} * @memberof MarketApiDepth */ readonly limit?: number; /** * Filters for symbols that have this `tradingStatus`. * A status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiDepth */ readonly symbolStatus?: DepthSymbolStatusEnum$1; } /** * Request parameters for getTrades operation in MarketApi. * @interface GetTradesRequest */ interface GetTradesRequest { /** * * @type {string} * @memberof MarketApiGetTrades */ readonly symbol: string; /** * * @type {number} * @memberof MarketApiGetTrades */ readonly limit?: number; } /** * Request parameters for historicalBlockTrades operation in MarketApi. * @interface HistoricalBlockTradesRequest */ interface HistoricalBlockTradesRequest { /** * * @type {string} * @memberof MarketApiHistoricalBlockTrades */ readonly symbol: string; /** * Block trade ID to fetch from * @type {number | bigint} * @memberof MarketApiHistoricalBlockTrades */ readonly fromId: number | bigint; /** * Default: 500; Maximum: 1000 * @type {number | bigint} * @memberof MarketApiHistoricalBlockTrades */ readonly limit?: number | bigint; } /** * Request parameters for historicalTrades operation in MarketApi. * @interface HistoricalTradesRequest */ interface HistoricalTradesRequest { /** * * @type {string} * @memberof MarketApiHistoricalTrades */ readonly symbol: string; /** * * @type {number} * @memberof MarketApiHistoricalTrades */ readonly limit?: number; /** * TradeId to fetch from. Default gets most recent trades. * @type {number | bigint} * @memberof MarketApiHistoricalTrades */ readonly fromId?: number | bigint; } /** * Request parameters for klines operation in MarketApi. * @interface KlinesRequest */ interface KlinesRequest$1 { /** * * @type {string} * @memberof MarketApiKlines */ readonly symbol: string; /** * * @type {'1s' | '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof MarketApiKlines */ readonly interval: KlinesIntervalEnum$1; /** * * @type {number | bigint} * @memberof MarketApiKlines */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof MarketApiKlines */ readonly endTime?: number | bigint; /** * Default: 0 (UTC) * @type {string} * @memberof MarketApiKlines */ readonly timeZone?: string; /** * * @type {number} * @memberof MarketApiKlines */ readonly limit?: number; } /** * Request parameters for referencePrice operation in MarketApi. * @interface ReferencePriceRequest */ interface ReferencePriceRequest$2 { /** * * @type {string} * @memberof MarketApiReferencePrice */ readonly symbol: string; } /** * Request parameters for referencePriceCalculation operation in MarketApi. * @interface ReferencePriceCalculationRequest */ interface ReferencePriceCalculationRequest$1 { /** * * @type {string} * @memberof MarketApiReferencePriceCalculation */ readonly symbol: string; /** * Supported values: `TRADING`, `HALT`, `BREAK` * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiReferencePriceCalculation */ readonly symbolStatus?: ReferencePriceCalculationSymbolStatusEnum$1; } /** * Request parameters for ticker operation in MarketApi. * @interface TickerRequest */ interface TickerRequest$2 { /** * Either `symbol` or `symbols` must be provided * @type {string} * @memberof MarketApiTicker */ readonly symbol?: string; /** * Either `symbol` or `symbols` must be provided * * Examples of accepted format for the `symbols` parameter: ["BTCUSDT","BNBUSDT"] or %5B%22BTCUSDT%22,%22BNBUSDT%22%5D * * The maximum number of symbols allowed in a request is 100. * @type {Array} * @memberof MarketApiTicker */ readonly symbols?: Array; /** * Units cannot be combined (e.g. `1d2h` is not allowed). * @type {'1m' | '2m' | '3m' | '4m' | '5m' | '6m' | '7m' | '8m' | '9m' | '10m' | '11m' | '12m' | '13m' | '14m' | '15m' | '16m' | '17m' | '18m' | '19m' | '20m' | '21m' | '22m' | '23m' | '24m' | '25m' | '26m' | '27m' | '28m' | '29m' | '30m' | '31m' | '32m' | '33m' | '34m' | '35m' | '36m' | '37m' | '38m' | '39m' | '40m' | '41m' | '42m' | '43m' | '44m' | '45m' | '46m' | '47m' | '48m' | '49m' | '50m' | '51m' | '52m' | '53m' | '54m' | '55m' | '56m' | '57m' | '58m' | '59m' | '1h' | '2h' | '3h' | '4h' | '5h' | '6h' | '7h' | '8h' | '9h' | '10h' | '11h' | '12h' | '13h' | '14h' | '15h' | '16h' | '17h' | '18h' | '19h' | '20h' | '21h' | '22h' | '23h' | '1d' | '2d' | '3d' | '4d' | '5d' | '6d' | '7d'} * @memberof MarketApiTicker */ readonly windowSize?: TickerWindowSizeEnum$1; /** * * @type {'FULL' | 'MINI'} * @memberof MarketApiTicker */ readonly type?: TickerTypeEnum$1; /** * * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiTicker */ readonly symbolStatus?: TickerSymbolStatusEnum$1; } /** * Request parameters for ticker24hr operation in MarketApi. * @interface Ticker24hrRequest */ interface Ticker24hrRequest$1 { /** * Either `symbol` or `symbols` must be provided * @type {string} * @memberof MarketApiTicker24hr */ readonly symbol?: string; /** * Either `symbol` or `symbols` must be provided * * Examples of accepted format for the `symbols` parameter: ["BTCUSDT","BNBUSDT"] or %5B%22BTCUSDT%22,%22BNBUSDT%22%5D * * The maximum number of symbols allowed in a request is 100. * @type {Array} * @memberof MarketApiTicker24hr */ readonly symbols?: Array; /** * * @type {'FULL' | 'MINI'} * @memberof MarketApiTicker24hr */ readonly type?: Ticker24hrTypeEnum$1; /** * * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiTicker24hr */ readonly symbolStatus?: Ticker24hrSymbolStatusEnum$1; } /** * Request parameters for tickerBookTicker operation in MarketApi. * @interface TickerBookTickerRequest */ interface TickerBookTickerRequest { /** * Parameter symbol and symbols cannot be used in combination. * If neither parameter is sent, `bookTickers` for all symbols will be returned in an array. * @type {string} * @memberof MarketApiTickerBookTicker */ readonly symbol?: string; /** * Parameter symbol and symbols cannot be used in combination. * If neither parameter is sent, `bookTickers` for all symbols will be returned in an array. * Examples of accepted format for the symbols parameter: ["BTCUSDT","BNBUSDT"] or %5B%22BTCUSDT%22,%22BNBUSDT%22%5D * @type {Array} * @memberof MarketApiTickerBookTicker */ readonly symbols?: Array; /** * Filters for symbols that have this `tradingStatus`. * For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. * For multiple or all symbols, non-matching ones are simply excluded from the response. * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiTickerBookTicker */ readonly symbolStatus?: TickerBookTickerSymbolStatusEnum; } /** * Request parameters for tickerPrice operation in MarketApi. * @interface TickerPriceRequest */ interface TickerPriceRequest$1 { /** * Parameter symbol and symbols cannot be used in combination. * If neither parameter is sent, prices for all symbols will be returned in an array. * @type {string} * @memberof MarketApiTickerPrice */ readonly symbol?: string; /** * Parameter symbol and symbols cannot be used in combination. * If neither parameter is sent, prices for all symbols will be returned in an array. * Examples of accepted format for the symbols parameter: ["BTCUSDT","BNBUSDT"] or %5B%22BTCUSDT%22,%22BNBUSDT%22%5D * @type {Array} * @memberof MarketApiTickerPrice */ readonly symbols?: Array; /** * Filters for symbols that have this `tradingStatus`. * For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. * For multiple or all symbols, non-matching ones are simply excluded from the response. * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiTickerPrice */ readonly symbolStatus?: TickerPriceSymbolStatusEnum$1; } /** * Request parameters for tickerTradingDay operation in MarketApi. * @interface TickerTradingDayRequest */ interface TickerTradingDayRequest$1 { /** * Either `symbol` or `symbols` must be provided. * @type {string} * @memberof MarketApiTickerTradingDay */ readonly symbol?: string; /** * Either `symbol` or `symbols` must be provided. * Examples of accepted format for the `symbols` parameter: ["BTCUSDT","BNBUSDT"] or %5B%22BTCUSDT%22,%22BNBUSDT%22%5D. * The maximum number of `symbols` allowed in a request is 100. * @type {Array} * @memberof MarketApiTickerTradingDay */ readonly symbols?: Array; /** * Default: 0 (UTC) * @type {string} * @memberof MarketApiTickerTradingDay */ readonly timeZone?: string; /** * * @type {'FULL' | 'MINI'} * @memberof MarketApiTickerTradingDay */ readonly type?: TickerTradingDayTypeEnum$1; /** * Filters for symbols that have this `tradingStatus`. * For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. * For multiple symbols, non-matching ones are simply excluded from the response. * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiTickerTradingDay */ readonly symbolStatus?: TickerTradingDaySymbolStatusEnum$1; } /** * Request parameters for uiKlines operation in MarketApi. * @interface UiKlinesRequest */ interface UiKlinesRequest$1 { /** * * @type {string} * @memberof MarketApiUiKlines */ readonly symbol: string; /** * * @type {'1s' | '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof MarketApiUiKlines */ readonly interval: UiKlinesIntervalEnum$1; /** * * @type {number | bigint} * @memberof MarketApiUiKlines */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof MarketApiUiKlines */ readonly endTime?: number | bigint; /** * Default: 0 (UTC) * @type {string} * @memberof MarketApiUiKlines */ readonly timeZone?: string; /** * * @type {number} * @memberof MarketApiUiKlines */ readonly limit?: number; } /** * MarketApi - object-oriented interface * @class MarketApi */ declare class MarketApi$1 implements MarketApiInterface$1 { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Get compressed, aggregate trades. Trades that fill at the time, from the same taker order, with the same price will have the quantity aggregated. * * Weight(IP): 4 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If fromId, startTime, and endTime are not sent, the most recent aggregate trades will be returned. * * @summary Compressed/Aggregate trades list * @param {AggTradesRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#agg-trades Binance API Documentation} */ aggTrades(requestParameters: AggTradesRequest): Promise>; /** * Current average price for a symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Current average price * @param {AvgPriceRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#avg-price Binance API Documentation} */ avgPrice(requestParameters: AvgPriceRequest$2): Promise>; /** * Order book * * Weight: Adjusted based on the limit: * * |Limit|Request Weight * ------|------- * 1-100| 5 * 101-500| 25 * 501-1000| 50 * 1001-5000| 250 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Order book * @param {DepthRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#depth Binance API Documentation} */ depth(requestParameters: DepthRequest$1): Promise>; /** * Get recent trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Recent trades list * @param {GetTradesRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#get-trades Binance API Documentation} */ getTrades(requestParameters: GetTradesRequest): Promise>; /** * Get block trades. * * Weight(IP): 25 * * Security Type: MARKET_DATA * * Notes: * - Data Source: Database * * @summary Historical Block Trades (MARKET_DATA) * @param {HistoricalBlockTradesRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#historical-block-trades Binance API Documentation} */ historicalBlockTrades(requestParameters: HistoricalBlockTradesRequest): Promise>; /** * Get older trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Database * * @summary Old trade lookup * @param {HistoricalTradesRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#historical-trades Binance API Documentation} */ historicalTrades(requestParameters: HistoricalTradesRequest): Promise>; /** * Kline/candlestick bars for a symbol. * Klines are uniquely identified by their open time. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * Supported kline intervals (case-sensitive): * * Interval | `interval` value * --------- | ---------------- * seconds | `1s` * minutes | `1m`, `3m`, `5m`, `15m`, `30m` * hours | `1h`, `2h`, `4h`, `6h`, `8h`, `12h` * days | `1d`, `3d` * weeks | `1w` * months | `1M` * **Notes:** * * If `startTime` and `endTime` are not sent, the most recent klines are returned. * Supported values for `timeZone`: * Hours and minutes (e.g. `-1:00`, `05:45`) * Only hours (e.g. `0`, `8`, `4`) * Accepted range is strictly [-12:00 to +14:00] inclusive * If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary Kline/Candlestick data * @param {KlinesRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#klines Binance API Documentation} */ klines(requestParameters: KlinesRequest$1): Promise>; /** * Query the reference price for a symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price * @param {ReferencePriceRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#reference-price Binance API Documentation} */ referencePrice(requestParameters: ReferencePriceRequest$2): Promise>; /** * Describes how reference price is calculated for a given symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price Calculation * @param {ReferencePriceCalculationRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#reference-price-calculation Binance API Documentation} */ referencePriceCalculation(requestParameters: ReferencePriceCalculationRequest$1): Promise>; /** * **Note:** This endpoint differs from `GET /api/v3/ticker/24hr`. * * The statistical time range of this endpoint can be up to 59999ms longer * than the requested `windowSize`. * * `openTime` starts at the beginning of a minute, while the end time is * the current time. Therefore, the actual interval can be up to 59999ms * longer than the requested window. * * For example, if `closeTime` is 1641287867099 (January 04, 2022 * 09:17:47:099 UTC) and `windowSize` is `1d`, then `openTime` is * 1641201420000 (January 3, 2022, 09:17:00 UTC). * * Weight: 4 for each requested symbol regardless of windowSize. * * The weight for this request will cap at 200 once the number of `symbols` in the request is more than 50. * * Security Type: NONE * * Notes: **Data Source:** Database * * @summary Rolling window price change statistics * @param {TickerRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#ticker Binance API Documentation} */ ticker(requestParameters?: TickerRequest$2): Promise>; /** * 24 hour rolling window price change statistics. **Careful** when accessing this with no symbol. * * Weight: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
ParameterSymbols ProvidedWeight
symbol12
symbol parameter is omitted80
symbols1-202
21-10040
101 or more80
symbols parameter is omitted80
* * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary 24hr ticker price change statistics * @param {Ticker24hrRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#ticker24hr Binance API Documentation} */ ticker24hr(requestParameters?: Ticker24hrRequest$1): Promise>; /** * Best price/qty on the order book for a symbol or symbols. * * Weight: |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Symbol order book ticker * @param {TickerBookTickerRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#ticker-book-ticker Binance API Documentation} */ tickerBookTicker(requestParameters?: TickerBookTickerRequest): Promise>; /** * Latest price for a symbol or symbols. * * Weight: |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Symbol price ticker * @param {TickerPriceRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#ticker-price Binance API Documentation} */ tickerPrice(requestParameters?: TickerPriceRequest$1): Promise>; /** * Price change statistics for a trading day. * * Weight: 4 for each requested symbol. The weight for this request will cap at 200 once the number of symbols in the request is more than 50. * * Security Type: NONE * * Notes: **Data Source:** Database * **Notes:**: * - Supported values for `timeZone`: * - Hours and minutes (e.g. `-1:00`, `05:45`) * - Only hours (e.g. `0`, `8`, `4`) * * @summary Trading Day Ticker * @param {TickerTradingDayRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#ticker-trading-day Binance API Documentation} */ tickerTradingDay(requestParameters?: TickerTradingDayRequest$1): Promise>; /** * The request is similar to klines having the same parameters and * response. * * `uiKlines` return modified kline data, optimized for presentation of * candlestick charts. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If `startTime` and `endTime` are not sent, the most recent klines are returned. * - Supported values for `timeZone`: * - Hours and minutes (e.g. `-1:00`, `05:45`) * - Only hours (e.g. `0`, `8`, `4`) * - Accepted range is strictly [-12:00 to +14:00] inclusive * - If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * - Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary UIKlines * @param {UiKlinesRequest} requestParameters Request parameters. * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/market#ui-klines Binance API Documentation} */ uiKlines(requestParameters: UiKlinesRequest$1): Promise>; } declare enum DepthSymbolStatusEnum$1 { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum KlinesIntervalEnum$1 { INTERVAL_1s = "1s", INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum ReferencePriceCalculationSymbolStatusEnum$1 { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum TickerWindowSizeEnum$1 { WINDOW_SIZE_1m = "1m", WINDOW_SIZE_2m = "2m", WINDOW_SIZE_3m = "3m", WINDOW_SIZE_4m = "4m", WINDOW_SIZE_5m = "5m", WINDOW_SIZE_6m = "6m", WINDOW_SIZE_7m = "7m", WINDOW_SIZE_8m = "8m", WINDOW_SIZE_9m = "9m", WINDOW_SIZE_10m = "10m", WINDOW_SIZE_11m = "11m", WINDOW_SIZE_12m = "12m", WINDOW_SIZE_13m = "13m", WINDOW_SIZE_14m = "14m", WINDOW_SIZE_15m = "15m", WINDOW_SIZE_16m = "16m", WINDOW_SIZE_17m = "17m", WINDOW_SIZE_18m = "18m", WINDOW_SIZE_19m = "19m", WINDOW_SIZE_20m = "20m", WINDOW_SIZE_21m = "21m", WINDOW_SIZE_22m = "22m", WINDOW_SIZE_23m = "23m", WINDOW_SIZE_24m = "24m", WINDOW_SIZE_25m = "25m", WINDOW_SIZE_26m = "26m", WINDOW_SIZE_27m = "27m", WINDOW_SIZE_28m = "28m", WINDOW_SIZE_29m = "29m", WINDOW_SIZE_30m = "30m", WINDOW_SIZE_31m = "31m", WINDOW_SIZE_32m = "32m", WINDOW_SIZE_33m = "33m", WINDOW_SIZE_34m = "34m", WINDOW_SIZE_35m = "35m", WINDOW_SIZE_36m = "36m", WINDOW_SIZE_37m = "37m", WINDOW_SIZE_38m = "38m", WINDOW_SIZE_39m = "39m", WINDOW_SIZE_40m = "40m", WINDOW_SIZE_41m = "41m", WINDOW_SIZE_42m = "42m", WINDOW_SIZE_43m = "43m", WINDOW_SIZE_44m = "44m", WINDOW_SIZE_45m = "45m", WINDOW_SIZE_46m = "46m", WINDOW_SIZE_47m = "47m", WINDOW_SIZE_48m = "48m", WINDOW_SIZE_49m = "49m", WINDOW_SIZE_50m = "50m", WINDOW_SIZE_51m = "51m", WINDOW_SIZE_52m = "52m", WINDOW_SIZE_53m = "53m", WINDOW_SIZE_54m = "54m", WINDOW_SIZE_55m = "55m", WINDOW_SIZE_56m = "56m", WINDOW_SIZE_57m = "57m", WINDOW_SIZE_58m = "58m", WINDOW_SIZE_59m = "59m", WINDOW_SIZE_1h = "1h", WINDOW_SIZE_2h = "2h", WINDOW_SIZE_3h = "3h", WINDOW_SIZE_4h = "4h", WINDOW_SIZE_5h = "5h", WINDOW_SIZE_6h = "6h", WINDOW_SIZE_7h = "7h", WINDOW_SIZE_8h = "8h", WINDOW_SIZE_9h = "9h", WINDOW_SIZE_10h = "10h", WINDOW_SIZE_11h = "11h", WINDOW_SIZE_12h = "12h", WINDOW_SIZE_13h = "13h", WINDOW_SIZE_14h = "14h", WINDOW_SIZE_15h = "15h", WINDOW_SIZE_16h = "16h", WINDOW_SIZE_17h = "17h", WINDOW_SIZE_18h = "18h", WINDOW_SIZE_19h = "19h", WINDOW_SIZE_20h = "20h", WINDOW_SIZE_21h = "21h", WINDOW_SIZE_22h = "22h", WINDOW_SIZE_23h = "23h", WINDOW_SIZE_1d = "1d", WINDOW_SIZE_2d = "2d", WINDOW_SIZE_3d = "3d", WINDOW_SIZE_4d = "4d", WINDOW_SIZE_5d = "5d", WINDOW_SIZE_6d = "6d", WINDOW_SIZE_7d = "7d", } declare enum TickerTypeEnum$1 { FULL = "FULL", MINI = "MINI", } declare enum TickerSymbolStatusEnum$1 { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum Ticker24hrTypeEnum$1 { FULL = "FULL", MINI = "MINI", } declare enum Ticker24hrSymbolStatusEnum$1 { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum TickerBookTickerSymbolStatusEnum { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum TickerPriceSymbolStatusEnum$1 { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum TickerTradingDayTypeEnum$1 { FULL = "FULL", MINI = "MINI", } declare enum TickerTradingDaySymbolStatusEnum$1 { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum UiKlinesIntervalEnum$1 { INTERVAL_1s = "1s", 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/trade-api.d.ts /** * TradeApi - interface * @interface TradeApi */ interface TradeApiInterface$1 { /** * Cancels all active orders on a symbol. * This includes orders that are part of an order list. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Cancel All Open Orders on a Symbol (TRADE) * @param {DeleteOpenOrdersRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ deleteOpenOrders(requestParameters: DeleteOpenOrdersRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * - Either `orderId` or `origClientOrderId` must be sent. * - If both `orderId` and `origClientOrderId` are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * - The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel order (TRADE) * @param {DeleteOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ deleteOrder(requestParameters: DeleteOrderRequest): Promise>; /** * Cancel an entire Order list * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Notes:** * - Canceling an individual order from an order list will cancel the entire order list. * - If both orderListId and listClientOrderId parameters are provided, the orderListId is searched first, then the listClientOrderId from that result is checked against that order. If both conditions are not met the request will be rejected. * * @summary Cancel Order list (TRADE) * @param {DeleteOrderListRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ deleteOrderList(requestParameters: DeleteOrderListRequest): Promise>; /** * Send in a new order. * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Some additional mandatory parameters based on order `type`: * * Type | Additional mandatory parameters | Additional Information * ------------ | ------------| ------ * `LIMIT` | `timeInForce`, `quantity`, `price`| * `MARKET` | `quantity` or `quoteOrderQty`| `MARKET` orders using the `quantity` field specifies the amount of the `base asset` the user wants to buy or sell at the market price.
E.g. MARKET order on BTCUSDT will specify how much BTC the user is buying or selling.

`MARKET` orders using `quoteOrderQty` specifies the amount the user wants to spend (when buying) or receive (when selling) the `quote` asset; the correct `quantity` will be determined based on the market liquidity and `quoteOrderQty`.
E.g. Using the symbol BTCUSDT:
`BUY` side, the order will buy as many BTC as `quoteOrderQty` USDT can.
`SELL` side, the order will sell as much BTC needed to receive `quoteOrderQty` USDT. * `STOP_LOSS` | `quantity`, `stopPrice` or `trailingDelta`| This will execute a `MARKET` order when the conditions are met. (e.g. `stopPrice` is met or `trailingDelta` is activated) * `STOP_LOSS_LIMIT` | `timeInForce`, `quantity`, `price`, `stopPrice` or `trailingDelta` * `TAKE_PROFIT` | `quantity`, `stopPrice` or `trailingDelta` | This will execute a `MARKET` order when the conditions are met. (e.g. `stopPrice` is met or `trailingDelta` is activated) * `TAKE_PROFIT_LIMIT` | `timeInForce`, `quantity`, `price`, `stopPrice` or `trailingDelta` | * `LIMIT_MAKER` | `quantity`, `price`| This is a `LIMIT` order that will be rejected if the order immediately matches and trades as a taker.
This is also known as a POST-ONLY order. * * * Notes on using parameters for Pegged Orders: * These parameters are allowed for `LIMIT`, `LIMIT_MAKER`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_LIMIT` orders. * If `pegPriceType` is specified, `price` becomes optional. Otherwise, it is still mandatory. * `pegPriceType=PRIMARY_PEG` means the primary peg, that is the best price on the same side of the order book as your order. * `pegPriceType=MARKET_PEG` means the market peg, that is the best price on the opposite side of the order book from your order. * Use `pegOffsetType` and `pegOffsetValue` to request a price level other than the best one. These parameters must be specified together. * * Other info: * Any `LIMIT` or `LIMIT_MAKER` type order can be made an iceberg order by sending an `icebergQty`. * Any order with an `icebergQty` MUST have `timeInForce` set to `GTC`. * For `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_LIMIT` and `TAKE_PROFIT` orders, `trailingDelta` can be combined with `stopPrice`. * `MARKET` orders using `quoteOrderQty` will not break `LOT_SIZE` filter rules; the order will execute a `quantity` that will have the notional value as close as possible to `quoteOrderQty`. Trigger order price rules against market price for both MARKET and LIMIT versions: * Price above market price: `STOP_LOSS` `BUY`, `TAKE_PROFIT` `SELL` * Price below market price: `STOP_LOSS` `SELL`, `TAKE_PROFIT` `BUY` * * @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>; /** * Reduce the quantity of an existing open order. * * This adds 0 orders to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read Order Amend Keep Priority FAQ to learn more. * * Weight(IP): 4 * * Unfilled Order Count: 0 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Order Amend Keep Priority (TRADE) * @param {OrderAmendKeepPriorityRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ orderAmendKeepPriority(requestParameters: OrderAmendKeepPriorityRequest$1): Promise>; /** * - Cancels an existing order and places a new order on the same symbol. * - Filters and Order Count are evaluated before the processing of the cancellation and order placement occurs. * - A new order that was not attempted (i.e. when `newOrderResult: NOT_ATTEMPTED`), will still increase the unfilled order count by 1. * - You can only cancel an individual order from an orderList using this endpoint, but the result is the same as canceling the entire orderList. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Similar to `POST /api/v3/order`, additional mandatory parameters are determined by `type`. * Response format varies depending on whether the processing of the message succeeded, partially succeeded, or failed. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
RequestResponse
cancelReplaceModeorderRateLimitExceededModeUnfilled Order CountcancelResultnewOrderResultstatus
STOP_ON_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE➖ NOT_ATTEMPTEDN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits❌ FAILURE➖ NOT_ATTEMPTED429
✅ SUCCESS❌ FAILURE429
ALLOW_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE❌ FAILUREN/A
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILURE409
* **Notes:** * - The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel an Existing Order and Send a New Order (TRADE) * @param {OrderCancelReplaceRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ orderCancelReplace(requestParameters: OrderCancelReplaceRequest$1): Promise>; /** * Send in an one-cancels-the-other (OCO) pair, where activation of one * order immediately cancels the other. * * - An OCO has 2 orders called the **above order** and **below order**. * - One of the orders must be a `LIMIT_MAKER/TAKE_PROFIT/TAKE_PROFIT_LIMIT` order and the other must be `STOP_LOSS` or `STOP_LOSS_LIMIT` order. * - Price restrictions * - If the OCO is on the `SELL` side: * - `LIMIT_MAKER/TAKE_PROFIT_LIMIT` `price` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT` `stopPrice` * - `TAKE_PROFIT stopPrice` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT stopPrice` * - If the OCO is on the `BUY` side: * - `LIMIT_MAKER/TAKE_PROFIT_LIMIT price` < Last Traded Price < `stopPrice` * - `TAKE_PROFIT stopPrice` < Last Traded Price < `STOP_LOSS/STOP_LOSS_LIMIT stopPrice` * OCOs add **2 orders** to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * - OCOs add 2 orders to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New Order list - OCO (TRADE) * @param {OrderListOcoRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ orderListOco(requestParameters: OrderListOcoRequest): Promise>; /** * Place an [OPO](/products/spot/faqs/opo). * * - OPOs add 2 orders to the `EXCHANGE_MAX_NUM_ORDERS`` filter and `MAX_NUM_ORDERS`` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New Order List - OPO (TRADE) * @param {OrderListOpoRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ orderListOpo(requestParameters: OrderListOpoRequest): Promise>; /** * Place an [OPOCO](/products/spot/faqs/opo). * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New Order List - OPOCO (TRADE) * @param {OrderListOpocoRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ orderListOpoco(requestParameters: OrderListOpocoRequest): Promise>; /** * Place an OTO. * * - An OTO (One-Triggers-the-Other) is an order list comprised of 2 orders. * - The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. * - The second order is called the **pending order**. It can be any order type except for `MARKET` orders using parameter `quoteOrderQty`. The pending order is only placed on the order book when the working order gets **fully filled**. * - If either the working order or the pending order is cancelled individually, the other order in the order list will also be canceled or expired. * - When the order list is placed, if the working order gets **immediately fully filled**, the placement response will show the working order as `FILLED` but the pending order will still appear as `PENDING_NEW`. You need to query the status of the pending order again to see its updated status. * - OTOs add **2 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingType` or `workingType`** * * Depending on the `pendingType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingType` = `LIMIT` |`pendingPrice`, `pendingTimeInForce` | * |`pendingType` = `STOP_LOSS` or `TAKE_PROFIT` |`pendingStopPrice` and/or `pendingTrailingDelta`| * |`pendingType` = `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`|`pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce`| * * @summary New Order list - OTO (TRADE) * @param {OrderListOtoRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ orderListOto(requestParameters: OrderListOtoRequest): Promise>; /** * Place an OTOCO. * * - An OTOCO (One-Triggers-One-Cancels-the-Other) is an order list comprised of 3 orders. * - The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. * - The behavior of the working order is the same as the [OTO](#order-list-oto). * - OTOCO has 2 pending orders (pending above and pending below), forming an OCO pair. The pending orders are only placed on the order book when the working order gets **fully filled**. * - The rules of the pending above and pending below follow the same rules as the [Order list OCO](#order-list-oco). * - OTOCOs add **3 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingAboveType`, `pendingBelowType` or `workingType`** * * Depending on the `pendingAboveType`/`pendingBelowType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingAboveType`= `LIMIT_MAKER` |`pendingAbovePrice` | * |`pendingAboveType` = `STOP_LOSS/TAKE_PROFIT` |`pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`| * |`pendingAboveType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT` |`pendingAbovePrice`, `pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`, `pendingAboveTimeInForce`| * |`pendingBelowType`= `LIMIT_MAKER` |`pendingBelowPrice` | * |`pendingBelowType= STOP_LOSS/TAKE_PROFIT` |`pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`| * |`pendingBelowType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT` |`pendingBelowPrice`, `pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`, `pendingBelowTimeInForce`| * * @summary New Order list - OTOCO (TRADE) * @param {OrderListOtocoRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ orderListOtoco(requestParameters: OrderListOtocoRequest): Promise>; /** * Send in a new OCO. * * - Price Restrictions: * - `SELL`: Limit Price > Last Price > Stop Price * - `BUY`: Limit Price < Last Price < Stop Price * - Quantity Restrictions: * - Both legs must have the same quantity. * - `ICEBERG` quantities however do not have to be the same * - `OCO` adds **2 orders** to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New OCO - Deprecated (TRADE) * @param {OrderOcoRequest} requestParameters Request parameters. * * @deprecated * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ orderOco(requestParameters: OrderOcoRequest): Promise>; /** * Test new order creation and signature/recvWindow long. * * Creates and validates a new order but does not send it into the matching * engine. * * Weight: |Condition|Weight| * |---|---| * |Without `computeCommissionRates`|1| * |With `computeCommissionRates`|20| * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order (TRADE) * @param {OrderTestRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ orderTest(requestParameters: OrderTestRequest$1): Promise>; /** * Places an order using smart order routing (SOR). * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read [SOR FAQ](/products/spot/faqs/sor_faq) to learn more. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Note:** `POST /api/v3/sor/order` only supports `LIMIT` and `MARKET` orders. `quoteOrderQty` is not supported. * * @summary New order using SOR (TRADE) * @param {SorOrderRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ sorOrder(requestParameters: SorOrderRequest): Promise>; /** * Test new order creation and signature/recvWindow using smart order routing (SOR). * Creates and validates a new order but does not send it into the matching engine. * * Weight: |Condition|Weight| * |---|---| * |Without `computeCommissionRates`|1| * |With `computeCommissionRates`|20| * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order using SOR (TRADE) * @param {SorOrderTestRequest} requestParameters Request parameters. * * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @memberof TradeApiInterface */ sorOrderTest(requestParameters: SorOrderTestRequest$1): Promise>; } /** * Request parameters for deleteOpenOrders operation in TradeApi. * @interface DeleteOpenOrdersRequest */ interface DeleteOpenOrdersRequest { /** * * @type {string} * @memberof TradeApiDeleteOpenOrders */ readonly symbol: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiDeleteOpenOrders */ readonly recvWindow?: number; } /** * Request parameters for deleteOrder operation in TradeApi. * @interface DeleteOrderRequest */ interface DeleteOrderRequest { /** * * @type {string} * @memberof TradeApiDeleteOrder */ readonly symbol: string; /** * * @type {number | bigint} * @memberof TradeApiDeleteOrder */ readonly orderId?: number | bigint; /** * * @type {string} * @memberof TradeApiDeleteOrder */ readonly origClientOrderId?: string; /** * Used to uniquely identify this cancel. Automatically generated by default. * @type {string} * @memberof TradeApiDeleteOrder */ readonly newClientOrderId?: string; /** * Supported values:
`ONLY_NEW` - Cancel will succeed if the order status is `NEW`.
`ONLY_PARTIALLY_FILLED` - Cancel will succeed if order status is `PARTIALLY_FILLED`. * @type {'ONLY_NEW' | 'ONLY_PARTIALLY_FILLED'} * @memberof TradeApiDeleteOrder */ readonly cancelRestrictions?: DeleteOrderCancelRestrictionsEnum; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiDeleteOrder */ readonly recvWindow?: number; } /** * Request parameters for deleteOrderList operation in TradeApi. * @interface DeleteOrderListRequest */ interface DeleteOrderListRequest { /** * * @type {string} * @memberof TradeApiDeleteOrderList */ readonly symbol: string; /** * Either `orderListId` or `listClientOrderId` must be provided * @type {number | bigint} * @memberof TradeApiDeleteOrderList */ readonly orderListId?: number | bigint; /** * Either `orderListId` or `listClientOrderId` must be provided * @type {string} * @memberof TradeApiDeleteOrderList */ readonly listClientOrderId?: string; /** * Used to uniquely identify this cancel. Automatically generated by default. * @type {string} * @memberof TradeApiDeleteOrderList */ readonly newClientOrderId?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiDeleteOrderList */ readonly recvWindow?: number; } /** * Request parameters for newOrder operation in TradeApi. * @interface NewOrderRequest */ interface NewOrderRequest { /** * * @type {string} * @memberof TradeApiNewOrder */ readonly symbol: string; /** * Please see [Enums](/products/spot/enums#side) for supported values. * @type {'BUY' | 'SELL'} * @memberof TradeApiNewOrder */ readonly side: NewOrderSideEnum; /** * Please see [Enums](/products/spot/enums#ordertypes) for supported values. * @type {'MARKET' | 'LIMIT' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiNewOrder */ readonly type: NewOrderTypeEnum; /** * Please see [Enums](/products/spot/enums#timeinforce) for supported values. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiNewOrder */ readonly timeInForce?: NewOrderTimeInForceEnum; /** * * @type {number} * @memberof TradeApiNewOrder */ readonly quantity?: number; /** * * @type {number} * @memberof TradeApiNewOrder */ readonly quoteOrderQty?: number; /** * * @type {number} * @memberof TradeApiNewOrder */ readonly price?: number; /** * A unique id among open orders. Automatically generated if not sent.
Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected. * @type {string} * @memberof TradeApiNewOrder */ readonly newClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiNewOrder */ readonly strategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiNewOrder */ readonly strategyType?: number; /** * Used with `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, and `TAKE_PROFIT_LIMIT` orders. * @type {number} * @memberof TradeApiNewOrder */ readonly stopPrice?: number; /** * See Trailing Stop order FAQ * @type {number | bigint} * @memberof TradeApiNewOrder */ readonly trailingDelta?: number | bigint; /** * Used with `LIMIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` to create an iceberg order. * @type {number} * @memberof TradeApiNewOrder */ readonly icebergQty?: number; /** * `MARKET` and `LIMIT` order types default to `FULL`, all other orders default to `ACK`. * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiNewOrder */ readonly newOrderRespType?: NewOrderNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiNewOrder */ readonly selfTradePreventionMode?: NewOrderSelfTradePreventionModeEnum; /** * See Pegged Orders Info * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiNewOrder */ readonly pegPriceType?: NewOrderPegPriceTypeEnum; /** * Price level to peg the price to (max: 100). See Pegged Orders Info * @type {number} * @memberof TradeApiNewOrder */ readonly pegOffsetValue?: number; /** * Only `PRICE_LEVEL` is supported. See Pegged Orders Info * @type {'PRICE_LEVEL'} * @memberof TradeApiNewOrder */ readonly pegOffsetType?: NewOrderPegOffsetTypeEnum; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiNewOrder */ readonly recvWindow?: number; } /** * Request parameters for orderAmendKeepPriority operation in TradeApi. * @interface OrderAmendKeepPriorityRequest */ interface OrderAmendKeepPriorityRequest$1 { /** * * @type {string} * @memberof TradeApiOrderAmendKeepPriority */ readonly symbol: string; /** * `newQty` must be greater than 0 and less than the order's quantity. * @type {number} * @memberof TradeApiOrderAmendKeepPriority */ readonly newQty: number; /** * `orderId` or `origClientOrderId` must be sent * @type {number | bigint} * @memberof TradeApiOrderAmendKeepPriority */ readonly orderId?: number | bigint; /** * `orderId` or `origClientOrderId` must be sent * @type {string} * @memberof TradeApiOrderAmendKeepPriority */ readonly origClientOrderId?: string; /** * The new client order ID for the order after being amended.
If not sent, one will be randomly generated.
It is possible to reuse the current clientOrderId by sending it as the `newClientOrderId`. * @type {string} * @memberof TradeApiOrderAmendKeepPriority */ readonly newClientOrderId?: string; /** * The value cannot be greater than `60000`.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderAmendKeepPriority */ readonly recvWindow?: number; } /** * Request parameters for orderCancelReplace operation in TradeApi. * @interface OrderCancelReplaceRequest */ interface OrderCancelReplaceRequest$1 { /** * * @type {string} * @memberof TradeApiOrderCancelReplace */ readonly symbol: string; /** * * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderCancelReplace */ readonly side: OrderCancelReplaceSideEnum$1; /** * * @type {'MARKET' | 'LIMIT' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderCancelReplace */ readonly type: OrderCancelReplaceTypeEnum$1; /** * The allowed values are:
`STOP_ON_FAILURE` - If the cancel request fails, the new order placement will not be attempted.
`ALLOW_FAILURE` - new order placement will be attempted even if cancel request fails. * @type {'STOP_ON_FAILURE' | 'ALLOW_FAILURE'} * @memberof TradeApiOrderCancelReplace */ readonly cancelReplaceMode: OrderCancelReplaceCancelReplaceModeEnum$1; /** * * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderCancelReplace */ readonly timeInForce?: OrderCancelReplaceTimeInForceEnum$1; /** * * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly quantity?: number; /** * * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly quoteOrderQty?: number; /** * * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly price?: number; /** * Used to uniquely identify this cancel. Automatically generated by default. * @type {string} * @memberof TradeApiOrderCancelReplace */ readonly cancelNewClientOrderId?: string; /** * Either `cancelOrderId` or `cancelOrigClientOrderId` must be sent.

If both `cancelOrderId` and `cancelOrigClientOrderId` parameters are provided, the `cancelOrderId` is searched first, then the `cancelOrigClientOrderId` from that result is checked against that order.

If both conditions are not met the request will be rejected. * @type {string} * @memberof TradeApiOrderCancelReplace */ readonly cancelOrigClientOrderId?: string; /** * Either `cancelOrderId` or `cancelOrigClientOrderId` must be sent.

If both `cancelOrderId` and `cancelOrigClientOrderId` parameters are provided, the `cancelOrderId` is searched first, then the `cancelOrigClientOrderId` from that result is checked against that order.

If both conditions are not met the request will be rejected. * @type {number | bigint} * @memberof TradeApiOrderCancelReplace */ readonly cancelOrderId?: number | bigint; /** * Used to identify the new order. * @type {string} * @memberof TradeApiOrderCancelReplace */ readonly newClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiOrderCancelReplace */ readonly strategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly strategyType?: number; /** * * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly stopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number | bigint} * @memberof TradeApiOrderCancelReplace */ readonly trailingDelta?: number | bigint; /** * * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly icebergQty?: number; /** * Allowed values:
`ACK`, `RESULT`, `FULL`
`MARKET` and `LIMIT` orders types default to `FULL`; all other orders default to `ACK` * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderCancelReplace */ readonly newOrderRespType?: OrderCancelReplaceNewOrderRespTypeEnum$1; /** * The allowed enums is dependent on what is configured on the symbol. The possible supported values are: [STP Modes](/products/spot/enums#stpmodes). * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderCancelReplace */ readonly selfTradePreventionMode?: OrderCancelReplaceSelfTradePreventionModeEnum$1; /** * Supported values:
`ONLY_NEW` - Cancel will succeed if the order status is `NEW`.
`ONLY_PARTIALLY_FILLED ` - Cancel will succeed if order status is `PARTIALLY_FILLED`. * @type {'ONLY_NEW' | 'ONLY_PARTIALLY_FILLED'} * @memberof TradeApiOrderCancelReplace */ readonly cancelRestrictions?: OrderCancelReplaceCancelRestrictionsEnum$1; /** * Supported values:
`DO_NOTHING` (default)- will only attempt to cancel the order if account has not exceeded the unfilled order rate limit
`CANCEL_ONLY` - will always cancel the order * @type {'DO_NOTHING' | 'CANCEL_ONLY'} * @memberof TradeApiOrderCancelReplace */ readonly orderRateLimitExceededMode?: OrderCancelReplaceOrderRateLimitExceededModeEnum$1; /** * `PRIMARY_PEG` or `MARKET_PEG`
See Pegged Orders * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderCancelReplace */ readonly pegPriceType?: OrderCancelReplacePegPriceTypeEnum$1; /** * Price level to peg the price to (max: 100)
See Pegged Orders * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly pegOffsetValue?: number; /** * Only `PRICE_LEVEL` is supported
See Pegged Orders. * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderCancelReplace */ readonly pegOffsetType?: OrderCancelReplacePegOffsetTypeEnum$1; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly recvWindow?: number; } /** * Request parameters for orderListOco operation in TradeApi. * @interface OrderListOcoRequest */ interface OrderListOcoRequest { /** * * @type {string} * @memberof TradeApiOrderListOco */ readonly symbol: string; /** * * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListOco */ readonly side: OrderListOcoSideEnum; /** * Quantity for both orders of the order list. * @type {number} * @memberof TradeApiOrderListOco */ readonly quantity: number; /** * * @type {'STOP_LOSS_LIMIT' | 'STOP_LOSS' | 'LIMIT_MAKER' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListOco */ readonly aboveType: OrderListOcoAboveTypeEnum; /** * Supported values: `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT` * @type {'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListOco */ readonly belowType: OrderListOcoBelowTypeEnum; /** * Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `aboveClientOrderId` and the `belowClientOrderId`. * @type {string} * @memberof TradeApiOrderListOco */ readonly listClientOrderId?: string; /** * Arbitrary unique ID among open orders for the above order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOco */ readonly aboveClientOrderId?: string; /** * Note that this can only be used if `aboveTimeInForce` is `GTC`. * @type {number | bigint} * @memberof TradeApiOrderListOco */ readonly aboveIcebergQty?: number | bigint; /** * Can be used if `aboveType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListOco */ readonly abovePrice?: number; /** * Can be used if `aboveType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `aboveStopPrice` or `aboveTrailingDelta` or both, must be specified. * @type {number} * @memberof TradeApiOrderListOco */ readonly aboveStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number | bigint} * @memberof TradeApiOrderListOco */ readonly aboveTrailingDelta?: number | bigint; /** * Required if `aboveType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOco */ readonly aboveTimeInForce?: OrderListOcoAboveTimeInForceEnum; /** * Arbitrary numeric value identifying the above order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOco */ readonly aboveStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the above order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOco */ readonly aboveStrategyType?: number; /** * `PRIMARY_PEG` or `MARKET_PEG`. See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOco */ readonly abovePegPriceType?: OrderListOcoAbovePegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOco */ readonly abovePegOffsetType?: OrderListOcoAbovePegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListOco */ readonly abovePegOffsetValue?: number; /** * Arbitrary unique ID among open orders for the below order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOco */ readonly belowClientOrderId?: string; /** * Note that this can only be used if `belowTimeInForce` is `GTC`. * @type {number | bigint} * @memberof TradeApiOrderListOco */ readonly belowIcebergQty?: number | bigint; /** * Can be used if `belowType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListOco */ readonly belowPrice?: number; /** * Can be used if `belowType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `belowStopPrice` or `belowTrailingDelta` or both, must be specified. * @type {number} * @memberof TradeApiOrderListOco */ readonly belowStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number | bigint} * @memberof TradeApiOrderListOco */ readonly belowTrailingDelta?: number | bigint; /** * Required if `belowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOco */ readonly belowTimeInForce?: OrderListOcoBelowTimeInForceEnum; /** * Arbitrary numeric value identifying the below order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOco */ readonly belowStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the below order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOco */ readonly belowStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOco */ readonly belowPegPriceType?: OrderListOcoBelowPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOco */ readonly belowPegOffsetType?: OrderListOcoBelowPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListOco */ readonly belowPegOffsetValue?: number; /** * Select response format: `ACK`, `RESULT`, `FULL`. * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListOco */ readonly newOrderRespType?: OrderListOcoNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListOco */ readonly selfTradePreventionMode?: OrderListOcoSelfTradePreventionModeEnum; /** * The value cannot be greater than `60000`. Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListOco */ readonly recvWindow?: number; } /** * Request parameters for orderListOpo operation in TradeApi. * @interface OrderListOpoRequest */ interface OrderListOpoRequest { /** * * @type {string} * @memberof TradeApiOrderListOpo */ readonly symbol: string; /** * Supported values: `LIMIT`, `LIMIT_MAKER` * @type {'LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListOpo */ readonly workingType: OrderListOpoWorkingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListOpo */ readonly workingSide: OrderListOpoWorkingSideEnum; /** * Price for the working order. * @type {number} * @memberof TradeApiOrderListOpo */ readonly workingPrice: number; /** * Sets the quantity for the working order. * @type {number} * @memberof TradeApiOrderListOpo */ readonly workingQuantity: number; /** * Supported values: [Order Types](/products/spot/enums#ordertypes). Note that `MARKET` orders using `quoteOrderQty` are not supported. * @type {'LIMIT' | 'MARKET' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListOpo */ readonly pendingType: OrderListOpoPendingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListOpo */ readonly pendingSide: OrderListOpoPendingSideEnum; /** * Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. * @type {string} * @memberof TradeApiOrderListOpo */ readonly listClientOrderId?: string; /** * Format of the JSON response. Supported values: [Order Response Type](/products/spot/enums#orderresponsetype) * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListOpo */ readonly newOrderRespType?: OrderListOpoNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListOpo */ readonly selfTradePreventionMode?: OrderListOpoSelfTradePreventionModeEnum; /** * Arbitrary unique ID among open orders for the working order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOpo */ readonly workingClientOrderId?: string; /** * This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListOpo */ readonly workingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOpo */ readonly workingTimeInForce?: OrderListOpoWorkingTimeInForceEnum; /** * Arbitrary numeric value identifying the working order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOpo */ readonly workingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOpo */ readonly workingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOpo */ readonly workingPegPriceType?: OrderListOpoWorkingPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOpo */ readonly workingPegOffsetType?: OrderListOpoWorkingPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListOpo */ readonly workingPegOffsetValue?: number; /** * Arbitrary unique ID among open orders for the pending order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOpo */ readonly pendingClientOrderId?: string; /** * Price for the pending order. * @type {number} * @memberof TradeApiOrderListOpo */ readonly pendingPrice?: number; /** * Stop price for the pending order. * @type {number} * @memberof TradeApiOrderListOpo */ readonly pendingStopPrice?: number; /** * Trailing delta for the pending order. * @type {number} * @memberof TradeApiOrderListOpo */ readonly pendingTrailingDelta?: number; /** * This can only be used if `pendingTimeInForce` is `GTC` or if `pendingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListOpo */ readonly pendingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOpo */ readonly pendingTimeInForce?: OrderListOpoPendingTimeInForceEnum; /** * Arbitrary numeric value identifying the pending order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOpo */ readonly pendingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOpo */ readonly pendingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOpo */ readonly pendingPegPriceType?: OrderListOpoPendingPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOpo */ readonly pendingPegOffsetType?: OrderListOpoPendingPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListOpo */ readonly pendingPegOffsetValue?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListOpo */ readonly recvWindow?: number; } /** * Request parameters for orderListOpoco operation in TradeApi. * @interface OrderListOpocoRequest */ interface OrderListOpocoRequest { /** * * @type {string} * @memberof TradeApiOrderListOpoco */ readonly symbol: string; /** * * @type {'LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListOpoco */ readonly workingType: OrderListOpocoWorkingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListOpoco */ readonly workingSide: OrderListOpocoWorkingSideEnum; /** * Price for the working order. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly workingPrice: number; /** * Sets the quantity for the working order. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly workingQuantity: number; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListOpoco */ readonly pendingSide: OrderListOpocoPendingSideEnum; /** * Supported values: `STOP_LOSS_LIMIT`, `STOP_LOSS`, `LIMIT_MAKER`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT` * @type {'STOP_LOSS_LIMIT' | 'STOP_LOSS' | 'LIMIT_MAKER' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListOpoco */ readonly pendingAboveType: OrderListOpocoPendingAboveTypeEnum; /** * Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. * @type {string} * @memberof TradeApiOrderListOpoco */ readonly listClientOrderId?: string; /** * Format of the JSON response. Supported values: [Order Response Type](/products/spot/enums#orderresponsetype) * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListOpoco */ readonly newOrderRespType?: OrderListOpocoNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListOpoco */ readonly selfTradePreventionMode?: OrderListOpocoSelfTradePreventionModeEnum; /** * Arbitrary unique ID among open orders for the working order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOpoco */ readonly workingClientOrderId?: string; /** * This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly workingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOpoco */ readonly workingTimeInForce?: OrderListOpocoWorkingTimeInForceEnum; /** * Arbitrary numeric value identifying the working order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOpoco */ readonly workingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly workingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOpoco */ readonly workingPegPriceType?: OrderListOpocoWorkingPegPriceTypeEnum; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOpoco */ readonly workingPegOffsetType?: OrderListOpocoWorkingPegOffsetTypeEnum; /** * Price level for pegging (max: 100). See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {number} * @memberof TradeApiOrderListOpoco */ readonly workingPegOffsetValue?: number; /** * Arbitrary unique ID among open orders for the pending above order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOpoco */ readonly pendingAboveClientOrderId?: string; /** * Can be used if `pendingAboveType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingAbovePrice?: number; /** * Can be used if `pendingAboveType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingAboveStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingAboveTrailingDelta?: number; /** * This can only be used if `pendingAboveTimeInForce` is `GTC` or `pendingAboveType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingAboveIcebergQty?: number; /** * Required if `pendingAboveType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOpoco */ readonly pendingAboveTimeInForce?: OrderListOpocoPendingAboveTimeInForceEnum; /** * Arbitrary numeric value identifying the pending above order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOpoco */ readonly pendingAboveStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending above order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingAboveStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOpoco */ readonly pendingAbovePegPriceType?: OrderListOpocoPendingAbovePegPriceTypeEnum; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOpoco */ readonly pendingAbovePegOffsetType?: OrderListOpocoPendingAbovePegOffsetTypeEnum; /** * Price level for pegging (max: 100). See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingAbovePegOffsetValue?: number; /** * Supported values: `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT` * @type {'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowType?: OrderListOpocoPendingBelowTypeEnum; /** * Arbitrary unique ID among open orders for the pending below order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowClientOrderId?: string; /** * Can be used if `pendingBelowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowPrice?: number; /** * Can be used if `pendingBelowType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `pendingBelowStopPrice` or `pendingBelowTrailingDelta` or both, must be specified. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowTrailingDelta?: number; /** * This can only be used if `pendingBelowTimeInForce` is `GTC` or `pendingBelowType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowTimeInForce?: OrderListOpocoPendingBelowTimeInForceEnum; /** * Arbitrary numeric value identifying the pending below order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending below order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowPegPriceType?: OrderListOpocoPendingBelowPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowPegOffsetType?: OrderListOpocoPendingBelowPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListOpoco */ readonly pendingBelowPegOffsetValue?: number; /** * The value cannot be greater than `60000`. Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListOpoco */ readonly recvWindow?: number; } /** * Request parameters for orderListOto operation in TradeApi. * @interface OrderListOtoRequest */ interface OrderListOtoRequest { /** * * @type {string} * @memberof TradeApiOrderListOto */ readonly symbol: string; /** * Supported values: `LIMIT`, `LIMIT_MAKER` * @type {'LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListOto */ readonly workingType: OrderListOtoWorkingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListOto */ readonly workingSide: OrderListOtoWorkingSideEnum; /** * * @type {number} * @memberof TradeApiOrderListOto */ readonly workingPrice: number; /** * Sets the quantity for the working order. * @type {number} * @memberof TradeApiOrderListOto */ readonly workingQuantity: number; /** * Supported values: [Order Types](/products/spot/enums#ordertypes). Note that `MARKET` orders using `quoteOrderQty` are not supported. * @type {'LIMIT' | 'MARKET' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListOto */ readonly pendingType: OrderListOtoPendingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListOto */ readonly pendingSide: OrderListOtoPendingSideEnum; /** * Sets the quantity for the pending order. * @type {number} * @memberof TradeApiOrderListOto */ readonly pendingQuantity: number; /** * Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. * @type {string} * @memberof TradeApiOrderListOto */ readonly listClientOrderId?: string; /** * Format of the JSON response. Supported values: [Order Response Type](/products/spot/enums#orderresponsetype) * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListOto */ readonly newOrderRespType?: OrderListOtoNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListOto */ readonly selfTradePreventionMode?: OrderListOtoSelfTradePreventionModeEnum; /** * Arbitrary unique ID among open orders for the working order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOto */ readonly workingClientOrderId?: string; /** * This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListOto */ readonly workingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOto */ readonly workingTimeInForce?: OrderListOtoWorkingTimeInForceEnum; /** * Arbitrary numeric value identifying the working order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOto */ readonly workingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOto */ readonly workingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOto */ readonly workingPegPriceType?: OrderListOtoWorkingPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOto */ readonly workingPegOffsetType?: OrderListOtoWorkingPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListOto */ readonly workingPegOffsetValue?: number; /** * Arbitrary unique ID among open orders for the pending order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOto */ readonly pendingClientOrderId?: string; /** * * @type {number} * @memberof TradeApiOrderListOto */ readonly pendingPrice?: number; /** * * @type {number} * @memberof TradeApiOrderListOto */ readonly pendingStopPrice?: number; /** * * @type {number} * @memberof TradeApiOrderListOto */ readonly pendingTrailingDelta?: number; /** * This can only be used if `pendingTimeInForce` is `GTC` or if `pendingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListOto */ readonly pendingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOto */ readonly pendingTimeInForce?: OrderListOtoPendingTimeInForceEnum; /** * Arbitrary numeric value identifying the pending order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOto */ readonly pendingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOto */ readonly pendingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOto */ readonly pendingPegPriceType?: OrderListOtoPendingPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOto */ readonly pendingPegOffsetType?: OrderListOtoPendingPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListOto */ readonly pendingPegOffsetValue?: number; /** * The value cannot be greater than `60000`. Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListOto */ readonly recvWindow?: number; } /** * Request parameters for orderListOtoco operation in TradeApi. * @interface OrderListOtocoRequest */ interface OrderListOtocoRequest { /** * * @type {string} * @memberof TradeApiOrderListOtoco */ readonly symbol: string; /** * Supported values: `LIMIT`, `LIMIT_MAKER` * @type {'LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListOtoco */ readonly workingType: OrderListOtocoWorkingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListOtoco */ readonly workingSide: OrderListOtocoWorkingSideEnum; /** * * @type {number} * @memberof TradeApiOrderListOtoco */ readonly workingPrice: number; /** * Sets the quantity for the working order. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly workingQuantity: number; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListOtoco */ readonly pendingSide: OrderListOtocoPendingSideEnum; /** * Sets the quantity for the pending orders. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingQuantity: number; /** * Supported values: `STOP_LOSS_LIMIT`, `STOP_LOSS`, `LIMIT_MAKER`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT` * @type {'STOP_LOSS_LIMIT' | 'STOP_LOSS' | 'LIMIT_MAKER' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListOtoco */ readonly pendingAboveType: OrderListOtocoPendingAboveTypeEnum; /** * Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. * @type {string} * @memberof TradeApiOrderListOtoco */ readonly listClientOrderId?: string; /** * Format of the JSON response. Supported values: [Order Response Type](/products/spot/enums#orderresponsetype) * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListOtoco */ readonly newOrderRespType?: OrderListOtocoNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListOtoco */ readonly selfTradePreventionMode?: OrderListOtocoSelfTradePreventionModeEnum; /** * Arbitrary unique ID among open orders for the working order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOtoco */ readonly workingClientOrderId?: string; /** * This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly workingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOtoco */ readonly workingTimeInForce?: OrderListOtocoWorkingTimeInForceEnum; /** * Arbitrary numeric value identifying the working order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOtoco */ readonly workingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly workingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOtoco */ readonly workingPegPriceType?: OrderListOtocoWorkingPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOtoco */ readonly workingPegOffsetType?: OrderListOtocoWorkingPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListOtoco */ readonly workingPegOffsetValue?: number; /** * Arbitrary unique ID among open orders for the pending above order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOtoco */ readonly pendingAboveClientOrderId?: string; /** * Can be used if `pendingAboveType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingAbovePrice?: number; /** * Can be used if `pendingAboveType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingAboveStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingAboveTrailingDelta?: number; /** * This can only be used if `pendingAboveTimeInForce` is `GTC` or if `pendingAboveType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingAboveIcebergQty?: number; /** * Required if `pendingAboveType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOtoco */ readonly pendingAboveTimeInForce?: OrderListOtocoPendingAboveTimeInForceEnum; /** * Arbitrary numeric value identifying the pending above order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOtoco */ readonly pendingAboveStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending above order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingAboveStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOtoco */ readonly pendingAbovePegPriceType?: OrderListOtocoPendingAbovePegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOtoco */ readonly pendingAbovePegOffsetType?: OrderListOtocoPendingAbovePegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingAbovePegOffsetValue?: number; /** * Supported values: `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT` * @type {'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowType?: OrderListOtocoPendingBelowTypeEnum; /** * Arbitrary unique ID among open orders for the pending below order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowClientOrderId?: string; /** * Can be used if `pendingBelowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowPrice?: number; /** * Can be used if `pendingBelowType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `pendingBelowStopPrice` or `pendingBelowTrailingDelta` or both, must be specified. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowTrailingDelta?: number; /** * This can only be used if `pendingBelowTimeInForce` is `GTC`, or if `pendingBelowType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowIcebergQty?: number; /** * Required if `pendingBelowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowTimeInForce?: OrderListOtocoPendingBelowTimeInForceEnum; /** * Arbitrary numeric value identifying the pending below order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending below order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowPegPriceType?: OrderListOtocoPendingBelowPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowPegOffsetType?: OrderListOtocoPendingBelowPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListOtoco */ readonly pendingBelowPegOffsetValue?: number; /** * The value cannot be greater than `60000`. Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListOtoco */ readonly recvWindow?: number; } /** * Request parameters for orderOco operation in TradeApi. * @interface OrderOcoRequest */ interface OrderOcoRequest { /** * * @type {string} * @memberof TradeApiOrderOco */ readonly symbol: string; /** * * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderOco */ readonly side: OrderOcoSideEnum; /** * * @type {number} * @memberof TradeApiOrderOco */ readonly quantity: number; /** * * @type {number} * @memberof TradeApiOrderOco */ readonly price: number; /** * * @type {number} * @memberof TradeApiOrderOco */ readonly stopPrice: number; /** * A unique Id for the entire orderList * @type {string} * @memberof TradeApiOrderOco */ readonly listClientOrderId?: string; /** * A unique Id for the limit order * @type {string} * @memberof TradeApiOrderOco */ readonly limitClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiOrderOco */ readonly limitStrategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiOrderOco */ readonly limitStrategyType?: number; /** * Used to make the `LIMIT_MAKER` leg an iceberg order. * @type {number} * @memberof TradeApiOrderOco */ readonly limitIcebergQty?: number; /** * * @type {number | bigint} * @memberof TradeApiOrderOco */ readonly trailingDelta?: number | bigint; /** * A unique Id for the stop loss/stop loss limit leg * @type {string} * @memberof TradeApiOrderOco */ readonly stopClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiOrderOco */ readonly stopStrategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiOrderOco */ readonly stopStrategyType?: number; /** * If provided, `stopLimitTimeInForce` is required. * @type {number} * @memberof TradeApiOrderOco */ readonly stopLimitPrice?: number; /** * Used with `STOP_LOSS_LIMIT` leg to make an iceberg order. * @type {number} * @memberof TradeApiOrderOco */ readonly stopIcebergQty?: number; /** * Valid values are `GTC`/`FOK`/`IOC` * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderOco */ readonly stopLimitTimeInForce?: OrderOcoStopLimitTimeInForceEnum; /** * Format of the JSON response. Supported values: [Order Response Type](/products/spot/enums#orderresponsetype) * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderOco */ readonly newOrderRespType?: OrderOcoNewOrderRespTypeEnum; /** * The allowed values are dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderOco */ readonly selfTradePreventionMode?: OrderOcoSelfTradePreventionModeEnum; /** * The value cannot be greater than `60000`.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderOco */ readonly recvWindow?: number; } /** * Request parameters for orderTest operation in TradeApi. * @interface OrderTestRequest */ interface OrderTestRequest$1 { /** * * @type {string} * @memberof TradeApiOrderTest */ readonly symbol: string; /** * Please see [Enums](/products/spot/enums#side) for supported values. * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderTest */ readonly side: OrderTestSideEnum$1; /** * Please see [Enums](/products/spot/enums#ordertypes) for supported values. * @type {'MARKET' | 'LIMIT' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderTest */ readonly type: OrderTestTypeEnum$1; /** * Default: `false`
See [Commissions FAQ](/products/spot/faqs/commission_faq#test-order-diferences) to learn more. * @type {boolean} * @memberof TradeApiOrderTest */ readonly computeCommissionRates?: boolean; /** * Please see [Enums](/products/spot/enums#timeinforce) for supported values. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderTest */ readonly timeInForce?: OrderTestTimeInForceEnum$1; /** * * @type {number} * @memberof TradeApiOrderTest */ readonly quantity?: number; /** * * @type {number} * @memberof TradeApiOrderTest */ readonly quoteOrderQty?: number; /** * * @type {number} * @memberof TradeApiOrderTest */ readonly price?: number; /** * A unique id among open orders. Automatically generated if not sent. Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected. * @type {string} * @memberof TradeApiOrderTest */ readonly newClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiOrderTest */ readonly strategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiOrderTest */ readonly strategyType?: number; /** * Used with `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, and `TAKE_PROFIT_LIMIT` orders. * @type {number} * @memberof TradeApiOrderTest */ readonly stopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number | bigint} * @memberof TradeApiOrderTest */ readonly trailingDelta?: number | bigint; /** * Used with `LIMIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` to create an iceberg order. * @type {number} * @memberof TradeApiOrderTest */ readonly icebergQty?: number; /** * Set the response JSON. `ACK`, `RESULT`, or `FULL`; `MARKET` and `LIMIT` order types default to `FULL`, all other orders default to `ACK`. * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderTest */ readonly newOrderRespType?: OrderTestNewOrderRespTypeEnum$1; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderTest */ readonly selfTradePreventionMode?: OrderTestSelfTradePreventionModeEnum$1; /** * `PRIMARY_PEG` or `MARKET_PEG`. See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderTest */ readonly pegPriceType?: OrderTestPegPriceTypeEnum$1; /** * Price level for pegging (max: 100). See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {number} * @memberof TradeApiOrderTest */ readonly pegOffsetValue?: number; /** * Only `PRICE_LEVEL` is supported. See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderTest */ readonly pegOffsetType?: OrderTestPegOffsetTypeEnum$1; /** * The value cannot be greater than `60000`. Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderTest */ readonly recvWindow?: number; } /** * Request parameters for sorOrder operation in TradeApi. * @interface SorOrderRequest */ interface SorOrderRequest { /** * * @type {string} * @memberof TradeApiSorOrder */ readonly symbol: string; /** * * @type {'BUY' | 'SELL'} * @memberof TradeApiSorOrder */ readonly side: SorOrderSideEnum; /** * * @type {'MARKET' | 'LIMIT'} * @memberof TradeApiSorOrder */ readonly type: SorOrderTypeEnum; /** * * @type {number} * @memberof TradeApiSorOrder */ readonly quantity: number; /** * * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiSorOrder */ readonly timeInForce?: SorOrderTimeInForceEnum; /** * * @type {number} * @memberof TradeApiSorOrder */ readonly price?: number; /** * A unique id among open orders. Automatically generated if not sent.
Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected. * @type {string} * @memberof TradeApiSorOrder */ readonly newClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiSorOrder */ readonly strategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiSorOrder */ readonly strategyType?: number; /** * Used with `LIMIT` to create an iceberg order. * @type {number} * @memberof TradeApiSorOrder */ readonly icebergQty?: number; /** * Set the response JSON. `ACK`, `RESULT`, or `FULL`. Default to `FULL` * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiSorOrder */ readonly newOrderRespType?: SorOrderNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. The possible supported values are: [STP Modes](/products/spot/enums#stpmodes). * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiSorOrder */ readonly selfTradePreventionMode?: SorOrderSelfTradePreventionModeEnum; /** * The value cannot be greater than `60000`.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiSorOrder */ readonly recvWindow?: number; } /** * Request parameters for sorOrderTest operation in TradeApi. * @interface SorOrderTestRequest */ interface SorOrderTestRequest$1 { /** * * @type {string} * @memberof TradeApiSorOrderTest */ readonly symbol: string; /** * Please see [Enums](/products/spot/enums#side) for supported values. * @type {'BUY' | 'SELL'} * @memberof TradeApiSorOrderTest */ readonly side: SorOrderTestSideEnum$1; /** * Please see [Enums](/products/spot/enums#ordertypes) for supported values. * @type {'MARKET' | 'LIMIT'} * @memberof TradeApiSorOrderTest */ readonly type: SorOrderTestTypeEnum$1; /** * * @type {number} * @memberof TradeApiSorOrderTest */ readonly quantity: number; /** * * @type {boolean} * @memberof TradeApiSorOrderTest */ readonly computeCommissionRates?: boolean; /** * Please see [Enums](/products/spot/enums#timeinforce) for supported values. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiSorOrderTest */ readonly timeInForce?: SorOrderTestTimeInForceEnum$1; /** * * @type {number} * @memberof TradeApiSorOrderTest */ readonly price?: number; /** * A unique id among open orders. Automatically generated if not sent. Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected. * @type {string} * @memberof TradeApiSorOrderTest */ readonly newClientOrderId?: string; /** * * @type {number | bigint} * @memberof TradeApiSorOrderTest */ readonly strategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiSorOrderTest */ readonly strategyType?: number; /** * Used with `LIMIT` to create an iceberg order. * @type {number} * @memberof TradeApiSorOrderTest */ readonly icebergQty?: number; /** * Set the response JSON. `ACK`, `RESULT`, or `FULL`. Default to `FULL`. * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiSorOrderTest */ readonly newOrderRespType?: SorOrderTestNewOrderRespTypeEnum$1; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiSorOrderTest */ readonly selfTradePreventionMode?: SorOrderTestSelfTradePreventionModeEnum$1; /** * The value cannot be greater than `60000`. Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiSorOrderTest */ readonly recvWindow?: number; } /** * TradeApi - object-oriented interface * @class TradeApi */ declare class TradeApi$1 implements TradeApiInterface$1 { private readonly configuration; private localVarAxiosParamCreator; constructor(configuration: ConfigurationRestAPI); /** * Cancels all active orders on a symbol. * This includes orders that are part of an order list. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Cancel All Open Orders on a Symbol (TRADE) * @param {DeleteOpenOrdersRequest} 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-spot-trading/api/rest-api/trade#delete-open-orders Binance API Documentation} */ deleteOpenOrders(requestParameters: DeleteOpenOrdersRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * - Either `orderId` or `origClientOrderId` must be sent. * - If both `orderId` and `origClientOrderId` are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * - The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel order (TRADE) * @param {DeleteOrderRequest} 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-spot-trading/api/rest-api/trade#delete-order Binance API Documentation} */ deleteOrder(requestParameters: DeleteOrderRequest): Promise>; /** * Cancel an entire Order list * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Notes:** * - Canceling an individual order from an order list will cancel the entire order list. * - If both orderListId and listClientOrderId parameters are provided, the orderListId is searched first, then the listClientOrderId from that result is checked against that order. If both conditions are not met the request will be rejected. * * @summary Cancel Order list (TRADE) * @param {DeleteOrderListRequest} 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-spot-trading/api/rest-api/trade#delete-order-list Binance API Documentation} */ deleteOrderList(requestParameters: DeleteOrderListRequest): Promise>; /** * Send in a new order. * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Some additional mandatory parameters based on order `type`: * * Type | Additional mandatory parameters | Additional Information * ------------ | ------------| ------ * `LIMIT` | `timeInForce`, `quantity`, `price`| * `MARKET` | `quantity` or `quoteOrderQty`| `MARKET` orders using the `quantity` field specifies the amount of the `base asset` the user wants to buy or sell at the market price.
E.g. MARKET order on BTCUSDT will specify how much BTC the user is buying or selling.

`MARKET` orders using `quoteOrderQty` specifies the amount the user wants to spend (when buying) or receive (when selling) the `quote` asset; the correct `quantity` will be determined based on the market liquidity and `quoteOrderQty`.
E.g. Using the symbol BTCUSDT:
`BUY` side, the order will buy as many BTC as `quoteOrderQty` USDT can.
`SELL` side, the order will sell as much BTC needed to receive `quoteOrderQty` USDT. * `STOP_LOSS` | `quantity`, `stopPrice` or `trailingDelta`| This will execute a `MARKET` order when the conditions are met. (e.g. `stopPrice` is met or `trailingDelta` is activated) * `STOP_LOSS_LIMIT` | `timeInForce`, `quantity`, `price`, `stopPrice` or `trailingDelta` * `TAKE_PROFIT` | `quantity`, `stopPrice` or `trailingDelta` | This will execute a `MARKET` order when the conditions are met. (e.g. `stopPrice` is met or `trailingDelta` is activated) * `TAKE_PROFIT_LIMIT` | `timeInForce`, `quantity`, `price`, `stopPrice` or `trailingDelta` | * `LIMIT_MAKER` | `quantity`, `price`| This is a `LIMIT` order that will be rejected if the order immediately matches and trades as a taker.
This is also known as a POST-ONLY order. * * * Notes on using parameters for Pegged Orders: * These parameters are allowed for `LIMIT`, `LIMIT_MAKER`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_LIMIT` orders. * If `pegPriceType` is specified, `price` becomes optional. Otherwise, it is still mandatory. * `pegPriceType=PRIMARY_PEG` means the primary peg, that is the best price on the same side of the order book as your order. * `pegPriceType=MARKET_PEG` means the market peg, that is the best price on the opposite side of the order book from your order. * Use `pegOffsetType` and `pegOffsetValue` to request a price level other than the best one. These parameters must be specified together. * * Other info: * Any `LIMIT` or `LIMIT_MAKER` type order can be made an iceberg order by sending an `icebergQty`. * Any order with an `icebergQty` MUST have `timeInForce` set to `GTC`. * For `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_LIMIT` and `TAKE_PROFIT` orders, `trailingDelta` can be combined with `stopPrice`. * `MARKET` orders using `quoteOrderQty` will not break `LOT_SIZE` filter rules; the order will execute a `quantity` that will have the notional value as close as possible to `quoteOrderQty`. Trigger order price rules against market price for both MARKET and LIMIT versions: * Price above market price: `STOP_LOSS` `BUY`, `TAKE_PROFIT` `SELL` * Price below market price: `STOP_LOSS` `SELL`, `TAKE_PROFIT` `BUY` * * @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-spot-trading/api/rest-api/trade#new-order Binance API Documentation} */ newOrder(requestParameters: NewOrderRequest): Promise>; /** * Reduce the quantity of an existing open order. * * This adds 0 orders to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read Order Amend Keep Priority FAQ to learn more. * * Weight(IP): 4 * * Unfilled Order Count: 0 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Order Amend Keep Priority (TRADE) * @param {OrderAmendKeepPriorityRequest} 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-spot-trading/api/rest-api/trade#order-amend-keep-priority Binance API Documentation} */ orderAmendKeepPriority(requestParameters: OrderAmendKeepPriorityRequest$1): Promise>; /** * - Cancels an existing order and places a new order on the same symbol. * - Filters and Order Count are evaluated before the processing of the cancellation and order placement occurs. * - A new order that was not attempted (i.e. when `newOrderResult: NOT_ATTEMPTED`), will still increase the unfilled order count by 1. * - You can only cancel an individual order from an orderList using this endpoint, but the result is the same as canceling the entire orderList. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Similar to `POST /api/v3/order`, additional mandatory parameters are determined by `type`. * Response format varies depending on whether the processing of the message succeeded, partially succeeded, or failed. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
RequestResponse
cancelReplaceModeorderRateLimitExceededModeUnfilled Order CountcancelResultnewOrderResultstatus
STOP_ON_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE➖ NOT_ATTEMPTEDN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits❌ FAILURE➖ NOT_ATTEMPTED429
✅ SUCCESS❌ FAILURE429
ALLOW_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE❌ FAILUREN/A
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILURE409
* **Notes:** * - The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel an Existing Order and Send a New Order (TRADE) * @param {OrderCancelReplaceRequest} 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-spot-trading/api/rest-api/trade#order-cancel-replace Binance API Documentation} */ orderCancelReplace(requestParameters: OrderCancelReplaceRequest$1): Promise>; /** * Send in an one-cancels-the-other (OCO) pair, where activation of one * order immediately cancels the other. * * - An OCO has 2 orders called the **above order** and **below order**. * - One of the orders must be a `LIMIT_MAKER/TAKE_PROFIT/TAKE_PROFIT_LIMIT` order and the other must be `STOP_LOSS` or `STOP_LOSS_LIMIT` order. * - Price restrictions * - If the OCO is on the `SELL` side: * - `LIMIT_MAKER/TAKE_PROFIT_LIMIT` `price` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT` `stopPrice` * - `TAKE_PROFIT stopPrice` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT stopPrice` * - If the OCO is on the `BUY` side: * - `LIMIT_MAKER/TAKE_PROFIT_LIMIT price` < Last Traded Price < `stopPrice` * - `TAKE_PROFIT stopPrice` < Last Traded Price < `STOP_LOSS/STOP_LOSS_LIMIT stopPrice` * OCOs add **2 orders** to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * - OCOs add 2 orders to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New Order list - OCO (TRADE) * @param {OrderListOcoRequest} 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-spot-trading/api/rest-api/trade#order-list-oco Binance API Documentation} */ orderListOco(requestParameters: OrderListOcoRequest): Promise>; /** * Place an [OPO](/products/spot/faqs/opo). * * - OPOs add 2 orders to the `EXCHANGE_MAX_NUM_ORDERS`` filter and `MAX_NUM_ORDERS`` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New Order List - OPO (TRADE) * @param {OrderListOpoRequest} 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-spot-trading/api/rest-api/trade#order-list-opo Binance API Documentation} */ orderListOpo(requestParameters: OrderListOpoRequest): Promise>; /** * Place an [OPOCO](/products/spot/faqs/opo). * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New Order List - OPOCO (TRADE) * @param {OrderListOpocoRequest} 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-spot-trading/api/rest-api/trade#order-list-opoco Binance API Documentation} */ orderListOpoco(requestParameters: OrderListOpocoRequest): Promise>; /** * Place an OTO. * * - An OTO (One-Triggers-the-Other) is an order list comprised of 2 orders. * - The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. * - The second order is called the **pending order**. It can be any order type except for `MARKET` orders using parameter `quoteOrderQty`. The pending order is only placed on the order book when the working order gets **fully filled**. * - If either the working order or the pending order is cancelled individually, the other order in the order list will also be canceled or expired. * - When the order list is placed, if the working order gets **immediately fully filled**, the placement response will show the working order as `FILLED` but the pending order will still appear as `PENDING_NEW`. You need to query the status of the pending order again to see its updated status. * - OTOs add **2 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingType` or `workingType`** * * Depending on the `pendingType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingType` = `LIMIT` |`pendingPrice`, `pendingTimeInForce` | * |`pendingType` = `STOP_LOSS` or `TAKE_PROFIT` |`pendingStopPrice` and/or `pendingTrailingDelta`| * |`pendingType` = `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`|`pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce`| * * @summary New Order list - OTO (TRADE) * @param {OrderListOtoRequest} 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-spot-trading/api/rest-api/trade#order-list-oto Binance API Documentation} */ orderListOto(requestParameters: OrderListOtoRequest): Promise>; /** * Place an OTOCO. * * - An OTOCO (One-Triggers-One-Cancels-the-Other) is an order list comprised of 3 orders. * - The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. * - The behavior of the working order is the same as the [OTO](#order-list-oto). * - OTOCO has 2 pending orders (pending above and pending below), forming an OCO pair. The pending orders are only placed on the order book when the working order gets **fully filled**. * - The rules of the pending above and pending below follow the same rules as the [Order list OCO](#order-list-oco). * - OTOCOs add **3 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingAboveType`, `pendingBelowType` or `workingType`** * * Depending on the `pendingAboveType`/`pendingBelowType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingAboveType`= `LIMIT_MAKER` |`pendingAbovePrice` | * |`pendingAboveType` = `STOP_LOSS/TAKE_PROFIT` |`pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`| * |`pendingAboveType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT` |`pendingAbovePrice`, `pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`, `pendingAboveTimeInForce`| * |`pendingBelowType`= `LIMIT_MAKER` |`pendingBelowPrice` | * |`pendingBelowType= STOP_LOSS/TAKE_PROFIT` |`pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`| * |`pendingBelowType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT` |`pendingBelowPrice`, `pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`, `pendingBelowTimeInForce`| * * @summary New Order list - OTOCO (TRADE) * @param {OrderListOtocoRequest} 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-spot-trading/api/rest-api/trade#order-list-otoco Binance API Documentation} */ orderListOtoco(requestParameters: OrderListOtocoRequest): Promise>; /** * Send in a new OCO. * * - Price Restrictions: * - `SELL`: Limit Price > Last Price > Stop Price * - `BUY`: Limit Price < Last Price < Stop Price * - Quantity Restrictions: * - Both legs must have the same quantity. * - `ICEBERG` quantities however do not have to be the same * - `OCO` adds **2 orders** to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New OCO - Deprecated (TRADE) * @param {OrderOcoRequest} 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-spot-trading/api/rest-api/trade#order-oco Binance API Documentation} */ orderOco(requestParameters: OrderOcoRequest): Promise>; /** * Test new order creation and signature/recvWindow long. * * Creates and validates a new order but does not send it into the matching * engine. * * Weight: |Condition|Weight| * |---|---| * |Without `computeCommissionRates`|1| * |With `computeCommissionRates`|20| * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order (TRADE) * @param {OrderTestRequest} 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-spot-trading/api/rest-api/trade#order-test Binance API Documentation} */ orderTest(requestParameters: OrderTestRequest$1): Promise>; /** * Places an order using smart order routing (SOR). * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read [SOR FAQ](/products/spot/faqs/sor_faq) to learn more. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Note:** `POST /api/v3/sor/order` only supports `LIMIT` and `MARKET` orders. `quoteOrderQty` is not supported. * * @summary New order using SOR (TRADE) * @param {SorOrderRequest} 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-spot-trading/api/rest-api/trade#sor-order Binance API Documentation} */ sorOrder(requestParameters: SorOrderRequest): Promise>; /** * Test new order creation and signature/recvWindow using smart order routing (SOR). * Creates and validates a new order but does not send it into the matching engine. * * Weight: |Condition|Weight| * |---|---| * |Without `computeCommissionRates`|1| * |With `computeCommissionRates`|20| * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order using SOR (TRADE) * @param {SorOrderTestRequest} 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-spot-trading/api/rest-api/trade#sor-order-test Binance API Documentation} */ sorOrderTest(requestParameters: SorOrderTestRequest$1): Promise>; } declare enum DeleteOrderCancelRestrictionsEnum { ONLY_NEW = "ONLY_NEW", ONLY_PARTIALLY_FILLED = "ONLY_PARTIALLY_FILLED", } declare enum NewOrderSideEnum { BUY = "BUY", SELL = "SELL", } declare enum NewOrderTypeEnum { MARKET = "MARKET", LIMIT = "LIMIT", STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum NewOrderTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum NewOrderNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum NewOrderSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum NewOrderPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum NewOrderPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderCancelReplaceSideEnum$1 { BUY = "BUY", SELL = "SELL", } declare enum OrderCancelReplaceTypeEnum$1 { MARKET = "MARKET", LIMIT = "LIMIT", STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderCancelReplaceCancelReplaceModeEnum$1 { STOP_ON_FAILURE = "STOP_ON_FAILURE", ALLOW_FAILURE = "ALLOW_FAILURE", } declare enum OrderCancelReplaceTimeInForceEnum$1 { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderCancelReplaceNewOrderRespTypeEnum$1 { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderCancelReplaceSelfTradePreventionModeEnum$1 { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderCancelReplaceCancelRestrictionsEnum$1 { ONLY_NEW = "ONLY_NEW", ONLY_PARTIALLY_FILLED = "ONLY_PARTIALLY_FILLED", } declare enum OrderCancelReplaceOrderRateLimitExceededModeEnum$1 { DO_NOTHING = "DO_NOTHING", CANCEL_ONLY = "CANCEL_ONLY", } declare enum OrderCancelReplacePegPriceTypeEnum$1 { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderCancelReplacePegOffsetTypeEnum$1 { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOcoSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListOcoAboveTypeEnum { STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", STOP_LOSS = "STOP_LOSS", LIMIT_MAKER = "LIMIT_MAKER", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListOcoBelowTypeEnum { STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListOcoAboveTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOcoAbovePegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOcoAbovePegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOcoBelowTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOcoBelowPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOcoBelowPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOcoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListOcoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListOpoWorkingTypeEnum { LIMIT = "LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListOpoWorkingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListOpoPendingTypeEnum { LIMIT = "LIMIT", MARKET = "MARKET", STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListOpoPendingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListOpoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListOpoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListOpoWorkingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOpoWorkingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOpoWorkingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOpoPendingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOpoPendingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOpoPendingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOpocoWorkingTypeEnum { LIMIT = "LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListOpocoWorkingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListOpocoPendingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListOpocoPendingAboveTypeEnum { STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", STOP_LOSS = "STOP_LOSS", LIMIT_MAKER = "LIMIT_MAKER", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListOpocoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListOpocoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListOpocoWorkingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOpocoWorkingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOpocoWorkingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOpocoPendingAboveTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOpocoPendingAbovePegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOpocoPendingAbovePegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOpocoPendingBelowTypeEnum { STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListOpocoPendingBelowTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOpocoPendingBelowPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOpocoPendingBelowPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOtoWorkingTypeEnum { LIMIT = "LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListOtoWorkingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListOtoPendingTypeEnum { LIMIT = "LIMIT", MARKET = "MARKET", STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListOtoPendingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListOtoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListOtoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListOtoWorkingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOtoWorkingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOtoWorkingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOtoPendingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOtoPendingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOtoPendingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOtocoWorkingTypeEnum { LIMIT = "LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListOtocoWorkingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListOtocoPendingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListOtocoPendingAboveTypeEnum { STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", STOP_LOSS = "STOP_LOSS", LIMIT_MAKER = "LIMIT_MAKER", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListOtocoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListOtocoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListOtocoWorkingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOtocoWorkingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOtocoWorkingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOtocoPendingAboveTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOtocoPendingAbovePegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOtocoPendingAbovePegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListOtocoPendingBelowTypeEnum { STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListOtocoPendingBelowTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListOtocoPendingBelowPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListOtocoPendingBelowPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderOcoSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderOcoStopLimitTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderOcoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderOcoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderTestSideEnum$1 { BUY = "BUY", SELL = "SELL", } declare enum OrderTestTypeEnum$1 { MARKET = "MARKET", LIMIT = "LIMIT", STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderTestTimeInForceEnum$1 { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderTestNewOrderRespTypeEnum$1 { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderTestSelfTradePreventionModeEnum$1 { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderTestPegPriceTypeEnum$1 { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderTestPegOffsetTypeEnum$1 { PRICE_LEVEL = "PRICE_LEVEL", } declare enum SorOrderSideEnum { BUY = "BUY", SELL = "SELL", } declare enum SorOrderTypeEnum { MARKET = "MARKET", LIMIT = "LIMIT", } declare enum SorOrderTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum SorOrderNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum SorOrderSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum SorOrderTestSideEnum$1 { BUY = "BUY", SELL = "SELL", } declare enum SorOrderTestTypeEnum$1 { MARKET = "MARKET", LIMIT = "LIMIT", } declare enum SorOrderTestTimeInForceEnum$1 { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum SorOrderTestNewOrderRespTypeEnum$1 { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum SorOrderTestSelfTradePreventionModeEnum$1 { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } //#endregion //#region src/rest-api/rest-api.d.ts declare class RestAPI { private configuration; private accountApi; private generalApi; private marketApi; private tradeApi; 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. * @param timeUnit - The time unit 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, timeUnit?: TimeUnit$1): 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. * @param timeUnit - The time unit 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, timeUnit?: TimeUnit$1): Promise>; /** * Get current account commission rates. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Commission Rates (USER_DATA) * @param {AccountCommissionRequest} 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-spot-trading/api/rest-api/account#account-commission Binance API Documentation} */ accountCommission(requestParameters: AccountCommissionRequest$1): Promise>; /** * Retrieves all order lists based on provided optional parameters. * * Note that the time between `startTime` and `endTime` can't be longer * than 24 hours. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query all Order lists (USER_DATA) * @param {AllOrderListRequest} 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-spot-trading/api/rest-api/account#all-order-list Binance API Documentation} */ allOrderList(requestParameters?: AllOrderListRequest): Promise>; /** * Get all account orders; active, canceled, or filled. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * - If `orderId` is set, it will get orders >= that `orderId`. Otherwise most recent orders are returned. * - For some historical orders `cummulativeQuoteQty` will be < 0, meaning the data is not available at this time. * - If `startTime` and/or `endTime` provided, `orderId` is not required. * - The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary All orders (USER_DATA) * @param {AllOrdersRequest} requestParameters Request parameters. * * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/account#all-orders Binance API Documentation} */ allOrders(requestParameters: AllOrdersRequest$1): Promise>; /** * Get current account information. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * @summary Account information (USER_DATA) * @param {GetAccountRequest} 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-spot-trading/api/rest-api/account#get-account Binance API Documentation} */ getAccount(requestParameters?: GetAccountRequest): Promise>; /** * Get all open orders on a symbol. **Careful** when accessing this with no symbol. * * Weight: 6 for a single symbol; 80 when the symbol parameter is omitted * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * - If the symbol is not sent, orders for all symbols will be returned in an array. * * @summary Current open orders (USER_DATA) * @param {GetOpenOrdersRequest} 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-spot-trading/api/rest-api/account#get-open-orders Binance API Documentation} */ getOpenOrders(requestParameters?: GetOpenOrdersRequest): Promise>; /** * Check an order's status. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * - Either `orderId` or `origClientOrderId` must be sent. * - If both `orderId` and `origClientOrderId` are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * - For some historical orders `cummulativeQuoteQty` will be < 0, meaning the data is not available at this time. * * @summary Query order (USER_DATA) * @param {GetOrderRequest} 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-spot-trading/api/rest-api/account#get-order Binance API Documentation} */ getOrder(requestParameters: GetOrderRequest): Promise>; /** * Retrieves a specific order list based on provided optional parameters. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Order list (USER_DATA) * @param {GetOrderListRequest} 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-spot-trading/api/rest-api/account#get-order-list Binance API Documentation} */ getOrderList(requestParameters?: GetOrderListRequest): Promise>; /** * Retrieves allocations resulting from SOR order placement. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database" * * Supported parameter combinations: * * Parameters | Response | * ------------------------------------------- | -------- | * `symbol` | allocations from oldest to newest | * `symbol` + `startTime` | oldest allocations since `startTime` | * `symbol` + `endTime` | newest allocations until `endTime` | * `symbol` + `startTime` + `endTime` | allocations within the time range | * `symbol` + `fromAllocationId` | allocations by allocation ID | * `symbol` + `orderId` | allocations related to an order starting with oldest | * `symbol` + `orderId` + `fromAllocationId` | allocations related to an order by allocation ID | * **Note:** The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Query Allocations (USER_DATA) * @param {MyAllocationsRequest} 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-spot-trading/api/rest-api/account#my-allocations Binance API Documentation} */ myAllocations(requestParameters: MyAllocationsRequest$1): Promise>; /** * Retrieves the list of filters relevant to an account on a given symbol. This is the only endpoint that shows if an account has `MAX_ASSET` filters applied to it. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Query relevant filters (USER_DATA) * @param {MyFiltersRequest} 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-spot-trading/api/rest-api/account#my-filters Binance API Documentation} */ myFilters(requestParameters: MyFiltersRequest$1): Promise>; /** * Displays the list of orders that were expired due to STP. * * These are the combinations supported: * - `symbol` + `preventedMatchId` * - `symbol` + `orderId` * - `symbol` + `orderId` + `fromPreventedMatchId` (`limit` will default to 500) * - `symbol` + `orderId` + `fromPreventedMatchId` + `limit` * * Weight: Case | Weight * ---- | ----- * If `symbol` is invalid | 2 * Querying by `preventedMatchId` | 2 * Querying by `orderId` | 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Prevented Matches (USER_DATA) * @param {MyPreventedMatchesRequest} 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-spot-trading/api/rest-api/account#my-prevented-matches Binance API Documentation} */ myPreventedMatches(requestParameters: MyPreventedMatchesRequest$1): Promise>; /** * Get trades for a specific account and symbol. * * Weight: Condition| Weight| * ---| --- * |Without orderId|20| * |With orderId|5| * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * **Notes:**: * - If `fromId` is set, it will get trades >= that `fromId`. Otherwise most recent trades are returned. * - The time between `startTime` and `endTime` can't be longer than 24 hours. * - These are the supported combinations of all parameters: * - `symbol` * - `symbol` + `orderId` * - `symbol` + `startTime` * - `symbol` + `endTime` * - `symbol` + `fromId` * - `symbol` + `startTime` + `endTime` * - `symbol`+ `orderId` + `fromId` * * @summary Account trade list (USER_DATA) * @param {MyTradesRequest} 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-spot-trading/api/rest-api/account#my-trades Binance API Documentation} */ myTrades(requestParameters: MyTradesRequest$1): Promise>; /** * Query Open Order lists * * Weight(IP): 6 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory -> Database * * @summary Query Open Order lists (USER_DATA) * @param {OpenOrderListRequest} 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-spot-trading/api/rest-api/account#open-order-list Binance API Documentation} */ openOrderList(requestParameters?: OpenOrderListRequest): Promise>; /** * Queries all amendments of a single order. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Order Amendments (USER_DATA) * @param {OrderAmendmentsRequest} 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-spot-trading/api/rest-api/account#order-amendments Binance API Documentation} */ orderAmendments(requestParameters: OrderAmendmentsRequest$1): Promise>; /** * Displays the user's unfilled order count for all intervals. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Query Unfilled Order Count (USER_DATA) * @param {RateLimitOrderRequest} 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-spot-trading/api/rest-api/account#rate-limit-order Binance API Documentation} */ rateLimitOrder(requestParameters?: RateLimitOrderRequest): Promise>; /** * Current exchange trading rules and symbol information * * Weight(IP): 20 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Notes:** * If the value provided to `symbol` or `symbols` do not exist, the endpoint will throw an error saying the symbol is invalid. * All parameters are optional. * `permissions` can support single or multiple values (e.g. `SPOT`, `["MARGIN","LEVERAGED"]`). This cannot be used in combination with `symbol` or `symbols`. * If `permissions` parameter not provided, all symbols that have either `SPOT`, `MARGIN`, or `LEVERAGED` permission will be exposed. * To display symbols with any permission you need to specify them explicitly in `permissions`: (e.g. `["SPOT","MARGIN",...]`.). See Account and Symbol Permissions for the full list. * **Examples of Symbol Permissions Interpretation from the Response:** * * `[["A","B"]]` means you may place an order if your account has either permission "A" **or** permission "B". * `[["A"],["B"]]` means you can place an order if your account has permission "A" **and** permission "B". * `[["A"],["B","C"]]` means you can place an order if your account has permission "A" **and** permission "B" or permission "C". (Inclusive or is applied here, not exclusive or, so your account may have both permission "B" and permission "C".) * * @summary Exchange information * @param {ExchangeInfoRequest} 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-spot-trading/api/rest-api/general#exchange-info Binance API Documentation} */ exchangeInfo(requestParameters?: ExchangeInfoRequest$1): Promise>; /** * Query execution rules for symbols. * * Weight: Parameter | Weight * --- | --- * `symbol` | 2 * `symbols` | 2 for each `symbol`, capped at a max of 40 * `symbolStatus` | 40 * None | 40 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Note:**: No combination of multiple parameters is allowed. * * @summary Query Execution Rules * @param {ExecutionRulesRequest} 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-spot-trading/api/rest-api/general#execution-rules Binance API Documentation} */ executionRules(requestParameters?: ExecutionRulesRequest$1): Promise>; /** * Test connectivity to the Rest API. * * Weight(IP): 1 * * Security Type: NONE * * @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-spot-trading/api/rest-api/general#ping Binance API Documentation} */ ping(): Promise>; /** * Test connectivity to the Rest API and get the current server time. * * Weight(IP): 1 * * Security Type: NONE * * @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-spot-trading/api/rest-api/general#time Binance API Documentation} */ time(): Promise>; /** * Get compressed, aggregate trades. Trades that fill at the time, from the same taker order, with the same price will have the quantity aggregated. * * Weight(IP): 4 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If fromId, startTime, and endTime are not sent, the most recent aggregate trades will be returned. * * @summary Compressed/Aggregate trades list * @param {AggTradesRequest} 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-spot-trading/api/rest-api/market#agg-trades Binance API Documentation} */ aggTrades(requestParameters: AggTradesRequest): Promise>; /** * Current average price for a symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Current average price * @param {AvgPriceRequest} 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-spot-trading/api/rest-api/market#avg-price Binance API Documentation} */ avgPrice(requestParameters: AvgPriceRequest$2): Promise>; /** * Order book * * Weight: Adjusted based on the limit: * * |Limit|Request Weight * ------|------- * 1-100| 5 * 101-500| 25 * 501-1000| 50 * 1001-5000| 250 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Order book * @param {DepthRequest} 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-spot-trading/api/rest-api/market#depth Binance API Documentation} */ depth(requestParameters: DepthRequest$1): Promise>; /** * Get recent trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Recent trades list * @param {GetTradesRequest} 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-spot-trading/api/rest-api/market#get-trades Binance API Documentation} */ getTrades(requestParameters: GetTradesRequest): Promise>; /** * Get block trades. * * Weight(IP): 25 * * Security Type: MARKET_DATA * * Notes: * - Data Source: Database * * @summary Historical Block Trades (MARKET_DATA) * @param {HistoricalBlockTradesRequest} 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-spot-trading/api/rest-api/market#historical-block-trades Binance API Documentation} */ historicalBlockTrades(requestParameters: HistoricalBlockTradesRequest): Promise>; /** * Get older trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Database * * @summary Old trade lookup * @param {HistoricalTradesRequest} 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-spot-trading/api/rest-api/market#historical-trades Binance API Documentation} */ historicalTrades(requestParameters: HistoricalTradesRequest): Promise>; /** * Kline/candlestick bars for a symbol. * Klines are uniquely identified by their open time. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * Supported kline intervals (case-sensitive): * * Interval | `interval` value * --------- | ---------------- * seconds | `1s` * minutes | `1m`, `3m`, `5m`, `15m`, `30m` * hours | `1h`, `2h`, `4h`, `6h`, `8h`, `12h` * days | `1d`, `3d` * weeks | `1w` * months | `1M` * **Notes:** * * If `startTime` and `endTime` are not sent, the most recent klines are returned. * Supported values for `timeZone`: * Hours and minutes (e.g. `-1:00`, `05:45`) * Only hours (e.g. `0`, `8`, `4`) * Accepted range is strictly [-12:00 to +14:00] inclusive * If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary Kline/Candlestick data * @param {KlinesRequest} 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-spot-trading/api/rest-api/market#klines Binance API Documentation} */ klines(requestParameters: KlinesRequest$1): Promise>; /** * Query the reference price for a symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price * @param {ReferencePriceRequest} 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-spot-trading/api/rest-api/market#reference-price Binance API Documentation} */ referencePrice(requestParameters: ReferencePriceRequest$2): Promise>; /** * Describes how reference price is calculated for a given symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price Calculation * @param {ReferencePriceCalculationRequest} 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-spot-trading/api/rest-api/market#reference-price-calculation Binance API Documentation} */ referencePriceCalculation(requestParameters: ReferencePriceCalculationRequest$1): Promise>; /** * **Note:** This endpoint differs from `GET /api/v3/ticker/24hr`. * * The statistical time range of this endpoint can be up to 59999ms longer * than the requested `windowSize`. * * `openTime` starts at the beginning of a minute, while the end time is * the current time. Therefore, the actual interval can be up to 59999ms * longer than the requested window. * * For example, if `closeTime` is 1641287867099 (January 04, 2022 * 09:17:47:099 UTC) and `windowSize` is `1d`, then `openTime` is * 1641201420000 (January 3, 2022, 09:17:00 UTC). * * Weight: 4 for each requested symbol regardless of windowSize. * * The weight for this request will cap at 200 once the number of `symbols` in the request is more than 50. * * Security Type: NONE * * Notes: **Data Source:** Database * * @summary Rolling window price change statistics * @param {TickerRequest} 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-spot-trading/api/rest-api/market#ticker Binance API Documentation} */ ticker(requestParameters?: TickerRequest$2): Promise>; /** * 24 hour rolling window price change statistics. **Careful** when accessing this with no symbol. * * Weight: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
ParameterSymbols ProvidedWeight
symbol12
symbol parameter is omitted80
symbols1-202
21-10040
101 or more80
symbols parameter is omitted80
* * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary 24hr ticker price change statistics * @param {Ticker24hrRequest} 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-spot-trading/api/rest-api/market#ticker24hr Binance API Documentation} */ ticker24hr(requestParameters?: Ticker24hrRequest$1): Promise>; /** * Best price/qty on the order book for a symbol or symbols. * * Weight: |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Symbol order book ticker * @param {TickerBookTickerRequest} 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-spot-trading/api/rest-api/market#ticker-book-ticker Binance API Documentation} */ tickerBookTicker(requestParameters?: TickerBookTickerRequest): Promise>; /** * Latest price for a symbol or symbols. * * Weight: |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Symbol price ticker * @param {TickerPriceRequest} 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-spot-trading/api/rest-api/market#ticker-price Binance API Documentation} */ tickerPrice(requestParameters?: TickerPriceRequest$1): Promise>; /** * Price change statistics for a trading day. * * Weight: 4 for each requested symbol. The weight for this request will cap at 200 once the number of symbols in the request is more than 50. * * Security Type: NONE * * Notes: **Data Source:** Database * **Notes:**: * - Supported values for `timeZone`: * - Hours and minutes (e.g. `-1:00`, `05:45`) * - Only hours (e.g. `0`, `8`, `4`) * * @summary Trading Day Ticker * @param {TickerTradingDayRequest} 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-spot-trading/api/rest-api/market#ticker-trading-day Binance API Documentation} */ tickerTradingDay(requestParameters?: TickerTradingDayRequest$1): Promise>; /** * The request is similar to klines having the same parameters and * response. * * `uiKlines` return modified kline data, optimized for presentation of * candlestick charts. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If `startTime` and `endTime` are not sent, the most recent klines are returned. * - Supported values for `timeZone`: * - Hours and minutes (e.g. `-1:00`, `05:45`) * - Only hours (e.g. `0`, `8`, `4`) * - Accepted range is strictly [-12:00 to +14:00] inclusive * - If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * - Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary UIKlines * @param {UiKlinesRequest} 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-spot-trading/api/rest-api/market#ui-klines Binance API Documentation} */ uiKlines(requestParameters: UiKlinesRequest$1): Promise>; /** * Cancels all active orders on a symbol. * This includes orders that are part of an order list. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Cancel All Open Orders on a Symbol (TRADE) * @param {DeleteOpenOrdersRequest} 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-spot-trading/api/rest-api/trade#delete-open-orders Binance API Documentation} */ deleteOpenOrders(requestParameters: DeleteOpenOrdersRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * - Either `orderId` or `origClientOrderId` must be sent. * - If both `orderId` and `origClientOrderId` are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * - The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel order (TRADE) * @param {DeleteOrderRequest} 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-spot-trading/api/rest-api/trade#delete-order Binance API Documentation} */ deleteOrder(requestParameters: DeleteOrderRequest): Promise>; /** * Cancel an entire Order list * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Notes:** * - Canceling an individual order from an order list will cancel the entire order list. * - If both orderListId and listClientOrderId parameters are provided, the orderListId is searched first, then the listClientOrderId from that result is checked against that order. If both conditions are not met the request will be rejected. * * @summary Cancel Order list (TRADE) * @param {DeleteOrderListRequest} 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-spot-trading/api/rest-api/trade#delete-order-list Binance API Documentation} */ deleteOrderList(requestParameters: DeleteOrderListRequest): Promise>; /** * Send in a new order. * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Some additional mandatory parameters based on order `type`: * * Type | Additional mandatory parameters | Additional Information * ------------ | ------------| ------ * `LIMIT` | `timeInForce`, `quantity`, `price`| * `MARKET` | `quantity` or `quoteOrderQty`| `MARKET` orders using the `quantity` field specifies the amount of the `base asset` the user wants to buy or sell at the market price.
E.g. MARKET order on BTCUSDT will specify how much BTC the user is buying or selling.

`MARKET` orders using `quoteOrderQty` specifies the amount the user wants to spend (when buying) or receive (when selling) the `quote` asset; the correct `quantity` will be determined based on the market liquidity and `quoteOrderQty`.
E.g. Using the symbol BTCUSDT:
`BUY` side, the order will buy as many BTC as `quoteOrderQty` USDT can.
`SELL` side, the order will sell as much BTC needed to receive `quoteOrderQty` USDT. * `STOP_LOSS` | `quantity`, `stopPrice` or `trailingDelta`| This will execute a `MARKET` order when the conditions are met. (e.g. `stopPrice` is met or `trailingDelta` is activated) * `STOP_LOSS_LIMIT` | `timeInForce`, `quantity`, `price`, `stopPrice` or `trailingDelta` * `TAKE_PROFIT` | `quantity`, `stopPrice` or `trailingDelta` | This will execute a `MARKET` order when the conditions are met. (e.g. `stopPrice` is met or `trailingDelta` is activated) * `TAKE_PROFIT_LIMIT` | `timeInForce`, `quantity`, `price`, `stopPrice` or `trailingDelta` | * `LIMIT_MAKER` | `quantity`, `price`| This is a `LIMIT` order that will be rejected if the order immediately matches and trades as a taker.
This is also known as a POST-ONLY order. * * * Notes on using parameters for Pegged Orders: * These parameters are allowed for `LIMIT`, `LIMIT_MAKER`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_LIMIT` orders. * If `pegPriceType` is specified, `price` becomes optional. Otherwise, it is still mandatory. * `pegPriceType=PRIMARY_PEG` means the primary peg, that is the best price on the same side of the order book as your order. * `pegPriceType=MARKET_PEG` means the market peg, that is the best price on the opposite side of the order book from your order. * Use `pegOffsetType` and `pegOffsetValue` to request a price level other than the best one. These parameters must be specified together. * * Other info: * Any `LIMIT` or `LIMIT_MAKER` type order can be made an iceberg order by sending an `icebergQty`. * Any order with an `icebergQty` MUST have `timeInForce` set to `GTC`. * For `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_LIMIT` and `TAKE_PROFIT` orders, `trailingDelta` can be combined with `stopPrice`. * `MARKET` orders using `quoteOrderQty` will not break `LOT_SIZE` filter rules; the order will execute a `quantity` that will have the notional value as close as possible to `quoteOrderQty`. Trigger order price rules against market price for both MARKET and LIMIT versions: * Price above market price: `STOP_LOSS` `BUY`, `TAKE_PROFIT` `SELL` * Price below market price: `STOP_LOSS` `SELL`, `TAKE_PROFIT` `BUY` * * @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-spot-trading/api/rest-api/trade#new-order Binance API Documentation} */ newOrder(requestParameters: NewOrderRequest): Promise>; /** * Reduce the quantity of an existing open order. * * This adds 0 orders to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read Order Amend Keep Priority FAQ to learn more. * * Weight(IP): 4 * * Unfilled Order Count: 0 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Order Amend Keep Priority (TRADE) * @param {OrderAmendKeepPriorityRequest} 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-spot-trading/api/rest-api/trade#order-amend-keep-priority Binance API Documentation} */ orderAmendKeepPriority(requestParameters: OrderAmendKeepPriorityRequest$1): Promise>; /** * - Cancels an existing order and places a new order on the same symbol. * - Filters and Order Count are evaluated before the processing of the cancellation and order placement occurs. * - A new order that was not attempted (i.e. when `newOrderResult: NOT_ATTEMPTED`), will still increase the unfilled order count by 1. * - You can only cancel an individual order from an orderList using this endpoint, but the result is the same as canceling the entire orderList. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Similar to `POST /api/v3/order`, additional mandatory parameters are determined by `type`. * Response format varies depending on whether the processing of the message succeeded, partially succeeded, or failed. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
RequestResponse
cancelReplaceModeorderRateLimitExceededModeUnfilled Order CountcancelResultnewOrderResultstatus
STOP_ON_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE➖ NOT_ATTEMPTEDN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits❌ FAILURE➖ NOT_ATTEMPTED429
✅ SUCCESS❌ FAILURE429
ALLOW_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE❌ FAILUREN/A
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILURE409
* **Notes:** * - The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel an Existing Order and Send a New Order (TRADE) * @param {OrderCancelReplaceRequest} 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-spot-trading/api/rest-api/trade#order-cancel-replace Binance API Documentation} */ orderCancelReplace(requestParameters: OrderCancelReplaceRequest$1): Promise>; /** * Send in an one-cancels-the-other (OCO) pair, where activation of one * order immediately cancels the other. * * - An OCO has 2 orders called the **above order** and **below order**. * - One of the orders must be a `LIMIT_MAKER/TAKE_PROFIT/TAKE_PROFIT_LIMIT` order and the other must be `STOP_LOSS` or `STOP_LOSS_LIMIT` order. * - Price restrictions * - If the OCO is on the `SELL` side: * - `LIMIT_MAKER/TAKE_PROFIT_LIMIT` `price` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT` `stopPrice` * - `TAKE_PROFIT stopPrice` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT stopPrice` * - If the OCO is on the `BUY` side: * - `LIMIT_MAKER/TAKE_PROFIT_LIMIT price` < Last Traded Price < `stopPrice` * - `TAKE_PROFIT stopPrice` < Last Traded Price < `STOP_LOSS/STOP_LOSS_LIMIT stopPrice` * OCOs add **2 orders** to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * - OCOs add 2 orders to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New Order list - OCO (TRADE) * @param {OrderListOcoRequest} 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-spot-trading/api/rest-api/trade#order-list-oco Binance API Documentation} */ orderListOco(requestParameters: OrderListOcoRequest): Promise>; /** * Place an [OPO](/products/spot/faqs/opo). * * - OPOs add 2 orders to the `EXCHANGE_MAX_NUM_ORDERS`` filter and `MAX_NUM_ORDERS`` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New Order List - OPO (TRADE) * @param {OrderListOpoRequest} 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-spot-trading/api/rest-api/trade#order-list-opo Binance API Documentation} */ orderListOpo(requestParameters: OrderListOpoRequest): Promise>; /** * Place an [OPOCO](/products/spot/faqs/opo). * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New Order List - OPOCO (TRADE) * @param {OrderListOpocoRequest} 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-spot-trading/api/rest-api/trade#order-list-opoco Binance API Documentation} */ orderListOpoco(requestParameters: OrderListOpocoRequest): Promise>; /** * Place an OTO. * * - An OTO (One-Triggers-the-Other) is an order list comprised of 2 orders. * - The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. * - The second order is called the **pending order**. It can be any order type except for `MARKET` orders using parameter `quoteOrderQty`. The pending order is only placed on the order book when the working order gets **fully filled**. * - If either the working order or the pending order is cancelled individually, the other order in the order list will also be canceled or expired. * - When the order list is placed, if the working order gets **immediately fully filled**, the placement response will show the working order as `FILLED` but the pending order will still appear as `PENDING_NEW`. You need to query the status of the pending order again to see its updated status. * - OTOs add **2 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingType` or `workingType`** * * Depending on the `pendingType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingType` = `LIMIT` |`pendingPrice`, `pendingTimeInForce` | * |`pendingType` = `STOP_LOSS` or `TAKE_PROFIT` |`pendingStopPrice` and/or `pendingTrailingDelta`| * |`pendingType` = `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`|`pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce`| * * @summary New Order list - OTO (TRADE) * @param {OrderListOtoRequest} 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-spot-trading/api/rest-api/trade#order-list-oto Binance API Documentation} */ orderListOto(requestParameters: OrderListOtoRequest): Promise>; /** * Place an OTOCO. * * - An OTOCO (One-Triggers-One-Cancels-the-Other) is an order list comprised of 3 orders. * - The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. * - The behavior of the working order is the same as the [OTO](#order-list-oto). * - OTOCO has 2 pending orders (pending above and pending below), forming an OCO pair. The pending orders are only placed on the order book when the working order gets **fully filled**. * - The rules of the pending above and pending below follow the same rules as the [Order list OCO](#order-list-oco). * - OTOCOs add **3 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingAboveType`, `pendingBelowType` or `workingType`** * * Depending on the `pendingAboveType`/`pendingBelowType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingAboveType`= `LIMIT_MAKER` |`pendingAbovePrice` | * |`pendingAboveType` = `STOP_LOSS/TAKE_PROFIT` |`pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`| * |`pendingAboveType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT` |`pendingAbovePrice`, `pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`, `pendingAboveTimeInForce`| * |`pendingBelowType`= `LIMIT_MAKER` |`pendingBelowPrice` | * |`pendingBelowType= STOP_LOSS/TAKE_PROFIT` |`pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`| * |`pendingBelowType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT` |`pendingBelowPrice`, `pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`, `pendingBelowTimeInForce`| * * @summary New Order list - OTOCO (TRADE) * @param {OrderListOtocoRequest} 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-spot-trading/api/rest-api/trade#order-list-otoco Binance API Documentation} */ orderListOtoco(requestParameters: OrderListOtocoRequest): Promise>; /** * Send in a new OCO. * * - Price Restrictions: * - `SELL`: Limit Price > Last Price > Stop Price * - `BUY`: Limit Price < Last Price < Stop Price * - Quantity Restrictions: * - Both legs must have the same quantity. * - `ICEBERG` quantities however do not have to be the same * - `OCO` adds **2 orders** to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary New OCO - Deprecated (TRADE) * @param {OrderOcoRequest} requestParameters Request parameters. * @deprecated * @returns {Promise>} * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/rest-api/trade#order-oco Binance API Documentation} */ orderOco(requestParameters: OrderOcoRequest): Promise>; /** * Test new order creation and signature/recvWindow long. * * Creates and validates a new order but does not send it into the matching * engine. * * Weight: |Condition|Weight| * |---|---| * |Without `computeCommissionRates`|1| * |With `computeCommissionRates`|20| * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order (TRADE) * @param {OrderTestRequest} 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-spot-trading/api/rest-api/trade#order-test Binance API Documentation} */ orderTest(requestParameters: OrderTestRequest$1): Promise>; /** * Places an order using smart order routing (SOR). * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read [SOR FAQ](/products/spot/faqs/sor_faq) to learn more. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Note:** `POST /api/v3/sor/order` only supports `LIMIT` and `MARKET` orders. `quoteOrderQty` is not supported. * * @summary New order using SOR (TRADE) * @param {SorOrderRequest} 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-spot-trading/api/rest-api/trade#sor-order Binance API Documentation} */ sorOrder(requestParameters: SorOrderRequest): Promise>; /** * Test new order creation and signature/recvWindow using smart order routing (SOR). * Creates and validates a new order but does not send it into the matching engine. * * Weight: |Condition|Weight| * |---|---| * |Without `computeCommissionRates`|1| * |With `computeCommissionRates`|20| * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order using SOR (TRADE) * @param {SorOrderTestRequest} 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-spot-trading/api/rest-api/trade#sor-order-test Binance API Documentation} */ sorOrderTest(requestParameters: SorOrderTestRequest$1): Promise>; } declare namespace index_d_exports { export { AccountApi$1 as AccountApi, AccountApiInterface$1 as AccountApiInterface, AccountCommissionRequest$1 as AccountCommissionRequest, AccountCommissionResponse$1 as AccountCommissionResponse, AccountCommissionResponseDiscount, AccountCommissionResponseSpecialCommission, AccountCommissionResponseStandardCommission, AccountCommissionResponseTaxCommission, AggTradesRequest, AggTradesResponse, AggTradesResponseInner, AllOrderListRequest, AllOrderListResponse, AllOrderListResponseInner, AllOrderListResponseInnerOrdersInner, AllOrdersRequest$1 as AllOrdersRequest, AllOrdersResponse$1 as AllOrdersResponse, AllOrdersResponseInner, AvgPriceRequest$2 as AvgPriceRequest, AvgPriceResponse$2 as AvgPriceResponse, DeleteOpenOrdersRequest, DeleteOpenOrdersResponse, DeleteOpenOrdersResponseInner, DeleteOrderCancelRestrictionsEnum, DeleteOrderListRequest, DeleteOrderListResponse, DeleteOrderListResponseOrderReportsInner, DeleteOrderListResponseOrdersInner, DeleteOrderRequest, DeleteOrderResponse, DepthRequest$1 as DepthRequest, DepthResponse$1 as DepthResponse, DepthSymbolStatusEnum$1 as DepthSymbolStatusEnum, ExchangeFilters$1 as ExchangeFilters, ExchangeInfoPermissionsEnum, ExchangeInfoRequest$1 as ExchangeInfoRequest, ExchangeInfoResponse$1 as ExchangeInfoResponse, ExchangeInfoResponseSorsInner$1 as ExchangeInfoResponseSorsInner, ExchangeInfoResponseSymbolsInner$1 as ExchangeInfoResponseSymbolsInner, ExchangeInfoSymbolStatusEnum$1 as ExchangeInfoSymbolStatusEnum, ExchangeMaxNumAlgoOrdersFilter$1 as ExchangeMaxNumAlgoOrdersFilter, ExchangeMaxNumIcebergOrdersFilter$1 as ExchangeMaxNumIcebergOrdersFilter, ExchangeMaxNumOrderListsFilter$1 as ExchangeMaxNumOrderListsFilter, ExchangeMaxNumOrdersFilter$1 as ExchangeMaxNumOrdersFilter, ExecutionRulesRequest$1 as ExecutionRulesRequest, ExecutionRulesResponse$1 as ExecutionRulesResponse, ExecutionRulesResponseSymbolRulesInner, ExecutionRulesResponseSymbolRulesInnerRulesInner, ExecutionRulesSymbolStatusEnum$1 as ExecutionRulesSymbolStatusEnum, GeneralApi$1 as GeneralApi, GeneralApiInterface$1 as GeneralApiInterface, GetAccountRequest, GetAccountResponse, GetAccountResponseBalancesInner, GetAccountResponseCommissionRates, GetOpenOrdersRequest, GetOpenOrdersResponse, GetOpenOrdersResponseInner, GetOrderListRequest, GetOrderListResponse, GetOrderListResponseOrdersInner, GetOrderRequest, GetOrderResponse, GetTradesRequest, GetTradesResponse, GetTradesResponseInner, HistoricalBlockTradesRequest, HistoricalBlockTradesResponse, HistoricalBlockTradesResponseInner, HistoricalTradesRequest, HistoricalTradesResponse, IcebergPartsFilter$1 as IcebergPartsFilter, KlinesIntervalEnum$1 as KlinesIntervalEnum, KlinesItem, KlinesItemInner, KlinesRequest$1 as KlinesRequest, KlinesResponse$1 as KlinesResponse, LotSizeFilter$1 as LotSizeFilter, MarketApi$1 as MarketApi, MarketApiInterface$1 as MarketApiInterface, MarketLotSizeFilter$1 as MarketLotSizeFilter, MaxAssetFilter$1 as MaxAssetFilter, MaxNumAlgoOrdersFilter$1 as MaxNumAlgoOrdersFilter, MaxNumIcebergOrdersFilter$1 as MaxNumIcebergOrdersFilter, MaxNumOrderAmendsFilter$1 as MaxNumOrderAmendsFilter, MaxNumOrderListsFilter$1 as MaxNumOrderListsFilter, MaxNumOrdersFilter$1 as MaxNumOrdersFilter, MaxPositionFilter$1 as MaxPositionFilter, MinNotionalFilter$1 as MinNotionalFilter, MyAllocationsRequest$1 as MyAllocationsRequest, MyAllocationsResponse$1 as MyAllocationsResponse, MyAllocationsResponseInner, MyFiltersRequest$1 as MyFiltersRequest, MyFiltersResponse$1 as MyFiltersResponse, MyFiltersResponseAssetFiltersInner, MyFiltersResponseExchangeFiltersInner, MyFiltersResponseRateLimitsInner, MyFiltersResponseSymbolFiltersInner, MyPreventedMatchesRequest$1 as MyPreventedMatchesRequest, MyPreventedMatchesResponse$1 as MyPreventedMatchesResponse, MyPreventedMatchesResponseInner, MyTradesRequest$1 as MyTradesRequest, MyTradesResponse$1 as MyTradesResponse, MyTradesResponseInner, NewOrderNewOrderRespTypeEnum, NewOrderPegOffsetTypeEnum, NewOrderPegPriceTypeEnum, NewOrderRequest, NewOrderResponse, NewOrderResponseFillsInner, NewOrderSelfTradePreventionModeEnum, NewOrderSideEnum, NewOrderTimeInForceEnum, NewOrderTypeEnum, NotionalFilter$1 as NotionalFilter, OpenOrderListRequest, OpenOrderListResponse, OpenOrderListResponseInner, OpenOrderListResponseInnerOrdersInner, OrderAmendKeepPriorityRequest$1 as OrderAmendKeepPriorityRequest, OrderAmendKeepPriorityResponse$1 as OrderAmendKeepPriorityResponse, OrderAmendKeepPriorityResponseAmendedOrder, OrderAmendKeepPriorityResponseListStatus, OrderAmendKeepPriorityResponseListStatusOrdersInner, OrderAmendmentsRequest$1 as OrderAmendmentsRequest, OrderAmendmentsResponse$1 as OrderAmendmentsResponse, OrderAmendmentsResponseInner, OrderCancelReplaceCancelReplaceModeEnum$1 as OrderCancelReplaceCancelReplaceModeEnum, OrderCancelReplaceCancelRestrictionsEnum$1 as OrderCancelReplaceCancelRestrictionsEnum, OrderCancelReplaceNewOrderRespTypeEnum$1 as OrderCancelReplaceNewOrderRespTypeEnum, OrderCancelReplaceOrderRateLimitExceededModeEnum$1 as OrderCancelReplaceOrderRateLimitExceededModeEnum, OrderCancelReplacePegOffsetTypeEnum$1 as OrderCancelReplacePegOffsetTypeEnum, OrderCancelReplacePegPriceTypeEnum$1 as OrderCancelReplacePegPriceTypeEnum, OrderCancelReplaceRequest$1 as OrderCancelReplaceRequest, OrderCancelReplaceResponse$1 as OrderCancelReplaceResponse, OrderCancelReplaceResponseCancelResponse, OrderCancelReplaceResponseNewOrderResponse, OrderCancelReplaceResponseNewOrderResponseFillsInner, OrderCancelReplaceSelfTradePreventionModeEnum$1 as OrderCancelReplaceSelfTradePreventionModeEnum, OrderCancelReplaceSideEnum$1 as OrderCancelReplaceSideEnum, OrderCancelReplaceTimeInForceEnum$1 as OrderCancelReplaceTimeInForceEnum, OrderCancelReplaceTypeEnum$1 as OrderCancelReplaceTypeEnum, OrderListOcoAbovePegOffsetTypeEnum, OrderListOcoAbovePegPriceTypeEnum, OrderListOcoAboveTimeInForceEnum, OrderListOcoAboveTypeEnum, OrderListOcoBelowPegOffsetTypeEnum, OrderListOcoBelowPegPriceTypeEnum, OrderListOcoBelowTimeInForceEnum, OrderListOcoBelowTypeEnum, OrderListOcoNewOrderRespTypeEnum, OrderListOcoRequest, OrderListOcoResponse, OrderListOcoResponseOrderReportsInner, OrderListOcoResponseOrdersInner, OrderListOcoSelfTradePreventionModeEnum, OrderListOcoSideEnum, OrderListOpoNewOrderRespTypeEnum, OrderListOpoPendingPegOffsetTypeEnum, OrderListOpoPendingPegPriceTypeEnum, OrderListOpoPendingSideEnum, OrderListOpoPendingTimeInForceEnum, OrderListOpoPendingTypeEnum, OrderListOpoRequest, OrderListOpoResponse, OrderListOpoResponseOrderReportsInner, OrderListOpoResponseOrdersInner, OrderListOpoSelfTradePreventionModeEnum, OrderListOpoWorkingPegOffsetTypeEnum, OrderListOpoWorkingPegPriceTypeEnum, OrderListOpoWorkingSideEnum, OrderListOpoWorkingTimeInForceEnum, OrderListOpoWorkingTypeEnum, OrderListOpocoNewOrderRespTypeEnum, OrderListOpocoPendingAbovePegOffsetTypeEnum, OrderListOpocoPendingAbovePegPriceTypeEnum, OrderListOpocoPendingAboveTimeInForceEnum, OrderListOpocoPendingAboveTypeEnum, OrderListOpocoPendingBelowPegOffsetTypeEnum, OrderListOpocoPendingBelowPegPriceTypeEnum, OrderListOpocoPendingBelowTimeInForceEnum, OrderListOpocoPendingBelowTypeEnum, OrderListOpocoPendingSideEnum, OrderListOpocoRequest, OrderListOpocoResponse, OrderListOpocoResponseOrderReportsInner, OrderListOpocoResponseOrdersInner, OrderListOpocoSelfTradePreventionModeEnum, OrderListOpocoWorkingPegOffsetTypeEnum, OrderListOpocoWorkingPegPriceTypeEnum, OrderListOpocoWorkingSideEnum, OrderListOpocoWorkingTimeInForceEnum, OrderListOpocoWorkingTypeEnum, OrderListOtoNewOrderRespTypeEnum, OrderListOtoPendingPegOffsetTypeEnum, OrderListOtoPendingPegPriceTypeEnum, OrderListOtoPendingSideEnum, OrderListOtoPendingTimeInForceEnum, OrderListOtoPendingTypeEnum, OrderListOtoRequest, OrderListOtoResponse, OrderListOtoResponseOrderReportsInner, OrderListOtoResponseOrdersInner, OrderListOtoSelfTradePreventionModeEnum, OrderListOtoWorkingPegOffsetTypeEnum, OrderListOtoWorkingPegPriceTypeEnum, OrderListOtoWorkingSideEnum, OrderListOtoWorkingTimeInForceEnum, OrderListOtoWorkingTypeEnum, OrderListOtocoNewOrderRespTypeEnum, OrderListOtocoPendingAbovePegOffsetTypeEnum, OrderListOtocoPendingAbovePegPriceTypeEnum, OrderListOtocoPendingAboveTimeInForceEnum, OrderListOtocoPendingAboveTypeEnum, OrderListOtocoPendingBelowPegOffsetTypeEnum, OrderListOtocoPendingBelowPegPriceTypeEnum, OrderListOtocoPendingBelowTimeInForceEnum, OrderListOtocoPendingBelowTypeEnum, OrderListOtocoPendingSideEnum, OrderListOtocoRequest, OrderListOtocoResponse, OrderListOtocoResponseOrderReportsInner, OrderListOtocoResponseOrdersInner, OrderListOtocoSelfTradePreventionModeEnum, OrderListOtocoWorkingPegOffsetTypeEnum, OrderListOtocoWorkingPegPriceTypeEnum, OrderListOtocoWorkingSideEnum, OrderListOtocoWorkingTimeInForceEnum, OrderListOtocoWorkingTypeEnum, OrderOcoNewOrderRespTypeEnum, OrderOcoRequest, OrderOcoResponse, OrderOcoResponseOrderReportsInner, OrderOcoResponseOrdersInner, OrderOcoSelfTradePreventionModeEnum, OrderOcoSideEnum, OrderOcoStopLimitTimeInForceEnum, OrderTestNewOrderRespTypeEnum$1 as OrderTestNewOrderRespTypeEnum, OrderTestPegOffsetTypeEnum$1 as OrderTestPegOffsetTypeEnum, OrderTestPegPriceTypeEnum$1 as OrderTestPegPriceTypeEnum, OrderTestRequest$1 as OrderTestRequest, OrderTestResponse$1 as OrderTestResponse, OrderTestResponseDiscount, OrderTestResponseSpecialCommissionForOrder, OrderTestResponseStandardCommissionForOrder, OrderTestResponseTaxCommissionForOrder, OrderTestSelfTradePreventionModeEnum$1 as OrderTestSelfTradePreventionModeEnum, OrderTestSideEnum$1 as OrderTestSideEnum, OrderTestTimeInForceEnum$1 as OrderTestTimeInForceEnum, OrderTestTypeEnum$1 as OrderTestTypeEnum, PercentPriceBySideFilter$1 as PercentPriceBySideFilter, PercentPriceFilter$1 as PercentPriceFilter, PriceFilter$1 as PriceFilter, RateLimitOrderRequest, RateLimitOrderResponse, RateLimitOrderResponseInner, RateLimits$1 as RateLimits, ReferencePriceCalculationRequest$1 as ReferencePriceCalculationRequest, ReferencePriceCalculationResponse$1 as ReferencePriceCalculationResponse, ReferencePriceCalculationSymbolStatusEnum$1 as ReferencePriceCalculationSymbolStatusEnum, ReferencePriceRequest$2 as ReferencePriceRequest, ReferencePriceResponse$2 as ReferencePriceResponse, RestAPI, SorOrderNewOrderRespTypeEnum, SorOrderRequest, SorOrderResponse, SorOrderResponseFillsInner, SorOrderSelfTradePreventionModeEnum, SorOrderSideEnum, SorOrderTestNewOrderRespTypeEnum$1 as SorOrderTestNewOrderRespTypeEnum, SorOrderTestRequest$1 as SorOrderTestRequest, SorOrderTestResponse$1 as SorOrderTestResponse, SorOrderTestSelfTradePreventionModeEnum$1 as SorOrderTestSelfTradePreventionModeEnum, SorOrderTestSideEnum$1 as SorOrderTestSideEnum, SorOrderTestTimeInForceEnum$1 as SorOrderTestTimeInForceEnum, SorOrderTestTypeEnum$1 as SorOrderTestTypeEnum, SorOrderTimeInForceEnum, SorOrderTypeEnum, SymbolFilters$1 as SymbolFilters, TPlusSellFilter$1 as TPlusSellFilter, Ticker24hrRequest$1 as Ticker24hrRequest, Ticker24hrResponse$1 as Ticker24hrResponse, Ticker24hrResponse1$1 as Ticker24hrResponse1, Ticker24hrResponse2$1 as Ticker24hrResponse2, Ticker24hrResponse2Inner, Ticker24hrSymbolStatusEnum$1 as Ticker24hrSymbolStatusEnum, Ticker24hrTypeEnum$1 as Ticker24hrTypeEnum, TickerBookTickerRequest, TickerBookTickerResponse, TickerBookTickerResponse1, TickerBookTickerResponse2, TickerBookTickerResponse2Inner, TickerBookTickerSymbolStatusEnum, TickerPriceRequest$1 as TickerPriceRequest, TickerPriceResponse$1 as TickerPriceResponse, TickerPriceResponse1$1 as TickerPriceResponse1, TickerPriceResponse2$1 as TickerPriceResponse2, TickerPriceResponse2Inner, TickerPriceSymbolStatusEnum$1 as TickerPriceSymbolStatusEnum, TickerRequest$2 as TickerRequest, TickerResponse$2 as TickerResponse, TickerResponse1$1 as TickerResponse1, TickerResponse2$1 as TickerResponse2, TickerResponse2Inner, TickerSymbolStatusEnum$1 as TickerSymbolStatusEnum, TickerTradingDayRequest$1 as TickerTradingDayRequest, TickerTradingDayResponse$1 as TickerTradingDayResponse, TickerTradingDayResponse1, TickerTradingDayResponse2, TickerTradingDayResponse2Inner, TickerTradingDaySymbolStatusEnum$1 as TickerTradingDaySymbolStatusEnum, TickerTradingDayTypeEnum$1 as TickerTradingDayTypeEnum, TickerTypeEnum$1 as TickerTypeEnum, TickerWindowSizeEnum$1 as TickerWindowSizeEnum, TimeResponse$1 as TimeResponse, TradeApi$1 as TradeApi, TradeApiInterface$1 as TradeApiInterface, TrailingDeltaFilter$1 as TrailingDeltaFilter, UiKlinesIntervalEnum$1 as UiKlinesIntervalEnum, UiKlinesItem, UiKlinesRequest$1 as UiKlinesRequest, UiKlinesResponse$1 as UiKlinesResponse }; } //#endregion //#region src/websocket-api/types/account-commission-response-rate-limits-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AccountCommissionResponseRateLimitsInner */ interface AccountCommissionResponseRateLimitsInner { /** * * @type {string} * @memberof AccountCommissionResponseRateLimitsInner */ rateLimitType?: string; /** * * @type {string} * @memberof AccountCommissionResponseRateLimitsInner */ interval?: string; /** * * @type {number | bigint} * @memberof AccountCommissionResponseRateLimitsInner */ intervalNum?: number | bigint; /** * * @type {number | bigint} * @memberof AccountCommissionResponseRateLimitsInner */ limit?: number | bigint; /** * * @type {number | bigint} * @memberof AccountCommissionResponseRateLimitsInner */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/account-commission-response-result-discount.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Discount on standard commissions when paying in BNB. * @export * @interface AccountCommissionResponseResultDiscount */ interface AccountCommissionResponseResultDiscount { /** * * @type {boolean} * @memberof AccountCommissionResponseResultDiscount */ enabledForAccount?: boolean; /** * * @type {boolean} * @memberof AccountCommissionResponseResultDiscount */ enabledForSymbol?: boolean; /** * * @type {string} * @memberof AccountCommissionResponseResultDiscount */ discountAsset?: string; /** * Standard commission is reduced by this rate when paying commission in BNB. * @type {string} * @memberof AccountCommissionResponseResultDiscount */ discount?: string; } //#endregion //#region src/websocket-api/types/account-commission-response-result-special-commission.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Special commission rates from the order. * @export * @interface AccountCommissionResponseResultSpecialCommission */ interface AccountCommissionResponseResultSpecialCommission { /** * * @type {string} * @memberof AccountCommissionResponseResultSpecialCommission */ maker?: string; /** * * @type {string} * @memberof AccountCommissionResponseResultSpecialCommission */ taker?: string; /** * * @type {string} * @memberof AccountCommissionResponseResultSpecialCommission */ buyer?: string; /** * * @type {string} * @memberof AccountCommissionResponseResultSpecialCommission */ seller?: string; } //#endregion //#region src/websocket-api/types/account-commission-response-result-standard-commission.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Standard commission rates on trades from the order. * @export * @interface AccountCommissionResponseResultStandardCommission */ interface AccountCommissionResponseResultStandardCommission { /** * * @type {string} * @memberof AccountCommissionResponseResultStandardCommission */ maker?: string; /** * * @type {string} * @memberof AccountCommissionResponseResultStandardCommission */ taker?: string; /** * * @type {string} * @memberof AccountCommissionResponseResultStandardCommission */ buyer?: string; /** * * @type {string} * @memberof AccountCommissionResponseResultStandardCommission */ seller?: string; } //#endregion //#region src/websocket-api/types/account-commission-response-result-tax-commission.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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. */ /** * Tax commission rates on trades from the order. * @export * @interface AccountCommissionResponseResultTaxCommission */ interface AccountCommissionResponseResultTaxCommission { /** * * @type {string} * @memberof AccountCommissionResponseResultTaxCommission */ maker?: string; /** * * @type {string} * @memberof AccountCommissionResponseResultTaxCommission */ taker?: string; /** * * @type {string} * @memberof AccountCommissionResponseResultTaxCommission */ buyer?: string; /** * * @type {string} * @memberof AccountCommissionResponseResultTaxCommission */ seller?: string; } //#endregion //#region src/websocket-api/types/account-commission-response-result.d.ts /** * * @export * @interface AccountCommissionResponseResult */ interface AccountCommissionResponseResult { /** * * @type {string} * @memberof AccountCommissionResponseResult */ symbol?: string; /** * * @type {AccountCommissionResponseResultStandardCommission} * @memberof AccountCommissionResponseResult */ standardCommission?: AccountCommissionResponseResultStandardCommission; /** * * @type {AccountCommissionResponseResultSpecialCommission} * @memberof AccountCommissionResponseResult */ specialCommission?: AccountCommissionResponseResultSpecialCommission; /** * * @type {AccountCommissionResponseResultTaxCommission} * @memberof AccountCommissionResponseResult */ taxCommission?: AccountCommissionResponseResultTaxCommission; /** * * @type {AccountCommissionResponseResultDiscount} * @memberof AccountCommissionResponseResult */ discount?: AccountCommissionResponseResultDiscount; } //#endregion //#region src/websocket-api/types/account-commission-response.d.ts /** * * @export * @interface AccountCommissionResponse */ interface AccountCommissionResponse { /** * * @type {string} * @memberof AccountCommissionResponse */ id?: string; /** * * @type {number | bigint} * @memberof AccountCommissionResponse */ status?: number | bigint; /** * * @type {AccountCommissionResponseResult} * @memberof AccountCommissionResponse */ result?: AccountCommissionResponseResult; /** * * @type {Array} * @memberof AccountCommissionResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/account-rate-limits-orders-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AccountRateLimitsOrdersResponseResultInner */ interface AccountRateLimitsOrdersResponseResultInner { /** * * @type {string} * @memberof AccountRateLimitsOrdersResponseResultInner */ rateLimitType?: string; /** * * @type {string} * @memberof AccountRateLimitsOrdersResponseResultInner */ interval?: string; /** * * @type {number | bigint} * @memberof AccountRateLimitsOrdersResponseResultInner */ intervalNum?: number | bigint; /** * * @type {number | bigint} * @memberof AccountRateLimitsOrdersResponseResultInner */ limit?: number | bigint; /** * * @type {number | bigint} * @memberof AccountRateLimitsOrdersResponseResultInner */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/account-rate-limits-orders-response.d.ts /** * * @export * @interface AccountRateLimitsOrdersResponse */ interface AccountRateLimitsOrdersResponse { /** * * @type {string} * @memberof AccountRateLimitsOrdersResponse */ id?: string; /** * * @type {number | bigint} * @memberof AccountRateLimitsOrdersResponse */ status?: number | bigint; /** * * @type {Array} * @memberof AccountRateLimitsOrdersResponse */ result?: Array; /** * * @type {Array} * @memberof AccountRateLimitsOrdersResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/account-status-response-result-balances-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AccountStatusResponseResultBalancesInner */ interface AccountStatusResponseResultBalancesInner { /** * * @type {string} * @memberof AccountStatusResponseResultBalancesInner */ asset?: string; /** * * @type {string} * @memberof AccountStatusResponseResultBalancesInner */ free?: string; /** * * @type {string} * @memberof AccountStatusResponseResultBalancesInner */ locked?: string; } //#endregion //#region src/websocket-api/types/account-status-response-result-commission-rates.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AccountStatusResponseResultCommissionRates */ interface AccountStatusResponseResultCommissionRates { /** * * @type {string} * @memberof AccountStatusResponseResultCommissionRates */ maker?: string; /** * * @type {string} * @memberof AccountStatusResponseResultCommissionRates */ taker?: string; /** * * @type {string} * @memberof AccountStatusResponseResultCommissionRates */ buyer?: string; /** * * @type {string} * @memberof AccountStatusResponseResultCommissionRates */ seller?: string; } //#endregion //#region src/websocket-api/types/account-status-response-result.d.ts /** * * @export * @interface AccountStatusResponseResult */ interface AccountStatusResponseResult { /** * * @type {number | bigint} * @memberof AccountStatusResponseResult */ makerCommission?: number | bigint; /** * * @type {number | bigint} * @memberof AccountStatusResponseResult */ takerCommission?: number | bigint; /** * * @type {number | bigint} * @memberof AccountStatusResponseResult */ buyerCommission?: number | bigint; /** * * @type {number | bigint} * @memberof AccountStatusResponseResult */ sellerCommission?: number | bigint; /** * * @type {boolean} * @memberof AccountStatusResponseResult */ canTrade?: boolean; /** * * @type {boolean} * @memberof AccountStatusResponseResult */ canWithdraw?: boolean; /** * * @type {boolean} * @memberof AccountStatusResponseResult */ canDeposit?: boolean; /** * * @type {AccountStatusResponseResultCommissionRates} * @memberof AccountStatusResponseResult */ commissionRates?: AccountStatusResponseResultCommissionRates; /** * * @type {boolean} * @memberof AccountStatusResponseResult */ brokered?: boolean; /** * * @type {boolean} * @memberof AccountStatusResponseResult */ requireSelfTradePrevention?: boolean; /** * * @type {boolean} * @memberof AccountStatusResponseResult */ preventSor?: boolean; /** * * @type {number | bigint} * @memberof AccountStatusResponseResult */ updateTime?: number | bigint; /** * * @type {string} * @memberof AccountStatusResponseResult */ accountType?: string; /** * * @type {Array} * @memberof AccountStatusResponseResult */ balances?: Array; /** * * @type {Array} * @memberof AccountStatusResponseResult */ permissions?: Array; /** * * @type {number | bigint} * @memberof AccountStatusResponseResult */ uid?: number | bigint; } //#endregion //#region src/websocket-api/types/account-status-response.d.ts /** * * @export * @interface AccountStatusResponse */ interface AccountStatusResponse { /** * * @type {string} * @memberof AccountStatusResponse */ id?: string; /** * * @type {number | bigint} * @memberof AccountStatusResponse */ status?: number | bigint; /** * * @type {AccountStatusResponseResult} * @memberof AccountStatusResponse */ result?: AccountStatusResponseResult; /** * * @type {Array} * @memberof AccountStatusResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/all-order-lists-response-result-inner-orders-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AllOrderListsResponseResultInnerOrdersInner */ interface AllOrderListsResponseResultInnerOrdersInner { /** * * @type {string} * @memberof AllOrderListsResponseResultInnerOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof AllOrderListsResponseResultInnerOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof AllOrderListsResponseResultInnerOrdersInner */ clientOrderId?: string; } //#endregion //#region src/websocket-api/types/all-order-lists-response-result-inner.d.ts /** * * @export * @interface AllOrderListsResponseResultInner */ interface AllOrderListsResponseResultInner { /** * * @type {number | bigint} * @memberof AllOrderListsResponseResultInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof AllOrderListsResponseResultInner */ contingencyType?: string; /** * * @type {string} * @memberof AllOrderListsResponseResultInner */ listStatusType?: string; /** * * @type {string} * @memberof AllOrderListsResponseResultInner */ listOrderStatus?: string; /** * * @type {string} * @memberof AllOrderListsResponseResultInner */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof AllOrderListsResponseResultInner */ transactionTime?: number | bigint; /** * * @type {string} * @memberof AllOrderListsResponseResultInner */ symbol?: string; /** * * @type {Array} * @memberof AllOrderListsResponseResultInner */ orders?: Array; } //#endregion //#region src/websocket-api/types/all-order-lists-response.d.ts /** * * @export * @interface AllOrderListsResponse */ interface AllOrderListsResponse { /** * * @type {string} * @memberof AllOrderListsResponse */ id?: string; /** * * @type {number | bigint} * @memberof AllOrderListsResponse */ status?: number | bigint; /** * * @type {Array} * @memberof AllOrderListsResponse */ result?: Array; /** * * @type {Array} * @memberof AllOrderListsResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/all-orders-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AllOrdersResponseResultInner */ interface AllOrdersResponseResultInner { /** * * @type {string} * @memberof AllOrdersResponseResultInner */ symbol?: string; /** * * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ orderId?: number | bigint; /** * Present only for orders that belong to an order list. * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof AllOrdersResponseResultInner */ clientOrderId?: string; /** * * @type {string} * @memberof AllOrdersResponseResultInner */ price?: string; /** * * @type {string} * @memberof AllOrdersResponseResultInner */ origQty?: string; /** * * @type {string} * @memberof AllOrdersResponseResultInner */ executedQty?: string; /** * * @type {string} * @memberof AllOrdersResponseResultInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof AllOrdersResponseResultInner */ status?: string; /** * * @type {string} * @memberof AllOrdersResponseResultInner */ timeInForce?: string; /** * * @type {string} * @memberof AllOrdersResponseResultInner */ type?: string; /** * * @type {string} * @memberof AllOrdersResponseResultInner */ side?: string; /** * Order placement time. * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ time?: number | bigint; /** * Time of the last update to the order. * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ updateTime?: number | bigint; /** * * @type {boolean} * @memberof AllOrdersResponseResultInner */ isWorking?: boolean; /** * * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ workingTime?: number | bigint; /** * Always present. Zero if the order type does not use `quoteOrderQty`. * @type {string} * @memberof AllOrdersResponseResultInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof AllOrdersResponseResultInner */ selfTradePreventionMode?: string; /** * Present only if the order expired due to STP. * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ preventedMatchId?: number | bigint; /** * Present only if the order expired due to STP. * @type {string} * @memberof AllOrdersResponseResultInner */ preventedQuantity?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof AllOrdersResponseResultInner */ icebergQty?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof AllOrdersResponseResultInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof AllOrdersResponseResultInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof AllOrdersResponseResultInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof AllOrdersResponseResultInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof AllOrdersResponseResultInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof AllOrdersResponseResultInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof AllOrdersResponseResultInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof AllOrdersResponseResultInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/all-orders-response.d.ts /** * * @export * @interface AllOrdersResponse */ interface AllOrdersResponse { /** * * @type {string} * @memberof AllOrdersResponse */ id?: string; /** * * @type {number | bigint} * @memberof AllOrdersResponse */ status?: number | bigint; /** * * @type {Array} * @memberof AllOrdersResponse */ result?: Array; /** * * @type {Array} * @memberof AllOrdersResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/avg-price-response-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AvgPriceResponseResult */ interface AvgPriceResponseResult { /** * Average price interval (in minutes) * @type {number | bigint} * @memberof AvgPriceResponseResult */ mins?: number | bigint; /** * Average price * @type {string} * @memberof AvgPriceResponseResult */ price?: string; /** * Last trade time * @type {number | bigint} * @memberof AvgPriceResponseResult */ closeTime?: number | bigint; } //#endregion //#region src/websocket-api/types/avg-price-response.d.ts /** * * @export * @interface AvgPriceResponse */ interface AvgPriceResponse$1 { /** * * @type {string} * @memberof AvgPriceResponse */ id?: string; /** * * @type {number | bigint} * @memberof AvgPriceResponse */ status?: number | bigint; /** * * @type {AvgPriceResponseResult} * @memberof AvgPriceResponse */ result?: AvgPriceResponseResult; /** * * @type {Array} * @memberof AvgPriceResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/balance-update.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 BalanceUpdate */ interface BalanceUpdate$1 { /** * Event Time * @type {number | bigint} * @memberof BalanceUpdate */ E?: number | bigint; /** * Asset * @type {string} * @memberof BalanceUpdate */ a?: string; /** * Balance Delta * @type {string} * @memberof BalanceUpdate */ d?: string; /** * Clear Time * @type {number | bigint} * @memberof BalanceUpdate */ T?: number | bigint; } //#endregion //#region src/websocket-api/types/block-trades-historical-response-rate-limits-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 BlockTradesHistoricalResponseRateLimitsInner */ interface BlockTradesHistoricalResponseRateLimitsInner { /** * * @type {string} * @memberof BlockTradesHistoricalResponseRateLimitsInner */ rateLimitType?: string; /** * * @type {string} * @memberof BlockTradesHistoricalResponseRateLimitsInner */ interval?: string; /** * * @type {number} * @memberof BlockTradesHistoricalResponseRateLimitsInner */ intervalNum?: number; /** * * @type {number} * @memberof BlockTradesHistoricalResponseRateLimitsInner */ limit?: number; /** * * @type {number} * @memberof BlockTradesHistoricalResponseRateLimitsInner */ count?: number; } //#endregion //#region src/websocket-api/types/block-trades-historical-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 BlockTradesHistoricalResponseResultInner */ interface BlockTradesHistoricalResponseResultInner { /** * * @type {number | bigint} * @memberof BlockTradesHistoricalResponseResultInner */ id?: number | bigint; /** * * @type {string} * @memberof BlockTradesHistoricalResponseResultInner */ price?: string; /** * * @type {string} * @memberof BlockTradesHistoricalResponseResultInner */ qty?: string; /** * * @type {string} * @memberof BlockTradesHistoricalResponseResultInner */ quoteQty?: string; /** * * @type {number | bigint} * @memberof BlockTradesHistoricalResponseResultInner */ time?: number | bigint; /** * * @type {boolean} * @memberof BlockTradesHistoricalResponseResultInner */ isBuyerMaker?: boolean; } //#endregion //#region src/websocket-api/types/block-trades-historical-response.d.ts /** * * @export * @interface BlockTradesHistoricalResponse */ interface BlockTradesHistoricalResponse { /** * * @type {string} * @memberof BlockTradesHistoricalResponse */ id?: string; /** * * @type {number} * @memberof BlockTradesHistoricalResponse */ status?: number; /** * * @type {Array} * @memberof BlockTradesHistoricalResponse */ result?: Array; /** * * @type {Array} * @memberof BlockTradesHistoricalResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/depth-response-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 DepthResponseResult */ interface DepthResponseResult { /** * * @type {number | bigint} * @memberof DepthResponseResult */ lastUpdateId?: number | bigint; /** * Bid orders. Each entry is [price, quantity]. * @type {Array>} * @memberof DepthResponseResult */ bids?: Array>; /** * Ask orders. Each entry is [price, quantity]. * @type {Array>} * @memberof DepthResponseResult */ asks?: Array>; } //#endregion //#region src/websocket-api/types/depth-response.d.ts /** * * @export * @interface DepthResponse */ interface DepthResponse { /** * * @type {string} * @memberof DepthResponse */ id?: string; /** * * @type {number | bigint} * @memberof DepthResponse */ status?: number | bigint; /** * * @type {DepthResponseResult} * @memberof DepthResponse */ result?: DepthResponseResult; /** * * @type {Array} * @memberof DepthResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/event-stream-terminated.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 EventStreamTerminated */ interface EventStreamTerminated$1 { /** * Event Time * @type {number | bigint} * @memberof EventStreamTerminated */ E?: number | bigint; } //#endregion //#region src/websocket-api/types/exchange-max-num-algo-orders-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExchangeMaxNumAlgoOrdersFilter */ interface ExchangeMaxNumAlgoOrdersFilter { /** * * @type {string} * @memberof ExchangeMaxNumAlgoOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof ExchangeMaxNumAlgoOrdersFilter */ maxNumAlgoOrders?: number | bigint; } //#endregion //#region src/websocket-api/types/exchange-max-num-iceberg-orders-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExchangeMaxNumIcebergOrdersFilter */ interface ExchangeMaxNumIcebergOrdersFilter { /** * * @type {string} * @memberof ExchangeMaxNumIcebergOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof ExchangeMaxNumIcebergOrdersFilter */ maxNumIcebergOrders?: number | bigint; } //#endregion //#region src/websocket-api/types/exchange-max-num-order-lists-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExchangeMaxNumOrderListsFilter */ interface ExchangeMaxNumOrderListsFilter { /** * * @type {string} * @memberof ExchangeMaxNumOrderListsFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof ExchangeMaxNumOrderListsFilter */ maxNumOrderLists?: number | bigint; } //#endregion //#region src/websocket-api/types/exchange-max-num-orders-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExchangeMaxNumOrdersFilter */ interface ExchangeMaxNumOrdersFilter { /** * * @type {string} * @memberof ExchangeMaxNumOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof ExchangeMaxNumOrdersFilter */ maxNumOrders?: number | bigint; } //#endregion //#region src/websocket-api/types/exchange-filters.d.ts /** * @type ExchangeFilters */ type ExchangeFilters = ({ filterType: 'EXCHANGE_MAX_NUM_ALGO_ORDERS'; } & ExchangeMaxNumAlgoOrdersFilter) | ({ filterType: 'EXCHANGE_MAX_NUM_ICEBERG_ORDERS'; } & ExchangeMaxNumIcebergOrdersFilter) | ({ filterType: 'EXCHANGE_MAX_NUM_ORDERS'; } & ExchangeMaxNumOrdersFilter) | ({ filterType: 'EXCHANGE_MAX_NUM_ORDER_LISTS'; } & ExchangeMaxNumOrderListsFilter); //#endregion //#region src/websocket-api/types/exchange-info-response-sors-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExchangeInfoResponseSorsInner */ interface ExchangeInfoResponseSorsInner { /** * * @type {string} * @memberof ExchangeInfoResponseSorsInner */ baseAsset?: string; /** * * @type {Array} * @memberof ExchangeInfoResponseSorsInner */ symbols?: Array; } //#endregion //#region src/websocket-api/types/iceberg-parts-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 IcebergPartsFilter */ interface IcebergPartsFilter { /** * * @type {string} * @memberof IcebergPartsFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof IcebergPartsFilter */ limit?: number | bigint; } //#endregion //#region src/websocket-api/types/lot-size-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 LotSizeFilter */ interface LotSizeFilter { /** * * @type {string} * @memberof LotSizeFilter */ filterType?: string; /** * * @type {number} * @memberof LotSizeFilter */ qtyExponent?: number; /** * * @type {string} * @memberof LotSizeFilter */ minQty?: string; /** * * @type {string} * @memberof LotSizeFilter */ maxQty?: string; /** * * @type {string} * @memberof LotSizeFilter */ stepSize?: string; } //#endregion //#region src/websocket-api/types/market-lot-size-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MarketLotSizeFilter */ interface MarketLotSizeFilter { /** * * @type {string} * @memberof MarketLotSizeFilter */ filterType?: string; /** * * @type {number} * @memberof MarketLotSizeFilter */ qtyExponent?: number; /** * * @type {string} * @memberof MarketLotSizeFilter */ minQty?: string; /** * * @type {string} * @memberof MarketLotSizeFilter */ maxQty?: string; /** * * @type {string} * @memberof MarketLotSizeFilter */ stepSize?: string; } //#endregion //#region src/websocket-api/types/max-num-algo-orders-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxNumAlgoOrdersFilter */ interface MaxNumAlgoOrdersFilter { /** * * @type {string} * @memberof MaxNumAlgoOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof MaxNumAlgoOrdersFilter */ maxNumAlgoOrders?: number | bigint; } //#endregion //#region src/websocket-api/types/max-num-iceberg-orders-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxNumIcebergOrdersFilter */ interface MaxNumIcebergOrdersFilter { /** * * @type {string} * @memberof MaxNumIcebergOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof MaxNumIcebergOrdersFilter */ maxNumIcebergOrders?: number | bigint; } //#endregion //#region src/websocket-api/types/max-num-order-amends-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxNumOrderAmendsFilter */ interface MaxNumOrderAmendsFilter { /** * * @type {string} * @memberof MaxNumOrderAmendsFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof MaxNumOrderAmendsFilter */ maxNumOrderAmends?: number | bigint; } //#endregion //#region src/websocket-api/types/max-num-order-lists-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxNumOrderListsFilter */ interface MaxNumOrderListsFilter { /** * * @type {string} * @memberof MaxNumOrderListsFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof MaxNumOrderListsFilter */ maxNumOrderLists?: number | bigint; } //#endregion //#region src/websocket-api/types/max-num-orders-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxNumOrdersFilter */ interface MaxNumOrdersFilter { /** * * @type {string} * @memberof MaxNumOrdersFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof MaxNumOrdersFilter */ maxNumOrders?: number | bigint; } //#endregion //#region src/websocket-api/types/max-position-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxPositionFilter */ interface MaxPositionFilter { /** * * @type {string} * @memberof MaxPositionFilter */ filterType?: string; /** * * @type {number} * @memberof MaxPositionFilter */ qtyExponent?: number; /** * * @type {string} * @memberof MaxPositionFilter */ maxPosition?: string; } //#endregion //#region src/websocket-api/types/min-notional-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MinNotionalFilter */ interface MinNotionalFilter { /** * * @type {string} * @memberof MinNotionalFilter */ filterType?: string; /** * * @type {number} * @memberof MinNotionalFilter */ priceExponent?: number; /** * * @type {string} * @memberof MinNotionalFilter */ minNotional?: string; /** * * @type {boolean} * @memberof MinNotionalFilter */ applyToMarket?: boolean; /** * * @type {number} * @memberof MinNotionalFilter */ avgPriceMins?: number; } //#endregion //#region src/websocket-api/types/notional-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 NotionalFilter */ interface NotionalFilter { /** * * @type {string} * @memberof NotionalFilter */ filterType?: string; /** * * @type {number} * @memberof NotionalFilter */ priceExponent?: number; /** * * @type {string} * @memberof NotionalFilter */ minNotional?: string; /** * * @type {boolean} * @memberof NotionalFilter */ applyMinToMarket?: boolean; /** * * @type {string} * @memberof NotionalFilter */ maxNotional?: string; /** * * @type {boolean} * @memberof NotionalFilter */ applyMaxToMarket?: boolean; /** * * @type {number} * @memberof NotionalFilter */ avgPriceMins?: number; } //#endregion //#region src/websocket-api/types/percent-price-by-side-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 PercentPriceBySideFilter */ interface PercentPriceBySideFilter { /** * * @type {string} * @memberof PercentPriceBySideFilter */ filterType?: string; /** * * @type {number} * @memberof PercentPriceBySideFilter */ multiplierExponent?: number; /** * * @type {string} * @memberof PercentPriceBySideFilter */ bidMultiplierUp?: string; /** * * @type {string} * @memberof PercentPriceBySideFilter */ bidMultiplierDown?: string; /** * * @type {string} * @memberof PercentPriceBySideFilter */ askMultiplierUp?: string; /** * * @type {string} * @memberof PercentPriceBySideFilter */ askMultiplierDown?: string; /** * * @type {number} * @memberof PercentPriceBySideFilter */ avgPriceMins?: number; } //#endregion //#region src/websocket-api/types/percent-price-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 PercentPriceFilter */ interface PercentPriceFilter { /** * * @type {string} * @memberof PercentPriceFilter */ filterType?: string; /** * * @type {number} * @memberof PercentPriceFilter */ multiplierExponent?: number; /** * * @type {string} * @memberof PercentPriceFilter */ multiplierUp?: string; /** * * @type {string} * @memberof PercentPriceFilter */ multiplierDown?: string; /** * * @type {number} * @memberof PercentPriceFilter */ avgPriceMins?: number; } //#endregion //#region src/websocket-api/types/price-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 PriceFilter */ interface PriceFilter { /** * * @type {string} * @memberof PriceFilter */ filterType?: string; /** * * @type {number} * @memberof PriceFilter */ priceExponent?: number; /** * * @type {string} * @memberof PriceFilter */ minPrice?: string; /** * * @type {string} * @memberof PriceFilter */ maxPrice?: string; /** * * @type {string} * @memberof PriceFilter */ tickSize?: string; } //#endregion //#region src/websocket-api/types/tplus-sell-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TPlusSellFilter */ interface TPlusSellFilter { /** * * @type {string} * @memberof TPlusSellFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof TPlusSellFilter */ endTime?: number | bigint; } //#endregion //#region src/websocket-api/types/trailing-delta-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TrailingDeltaFilter */ interface TrailingDeltaFilter { /** * * @type {string} * @memberof TrailingDeltaFilter */ filterType?: string; /** * * @type {number | bigint} * @memberof TrailingDeltaFilter */ minTrailingAboveDelta?: number | bigint; /** * * @type {number | bigint} * @memberof TrailingDeltaFilter */ maxTrailingAboveDelta?: number | bigint; /** * * @type {number | bigint} * @memberof TrailingDeltaFilter */ minTrailingBelowDelta?: number | bigint; /** * * @type {number | bigint} * @memberof TrailingDeltaFilter */ maxTrailingBelowDelta?: number | bigint; } //#endregion //#region src/websocket-api/types/symbol-filters.d.ts /** * @type SymbolFilters */ type SymbolFilters = ({ filterType: 'ICEBERG_PARTS'; } & IcebergPartsFilter) | ({ filterType: 'LOT_SIZE'; } & LotSizeFilter) | ({ filterType: 'MARKET_LOT_SIZE'; } & MarketLotSizeFilter) | ({ filterType: 'MAX_NUM_ALGO_ORDERS'; } & MaxNumAlgoOrdersFilter) | ({ filterType: 'MAX_NUM_ICEBERG_ORDERS'; } & MaxNumIcebergOrdersFilter) | ({ filterType: 'MAX_NUM_ORDERS'; } & MaxNumOrdersFilter) | ({ filterType: 'MAX_NUM_ORDER_AMENDS'; } & MaxNumOrderAmendsFilter) | ({ filterType: 'MAX_NUM_ORDER_LISTS'; } & MaxNumOrderListsFilter) | ({ filterType: 'MAX_POSITION'; } & MaxPositionFilter) | ({ filterType: 'MIN_NOTIONAL'; } & MinNotionalFilter) | ({ filterType: 'NOTIONAL'; } & NotionalFilter) | ({ filterType: 'PERCENT_PRICE'; } & PercentPriceFilter) | ({ filterType: 'PERCENT_PRICE_BY_SIDE'; } & PercentPriceBySideFilter) | ({ filterType: 'PRICE_FILTER'; } & PriceFilter) | ({ filterType: 'TRAILING_DELTA'; } & TrailingDeltaFilter) | ({ filterType: 'T_PLUS_SELL'; } & TPlusSellFilter); //#endregion //#region src/websocket-api/types/exchange-info-response-symbols-inner.d.ts /** * * @export * @interface ExchangeInfoResponseSymbolsInner */ interface ExchangeInfoResponseSymbolsInner { /** * * @type {string} * @memberof ExchangeInfoResponseSymbolsInner */ symbol?: string; /** * * @type {string} * @memberof ExchangeInfoResponseSymbolsInner */ status?: string; /** * * @type {string} * @memberof ExchangeInfoResponseSymbolsInner */ baseAsset?: string; /** * * @type {number | bigint} * @memberof ExchangeInfoResponseSymbolsInner */ baseAssetPrecision?: number | bigint; /** * * @type {string} * @memberof ExchangeInfoResponseSymbolsInner */ quoteAsset?: string; /** * * @type {number | bigint} * @memberof ExchangeInfoResponseSymbolsInner */ quotePrecision?: number | bigint; /** * * @type {number | bigint} * @memberof ExchangeInfoResponseSymbolsInner */ quoteAssetPrecision?: number | bigint; /** * * @type {number | bigint} * @memberof ExchangeInfoResponseSymbolsInner */ baseCommissionPrecision?: number | bigint; /** * * @type {number | bigint} * @memberof ExchangeInfoResponseSymbolsInner */ quoteCommissionPrecision?: number | bigint; /** * * @type {Array} * @memberof ExchangeInfoResponseSymbolsInner */ orderTypes?: Array; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ icebergAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ ocoAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ otoAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ opoAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ quoteOrderQtyMarketAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ allowTrailingStop?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ cancelReplaceAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ amendAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ pegInstructionsAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ isSpotTradingAllowed?: boolean; /** * * @type {boolean} * @memberof ExchangeInfoResponseSymbolsInner */ isMarginTradingAllowed?: boolean; /** * * @type {Array} * @memberof ExchangeInfoResponseSymbolsInner */ filters?: Array; /** * * @type {Array} * @memberof ExchangeInfoResponseSymbolsInner */ permissions?: Array; /** * * @type {Array>} * @memberof ExchangeInfoResponseSymbolsInner */ permissionSets?: Array>; /** * * @type {string} * @memberof ExchangeInfoResponseSymbolsInner */ defaultSelfTradePreventionMode?: string; /** * * @type {Array} * @memberof ExchangeInfoResponseSymbolsInner */ allowedSelfTradePreventionModes?: Array; } //#endregion //#region src/websocket-api/types/rate-limits.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 RateLimits */ interface RateLimits { /** * * @type {string} * @memberof RateLimits */ rateLimitType?: string; /** * * @type {string} * @memberof RateLimits */ interval?: string; /** * * @type {number | bigint} * @memberof RateLimits */ intervalNum?: number | bigint; /** * * @type {number | bigint} * @memberof RateLimits */ limit?: number | bigint; /** * * @type {number | bigint} * @memberof RateLimits */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/exchange-info-response.d.ts /** * * @export * @interface ExchangeInfoResponse */ interface ExchangeInfoResponse { /** * * @type {string} * @memberof ExchangeInfoResponse */ timezone?: string; /** * * @type {number | bigint} * @memberof ExchangeInfoResponse */ serverTime?: number | bigint; /** * * @type {Array} * @memberof ExchangeInfoResponse */ rateLimits?: Array; /** * * @type {Array} * @memberof ExchangeInfoResponse */ exchangeFilters?: Array; /** * * @type {Array} * @memberof ExchangeInfoResponse */ symbols?: Array; /** * * @type {Array} * @memberof ExchangeInfoResponse */ sors?: Array; } //#endregion //#region src/websocket-api/types/execution-report.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExecutionReport */ interface ExecutionReport$1 { /** * Event time * @type {number | bigint} * @memberof ExecutionReport */ E?: number | bigint; /** * Symbol * @type {string} * @memberof ExecutionReport */ s?: string; /** * Client order ID * @type {string} * @memberof ExecutionReport */ c?: string; /** * Side * @type {string} * @memberof ExecutionReport */ S?: string; /** * Order type * @type {string} * @memberof ExecutionReport */ o?: string; /** * Time in force * @type {string} * @memberof ExecutionReport */ f?: string; /** * Order quantity * @type {string} * @memberof ExecutionReport */ q?: string; /** * Order price * @type {string} * @memberof ExecutionReport */ p?: string; /** * Stop price * @type {string} * @memberof ExecutionReport */ P?: string; /** * Iceberg quantity * @type {string} * @memberof ExecutionReport */ F?: string; /** * OrderListId * @type {number | bigint} * @memberof ExecutionReport */ g?: number | bigint; /** * Original client order ID; This is the ID of the order being canceled * @type {string} * @memberof ExecutionReport */ C?: string; /** * Current execution type * @type {string} * @memberof ExecutionReport */ x?: string; /** * Current order status * @type {string} * @memberof ExecutionReport */ X?: string; /** * Order reject reason; Please see Order Reject Reason for more information. * @type {string} * @memberof ExecutionReport */ r?: string; /** * Order ID * @type {number | bigint} * @memberof ExecutionReport */ i?: number | bigint; /** * Last executed quantity * @type {string} * @memberof ExecutionReport */ l?: string; /** * Cumulative filled quantity * @type {string} * @memberof ExecutionReport */ z?: string; /** * Last executed price * @type {string} * @memberof ExecutionReport */ L?: string; /** * Commission amount * @type {string} * @memberof ExecutionReport */ n?: string; /** * Commission asset * @type {string} * @memberof ExecutionReport */ N?: string; /** * Transaction time * @type {number | bigint} * @memberof ExecutionReport */ T?: number | bigint; /** * Trade ID * @type {number | bigint} * @memberof ExecutionReport */ t?: number | bigint; /** * Prevented Match Id; This is only visible if the order expired due to STP * @type {number | bigint} * @memberof ExecutionReport */ v?: number | bigint; /** * Execution Id * @type {number | bigint} * @memberof ExecutionReport */ I?: number | bigint; /** * Is the order on the book? * @type {boolean} * @memberof ExecutionReport */ w?: boolean; /** * Is this trade the maker side? * @type {boolean} * @memberof ExecutionReport */ m?: boolean; /** * Ignore * @type {boolean} * @memberof ExecutionReport */ M?: boolean; /** * Order creation time * @type {number | bigint} * @memberof ExecutionReport */ O?: number | bigint; /** * Cumulative quote asset transacted quantity * @type {string} * @memberof ExecutionReport */ Z?: string; /** * Last quote asset transacted quantity (i.e. lastPrice * lastQty) * @type {string} * @memberof ExecutionReport */ Y?: string; /** * Quote Order Quantity * @type {string} * @memberof ExecutionReport */ Q?: string; /** * Working Time; This is only visible if the order has been placed on the book. * @type {number | bigint} * @memberof ExecutionReport */ W?: number | bigint; /** * SelfTradePreventionMode * @type {string} * @memberof ExecutionReport */ V?: string; /** * Trailing Delta * @type {number | bigint} * @memberof ExecutionReport */ d?: number | bigint; /** * Trailing Time * @type {number | bigint} * @memberof ExecutionReport */ D?: number | bigint; /** * Strategy Id * @type {number | bigint} * @memberof ExecutionReport */ j?: number | bigint; /** * Strategy Type * @type {number | bigint} * @memberof ExecutionReport */ J?: number | bigint; /** * Prevented Quantity * @type {string} * @memberof ExecutionReport */ A?: string; /** * Last Prevented Quantity * @type {string} * @memberof ExecutionReport */ B?: string; /** * Trade Group Id * @type {number | bigint} * @memberof ExecutionReport */ u?: number | bigint; /** * Counter Order Id * @type {number | bigint} * @memberof ExecutionReport */ U?: number | bigint; /** * Counter Symbol * @type {string} * @memberof ExecutionReport */ Cs?: string; /** * Prevented Execution Quantity * @type {string} * @memberof ExecutionReport */ pl?: string; /** * Prevented Execution Price * @type {string} * @memberof ExecutionReport */ pL?: string; /** * Prevented Execution Quote Qty * @type {string} * @memberof ExecutionReport */ pY?: string; /** * Match Type * @type {string} * @memberof ExecutionReport */ b?: string; /** * Allocation ID * @type {number | bigint} * @memberof ExecutionReport */ a?: number | bigint; /** * Working Floor * @type {string} * @memberof ExecutionReport */ k?: string; /** * UsedSor * @type {boolean} * @memberof ExecutionReport */ uS?: boolean; /** * Pegged Price Type * @type {string} * @memberof ExecutionReport */ gP?: string; /** * Pegged Offset Type * @type {string} * @memberof ExecutionReport */ gOT?: string; /** * Pegged Offset Value * @type {number | bigint} * @memberof ExecutionReport */ gOV?: number | bigint; /** * Pegged Price * @type {string} * @memberof ExecutionReport */ gp?: string; /** * Expiry Reason. Appears when the order has expired. * @type {string} * @memberof ExecutionReport */ eR?: string; } //#endregion //#region src/websocket-api/types/execution-rules-response-result-symbol-rules-inner-rules-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExecutionRulesResponseResultSymbolRulesInnerRulesInner */ interface ExecutionRulesResponseResultSymbolRulesInnerRulesInner { /** * * @type {string} * @memberof ExecutionRulesResponseResultSymbolRulesInnerRulesInner */ ruleType?: string; /** * * @type {string} * @memberof ExecutionRulesResponseResultSymbolRulesInnerRulesInner */ bidLimitMultUp?: string; /** * * @type {string} * @memberof ExecutionRulesResponseResultSymbolRulesInnerRulesInner */ bidLimitMultDown?: string; /** * * @type {string} * @memberof ExecutionRulesResponseResultSymbolRulesInnerRulesInner */ askLimitMultUp?: string; /** * * @type {string} * @memberof ExecutionRulesResponseResultSymbolRulesInnerRulesInner */ askLimitMultDown?: string; } //#endregion //#region src/websocket-api/types/execution-rules-response-result-symbol-rules-inner.d.ts /** * * @export * @interface ExecutionRulesResponseResultSymbolRulesInner */ interface ExecutionRulesResponseResultSymbolRulesInner { /** * * @type {string} * @memberof ExecutionRulesResponseResultSymbolRulesInner */ symbol?: string; /** * * @type {Array} * @memberof ExecutionRulesResponseResultSymbolRulesInner */ rules?: Array; } //#endregion //#region src/websocket-api/types/execution-rules-response-result.d.ts /** * * @export * @interface ExecutionRulesResponseResult */ interface ExecutionRulesResponseResult { /** * * @type {Array} * @memberof ExecutionRulesResponseResult */ symbolRules?: Array; } //#endregion //#region src/websocket-api/types/execution-rules-response.d.ts /** * * @export * @interface ExecutionRulesResponse */ interface ExecutionRulesResponse { /** * * @type {string} * @memberof ExecutionRulesResponse */ id?: string; /** * * @type {number | bigint} * @memberof ExecutionRulesResponse */ status?: number | bigint; /** * * @type {ExecutionRulesResponseResult} * @memberof ExecutionRulesResponse */ result?: ExecutionRulesResponseResult; } //#endregion //#region src/websocket-api/types/external-lock-update.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExternalLockUpdate */ interface ExternalLockUpdate$1 { /** * Event Time * @type {number | bigint} * @memberof ExternalLockUpdate */ E?: number | bigint; /** * Asset * @type {string} * @memberof ExternalLockUpdate */ a?: string; /** * Delta * @type {string} * @memberof ExternalLockUpdate */ d?: string; /** * Transaction Time * @type {number | bigint} * @memberof ExternalLockUpdate */ T?: number | bigint; } //#endregion //#region src/websocket-api/types/klines-response-result-inner-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 KlinesResponseResultInnerInner */ type KlinesResponseResultInnerInner = number | string; //#endregion //#region src/websocket-api/types/klines-response.d.ts /** * * @export * @interface KlinesResponse */ interface KlinesResponse { /** * * @type {string} * @memberof KlinesResponse */ id?: string; /** * * @type {number | bigint} * @memberof KlinesResponse */ status?: number | bigint; /** * * @type {Array>} * @memberof KlinesResponse */ result?: Array>; /** * * @type {Array} * @memberof KlinesResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/list-status-oinner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ListStatusOInner */ interface ListStatusOInner$1 { /** * Symbol * @type {string} * @memberof ListStatusOInner */ s?: string; /** * OrderId * @type {number | bigint} * @memberof ListStatusOInner */ i?: number | bigint; /** * ClientOrderId * @type {string} * @memberof ListStatusOInner */ c?: string; } //#endregion //#region src/websocket-api/types/list-status.d.ts /** * * @export * @interface ListStatus */ interface ListStatus$1 { /** * Event Time * @type {number | bigint} * @memberof ListStatus */ E?: number | bigint; /** * Symbol * @type {string} * @memberof ListStatus */ s?: string; /** * OrderListId * @type {number | bigint} * @memberof ListStatus */ g?: number | bigint; /** * Contingency Type * @type {string} * @memberof ListStatus */ c?: string; /** * List Status Type * @type {string} * @memberof ListStatus */ l?: string; /** * List Order Status * @type {string} * @memberof ListStatus */ L?: string; /** * List Reject Reason * @type {string} * @memberof ListStatus */ r?: string; /** * List Client Order ID * @type {string} * @memberof ListStatus */ C?: string; /** * Transaction Time * @type {number | bigint} * @memberof ListStatus */ T?: number | bigint; /** * An array of objects * @type {Array} * @memberof ListStatus */ O?: Array; } //#endregion //#region src/websocket-api/types/max-asset-filter.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MaxAssetFilter */ interface MaxAssetFilter { /** * * @type {string} * @memberof MaxAssetFilter */ filterType?: string; /** * * @type {number} * @memberof MaxAssetFilter */ qtyExponent?: number; /** * * @type {string} * @memberof MaxAssetFilter */ limit?: string; /** * * @type {string} * @memberof MaxAssetFilter */ asset?: string; } //#endregion //#region src/websocket-api/types/my-allocations-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MyAllocationsResponseResultInner */ interface MyAllocationsResponseResultInner { /** * * @type {string} * @memberof MyAllocationsResponseResultInner */ symbol?: string; /** * * @type {number | bigint} * @memberof MyAllocationsResponseResultInner */ allocationId?: number | bigint; /** * * @type {string} * @memberof MyAllocationsResponseResultInner */ allocationType?: string; /** * * @type {number | bigint} * @memberof MyAllocationsResponseResultInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof MyAllocationsResponseResultInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof MyAllocationsResponseResultInner */ price?: string; /** * * @type {string} * @memberof MyAllocationsResponseResultInner */ qty?: string; /** * * @type {string} * @memberof MyAllocationsResponseResultInner */ quoteQty?: string; /** * * @type {string} * @memberof MyAllocationsResponseResultInner */ commission?: string; /** * * @type {string} * @memberof MyAllocationsResponseResultInner */ commissionAsset?: string; /** * * @type {number | bigint} * @memberof MyAllocationsResponseResultInner */ time?: number | bigint; /** * * @type {boolean} * @memberof MyAllocationsResponseResultInner */ isBuyer?: boolean; /** * * @type {boolean} * @memberof MyAllocationsResponseResultInner */ isMaker?: boolean; /** * * @type {boolean} * @memberof MyAllocationsResponseResultInner */ isAllocator?: boolean; } //#endregion //#region src/websocket-api/types/my-allocations-response.d.ts /** * * @export * @interface MyAllocationsResponse */ interface MyAllocationsResponse { /** * * @type {string} * @memberof MyAllocationsResponse */ id?: string; /** * * @type {number | bigint} * @memberof MyAllocationsResponse */ status?: number | bigint; /** * * @type {Array} * @memberof MyAllocationsResponse */ result?: Array; /** * * @type {Array} * @memberof MyAllocationsResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/my-filters-response.d.ts /** * * @export * @interface MyFiltersResponse */ interface MyFiltersResponse { /** * * @type {Array} * @memberof MyFiltersResponse */ exchangeFilters?: Array; /** * * @type {Array} * @memberof MyFiltersResponse */ symbolFilters?: Array; /** * * @type {Array} * @memberof MyFiltersResponse */ assetFilters?: Array; /** * * @type {Array} * @memberof MyFiltersResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/my-prevented-matches-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MyPreventedMatchesResponseResultInner */ interface MyPreventedMatchesResponseResultInner { /** * * @type {string} * @memberof MyPreventedMatchesResponseResultInner */ symbol?: string; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponseResultInner */ preventedMatchId?: number | bigint; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponseResultInner */ takerOrderId?: number | bigint; /** * * @type {string} * @memberof MyPreventedMatchesResponseResultInner */ makerSymbol?: string; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponseResultInner */ makerOrderId?: number | bigint; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponseResultInner */ tradeGroupId?: number | bigint; /** * * @type {string} * @memberof MyPreventedMatchesResponseResultInner */ selfTradePreventionMode?: string; /** * * @type {string} * @memberof MyPreventedMatchesResponseResultInner */ price?: string; /** * * @type {string} * @memberof MyPreventedMatchesResponseResultInner */ makerPreventedQuantity?: string; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponseResultInner */ transactTime?: number | bigint; } //#endregion //#region src/websocket-api/types/my-prevented-matches-response.d.ts /** * * @export * @interface MyPreventedMatchesResponse */ interface MyPreventedMatchesResponse { /** * * @type {string} * @memberof MyPreventedMatchesResponse */ id?: string; /** * * @type {number | bigint} * @memberof MyPreventedMatchesResponse */ status?: number | bigint; /** * * @type {Array} * @memberof MyPreventedMatchesResponse */ result?: Array; /** * * @type {Array} * @memberof MyPreventedMatchesResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/my-trades-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MyTradesResponseResultInner */ interface MyTradesResponseResultInner { /** * * @type {string} * @memberof MyTradesResponseResultInner */ symbol?: string; /** * * @type {number | bigint} * @memberof MyTradesResponseResultInner */ id?: number | bigint; /** * * @type {number | bigint} * @memberof MyTradesResponseResultInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof MyTradesResponseResultInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof MyTradesResponseResultInner */ price?: string; /** * * @type {string} * @memberof MyTradesResponseResultInner */ qty?: string; /** * * @type {string} * @memberof MyTradesResponseResultInner */ quoteQty?: string; /** * * @type {string} * @memberof MyTradesResponseResultInner */ commission?: string; /** * * @type {string} * @memberof MyTradesResponseResultInner */ commissionAsset?: string; /** * * @type {number | bigint} * @memberof MyTradesResponseResultInner */ time?: number | bigint; /** * * @type {boolean} * @memberof MyTradesResponseResultInner */ isBuyer?: boolean; /** * * @type {boolean} * @memberof MyTradesResponseResultInner */ isMaker?: boolean; /** * * @type {boolean} * @memberof MyTradesResponseResultInner */ isBestMatch?: boolean; } //#endregion //#region src/websocket-api/types/my-trades-response.d.ts /** * * @export * @interface MyTradesResponse */ interface MyTradesResponse { /** * * @type {string} * @memberof MyTradesResponse */ id?: string; /** * * @type {number | bigint} * @memberof MyTradesResponse */ status?: number | bigint; /** * * @type {Array} * @memberof MyTradesResponse */ result?: Array; /** * * @type {Array} * @memberof MyTradesResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/open-order-lists-status-response-result-inner-orders-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OpenOrderListsStatusResponseResultInnerOrdersInner */ interface OpenOrderListsStatusResponseResultInnerOrdersInner { /** * * @type {string} * @memberof OpenOrderListsStatusResponseResultInnerOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OpenOrderListsStatusResponseResultInnerOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OpenOrderListsStatusResponseResultInnerOrdersInner */ clientOrderId?: string; } //#endregion //#region src/websocket-api/types/open-order-lists-status-response-result-inner.d.ts /** * * @export * @interface OpenOrderListsStatusResponseResultInner */ interface OpenOrderListsStatusResponseResultInner { /** * * @type {number | bigint} * @memberof OpenOrderListsStatusResponseResultInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OpenOrderListsStatusResponseResultInner */ contingencyType?: string; /** * * @type {string} * @memberof OpenOrderListsStatusResponseResultInner */ listStatusType?: string; /** * * @type {string} * @memberof OpenOrderListsStatusResponseResultInner */ listOrderStatus?: string; /** * * @type {string} * @memberof OpenOrderListsStatusResponseResultInner */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OpenOrderListsStatusResponseResultInner */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OpenOrderListsStatusResponseResultInner */ symbol?: string; /** * * @type {Array} * @memberof OpenOrderListsStatusResponseResultInner */ orders?: Array; } //#endregion //#region src/websocket-api/types/open-order-lists-status-response.d.ts /** * * @export * @interface OpenOrderListsStatusResponse */ interface OpenOrderListsStatusResponse { /** * * @type {string} * @memberof OpenOrderListsStatusResponse */ id?: string; /** * * @type {number | bigint} * @memberof OpenOrderListsStatusResponse */ status?: number | bigint; /** * * @type {Array} * @memberof OpenOrderListsStatusResponse */ result?: Array; /** * * @type {Array} * @memberof OpenOrderListsStatusResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/open-orders-cancel-all-response-result-inner-order-reports-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ interface OpenOrdersCancelAllResponseResultInnerOrderReportsInner { /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ symbol?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ origClientOrderId?: string; /** * * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ side?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/open-orders-cancel-all-response-result-inner-orders-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OpenOrdersCancelAllResponseResultInnerOrdersInner */ interface OpenOrdersCancelAllResponseResultInnerOrdersInner { /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInnerOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInnerOrdersInner */ clientOrderId?: string; } //#endregion //#region src/websocket-api/types/open-orders-cancel-all-response-result-inner.d.ts /** * * @export * @interface OpenOrdersCancelAllResponseResultInner */ interface OpenOrdersCancelAllResponseResultInner { /** * * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ contingencyType?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ listStatusType?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ listOrderStatus?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInner */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ symbol?: string; /** * * @type {Array} * @memberof OpenOrdersCancelAllResponseResultInner */ orders?: Array; /** * * @type {Array} * @memberof OpenOrdersCancelAllResponseResultInner */ orderReports?: Array; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ origClientOrderId?: string; /** * * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ price?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ origQty?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ executedQty?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ status?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ timeInForce?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ type?: string; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ side?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ stopPrice?: string; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInner */ trailingTime?: number | bigint; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ icebergQty?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInner */ strategyType?: number | bigint; /** * * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ selfTradePreventionMode?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ preventedQuantity?: string; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OpenOrdersCancelAllResponseResultInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OpenOrdersCancelAllResponseResultInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OpenOrdersCancelAllResponseResultInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/open-orders-cancel-all-response.d.ts /** * * @export * @interface OpenOrdersCancelAllResponse */ interface OpenOrdersCancelAllResponse { /** * * @type {string} * @memberof OpenOrdersCancelAllResponse */ id?: string; /** * * @type {number | bigint} * @memberof OpenOrdersCancelAllResponse */ status?: number | bigint; /** * * @type {Array} * @memberof OpenOrdersCancelAllResponse */ result?: Array; /** * * @type {Array} * @memberof OpenOrdersCancelAllResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/open-orders-status-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OpenOrdersStatusResponseResultInner */ interface OpenOrdersStatusResponseResultInner { /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ orderId?: number | bigint; /** * Present only for orders that belong to an order list. * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ clientOrderId?: string; /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ price?: string; /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ origQty?: string; /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ executedQty?: string; /** * Always present. Zero if the order type does not use `quoteOrderQty`. * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ status?: string; /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ timeInForce?: string; /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ type?: string; /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ side?: string; /** * Order placement time. * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ time?: number | bigint; /** * Time of the last update to the order. * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ updateTime?: number | bigint; /** * * @type {boolean} * @memberof OpenOrdersStatusResponseResultInner */ isWorking?: boolean; /** * * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OpenOrdersStatusResponseResultInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OpenOrdersStatusResponseResultInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OpenOrdersStatusResponseResultInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/open-orders-status-response.d.ts /** * * @export * @interface OpenOrdersStatusResponse */ interface OpenOrdersStatusResponse { /** * * @type {string} * @memberof OpenOrdersStatusResponse */ id?: string; /** * * @type {number | bigint} * @memberof OpenOrdersStatusResponse */ status?: number | bigint; /** * * @type {Array} * @memberof OpenOrdersStatusResponse */ result?: Array; /** * * @type {Array} * @memberof OpenOrdersStatusResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-amend-keep-priority-response-result-amended-order.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderAmendKeepPriorityResponseResultAmendedOrder */ interface OrderAmendKeepPriorityResponseResultAmendedOrder { /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ origClientOrderId?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ clientOrderId?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ price?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ qty?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ executedQty?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ preventedQty?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ quoteOrderQty?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ cumulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ status?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ timeInForce?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ type?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ side?: string; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderAmendKeepPriorityResponseResultAmendedOrder */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-amend-keep-priority-response-result-list-status-orders-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderAmendKeepPriorityResponseResultListStatusOrdersInner */ interface OrderAmendKeepPriorityResponseResultListStatusOrdersInner { /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultListStatusOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultListStatusOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultListStatusOrdersInner */ clientOrderId?: string; } //#endregion //#region src/websocket-api/types/order-amend-keep-priority-response-result-list-status.d.ts /** * * @export * @interface OrderAmendKeepPriorityResponseResultListStatus */ interface OrderAmendKeepPriorityResponseResultListStatus { /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResultListStatus */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultListStatus */ contingencyType?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultListStatus */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultListStatus */ listClientOrderId?: string; /** * * @type {string} * @memberof OrderAmendKeepPriorityResponseResultListStatus */ symbol?: string; /** * * @type {Array} * @memberof OrderAmendKeepPriorityResponseResultListStatus */ orders?: Array; } //#endregion //#region src/websocket-api/types/order-amend-keep-priority-response-result.d.ts /** * * @export * @interface OrderAmendKeepPriorityResponseResult */ interface OrderAmendKeepPriorityResponseResult { /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResult */ transactTime?: number | bigint; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponseResult */ executionId?: number | bigint; /** * * @type {OrderAmendKeepPriorityResponseResultAmendedOrder} * @memberof OrderAmendKeepPriorityResponseResult */ amendedOrder?: OrderAmendKeepPriorityResponseResultAmendedOrder; /** * * @type {OrderAmendKeepPriorityResponseResultListStatus} * @memberof OrderAmendKeepPriorityResponseResult */ listStatus?: OrderAmendKeepPriorityResponseResultListStatus; } //#endregion //#region src/websocket-api/types/order-amend-keep-priority-response.d.ts /** * * @export * @interface OrderAmendKeepPriorityResponse */ interface OrderAmendKeepPriorityResponse { /** * * @type {string} * @memberof OrderAmendKeepPriorityResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderAmendKeepPriorityResponse */ status?: number | bigint; /** * * @type {OrderAmendKeepPriorityResponseResult} * @memberof OrderAmendKeepPriorityResponse */ result?: OrderAmendKeepPriorityResponseResult; /** * * @type {Array} * @memberof OrderAmendKeepPriorityResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-amendments-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderAmendmentsResponseResultInner */ interface OrderAmendmentsResponseResultInner { /** * * @type {string} * @memberof OrderAmendmentsResponseResultInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderAmendmentsResponseResultInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderAmendmentsResponseResultInner */ executionId?: number | bigint; /** * * @type {string} * @memberof OrderAmendmentsResponseResultInner */ origClientOrderId?: string; /** * * @type {string} * @memberof OrderAmendmentsResponseResultInner */ newClientOrderId?: string; /** * * @type {string} * @memberof OrderAmendmentsResponseResultInner */ origQty?: string; /** * * @type {string} * @memberof OrderAmendmentsResponseResultInner */ newQty?: string; /** * * @type {number | bigint} * @memberof OrderAmendmentsResponseResultInner */ time?: number | bigint; } //#endregion //#region src/websocket-api/types/order-amendments-response.d.ts /** * * @export * @interface OrderAmendmentsResponse */ interface OrderAmendmentsResponse { /** * * @type {string} * @memberof OrderAmendmentsResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderAmendmentsResponse */ status?: number | bigint; /** * * @type {Array} * @memberof OrderAmendmentsResponse */ result?: Array; /** * * @type {Array} * @memberof OrderAmendmentsResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-cancel-replace-response-result-cancel-response.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderCancelReplaceResponseResultCancelResponse */ interface OrderCancelReplaceResponseResultCancelResponse { /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ symbol?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ origClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultCancelResponse */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultCancelResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultCancelResponse */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ price?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ origQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ executedQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ status?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ timeInForce?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ type?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ side?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultCancelResponse */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultCancelResponse */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultCancelResponse */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultCancelResponse */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultCancelResponse */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderCancelReplaceResponseResultCancelResponse */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultCancelResponse */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderCancelReplaceResponseResultCancelResponse */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-cancel-replace-response-result-new-order-response.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderCancelReplaceResponseResultNewOrderResponse */ interface OrderCancelReplaceResponseResultNewOrderResponse { /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ price?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ origQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ executedQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ status?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ timeInForce?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ type?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ side?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderCancelReplaceResponseResultNewOrderResponse */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-cancel-replace-response-result.d.ts /** * * @export * @interface OrderCancelReplaceResponseResult */ interface OrderCancelReplaceResponseResult { /** * * @type {string} * @memberof OrderCancelReplaceResponseResult */ cancelResult?: string; /** * * @type {string} * @memberof OrderCancelReplaceResponseResult */ newOrderResult?: string; /** * * @type {OrderCancelReplaceResponseResultCancelResponse} * @memberof OrderCancelReplaceResponseResult */ cancelResponse?: OrderCancelReplaceResponseResultCancelResponse; /** * * @type {OrderCancelReplaceResponseResultNewOrderResponse} * @memberof OrderCancelReplaceResponseResult */ newOrderResponse?: OrderCancelReplaceResponseResultNewOrderResponse; } //#endregion //#region src/websocket-api/types/order-cancel-replace-response.d.ts /** * * @export * @interface OrderCancelReplaceResponse */ interface OrderCancelReplaceResponse { /** * * @type {string} * @memberof OrderCancelReplaceResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderCancelReplaceResponse */ status?: number | bigint; /** * * @type {OrderCancelReplaceResponseResult} * @memberof OrderCancelReplaceResponse */ result?: OrderCancelReplaceResponseResult; /** * * @type {Array} * @memberof OrderCancelReplaceResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-cancel-response-result.d.ts /** * * @export * @interface OrderCancelResponseResult */ interface OrderCancelResponseResult { /** * * @type {string} * @memberof OrderCancelResponseResult */ symbol?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ origClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderCancelResponseResult */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderCancelResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderCancelResponseResult */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderCancelResponseResult */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderCancelResponseResult */ price?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ origQty?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ executedQty?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ status?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ timeInForce?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ type?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ side?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderCancelResponseResult */ stopPrice?: string; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderCancelResponseResult */ trailingDelta?: number | bigint; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderCancelResponseResult */ icebergQty?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderCancelResponseResult */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderCancelResponseResult */ strategyType?: number | bigint; /** * * @type {string} * @memberof OrderCancelResponseResult */ selfTradePreventionMode?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderCancelResponseResult */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderCancelResponseResult */ preventedQuantity?: string; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderCancelResponseResult */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderCancelResponseResult */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderCancelResponseResult */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderCancelResponseResult */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderCancelResponseResult */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderCancelResponseResult */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderCancelResponseResult */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderCancelResponseResult */ expiryReason?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ contingencyType?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ listStatusType?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderCancelResponseResult */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderCancelResponseResult */ transactionTime?: number | bigint; /** * * @type {Array} * @memberof OrderCancelResponseResult */ orders?: Array; /** * * @type {Array} * @memberof OrderCancelResponseResult */ orderReports?: Array; } //#endregion //#region src/websocket-api/types/order-cancel-response.d.ts /** * * @export * @interface OrderCancelResponse */ interface OrderCancelResponse { /** * * @type {string} * @memberof OrderCancelResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderCancelResponse */ status?: number | bigint; /** * * @type {OrderCancelResponseResult} * @memberof OrderCancelResponse */ result?: OrderCancelResponseResult; /** * * @type {Array} * @memberof OrderCancelResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-list-cancel-response-result-order-reports-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListCancelResponseResultOrderReportsInner */ interface OrderListCancelResponseResultOrderReportsInner { /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListCancelResponseResultOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListCancelResponseResultOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListCancelResponseResultOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ side?: string; /** * * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListCancelResponseResultOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListCancelResponseResultOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListCancelResponseResultOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListCancelResponseResultOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListCancelResponseResultOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListCancelResponseResultOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListCancelResponseResultOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListCancelResponseResultOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-list-cancel-response-result.d.ts /** * * @export * @interface OrderListCancelResponseResult */ interface OrderListCancelResponseResult { /** * * @type {number | bigint} * @memberof OrderListCancelResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListCancelResponseResult */ contingencyType?: string; /** * * @type {string} * @memberof OrderListCancelResponseResult */ listStatusType?: string; /** * * @type {string} * @memberof OrderListCancelResponseResult */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListCancelResponseResult */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListCancelResponseResult */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListCancelResponseResult */ symbol?: string; /** * * @type {Array} * @memberof OrderListCancelResponseResult */ orders?: Array; /** * * @type {Array} * @memberof OrderListCancelResponseResult */ orderReports?: Array; } //#endregion //#region src/websocket-api/types/order-list-cancel-response.d.ts /** * * @export * @interface OrderListCancelResponse */ interface OrderListCancelResponse { /** * * @type {string} * @memberof OrderListCancelResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderListCancelResponse */ status?: number | bigint; /** * * @type {OrderListCancelResponseResult} * @memberof OrderListCancelResponse */ result?: OrderListCancelResponseResult; /** * * @type {Array} * @memberof OrderListCancelResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-list-place-oco-response-result-order-reports-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceOcoResponseResultOrderReportsInner */ interface OrderListPlaceOcoResponseResultOrderReportsInner { /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListPlaceOcoResponseResultOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-list-place-oco-response-result-orders-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceOcoResponseResultOrdersInner */ interface OrderListPlaceOcoResponseResultOrdersInner { /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResultOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResultOrdersInner */ clientOrderId?: string; } //#endregion //#region src/websocket-api/types/order-list-place-oco-response-result.d.ts /** * * @export * @interface OrderListPlaceOcoResponseResult */ interface OrderListPlaceOcoResponseResult { /** * * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResult */ contingencyType?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResult */ listStatusType?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResult */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResult */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOcoResponseResult */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOcoResponseResult */ symbol?: string; /** * * @type {Array} * @memberof OrderListPlaceOcoResponseResult */ orders?: Array; /** * * @type {Array} * @memberof OrderListPlaceOcoResponseResult */ orderReports?: Array; } //#endregion //#region src/websocket-api/types/order-list-place-oco-response.d.ts /** * * @export * @interface OrderListPlaceOcoResponse */ interface OrderListPlaceOcoResponse { /** * * @type {string} * @memberof OrderListPlaceOcoResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOcoResponse */ status?: number | bigint; /** * * @type {OrderListPlaceOcoResponseResult} * @memberof OrderListPlaceOcoResponse */ result?: OrderListPlaceOcoResponseResult; /** * * @type {Array} * @memberof OrderListPlaceOcoResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-list-place-opo-response-result-order-reports-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceOpoResponseResultOrderReportsInner */ interface OrderListPlaceOpoResponseResultOrderReportsInner { /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ selfTradePreventionMode?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ origQty?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListPlaceOpoResponseResultOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-list-place-opo-response-result-orders-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceOpoResponseResultOrdersInner */ interface OrderListPlaceOpoResponseResultOrdersInner { /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResultOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResultOrdersInner */ clientOrderId?: string; } //#endregion //#region src/websocket-api/types/order-list-place-opo-response-result.d.ts /** * * @export * @interface OrderListPlaceOpoResponseResult */ interface OrderListPlaceOpoResponseResult { /** * * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResult */ contingencyType?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResult */ listStatusType?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResult */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResult */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpoResponseResult */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpoResponseResult */ symbol?: string; /** * * @type {Array} * @memberof OrderListPlaceOpoResponseResult */ orders?: Array; /** * * @type {Array} * @memberof OrderListPlaceOpoResponseResult */ orderReports?: Array; } //#endregion //#region src/websocket-api/types/order-list-place-opo-response.d.ts /** * * @export * @interface OrderListPlaceOpoResponse */ interface OrderListPlaceOpoResponse { /** * * @type {string} * @memberof OrderListPlaceOpoResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpoResponse */ status?: number | bigint; /** * * @type {OrderListPlaceOpoResponseResult} * @memberof OrderListPlaceOpoResponse */ result?: OrderListPlaceOpoResponseResult; } //#endregion //#region src/websocket-api/types/order-list-place-opoco-response-result-order-reports-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceOpocoResponseResultOrderReportsInner */ interface OrderListPlaceOpocoResponseResultOrderReportsInner { /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ selfTradePreventionMode?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ stopPrice?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ origQty?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ preventedQuantity?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-list-place-opoco-response-result-orders-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceOpocoResponseResultOrdersInner */ interface OrderListPlaceOpocoResponseResultOrdersInner { /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResultOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResultOrdersInner */ clientOrderId?: string; } //#endregion //#region src/websocket-api/types/order-list-place-opoco-response-result.d.ts /** * * @export * @interface OrderListPlaceOpocoResponseResult */ interface OrderListPlaceOpocoResponseResult { /** * * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResult */ contingencyType?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResult */ listStatusType?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResult */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResult */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpocoResponseResult */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOpocoResponseResult */ symbol?: string; /** * * @type {Array} * @memberof OrderListPlaceOpocoResponseResult */ orders?: Array; /** * * @type {Array} * @memberof OrderListPlaceOpocoResponseResult */ orderReports?: Array; } //#endregion //#region src/websocket-api/types/order-list-place-opoco-response.d.ts /** * * @export * @interface OrderListPlaceOpocoResponse */ interface OrderListPlaceOpocoResponse { /** * * @type {string} * @memberof OrderListPlaceOpocoResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOpocoResponse */ status?: number | bigint; /** * * @type {OrderListPlaceOpocoResponseResult} * @memberof OrderListPlaceOpocoResponse */ result?: OrderListPlaceOpocoResponseResult; } //#endregion //#region src/websocket-api/types/order-list-place-oto-response-result-order-reports-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceOtoResponseResultOrderReportsInner */ interface OrderListPlaceOtoResponseResultOrderReportsInner { /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListPlaceOtoResponseResultOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-list-place-oto-response-result-orders-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceOtoResponseResultOrdersInner */ interface OrderListPlaceOtoResponseResultOrdersInner { /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResultOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResultOrdersInner */ clientOrderId?: string; } //#endregion //#region src/websocket-api/types/order-list-place-oto-response-result.d.ts /** * * @export * @interface OrderListPlaceOtoResponseResult */ interface OrderListPlaceOtoResponseResult { /** * * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResult */ contingencyType?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResult */ listStatusType?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResult */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResult */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtoResponseResult */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtoResponseResult */ symbol?: string; /** * * @type {Array} * @memberof OrderListPlaceOtoResponseResult */ orders?: Array; /** * * @type {Array} * @memberof OrderListPlaceOtoResponseResult */ orderReports?: Array; } //#endregion //#region src/websocket-api/types/order-list-place-oto-response.d.ts /** * * @export * @interface OrderListPlaceOtoResponse */ interface OrderListPlaceOtoResponse { /** * * @type {string} * @memberof OrderListPlaceOtoResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtoResponse */ status?: number | bigint; /** * * @type {OrderListPlaceOtoResponseResult} * @memberof OrderListPlaceOtoResponse */ result?: OrderListPlaceOtoResponseResult; /** * * @type {Array} * @memberof OrderListPlaceOtoResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-list-place-otoco-response-result-order-reports-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceOtocoResponseResultOrderReportsInner */ interface OrderListPlaceOtocoResponseResultOrderReportsInner { /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-list-place-otoco-response-result-orders-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceOtocoResponseResultOrdersInner */ interface OrderListPlaceOtocoResponseResultOrdersInner { /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrdersInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResultOrdersInner */ orderId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResultOrdersInner */ clientOrderId?: string; } //#endregion //#region src/websocket-api/types/order-list-place-otoco-response-result.d.ts /** * * @export * @interface OrderListPlaceOtocoResponseResult */ interface OrderListPlaceOtocoResponseResult { /** * * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResult */ contingencyType?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResult */ listStatusType?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResult */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResult */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtocoResponseResult */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceOtocoResponseResult */ symbol?: string; /** * * @type {Array} * @memberof OrderListPlaceOtocoResponseResult */ orders?: Array; /** * * @type {Array} * @memberof OrderListPlaceOtocoResponseResult */ orderReports?: Array; } //#endregion //#region src/websocket-api/types/order-list-place-otoco-response.d.ts /** * * @export * @interface OrderListPlaceOtocoResponse */ interface OrderListPlaceOtocoResponse { /** * * @type {string} * @memberof OrderListPlaceOtocoResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceOtocoResponse */ status?: number | bigint; /** * * @type {OrderListPlaceOtocoResponseResult} * @memberof OrderListPlaceOtocoResponse */ result?: OrderListPlaceOtocoResponseResult; /** * * @type {Array} * @memberof OrderListPlaceOtocoResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-list-place-response-result-order-reports-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderListPlaceResponseResultOrderReportsInner */ interface OrderListPlaceResponseResultOrderReportsInner { /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceResponseResultOrderReportsInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderListPlaceResponseResultOrderReportsInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceResponseResultOrderReportsInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ price?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ origQty?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ executedQty?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ status?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ timeInForce?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ type?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ side?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceResponseResultOrderReportsInner */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ selfTradePreventionMode?: string; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ icebergQty?: string; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderListPlaceResponseResultOrderReportsInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ preventedQuantity?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ stopPrice?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceResponseResultOrderReportsInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderListPlaceResponseResultOrderReportsInner */ strategyType?: number | bigint; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderListPlaceResponseResultOrderReportsInner */ trailingDelta?: number | bigint; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderListPlaceResponseResultOrderReportsInner */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderListPlaceResponseResultOrderReportsInner */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderListPlaceResponseResultOrderReportsInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderListPlaceResponseResultOrderReportsInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-list-place-response-result.d.ts /** * * @export * @interface OrderListPlaceResponseResult */ interface OrderListPlaceResponseResult { /** * * @type {number | bigint} * @memberof OrderListPlaceResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceResponseResult */ contingencyType?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResult */ listStatusType?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResult */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListPlaceResponseResult */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceResponseResult */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListPlaceResponseResult */ symbol?: string; /** * * @type {Array} * @memberof OrderListPlaceResponseResult */ orders?: Array; /** * * @type {Array} * @memberof OrderListPlaceResponseResult */ orderReports?: Array; } //#endregion //#region src/websocket-api/types/order-list-place-response.d.ts /** * * @export * @interface OrderListPlaceResponse */ interface OrderListPlaceResponse { /** * * @type {string} * @memberof OrderListPlaceResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderListPlaceResponse */ status?: number | bigint; /** * * @type {OrderListPlaceResponseResult} * @memberof OrderListPlaceResponse */ result?: OrderListPlaceResponseResult; /** * * @type {Array} * @memberof OrderListPlaceResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-list-status-response-result.d.ts /** * * @export * @interface OrderListStatusResponseResult */ interface OrderListStatusResponseResult { /** * * @type {number | bigint} * @memberof OrderListStatusResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderListStatusResponseResult */ contingencyType?: string; /** * * @type {string} * @memberof OrderListStatusResponseResult */ listStatusType?: string; /** * * @type {string} * @memberof OrderListStatusResponseResult */ listOrderStatus?: string; /** * * @type {string} * @memberof OrderListStatusResponseResult */ listClientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderListStatusResponseResult */ transactionTime?: number | bigint; /** * * @type {string} * @memberof OrderListStatusResponseResult */ symbol?: string; /** * * @type {Array} * @memberof OrderListStatusResponseResult */ orders?: Array; } //#endregion //#region src/websocket-api/types/order-list-status-response.d.ts /** * * @export * @interface OrderListStatusResponse */ interface OrderListStatusResponse { /** * * @type {string} * @memberof OrderListStatusResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderListStatusResponse */ status?: number | bigint; /** * * @type {OrderListStatusResponseResult} * @memberof OrderListStatusResponse */ result?: OrderListStatusResponseResult; /** * * @type {Array} * @memberof OrderListStatusResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-place-response-result-fills-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderPlaceResponseResultFillsInner */ interface OrderPlaceResponseResultFillsInner { /** * * @type {string} * @memberof OrderPlaceResponseResultFillsInner */ price?: string; /** * * @type {string} * @memberof OrderPlaceResponseResultFillsInner */ qty?: string; /** * * @type {string} * @memberof OrderPlaceResponseResultFillsInner */ commission?: string; /** * * @type {string} * @memberof OrderPlaceResponseResultFillsInner */ commissionAsset?: string; /** * * @type {number | bigint} * @memberof OrderPlaceResponseResultFillsInner */ tradeId?: number | bigint; } //#endregion //#region src/websocket-api/types/order-place-response-result.d.ts /** * * @export * @interface OrderPlaceResponseResult */ interface OrderPlaceResponseResult { /** * * @type {string} * @memberof OrderPlaceResponseResult */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderPlaceResponseResult */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof OrderPlaceResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderPlaceResponseResult */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof OrderPlaceResponseResult */ transactTime?: number | bigint; /** * * @type {string} * @memberof OrderPlaceResponseResult */ price?: string; /** * * @type {string} * @memberof OrderPlaceResponseResult */ origQty?: string; /** * * @type {string} * @memberof OrderPlaceResponseResult */ executedQty?: string; /** * * @type {string} * @memberof OrderPlaceResponseResult */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderPlaceResponseResult */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderPlaceResponseResult */ status?: string; /** * * @type {string} * @memberof OrderPlaceResponseResult */ timeInForce?: string; /** * * @type {string} * @memberof OrderPlaceResponseResult */ type?: string; /** * * @type {string} * @memberof OrderPlaceResponseResult */ side?: string; /** * * @type {number | bigint} * @memberof OrderPlaceResponseResult */ workingTime?: number | bigint; /** * * @type {string} * @memberof OrderPlaceResponseResult */ selfTradePreventionMode?: string; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof OrderPlaceResponseResult */ stopPrice?: string; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof OrderPlaceResponseResult */ trailingDelta?: number | bigint; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof OrderPlaceResponseResult */ icebergQty?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderPlaceResponseResult */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof OrderPlaceResponseResult */ strategyType?: number | bigint; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof OrderPlaceResponseResult */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof OrderPlaceResponseResult */ preventedQuantity?: string; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof OrderPlaceResponseResult */ trailingTime?: number | bigint; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderPlaceResponseResult */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderPlaceResponseResult */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderPlaceResponseResult */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderPlaceResponseResult */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderPlaceResponseResult */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderPlaceResponseResult */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderPlaceResponseResult */ expiryReason?: string; /** * * @type {Array} * @memberof OrderPlaceResponseResult */ fills?: Array; } //#endregion //#region src/websocket-api/types/order-place-response.d.ts /** * * @export * @interface OrderPlaceResponse */ interface OrderPlaceResponse { /** * * @type {string} * @memberof OrderPlaceResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderPlaceResponse */ status?: number | bigint; /** * * @type {OrderPlaceResponseResult} * @memberof OrderPlaceResponse */ result?: OrderPlaceResponseResult; /** * * @type {Array} * @memberof OrderPlaceResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-status-response-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderStatusResponseResult */ interface OrderStatusResponseResult { /** * * @type {string} * @memberof OrderStatusResponseResult */ symbol?: string; /** * * @type {number | bigint} * @memberof OrderStatusResponseResult */ orderId?: number | bigint; /** * Present only for orders that belong to an order list. * @type {number | bigint} * @memberof OrderStatusResponseResult */ orderListId?: number | bigint; /** * * @type {string} * @memberof OrderStatusResponseResult */ clientOrderId?: string; /** * * @type {string} * @memberof OrderStatusResponseResult */ price?: string; /** * * @type {string} * @memberof OrderStatusResponseResult */ origQty?: string; /** * * @type {string} * @memberof OrderStatusResponseResult */ executedQty?: string; /** * Always present. Zero if the order type does not use `quoteOrderQty`. * @type {string} * @memberof OrderStatusResponseResult */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof OrderStatusResponseResult */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof OrderStatusResponseResult */ status?: string; /** * * @type {string} * @memberof OrderStatusResponseResult */ timeInForce?: string; /** * * @type {string} * @memberof OrderStatusResponseResult */ type?: string; /** * * @type {string} * @memberof OrderStatusResponseResult */ side?: string; /** * Always present. Zero if the order type does not use `stopPrice`. * @type {string} * @memberof OrderStatusResponseResult */ stopPrice?: string; /** * Present only if `trailingDelta` was set on the order. * @type {number | bigint} * @memberof OrderStatusResponseResult */ trailingDelta?: number | bigint; /** * Present only if `trailingDelta` was set on the order. * @type {number | bigint} * @memberof OrderStatusResponseResult */ trailingTime?: number | bigint; /** * Always present. Zero for non-iceberg orders. * @type {string} * @memberof OrderStatusResponseResult */ icebergQty?: string; /** * Order placement time. * @type {number | bigint} * @memberof OrderStatusResponseResult */ time?: number | bigint; /** * Time of the last update to the order. * @type {number | bigint} * @memberof OrderStatusResponseResult */ updateTime?: number | bigint; /** * * @type {boolean} * @memberof OrderStatusResponseResult */ isWorking?: boolean; /** * * @type {number | bigint} * @memberof OrderStatusResponseResult */ workingTime?: number | bigint; /** * Present only if `strategyId` was set on the order. * @type {number | bigint} * @memberof OrderStatusResponseResult */ strategyId?: number | bigint; /** * Present only if `strategyType` was set on the order. * @type {number | bigint} * @memberof OrderStatusResponseResult */ strategyType?: number | bigint; /** * * @type {string} * @memberof OrderStatusResponseResult */ selfTradePreventionMode?: string; /** * Present only if the order expired due to STP. * @type {number | bigint} * @memberof OrderStatusResponseResult */ preventedMatchId?: number | bigint; /** * Present only if the order expired due to STP. * @type {string} * @memberof OrderStatusResponseResult */ preventedQuantity?: string; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof OrderStatusResponseResult */ usedSor?: boolean; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof OrderStatusResponseResult */ workingFloor?: string; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof OrderStatusResponseResult */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof OrderStatusResponseResult */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof OrderStatusResponseResult */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof OrderStatusResponseResult */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof OrderStatusResponseResult */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/order-status-response.d.ts /** * * @export * @interface OrderStatusResponse */ interface OrderStatusResponse { /** * * @type {string} * @memberof OrderStatusResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderStatusResponse */ status?: number | bigint; /** * * @type {OrderStatusResponseResult} * @memberof OrderStatusResponse */ result?: OrderStatusResponseResult; /** * * @type {Array} * @memberof OrderStatusResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/order-test-response-result-discount.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderTestResponseResultDiscount */ interface OrderTestResponseResultDiscount { /** * * @type {boolean} * @memberof OrderTestResponseResultDiscount */ enabledForAccount?: boolean; /** * * @type {boolean} * @memberof OrderTestResponseResultDiscount */ enabledForSymbol?: boolean; /** * * @type {string} * @memberof OrderTestResponseResultDiscount */ discountAsset?: string; /** * * @type {string} * @memberof OrderTestResponseResultDiscount */ discount?: string; } //#endregion //#region src/websocket-api/types/order-test-response-result-standard-commission-for-order.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OrderTestResponseResultStandardCommissionForOrder */ interface OrderTestResponseResultStandardCommissionForOrder { /** * * @type {string} * @memberof OrderTestResponseResultStandardCommissionForOrder */ maker?: string; /** * * @type {string} * @memberof OrderTestResponseResultStandardCommissionForOrder */ taker?: string; } //#endregion //#region src/websocket-api/types/order-test-response-result.d.ts /** * * @export * @interface OrderTestResponseResult */ interface OrderTestResponseResult { /** * * @type {OrderTestResponseResultStandardCommissionForOrder} * @memberof OrderTestResponseResult */ standardCommissionForOrder?: OrderTestResponseResultStandardCommissionForOrder; /** * * @type {OrderTestResponseResultStandardCommissionForOrder} * @memberof OrderTestResponseResult */ specialCommissionForOrder?: OrderTestResponseResultStandardCommissionForOrder; /** * * @type {OrderTestResponseResultStandardCommissionForOrder} * @memberof OrderTestResponseResult */ taxCommissionForOrder?: OrderTestResponseResultStandardCommissionForOrder; /** * * @type {OrderTestResponseResultDiscount} * @memberof OrderTestResponseResult */ discount?: OrderTestResponseResultDiscount; } //#endregion //#region src/websocket-api/types/order-test-response.d.ts /** * * @export * @interface OrderTestResponse */ interface OrderTestResponse { /** * * @type {string} * @memberof OrderTestResponse */ id?: string; /** * * @type {number | bigint} * @memberof OrderTestResponse */ status?: number | bigint; /** * * @type {OrderTestResponseResult} * @memberof OrderTestResponse */ result?: OrderTestResponseResult; /** * * @type {Array} * @memberof OrderTestResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/outbound-account-position-binner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OutboundAccountPositionBInner */ interface OutboundAccountPositionBInner$1 { /** * Asset * @type {string} * @memberof OutboundAccountPositionBInner */ a?: string; /** * Free * @type {string} * @memberof OutboundAccountPositionBInner */ f?: string; /** * Locked * @type {string} * @memberof OutboundAccountPositionBInner */ l?: string; } //#endregion //#region src/websocket-api/types/outbound-account-position.d.ts /** * * @export * @interface OutboundAccountPosition */ interface OutboundAccountPosition$1 { /** * Event Time * @type {number | bigint} * @memberof OutboundAccountPosition */ E?: number | bigint; /** * Time of last account update * @type {number | bigint} * @memberof OutboundAccountPosition */ u?: number | bigint; /** * Balances Array * @type {Array} * @memberof OutboundAccountPosition */ B?: Array; } //#endregion //#region src/websocket-api/types/ping-response.d.ts /** * * @export * @interface PingResponse */ interface PingResponse { /** * * @type {string} * @memberof PingResponse */ id?: string; /** * * @type {number | bigint} * @memberof PingResponse */ status?: number | bigint; /** * * @type {object} * @memberof PingResponse */ result?: object; /** * * @type {Array} * @memberof PingResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/reference-price-calculation-response-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ReferencePriceCalculationResponseResult */ interface ReferencePriceCalculationResponseResult { /** * * @type {string} * @memberof ReferencePriceCalculationResponseResult */ symbol?: string; /** * * @type {string} * @memberof ReferencePriceCalculationResponseResult */ calculationType?: string; /** * If the reference price is being calculated by the matching engine as an arithmetic mean * @type {number | bigint} * @memberof ReferencePriceCalculationResponseResult */ bucketCount?: number | bigint; /** * If the reference price is being calculated by the matching engine as an arithmetic mean * @type {number | bigint} * @memberof ReferencePriceCalculationResponseResult */ bucketWidthMs?: number | bigint; /** * If the reference price is being calculated outside the matching engine * @type {number | bigint} * @memberof ReferencePriceCalculationResponseResult */ externalCalculationId?: number | bigint; } //#endregion //#region src/websocket-api/types/reference-price-calculation-response.d.ts /** * * @export * @interface ReferencePriceCalculationResponse */ interface ReferencePriceCalculationResponse { /** * * @type {string} * @memberof ReferencePriceCalculationResponse */ id?: string; /** * * @type {number | bigint} * @memberof ReferencePriceCalculationResponse */ status?: number | bigint; /** * * @type {ReferencePriceCalculationResponseResult} * @memberof ReferencePriceCalculationResponse */ result?: ReferencePriceCalculationResponseResult; /** * * @type {Array} * @memberof ReferencePriceCalculationResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/reference-price-response-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ReferencePriceResponseResult */ interface ReferencePriceResponseResult { /** * * @type {string} * @memberof ReferencePriceResponseResult */ symbol?: string; /** * * @type {string} * @memberof ReferencePriceResponseResult */ referencePrice?: string; /** * Timestamp when the reference price was valid * @type {number | bigint} * @memberof ReferencePriceResponseResult */ timestamp?: number | bigint; /** * * @type {number | bigint} * @memberof ReferencePriceResponseResult */ code?: number | bigint; /** * * @type {string} * @memberof ReferencePriceResponseResult */ msg?: string; } //#endregion //#region src/websocket-api/types/reference-price-response.d.ts /** * * @export * @interface ReferencePriceResponse */ interface ReferencePriceResponse$1 { /** * * @type {string} * @memberof ReferencePriceResponse */ id?: string; /** * * @type {number | bigint} * @memberof ReferencePriceResponse */ status?: number | bigint; /** * * @type {ReferencePriceResponseResult} * @memberof ReferencePriceResponse */ result?: ReferencePriceResponseResult; /** * * @type {Array} * @memberof ReferencePriceResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/session-logon-response-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 SessionLogonResponseResult */ interface SessionLogonResponseResult { /** * * @type {string} * @memberof SessionLogonResponseResult */ apiKey?: string; /** * * @type {number | bigint} * @memberof SessionLogonResponseResult */ authorizedSince?: number | bigint; /** * * @type {number | bigint} * @memberof SessionLogonResponseResult */ connectedSince?: number | bigint; /** * * @type {boolean} * @memberof SessionLogonResponseResult */ returnRateLimits?: boolean; /** * * @type {number | bigint} * @memberof SessionLogonResponseResult */ serverTime?: number | bigint; /** * Is User Data Stream subscription active? * @type {boolean} * @memberof SessionLogonResponseResult */ userDataStream?: boolean; } //#endregion //#region src/websocket-api/types/session-logon-response.d.ts /** * * @export * @interface SessionLogonResponse */ interface SessionLogonResponse { /** * * @type {string} * @memberof SessionLogonResponse */ id?: string; /** * * @type {number | bigint} * @memberof SessionLogonResponse */ status?: number | bigint; /** * * @type {SessionLogonResponseResult} * @memberof SessionLogonResponse */ result?: SessionLogonResponseResult; } //#endregion //#region src/websocket-api/types/session-logout-response-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 SessionLogoutResponseResult */ interface SessionLogoutResponseResult { /** * * @type {string} * @memberof SessionLogoutResponseResult */ apiKey?: string; /** * * @type {number | bigint} * @memberof SessionLogoutResponseResult */ authorizedSince?: number | bigint; /** * * @type {number | bigint} * @memberof SessionLogoutResponseResult */ connectedSince?: number | bigint; /** * * @type {boolean} * @memberof SessionLogoutResponseResult */ returnRateLimits?: boolean; /** * * @type {number | bigint} * @memberof SessionLogoutResponseResult */ serverTime?: number | bigint; /** * Is User Data Stream subscription active? * @type {boolean} * @memberof SessionLogoutResponseResult */ userDataStream?: boolean; } //#endregion //#region src/websocket-api/types/session-logout-response.d.ts /** * * @export * @interface SessionLogoutResponse */ interface SessionLogoutResponse { /** * * @type {string} * @memberof SessionLogoutResponse */ id?: string; /** * * @type {number | bigint} * @memberof SessionLogoutResponse */ status?: number | bigint; /** * * @type {SessionLogoutResponseResult} * @memberof SessionLogoutResponse */ result?: SessionLogoutResponseResult; } //#endregion //#region src/websocket-api/types/session-status-response-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 SessionStatusResponseResult */ interface SessionStatusResponseResult { /** * * @type {string} * @memberof SessionStatusResponseResult */ apiKey?: string; /** * * @type {number | bigint} * @memberof SessionStatusResponseResult */ authorizedSince?: number | bigint; /** * * @type {number | bigint} * @memberof SessionStatusResponseResult */ connectedSince?: number | bigint; /** * * @type {boolean} * @memberof SessionStatusResponseResult */ returnRateLimits?: boolean; /** * * @type {number | bigint} * @memberof SessionStatusResponseResult */ serverTime?: number | bigint; /** * Is User Data Stream subscription active? * @type {boolean} * @memberof SessionStatusResponseResult */ userDataStream?: boolean; } //#endregion //#region src/websocket-api/types/session-status-response.d.ts /** * * @export * @interface SessionStatusResponse */ interface SessionStatusResponse { /** * * @type {string} * @memberof SessionStatusResponse */ id?: string; /** * * @type {number | bigint} * @memberof SessionStatusResponse */ status?: number | bigint; /** * * @type {SessionStatusResponseResult} * @memberof SessionStatusResponse */ result?: SessionStatusResponseResult; } //#endregion //#region src/websocket-api/types/session-subscriptions-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 SessionSubscriptionsResponseResultInner */ interface SessionSubscriptionsResponseResultInner { /** * * @type {number | bigint} * @memberof SessionSubscriptionsResponseResultInner */ subscriptionId?: number | bigint; } //#endregion //#region src/websocket-api/types/session-subscriptions-response.d.ts /** * * @export * @interface SessionSubscriptionsResponse */ interface SessionSubscriptionsResponse { /** * * @type {string} * @memberof SessionSubscriptionsResponse */ id?: string; /** * * @type {number | bigint} * @memberof SessionSubscriptionsResponse */ status?: number | bigint; /** * * @type {Array} * @memberof SessionSubscriptionsResponse */ result?: Array; } //#endregion //#region src/websocket-api/types/sor-order-place-response-result-inner-fills-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 SorOrderPlaceResponseResultInnerFillsInner */ interface SorOrderPlaceResponseResultInnerFillsInner { /** * * @type {string} * @memberof SorOrderPlaceResponseResultInnerFillsInner */ matchType?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInnerFillsInner */ price?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInnerFillsInner */ qty?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInnerFillsInner */ commission?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInnerFillsInner */ commissionAsset?: string; /** * * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInnerFillsInner */ tradeId?: number | bigint; /** * * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInnerFillsInner */ allocId?: number | bigint; } //#endregion //#region src/websocket-api/types/sor-order-place-response-result-inner.d.ts /** * * @export * @interface SorOrderPlaceResponseResultInner */ interface SorOrderPlaceResponseResultInner { /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ symbol?: string; /** * * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInner */ orderId?: number | bigint; /** * * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInner */ orderListId?: number | bigint; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ clientOrderId?: string; /** * * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInner */ transactTime?: number | bigint; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ price?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ origQty?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ executedQty?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ origQuoteOrderQty?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ cummulativeQuoteQty?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ status?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ timeInForce?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ type?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ side?: string; /** * * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInner */ workingTime?: number | bigint; /** * * @type {Array} * @memberof SorOrderPlaceResponseResultInner */ fills?: Array; /** * Determines whether the order is being filled by the SOR or by the order book. * @type {string} * @memberof SorOrderPlaceResponseResultInner */ workingFloor?: string; /** * * @type {string} * @memberof SorOrderPlaceResponseResultInner */ selfTradePreventionMode?: string; /** * Field that determines whether order used SOR. * @type {boolean} * @memberof SorOrderPlaceResponseResultInner */ usedSor?: boolean; /** * Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders. * @type {string} * @memberof SorOrderPlaceResponseResultInner */ stopPrice?: string; /** * Delta price change required before order activation. * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInner */ trailingDelta?: number | bigint; /** * Appears only if the parameter icebergQty was sent in the request. * @type {string} * @memberof SorOrderPlaceResponseResultInner */ icebergQty?: string; /** * Appears only if the strategyId parameter was provided upon order placement. * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInner */ strategyId?: number | bigint; /** * Appears only if the strategyType parameter was provided upon order placement. * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInner */ strategyType?: number | bigint; /** * Appears only if the order expired due to STP. * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInner */ preventedMatchId?: number | bigint; /** * Order quantity that expired due to STP. * @type {string} * @memberof SorOrderPlaceResponseResultInner */ preventedQuantity?: string; /** * Time when the trailing order is now active and tracking price changes. * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInner */ trailingTime?: number | bigint; /** * Price peg type. Only for pegged orders. * @type {string} * @memberof SorOrderPlaceResponseResultInner */ pegPriceType?: string; /** * Price peg offset type. Only for pegged orders, if requested. * @type {string} * @memberof SorOrderPlaceResponseResultInner */ pegOffsetType?: string; /** * Price peg offset value. Only for pegged orders, if requested. * @type {number | bigint} * @memberof SorOrderPlaceResponseResultInner */ pegOffsetValue?: number | bigint; /** * Current price order is pegged at. Only for pegged orders, once determined. * @type {string} * @memberof SorOrderPlaceResponseResultInner */ peggedPrice?: string; /** * Cause of the order\'s expiration. Appears when an order has expired. * @type {string} * @memberof SorOrderPlaceResponseResultInner */ expiryReason?: string; } //#endregion //#region src/websocket-api/types/sor-order-place-response.d.ts /** * * @export * @interface SorOrderPlaceResponse */ interface SorOrderPlaceResponse { /** * * @type {string} * @memberof SorOrderPlaceResponse */ id?: string; /** * * @type {number | bigint} * @memberof SorOrderPlaceResponse */ status?: number | bigint; /** * * @type {Array} * @memberof SorOrderPlaceResponse */ result?: Array; /** * * @type {Array} * @memberof SorOrderPlaceResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/sor-order-test-response-result.d.ts /** * * @export * @interface SorOrderTestResponseResult */ interface SorOrderTestResponseResult { /** * * @type {OrderTestResponseResultStandardCommissionForOrder} * @memberof SorOrderTestResponseResult */ standardCommissionForOrder?: OrderTestResponseResultStandardCommissionForOrder; /** * * @type {OrderTestResponseResultStandardCommissionForOrder} * @memberof SorOrderTestResponseResult */ taxCommissionForOrder?: OrderTestResponseResultStandardCommissionForOrder; /** * * @type {OrderTestResponseResultDiscount} * @memberof SorOrderTestResponseResult */ discount?: OrderTestResponseResultDiscount; } //#endregion //#region src/websocket-api/types/sor-order-test-response.d.ts /** * * @export * @interface SorOrderTestResponse */ interface SorOrderTestResponse { /** * * @type {string} * @memberof SorOrderTestResponse */ id?: string; /** * * @type {number | bigint} * @memberof SorOrderTestResponse */ status?: number | bigint; /** * * @type {SorOrderTestResponseResult} * @memberof SorOrderTestResponse */ result?: SorOrderTestResponseResult; /** * * @type {Array} * @memberof SorOrderTestResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/ticker24hr-response1-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 Ticker24hrResponse1Result */ interface Ticker24hrResponse1Result { /** * Symbol Name * @type {string} * @memberof Ticker24hrResponse1Result */ symbol?: string; /** * * @type {string} * @memberof Ticker24hrResponse1Result */ priceChange?: string; /** * * @type {string} * @memberof Ticker24hrResponse1Result */ priceChangePercent?: string; /** * * @type {string} * @memberof Ticker24hrResponse1Result */ weightedAvgPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse1Result */ prevClosePrice?: string; /** * Closing price of the interval * @type {string} * @memberof Ticker24hrResponse1Result */ lastPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse1Result */ lastQty?: string; /** * * @type {string} * @memberof Ticker24hrResponse1Result */ bidPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse1Result */ bidQty?: string; /** * * @type {string} * @memberof Ticker24hrResponse1Result */ askPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse1Result */ askQty?: string; /** * Opening price of the Interval * @type {string} * @memberof Ticker24hrResponse1Result */ openPrice?: string; /** * Highest price in the interval * @type {string} * @memberof Ticker24hrResponse1Result */ highPrice?: string; /** * Lowest price in the interval * @type {string} * @memberof Ticker24hrResponse1Result */ lowPrice?: string; /** * Total trade volume (in base asset) * @type {string} * @memberof Ticker24hrResponse1Result */ volume?: string; /** * Total trade volume (in quote asset) * @type {string} * @memberof Ticker24hrResponse1Result */ quoteVolume?: string; /** * Start of the ticker interval * @type {number | bigint} * @memberof Ticker24hrResponse1Result */ openTime?: number | bigint; /** * End of the ticker interval * @type {number | bigint} * @memberof Ticker24hrResponse1Result */ closeTime?: number | bigint; /** * First tradeId * @type {number | bigint} * @memberof Ticker24hrResponse1Result */ firstId?: number | bigint; /** * Last tradeId * @type {number | bigint} * @memberof Ticker24hrResponse1Result */ lastId?: number | bigint; /** * Trade count * @type {number | bigint} * @memberof Ticker24hrResponse1Result */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/ticker24hr-response1.d.ts /** * * @export * @interface Ticker24hrResponse1 */ interface Ticker24hrResponse1 { /** * * @type {string} * @memberof Ticker24hrResponse1 */ id?: string; /** * * @type {number | bigint} * @memberof Ticker24hrResponse1 */ status?: number | bigint; /** * * @type {Ticker24hrResponse1Result} * @memberof Ticker24hrResponse1 */ result?: Ticker24hrResponse1Result; /** * * @type {Array} * @memberof Ticker24hrResponse1 */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/ticker24hr-response2-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 Ticker24hrResponse2ResultInner */ interface Ticker24hrResponse2ResultInner { /** * Symbol Name * @type {string} * @memberof Ticker24hrResponse2ResultInner */ symbol?: string; /** * * @type {string} * @memberof Ticker24hrResponse2ResultInner */ priceChange?: string; /** * * @type {string} * @memberof Ticker24hrResponse2ResultInner */ priceChangePercent?: string; /** * * @type {string} * @memberof Ticker24hrResponse2ResultInner */ weightedAvgPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse2ResultInner */ prevClosePrice?: string; /** * Closing price of the interval * @type {string} * @memberof Ticker24hrResponse2ResultInner */ lastPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse2ResultInner */ lastQty?: string; /** * * @type {string} * @memberof Ticker24hrResponse2ResultInner */ bidPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse2ResultInner */ bidQty?: string; /** * * @type {string} * @memberof Ticker24hrResponse2ResultInner */ askPrice?: string; /** * * @type {string} * @memberof Ticker24hrResponse2ResultInner */ askQty?: string; /** * Opening price of the Interval * @type {string} * @memberof Ticker24hrResponse2ResultInner */ openPrice?: string; /** * Highest price in the interval * @type {string} * @memberof Ticker24hrResponse2ResultInner */ highPrice?: string; /** * Lowest price in the interval * @type {string} * @memberof Ticker24hrResponse2ResultInner */ lowPrice?: string; /** * Total trade volume (in base asset) * @type {string} * @memberof Ticker24hrResponse2ResultInner */ volume?: string; /** * Total trade volume (in quote asset) * @type {string} * @memberof Ticker24hrResponse2ResultInner */ quoteVolume?: string; /** * Start of the ticker interval * @type {number | bigint} * @memberof Ticker24hrResponse2ResultInner */ openTime?: number | bigint; /** * End of the ticker interval * @type {number | bigint} * @memberof Ticker24hrResponse2ResultInner */ closeTime?: number | bigint; /** * First tradeId * @type {number | bigint} * @memberof Ticker24hrResponse2ResultInner */ firstId?: number | bigint; /** * Last tradeId * @type {number | bigint} * @memberof Ticker24hrResponse2ResultInner */ lastId?: number | bigint; /** * Trade count * @type {number | bigint} * @memberof Ticker24hrResponse2ResultInner */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/ticker24hr-response2.d.ts /** * * @export * @interface Ticker24hrResponse2 */ interface Ticker24hrResponse2 { /** * * @type {string} * @memberof Ticker24hrResponse2 */ id?: string; /** * * @type {number | bigint} * @memberof Ticker24hrResponse2 */ status?: number | bigint; /** * * @type {Array} * @memberof Ticker24hrResponse2 */ result?: Array; /** * * @type {Array} * @memberof Ticker24hrResponse2 */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/ticker24hr-response.d.ts /** * @type Ticker24hrResponse */ type Ticker24hrResponse = Ticker24hrResponse1 | Ticker24hrResponse2; //#endregion //#region src/websocket-api/types/ticker-book-response1-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerBookResponse1Result */ interface TickerBookResponse1Result { /** * * @type {string} * @memberof TickerBookResponse1Result */ symbol?: string; /** * best bid price. * @type {string} * @memberof TickerBookResponse1Result */ bidPrice?: string; /** * bid/ask qty. * @type {string} * @memberof TickerBookResponse1Result */ bidQty?: string; /** * best ask price. * @type {string} * @memberof TickerBookResponse1Result */ askPrice?: string; /** * bid/ask qty. * @type {string} * @memberof TickerBookResponse1Result */ askQty?: string; } //#endregion //#region src/websocket-api/types/ticker-book-response1.d.ts /** * * @export * @interface TickerBookResponse1 */ interface TickerBookResponse1 { /** * * @type {string} * @memberof TickerBookResponse1 */ id?: string; /** * * @type {number | bigint} * @memberof TickerBookResponse1 */ status?: number | bigint; /** * * @type {TickerBookResponse1Result} * @memberof TickerBookResponse1 */ result?: TickerBookResponse1Result; /** * * @type {Array} * @memberof TickerBookResponse1 */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/ticker-book-response2-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerBookResponse2ResultInner */ interface TickerBookResponse2ResultInner { /** * * @type {string} * @memberof TickerBookResponse2ResultInner */ symbol?: string; /** * best bid price. * @type {string} * @memberof TickerBookResponse2ResultInner */ bidPrice?: string; /** * bid/ask qty. * @type {string} * @memberof TickerBookResponse2ResultInner */ bidQty?: string; /** * best ask price. * @type {string} * @memberof TickerBookResponse2ResultInner */ askPrice?: string; /** * bid/ask qty. * @type {string} * @memberof TickerBookResponse2ResultInner */ askQty?: string; } //#endregion //#region src/websocket-api/types/ticker-book-response2.d.ts /** * * @export * @interface TickerBookResponse2 */ interface TickerBookResponse2 { /** * * @type {string} * @memberof TickerBookResponse2 */ id?: string; /** * * @type {number | bigint} * @memberof TickerBookResponse2 */ status?: number | bigint; /** * * @type {Array} * @memberof TickerBookResponse2 */ result?: Array; /** * * @type {Array} * @memberof TickerBookResponse2 */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/ticker-book-response.d.ts /** * @type TickerBookResponse */ type TickerBookResponse = TickerBookResponse1 | TickerBookResponse2; //#endregion //#region src/websocket-api/types/ticker-price-response1-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerPriceResponse1Result */ interface TickerPriceResponse1Result { /** * * @type {string} * @memberof TickerPriceResponse1Result */ symbol?: string; /** * * @type {string} * @memberof TickerPriceResponse1Result */ price?: string; } //#endregion //#region src/websocket-api/types/ticker-price-response1.d.ts /** * * @export * @interface TickerPriceResponse1 */ interface TickerPriceResponse1 { /** * * @type {string} * @memberof TickerPriceResponse1 */ id?: string; /** * * @type {number | bigint} * @memberof TickerPriceResponse1 */ status?: number | bigint; /** * * @type {TickerPriceResponse1Result} * @memberof TickerPriceResponse1 */ result?: TickerPriceResponse1Result; /** * * @type {Array} * @memberof TickerPriceResponse1 */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/ticker-price-response2-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerPriceResponse2ResultInner */ interface TickerPriceResponse2ResultInner { /** * * @type {string} * @memberof TickerPriceResponse2ResultInner */ symbol?: string; /** * * @type {string} * @memberof TickerPriceResponse2ResultInner */ price?: string; } //#endregion //#region src/websocket-api/types/ticker-price-response2.d.ts /** * * @export * @interface TickerPriceResponse2 */ interface TickerPriceResponse2 { /** * * @type {string} * @memberof TickerPriceResponse2 */ id?: string; /** * * @type {number | bigint} * @memberof TickerPriceResponse2 */ status?: number | bigint; /** * * @type {Array} * @memberof TickerPriceResponse2 */ result?: Array; /** * * @type {Array} * @memberof TickerPriceResponse2 */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/ticker-price-response.d.ts /** * @type TickerPriceResponse */ type TickerPriceResponse = TickerPriceResponse1 | TickerPriceResponse2; //#endregion //#region src/websocket-api/types/ticker-response1-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerResponse1Result */ interface TickerResponse1Result { /** * * @type {string} * @memberof TickerResponse1Result */ symbol?: string; /** * Absolute price change * @type {string} * @memberof TickerResponse1Result */ priceChange?: string; /** * Relative price change in percent * @type {string} * @memberof TickerResponse1Result */ priceChangePercent?: string; /** * QuoteVolume / Volume * @type {string} * @memberof TickerResponse1Result */ weightedAvgPrice?: string; /** * * @type {string} * @memberof TickerResponse1Result */ openPrice?: string; /** * * @type {string} * @memberof TickerResponse1Result */ highPrice?: string; /** * * @type {string} * @memberof TickerResponse1Result */ lowPrice?: string; /** * * @type {string} * @memberof TickerResponse1Result */ lastPrice?: string; /** * * @type {string} * @memberof TickerResponse1Result */ volume?: string; /** * Sum of (price * volume) for all trades * @type {string} * @memberof TickerResponse1Result */ quoteVolume?: string; /** * Open time for ticker window * @type {number | bigint} * @memberof TickerResponse1Result */ openTime?: number | bigint; /** * Close time for ticker window * @type {number | bigint} * @memberof TickerResponse1Result */ closeTime?: number | bigint; /** * Trade IDs * @type {number | bigint} * @memberof TickerResponse1Result */ firstId?: number | bigint; /** * * @type {number | bigint} * @memberof TickerResponse1Result */ lastId?: number | bigint; /** * Number of trades in the interval * @type {number | bigint} * @memberof TickerResponse1Result */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/ticker-response1.d.ts /** * * @export * @interface TickerResponse1 */ interface TickerResponse1 { /** * * @type {string} * @memberof TickerResponse1 */ id?: string; /** * * @type {number | bigint} * @memberof TickerResponse1 */ status?: number | bigint; /** * * @type {TickerResponse1Result} * @memberof TickerResponse1 */ result?: TickerResponse1Result; /** * * @type {Array} * @memberof TickerResponse1 */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/ticker-response2-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerResponse2ResultInner */ interface TickerResponse2ResultInner { /** * * @type {string} * @memberof TickerResponse2ResultInner */ symbol?: string; /** * Absolute price change * @type {string} * @memberof TickerResponse2ResultInner */ priceChange?: string; /** * Relative price change in percent * @type {string} * @memberof TickerResponse2ResultInner */ priceChangePercent?: string; /** * QuoteVolume / Volume * @type {string} * @memberof TickerResponse2ResultInner */ weightedAvgPrice?: string; /** * * @type {string} * @memberof TickerResponse2ResultInner */ openPrice?: string; /** * * @type {string} * @memberof TickerResponse2ResultInner */ highPrice?: string; /** * * @type {string} * @memberof TickerResponse2ResultInner */ lowPrice?: string; /** * * @type {string} * @memberof TickerResponse2ResultInner */ lastPrice?: string; /** * * @type {string} * @memberof TickerResponse2ResultInner */ volume?: string; /** * Sum of (price * volume) for all trades * @type {string} * @memberof TickerResponse2ResultInner */ quoteVolume?: string; /** * Open time for ticker window * @type {number | bigint} * @memberof TickerResponse2ResultInner */ openTime?: number | bigint; /** * Close time for ticker window * @type {number | bigint} * @memberof TickerResponse2ResultInner */ closeTime?: number | bigint; /** * Trade IDs * @type {number | bigint} * @memberof TickerResponse2ResultInner */ firstId?: number | bigint; /** * * @type {number | bigint} * @memberof TickerResponse2ResultInner */ lastId?: number | bigint; /** * Number of trades in the interval * @type {number | bigint} * @memberof TickerResponse2ResultInner */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/ticker-response2.d.ts /** * * @export * @interface TickerResponse2 */ interface TickerResponse2 { /** * * @type {string} * @memberof TickerResponse2 */ id?: string; /** * * @type {number | bigint} * @memberof TickerResponse2 */ status?: number | bigint; /** * * @type {Array} * @memberof TickerResponse2 */ result?: Array; /** * * @type {Array} * @memberof TickerResponse2 */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/ticker-response.d.ts /** * @type TickerResponse */ type TickerResponse$1 = TickerResponse1 | TickerResponse2; //#endregion //#region src/websocket-api/types/ticker-trading-day-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerTradingDayResponseResultInner */ interface TickerTradingDayResponseResultInner { /** * * @type {string} * @memberof TickerTradingDayResponseResultInner */ symbol?: string; /** * Absolute price change * @type {string} * @memberof TickerTradingDayResponseResultInner */ priceChange?: string; /** * Relative price change in percent * @type {string} * @memberof TickerTradingDayResponseResultInner */ priceChangePercent?: string; /** * quoteVolume / volume * @type {string} * @memberof TickerTradingDayResponseResultInner */ weightedAvgPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponseResultInner */ openPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponseResultInner */ highPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponseResultInner */ lowPrice?: string; /** * * @type {string} * @memberof TickerTradingDayResponseResultInner */ lastPrice?: string; /** * Volume in base asset * @type {string} * @memberof TickerTradingDayResponseResultInner */ volume?: string; /** * Volume in quote asset * @type {string} * @memberof TickerTradingDayResponseResultInner */ quoteVolume?: string; /** * * @type {number | bigint} * @memberof TickerTradingDayResponseResultInner */ openTime?: number | bigint; /** * * @type {number | bigint} * @memberof TickerTradingDayResponseResultInner */ closeTime?: number | bigint; /** * Trade ID of the first trade in the interval * @type {number | bigint} * @memberof TickerTradingDayResponseResultInner */ firstId?: number | bigint; /** * Trade ID of the last trade in the interval * @type {number | bigint} * @memberof TickerTradingDayResponseResultInner */ lastId?: number | bigint; /** * Number of trades in the interval * @type {number | bigint} * @memberof TickerTradingDayResponseResultInner */ count?: number | bigint; } //#endregion //#region src/websocket-api/types/ticker-trading-day-response.d.ts /** * * @export * @interface TickerTradingDayResponse */ interface TickerTradingDayResponse { /** * * @type {string} * @memberof TickerTradingDayResponse */ id?: string; /** * * @type {number | bigint} * @memberof TickerTradingDayResponse */ status?: number | bigint; /** * * @type {Array} * @memberof TickerTradingDayResponse */ result?: Array; /** * * @type {Array} * @memberof TickerTradingDayResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/time-response-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TimeResponseResult */ interface TimeResponseResult { /** * * @type {number | bigint} * @memberof TimeResponseResult */ serverTime?: number | bigint; } //#endregion //#region src/websocket-api/types/time-response.d.ts /** * * @export * @interface TimeResponse */ interface TimeResponse { /** * * @type {string} * @memberof TimeResponse */ id?: string; /** * * @type {number | bigint} * @memberof TimeResponse */ status?: number | bigint; /** * * @type {TimeResponseResult} * @memberof TimeResponse */ result?: TimeResponseResult; /** * * @type {Array} * @memberof TimeResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/trades-aggregate-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TradesAggregateResponseResultInner */ interface TradesAggregateResponseResultInner { /** * Aggregate tradeId * @type {number | bigint} * @memberof TradesAggregateResponseResultInner */ a?: number | bigint; /** * Price * @type {string} * @memberof TradesAggregateResponseResultInner */ p?: string; /** * Quantity * @type {string} * @memberof TradesAggregateResponseResultInner */ q?: string; /** * First tradeId * @type {number | bigint} * @memberof TradesAggregateResponseResultInner */ f?: number | bigint; /** * Last tradeId * @type {number | bigint} * @memberof TradesAggregateResponseResultInner */ l?: number | bigint; /** * Timestamp * @type {number | bigint} * @memberof TradesAggregateResponseResultInner */ T?: number | bigint; /** * Was the buyer the maker? * @type {boolean} * @memberof TradesAggregateResponseResultInner */ m?: boolean; /** * Was the trade the best price match? * @type {boolean} * @memberof TradesAggregateResponseResultInner */ M?: boolean; } //#endregion //#region src/websocket-api/types/trades-aggregate-response.d.ts /** * * @export * @interface TradesAggregateResponse */ interface TradesAggregateResponse { /** * * @type {string} * @memberof TradesAggregateResponse */ id?: string; /** * * @type {number | bigint} * @memberof TradesAggregateResponse */ status?: number | bigint; /** * * @type {Array} * @memberof TradesAggregateResponse */ result?: Array; /** * * @type {Array} * @memberof TradesAggregateResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/trades-historical-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TradesHistoricalResponseResultInner */ interface TradesHistoricalResponseResultInner { /** * * @type {number | bigint} * @memberof TradesHistoricalResponseResultInner */ id?: number | bigint; /** * * @type {string} * @memberof TradesHistoricalResponseResultInner */ price?: string; /** * * @type {string} * @memberof TradesHistoricalResponseResultInner */ qty?: string; /** * * @type {string} * @memberof TradesHistoricalResponseResultInner */ quoteQty?: string; /** * * @type {number | bigint} * @memberof TradesHistoricalResponseResultInner */ time?: number | bigint; /** * * @type {boolean} * @memberof TradesHistoricalResponseResultInner */ isBuyerMaker?: boolean; /** * * @type {boolean} * @memberof TradesHistoricalResponseResultInner */ isBestMatch?: boolean; } //#endregion //#region src/websocket-api/types/trades-historical-response.d.ts /** * * @export * @interface TradesHistoricalResponse */ interface TradesHistoricalResponse { /** * * @type {string} * @memberof TradesHistoricalResponse */ id?: string; /** * * @type {number | bigint} * @memberof TradesHistoricalResponse */ status?: number | bigint; /** * * @type {Array} * @memberof TradesHistoricalResponse */ result?: Array; /** * * @type {Array} * @memberof TradesHistoricalResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/trades-recent-response-result-inner.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TradesRecentResponseResultInner */ interface TradesRecentResponseResultInner { /** * * @type {number | bigint} * @memberof TradesRecentResponseResultInner */ id?: number | bigint; /** * * @type {string} * @memberof TradesRecentResponseResultInner */ price?: string; /** * * @type {string} * @memberof TradesRecentResponseResultInner */ qty?: string; /** * * @type {string} * @memberof TradesRecentResponseResultInner */ quoteQty?: string; /** * * @type {number | bigint} * @memberof TradesRecentResponseResultInner */ time?: number | bigint; /** * * @type {boolean} * @memberof TradesRecentResponseResultInner */ isBuyerMaker?: boolean; /** * * @type {boolean} * @memberof TradesRecentResponseResultInner */ isBestMatch?: boolean; } //#endregion //#region src/websocket-api/types/trades-recent-response.d.ts /** * * @export * @interface TradesRecentResponse */ interface TradesRecentResponse { /** * * @type {string} * @memberof TradesRecentResponse */ id?: string; /** * * @type {number | bigint} * @memberof TradesRecentResponse */ status?: number | bigint; /** * * @type {Array} * @memberof TradesRecentResponse */ result?: Array; /** * * @type {Array} * @memberof TradesRecentResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/ui-klines-response.d.ts /** * * @export * @interface UiKlinesResponse */ interface UiKlinesResponse { /** * * @type {string} * @memberof UiKlinesResponse */ id?: string; /** * * @type {number | bigint} * @memberof UiKlinesResponse */ status?: number | bigint; /** * * @type {Array>} * @memberof UiKlinesResponse */ result?: Array>; /** * * @type {Array} * @memberof UiKlinesResponse */ rateLimits?: Array; } //#endregion //#region src/websocket-api/types/user-data-stream-events-response.d.ts /** * @type UserDataStreamEventsResponse */ type UserDataStreamEventsResponse$1 = ({ e: 'balanceUpdate'; } & BalanceUpdate$1) | ({ e: 'eventStreamTerminated'; } & EventStreamTerminated$1) | ({ e: 'executionReport'; } & ExecutionReport$1) | ({ e: 'externalLockUpdate'; } & ExternalLockUpdate$1) | ({ e: 'listStatus'; } & ListStatus$1) | ({ e: 'outboundAccountPosition'; } & OutboundAccountPosition$1); //#endregion //#region src/websocket-api/types/user-data-stream-subscribe-response-result.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 UserDataStreamSubscribeResponseResult */ interface UserDataStreamSubscribeResponseResult { /** * * @type {number | bigint} * @memberof UserDataStreamSubscribeResponseResult */ subscriptionId?: number | bigint; } //#endregion //#region src/websocket-api/types/user-data-stream-subscribe-response.d.ts /** * * @export * @interface UserDataStreamSubscribeResponse */ interface UserDataStreamSubscribeResponse { /** * * @type {string} * @memberof UserDataStreamSubscribeResponse */ id?: string; /** * * @type {number | bigint} * @memberof UserDataStreamSubscribeResponse */ status?: number | bigint; /** * * @type {UserDataStreamSubscribeResponseResult} * @memberof UserDataStreamSubscribeResponse */ result?: UserDataStreamSubscribeResponseResult; } //#endregion //#region src/websocket-api/types/user-data-stream-subscribe-signature-response.d.ts /** * * @export * @interface UserDataStreamSubscribeSignatureResponse */ interface UserDataStreamSubscribeSignatureResponse { /** * * @type {string} * @memberof UserDataStreamSubscribeSignatureResponse */ id?: string; /** * * @type {number | bigint} * @memberof UserDataStreamSubscribeSignatureResponse */ status?: number | bigint; /** * * @type {UserDataStreamSubscribeResponseResult} * @memberof UserDataStreamSubscribeSignatureResponse */ result?: UserDataStreamSubscribeResponseResult; } //#endregion //#region src/websocket-api/types/user-data-stream-unsubscribe-response.d.ts /** * Spot WebSocket API * * Access market data, manage accounts, and trade on Binance Spot. * * 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 UserDataStreamUnsubscribeResponse */ interface UserDataStreamUnsubscribeResponse { /** * * @type {string} * @memberof UserDataStreamUnsubscribeResponse */ id?: string; /** * * @type {number | bigint} * @memberof UserDataStreamUnsubscribeResponse */ status?: number | bigint; /** * * @type {object} * @memberof UserDataStreamUnsubscribeResponse */ result?: object; } //#endregion //#region src/websocket-api/modules/account-api.d.ts /** * AccountApi - interface * * @interface AccountApi */ interface AccountApiInterface { /** * Get current account commission rates. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Account Commission Rates (USER_DATA) * @param {AccountCommissionRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ accountCommission(requestParameters: AccountCommissionRequest): Promise>; /** * Query your current unfilled order count for all intervals. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Unfilled Order Count (USER_DATA) * @param {AccountRateLimitsOrdersRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ accountRateLimitsOrders(requestParameters?: AccountRateLimitsOrdersRequest): Promise>; /** * Query information about your account. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * @summary Account information (USER_DATA) * @param {AccountStatusRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ accountStatus(requestParameters?: AccountStatusRequest): Promise>; /** * Query information about all your order lists, filtered by time range. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Notes: * If `startTime` and/or `endTime` are specified, `fromId` is ignored. * Order lists are filtered by `transactionTime` of the last order list execution status update. * If `fromId` is specified, return order lists with order list ID >= `fromId`. * If no condition is specified, the most recent order lists are returned. * The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account order list history (USER_DATA) * @param {AllOrderListsRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ allOrderLists(requestParameters?: AllOrderListsRequest): Promise>; /** * Query information about all your orders – active, canceled, filled – filtered by time range. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Notes: * * If `startTime` and/or `endTime` are specified, `orderId` is ignored. * * Orders are filtered by `time` of the last execution status update. * * If `orderId` is specified, return orders with order ID >= `orderId`. * * If no condition is specified, the most recent orders are returned. * * For some historical orders the `cummulativeQuoteQty` response field may be negative, * meaning the data is not available at this time. * * The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account order history (USER_DATA) * @param {AllOrdersRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ allOrders(requestParameters: AllOrdersRequest): Promise>; /** * Retrieves allocations resulting from SOR order placement. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Supported parameter combinations: * * Parameters | Response | * ------------------------------------------- | -------- | * `symbol` | allocations from oldest to newest | * `symbol` + `startTime` | oldest allocations since `startTime` | * `symbol` + `endTime` | newest allocations until `endTime` | * `symbol` + `startTime` + `endTime` | allocations within the time range | * `symbol` + `fromAllocationId` | allocations by allocation ID | * `symbol` + `orderId` | allocations related to an order starting with oldest | * `symbol` + `orderId` + `fromAllocationId` | allocations related to an order by allocation ID | * **Note:** The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account allocations (USER_DATA) * @param {MyAllocationsRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ myAllocations(requestParameters: MyAllocationsRequest): Promise>; /** * Retrieves the list of [filters](/products/spot/filters) relevant to an account on a given symbol. This is the only method * that shows if an account has [`MAX_ASSET`](/products/spot/filters#max_asset) filters applied to it. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Query Relevant Filters (USER_DATA) * @param {MyFiltersRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ myFilters(requestParameters: MyFiltersRequest): Promise>; /** * Displays the list of orders that were expired due to STP. * * These are the combinations supported: * * `symbol` + `preventedMatchId` * `symbol` + `orderId` * `symbol` + `orderId` + `fromPreventedMatchId` (`limit` will default to 500) * `symbol` + `orderId` + `fromPreventedMatchId` + `limit` * * Weight: Case | Weight * ---- | ----- * If `symbol` is invalid | 2 * Querying by `preventedMatchId` | 2 * Querying by `orderId` | 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Account prevented matches (USER_DATA) * @param {MyPreventedMatchesRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ myPreventedMatches(requestParameters: MyPreventedMatchesRequest): Promise>; /** * Query information about all your trades, filtered by time range. * * Weight: Condition| Weight| * ---| --- * |Without orderId|20| * |With orderId|5| * * Security Type: USER_DATA * * Notes: * Data Source: Memory => Database * * Notes: * - If `fromId` is specified, return trades with trade ID >= `fromId`. * - If `startTime` and/or `endTime` are specified, trades are filtered by execution time (`time`). * - `fromId` cannot be used together with `startTime` and `endTime`. * - If `orderId` is specified, only trades related to that order are returned. * - `startTime` and `endTime` cannot be used together with `orderId`. * - If no condition is specified, the most recent trades are returned. * - The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account trade history (USER_DATA) * @param {MyTradesRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ myTrades(requestParameters: MyTradesRequest): Promise>; /** * Query execution status of all open order lists. * * If you need to continuously monitor order status updates, please consider using WebSocket Streams: * * `userDataStream.subscribe` if on an authenticated session * `userDataStream.subscribe.signature` if subscribing through signature subscription * * Weight(IP): 6 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory -> Database * * @summary Current open Order lists (USER_DATA) * @param {OpenOrderListsStatusRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ openOrderListsStatus(requestParameters?: OpenOrderListsStatusRequest): Promise>; /** * Query execution status of all open orders. * * If you need to continuously monitor order status updates, please consider using WebSocket Streams: * * `userDataStream.subscribe` if on an authenticated session * `userDataStream.subscribe.signature` if subscribing through signature subscription * * Weight: | Parameter | Weight | * | --------- | ------ | * | `symbol` | 6 | * | none | 80 | * * Security Type: USER_DATA * * Notes: * Data Source: Memory => Database * * @summary Current open orders (USER_DATA) * @param {OpenOrdersStatusRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ openOrdersStatus(requestParameters?: OpenOrdersStatusRequest): Promise>; /** * Queries all amendments of a single order. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Order Amendments (USER_DATA) * @param {OrderAmendmentsRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ orderAmendments(requestParameters: OrderAmendmentsRequest): Promise>; /** * Check execution status of an Order list. * * For execution status of individual orders, use `order.status`. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Notes: * * `origClientOrderId` refers to `listClientOrderId` of the order list itself. * * If both `origClientOrderId` and `orderListId` parameters are specified, * only `origClientOrderId` is used and `orderListId` is ignored. * * @summary Query Order list (USER_DATA) * @param {OrderListStatusRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ orderListStatus(requestParameters?: OrderListStatusRequest): Promise>; /** * Check execution status of an order. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * Notes: * * If both `orderId` and `origClientOrderId` are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * For some historical orders the `cummulativeQuoteQty` response field may be negative, * meaning the data is not available at this time. * * @summary Query order (USER_DATA) * @param {OrderStatusRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AccountApiInterface */ orderStatus(requestParameters: OrderStatusRequest): Promise>; } /** * Request parameters for accountCommission operation in AccountApi. * @interface AccountCommissionRequest */ interface AccountCommissionRequest { /** * * @type {string} * @memberof AccountApiAccountCommission */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof AccountApiAccountCommission */ readonly id?: string; } /** * Request parameters for accountRateLimitsOrders operation in AccountApi. * @interface AccountRateLimitsOrdersRequest */ interface AccountRateLimitsOrdersRequest { /** * Client-generated request identifier. * @type {string} * @memberof AccountApiAccountRateLimitsOrders */ readonly id?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiAccountRateLimitsOrders */ readonly recvWindow?: number; } /** * Request parameters for accountStatus operation in AccountApi. * @interface AccountStatusRequest */ interface AccountStatusRequest { /** * Client-generated request identifier. * @type {string} * @memberof AccountApiAccountStatus */ readonly id?: string; /** * When set to `true`, emits only the non-zero balances of an account. Default value: `false`. * @type {boolean} * @memberof AccountApiAccountStatus */ readonly omitZeroBalances?: boolean; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiAccountStatus */ readonly recvWindow?: number; } /** * Request parameters for allOrderLists operation in AccountApi. * @interface AllOrderListsRequest */ interface AllOrderListsRequest { /** * Client-generated request identifier. * @type {string} * @memberof AccountApiAllOrderLists */ readonly id?: string; /** * Order list ID to begin at * @type {number} * @memberof AccountApiAllOrderLists */ readonly fromId?: number; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiAllOrderLists */ readonly startTime?: number | bigint; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiAllOrderLists */ readonly endTime?: number | bigint; /** * Default: 500; Maximum: 1000 * @type {number} * @memberof AccountApiAllOrderLists */ readonly limit?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiAllOrderLists */ readonly recvWindow?: number; } /** * Request parameters for allOrders operation in AccountApi. * @interface AllOrdersRequest */ interface AllOrdersRequest { /** * * @type {string} * @memberof AccountApiAllOrders */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof AccountApiAllOrders */ readonly id?: string; /** * Order ID to begin at * @type {number | bigint} * @memberof AccountApiAllOrders */ readonly orderId?: number | bigint; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiAllOrders */ readonly startTime?: number | bigint; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiAllOrders */ readonly endTime?: number | bigint; /** * Default: 500; Maximum: 1000 * @type {number} * @memberof AccountApiAllOrders */ readonly limit?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiAllOrders */ readonly recvWindow?: number; } /** * Request parameters for myAllocations operation in AccountApi. * @interface MyAllocationsRequest */ interface MyAllocationsRequest { /** * * @type {string} * @memberof AccountApiMyAllocations */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof AccountApiMyAllocations */ readonly id?: string; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiMyAllocations */ readonly startTime?: number | bigint; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiMyAllocations */ readonly endTime?: number | bigint; /** * Allocation ID to begin at * @type {number} * @memberof AccountApiMyAllocations */ readonly fromAllocationId?: number; /** * Default: 500; Maximum: 1000 * @type {number} * @memberof AccountApiMyAllocations */ readonly limit?: number; /** * Order ID * @type {number | bigint} * @memberof AccountApiMyAllocations */ readonly orderId?: number | bigint; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiMyAllocations */ readonly recvWindow?: number; } /** * Request parameters for myFilters operation in AccountApi. * @interface MyFiltersRequest */ interface MyFiltersRequest { /** * * @type {string} * @memberof AccountApiMyFilters */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof AccountApiMyFilters */ readonly id?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiMyFilters */ readonly recvWindow?: number; } /** * Request parameters for myPreventedMatches operation in AccountApi. * @interface MyPreventedMatchesRequest */ interface MyPreventedMatchesRequest { /** * * @type {string} * @memberof AccountApiMyPreventedMatches */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof AccountApiMyPreventedMatches */ readonly id?: string; /** * Prevented match ID * @type {number | bigint} * @memberof AccountApiMyPreventedMatches */ readonly preventedMatchId?: number | bigint; /** * Order ID * @type {number | bigint} * @memberof AccountApiMyPreventedMatches */ readonly orderId?: number | bigint; /** * Prevented match ID to begin at * @type {number | bigint} * @memberof AccountApiMyPreventedMatches */ readonly fromPreventedMatchId?: number | bigint; /** * Default: 500; Maximum: 1000 * @type {number} * @memberof AccountApiMyPreventedMatches */ readonly limit?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiMyPreventedMatches */ readonly recvWindow?: number; } /** * Request parameters for myTrades operation in AccountApi. * @interface MyTradesRequest */ interface MyTradesRequest { /** * * @type {string} * @memberof AccountApiMyTrades */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof AccountApiMyTrades */ readonly id?: string; /** * This can only be used in combination with `symbol`. * @type {number | bigint} * @memberof AccountApiMyTrades */ readonly orderId?: number | bigint; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiMyTrades */ readonly startTime?: number | bigint; /** * Timestamp in ms * @type {number | bigint} * @memberof AccountApiMyTrades */ readonly endTime?: number | bigint; /** * First trade ID to query * @type {number} * @memberof AccountApiMyTrades */ readonly fromId?: number; /** * Default: 500; Maximum: 1000 * @type {number} * @memberof AccountApiMyTrades */ readonly limit?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiMyTrades */ readonly recvWindow?: number; } /** * Request parameters for openOrderListsStatus operation in AccountApi. * @interface OpenOrderListsStatusRequest */ interface OpenOrderListsStatusRequest { /** * Client-generated request identifier. * @type {string} * @memberof AccountApiOpenOrderListsStatus */ readonly id?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiOpenOrderListsStatus */ readonly recvWindow?: number; } /** * Request parameters for openOrdersStatus operation in AccountApi. * @interface OpenOrdersStatusRequest */ interface OpenOrdersStatusRequest { /** * Client-generated request identifier. * @type {string} * @memberof AccountApiOpenOrdersStatus */ readonly id?: string; /** * If omitted, open orders for all symbols are returned * @type {string} * @memberof AccountApiOpenOrdersStatus */ readonly symbol?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiOpenOrdersStatus */ readonly recvWindow?: number; } /** * Request parameters for orderAmendments operation in AccountApi. * @interface OrderAmendmentsRequest */ interface OrderAmendmentsRequest { /** * * @type {string} * @memberof AccountApiOrderAmendments */ readonly symbol: string; /** * Order ID * @type {number | bigint} * @memberof AccountApiOrderAmendments */ readonly orderId: number | bigint; /** * Client-generated request identifier. * @type {string} * @memberof AccountApiOrderAmendments */ readonly id?: string; /** * Execution ID to begin at * @type {number | bigint} * @memberof AccountApiOrderAmendments */ readonly fromExecutionId?: number | bigint; /** * Default: 500; Maximum: 1000 * @type {number | bigint} * @memberof AccountApiOrderAmendments */ readonly limit?: number | bigint; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiOrderAmendments */ readonly recvWindow?: number; } /** * Request parameters for orderListStatus operation in AccountApi. * @interface OrderListStatusRequest */ interface OrderListStatusRequest { /** * Client-generated request identifier. * @type {string} * @memberof AccountApiOrderListStatus */ readonly id?: string; /** * Query order list by `listClientOrderId`. `orderListId` or `origClientOrderId` must be provided. * @type {string} * @memberof AccountApiOrderListStatus */ readonly origClientOrderId?: string; /** * Query order list by `orderListId`. `orderListId` or `origClientOrderId` must be provided. * @type {number} * @memberof AccountApiOrderListStatus */ readonly orderListId?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiOrderListStatus */ readonly recvWindow?: number; } /** * Request parameters for orderStatus operation in AccountApi. * @interface OrderStatusRequest */ interface OrderStatusRequest { /** * * @type {string} * @memberof AccountApiOrderStatus */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof AccountApiOrderStatus */ readonly id?: string; /** * Lookup order by `orderId` * @type {number | bigint} * @memberof AccountApiOrderStatus */ readonly orderId?: number | bigint; /** * Lookup order by `clientOrderId` * @type {string} * @memberof AccountApiOrderStatus */ readonly origClientOrderId?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AccountApiOrderStatus */ readonly recvWindow?: number; } /** * AccountApi - object-oriented interface * @class AccountApi * @extends {WebsocketAPIBase} */ declare class AccountApi implements AccountApiInterface { private readonly websocketBase; constructor(websocketBase: WebsocketAPIBase); /** * Get current account commission rates. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Account Commission Rates (USER_DATA) * @param {AccountCommissionRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#account-commission Binance API Documentation} */ accountCommission(requestParameters: AccountCommissionRequest): Promise>; /** * Query your current unfilled order count for all intervals. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Unfilled Order Count (USER_DATA) * @param {AccountRateLimitsOrdersRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#account-rate-limits-orders Binance API Documentation} */ accountRateLimitsOrders(requestParameters?: AccountRateLimitsOrdersRequest): Promise>; /** * Query information about your account. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * @summary Account information (USER_DATA) * @param {AccountStatusRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#account-status Binance API Documentation} */ accountStatus(requestParameters?: AccountStatusRequest): Promise>; /** * Query information about all your order lists, filtered by time range. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Notes: * If `startTime` and/or `endTime` are specified, `fromId` is ignored. * Order lists are filtered by `transactionTime` of the last order list execution status update. * If `fromId` is specified, return order lists with order list ID >= `fromId`. * If no condition is specified, the most recent order lists are returned. * The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account order list history (USER_DATA) * @param {AllOrderListsRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#all-order-lists Binance API Documentation} */ allOrderLists(requestParameters?: AllOrderListsRequest): Promise>; /** * Query information about all your orders – active, canceled, filled – filtered by time range. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Notes: * * If `startTime` and/or `endTime` are specified, `orderId` is ignored. * * Orders are filtered by `time` of the last execution status update. * * If `orderId` is specified, return orders with order ID >= `orderId`. * * If no condition is specified, the most recent orders are returned. * * For some historical orders the `cummulativeQuoteQty` response field may be negative, * meaning the data is not available at this time. * * The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account order history (USER_DATA) * @param {AllOrdersRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#all-orders Binance API Documentation} */ allOrders(requestParameters: AllOrdersRequest): Promise>; /** * Retrieves allocations resulting from SOR order placement. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Supported parameter combinations: * * Parameters | Response | * ------------------------------------------- | -------- | * `symbol` | allocations from oldest to newest | * `symbol` + `startTime` | oldest allocations since `startTime` | * `symbol` + `endTime` | newest allocations until `endTime` | * `symbol` + `startTime` + `endTime` | allocations within the time range | * `symbol` + `fromAllocationId` | allocations by allocation ID | * `symbol` + `orderId` | allocations related to an order starting with oldest | * `symbol` + `orderId` + `fromAllocationId` | allocations related to an order by allocation ID | * **Note:** The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account allocations (USER_DATA) * @param {MyAllocationsRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#my-allocations Binance API Documentation} */ myAllocations(requestParameters: MyAllocationsRequest): Promise>; /** * Retrieves the list of [filters](/products/spot/filters) relevant to an account on a given symbol. This is the only method * that shows if an account has [`MAX_ASSET`](/products/spot/filters#max_asset) filters applied to it. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Query Relevant Filters (USER_DATA) * @param {MyFiltersRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#my-filters Binance API Documentation} */ myFilters(requestParameters: MyFiltersRequest): Promise>; /** * Displays the list of orders that were expired due to STP. * * These are the combinations supported: * * `symbol` + `preventedMatchId` * `symbol` + `orderId` * `symbol` + `orderId` + `fromPreventedMatchId` (`limit` will default to 500) * `symbol` + `orderId` + `fromPreventedMatchId` + `limit` * * Weight: Case | Weight * ---- | ----- * If `symbol` is invalid | 2 * Querying by `preventedMatchId` | 2 * Querying by `orderId` | 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Account prevented matches (USER_DATA) * @param {MyPreventedMatchesRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#my-prevented-matches Binance API Documentation} */ myPreventedMatches(requestParameters: MyPreventedMatchesRequest): Promise>; /** * Query information about all your trades, filtered by time range. * * Weight: Condition| Weight| * ---| --- * |Without orderId|20| * |With orderId|5| * * Security Type: USER_DATA * * Notes: * Data Source: Memory => Database * * Notes: * - If `fromId` is specified, return trades with trade ID >= `fromId`. * - If `startTime` and/or `endTime` are specified, trades are filtered by execution time (`time`). * - `fromId` cannot be used together with `startTime` and `endTime`. * - If `orderId` is specified, only trades related to that order are returned. * - `startTime` and `endTime` cannot be used together with `orderId`. * - If no condition is specified, the most recent trades are returned. * - The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account trade history (USER_DATA) * @param {MyTradesRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#my-trades Binance API Documentation} */ myTrades(requestParameters: MyTradesRequest): Promise>; /** * Query execution status of all open order lists. * * If you need to continuously monitor order status updates, please consider using WebSocket Streams: * * `userDataStream.subscribe` if on an authenticated session * `userDataStream.subscribe.signature` if subscribing through signature subscription * * Weight(IP): 6 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory -> Database * * @summary Current open Order lists (USER_DATA) * @param {OpenOrderListsStatusRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#open-order-lists-status Binance API Documentation} */ openOrderListsStatus(requestParameters?: OpenOrderListsStatusRequest): Promise>; /** * Query execution status of all open orders. * * If you need to continuously monitor order status updates, please consider using WebSocket Streams: * * `userDataStream.subscribe` if on an authenticated session * `userDataStream.subscribe.signature` if subscribing through signature subscription * * Weight: | Parameter | Weight | * | --------- | ------ | * | `symbol` | 6 | * | none | 80 | * * Security Type: USER_DATA * * Notes: * Data Source: Memory => Database * * @summary Current open orders (USER_DATA) * @param {OpenOrdersStatusRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#open-orders-status Binance API Documentation} */ openOrdersStatus(requestParameters?: OpenOrdersStatusRequest): Promise>; /** * Queries all amendments of a single order. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Order Amendments (USER_DATA) * @param {OrderAmendmentsRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#order-amendments Binance API Documentation} */ orderAmendments(requestParameters: OrderAmendmentsRequest): Promise>; /** * Check execution status of an Order list. * * For execution status of individual orders, use `order.status`. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Notes: * * `origClientOrderId` refers to `listClientOrderId` of the order list itself. * * If both `origClientOrderId` and `orderListId` parameters are specified, * only `origClientOrderId` is used and `orderListId` is ignored. * * @summary Query Order list (USER_DATA) * @param {OrderListStatusRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#order-list-status Binance API Documentation} */ orderListStatus(requestParameters?: OrderListStatusRequest): Promise>; /** * Check execution status of an order. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * Notes: * * If both `orderId` and `origClientOrderId` are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * For some historical orders the `cummulativeQuoteQty` response field may be negative, * meaning the data is not available at this time. * * @summary Query order (USER_DATA) * @param {OrderStatusRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AccountApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#order-status Binance API Documentation} */ orderStatus(requestParameters: OrderStatusRequest): Promise>; } //#endregion //#region src/websocket-api/modules/auth-api.d.ts /** * AuthApi - interface * * @interface AuthApi */ interface AuthApiInterface { /** * Authenticate WebSocket connection using the provided API key. * * After calling `session.logon`, you can omit `apiKey` and `signature` parameters for future requests that require them. * * Note that only one API key can be authenticated. * * Calling `session.logon` multiple times changes the current authenticated API key. * **Note:** Only Ed25519 keys are supported for this feature. * * Weight(IP): 2 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Log in with API key (USER_DATA) * @param {SessionLogonRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AuthApiInterface */ sessionLogon(requestParameters?: SessionLogonRequest): Promise[]>; /** * Forget the API key previously authenticated. If the connection is not authenticated, this request does nothing. * * Note that the WebSocket connection stays open after `session.logout` request. You can continue using the connection, but now you will have to explicitly provide the `apiKey` and `signature` parameters where needed. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Log out of the session * @param {SessionLogoutRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AuthApiInterface */ sessionLogout(requestParameters?: SessionLogoutRequest): Promise[]>; /** * Query the status of the WebSocket connection, * inspecting which API key (if any) is used to authorize requests. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query session status * @param {SessionStatusRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof AuthApiInterface */ sessionStatus(requestParameters?: SessionStatusRequest): Promise>; } /** * Request parameters for sessionLogon operation in AuthApi. * @interface SessionLogonRequest */ interface SessionLogonRequest { /** * Client-generated request identifier. * @type {string} * @memberof AuthApiSessionLogon */ readonly id?: string; /** * The value cannot be greater than `60000`. Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof AuthApiSessionLogon */ readonly recvWindow?: number; } /** * Request parameters for sessionLogout operation in AuthApi. * @interface SessionLogoutRequest */ interface SessionLogoutRequest { /** * Client-generated request identifier. * @type {string} * @memberof AuthApiSessionLogout */ readonly id?: string; } /** * Request parameters for sessionStatus operation in AuthApi. * @interface SessionStatusRequest */ interface SessionStatusRequest { /** * Client-generated request identifier. * @type {string} * @memberof AuthApiSessionStatus */ readonly id?: string; } /** * AuthApi - object-oriented interface * @class AuthApi * @extends {WebsocketAPIBase} */ declare class AuthApi implements AuthApiInterface { private readonly websocketBase; constructor(websocketBase: WebsocketAPIBase); /** * Authenticate WebSocket connection using the provided API key. * * After calling `session.logon`, you can omit `apiKey` and `signature` parameters for future requests that require them. * * Note that only one API key can be authenticated. * * Calling `session.logon` multiple times changes the current authenticated API key. * **Note:** Only Ed25519 keys are supported for this feature. * * Weight(IP): 2 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Log in with API key (USER_DATA) * @param {SessionLogonRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AuthApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/auth#session-logon Binance API Documentation} */ sessionLogon(requestParameters?: SessionLogonRequest): Promise[]>; /** * Forget the API key previously authenticated. If the connection is not authenticated, this request does nothing. * * Note that the WebSocket connection stays open after `session.logout` request. You can continue using the connection, but now you will have to explicitly provide the `apiKey` and `signature` parameters where needed. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Log out of the session * @param {SessionLogoutRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AuthApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/auth#session-logout Binance API Documentation} */ sessionLogout(requestParameters?: SessionLogoutRequest): Promise[]>; /** * Query the status of the WebSocket connection, * inspecting which API key (if any) is used to authorize requests. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query session status * @param {SessionStatusRequest} requestParameters Request parameters. * @returns {Promise} * @memberof AuthApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/auth#session-status Binance API Documentation} */ sessionStatus(requestParameters?: SessionStatusRequest): Promise>; } //#endregion //#region src/websocket-api/modules/general-api.d.ts /** * GeneralApi - interface * * @interface GeneralApi */ interface GeneralApiInterface { /** * Query current exchange trading rules, rate limits, and symbol * information. * * Weight(IP): 20 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Notes:** * If the value provided to `symbol` or `symbols` do not exist, the endpoint will throw an error saying the symbol is invalid. * All parameters are optional. * Only one of `symbol`, `symbols`, `permissions` parameters can be specified. * Without parameters, `exchangeInfo` displays all symbols with `["SPOT", "MARGIN", "LEVERAGED"]` permissions. * In order to list *all* active symbols on the exchange, you need to explicitly request all permissions. * `permissions` accepts either a list of permissions, or a single permission name. E.g. `"SPOT"`. * **Examples of Symbol Permissions Interpretation from the Response:** * * `[["A","B"]]` means you may place an order if your account has either permission "A" **or** permission "B". * `[["A"],["B"]]` means you can place an order if your account has permission "A" **and** permission "B". * `[["A"],["B","C"]]` means you can place an order if your account has permission "A" **and** permission "B" or permission "C". (Inclusive or is applied here, not exclusive or, so your account may have both permission "B" and permission "C".) * * @summary Exchange information * @param {ExchangeInfoRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof GeneralApiInterface */ exchangeInfo(requestParameters?: ExchangeInfoRequest): Promise>; /** * Query execution rules for symbols. * * Weight: Parameter | Weight * --- | --- * `symbol` | 2 * `symbols` | 2 for each `symbol`, capped at a max of 40 * `symbolStatus` | 40 * None | 40 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Note:** No combination of multiple parameters is allowed. * * @summary Query Execution Rules * @param {ExecutionRulesRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof GeneralApiInterface */ executionRules(requestParameters?: ExecutionRulesRequest): Promise>; /** * Test connectivity to the WebSocket API. * * Note: You can use regular WebSocket ping frames to test connectivity as well, WebSocket API will respond with pong frames as soon as possible. ping request along with time is a safe way to test request-response handling in your application. * * Weight(IP): 1 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Test connectivity * @param {PingRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof GeneralApiInterface */ ping(requestParameters?: PingRequest): Promise>; /** * Test connectivity to the WebSocket API and get the current server time. * * Weight(IP): 1 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Check server time * @param {TimeRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof GeneralApiInterface */ time(requestParameters?: TimeRequest): Promise>; } /** * Request parameters for exchangeInfo operation in GeneralApi. * @interface ExchangeInfoRequest */ interface ExchangeInfoRequest { /** * Client-generated request identifier. * @type {string} * @memberof GeneralApiExchangeInfo */ readonly id?: string; /** * Describe a single symbol * @type {string} * @memberof GeneralApiExchangeInfo */ readonly symbol?: string; /** * Describe multiple symbols * @type {Array} * @memberof GeneralApiExchangeInfo */ readonly symbols?: Array; /** * Filter symbols by permissions * @type {Array} * @memberof GeneralApiExchangeInfo */ readonly permissions?: Array; /** * Controls whether the content of the `permissionSets` field is populated or not. Defaults to `true`. * @type {boolean} * @memberof GeneralApiExchangeInfo */ readonly showPermissionSets?: boolean; /** * Filters for symbols that have this `tradingStatus`. Valid values: `TRADING`, `HALT`, `BREAK`. Cannot be used in combination with `symbol` or `symbols`. * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof GeneralApiExchangeInfo */ readonly symbolStatus?: ExchangeInfoSymbolStatusEnum; } /** * Request parameters for executionRules operation in GeneralApi. * @interface ExecutionRulesRequest */ interface ExecutionRulesRequest { /** * Client-generated request identifier. * @type {string} * @memberof GeneralApiExecutionRules */ readonly id?: string; /** * Query for specified symbol. * @type {string} * @memberof GeneralApiExecutionRules */ readonly symbol?: string; /** * Query for multiple symbols. * @type {Array} * @memberof GeneralApiExecutionRules */ readonly symbols?: Array; /** * Query for all symbols with the specified status. Supported values: `TRADING`, `HALT`, `BREAK` * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof GeneralApiExecutionRules */ readonly symbolStatus?: ExecutionRulesSymbolStatusEnum; } /** * Request parameters for ping operation in GeneralApi. * @interface PingRequest */ interface PingRequest { /** * Client-generated request identifier. * @type {string} * @memberof GeneralApiPing */ readonly id?: string; } /** * Request parameters for time operation in GeneralApi. * @interface TimeRequest */ interface TimeRequest { /** * Client-generated request identifier. * @type {string} * @memberof GeneralApiTime */ readonly id?: string; } /** * GeneralApi - object-oriented interface * @class GeneralApi * @extends {WebsocketAPIBase} */ declare class GeneralApi implements GeneralApiInterface { private readonly websocketBase; constructor(websocketBase: WebsocketAPIBase); /** * Query current exchange trading rules, rate limits, and symbol * information. * * Weight(IP): 20 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Notes:** * If the value provided to `symbol` or `symbols` do not exist, the endpoint will throw an error saying the symbol is invalid. * All parameters are optional. * Only one of `symbol`, `symbols`, `permissions` parameters can be specified. * Without parameters, `exchangeInfo` displays all symbols with `["SPOT", "MARGIN", "LEVERAGED"]` permissions. * In order to list *all* active symbols on the exchange, you need to explicitly request all permissions. * `permissions` accepts either a list of permissions, or a single permission name. E.g. `"SPOT"`. * **Examples of Symbol Permissions Interpretation from the Response:** * * `[["A","B"]]` means you may place an order if your account has either permission "A" **or** permission "B". * `[["A"],["B"]]` means you can place an order if your account has permission "A" **and** permission "B". * `[["A"],["B","C"]]` means you can place an order if your account has permission "A" **and** permission "B" or permission "C". (Inclusive or is applied here, not exclusive or, so your account may have both permission "B" and permission "C".) * * @summary Exchange information * @param {ExchangeInfoRequest} requestParameters Request parameters. * @returns {Promise} * @memberof GeneralApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/general#exchange-info Binance API Documentation} */ exchangeInfo(requestParameters?: ExchangeInfoRequest): Promise>; /** * Query execution rules for symbols. * * Weight: Parameter | Weight * --- | --- * `symbol` | 2 * `symbols` | 2 for each `symbol`, capped at a max of 40 * `symbolStatus` | 40 * None | 40 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Note:** No combination of multiple parameters is allowed. * * @summary Query Execution Rules * @param {ExecutionRulesRequest} requestParameters Request parameters. * @returns {Promise} * @memberof GeneralApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/general#execution-rules Binance API Documentation} */ executionRules(requestParameters?: ExecutionRulesRequest): Promise>; /** * Test connectivity to the WebSocket API. * * Note: You can use regular WebSocket ping frames to test connectivity as well, WebSocket API will respond with pong frames as soon as possible. ping request along with time is a safe way to test request-response handling in your application. * * Weight(IP): 1 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Test connectivity * @param {PingRequest} requestParameters Request parameters. * @returns {Promise} * @memberof GeneralApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/general#ping Binance API Documentation} */ ping(requestParameters?: PingRequest): Promise>; /** * Test connectivity to the WebSocket API and get the current server time. * * Weight(IP): 1 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Check server time * @param {TimeRequest} requestParameters Request parameters. * @returns {Promise} * @memberof GeneralApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/general#time Binance API Documentation} */ time(requestParameters?: TimeRequest): Promise>; } declare enum ExchangeInfoSymbolStatusEnum { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum ExecutionRulesSymbolStatusEnum { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } //#endregion //#region src/websocket-api/modules/market-api.d.ts /** * MarketApi - interface * * @interface MarketApi */ interface MarketApiInterface { /** * Get current average price for a symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Current average price * @param {AvgPriceRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ avgPrice(requestParameters: AvgPriceRequest$1): Promise>; /** * Get block trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: * - Data Source: Database * * @summary Historical Block Trades * @param {BlockTradesHistoricalRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ blockTradesHistorical(requestParameters: BlockTradesHistoricalRequest): Promise>; /** * Get current order book. * * Note that this request returns limited market depth. * * If you need to continuously monitor order book updates, please consider using WebSocket Streams: * `@depth` * `@depth` * * You can use `depth` request together with `@depth` streams to [maintain a local order book](/products/spot/web-socket-streams#how-to-manage-a-local-order-book-correctly). * * Weight: Adjusted based on the limit: * * |Limit|Request Weight * ------|------- * 1-100| 5 * 101-500| 25 * 501-1000| 50 * 1001-5000| 250 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Order book * @param {DepthRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ depth(requestParameters: DepthRequest): Promise>; /** * Get klines (candlestick bars). * * Klines are uniquely identified by their open & close time. * * If you need access to real-time kline updates, please consider using WebSocket Streams: * `@kline_` * * If you need historical kline data, please consider using [data.binance.vision](https://github.com/binance/binance-public-data/#klines). * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * Supported kline intervals (case-sensitive): * * Interval | `interval` value * --------- | ---------------- * seconds | `1s` * minutes | `1m`, `3m`, `5m`, `15m`, `30m` * hours | `1h`, `2h`, `4h`, `6h`, `8h`, `12h` * days | `1d`, `3d` * weeks | `1w` * months | `1M` * **Notes:** * * If `startTime` and `endTime` are not sent, the most recent klines are returned. * Supported values for `timeZone`: * Hours and minutes (e.g. `-1:00`, `05:45`) * Only hours (e.g. `0`, `8`, `4`) * Accepted range is strictly [-12:00 to +14:00] inclusive * If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary Klines * @param {KlinesRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ klines(requestParameters: KlinesRequest): Promise>; /** * Query Reference Price * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price * @param {ReferencePriceRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ referencePrice(requestParameters: ReferencePriceRequest$1): Promise>; /** * Query Reference Price Calculation * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price Calculation * @param {ReferencePriceCalculationRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ referencePriceCalculation(requestParameters: ReferencePriceCalculationRequest): Promise>; /** * Get rolling window price change statistics with a custom window. * * This request is similar to `ticker.24hr` but statistics are computed on demand using the arbitrary window you specify. * **Note:** Window size precision is limited to 1 minute. * While the `closeTime` is the current time of the request, `openTime` always start on a minute boundary. * As such, the effective window might be up to 59999 ms wider than the requested `windowSize`. * *
* Window computation example * * For example, a request for `"windowSize": "7d"` might result in the following window: * * ```javascript * { * "openTime": 1659580020000, * "closeTime": 1660184865291 * } * ``` * * Time of the request – `closeTime` – is 1660184865291 (August 11, 2022 02:27:45.291). * Requested window size should put the `openTime` 7 days before that – August 4, 02:27:45.291 – * but due to limited precision it ends up a bit earlier: 1659580020000 (August 4, 2022 02:27:00), * exactly at the start of a minute. *
* * If you need to continuously monitor trading statistics, please consider using WebSocket Streams: * `@ticker_` or `!ticker_@arr` * * Weight: Adjusted based on the number of requested symbols: * * | Symbols | Weight | * |:-------:|:------:| * | 1–50 | 4 per symbol | * | 51–100 | 200 | * * Security Type: NONE * * Notes: **Data Source:** Database * * Supported window sizes: * * Unit | `windowSize` value * ------- | ------------------ * minutes | `1m`, `2m` ... `59m` * hours | `1h`, `2h` ... `23h` * days | `1d`, `2d` ... `7d` * * Notes: * * Either `symbol` or `symbols` must be specified. * * Maximum number of symbols in one request: 200. * * Window size units cannot be combined. * E.g., 1d 2h is not supported. * * @summary Rolling window price change statistics * @param {TickerRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ ticker(requestParameters?: TickerRequest$1): Promise>; /** * Get 24-hour rolling window price change statistics. * * If you need to continuously monitor trading statistics, please consider using WebSocket Streams: * * `@ticker` or `!ticker@arr` * * `@miniTicker` or `!miniTicker@arr` * * If you need different window sizes, * * use the `ticker` request. * * Weight: Adjusted based on the number of requested symbols: * * |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 80| * |symbols| 1-20 |2| * | | 21-100 |40| * | | 101+ |80| * | |omitted| 80| * * Security Type: NONE * * Notes: **Data Source:** Memory * * Notes: * * `symbol` and `symbols` cannot be used together. * * If no symbol is specified, returns information about all symbols currently trading on the exchange. * * @summary 24hr ticker price change statistics * @param {Ticker24hrRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ ticker24hr(requestParameters?: Ticker24hrRequest): Promise>; /** * Get the current best price and quantity on the order book. * * If you need access to real-time order book ticker updates, please * consider using WebSocket Streams: * * `@bookTicker` * * Weight: Adjusted based on the number of requested symbols: * * |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * Notes: * * `symbol` and `symbols` cannot be used together. * * If no symbol is specified, returns information about all symbols currently trading on the exchange. * * @summary Symbol order book ticker * @param {TickerBookRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ tickerBook(requestParameters?: TickerBookRequest): Promise>; /** * Get the latest market price for a symbol. * * If you need access to real-time price updates, please consider using * WebSocket Streams: * * `@aggTrade` * * `@trade` * * Weight: Adjusted based on the number of requested symbols: * * |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * Notes: * * `symbol` and `symbols` cannot be used together. * * If no symbol is specified, returns information about all symbols currently trading on the exchange. * * @summary Symbol price ticker * @param {TickerPriceRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ tickerPrice(requestParameters?: TickerPriceRequest): Promise>; /** * Price change statistics for a trading day. * * Weight: 4 for each requested symbol regardless of windowSize. The weight for this request will cap at 200 once the number of symbols in the request is more than 50. * * Security Type: NONE * * Notes: **Data Source:** Database * **Notes:** * * Supported values for `timeZone`: * Hours and minutes (e.g. `-1:00`, `05:45`) * Only hours (e.g. `0`, `8`, `4`) * * * @summary Trading Day Ticker * @param {TickerTradingDayRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ tickerTradingDay(requestParameters?: TickerTradingDayRequest): Promise>; /** * Get aggregate trades. * * An *aggregate trade* (aggtrade) represents one or more individual * trades. * * Trades that fill at the same time, from the same taker order, with the * same price – * * those trades are collected into an aggregate trade with total quantity * of the individual trades. * * If you need access to real-time trading activity, please consider using * WebSocket Streams: * * `@aggTrade` * * If you need historical aggregate trade data, please consider using [data.binance.vision](https://github.com/binance/binance-public-data/#aggtrades). * * Weight(IP): 4 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If `fromId` is specified, return aggtrades with aggregate trade ID >= `fromId`. Use `fromId` and `limit` to page through all aggtrades. * - If `startTime` and/or `endTime` are specified, aggtrades are filtered by execution time (`T`). `fromId` cannot be used together with `startTime` and `endTime`. * - If no condition is specified, the most recent aggregate trades are returned. * * @summary Aggregate trades * @param {TradesAggregateRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ tradesAggregate(requestParameters: TradesAggregateRequest): Promise>; /** * Get historical trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Database * * Notes: * * If `fromId` is not specified, the most recent trades are returned. * * @summary Historical trades * @param {TradesHistoricalRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ tradesHistorical(requestParameters: TradesHistoricalRequest): Promise>; /** * Get recent trades. * * If you need access to real-time trading activity, please consider using * WebSocket Streams: * * `@trade` * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Recent trades * @param {TradesRecentRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ tradesRecent(requestParameters: TradesRecentRequest): Promise>; /** * Get klines (candlestick bars) optimized for presentation. * * This request is similar to `klines`, having the same parameters and response. `uiKlines` return modified kline data, optimized for presentation of candlestick charts. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If `startTime` and `endTime` are not sent, the most recent klines are returned. * - Supported values for `timeZone`: * - Hours and minutes (e.g. `-1:00`, `05:45`) * - Only hours (e.g. `0`, `8`, `4`) * - Accepted range is strictly [-12:00 to +14:00] inclusive * - If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * - Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary UI Klines * @param {UiKlinesRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof MarketApiInterface */ uiKlines(requestParameters: UiKlinesRequest): Promise>; } /** * Request parameters for avgPrice operation in MarketApi. * @interface AvgPriceRequest */ interface AvgPriceRequest$1 { /** * * @type {string} * @memberof MarketApiAvgPrice */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof MarketApiAvgPrice */ readonly id?: string; } /** * Request parameters for blockTradesHistorical operation in MarketApi. * @interface BlockTradesHistoricalRequest */ interface BlockTradesHistoricalRequest { /** * * @type {string} * @memberof MarketApiBlockTradesHistorical */ readonly symbol: string; /** * Block trade ID to fetch from * @type {number | bigint} * @memberof MarketApiBlockTradesHistorical */ readonly fromId: number | bigint; /** * Client-generated request identifier. * @type {string} * @memberof MarketApiBlockTradesHistorical */ readonly id?: string; /** * Default: 500; Maximum: 1000 * @type {number | bigint} * @memberof MarketApiBlockTradesHistorical */ readonly limit?: number | bigint; } /** * Request parameters for depth operation in MarketApi. * @interface DepthRequest */ interface DepthRequest { /** * * @type {string} * @memberof MarketApiDepth */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof MarketApiDepth */ readonly id?: string; /** * * @type {number} * @memberof MarketApiDepth */ readonly limit?: number; /** * Filters for symbols that have this `tradingStatus`. * A status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiDepth */ readonly symbolStatus?: DepthSymbolStatusEnum; } /** * Request parameters for klines operation in MarketApi. * @interface KlinesRequest */ interface KlinesRequest { /** * * @type {string} * @memberof MarketApiKlines */ readonly symbol: string; /** * * @type {'1s' | '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof MarketApiKlines */ readonly interval: KlinesIntervalEnum; /** * Client-generated request identifier. * @type {string} * @memberof MarketApiKlines */ readonly id?: string; /** * * @type {number | bigint} * @memberof MarketApiKlines */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof MarketApiKlines */ readonly endTime?: number | bigint; /** * Default: 0 (UTC) * @type {string} * @memberof MarketApiKlines */ readonly timeZone?: string; /** * * @type {number} * @memberof MarketApiKlines */ readonly limit?: number; } /** * Request parameters for referencePrice operation in MarketApi. * @interface ReferencePriceRequest */ interface ReferencePriceRequest$1 { /** * * @type {string} * @memberof MarketApiReferencePrice */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof MarketApiReferencePrice */ readonly id?: string; } /** * Request parameters for referencePriceCalculation operation in MarketApi. * @interface ReferencePriceCalculationRequest */ interface ReferencePriceCalculationRequest { /** * * @type {string} * @memberof MarketApiReferencePriceCalculation */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof MarketApiReferencePriceCalculation */ readonly id?: string; /** * * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiReferencePriceCalculation */ readonly symbolStatus?: ReferencePriceCalculationSymbolStatusEnum; } /** * Request parameters for ticker operation in MarketApi. * @interface TickerRequest */ interface TickerRequest$1 { /** * Client-generated request identifier. * @type {string} * @memberof MarketApiTicker */ readonly id?: string; /** * Query ticker of a single symbol * @type {string} * @memberof MarketApiTicker */ readonly symbol?: string; /** * Query ticker for multiple symbols * @type {Array} * @memberof MarketApiTicker */ readonly symbols?: Array; /** * Ticker type. Supported values: FULL (default) or MINI * @type {'FULL' | 'MINI'} * @memberof MarketApiTicker */ readonly type?: TickerTypeEnum; /** * Defaults to 1d if no parameter provided. * @type {'1m' | '2m' | '3m' | '4m' | '5m' | '6m' | '7m' | '8m' | '9m' | '10m' | '11m' | '12m' | '13m' | '14m' | '15m' | '16m' | '17m' | '18m' | '19m' | '20m' | '21m' | '22m' | '23m' | '24m' | '25m' | '26m' | '27m' | '28m' | '29m' | '30m' | '31m' | '32m' | '33m' | '34m' | '35m' | '36m' | '37m' | '38m' | '39m' | '40m' | '41m' | '42m' | '43m' | '44m' | '45m' | '46m' | '47m' | '48m' | '49m' | '50m' | '51m' | '52m' | '53m' | '54m' | '55m' | '56m' | '57m' | '58m' | '59m' | '1h' | '2h' | '3h' | '4h' | '5h' | '6h' | '7h' | '8h' | '9h' | '10h' | '11h' | '12h' | '13h' | '14h' | '15h' | '16h' | '17h' | '18h' | '19h' | '20h' | '21h' | '22h' | '23h' | '1d' | '2d' | '3d' | '4d' | '5d' | '6d' | '7d'} * @memberof MarketApiTicker */ readonly windowSize?: TickerWindowSizeEnum; /** * Filters for symbols that have this `tradingStatus`. For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. For multiple or all symbols, non-matching ones are simply excluded from the response. Valid values: `TRADING`, `HALT`, `BREAK` * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiTicker */ readonly symbolStatus?: TickerSymbolStatusEnum; } /** * Request parameters for ticker24hr operation in MarketApi. * @interface Ticker24hrRequest */ interface Ticker24hrRequest { /** * Client-generated request identifier. * @type {string} * @memberof MarketApiTicker24hr */ readonly id?: string; /** * * @type {string} * @memberof MarketApiTicker24hr */ readonly symbol?: string; /** * * @type {Array} * @memberof MarketApiTicker24hr */ readonly symbols?: Array; /** * Ticker type. Supported values: FULL (default) or MINI * @type {'FULL' | 'MINI'} * @memberof MarketApiTicker24hr */ readonly type?: Ticker24hrTypeEnum; /** * Filters for symbols that have this `tradingStatus`. For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. For multiple or all symbols, non-matching ones are simply excluded from the response. Valid values: `TRADING`, `HALT`, `BREAK` * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiTicker24hr */ readonly symbolStatus?: Ticker24hrSymbolStatusEnum; } /** * Request parameters for tickerBook operation in MarketApi. * @interface TickerBookRequest */ interface TickerBookRequest { /** * Client-generated request identifier. * @type {string} * @memberof MarketApiTickerBook */ readonly id?: string; /** * Query ticker for a single symbol * @type {string} * @memberof MarketApiTickerBook */ readonly symbol?: string; /** * Query ticker for multiple symbols * @type {Array} * @memberof MarketApiTickerBook */ readonly symbols?: Array; /** * Filters for symbols that have this `tradingStatus`. For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. For multiple or all symbols, non-matching ones are simply excluded from the response. Valid values: `TRADING`, `HALT`, `BREAK` * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiTickerBook */ readonly symbolStatus?: TickerBookSymbolStatusEnum; } /** * Request parameters for tickerPrice operation in MarketApi. * @interface TickerPriceRequest */ interface TickerPriceRequest { /** * Client-generated request identifier. * @type {string} * @memberof MarketApiTickerPrice */ readonly id?: string; /** * Query price for a single symbol * @type {string} * @memberof MarketApiTickerPrice */ readonly symbol?: string; /** * Query price for multiple symbols * @type {Array} * @memberof MarketApiTickerPrice */ readonly symbols?: Array; /** * Filters for symbols that have this `tradingStatus`. For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. For multiple or all symbols, non-matching ones are simply excluded from the response. Valid values: `TRADING`, `HALT`, `BREAK` * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiTickerPrice */ readonly symbolStatus?: TickerPriceSymbolStatusEnum; } /** * Request parameters for tickerTradingDay operation in MarketApi. * @interface TickerTradingDayRequest */ interface TickerTradingDayRequest { /** * Client-generated request identifier. * @type {string} * @memberof MarketApiTickerTradingDay */ readonly id?: string; /** * * @type {string} * @memberof MarketApiTickerTradingDay */ readonly symbol?: string; /** * * @type {Array} * @memberof MarketApiTickerTradingDay */ readonly symbols?: Array; /** * Default: 0 (UTC) * @type {string} * @memberof MarketApiTickerTradingDay */ readonly timeZone?: string; /** * Ticker type. Supported values: FULL (default) or MINI * @type {'FULL' | 'MINI'} * @memberof MarketApiTickerTradingDay */ readonly type?: TickerTradingDayTypeEnum; /** * Filters for symbols that have this `tradingStatus`. For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. For multiple or all symbols, non-matching ones are simply excluded from the response. Valid values: `TRADING`, `HALT`, `BREAK` * @type {'TRADING' | 'HALT' | 'BREAK'} * @memberof MarketApiTickerTradingDay */ readonly symbolStatus?: TickerTradingDaySymbolStatusEnum; } /** * Request parameters for tradesAggregate operation in MarketApi. * @interface TradesAggregateRequest */ interface TradesAggregateRequest { /** * * @type {string} * @memberof MarketApiTradesAggregate */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof MarketApiTradesAggregate */ readonly id?: string; /** * Aggregate trade ID to begin at * @type {number | bigint} * @memberof MarketApiTradesAggregate */ readonly fromId?: number | bigint; /** * Timestamp in ms to get aggregate trades from INCLUSIVE. * @type {number | bigint} * @memberof MarketApiTradesAggregate */ readonly startTime?: number | bigint; /** * Timestamp in ms to get aggregate trades until INCLUSIVE. * @type {number | bigint} * @memberof MarketApiTradesAggregate */ readonly endTime?: number | bigint; /** * * @type {number} * @memberof MarketApiTradesAggregate */ readonly limit?: number; } /** * Request parameters for tradesHistorical operation in MarketApi. * @interface TradesHistoricalRequest */ interface TradesHistoricalRequest { /** * * @type {string} * @memberof MarketApiTradesHistorical */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof MarketApiTradesHistorical */ readonly id?: string; /** * Trade ID to begin at * @type {number | bigint} * @memberof MarketApiTradesHistorical */ readonly fromId?: number | bigint; /** * * @type {number} * @memberof MarketApiTradesHistorical */ readonly limit?: number; } /** * Request parameters for tradesRecent operation in MarketApi. * @interface TradesRecentRequest */ interface TradesRecentRequest { /** * * @type {string} * @memberof MarketApiTradesRecent */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof MarketApiTradesRecent */ readonly id?: string; /** * * @type {number} * @memberof MarketApiTradesRecent */ readonly limit?: number; } /** * Request parameters for uiKlines operation in MarketApi. * @interface UiKlinesRequest */ interface UiKlinesRequest { /** * * @type {string} * @memberof MarketApiUiKlines */ readonly symbol: string; /** * * @type {'1s' | '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof MarketApiUiKlines */ readonly interval: UiKlinesIntervalEnum; /** * Client-generated request identifier. * @type {string} * @memberof MarketApiUiKlines */ readonly id?: string; /** * * @type {number | bigint} * @memberof MarketApiUiKlines */ readonly startTime?: number | bigint; /** * * @type {number | bigint} * @memberof MarketApiUiKlines */ readonly endTime?: number | bigint; /** * Default: 0 (UTC) * @type {string} * @memberof MarketApiUiKlines */ readonly timeZone?: string; /** * * @type {number} * @memberof MarketApiUiKlines */ readonly limit?: number; } /** * MarketApi - object-oriented interface * @class MarketApi * @extends {WebsocketAPIBase} */ declare class MarketApi implements MarketApiInterface { private readonly websocketBase; constructor(websocketBase: WebsocketAPIBase); /** * Get current average price for a symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Current average price * @param {AvgPriceRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#avg-price Binance API Documentation} */ avgPrice(requestParameters: AvgPriceRequest$1): Promise>; /** * Get block trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: * - Data Source: Database * * @summary Historical Block Trades * @param {BlockTradesHistoricalRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#block-trades-historical Binance API Documentation} */ blockTradesHistorical(requestParameters: BlockTradesHistoricalRequest): Promise>; /** * Get current order book. * * Note that this request returns limited market depth. * * If you need to continuously monitor order book updates, please consider using WebSocket Streams: * `@depth` * `@depth` * * You can use `depth` request together with `@depth` streams to [maintain a local order book](/products/spot/web-socket-streams#how-to-manage-a-local-order-book-correctly). * * Weight: Adjusted based on the limit: * * |Limit|Request Weight * ------|------- * 1-100| 5 * 101-500| 25 * 501-1000| 50 * 1001-5000| 250 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Order book * @param {DepthRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#depth Binance API Documentation} */ depth(requestParameters: DepthRequest): Promise>; /** * Get klines (candlestick bars). * * Klines are uniquely identified by their open & close time. * * If you need access to real-time kline updates, please consider using WebSocket Streams: * `@kline_` * * If you need historical kline data, please consider using [data.binance.vision](https://github.com/binance/binance-public-data/#klines). * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * Supported kline intervals (case-sensitive): * * Interval | `interval` value * --------- | ---------------- * seconds | `1s` * minutes | `1m`, `3m`, `5m`, `15m`, `30m` * hours | `1h`, `2h`, `4h`, `6h`, `8h`, `12h` * days | `1d`, `3d` * weeks | `1w` * months | `1M` * **Notes:** * * If `startTime` and `endTime` are not sent, the most recent klines are returned. * Supported values for `timeZone`: * Hours and minutes (e.g. `-1:00`, `05:45`) * Only hours (e.g. `0`, `8`, `4`) * Accepted range is strictly [-12:00 to +14:00] inclusive * If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary Klines * @param {KlinesRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#klines Binance API Documentation} */ klines(requestParameters: KlinesRequest): Promise>; /** * Query Reference Price * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price * @param {ReferencePriceRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#reference-price Binance API Documentation} */ referencePrice(requestParameters: ReferencePriceRequest$1): Promise>; /** * Query Reference Price Calculation * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price Calculation * @param {ReferencePriceCalculationRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#reference-price-calculation Binance API Documentation} */ referencePriceCalculation(requestParameters: ReferencePriceCalculationRequest): Promise>; /** * Get rolling window price change statistics with a custom window. * * This request is similar to `ticker.24hr` but statistics are computed on demand using the arbitrary window you specify. * **Note:** Window size precision is limited to 1 minute. * While the `closeTime` is the current time of the request, `openTime` always start on a minute boundary. * As such, the effective window might be up to 59999 ms wider than the requested `windowSize`. * *
* Window computation example * * For example, a request for `"windowSize": "7d"` might result in the following window: * * ```javascript * { * "openTime": 1659580020000, * "closeTime": 1660184865291 * } * ``` * * Time of the request – `closeTime` – is 1660184865291 (August 11, 2022 02:27:45.291). * Requested window size should put the `openTime` 7 days before that – August 4, 02:27:45.291 – * but due to limited precision it ends up a bit earlier: 1659580020000 (August 4, 2022 02:27:00), * exactly at the start of a minute. *
* * If you need to continuously monitor trading statistics, please consider using WebSocket Streams: * `@ticker_` or `!ticker_@arr` * * Weight: Adjusted based on the number of requested symbols: * * | Symbols | Weight | * |:-------:|:------:| * | 1–50 | 4 per symbol | * | 51–100 | 200 | * * Security Type: NONE * * Notes: **Data Source:** Database * * Supported window sizes: * * Unit | `windowSize` value * ------- | ------------------ * minutes | `1m`, `2m` ... `59m` * hours | `1h`, `2h` ... `23h` * days | `1d`, `2d` ... `7d` * * Notes: * * Either `symbol` or `symbols` must be specified. * * Maximum number of symbols in one request: 200. * * Window size units cannot be combined. * E.g., 1d 2h is not supported. * * @summary Rolling window price change statistics * @param {TickerRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ticker Binance API Documentation} */ ticker(requestParameters?: TickerRequest$1): Promise>; /** * Get 24-hour rolling window price change statistics. * * If you need to continuously monitor trading statistics, please consider using WebSocket Streams: * * `@ticker` or `!ticker@arr` * * `@miniTicker` or `!miniTicker@arr` * * If you need different window sizes, * * use the `ticker` request. * * Weight: Adjusted based on the number of requested symbols: * * |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 80| * |symbols| 1-20 |2| * | | 21-100 |40| * | | 101+ |80| * | |omitted| 80| * * Security Type: NONE * * Notes: **Data Source:** Memory * * Notes: * * `symbol` and `symbols` cannot be used together. * * If no symbol is specified, returns information about all symbols currently trading on the exchange. * * @summary 24hr ticker price change statistics * @param {Ticker24hrRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ticker24hr Binance API Documentation} */ ticker24hr(requestParameters?: Ticker24hrRequest): Promise>; /** * Get the current best price and quantity on the order book. * * If you need access to real-time order book ticker updates, please * consider using WebSocket Streams: * * `@bookTicker` * * Weight: Adjusted based on the number of requested symbols: * * |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * Notes: * * `symbol` and `symbols` cannot be used together. * * If no symbol is specified, returns information about all symbols currently trading on the exchange. * * @summary Symbol order book ticker * @param {TickerBookRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ticker-book Binance API Documentation} */ tickerBook(requestParameters?: TickerBookRequest): Promise>; /** * Get the latest market price for a symbol. * * If you need access to real-time price updates, please consider using * WebSocket Streams: * * `@aggTrade` * * `@trade` * * Weight: Adjusted based on the number of requested symbols: * * |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * Notes: * * `symbol` and `symbols` cannot be used together. * * If no symbol is specified, returns information about all symbols currently trading on the exchange. * * @summary Symbol price ticker * @param {TickerPriceRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ticker-price Binance API Documentation} */ tickerPrice(requestParameters?: TickerPriceRequest): Promise>; /** * Price change statistics for a trading day. * * Weight: 4 for each requested symbol regardless of windowSize. The weight for this request will cap at 200 once the number of symbols in the request is more than 50. * * Security Type: NONE * * Notes: **Data Source:** Database * **Notes:** * * Supported values for `timeZone`: * Hours and minutes (e.g. `-1:00`, `05:45`) * Only hours (e.g. `0`, `8`, `4`) * * * @summary Trading Day Ticker * @param {TickerTradingDayRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ticker-trading-day Binance API Documentation} */ tickerTradingDay(requestParameters?: TickerTradingDayRequest): Promise>; /** * Get aggregate trades. * * An *aggregate trade* (aggtrade) represents one or more individual * trades. * * Trades that fill at the same time, from the same taker order, with the * same price – * * those trades are collected into an aggregate trade with total quantity * of the individual trades. * * If you need access to real-time trading activity, please consider using * WebSocket Streams: * * `@aggTrade` * * If you need historical aggregate trade data, please consider using [data.binance.vision](https://github.com/binance/binance-public-data/#aggtrades). * * Weight(IP): 4 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If `fromId` is specified, return aggtrades with aggregate trade ID >= `fromId`. Use `fromId` and `limit` to page through all aggtrades. * - If `startTime` and/or `endTime` are specified, aggtrades are filtered by execution time (`T`). `fromId` cannot be used together with `startTime` and `endTime`. * - If no condition is specified, the most recent aggregate trades are returned. * * @summary Aggregate trades * @param {TradesAggregateRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#trades-aggregate Binance API Documentation} */ tradesAggregate(requestParameters: TradesAggregateRequest): Promise>; /** * Get historical trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Database * * Notes: * * If `fromId` is not specified, the most recent trades are returned. * * @summary Historical trades * @param {TradesHistoricalRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#trades-historical Binance API Documentation} */ tradesHistorical(requestParameters: TradesHistoricalRequest): Promise>; /** * Get recent trades. * * If you need access to real-time trading activity, please consider using * WebSocket Streams: * * `@trade` * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Recent trades * @param {TradesRecentRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#trades-recent Binance API Documentation} */ tradesRecent(requestParameters: TradesRecentRequest): Promise>; /** * Get klines (candlestick bars) optimized for presentation. * * This request is similar to `klines`, having the same parameters and response. `uiKlines` return modified kline data, optimized for presentation of candlestick charts. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If `startTime` and `endTime` are not sent, the most recent klines are returned. * - Supported values for `timeZone`: * - Hours and minutes (e.g. `-1:00`, `05:45`) * - Only hours (e.g. `0`, `8`, `4`) * - Accepted range is strictly [-12:00 to +14:00] inclusive * - If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * - Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary UI Klines * @param {UiKlinesRequest} requestParameters Request parameters. * @returns {Promise} * @memberof MarketApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ui-klines Binance API Documentation} */ uiKlines(requestParameters: UiKlinesRequest): Promise>; } declare enum DepthSymbolStatusEnum { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum KlinesIntervalEnum { INTERVAL_1s = "1s", INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum ReferencePriceCalculationSymbolStatusEnum { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum TickerTypeEnum { FULL = "FULL", MINI = "MINI", } declare enum TickerWindowSizeEnum { WINDOW_SIZE_1m = "1m", WINDOW_SIZE_2m = "2m", WINDOW_SIZE_3m = "3m", WINDOW_SIZE_4m = "4m", WINDOW_SIZE_5m = "5m", WINDOW_SIZE_6m = "6m", WINDOW_SIZE_7m = "7m", WINDOW_SIZE_8m = "8m", WINDOW_SIZE_9m = "9m", WINDOW_SIZE_10m = "10m", WINDOW_SIZE_11m = "11m", WINDOW_SIZE_12m = "12m", WINDOW_SIZE_13m = "13m", WINDOW_SIZE_14m = "14m", WINDOW_SIZE_15m = "15m", WINDOW_SIZE_16m = "16m", WINDOW_SIZE_17m = "17m", WINDOW_SIZE_18m = "18m", WINDOW_SIZE_19m = "19m", WINDOW_SIZE_20m = "20m", WINDOW_SIZE_21m = "21m", WINDOW_SIZE_22m = "22m", WINDOW_SIZE_23m = "23m", WINDOW_SIZE_24m = "24m", WINDOW_SIZE_25m = "25m", WINDOW_SIZE_26m = "26m", WINDOW_SIZE_27m = "27m", WINDOW_SIZE_28m = "28m", WINDOW_SIZE_29m = "29m", WINDOW_SIZE_30m = "30m", WINDOW_SIZE_31m = "31m", WINDOW_SIZE_32m = "32m", WINDOW_SIZE_33m = "33m", WINDOW_SIZE_34m = "34m", WINDOW_SIZE_35m = "35m", WINDOW_SIZE_36m = "36m", WINDOW_SIZE_37m = "37m", WINDOW_SIZE_38m = "38m", WINDOW_SIZE_39m = "39m", WINDOW_SIZE_40m = "40m", WINDOW_SIZE_41m = "41m", WINDOW_SIZE_42m = "42m", WINDOW_SIZE_43m = "43m", WINDOW_SIZE_44m = "44m", WINDOW_SIZE_45m = "45m", WINDOW_SIZE_46m = "46m", WINDOW_SIZE_47m = "47m", WINDOW_SIZE_48m = "48m", WINDOW_SIZE_49m = "49m", WINDOW_SIZE_50m = "50m", WINDOW_SIZE_51m = "51m", WINDOW_SIZE_52m = "52m", WINDOW_SIZE_53m = "53m", WINDOW_SIZE_54m = "54m", WINDOW_SIZE_55m = "55m", WINDOW_SIZE_56m = "56m", WINDOW_SIZE_57m = "57m", WINDOW_SIZE_58m = "58m", WINDOW_SIZE_59m = "59m", WINDOW_SIZE_1h = "1h", WINDOW_SIZE_2h = "2h", WINDOW_SIZE_3h = "3h", WINDOW_SIZE_4h = "4h", WINDOW_SIZE_5h = "5h", WINDOW_SIZE_6h = "6h", WINDOW_SIZE_7h = "7h", WINDOW_SIZE_8h = "8h", WINDOW_SIZE_9h = "9h", WINDOW_SIZE_10h = "10h", WINDOW_SIZE_11h = "11h", WINDOW_SIZE_12h = "12h", WINDOW_SIZE_13h = "13h", WINDOW_SIZE_14h = "14h", WINDOW_SIZE_15h = "15h", WINDOW_SIZE_16h = "16h", WINDOW_SIZE_17h = "17h", WINDOW_SIZE_18h = "18h", WINDOW_SIZE_19h = "19h", WINDOW_SIZE_20h = "20h", WINDOW_SIZE_21h = "21h", WINDOW_SIZE_22h = "22h", WINDOW_SIZE_23h = "23h", WINDOW_SIZE_1d = "1d", WINDOW_SIZE_2d = "2d", WINDOW_SIZE_3d = "3d", WINDOW_SIZE_4d = "4d", WINDOW_SIZE_5d = "5d", WINDOW_SIZE_6d = "6d", WINDOW_SIZE_7d = "7d", } declare enum TickerSymbolStatusEnum { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum Ticker24hrTypeEnum { FULL = "FULL", MINI = "MINI", } declare enum Ticker24hrSymbolStatusEnum { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum TickerBookSymbolStatusEnum { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum TickerPriceSymbolStatusEnum { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum TickerTradingDayTypeEnum { FULL = "FULL", MINI = "MINI", } declare enum TickerTradingDaySymbolStatusEnum { TRADING = "TRADING", HALT = "HALT", BREAK = "BREAK", } declare enum UiKlinesIntervalEnum { INTERVAL_1s = "1s", 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/websocket-api/modules/trade-api.d.ts /** * TradeApi - interface * * @interface TradeApi */ interface TradeApiInterface { /** * Cancel all open orders on a symbol. * This includes orders that are part of an order list. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Cancel open orders (TRADE) * @param {OpenOrdersCancelAllRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ openOrdersCancelAll(requestParameters: OpenOrdersCancelAllRequest): Promise>; /** * Reduce the quantity of an existing open order. * * This adds 0 orders to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read [Order Amend Keep Priority FAQ](/products/spot/faqs/order_amend_keep_priority) to learn more. * * Weight(IP): 4 * * Unfilled Order Count: 0 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Order Amend Keep Priority (TRADE) * @param {OrderAmendKeepPriorityRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderAmendKeepPriority(requestParameters: OrderAmendKeepPriorityRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Notes: * * If both `orderId` and `origClientOrderId` parameters are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * `newClientOrderId` will replace `clientOrderId` of the canceled order, freeing it up for new orders. * * If you cancel an order that is a part of an order list, the entire order list is canceled. * * The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel order (TRADE) * @param {OrderCancelRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderCancel(requestParameters: OrderCancelRequest): Promise>; /** * * Cancel an existing order and immediately place a new order instead of the canceled one. * A new order that was not attempted (i.e. when `newOrderResult: NOT_ATTEMPTED`), will still increase the unfilled order count by 1. * You can only cancel an individual order from an orderList using this method, but the result is the same as canceling the entire orderList.not attempted (i.e. when `newOrderResult: NOT_ATTEMPTED`), will still increase the unfilled order count by 1. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Similar to the [`order.place`](#order-place) request, * additional mandatory parameters (*) are determined by the new order `type`. * * Available `cancelReplaceMode` options: * * `STOP_ON_FAILURE` – if cancellation request fails, new order placement will not be attempted. * `ALLOW_FAILURE` – new order placement will be attempted even if the cancel request fails. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
RequestResponse
cancelReplaceModeorderRateLimitExceededModeUnfilled Order CountcancelResultnewOrderResultstatus
STOP_ON_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE➖ NOT_ATTEMPTEDN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits❌ FAILURE➖ NOT_ATTEMPTED429
✅ SUCCESS❌ FAILURE429
ALLOW_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE❌ FAILUREN/A
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILURE409
* * Notes: * * If both `cancelOrderId` and `cancelOrigClientOrderId` parameters are provided, the `cancelOrderId` is searched first, then the `cancelOrigClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * `cancelNewClientOrderId` will replace `clientOrderId` of the canceled order, freeing it up for new orders. * * `newClientOrderId` specifies `clientOrderId` value for the placed order. * * A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired. * * The new order can reuse old `clientOrderId` of the canceled order. * * This cancel-replace operation is **not transactional**. * * If one operation succeeds but the other one fails, the successful operation is still executed. * * For example, in `STOP_ON_FAILURE` mode, if the new order placement fails, the old order is still canceled. * * Filters and order count limits are evaluated before cancellation and order placement occurs. * * If new order placement is not attempted, your order count is still incremented. * * Like [`order.cancel`](#order-cancel), if you cancel an individual order from an order list, the entire order list is canceled. * * The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel and replace order (TRADE) * @param {OrderCancelReplaceRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderCancelReplace(requestParameters: OrderCancelReplaceRequest): Promise>; /** * Cancel an active order list. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Notes: * * If both `orderListId` and `listClientOrderId` parameters are provided, the `orderListId` is searched first, then the `listClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * Canceling an individual order with [`order.cancel`](#order-cancel) will cancel the entire order list as well. * * @summary Cancel Order list (TRADE) * @param {OrderListCancelRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderListCancel(requestParameters: OrderListCancelRequest): Promise>; /** * Send in a new one-cancels-the-other (OCO) pair: * `LIMIT_MAKER` + `STOP_LOSS`/`STOP_LOSS_LIMIT` orders (called *legs*), * where activation of one order immediately cancels the other. * * This adds 1 order to `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Notes: * * `listClientOrderId` parameter specifies `listClientOrderId` for the OCO pair. * * A new OCO with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. * * `listClientOrderId` is distinct from `clientOrderId` of individual orders. * * `limitClientOrderId` and `stopClientOrderId` specify `clientOrderId` values for both legs of the OCO. * * A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired. * * Price restrictions on the legs: * * | `side` | Price relation | * | ------ | -------------- | * | `BUY` | `price` < market price < `stopPrice` | * | `SELL` | `price` > market price > `stopPrice` | * * Both legs have the same `quantity`. * * However, you can set different iceberg quantity for individual legs. * * If `stopIcebergQty` is used, `stopLimitTimeInForce` must be `GTC`. * * `trailingDelta` applies only to the `STOP_LOSS`/`STOP_LOSS_LIMIT` leg of the OCO. * * @summary Place new OCO - Deprecated (TRADE) * @param {OrderListPlaceRequest} requestParameters Request parameters. * @deprecated * @returns {Promise} * @memberof TradeApiInterface */ orderListPlace(requestParameters: OrderListPlaceRequest): Promise>; /** * Send in an one-cancels-the-other (OCO) pair, where activation of one order immediately cancels the other. * * An OCO has 2 orders called the **above order** and **below order**. * * One of the orders must be a `LIMIT_MAKER/TAKE_PROFIT/TAKE_PROFIT_LIMIT` order and the other must be * `STOP_LOSS` or `STOP_LOSS_LIMIT` order. * * Price restrictions: * If the OCO is on the `SELL` side: * `LIMIT_MAKER/TAKE_PROFIT_LIMIT` `price` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT` * `stopPrice` * `TAKE_PROFIT stopPrice` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT * stopPrice` * If the OCO is on the `BUY` side: * `LIMIT_MAKER` `price` < Last Traded Price < `STOP_LOSS/STOP_LOSS_LIMIT` `stopPrice` * `TAKE_PROFIT stopPrice` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT stopPrice` * OCOs add **2 orders** to the `EXCHANGE_MAX_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Place new Order list - OCO (TRADE) * @param {OrderListPlaceOcoRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderListPlaceOco(requestParameters: OrderListPlaceOcoRequest): Promise>; /** * Place an [OPO](/products/spot/faqs/opo). * * OPOs add 2 orders to the EXCHANGE_MAX_NUM_ORDERS filter and MAX_NUM_ORDERS filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary OPO (TRADE) * @param {OrderListPlaceOpoRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderListPlaceOpo(requestParameters: OrderListPlaceOpoRequest): Promise>; /** * Place an [OPOCO](/products/spot/faqs/opo). * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary OPOCO (TRADE) * @param {OrderListPlaceOpocoRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderListPlaceOpoco(requestParameters: OrderListPlaceOpocoRequest): Promise>; /** * Places an OTO. * * An OTO (One-Triggers-the-Other) is an order list comprised of 2 orders. * * The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the * working order goes on the order book. * * The second order is called the **pending order**. It can be any order type except for `MARKET` orders using * parameter `quoteOrderQty`. The pending order is only placed on the order book when the working order gets **fully filled**. * * If either the working order or the pending order is cancelled individually, the other order in the order list * will also be canceled or expired. * * When the order list is placed, if the working order gets **immediately fully filled**, the placement response * will show the working order as `FILLED` but the pending order will still appear as `PENDING_NEW`. You need to * query the status of the pending order again to see its updated status. * * OTOs add **2 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingType` or `workingType`** * * Depending on the `pendingType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingType` = `LIMIT` |`pendingPrice`, `pendingTimeInForce` | * |`pendingType` = `STOP_LOSS` or `TAKE_PROFIT` |`pendingStopPrice` and/or `pendingTrailingDelta`| * |`pendingType` =`STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`|`pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce`| * * @summary Place new Order list - OTO (TRADE) * @param {OrderListPlaceOtoRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderListPlaceOto(requestParameters: OrderListPlaceOtoRequest): Promise>; /** * Place an OTOCO. * * An OTOCO (One-Triggers-One-Cancels-the-Other) is an order list comprised of 3 orders. * The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. * The behavior of the working order is the same as the [OTO](#order-list-place-oto). * OTOCO has 2 pending orders (pending above and pending below), forming an OCO pair. The pending orders are only placed on the order book when the working order gets **fully filled**. * The rules of the pending above and pending below follow the same rules as the [Order list OCO](#order-list-place-oco). * OTOCOs add **3 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingAboveType`, `pendingBelowType` or `workingType`** * * Depending on the `pendingAboveType`/`pendingBelowType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingAboveType`= `LIMIT_MAKER` |`pendingAbovePrice` | * |`pendingAboveType` = `STOP_LOSS/TAKE_PROFIT` |`pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`| * |`pendingAboveType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT`|`pendingAbovePrice`, `pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`, `pendingAboveTimeInForce`| * |`pendingBelowType`= `LIMIT_MAKER` |`pendingBelowPrice` | * `pendingBelowType= STOP_LOSS/TAKE_PROFIT` |`pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`| * |`pendingBelowType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT`|`pendingBelowPrice`, `pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`, `pendingBelowTimeInForce`| * * @summary Place new Order list - OTOCO (TRADE) * @param {OrderListPlaceOtocoRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderListPlaceOtoco(requestParameters: OrderListPlaceOtocoRequest): Promise>; /** * Send in a new order. * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Certain parameters (*) become mandatory based on the order `type`: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Order typeMandatory parameters
LIMIT *
    *
  • timeInForce
    • *
  • price
    • *
  • quantity
    • *
*
LIMIT_MAKER *
    *
  • price
    • *
  • quantity
    • *
*
MARKET *
    *
  • quantity or quoteOrderQty
    • *
*
STOP_LOSS *
    *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
STOP_LOSS_LIMIT *
    *
  • timeInForce
    • *
  • price
    • *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
TAKE_PROFIT *
    *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
TAKE_PROFIT_LIMIT *
    *
  • timeInForce
    • *
  • price
    • *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
* * Supported order types: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Order typeDescription
LIMIT *

* Buy or sell quantity at the specified price or better. *

*
LIMIT_MAKER *

* LIMIT order that will be rejected if it immediately matches and trades as a taker. *

*

* This order type is also known as a POST-ONLY order. *

*
MARKET *

* Buy or sell at the best available market price. *

*
    *
  • *

    * MARKET order with quantity parameter * specifies the amount of the base asset you want to buy or sell. * Actually executed quantity of the quote asset will be determined by available market liquidity. *

    *

    * E.g., a MARKET BUY order on BTCUSDT for "quantity": "0.1000" * specifies that you want to buy 0.1 BTC at the best available price. * If there is not enough BTC at the best price, keep buying at the next best price, * until either your order is filled, or you run out of USDT, or market runs out of BTC. *

    *
    • *
  • *

    * MARKET order with quoteOrderQty parameter * specifies the amount of the quote asset you want to spend (when buying) or receive (when selling). * Actually executed quantity of the base asset will be determined by available market liquidity. *

    *

    * E.g., a MARKET BUY on BTCUSDT for "quoteOrderQty": "100.00" * specifies that you want to buy as much BTC as you can for 100 USDT at the best available price. * Similarly, a SELL order will sell as much available BTC as needed for you to receive 100 USDT * (before commission). *

    *
    • *
*
STOP_LOSS *

* Execute a MARKET order for given quantity when specified conditions are met. *

*

* I.e., when stopPrice is reached, or when trailingDelta is activated. *

*
STOP_LOSS_LIMIT *

* Place a LIMIT order with given parameters when specified conditions are met. *

*
TAKE_PROFIT *

* Like STOP_LOSS but activates when market price moves in the favorable direction. *

*
TAKE_PROFIT_LIMIT *

* Like STOP_LOSS_LIMIT but activates when market price moves in the favorable direction. *

*
* * * Notes on using parameters for Pegged Orders: * * These parameters are allowed for `LIMIT`, `LIMIT_MAKER`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_LIMIT` orders. * If `pegPriceType` is specified, `price` becomes optional. Otherwise, it is still mandatory. * `pegPriceType=PRIMARY_PEG` means the primary peg, that is the best price on the same side of the order book as your order. * `pegPriceType=MARKET_PEG` means the market peg, that is the best price on the opposite side of the order book from your order. * Use `pegOffsetType` and `pegOffsetValue` to request a price level other than the best one. These parameters must be specified together. * * * * Available `timeInForce` options, * setting how long the order should be active before expiration: * * TIF | Description * ----- | -------------- * `GTC` | **Good 'til Canceled** – the order will remain on the book until you cancel it, or the order is completely filled. * `IOC` | **Immediate or Cancel** – the order will be filled for as much as possible, the unfilled quantity immediately expires. * `FOK` | **Fill or Kill** – the order will expire unless it cannot be immediately filled for the entire quantity. * * Notes: * * `newClientOrderId` specifies `clientOrderId` value for the order. * * A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired. * * Any `LIMIT` or `LIMIT_MAKER` order can be made into an iceberg order by specifying the `icebergQty`. * * An order with an `icebergQty` must have `timeInForce` set to `GTC`. * * Trigger order price rules for `STOP_LOSS`/`TAKE_PROFIT` orders: * * `stopPrice` must be above market price: `STOP_LOSS BUY`, `TAKE_PROFIT SELL` * `stopPrice` must be below market price: `STOP_LOSS SELL`, `TAKE_PROFIT BUY` * * `MARKET` orders using `quoteOrderQty` follow [`LOT_SIZE`](/products/spot/filters#lot_size) filter rules. * * The order will execute a quantity that has notional value as close as possible to requested `quoteOrderQty`. * * @summary Place new order (TRADE) * @param {OrderPlaceRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderPlace(requestParameters: OrderPlaceRequest): Promise>; /** * Test order placement. * * Validates new order parameters and verifies your signature * but does not send the order into the matching engine. * * Weight: | Condition | Request Weight | * | --- | --- | * | Without `computeCommissionRates` | 1 | * | With `computeCommissionRates` | 20 | * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order (TRADE) * @param {OrderTestRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ orderTest(requestParameters: OrderTestRequest): Promise>; /** * Places an order using smart order routing (SOR). * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read [SOR FAQ](/products/spot/faqs/sor_faq) to learn more. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Note:** `sor.order.place` only supports `LIMIT` and `MARKET` orders. `quoteOrderQty` is not supported. * * @summary Place new order using SOR (TRADE) * @param {SorOrderPlaceRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ sorOrderPlace(requestParameters: SorOrderPlaceRequest): Promise>; /** * Test new order creation and signature/recvWindow using smart order routing (SOR). * Creates and validates a new order but does not send it into the matching engine. * * Weight: | Condition | Request Weight | * | --- | --- | * | Without `computeCommissionRates` | 1 | * | With `computeCommissionRates` | 20 | * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order using SOR (TRADE) * @param {SorOrderTestRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof TradeApiInterface */ sorOrderTest(requestParameters: SorOrderTestRequest): Promise>; } /** * Request parameters for openOrdersCancelAll operation in TradeApi. * @interface OpenOrdersCancelAllRequest */ interface OpenOrdersCancelAllRequest { /** * * @type {string} * @memberof TradeApiOpenOrdersCancelAll */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOpenOrdersCancelAll */ readonly id?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOpenOrdersCancelAll */ readonly recvWindow?: number; } /** * Request parameters for orderAmendKeepPriority operation in TradeApi. * @interface OrderAmendKeepPriorityRequest */ interface OrderAmendKeepPriorityRequest { /** * * @type {string} * @memberof TradeApiOrderAmendKeepPriority */ readonly symbol: string; /** * `newQty` must be greater than 0 and less than the order's quantity. * @type {number} * @memberof TradeApiOrderAmendKeepPriority */ readonly newQty: number; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderAmendKeepPriority */ readonly id?: string; /** * `orderId` or `origClientOrderId` must be sent * @type {number | bigint} * @memberof TradeApiOrderAmendKeepPriority */ readonly orderId?: number | bigint; /** * `orderId` or `origClientOrderId` must be sent * @type {string} * @memberof TradeApiOrderAmendKeepPriority */ readonly origClientOrderId?: string; /** * The new client order ID for the order after being amended.
If not sent, one will be randomly generated.
It is possible to reuse the current clientOrderId by sending it as the `newClientOrderId`. * @type {string} * @memberof TradeApiOrderAmendKeepPriority */ readonly newClientOrderId?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderAmendKeepPriority */ readonly recvWindow?: number; } /** * Request parameters for orderCancel operation in TradeApi. * @interface OrderCancelRequest */ interface OrderCancelRequest { /** * * @type {string} * @memberof TradeApiOrderCancel */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderCancel */ readonly id?: string; /** * * @type {number | bigint} * @memberof TradeApiOrderCancel */ readonly orderId?: number | bigint; /** * * @type {string} * @memberof TradeApiOrderCancel */ readonly origClientOrderId?: string; /** * Used to uniquely identify this cancel. Automatically generated by default. * @type {string} * @memberof TradeApiOrderCancel */ readonly newClientOrderId?: string; /** * Supported values:
`ONLY_NEW` - Cancel will succeed if the order status is `NEW`.
`ONLY_PARTIALLY_FILLED` - Cancel will succeed if order status is `PARTIALLY_FILLED`. * @type {'ONLY_NEW' | 'ONLY_PARTIALLY_FILLED'} * @memberof TradeApiOrderCancel */ readonly cancelRestrictions?: OrderCancelCancelRestrictionsEnum; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderCancel */ readonly recvWindow?: number; } /** * Request parameters for orderCancelReplace operation in TradeApi. * @interface OrderCancelReplaceRequest */ interface OrderCancelReplaceRequest { /** * * @type {string} * @memberof TradeApiOrderCancelReplace */ readonly symbol: string; /** * The allowed values are:
`STOP_ON_FAILURE` - If the cancel request fails, the new order placement will not be attempted.
`ALLOW_FAILURE` - new order placement will be attempted even if cancel request fails. * @type {'STOP_ON_FAILURE' | 'ALLOW_FAILURE'} * @memberof TradeApiOrderCancelReplace */ readonly cancelReplaceMode: OrderCancelReplaceCancelReplaceModeEnum; /** * Please see [Enums](/products/spot/enums#side) for supported values. * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderCancelReplace */ readonly side: OrderCancelReplaceSideEnum; /** * Please see [Enums](/products/spot/enums#ordertypes) for supported values. * @type {'MARKET' | 'LIMIT' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderCancelReplace */ readonly type: OrderCancelReplaceTypeEnum; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderCancelReplace */ readonly id?: string; /** * Either `cancelOrderId` or `cancelOrigClientOrderId` must be sent.

If both `cancelOrderId` and `cancelOrigClientOrderId` parameters are provided, the `cancelOrderId` is searched first, then the `cancelOrigClientOrderId` from that result is checked against that order.

If both conditions are not met the request will be rejected. * @type {number | bigint} * @memberof TradeApiOrderCancelReplace */ readonly cancelOrderId?: number | bigint; /** * Either `cancelOrderId` or `cancelOrigClientOrderId` must be sent.

If both `cancelOrderId` and `cancelOrigClientOrderId` parameters are provided, the `cancelOrderId` is searched first, then the `cancelOrigClientOrderId` from that result is checked against that order.

If both conditions are not met the request will be rejected. * @type {string} * @memberof TradeApiOrderCancelReplace */ readonly cancelOrigClientOrderId?: string; /** * Used to uniquely identify this cancel. Automatically generated by default. * @type {string} * @memberof TradeApiOrderCancelReplace */ readonly cancelNewClientOrderId?: string; /** * Please see [Enums](/products/spot/enums#timeinforce) for supported values. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderCancelReplace */ readonly timeInForce?: OrderCancelReplaceTimeInForceEnum; /** * * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly price?: number; /** * * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly quantity?: number; /** * * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly quoteOrderQty?: number; /** * Used to identify the new order. * @type {string} * @memberof TradeApiOrderCancelReplace */ readonly newClientOrderId?: string; /** * Allowed values:
`ACK`, `RESULT`, `FULL`
`MARKET` and `LIMIT` orders types default to `FULL`; all other orders default to `ACK` * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderCancelReplace */ readonly newOrderRespType?: OrderCancelReplaceNewOrderRespTypeEnum; /** * Used with `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, and `TAKE_PROFIT_LIMIT` orders. * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly stopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly trailingDelta?: number; /** * Used with `LIMIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` to create an iceberg order. * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly icebergQty?: number; /** * * @type {number | bigint} * @memberof TradeApiOrderCancelReplace */ readonly strategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly strategyType?: number; /** * The allowed enums is dependent on what is configured on the symbol. The possible supported values are: [STP Modes](/products/spot/enums#stpmodes). * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderCancelReplace */ readonly selfTradePreventionMode?: OrderCancelReplaceSelfTradePreventionModeEnum; /** * Supported values:
`ONLY_NEW` - Cancel will succeed if the order status is `NEW`.
`ONLY_PARTIALLY_FILLED` - Cancel will succeed if order status is `PARTIALLY_FILLED`. * @type {'ONLY_NEW' | 'ONLY_PARTIALLY_FILLED'} * @memberof TradeApiOrderCancelReplace */ readonly cancelRestrictions?: OrderCancelReplaceCancelRestrictionsEnum; /** * Supported values:
`DO_NOTHING` (default)- will only attempt to cancel the order if account has not exceeded the unfilled order rate limit
`CANCEL_ONLY` - will always cancel the order * @type {'DO_NOTHING' | 'CANCEL_ONLY'} * @memberof TradeApiOrderCancelReplace */ readonly orderRateLimitExceededMode?: OrderCancelReplaceOrderRateLimitExceededModeEnum; /** * `PRIMARY_PEG` or `MARKET_PEG`
See Pegged Orders * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderCancelReplace */ readonly pegPriceType?: OrderCancelReplacePegPriceTypeEnum; /** * Price level to peg the price to (max: 100)
See Pegged Orders * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly pegOffsetValue?: number; /** * Only `PRICE_LEVEL` is supported
See Pegged Orders * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderCancelReplace */ readonly pegOffsetType?: OrderCancelReplacePegOffsetTypeEnum; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderCancelReplace */ readonly recvWindow?: number; } /** * Request parameters for orderListCancel operation in TradeApi. * @interface OrderListCancelRequest */ interface OrderListCancelRequest { /** * * @type {string} * @memberof TradeApiOrderListCancel */ readonly symbol: string; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderListCancel */ readonly id?: string; /** * Either `orderListId` or `listClientOrderId` must be provided * @type {number} * @memberof TradeApiOrderListCancel */ readonly orderListId?: number; /** * Either `orderListId` or `listClientOrderId` must be provided * @type {string} * @memberof TradeApiOrderListCancel */ readonly listClientOrderId?: string; /** * Used to uniquely identify this cancel. Automatically generated by default. * @type {string} * @memberof TradeApiOrderListCancel */ readonly newClientOrderId?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListCancel */ readonly recvWindow?: number; } /** * Request parameters for orderListPlace operation in TradeApi. * @interface OrderListPlaceRequest */ interface OrderListPlaceRequest { /** * * @type {string} * @memberof TradeApiOrderListPlace */ readonly symbol: string; /** * Please see [Enums](/products/spot/enums#side) for supported values. * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListPlace */ readonly side: OrderListPlaceSideEnum; /** * * @type {number} * @memberof TradeApiOrderListPlace */ readonly price: number; /** * * @type {number} * @memberof TradeApiOrderListPlace */ readonly quantity: number; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderListPlace */ readonly id?: string; /** * A unique Id for the entire orderList * @type {string} * @memberof TradeApiOrderListPlace */ readonly listClientOrderId?: string; /** * A unique Id for the limit order * @type {string} * @memberof TradeApiOrderListPlace */ readonly limitClientOrderId?: string; /** * Used to make the `LIMIT_MAKER` leg an iceberg order. * @type {number} * @memberof TradeApiOrderListPlace */ readonly limitIcebergQty?: number; /** * * @type {number | bigint} * @memberof TradeApiOrderListPlace */ readonly limitStrategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiOrderListPlace */ readonly limitStrategyType?: number; /** * * @type {number} * @memberof TradeApiOrderListPlace */ readonly stopPrice?: number; /** * * @type {number} * @memberof TradeApiOrderListPlace */ readonly trailingDelta?: number; /** * A unique Id for the stop loss/stop loss limit leg * @type {string} * @memberof TradeApiOrderListPlace */ readonly stopClientOrderId?: string; /** * If provided, `stopLimitTimeInForce` is required. * @type {number} * @memberof TradeApiOrderListPlace */ readonly stopLimitPrice?: number; /** * Valid values are `GTC`/`FOK`/`IOC` * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlace */ readonly stopLimitTimeInForce?: OrderListPlaceStopLimitTimeInForceEnum; /** * Used with `STOP_LOSS_LIMIT` leg to make an iceberg order. * @type {number} * @memberof TradeApiOrderListPlace */ readonly stopIcebergQty?: number; /** * * @type {number | bigint} * @memberof TradeApiOrderListPlace */ readonly stopStrategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiOrderListPlace */ readonly stopStrategyType?: number; /** * Format of the JSON response. Supported values: [Order Response Type](/products/spot/enums#orderresponsetype) * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListPlace */ readonly newOrderRespType?: OrderListPlaceNewOrderRespTypeEnum; /** * The allowed values are dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListPlace */ readonly selfTradePreventionMode?: OrderListPlaceSelfTradePreventionModeEnum; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListPlace */ readonly recvWindow?: number; } /** * Request parameters for orderListPlaceOco operation in TradeApi. * @interface OrderListPlaceOcoRequest */ interface OrderListPlaceOcoRequest { /** * * @type {string} * @memberof TradeApiOrderListPlaceOco */ readonly symbol: string; /** * `BUY` or `SELL` * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListPlaceOco */ readonly side: OrderListPlaceOcoSideEnum; /** * Quantity for both orders of the order list. * @type {number} * @memberof TradeApiOrderListPlaceOco */ readonly quantity: number; /** * * @type {'STOP_LOSS_LIMIT' | 'STOP_LOSS' | 'LIMIT_MAKER' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListPlaceOco */ readonly aboveType: OrderListPlaceOcoAboveTypeEnum; /** * Supported values: `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT` * @type {'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListPlaceOco */ readonly belowType: OrderListPlaceOcoBelowTypeEnum; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderListPlaceOco */ readonly id?: string; /** * Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `aboveClientOrderId` and the `belowClientOrderId`. * @type {string} * @memberof TradeApiOrderListPlaceOco */ readonly listClientOrderId?: string; /** * Arbitrary unique ID among open orders for the above order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOco */ readonly aboveClientOrderId?: string; /** * Note that this can only be used if `aboveTimeInForce` is `GTC`. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOco */ readonly aboveIcebergQty?: number | bigint; /** * Can be used if `aboveType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListPlaceOco */ readonly abovePrice?: number; /** * Can be used if `aboveType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `aboveStopPrice` or `aboveTrailingDelta` or both, must be specified. * @type {number} * @memberof TradeApiOrderListPlaceOco */ readonly aboveStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number | bigint} * @memberof TradeApiOrderListPlaceOco */ readonly aboveTrailingDelta?: number | bigint; /** * Required if `aboveType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOco */ readonly aboveTimeInForce?: OrderListPlaceOcoAboveTimeInForceEnum; /** * Arbitrary numeric value identifying the above order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOco */ readonly aboveStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the above order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOco */ readonly aboveStrategyType?: number; /** * `PRIMARY_PEG` or `MARKET_PEG`. See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOco */ readonly abovePegPriceType?: OrderListPlaceOcoAbovePegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOco */ readonly abovePegOffsetType?: OrderListPlaceOcoAbovePegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOco */ readonly abovePegOffsetValue?: number; /** * Arbitrary unique ID among open orders for the below order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOco */ readonly belowClientOrderId?: string; /** * Note that this can only be used if `belowTimeInForce` is `GTC`. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOco */ readonly belowIcebergQty?: number | bigint; /** * Can be used if `belowType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListPlaceOco */ readonly belowPrice?: number; /** * Can be used if `belowType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `belowStopPrice` or `belowTrailingDelta` or both, must be specified. * @type {number} * @memberof TradeApiOrderListPlaceOco */ readonly belowStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number | bigint} * @memberof TradeApiOrderListPlaceOco */ readonly belowTrailingDelta?: number | bigint; /** * Required if `belowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOco */ readonly belowTimeInForce?: OrderListPlaceOcoBelowTimeInForceEnum; /** * Arbitrary numeric value identifying the below order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOco */ readonly belowStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the below order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOco */ readonly belowStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOco */ readonly belowPegPriceType?: OrderListPlaceOcoBelowPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOco */ readonly belowPegOffsetType?: OrderListPlaceOcoBelowPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOco */ readonly belowPegOffsetValue?: number; /** * Select response format: `ACK`, `RESULT`, `FULL`. * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListPlaceOco */ readonly newOrderRespType?: OrderListPlaceOcoNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListPlaceOco */ readonly selfTradePreventionMode?: OrderListPlaceOcoSelfTradePreventionModeEnum; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListPlaceOco */ readonly recvWindow?: number; } /** * Request parameters for orderListPlaceOpo operation in TradeApi. * @interface OrderListPlaceOpoRequest */ interface OrderListPlaceOpoRequest { /** * * @type {string} * @memberof TradeApiOrderListPlaceOpo */ readonly symbol: string; /** * Supported values: `LIMIT`, `LIMIT_MAKER` * @type {'LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListPlaceOpo */ readonly workingType: OrderListPlaceOpoWorkingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListPlaceOpo */ readonly workingSide: OrderListPlaceOpoWorkingSideEnum; /** * Price for the working order. * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly workingPrice: number; /** * Sets the quantity for the working order. * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly workingQuantity: number; /** * Supported values: [Order Types](/products/spot/enums#ordertypes). Note that `MARKET` orders using `quoteOrderQty` are not supported. * @type {'LIMIT' | 'MARKET' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingType: OrderListPlaceOpoPendingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingSide: OrderListPlaceOpoPendingSideEnum; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderListPlaceOpo */ readonly id?: string; /** * Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. * @type {string} * @memberof TradeApiOrderListPlaceOpo */ readonly listClientOrderId?: string; /** * Format of the JSON response. Supported values: [Order Response Type](/products/spot/enums#orderresponsetype) * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListPlaceOpo */ readonly newOrderRespType?: OrderListPlaceOpoNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListPlaceOpo */ readonly selfTradePreventionMode?: OrderListPlaceOpoSelfTradePreventionModeEnum; /** * Arbitrary unique ID among open orders for the working order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOpo */ readonly workingClientOrderId?: string; /** * This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly workingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOpo */ readonly workingTimeInForce?: OrderListPlaceOpoWorkingTimeInForceEnum; /** * Arbitrary numeric value identifying the working order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOpo */ readonly workingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly workingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOpo */ readonly workingPegPriceType?: OrderListPlaceOpoWorkingPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOpo */ readonly workingPegOffsetType?: OrderListPlaceOpoWorkingPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly workingPegOffsetValue?: number; /** * Arbitrary unique ID among open orders for the pending order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingClientOrderId?: string; /** * Price for the pending order. * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingPrice?: number; /** * Stop price for the pending order. * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingStopPrice?: number; /** * Trailing delta for the pending order. * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingTrailingDelta?: number; /** * This can only be used if `pendingTimeInForce` is `GTC` or if `pendingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingTimeInForce?: OrderListPlaceOpoPendingTimeInForceEnum; /** * Arbitrary numeric value identifying the pending order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingPegPriceType?: OrderListPlaceOpoPendingPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingPegOffsetType?: OrderListPlaceOpoPendingPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly pendingPegOffsetValue?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListPlaceOpo */ readonly recvWindow?: number; } /** * Request parameters for orderListPlaceOpoco operation in TradeApi. * @interface OrderListPlaceOpocoRequest */ interface OrderListPlaceOpocoRequest { /** * * @type {string} * @memberof TradeApiOrderListPlaceOpoco */ readonly symbol: string; /** * * @type {'LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingType: OrderListPlaceOpocoWorkingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingSide: OrderListPlaceOpocoWorkingSideEnum; /** * Price for the working order. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingPrice: number; /** * Sets the quantity for the working order. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingQuantity: number; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingSide: OrderListPlaceOpocoPendingSideEnum; /** * Supported values: `STOP_LOSS_LIMIT`, `STOP_LOSS`, `LIMIT_MAKER`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT` * @type {'STOP_LOSS_LIMIT' | 'STOP_LOSS' | 'LIMIT_MAKER' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAboveType: OrderListPlaceOpocoPendingAboveTypeEnum; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderListPlaceOpoco */ readonly id?: string; /** * Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. * @type {string} * @memberof TradeApiOrderListPlaceOpoco */ readonly listClientOrderId?: string; /** * Format of the JSON response. Supported values: [Order Response Type](/products/spot/enums#orderresponsetype) * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListPlaceOpoco */ readonly newOrderRespType?: OrderListPlaceOpocoNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListPlaceOpoco */ readonly selfTradePreventionMode?: OrderListPlaceOpocoSelfTradePreventionModeEnum; /** * Arbitrary unique ID among open orders for the working order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingClientOrderId?: string; /** * This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingTimeInForce?: OrderListPlaceOpocoWorkingTimeInForceEnum; /** * Arbitrary numeric value identifying the working order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingPegPriceType?: OrderListPlaceOpocoWorkingPegPriceTypeEnum; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingPegOffsetType?: OrderListPlaceOpocoWorkingPegOffsetTypeEnum; /** * Price level for pegging (max: 100). See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly workingPegOffsetValue?: number; /** * Arbitrary unique ID among open orders for the pending above order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAboveClientOrderId?: string; /** * Can be used if `pendingAboveType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAbovePrice?: number; /** * Can be used if `pendingAboveType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAboveStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAboveTrailingDelta?: number; /** * This can only be used if `pendingAboveTimeInForce` is `GTC` or `pendingAboveType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAboveIcebergQty?: number; /** * Required if `pendingAboveType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAboveTimeInForce?: OrderListPlaceOpocoPendingAboveTimeInForceEnum; /** * Arbitrary numeric value identifying the pending above order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAboveStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending above order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAboveStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAbovePegPriceType?: OrderListPlaceOpocoPendingAbovePegPriceTypeEnum; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAbovePegOffsetType?: OrderListPlaceOpocoPendingAbovePegOffsetTypeEnum; /** * Price level for pegging (max: 100). See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingAbovePegOffsetValue?: number; /** * Supported values: `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT` * @type {'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowType?: OrderListPlaceOpocoPendingBelowTypeEnum; /** * Arbitrary unique ID among open orders for the pending below order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowClientOrderId?: string; /** * Can be used if `pendingBelowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowPrice?: number; /** * Can be used if `pendingBelowType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `pendingBelowStopPrice` or `pendingBelowTrailingDelta` or both, must be specified. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowTrailingDelta?: number; /** * This can only be used if `pendingBelowTimeInForce` is `GTC` or `pendingBelowType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowTimeInForce?: OrderListPlaceOpocoPendingBelowTimeInForceEnum; /** * Arbitrary numeric value identifying the pending below order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending below order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowPegPriceType?: OrderListPlaceOpocoPendingBelowPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowPegOffsetType?: OrderListPlaceOpocoPendingBelowPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly pendingBelowPegOffsetValue?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListPlaceOpoco */ readonly recvWindow?: number; } /** * Request parameters for orderListPlaceOto operation in TradeApi. * @interface OrderListPlaceOtoRequest */ interface OrderListPlaceOtoRequest { /** * * @type {string} * @memberof TradeApiOrderListPlaceOto */ readonly symbol: string; /** * Supported values: `LIMIT`, `LIMIT_MAKER` * @type {'LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListPlaceOto */ readonly workingType: OrderListPlaceOtoWorkingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListPlaceOto */ readonly workingSide: OrderListPlaceOtoWorkingSideEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly workingPrice: number; /** * Sets the quantity for the working order. * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly workingQuantity: number; /** * Supported values: [Order Types](/products/spot/enums#ordertypes). Note that `MARKET` orders using `quoteOrderQty` are not supported. * @type {'LIMIT' | 'MARKET' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListPlaceOto */ readonly pendingType: OrderListPlaceOtoPendingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListPlaceOto */ readonly pendingSide: OrderListPlaceOtoPendingSideEnum; /** * Sets the quantity for the pending order. * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly pendingQuantity: number; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderListPlaceOto */ readonly id?: string; /** * Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. * @type {string} * @memberof TradeApiOrderListPlaceOto */ readonly listClientOrderId?: string; /** * Format of the JSON response. Supported values: [Order Response Type](/products/spot/enums#orderresponsetype) * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListPlaceOto */ readonly newOrderRespType?: OrderListPlaceOtoNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListPlaceOto */ readonly selfTradePreventionMode?: OrderListPlaceOtoSelfTradePreventionModeEnum; /** * Arbitrary unique ID among open orders for the working order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOto */ readonly workingClientOrderId?: string; /** * This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly workingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOto */ readonly workingTimeInForce?: OrderListPlaceOtoWorkingTimeInForceEnum; /** * Arbitrary numeric value identifying the working order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOto */ readonly workingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly workingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOto */ readonly workingPegPriceType?: OrderListPlaceOtoWorkingPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOto */ readonly workingPegOffsetType?: OrderListPlaceOtoWorkingPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly workingPegOffsetValue?: number; /** * Arbitrary unique ID among open orders for the pending order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOto */ readonly pendingClientOrderId?: string; /** * * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly pendingPrice?: number; /** * * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly pendingStopPrice?: number; /** * * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly pendingTrailingDelta?: number; /** * This can only be used if `pendingTimeInForce` is `GTC` or if `pendingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly pendingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOto */ readonly pendingTimeInForce?: OrderListPlaceOtoPendingTimeInForceEnum; /** * Arbitrary numeric value identifying the pending order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOto */ readonly pendingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly pendingStrategyType?: number; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOto */ readonly pendingPegOffsetType?: OrderListPlaceOtoPendingPegOffsetTypeEnum; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOto */ readonly pendingPegPriceType?: OrderListPlaceOtoPendingPegPriceTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly pendingPegOffsetValue?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListPlaceOto */ readonly recvWindow?: number; } /** * Request parameters for orderListPlaceOtoco operation in TradeApi. * @interface OrderListPlaceOtocoRequest */ interface OrderListPlaceOtocoRequest { /** * * @type {string} * @memberof TradeApiOrderListPlaceOtoco */ readonly symbol: string; /** * Supported values: `LIMIT`, `LIMIT_MAKER` * @type {'LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingType: OrderListPlaceOtocoWorkingTypeEnum; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingSide: OrderListPlaceOtocoWorkingSideEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingPrice: number; /** * Sets the quantity for the working order. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingQuantity: number; /** * Supported values: [Order Side](/products/spot/enums#side) * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingSide: OrderListPlaceOtocoPendingSideEnum; /** * Sets the quantity for the pending orders. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingQuantity: number; /** * Supported values: `STOP_LOSS_LIMIT`, `STOP_LOSS`, `LIMIT_MAKER`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT` * @type {'STOP_LOSS_LIMIT' | 'STOP_LOSS' | 'LIMIT_MAKER' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAboveType: OrderListPlaceOtocoPendingAboveTypeEnum; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderListPlaceOtoco */ readonly id?: string; /** * Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. * @type {string} * @memberof TradeApiOrderListPlaceOtoco */ readonly listClientOrderId?: string; /** * Format of the JSON response. Supported values: [Order Response Type](/products/spot/enums#orderresponsetype) * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderListPlaceOtoco */ readonly newOrderRespType?: OrderListPlaceOtocoNewOrderRespTypeEnum; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderListPlaceOtoco */ readonly selfTradePreventionMode?: OrderListPlaceOtocoSelfTradePreventionModeEnum; /** * Arbitrary unique ID among open orders for the working order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingClientOrderId?: string; /** * This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingIcebergQty?: number; /** * Supported values: [Time In Force](/products/spot/enums#timeinforce) * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingTimeInForce?: OrderListPlaceOtocoWorkingTimeInForceEnum; /** * Arbitrary numeric value identifying the working order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingPegPriceType?: OrderListPlaceOtocoWorkingPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingPegOffsetType?: OrderListPlaceOtocoWorkingPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly workingPegOffsetValue?: number; /** * Arbitrary unique ID among open orders for the pending above order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAboveClientOrderId?: string; /** * Can be used if `pendingAboveType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAbovePrice?: number; /** * Can be used if `pendingAboveType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAboveStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAboveTrailingDelta?: number; /** * This can only be used if `pendingAboveTimeInForce` is `GTC` or if `pendingAboveType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAboveIcebergQty?: number; /** * Required if `pendingAboveType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAboveTimeInForce?: OrderListPlaceOtocoPendingAboveTimeInForceEnum; /** * Arbitrary numeric value identifying the pending above order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAboveStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending above order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAboveStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAbovePegPriceType?: OrderListPlaceOtocoPendingAbovePegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAbovePegOffsetType?: OrderListPlaceOtocoPendingAbovePegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingAbovePegOffsetValue?: number; /** * Supported values: `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT` * @type {'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT'} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowType?: OrderListPlaceOtocoPendingBelowTypeEnum; /** * Arbitrary unique ID among open orders for the pending below order. Automatically generated if not sent. * @type {string} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowClientOrderId?: string; /** * Can be used if `pendingBelowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT` to specify the limit price. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowPrice?: number; /** * Can be used if `pendingBelowType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `pendingBelowStopPrice` or `pendingBelowTrailingDelta` or both, must be specified. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowStopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowTrailingDelta?: number; /** * This can only be used if `pendingBelowTimeInForce` is `GTC`, or if `pendingBelowType` is `LIMIT_MAKER`. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowIcebergQty?: number; /** * Required if `pendingBelowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowTimeInForce?: OrderListPlaceOtocoPendingBelowTimeInForceEnum; /** * Arbitrary numeric value identifying the pending below order within an order strategy. * @type {number | bigint} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowStrategyId?: number | bigint; /** * Arbitrary numeric value identifying the pending below order strategy. Values smaller than `1000000` are reserved and cannot be used. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowStrategyType?: number; /** * See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowPegPriceType?: OrderListPlaceOtocoPendingBelowPegPriceTypeEnum; /** * * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowPegOffsetType?: OrderListPlaceOtocoPendingBelowPegOffsetTypeEnum; /** * * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly pendingBelowPegOffsetValue?: number; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderListPlaceOtoco */ readonly recvWindow?: number; } /** * Request parameters for orderPlace operation in TradeApi. * @interface OrderPlaceRequest */ interface OrderPlaceRequest { /** * * @type {string} * @memberof TradeApiOrderPlace */ readonly symbol: string; /** * Please see [Enums](/products/spot/enums#side) for supported values. * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderPlace */ readonly side: OrderPlaceSideEnum; /** * Please see [Enums](/products/spot/enums#ordertypes) for supported values. * @type {'MARKET' | 'LIMIT' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderPlace */ readonly type: OrderPlaceTypeEnum; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderPlace */ readonly id?: string; /** * Please see [Enums](/products/spot/enums#timeinforce) for supported values. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderPlace */ readonly timeInForce?: OrderPlaceTimeInForceEnum; /** * * @type {number} * @memberof TradeApiOrderPlace */ readonly price?: number; /** * * @type {number} * @memberof TradeApiOrderPlace */ readonly quantity?: number; /** * * @type {number} * @memberof TradeApiOrderPlace */ readonly quoteOrderQty?: number; /** * A unique id among open orders. Automatically generated if not sent.
Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected. * @type {string} * @memberof TradeApiOrderPlace */ readonly newClientOrderId?: string; /** * `MARKET` and `LIMIT` order types default to `FULL`, all other orders default to `ACK`. * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderPlace */ readonly newOrderRespType?: OrderPlaceNewOrderRespTypeEnum; /** * Used with `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, and `TAKE_PROFIT_LIMIT` orders. * @type {number} * @memberof TradeApiOrderPlace */ readonly stopPrice?: number; /** * See Trailing Stop order FAQ * @type {number} * @memberof TradeApiOrderPlace */ readonly trailingDelta?: number; /** * Used with `LIMIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` to create an iceberg order. * @type {number} * @memberof TradeApiOrderPlace */ readonly icebergQty?: number; /** * * @type {number | bigint} * @memberof TradeApiOrderPlace */ readonly strategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiOrderPlace */ readonly strategyType?: number; /** * The allowed enums is dependent on what is configured on the symbol. * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderPlace */ readonly selfTradePreventionMode?: OrderPlaceSelfTradePreventionModeEnum; /** * See Pegged Orders Info * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderPlace */ readonly pegPriceType?: OrderPlacePegPriceTypeEnum; /** * Price level to peg the price to (max: 100). See Pegged Orders Info * @type {number} * @memberof TradeApiOrderPlace */ readonly pegOffsetValue?: number; /** * Only `PRICE_LEVEL` is supported. See Pegged Orders Info * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderPlace */ readonly pegOffsetType?: OrderPlacePegOffsetTypeEnum; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderPlace */ readonly recvWindow?: number; } /** * Request parameters for orderTest operation in TradeApi. * @interface OrderTestRequest */ interface OrderTestRequest { /** * * @type {string} * @memberof TradeApiOrderTest */ readonly symbol: string; /** * Please see [Enums](/products/spot/enums#side) for supported values. * @type {'BUY' | 'SELL'} * @memberof TradeApiOrderTest */ readonly side: OrderTestSideEnum; /** * Please see [Enums](/products/spot/enums#ordertypes) for supported values. * @type {'MARKET' | 'LIMIT' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT' | 'TAKE_PROFIT_LIMIT' | 'LIMIT_MAKER'} * @memberof TradeApiOrderTest */ readonly type: OrderTestTypeEnum; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiOrderTest */ readonly id?: string; /** * Default: `false`
See [Commissions FAQ](/products/spot/faqs/commission_faq#test-order-diferences) to learn more. * @type {boolean} * @memberof TradeApiOrderTest */ readonly computeCommissionRates?: boolean; /** * Please see [Enums](/products/spot/enums#timeinforce) for supported values. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiOrderTest */ readonly timeInForce?: OrderTestTimeInForceEnum; /** * * @type {number} * @memberof TradeApiOrderTest */ readonly price?: number; /** * * @type {number} * @memberof TradeApiOrderTest */ readonly quantity?: number; /** * * @type {number} * @memberof TradeApiOrderTest */ readonly quoteOrderQty?: number; /** * A unique id among open orders. Automatically generated if not sent. Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected. * @type {string} * @memberof TradeApiOrderTest */ readonly newClientOrderId?: string; /** * Set the response JSON. `ACK`, `RESULT`, or `FULL`; `MARKET` and `LIMIT` order types default to `FULL`, all other orders default to `ACK`. * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiOrderTest */ readonly newOrderRespType?: OrderTestNewOrderRespTypeEnum; /** * Used with `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, and `TAKE_PROFIT_LIMIT` orders. * @type {number} * @memberof TradeApiOrderTest */ readonly stopPrice?: number; /** * See [Trailing Stop order FAQ](/products/spot/faqs/trailing-stop-faq) * @type {number} * @memberof TradeApiOrderTest */ readonly trailingDelta?: number; /** * Used with `LIMIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` to create an iceberg order. * @type {number} * @memberof TradeApiOrderTest */ readonly icebergQty?: number; /** * * @type {number | bigint} * @memberof TradeApiOrderTest */ readonly strategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiOrderTest */ readonly strategyType?: number; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiOrderTest */ readonly selfTradePreventionMode?: OrderTestSelfTradePreventionModeEnum; /** * `PRIMARY_PEG` or `MARKET_PEG`. See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRIMARY_PEG' | 'MARKET_PEG'} * @memberof TradeApiOrderTest */ readonly pegPriceType?: OrderTestPegPriceTypeEnum; /** * Price level for pegging (max: 100). See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {number} * @memberof TradeApiOrderTest */ readonly pegOffsetValue?: number; /** * Only `PRICE_LEVEL` is supported. See [Pegged Orders](/products/spot/faqs/pegged_orders) * @type {'PRICE_LEVEL'} * @memberof TradeApiOrderTest */ readonly pegOffsetType?: OrderTestPegOffsetTypeEnum; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiOrderTest */ readonly recvWindow?: number; } /** * Request parameters for sorOrderPlace operation in TradeApi. * @interface SorOrderPlaceRequest */ interface SorOrderPlaceRequest { /** * * @type {string} * @memberof TradeApiSorOrderPlace */ readonly symbol: string; /** * `BUY` or `SELL` * @type {'BUY' | 'SELL'} * @memberof TradeApiSorOrderPlace */ readonly side: SorOrderPlaceSideEnum; /** * Only `LIMIT` and `MARKET` orders are supported. * @type {'MARKET' | 'LIMIT'} * @memberof TradeApiSorOrderPlace */ readonly type: SorOrderPlaceTypeEnum; /** * * @type {number} * @memberof TradeApiSorOrderPlace */ readonly quantity: number; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiSorOrderPlace */ readonly id?: string; /** * Applicable only to `LIMIT` order type. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiSorOrderPlace */ readonly timeInForce?: SorOrderPlaceTimeInForceEnum; /** * * @type {number} * @memberof TradeApiSorOrderPlace */ readonly price?: number; /** * A unique id among open orders. Automatically generated if not sent.
Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected. * @type {string} * @memberof TradeApiSorOrderPlace */ readonly newClientOrderId?: string; /** * Set the response JSON. `ACK`, `RESULT`, or `FULL`. Default to `FULL` * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiSorOrderPlace */ readonly newOrderRespType?: SorOrderPlaceNewOrderRespTypeEnum; /** * Used with `LIMIT` to create an iceberg order. * @type {number} * @memberof TradeApiSorOrderPlace */ readonly icebergQty?: number; /** * * @type {number | bigint} * @memberof TradeApiSorOrderPlace */ readonly strategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiSorOrderPlace */ readonly strategyType?: number; /** * The allowed enums is dependent on what is configured on the symbol. The possible supported values are: [STP Modes](/products/spot/enums#stpmodes). * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiSorOrderPlace */ readonly selfTradePreventionMode?: SorOrderPlaceSelfTradePreventionModeEnum; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiSorOrderPlace */ readonly recvWindow?: number; } /** * Request parameters for sorOrderTest operation in TradeApi. * @interface SorOrderTestRequest */ interface SorOrderTestRequest { /** * * @type {string} * @memberof TradeApiSorOrderTest */ readonly symbol: string; /** * Please see [Enums](/products/spot/enums#side) for supported values. * @type {'BUY' | 'SELL'} * @memberof TradeApiSorOrderTest */ readonly side: SorOrderTestSideEnum; /** * Please see [Enums](/products/spot/enums#ordertypes) for supported values. * @type {'MARKET' | 'LIMIT'} * @memberof TradeApiSorOrderTest */ readonly type: SorOrderTestTypeEnum; /** * * @type {number} * @memberof TradeApiSorOrderTest */ readonly quantity: number; /** * Client-generated request identifier. * @type {string} * @memberof TradeApiSorOrderTest */ readonly id?: string; /** * Default: `false` * @type {boolean} * @memberof TradeApiSorOrderTest */ readonly computeCommissionRates?: boolean; /** * Please see [Enums](/products/spot/enums#timeinforce) for supported values. * @type {'GTC' | 'IOC' | 'FOK'} * @memberof TradeApiSorOrderTest */ readonly timeInForce?: SorOrderTestTimeInForceEnum; /** * * @type {number} * @memberof TradeApiSorOrderTest */ readonly price?: number; /** * A unique id among open orders. Automatically generated if not sent. Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected. * @type {string} * @memberof TradeApiSorOrderTest */ readonly newClientOrderId?: string; /** * Set the response JSON. `ACK`, `RESULT`, or `FULL`. Default to `FULL`. * @type {'ACK' | 'RESULT' | 'FULL'} * @memberof TradeApiSorOrderTest */ readonly newOrderRespType?: SorOrderTestNewOrderRespTypeEnum; /** * Used with `LIMIT` to create an iceberg order. * @type {number} * @memberof TradeApiSorOrderTest */ readonly icebergQty?: number; /** * * @type {number | bigint} * @memberof TradeApiSorOrderTest */ readonly strategyId?: number | bigint; /** * The value cannot be less than `1000000`. * @type {number} * @memberof TradeApiSorOrderTest */ readonly strategyType?: number; /** * The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](/products/spot/enums#stpmodes) * @type {'NONE' | 'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'DECREMENT' | 'TRANSFER'} * @memberof TradeApiSorOrderTest */ readonly selfTradePreventionMode?: SorOrderTestSelfTradePreventionModeEnum; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof TradeApiSorOrderTest */ readonly recvWindow?: number; } /** * TradeApi - object-oriented interface * @class TradeApi * @extends {WebsocketAPIBase} */ declare class TradeApi implements TradeApiInterface { private readonly websocketBase; constructor(websocketBase: WebsocketAPIBase); /** * Cancel all open orders on a symbol. * This includes orders that are part of an order list. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Cancel open orders (TRADE) * @param {OpenOrdersCancelAllRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#open-orders-cancel-all Binance API Documentation} */ openOrdersCancelAll(requestParameters: OpenOrdersCancelAllRequest): Promise>; /** * Reduce the quantity of an existing open order. * * This adds 0 orders to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read [Order Amend Keep Priority FAQ](/products/spot/faqs/order_amend_keep_priority) to learn more. * * Weight(IP): 4 * * Unfilled Order Count: 0 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Order Amend Keep Priority (TRADE) * @param {OrderAmendKeepPriorityRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-amend-keep-priority Binance API Documentation} */ orderAmendKeepPriority(requestParameters: OrderAmendKeepPriorityRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Notes: * * If both `orderId` and `origClientOrderId` parameters are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * `newClientOrderId` will replace `clientOrderId` of the canceled order, freeing it up for new orders. * * If you cancel an order that is a part of an order list, the entire order list is canceled. * * The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel order (TRADE) * @param {OrderCancelRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-cancel Binance API Documentation} */ orderCancel(requestParameters: OrderCancelRequest): Promise>; /** * * Cancel an existing order and immediately place a new order instead of the canceled one. * A new order that was not attempted (i.e. when `newOrderResult: NOT_ATTEMPTED`), will still increase the unfilled order count by 1. * You can only cancel an individual order from an orderList using this method, but the result is the same as canceling the entire orderList.not attempted (i.e. when `newOrderResult: NOT_ATTEMPTED`), will still increase the unfilled order count by 1. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Similar to the [`order.place`](#order-place) request, * additional mandatory parameters (*) are determined by the new order `type`. * * Available `cancelReplaceMode` options: * * `STOP_ON_FAILURE` – if cancellation request fails, new order placement will not be attempted. * `ALLOW_FAILURE` – new order placement will be attempted even if the cancel request fails. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
RequestResponse
cancelReplaceModeorderRateLimitExceededModeUnfilled Order CountcancelResultnewOrderResultstatus
STOP_ON_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE➖ NOT_ATTEMPTEDN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits❌ FAILURE➖ NOT_ATTEMPTED429
✅ SUCCESS❌ FAILURE429
ALLOW_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE❌ FAILUREN/A
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILURE409
* * Notes: * * If both `cancelOrderId` and `cancelOrigClientOrderId` parameters are provided, the `cancelOrderId` is searched first, then the `cancelOrigClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * `cancelNewClientOrderId` will replace `clientOrderId` of the canceled order, freeing it up for new orders. * * `newClientOrderId` specifies `clientOrderId` value for the placed order. * * A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired. * * The new order can reuse old `clientOrderId` of the canceled order. * * This cancel-replace operation is **not transactional**. * * If one operation succeeds but the other one fails, the successful operation is still executed. * * For example, in `STOP_ON_FAILURE` mode, if the new order placement fails, the old order is still canceled. * * Filters and order count limits are evaluated before cancellation and order placement occurs. * * If new order placement is not attempted, your order count is still incremented. * * Like [`order.cancel`](#order-cancel), if you cancel an individual order from an order list, the entire order list is canceled. * * The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel and replace order (TRADE) * @param {OrderCancelReplaceRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-cancel-replace Binance API Documentation} */ orderCancelReplace(requestParameters: OrderCancelReplaceRequest): Promise>; /** * Cancel an active order list. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Notes: * * If both `orderListId` and `listClientOrderId` parameters are provided, the `orderListId` is searched first, then the `listClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * Canceling an individual order with [`order.cancel`](#order-cancel) will cancel the entire order list as well. * * @summary Cancel Order list (TRADE) * @param {OrderListCancelRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-cancel Binance API Documentation} */ orderListCancel(requestParameters: OrderListCancelRequest): Promise>; /** * Send in a new one-cancels-the-other (OCO) pair: * `LIMIT_MAKER` + `STOP_LOSS`/`STOP_LOSS_LIMIT` orders (called *legs*), * where activation of one order immediately cancels the other. * * This adds 1 order to `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Notes: * * `listClientOrderId` parameter specifies `listClientOrderId` for the OCO pair. * * A new OCO with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. * * `listClientOrderId` is distinct from `clientOrderId` of individual orders. * * `limitClientOrderId` and `stopClientOrderId` specify `clientOrderId` values for both legs of the OCO. * * A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired. * * Price restrictions on the legs: * * | `side` | Price relation | * | ------ | -------------- | * | `BUY` | `price` < market price < `stopPrice` | * | `SELL` | `price` > market price > `stopPrice` | * * Both legs have the same `quantity`. * * However, you can set different iceberg quantity for individual legs. * * If `stopIcebergQty` is used, `stopLimitTimeInForce` must be `GTC`. * * `trailingDelta` applies only to the `STOP_LOSS`/`STOP_LOSS_LIMIT` leg of the OCO. * * @summary Place new OCO - Deprecated (TRADE) * @param {OrderListPlaceRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place Binance API Documentation} */ orderListPlace(requestParameters: OrderListPlaceRequest): Promise>; /** * Send in an one-cancels-the-other (OCO) pair, where activation of one order immediately cancels the other. * * An OCO has 2 orders called the **above order** and **below order**. * * One of the orders must be a `LIMIT_MAKER/TAKE_PROFIT/TAKE_PROFIT_LIMIT` order and the other must be * `STOP_LOSS` or `STOP_LOSS_LIMIT` order. * * Price restrictions: * If the OCO is on the `SELL` side: * `LIMIT_MAKER/TAKE_PROFIT_LIMIT` `price` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT` * `stopPrice` * `TAKE_PROFIT stopPrice` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT * stopPrice` * If the OCO is on the `BUY` side: * `LIMIT_MAKER` `price` < Last Traded Price < `STOP_LOSS/STOP_LOSS_LIMIT` `stopPrice` * `TAKE_PROFIT stopPrice` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT stopPrice` * OCOs add **2 orders** to the `EXCHANGE_MAX_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Place new Order list - OCO (TRADE) * @param {OrderListPlaceOcoRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place-oco Binance API Documentation} */ orderListPlaceOco(requestParameters: OrderListPlaceOcoRequest): Promise>; /** * Place an [OPO](/products/spot/faqs/opo). * * OPOs add 2 orders to the EXCHANGE_MAX_NUM_ORDERS filter and MAX_NUM_ORDERS filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary OPO (TRADE) * @param {OrderListPlaceOpoRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place-opo Binance API Documentation} */ orderListPlaceOpo(requestParameters: OrderListPlaceOpoRequest): Promise>; /** * Place an [OPOCO](/products/spot/faqs/opo). * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary OPOCO (TRADE) * @param {OrderListPlaceOpocoRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place-opoco Binance API Documentation} */ orderListPlaceOpoco(requestParameters: OrderListPlaceOpocoRequest): Promise>; /** * Places an OTO. * * An OTO (One-Triggers-the-Other) is an order list comprised of 2 orders. * * The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the * working order goes on the order book. * * The second order is called the **pending order**. It can be any order type except for `MARKET` orders using * parameter `quoteOrderQty`. The pending order is only placed on the order book when the working order gets **fully filled**. * * If either the working order or the pending order is cancelled individually, the other order in the order list * will also be canceled or expired. * * When the order list is placed, if the working order gets **immediately fully filled**, the placement response * will show the working order as `FILLED` but the pending order will still appear as `PENDING_NEW`. You need to * query the status of the pending order again to see its updated status. * * OTOs add **2 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingType` or `workingType`** * * Depending on the `pendingType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingType` = `LIMIT` |`pendingPrice`, `pendingTimeInForce` | * |`pendingType` = `STOP_LOSS` or `TAKE_PROFIT` |`pendingStopPrice` and/or `pendingTrailingDelta`| * |`pendingType` =`STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`|`pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce`| * * @summary Place new Order list - OTO (TRADE) * @param {OrderListPlaceOtoRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place-oto Binance API Documentation} */ orderListPlaceOto(requestParameters: OrderListPlaceOtoRequest): Promise>; /** * Place an OTOCO. * * An OTOCO (One-Triggers-One-Cancels-the-Other) is an order list comprised of 3 orders. * The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. * The behavior of the working order is the same as the [OTO](#order-list-place-oto). * OTOCO has 2 pending orders (pending above and pending below), forming an OCO pair. The pending orders are only placed on the order book when the working order gets **fully filled**. * The rules of the pending above and pending below follow the same rules as the [Order list OCO](#order-list-place-oco). * OTOCOs add **3 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingAboveType`, `pendingBelowType` or `workingType`** * * Depending on the `pendingAboveType`/`pendingBelowType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingAboveType`= `LIMIT_MAKER` |`pendingAbovePrice` | * |`pendingAboveType` = `STOP_LOSS/TAKE_PROFIT` |`pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`| * |`pendingAboveType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT`|`pendingAbovePrice`, `pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`, `pendingAboveTimeInForce`| * |`pendingBelowType`= `LIMIT_MAKER` |`pendingBelowPrice` | * `pendingBelowType= STOP_LOSS/TAKE_PROFIT` |`pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`| * |`pendingBelowType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT`|`pendingBelowPrice`, `pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`, `pendingBelowTimeInForce`| * * @summary Place new Order list - OTOCO (TRADE) * @param {OrderListPlaceOtocoRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place-otoco Binance API Documentation} */ orderListPlaceOtoco(requestParameters: OrderListPlaceOtocoRequest): Promise>; /** * Send in a new order. * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Certain parameters (*) become mandatory based on the order `type`: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Order typeMandatory parameters
LIMIT *
    *
  • timeInForce
    • *
  • price
    • *
  • quantity
    • *
*
LIMIT_MAKER *
    *
  • price
    • *
  • quantity
    • *
*
MARKET *
    *
  • quantity or quoteOrderQty
    • *
*
STOP_LOSS *
    *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
STOP_LOSS_LIMIT *
    *
  • timeInForce
    • *
  • price
    • *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
TAKE_PROFIT *
    *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
TAKE_PROFIT_LIMIT *
    *
  • timeInForce
    • *
  • price
    • *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
* * Supported order types: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Order typeDescription
LIMIT *

* Buy or sell quantity at the specified price or better. *

*
LIMIT_MAKER *

* LIMIT order that will be rejected if it immediately matches and trades as a taker. *

*

* This order type is also known as a POST-ONLY order. *

*
MARKET *

* Buy or sell at the best available market price. *

*
    *
  • *

    * MARKET order with quantity parameter * specifies the amount of the base asset you want to buy or sell. * Actually executed quantity of the quote asset will be determined by available market liquidity. *

    *

    * E.g., a MARKET BUY order on BTCUSDT for "quantity": "0.1000" * specifies that you want to buy 0.1 BTC at the best available price. * If there is not enough BTC at the best price, keep buying at the next best price, * until either your order is filled, or you run out of USDT, or market runs out of BTC. *

    *
    • *
  • *

    * MARKET order with quoteOrderQty parameter * specifies the amount of the quote asset you want to spend (when buying) or receive (when selling). * Actually executed quantity of the base asset will be determined by available market liquidity. *

    *

    * E.g., a MARKET BUY on BTCUSDT for "quoteOrderQty": "100.00" * specifies that you want to buy as much BTC as you can for 100 USDT at the best available price. * Similarly, a SELL order will sell as much available BTC as needed for you to receive 100 USDT * (before commission). *

    *
    • *
*
STOP_LOSS *

* Execute a MARKET order for given quantity when specified conditions are met. *

*

* I.e., when stopPrice is reached, or when trailingDelta is activated. *

*
STOP_LOSS_LIMIT *

* Place a LIMIT order with given parameters when specified conditions are met. *

*
TAKE_PROFIT *

* Like STOP_LOSS but activates when market price moves in the favorable direction. *

*
TAKE_PROFIT_LIMIT *

* Like STOP_LOSS_LIMIT but activates when market price moves in the favorable direction. *

*
* * * Notes on using parameters for Pegged Orders: * * These parameters are allowed for `LIMIT`, `LIMIT_MAKER`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_LIMIT` orders. * If `pegPriceType` is specified, `price` becomes optional. Otherwise, it is still mandatory. * `pegPriceType=PRIMARY_PEG` means the primary peg, that is the best price on the same side of the order book as your order. * `pegPriceType=MARKET_PEG` means the market peg, that is the best price on the opposite side of the order book from your order. * Use `pegOffsetType` and `pegOffsetValue` to request a price level other than the best one. These parameters must be specified together. * * * * Available `timeInForce` options, * setting how long the order should be active before expiration: * * TIF | Description * ----- | -------------- * `GTC` | **Good 'til Canceled** – the order will remain on the book until you cancel it, or the order is completely filled. * `IOC` | **Immediate or Cancel** – the order will be filled for as much as possible, the unfilled quantity immediately expires. * `FOK` | **Fill or Kill** – the order will expire unless it cannot be immediately filled for the entire quantity. * * Notes: * * `newClientOrderId` specifies `clientOrderId` value for the order. * * A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired. * * Any `LIMIT` or `LIMIT_MAKER` order can be made into an iceberg order by specifying the `icebergQty`. * * An order with an `icebergQty` must have `timeInForce` set to `GTC`. * * Trigger order price rules for `STOP_LOSS`/`TAKE_PROFIT` orders: * * `stopPrice` must be above market price: `STOP_LOSS BUY`, `TAKE_PROFIT SELL` * `stopPrice` must be below market price: `STOP_LOSS SELL`, `TAKE_PROFIT BUY` * * `MARKET` orders using `quoteOrderQty` follow [`LOT_SIZE`](/products/spot/filters#lot_size) filter rules. * * The order will execute a quantity that has notional value as close as possible to requested `quoteOrderQty`. * * @summary Place new order (TRADE) * @param {OrderPlaceRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-place Binance API Documentation} */ orderPlace(requestParameters: OrderPlaceRequest): Promise>; /** * Test order placement. * * Validates new order parameters and verifies your signature * but does not send the order into the matching engine. * * Weight: | Condition | Request Weight | * | --- | --- | * | Without `computeCommissionRates` | 1 | * | With `computeCommissionRates` | 20 | * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order (TRADE) * @param {OrderTestRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-test Binance API Documentation} */ orderTest(requestParameters: OrderTestRequest): Promise>; /** * Places an order using smart order routing (SOR). * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read [SOR FAQ](/products/spot/faqs/sor_faq) to learn more. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Note:** `sor.order.place` only supports `LIMIT` and `MARKET` orders. `quoteOrderQty` is not supported. * * @summary Place new order using SOR (TRADE) * @param {SorOrderPlaceRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#sor-order-place Binance API Documentation} */ sorOrderPlace(requestParameters: SorOrderPlaceRequest): Promise>; /** * Test new order creation and signature/recvWindow using smart order routing (SOR). * Creates and validates a new order but does not send it into the matching engine. * * Weight: | Condition | Request Weight | * | --- | --- | * | Without `computeCommissionRates` | 1 | * | With `computeCommissionRates` | 20 | * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order using SOR (TRADE) * @param {SorOrderTestRequest} requestParameters Request parameters. * @returns {Promise} * @memberof TradeApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#sor-order-test Binance API Documentation} */ sorOrderTest(requestParameters: SorOrderTestRequest): Promise>; } declare enum OrderCancelCancelRestrictionsEnum { ONLY_NEW = "ONLY_NEW", ONLY_PARTIALLY_FILLED = "ONLY_PARTIALLY_FILLED", } declare enum OrderCancelReplaceCancelReplaceModeEnum { STOP_ON_FAILURE = "STOP_ON_FAILURE", ALLOW_FAILURE = "ALLOW_FAILURE", } declare enum OrderCancelReplaceSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderCancelReplaceTypeEnum { MARKET = "MARKET", LIMIT = "LIMIT", STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderCancelReplaceTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderCancelReplaceNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderCancelReplaceSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderCancelReplaceCancelRestrictionsEnum { ONLY_NEW = "ONLY_NEW", ONLY_PARTIALLY_FILLED = "ONLY_PARTIALLY_FILLED", } declare enum OrderCancelReplaceOrderRateLimitExceededModeEnum { DO_NOTHING = "DO_NOTHING", CANCEL_ONLY = "CANCEL_ONLY", } declare enum OrderCancelReplacePegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderCancelReplacePegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListPlaceStopLimitTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListPlaceSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListPlaceOcoSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListPlaceOcoAboveTypeEnum { STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", STOP_LOSS = "STOP_LOSS", LIMIT_MAKER = "LIMIT_MAKER", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListPlaceOcoBelowTypeEnum { STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListPlaceOcoAboveTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOcoAbovePegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOcoAbovePegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOcoBelowTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOcoBelowPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOcoBelowPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOcoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListPlaceOcoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListPlaceOpoWorkingTypeEnum { LIMIT = "LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListPlaceOpoWorkingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListPlaceOpoPendingTypeEnum { LIMIT = "LIMIT", MARKET = "MARKET", STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListPlaceOpoPendingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListPlaceOpoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListPlaceOpoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListPlaceOpoWorkingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOpoWorkingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOpoWorkingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOpoPendingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOpoPendingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOpoPendingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOpocoWorkingTypeEnum { LIMIT = "LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListPlaceOpocoWorkingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListPlaceOpocoPendingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListPlaceOpocoPendingAboveTypeEnum { STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", STOP_LOSS = "STOP_LOSS", LIMIT_MAKER = "LIMIT_MAKER", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListPlaceOpocoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListPlaceOpocoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListPlaceOpocoWorkingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOpocoWorkingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOpocoWorkingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOpocoPendingAboveTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOpocoPendingAbovePegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOpocoPendingAbovePegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOpocoPendingBelowTypeEnum { STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListPlaceOpocoPendingBelowTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOpocoPendingBelowPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOpocoPendingBelowPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOtoWorkingTypeEnum { LIMIT = "LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListPlaceOtoWorkingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListPlaceOtoPendingTypeEnum { LIMIT = "LIMIT", MARKET = "MARKET", STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListPlaceOtoPendingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListPlaceOtoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListPlaceOtoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListPlaceOtoWorkingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOtoWorkingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOtoWorkingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOtoPendingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOtoPendingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOtoPendingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOtocoWorkingTypeEnum { LIMIT = "LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderListPlaceOtocoWorkingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListPlaceOtocoPendingSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderListPlaceOtocoPendingAboveTypeEnum { STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", STOP_LOSS = "STOP_LOSS", LIMIT_MAKER = "LIMIT_MAKER", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListPlaceOtocoNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderListPlaceOtocoSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderListPlaceOtocoWorkingTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOtocoWorkingPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOtocoWorkingPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOtocoPendingAboveTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOtocoPendingAbovePegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOtocoPendingAbovePegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderListPlaceOtocoPendingBelowTypeEnum { STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", } declare enum OrderListPlaceOtocoPendingBelowTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderListPlaceOtocoPendingBelowPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderListPlaceOtocoPendingBelowPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderPlaceSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderPlaceTypeEnum { MARKET = "MARKET", LIMIT = "LIMIT", STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderPlaceTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderPlaceNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderPlaceSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderPlacePegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderPlacePegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum OrderTestSideEnum { BUY = "BUY", SELL = "SELL", } declare enum OrderTestTypeEnum { MARKET = "MARKET", LIMIT = "LIMIT", STOP_LOSS = "STOP_LOSS", STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT", TAKE_PROFIT = "TAKE_PROFIT", TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT", LIMIT_MAKER = "LIMIT_MAKER", } declare enum OrderTestTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum OrderTestNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum OrderTestSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum OrderTestPegPriceTypeEnum { PRIMARY_PEG = "PRIMARY_PEG", MARKET_PEG = "MARKET_PEG", } declare enum OrderTestPegOffsetTypeEnum { PRICE_LEVEL = "PRICE_LEVEL", } declare enum SorOrderPlaceSideEnum { BUY = "BUY", SELL = "SELL", } declare enum SorOrderPlaceTypeEnum { MARKET = "MARKET", LIMIT = "LIMIT", } declare enum SorOrderPlaceTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum SorOrderPlaceNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum SorOrderPlaceSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } declare enum SorOrderTestSideEnum { BUY = "BUY", SELL = "SELL", } declare enum SorOrderTestTypeEnum { MARKET = "MARKET", LIMIT = "LIMIT", } declare enum SorOrderTestTimeInForceEnum { GTC = "GTC", IOC = "IOC", FOK = "FOK", } declare enum SorOrderTestNewOrderRespTypeEnum { ACK = "ACK", RESULT = "RESULT", FULL = "FULL", } declare enum SorOrderTestSelfTradePreventionModeEnum { NONE = "NONE", EXPIRE_TAKER = "EXPIRE_TAKER", EXPIRE_MAKER = "EXPIRE_MAKER", EXPIRE_BOTH = "EXPIRE_BOTH", DECREMENT = "DECREMENT", TRANSFER = "TRANSFER", } //#endregion //#region src/websocket-api/modules/user-data-stream-api.d.ts /** * UserDataStreamApi - interface * * @interface UserDataStreamApi */ interface UserDataStreamApiInterface { /** * **Note:** * * Users should track the corresponding subscription status of related accounts as needed. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Listing all subscriptions * @param {SessionSubscriptionsRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof UserDataStreamApiInterface */ sessionSubscriptions(requestParameters?: SessionSubscriptionsRequest): Promise>; /** * Subscribe to the User Data Stream in the current WebSocket connection. * **Notes:** * - This method requires an authenticated WebSocket connection using Ed25519 keys. Please refer to [`session.logon`](/catalog/core-trading-spot-trading/api/ws-api/auth#session-logon). * - To check the subscription status, use [`session.status`](/catalog/core-trading-spot-trading/api/ws-api/auth#session-status), see the `userDataStream` flag indicating you have have an active subscription. * - User Data Stream events are available in both JSON and [SBE](/products/spot/faqs/sbe_faq) sessions. * - Please refer to [User Data Streams](/products/spot/user-data-stream) for the event format details. * - For SBE, only SBE schema 2:1 or later is supported. * * Weight(IP): 2 * * Security Type: NONE * * @summary Subscribe to User Data Stream * @param {UserDataStreamSubscribeRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof UserDataStreamApiInterface */ userDataStreamSubscribe(requestParameters?: UserDataStreamSubscribeRequest): Promise>; /** * Weight(IP): 2 * * Security Type: USER_STREAM * * Notes: **Data Source:** Memory * * @summary Subscribe to User Data Stream through signature subscription (USER_STREAM) * @param {UserDataStreamSubscribeSignatureRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof UserDataStreamApiInterface */ userDataStreamSubscribeSignature(requestParameters?: UserDataStreamSubscribeSignatureRequest): Promise>; /** * Stop listening to the User Data Stream in the current WebSocket * connection. * * Note that `session.logout` will only close the subscription created with `userDataStream.subscribe` but not subscriptions opened with `userDataStream.subscribe.signature`. * * Weight(IP): 2 * * @summary WebSocket Unsubscribe from User Data Stream * @param {UserDataStreamUnsubscribeRequest} requestParameters Request parameters. * * @returns {Promise} * @memberof UserDataStreamApiInterface */ userDataStreamUnsubscribe(requestParameters?: UserDataStreamUnsubscribeRequest): Promise>; } /** * Request parameters for sessionSubscriptions operation in UserDataStreamApi. * @interface SessionSubscriptionsRequest */ interface SessionSubscriptionsRequest { /** * Client-generated request identifier. * @type {string} * @memberof UserDataStreamApiSessionSubscriptions */ readonly id?: string; } /** * Request parameters for userDataStreamSubscribe operation in UserDataStreamApi. * @interface UserDataStreamSubscribeRequest */ interface UserDataStreamSubscribeRequest { /** * Client-generated request identifier. * @type {string} * @memberof UserDataStreamApiUserDataStreamSubscribe */ readonly id?: string; } /** * Request parameters for userDataStreamSubscribeSignature operation in UserDataStreamApi. * @interface UserDataStreamSubscribeSignatureRequest */ interface UserDataStreamSubscribeSignatureRequest { /** * Client-generated request identifier. * @type {string} * @memberof UserDataStreamApiUserDataStreamSubscribeSignature */ readonly id?: string; /** * Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified. * @type {number} * @memberof UserDataStreamApiUserDataStreamSubscribeSignature */ readonly recvWindow?: number; } /** * Request parameters for userDataStreamUnsubscribe operation in UserDataStreamApi. * @interface UserDataStreamUnsubscribeRequest */ interface UserDataStreamUnsubscribeRequest { /** * Client-generated request identifier. * @type {string} * @memberof UserDataStreamApiUserDataStreamUnsubscribe */ readonly id?: string; /** * When called with no parameter, this will close all subscriptions. When called with the subscriptionId parameter, this will attempt to close the subscription with that subscription id, if it exists. * @type {number} * @memberof UserDataStreamApiUserDataStreamUnsubscribe */ readonly subscriptionId?: number; } /** * UserDataStreamApi - object-oriented interface * @class UserDataStreamApi * @extends {WebsocketAPIBase} */ declare class UserDataStreamApi implements UserDataStreamApiInterface { private readonly websocketBase; constructor(websocketBase: WebsocketAPIBase); /** * **Note:** * * Users should track the corresponding subscription status of related accounts as needed. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Listing all subscriptions * @param {SessionSubscriptionsRequest} requestParameters Request parameters. * @returns {Promise} * @memberof UserDataStreamApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/user-data-stream#session-subscriptions Binance API Documentation} */ sessionSubscriptions(requestParameters?: SessionSubscriptionsRequest): Promise>; /** * Subscribe to the User Data Stream in the current WebSocket connection. * **Notes:** * - This method requires an authenticated WebSocket connection using Ed25519 keys. Please refer to [`session.logon`](/catalog/core-trading-spot-trading/api/ws-api/auth#session-logon). * - To check the subscription status, use [`session.status`](/catalog/core-trading-spot-trading/api/ws-api/auth#session-status), see the `userDataStream` flag indicating you have have an active subscription. * - User Data Stream events are available in both JSON and [SBE](/products/spot/faqs/sbe_faq) sessions. * - Please refer to [User Data Streams](/products/spot/user-data-stream) for the event format details. * - For SBE, only SBE schema 2:1 or later is supported. * * Weight(IP): 2 * * Security Type: NONE * * @summary Subscribe to User Data Stream * @param {UserDataStreamSubscribeRequest} requestParameters Request parameters. * @returns {Promise} * @memberof UserDataStreamApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/user-data-stream#user-data-stream-subscribe Binance API Documentation} */ userDataStreamSubscribe(requestParameters?: UserDataStreamSubscribeRequest): Promise>; /** * Weight(IP): 2 * * Security Type: USER_STREAM * * Notes: **Data Source:** Memory * * @summary Subscribe to User Data Stream through signature subscription (USER_STREAM) * @param {UserDataStreamSubscribeSignatureRequest} requestParameters Request parameters. * @returns {Promise} * @memberof UserDataStreamApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/user-data-stream#user-data-stream-subscribe-signature Binance API Documentation} */ userDataStreamSubscribeSignature(requestParameters?: UserDataStreamSubscribeSignatureRequest): Promise>; /** * Stop listening to the User Data Stream in the current WebSocket * connection. * * Note that `session.logout` will only close the subscription created with `userDataStream.subscribe` but not subscriptions opened with `userDataStream.subscribe.signature`. * * Weight(IP): 2 * * @summary WebSocket Unsubscribe from User Data Stream * @param {UserDataStreamUnsubscribeRequest} requestParameters Request parameters. * @returns {Promise} * @memberof UserDataStreamApi * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/user-data-stream#user-data-stream-unsubscribe Binance API Documentation} */ userDataStreamUnsubscribe(requestParameters?: UserDataStreamUnsubscribeRequest): Promise>; } //#endregion //#region src/websocket-api/websocket-api-connection.d.ts declare class WebsocketAPIConnection { private websocketBase; private accountApi; private authApi; private generalApi; private marketApi; private tradeApi; private userDataStreamApi; constructor(websocketBase: WebsocketAPIBase); on(event: 'open' | 'message' | 'error' | 'close' | 'ping' | 'pong', listener: (...args: any[]) => void): void; off(event: 'open' | 'message' | 'error' | 'close' | 'ping' | 'pong', listener: (...args: any[]) => void): void; /** * Disconnects from the WebSocket server. * If there is no active connection, a warning is logged. * Otherwise, all connections in the connection pool are closed gracefully, * and a message is logged indicating that the connection has been disconnected. * @returns A Promise that resolves when all connections have been closed. * @throws Error if the WebSocket client is not set. */ disconnect(): Promise; /** * Checks if the WebSocket connection is currently open. * @returns `true` if the connection is open, `false` otherwise. */ isConnected(): boolean; /** * Sends a ping message to all connected Websocket servers in the pool. * If no connections are ready, a warning is logged. * For each active connection, the ping message is sent, and debug logs provide details. * @throws Error if a Websocket client is not set for a connection. */ pingServer(): void; /** * Sends an unsigned message to the WebSocket server * @param method The API method to call * @param payload Message parameters and options * @returns Promise that resolves with the server response * @throws Error if not connected */ sendMessage(method: string, payload?: WebsocketSendMsgOptions): Promise>; /** * Sends a signed message to the WebSocket server with authentication * @param method The API method to call * @param payload Message parameters and options * @returns Promise that resolves with the server response * @throws Error if not connected */ sendSignedMessage(method: string, payload?: WebsocketSendMsgOptions): Promise>; /** * Get current account commission rates. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Account Commission Rates (USER_DATA) * @param {AccountCommissionRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#account-commission Binance API Documentation} */ accountCommission(requestParameters: AccountCommissionRequest): Promise>; /** * Query your current unfilled order count for all intervals. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Unfilled Order Count (USER_DATA) * @param {AccountRateLimitsOrdersRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#account-rate-limits-orders Binance API Documentation} */ accountRateLimitsOrders(requestParameters?: AccountRateLimitsOrdersRequest): Promise>; /** * Query information about your account. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * @summary Account information (USER_DATA) * @param {AccountStatusRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#account-status Binance API Documentation} */ accountStatus(requestParameters?: AccountStatusRequest): Promise>; /** * Query information about all your order lists, filtered by time range. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Notes: * If `startTime` and/or `endTime` are specified, `fromId` is ignored. * Order lists are filtered by `transactionTime` of the last order list execution status update. * If `fromId` is specified, return order lists with order list ID >= `fromId`. * If no condition is specified, the most recent order lists are returned. * The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account order list history (USER_DATA) * @param {AllOrderListsRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#all-order-lists Binance API Documentation} */ allOrderLists(requestParameters?: AllOrderListsRequest): Promise>; /** * Query information about all your orders – active, canceled, filled – filtered by time range. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Notes: * * If `startTime` and/or `endTime` are specified, `orderId` is ignored. * * Orders are filtered by `time` of the last execution status update. * * If `orderId` is specified, return orders with order ID >= `orderId`. * * If no condition is specified, the most recent orders are returned. * * For some historical orders the `cummulativeQuoteQty` response field may be negative, * meaning the data is not available at this time. * * The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account order history (USER_DATA) * @param {AllOrdersRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#all-orders Binance API Documentation} */ allOrders(requestParameters: AllOrdersRequest): Promise>; /** * Retrieves allocations resulting from SOR order placement. * * Weight(IP): 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Supported parameter combinations: * * Parameters | Response | * ------------------------------------------- | -------- | * `symbol` | allocations from oldest to newest | * `symbol` + `startTime` | oldest allocations since `startTime` | * `symbol` + `endTime` | newest allocations until `endTime` | * `symbol` + `startTime` + `endTime` | allocations within the time range | * `symbol` + `fromAllocationId` | allocations by allocation ID | * `symbol` + `orderId` | allocations related to an order starting with oldest | * `symbol` + `orderId` + `fromAllocationId` | allocations related to an order by allocation ID | * **Note:** The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account allocations (USER_DATA) * @param {MyAllocationsRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#my-allocations Binance API Documentation} */ myAllocations(requestParameters: MyAllocationsRequest): Promise>; /** * Retrieves the list of [filters](/products/spot/filters) relevant to an account on a given symbol. This is the only method * that shows if an account has [`MAX_ASSET`](/products/spot/filters#max_asset) filters applied to it. * * Weight(IP): 40 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Query Relevant Filters (USER_DATA) * @param {MyFiltersRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#my-filters Binance API Documentation} */ myFilters(requestParameters: MyFiltersRequest): Promise>; /** * Displays the list of orders that were expired due to STP. * * These are the combinations supported: * * `symbol` + `preventedMatchId` * `symbol` + `orderId` * `symbol` + `orderId` + `fromPreventedMatchId` (`limit` will default to 500) * `symbol` + `orderId` + `fromPreventedMatchId` + `limit` * * Weight: Case | Weight * ---- | ----- * If `symbol` is invalid | 2 * Querying by `preventedMatchId` | 2 * Querying by `orderId` | 20 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Account prevented matches (USER_DATA) * @param {MyPreventedMatchesRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#my-prevented-matches Binance API Documentation} */ myPreventedMatches(requestParameters: MyPreventedMatchesRequest): Promise>; /** * Query information about all your trades, filtered by time range. * * Weight: Condition| Weight| * ---| --- * |Without orderId|20| * |With orderId|5| * * Security Type: USER_DATA * * Notes: * Data Source: Memory => Database * * Notes: * - If `fromId` is specified, return trades with trade ID >= `fromId`. * - If `startTime` and/or `endTime` are specified, trades are filtered by execution time (`time`). * - `fromId` cannot be used together with `startTime` and `endTime`. * - If `orderId` is specified, only trades related to that order are returned. * - `startTime` and `endTime` cannot be used together with `orderId`. * - If no condition is specified, the most recent trades are returned. * - The time between `startTime` and `endTime` can't be longer than 24 hours. * * @summary Account trade history (USER_DATA) * @param {MyTradesRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#my-trades Binance API Documentation} */ myTrades(requestParameters: MyTradesRequest): Promise>; /** * Query execution status of all open order lists. * * If you need to continuously monitor order status updates, please consider using WebSocket Streams: * * `userDataStream.subscribe` if on an authenticated session * `userDataStream.subscribe.signature` if subscribing through signature subscription * * Weight(IP): 6 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory -> Database * * @summary Current open Order lists (USER_DATA) * @param {OpenOrderListsStatusRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#open-order-lists-status Binance API Documentation} */ openOrderListsStatus(requestParameters?: OpenOrderListsStatusRequest): Promise>; /** * Query execution status of all open orders. * * If you need to continuously monitor order status updates, please consider using WebSocket Streams: * * `userDataStream.subscribe` if on an authenticated session * `userDataStream.subscribe.signature` if subscribing through signature subscription * * Weight: | Parameter | Weight | * | --------- | ------ | * | `symbol` | 6 | * | none | 80 | * * Security Type: USER_DATA * * Notes: * Data Source: Memory => Database * * @summary Current open orders (USER_DATA) * @param {OpenOrdersStatusRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#open-orders-status Binance API Documentation} */ openOrdersStatus(requestParameters?: OpenOrdersStatusRequest): Promise>; /** * Queries all amendments of a single order. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * @summary Query Order Amendments (USER_DATA) * @param {OrderAmendmentsRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#order-amendments Binance API Documentation} */ orderAmendments(requestParameters: OrderAmendmentsRequest): Promise>; /** * Check execution status of an Order list. * * For execution status of individual orders, use `order.status`. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Database * * Notes: * * `origClientOrderId` refers to `listClientOrderId` of the order list itself. * * If both `origClientOrderId` and `orderListId` parameters are specified, * only `origClientOrderId` is used and `orderListId` is ignored. * * @summary Query Order list (USER_DATA) * @param {OrderListStatusRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#order-list-status Binance API Documentation} */ orderListStatus(requestParameters?: OrderListStatusRequest): Promise>; /** * Check execution status of an order. * * Weight(IP): 4 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory => Database * * Notes: * * If both `orderId` and `origClientOrderId` are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * For some historical orders the `cummulativeQuoteQty` response field may be negative, * meaning the data is not available at this time. * * @summary Query order (USER_DATA) * @param {OrderStatusRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/account#order-status Binance API Documentation} */ orderStatus(requestParameters: OrderStatusRequest): Promise>; /** * Authenticate WebSocket connection using the provided API key. * * After calling `session.logon`, you can omit `apiKey` and `signature` parameters for future requests that require them. * * Note that only one API key can be authenticated. * * Calling `session.logon` multiple times changes the current authenticated API key. * **Note:** Only Ed25519 keys are supported for this feature. * * Weight(IP): 2 * * Security Type: USER_DATA * * Notes: **Data Source:** Memory * * @summary Log in with API key (USER_DATA) * @param {SessionLogonRequest} requestParameters Request parameters. * * @returns Promise[]> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/auth#session-logon Binance API Documentation} */ sessionLogon(requestParameters?: SessionLogonRequest): Promise[]>; /** * Forget the API key previously authenticated. If the connection is not authenticated, this request does nothing. * * Note that the WebSocket connection stays open after `session.logout` request. You can continue using the connection, but now you will have to explicitly provide the `apiKey` and `signature` parameters where needed. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Log out of the session * @param {SessionLogoutRequest} requestParameters Request parameters. * * @returns Promise[]> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/auth#session-logout Binance API Documentation} */ sessionLogout(requestParameters?: SessionLogoutRequest): Promise[]>; /** * Query the status of the WebSocket connection, * inspecting which API key (if any) is used to authorize requests. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query session status * @param {SessionStatusRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/auth#session-status Binance API Documentation} */ sessionStatus(requestParameters?: SessionStatusRequest): Promise>; /** * Query current exchange trading rules, rate limits, and symbol * information. * * Weight(IP): 20 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Notes:** * If the value provided to `symbol` or `symbols` do not exist, the endpoint will throw an error saying the symbol is invalid. * All parameters are optional. * Only one of `symbol`, `symbols`, `permissions` parameters can be specified. * Without parameters, `exchangeInfo` displays all symbols with `["SPOT", "MARGIN", "LEVERAGED"]` permissions. * In order to list *all* active symbols on the exchange, you need to explicitly request all permissions. * `permissions` accepts either a list of permissions, or a single permission name. E.g. `"SPOT"`. * **Examples of Symbol Permissions Interpretation from the Response:** * * `[["A","B"]]` means you may place an order if your account has either permission "A" **or** permission "B". * `[["A"],["B"]]` means you can place an order if your account has permission "A" **and** permission "B". * `[["A"],["B","C"]]` means you can place an order if your account has permission "A" **and** permission "B" or permission "C". (Inclusive or is applied here, not exclusive or, so your account may have both permission "B" and permission "C".) * * @summary Exchange information * @param {ExchangeInfoRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/general#exchange-info Binance API Documentation} */ exchangeInfo(requestParameters?: ExchangeInfoRequest): Promise>; /** * Query execution rules for symbols. * * Weight: Parameter | Weight * --- | --- * `symbol` | 2 * `symbols` | 2 for each `symbol`, capped at a max of 40 * `symbolStatus` | 40 * None | 40 * * Security Type: NONE * * Notes: **Data Source:** Memory * **Note:** No combination of multiple parameters is allowed. * * @summary Query Execution Rules * @param {ExecutionRulesRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/general#execution-rules Binance API Documentation} */ executionRules(requestParameters?: ExecutionRulesRequest): Promise>; /** * Test connectivity to the WebSocket API. * * Note: You can use regular WebSocket ping frames to test connectivity as well, WebSocket API will respond with pong frames as soon as possible. ping request along with time is a safe way to test request-response handling in your application. * * Weight(IP): 1 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Test connectivity * @param {PingRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/general#ping Binance API Documentation} */ ping(requestParameters?: PingRequest): Promise>; /** * Test connectivity to the WebSocket API and get the current server time. * * Weight(IP): 1 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Check server time * @param {TimeRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/general#time Binance API Documentation} */ time(requestParameters?: TimeRequest): Promise>; /** * Get current average price for a symbol. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Current average price * @param {AvgPriceRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#avg-price Binance API Documentation} */ avgPrice(requestParameters: AvgPriceRequest$1): Promise>; /** * Get block trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: * - Data Source: Database * * @summary Historical Block Trades * @param {BlockTradesHistoricalRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#block-trades-historical Binance API Documentation} */ blockTradesHistorical(requestParameters: BlockTradesHistoricalRequest): Promise>; /** * Get current order book. * * Note that this request returns limited market depth. * * If you need to continuously monitor order book updates, please consider using WebSocket Streams: * `@depth` * `@depth` * * You can use `depth` request together with `@depth` streams to [maintain a local order book](/products/spot/web-socket-streams#how-to-manage-a-local-order-book-correctly). * * Weight: Adjusted based on the limit: * * |Limit|Request Weight * ------|------- * 1-100| 5 * 101-500| 25 * 501-1000| 50 * 1001-5000| 250 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Order book * @param {DepthRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#depth Binance API Documentation} */ depth(requestParameters: DepthRequest): Promise>; /** * Get klines (candlestick bars). * * Klines are uniquely identified by their open & close time. * * If you need access to real-time kline updates, please consider using WebSocket Streams: * `@kline_` * * If you need historical kline data, please consider using [data.binance.vision](https://github.com/binance/binance-public-data/#klines). * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * Supported kline intervals (case-sensitive): * * Interval | `interval` value * --------- | ---------------- * seconds | `1s` * minutes | `1m`, `3m`, `5m`, `15m`, `30m` * hours | `1h`, `2h`, `4h`, `6h`, `8h`, `12h` * days | `1d`, `3d` * weeks | `1w` * months | `1M` * **Notes:** * * If `startTime` and `endTime` are not sent, the most recent klines are returned. * Supported values for `timeZone`: * Hours and minutes (e.g. `-1:00`, `05:45`) * Only hours (e.g. `0`, `8`, `4`) * Accepted range is strictly [-12:00 to +14:00] inclusive * If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary Klines * @param {KlinesRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#klines Binance API Documentation} */ klines(requestParameters: KlinesRequest): Promise>; /** * Query Reference Price * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price * @param {ReferencePriceRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#reference-price Binance API Documentation} */ referencePrice(requestParameters: ReferencePriceRequest$1): Promise>; /** * Query Reference Price Calculation * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Query Reference Price Calculation * @param {ReferencePriceCalculationRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#reference-price-calculation Binance API Documentation} */ referencePriceCalculation(requestParameters: ReferencePriceCalculationRequest): Promise>; /** * Get rolling window price change statistics with a custom window. * * This request is similar to `ticker.24hr` but statistics are computed on demand using the arbitrary window you specify. * **Note:** Window size precision is limited to 1 minute. * While the `closeTime` is the current time of the request, `openTime` always start on a minute boundary. * As such, the effective window might be up to 59999 ms wider than the requested `windowSize`. * *
* Window computation example * * For example, a request for `"windowSize": "7d"` might result in the following window: * * ```javascript * { * "openTime": 1659580020000, * "closeTime": 1660184865291 * } * ``` * * Time of the request – `closeTime` – is 1660184865291 (August 11, 2022 02:27:45.291). * Requested window size should put the `openTime` 7 days before that – August 4, 02:27:45.291 – * but due to limited precision it ends up a bit earlier: 1659580020000 (August 4, 2022 02:27:00), * exactly at the start of a minute. *
* * If you need to continuously monitor trading statistics, please consider using WebSocket Streams: * `@ticker_` or `!ticker_@arr` * * Weight: Adjusted based on the number of requested symbols: * * | Symbols | Weight | * |:-------:|:------:| * | 1–50 | 4 per symbol | * | 51–100 | 200 | * * Security Type: NONE * * Notes: **Data Source:** Database * * Supported window sizes: * * Unit | `windowSize` value * ------- | ------------------ * minutes | `1m`, `2m` ... `59m` * hours | `1h`, `2h` ... `23h` * days | `1d`, `2d` ... `7d` * * Notes: * * Either `symbol` or `symbols` must be specified. * * Maximum number of symbols in one request: 200. * * Window size units cannot be combined. * E.g., 1d 2h is not supported. * * @summary Rolling window price change statistics * @param {TickerRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ticker Binance API Documentation} */ ticker(requestParameters?: TickerRequest$1): Promise>; /** * Get 24-hour rolling window price change statistics. * * If you need to continuously monitor trading statistics, please consider using WebSocket Streams: * * `@ticker` or `!ticker@arr` * * `@miniTicker` or `!miniTicker@arr` * * If you need different window sizes, * * use the `ticker` request. * * Weight: Adjusted based on the number of requested symbols: * * |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 80| * |symbols| 1-20 |2| * | | 21-100 |40| * | | 101+ |80| * | |omitted| 80| * * Security Type: NONE * * Notes: **Data Source:** Memory * * Notes: * * `symbol` and `symbols` cannot be used together. * * If no symbol is specified, returns information about all symbols currently trading on the exchange. * * @summary 24hr ticker price change statistics * @param {Ticker24hrRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ticker24hr Binance API Documentation} */ ticker24hr(requestParameters?: Ticker24hrRequest): Promise>; /** * Get the current best price and quantity on the order book. * * If you need access to real-time order book ticker updates, please * consider using WebSocket Streams: * * `@bookTicker` * * Weight: Adjusted based on the number of requested symbols: * * |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * Notes: * * `symbol` and `symbols` cannot be used together. * * If no symbol is specified, returns information about all symbols currently trading on the exchange. * * @summary Symbol order book ticker * @param {TickerBookRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ticker-book Binance API Documentation} */ tickerBook(requestParameters?: TickerBookRequest): Promise>; /** * Get the latest market price for a symbol. * * If you need access to real-time price updates, please consider using * WebSocket Streams: * * `@aggTrade` * * `@trade` * * Weight: Adjusted based on the number of requested symbols: * * |Parameter|Symbols Provided|Weight| * |---|---|---| * |symbol| 1 |2| * | |omitted| 4| * |symbols| Any |4| * * Security Type: NONE * * Notes: **Data Source:** Memory * * Notes: * * `symbol` and `symbols` cannot be used together. * * If no symbol is specified, returns information about all symbols currently trading on the exchange. * * @summary Symbol price ticker * @param {TickerPriceRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ticker-price Binance API Documentation} */ tickerPrice(requestParameters?: TickerPriceRequest): Promise>; /** * Price change statistics for a trading day. * * Weight: 4 for each requested symbol regardless of windowSize. The weight for this request will cap at 200 once the number of symbols in the request is more than 50. * * Security Type: NONE * * Notes: **Data Source:** Database * **Notes:** * * Supported values for `timeZone`: * Hours and minutes (e.g. `-1:00`, `05:45`) * Only hours (e.g. `0`, `8`, `4`) * * * @summary Trading Day Ticker * @param {TickerTradingDayRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ticker-trading-day Binance API Documentation} */ tickerTradingDay(requestParameters?: TickerTradingDayRequest): Promise>; /** * Get aggregate trades. * * An *aggregate trade* (aggtrade) represents one or more individual * trades. * * Trades that fill at the same time, from the same taker order, with the * same price – * * those trades are collected into an aggregate trade with total quantity * of the individual trades. * * If you need access to real-time trading activity, please consider using * WebSocket Streams: * * `@aggTrade` * * If you need historical aggregate trade data, please consider using [data.binance.vision](https://github.com/binance/binance-public-data/#aggtrades). * * Weight(IP): 4 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If `fromId` is specified, return aggtrades with aggregate trade ID >= `fromId`. Use `fromId` and `limit` to page through all aggtrades. * - If `startTime` and/or `endTime` are specified, aggtrades are filtered by execution time (`T`). `fromId` cannot be used together with `startTime` and `endTime`. * - If no condition is specified, the most recent aggregate trades are returned. * * @summary Aggregate trades * @param {TradesAggregateRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#trades-aggregate Binance API Documentation} */ tradesAggregate(requestParameters: TradesAggregateRequest): Promise>; /** * Get historical trades. * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Database * * Notes: * * If `fromId` is not specified, the most recent trades are returned. * * @summary Historical trades * @param {TradesHistoricalRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#trades-historical Binance API Documentation} */ tradesHistorical(requestParameters: TradesHistoricalRequest): Promise>; /** * Get recent trades. * * If you need access to real-time trading activity, please consider using * WebSocket Streams: * * `@trade` * * Weight(IP): 25 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Recent trades * @param {TradesRecentRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#trades-recent Binance API Documentation} */ tradesRecent(requestParameters: TradesRecentRequest): Promise>; /** * Get klines (candlestick bars) optimized for presentation. * * This request is similar to `klines`, having the same parameters and response. `uiKlines` return modified kline data, optimized for presentation of candlestick charts. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Database * * - If `startTime` and `endTime` are not sent, the most recent klines are returned. * - Supported values for `timeZone`: * - Hours and minutes (e.g. `-1:00`, `05:45`) * - Only hours (e.g. `0`, `8`, `4`) * - Accepted range is strictly [-12:00 to +14:00] inclusive * - If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC. * - Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`. * * @summary UI Klines * @param {UiKlinesRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/market#ui-klines Binance API Documentation} */ uiKlines(requestParameters: UiKlinesRequest): Promise>; /** * Cancel all open orders on a symbol. * This includes orders that are part of an order list. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Cancel open orders (TRADE) * @param {OpenOrdersCancelAllRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#open-orders-cancel-all Binance API Documentation} */ openOrdersCancelAll(requestParameters: OpenOrdersCancelAllRequest): Promise>; /** * Reduce the quantity of an existing open order. * * This adds 0 orders to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read [Order Amend Keep Priority FAQ](/products/spot/faqs/order_amend_keep_priority) to learn more. * * Weight(IP): 4 * * Unfilled Order Count: 0 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Order Amend Keep Priority (TRADE) * @param {OrderAmendKeepPriorityRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-amend-keep-priority Binance API Documentation} */ orderAmendKeepPriority(requestParameters: OrderAmendKeepPriorityRequest): Promise>; /** * Cancel an active order. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Notes: * * If both `orderId` and `origClientOrderId` parameters are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * `newClientOrderId` will replace `clientOrderId` of the canceled order, freeing it up for new orders. * * If you cancel an order that is a part of an order list, the entire order list is canceled. * * The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel order (TRADE) * @param {OrderCancelRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-cancel Binance API Documentation} */ orderCancel(requestParameters: OrderCancelRequest): Promise>; /** * * Cancel an existing order and immediately place a new order instead of the canceled one. * A new order that was not attempted (i.e. when `newOrderResult: NOT_ATTEMPTED`), will still increase the unfilled order count by 1. * You can only cancel an individual order from an orderList using this method, but the result is the same as canceling the entire orderList.not attempted (i.e. when `newOrderResult: NOT_ATTEMPTED`), will still increase the unfilled order count by 1. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Similar to the [`order.place`](#order-place) request, * additional mandatory parameters (*) are determined by the new order `type`. * * Available `cancelReplaceMode` options: * * `STOP_ON_FAILURE` – if cancellation request fails, new order placement will not be attempted. * `ALLOW_FAILURE` – new order placement will be attempted even if the cancel request fails. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
RequestResponse
cancelReplaceModeorderRateLimitExceededModeUnfilled Order CountcancelResultnewOrderResultstatus
STOP_ON_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE➖ NOT_ATTEMPTEDN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE➖ NOT_ATTEMPTED400
✅ SUCCESS❌ FAILURE409
Exceeds Limits❌ FAILURE➖ NOT_ATTEMPTED429
✅ SUCCESS❌ FAILURE429
ALLOW_FAILUREDO_NOTHINGWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESSN/A
❌ FAILURE❌ FAILUREN/A
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILUREN/A
CANCEL_ONLYWithin Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESS409
✅ SUCCESS❌ FAILURE409
Exceeds Limits✅ SUCCESS✅ SUCCESS200
❌ FAILURE❌ FAILURE400
❌ FAILURE✅ SUCCESSN/A
✅ SUCCESS❌ FAILURE409
* * Notes: * * If both `cancelOrderId` and `cancelOrigClientOrderId` parameters are provided, the `cancelOrderId` is searched first, then the `cancelOrigClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * `cancelNewClientOrderId` will replace `clientOrderId` of the canceled order, freeing it up for new orders. * * `newClientOrderId` specifies `clientOrderId` value for the placed order. * * A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired. * * The new order can reuse old `clientOrderId` of the canceled order. * * This cancel-replace operation is **not transactional**. * * If one operation succeeds but the other one fails, the successful operation is still executed. * * For example, in `STOP_ON_FAILURE` mode, if the new order placement fails, the old order is still canceled. * * Filters and order count limits are evaluated before cancellation and order placement occurs. * * If new order placement is not attempted, your order count is still incremented. * * Like [`order.cancel`](#order-cancel), if you cancel an individual order from an order list, the entire order list is canceled. * * The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower. * * @summary Cancel and replace order (TRADE) * @param {OrderCancelReplaceRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-cancel-replace Binance API Documentation} */ orderCancelReplace(requestParameters: OrderCancelReplaceRequest): Promise>; /** * Cancel an active order list. * * Weight(IP): 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Notes: * * If both `orderListId` and `listClientOrderId` parameters are provided, the `orderListId` is searched first, then the `listClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected. * * Canceling an individual order with [`order.cancel`](#order-cancel) will cancel the entire order list as well. * * @summary Cancel Order list (TRADE) * @param {OrderListCancelRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-cancel Binance API Documentation} */ orderListCancel(requestParameters: OrderListCancelRequest): Promise>; /** * Send in a new one-cancels-the-other (OCO) pair: * `LIMIT_MAKER` + `STOP_LOSS`/`STOP_LOSS_LIMIT` orders (called *legs*), * where activation of one order immediately cancels the other. * * This adds 1 order to `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Notes: * * `listClientOrderId` parameter specifies `listClientOrderId` for the OCO pair. * * A new OCO with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. * * `listClientOrderId` is distinct from `clientOrderId` of individual orders. * * `limitClientOrderId` and `stopClientOrderId` specify `clientOrderId` values for both legs of the OCO. * * A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired. * * Price restrictions on the legs: * * | `side` | Price relation | * | ------ | -------------- | * | `BUY` | `price` < market price < `stopPrice` | * | `SELL` | `price` > market price > `stopPrice` | * * Both legs have the same `quantity`. * * However, you can set different iceberg quantity for individual legs. * * If `stopIcebergQty` is used, `stopLimitTimeInForce` must be `GTC`. * * `trailingDelta` applies only to the `STOP_LOSS`/`STOP_LOSS_LIMIT` leg of the OCO. * * @summary Place new OCO - Deprecated (TRADE) * @param {OrderListPlaceRequest} requestParameters Request parameters. * @deprecated * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place Binance API Documentation} */ orderListPlace(requestParameters: OrderListPlaceRequest): Promise>; /** * Send in an one-cancels-the-other (OCO) pair, where activation of one order immediately cancels the other. * * An OCO has 2 orders called the **above order** and **below order**. * * One of the orders must be a `LIMIT_MAKER/TAKE_PROFIT/TAKE_PROFIT_LIMIT` order and the other must be * `STOP_LOSS` or `STOP_LOSS_LIMIT` order. * * Price restrictions: * If the OCO is on the `SELL` side: * `LIMIT_MAKER/TAKE_PROFIT_LIMIT` `price` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT` * `stopPrice` * `TAKE_PROFIT stopPrice` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT * stopPrice` * If the OCO is on the `BUY` side: * `LIMIT_MAKER` `price` < Last Traded Price < `STOP_LOSS/STOP_LOSS_LIMIT` `stopPrice` * `TAKE_PROFIT stopPrice` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT stopPrice` * OCOs add **2 orders** to the `EXCHANGE_MAX_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary Place new Order list - OCO (TRADE) * @param {OrderListPlaceOcoRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place-oco Binance API Documentation} */ orderListPlaceOco(requestParameters: OrderListPlaceOcoRequest): Promise>; /** * Place an [OPO](/products/spot/faqs/opo). * * OPOs add 2 orders to the EXCHANGE_MAX_NUM_ORDERS filter and MAX_NUM_ORDERS filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary OPO (TRADE) * @param {OrderListPlaceOpoRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place-opo Binance API Documentation} */ orderListPlaceOpo(requestParameters: OrderListPlaceOpoRequest): Promise>; /** * Place an [OPOCO](/products/spot/faqs/opo). * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * @summary OPOCO (TRADE) * @param {OrderListPlaceOpocoRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place-opoco Binance API Documentation} */ orderListPlaceOpoco(requestParameters: OrderListPlaceOpocoRequest): Promise>; /** * Places an OTO. * * An OTO (One-Triggers-the-Other) is an order list comprised of 2 orders. * * The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the * working order goes on the order book. * * The second order is called the **pending order**. It can be any order type except for `MARKET` orders using * parameter `quoteOrderQty`. The pending order is only placed on the order book when the working order gets **fully filled**. * * If either the working order or the pending order is cancelled individually, the other order in the order list * will also be canceled or expired. * * When the order list is placed, if the working order gets **immediately fully filled**, the placement response * will show the working order as `FILLED` but the pending order will still appear as `PENDING_NEW`. You need to * query the status of the pending order again to see its updated status. * * OTOs add **2 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 2 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingType` or `workingType`** * * Depending on the `pendingType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingType` = `LIMIT` |`pendingPrice`, `pendingTimeInForce` | * |`pendingType` = `STOP_LOSS` or `TAKE_PROFIT` |`pendingStopPrice` and/or `pendingTrailingDelta`| * |`pendingType` =`STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`|`pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce`| * * @summary Place new Order list - OTO (TRADE) * @param {OrderListPlaceOtoRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place-oto Binance API Documentation} */ orderListPlaceOto(requestParameters: OrderListPlaceOtoRequest): Promise>; /** * Place an OTOCO. * * An OTOCO (One-Triggers-One-Cancels-the-Other) is an order list comprised of 3 orders. * The first order is called the **working order** and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. * The behavior of the working order is the same as the [OTO](#order-list-place-oto). * OTOCO has 2 pending orders (pending above and pending below), forming an OCO pair. The pending orders are only placed on the order book when the working order gets **fully filled**. * The rules of the pending above and pending below follow the same rules as the [Order list OCO](#order-list-place-oco). * OTOCOs add **3 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 3 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Mandatory parameters based on `pendingAboveType`, `pendingBelowType` or `workingType`** * * Depending on the `pendingAboveType`/`pendingBelowType` or `workingType`, some optional parameters will become mandatory. * * |Type |Additional mandatory parameters|Additional information| * |---- |---- |------ * |`workingType` = `LIMIT` |`workingTimeInForce` | * |`pendingAboveType`= `LIMIT_MAKER` |`pendingAbovePrice` | * |`pendingAboveType` = `STOP_LOSS/TAKE_PROFIT` |`pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`| * |`pendingAboveType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT`|`pendingAbovePrice`, `pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`, `pendingAboveTimeInForce`| * |`pendingBelowType`= `LIMIT_MAKER` |`pendingBelowPrice` | * `pendingBelowType= STOP_LOSS/TAKE_PROFIT` |`pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`| * |`pendingBelowType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT`|`pendingBelowPrice`, `pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`, `pendingBelowTimeInForce`| * * @summary Place new Order list - OTOCO (TRADE) * @param {OrderListPlaceOtocoRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-list-place-otoco Binance API Documentation} */ orderListPlaceOtoco(requestParameters: OrderListPlaceOtocoRequest): Promise>; /** * Send in a new order. * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * * Certain parameters (*) become mandatory based on the order `type`: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Order typeMandatory parameters
LIMIT *
    *
  • timeInForce
    • *
  • price
    • *
  • quantity
    • *
*
LIMIT_MAKER *
    *
  • price
    • *
  • quantity
    • *
*
MARKET *
    *
  • quantity or quoteOrderQty
    • *
*
STOP_LOSS *
    *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
STOP_LOSS_LIMIT *
    *
  • timeInForce
    • *
  • price
    • *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
TAKE_PROFIT *
    *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
TAKE_PROFIT_LIMIT *
    *
  • timeInForce
    • *
  • price
    • *
  • quantity
    • *
  • stopPrice or trailingDelta
    • *
*
* * Supported order types: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Order typeDescription
LIMIT *

* Buy or sell quantity at the specified price or better. *

*
LIMIT_MAKER *

* LIMIT order that will be rejected if it immediately matches and trades as a taker. *

*

* This order type is also known as a POST-ONLY order. *

*
MARKET *

* Buy or sell at the best available market price. *

*
    *
  • *

    * MARKET order with quantity parameter * specifies the amount of the base asset you want to buy or sell. * Actually executed quantity of the quote asset will be determined by available market liquidity. *

    *

    * E.g., a MARKET BUY order on BTCUSDT for "quantity": "0.1000" * specifies that you want to buy 0.1 BTC at the best available price. * If there is not enough BTC at the best price, keep buying at the next best price, * until either your order is filled, or you run out of USDT, or market runs out of BTC. *

    *
    • *
  • *

    * MARKET order with quoteOrderQty parameter * specifies the amount of the quote asset you want to spend (when buying) or receive (when selling). * Actually executed quantity of the base asset will be determined by available market liquidity. *

    *

    * E.g., a MARKET BUY on BTCUSDT for "quoteOrderQty": "100.00" * specifies that you want to buy as much BTC as you can for 100 USDT at the best available price. * Similarly, a SELL order will sell as much available BTC as needed for you to receive 100 USDT * (before commission). *

    *
    • *
*
STOP_LOSS *

* Execute a MARKET order for given quantity when specified conditions are met. *

*

* I.e., when stopPrice is reached, or when trailingDelta is activated. *

*
STOP_LOSS_LIMIT *

* Place a LIMIT order with given parameters when specified conditions are met. *

*
TAKE_PROFIT *

* Like STOP_LOSS but activates when market price moves in the favorable direction. *

*
TAKE_PROFIT_LIMIT *

* Like STOP_LOSS_LIMIT but activates when market price moves in the favorable direction. *

*
* * * Notes on using parameters for Pegged Orders: * * These parameters are allowed for `LIMIT`, `LIMIT_MAKER`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_LIMIT` orders. * If `pegPriceType` is specified, `price` becomes optional. Otherwise, it is still mandatory. * `pegPriceType=PRIMARY_PEG` means the primary peg, that is the best price on the same side of the order book as your order. * `pegPriceType=MARKET_PEG` means the market peg, that is the best price on the opposite side of the order book from your order. * Use `pegOffsetType` and `pegOffsetValue` to request a price level other than the best one. These parameters must be specified together. * * * * Available `timeInForce` options, * setting how long the order should be active before expiration: * * TIF | Description * ----- | -------------- * `GTC` | **Good 'til Canceled** – the order will remain on the book until you cancel it, or the order is completely filled. * `IOC` | **Immediate or Cancel** – the order will be filled for as much as possible, the unfilled quantity immediately expires. * `FOK` | **Fill or Kill** – the order will expire unless it cannot be immediately filled for the entire quantity. * * Notes: * * `newClientOrderId` specifies `clientOrderId` value for the order. * * A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired. * * Any `LIMIT` or `LIMIT_MAKER` order can be made into an iceberg order by specifying the `icebergQty`. * * An order with an `icebergQty` must have `timeInForce` set to `GTC`. * * Trigger order price rules for `STOP_LOSS`/`TAKE_PROFIT` orders: * * `stopPrice` must be above market price: `STOP_LOSS BUY`, `TAKE_PROFIT SELL` * `stopPrice` must be below market price: `STOP_LOSS SELL`, `TAKE_PROFIT BUY` * * `MARKET` orders using `quoteOrderQty` follow [`LOT_SIZE`](/products/spot/filters#lot_size) filter rules. * * The order will execute a quantity that has notional value as close as possible to requested `quoteOrderQty`. * * @summary Place new order (TRADE) * @param {OrderPlaceRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-place Binance API Documentation} */ orderPlace(requestParameters: OrderPlaceRequest): Promise>; /** * Test order placement. * * Validates new order parameters and verifies your signature * but does not send the order into the matching engine. * * Weight: | Condition | Request Weight | * | --- | --- | * | Without `computeCommissionRates` | 1 | * | With `computeCommissionRates` | 20 | * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order (TRADE) * @param {OrderTestRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#order-test Binance API Documentation} */ orderTest(requestParameters: OrderTestRequest): Promise>; /** * Places an order using smart order routing (SOR). * * This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter. * * Read [SOR FAQ](/products/spot/faqs/sor_faq) to learn more. * * Weight(IP): 1 * * Unfilled Order Count: 1 * * Security Type: TRADE * * Notes: **Data Source:** Matching Engine * **Note:** `sor.order.place` only supports `LIMIT` and `MARKET` orders. `quoteOrderQty` is not supported. * * @summary Place new order using SOR (TRADE) * @param {SorOrderPlaceRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#sor-order-place Binance API Documentation} */ sorOrderPlace(requestParameters: SorOrderPlaceRequest): Promise>; /** * Test new order creation and signature/recvWindow using smart order routing (SOR). * Creates and validates a new order but does not send it into the matching engine. * * Weight: | Condition | Request Weight | * | --- | --- | * | Without `computeCommissionRates` | 1 | * | With `computeCommissionRates` | 20 | * * Security Type: TRADE * * Notes: **Data Source:** Memory * * @summary Test new order using SOR (TRADE) * @param {SorOrderTestRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/trade#sor-order-test Binance API Documentation} */ sorOrderTest(requestParameters: SorOrderTestRequest): Promise>; /** * **Note:** * * Users should track the corresponding subscription status of related accounts as needed. * * Weight(IP): 2 * * Security Type: NONE * * Notes: **Data Source:** Memory * * @summary Listing all subscriptions * @param {SessionSubscriptionsRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/user-data-stream#session-subscriptions Binance API Documentation} */ sessionSubscriptions(requestParameters?: SessionSubscriptionsRequest): Promise>; /** * Subscribe to the User Data Stream in the current WebSocket connection. * **Notes:** * - This method requires an authenticated WebSocket connection using Ed25519 keys. Please refer to [`session.logon`](/catalog/core-trading-spot-trading/api/ws-api/auth#session-logon). * - To check the subscription status, use [`session.status`](/catalog/core-trading-spot-trading/api/ws-api/auth#session-status), see the `userDataStream` flag indicating you have have an active subscription. * - User Data Stream events are available in both JSON and [SBE](/products/spot/faqs/sbe_faq) sessions. * - Please refer to [User Data Streams](/products/spot/user-data-stream) for the event format details. * - For SBE, only SBE schema 2:1 or later is supported. * * Weight(IP): 2 * * Security Type: NONE * * @summary Subscribe to User Data Stream * @param {UserDataStreamSubscribeRequest} requestParameters Request parameters. * @param {string} [id] Optional custom stream identifier. * * @returns Promise<{response: WebsocketApiResponse, stream: WebsocketStream}> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/user-data-stream#user-data-stream-subscribe Binance API Documentation} */ userDataStreamSubscribe(requestParameters?: UserDataStreamSubscribeRequest, id?: string): Promise<{ response: WebsocketApiResponse; stream: WebsocketStream; }>; /** * Weight(IP): 2 * * Security Type: USER_STREAM * * Notes: **Data Source:** Memory * * @summary Subscribe to User Data Stream through signature subscription (USER_STREAM) * @param {UserDataStreamSubscribeSignatureRequest} requestParameters Request parameters. * @param {string} [id] Optional custom stream identifier. * * @returns Promise<{response: WebsocketApiResponse, stream: WebsocketStream}> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/user-data-stream#user-data-stream-subscribe-signature Binance API Documentation} */ userDataStreamSubscribeSignature(requestParameters?: UserDataStreamSubscribeSignatureRequest, id?: string): Promise<{ response: WebsocketApiResponse; stream: WebsocketStream; }>; /** * Stop listening to the User Data Stream in the current WebSocket * connection. * * Note that `session.logout` will only close the subscription created with `userDataStream.subscribe` but not subscriptions opened with `userDataStream.subscribe.signature`. * * Weight(IP): 2 * * @summary WebSocket Unsubscribe from User Data Stream * @param {UserDataStreamUnsubscribeRequest} requestParameters Request parameters. * * @returns Promise> * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-api/user-data-stream#user-data-stream-unsubscribe Binance API Documentation} */ userDataStreamUnsubscribe(requestParameters?: UserDataStreamUnsubscribeRequest): Promise>; } //#endregion //#region src/websocket-api/websocket-api.d.ts declare class WebsocketAPI { private configuration; constructor(configuration: ConfigurationWebsocketAPI); /** * Connects to the Binance WebSocket API and returns a `WebsocketAPIConnection` instance. * * @param {object} [options] - Optional connection options. * @param {string} [options.mode='single'] - The connection mode, either 'single' or 'pool'. Overrides the `mode` property in the configuration. * @param {number} [options.poolSize=1] - The number of connections to use in pool mode. Overrides the `poolSize` property in the configuration. * @returns {Promise} - A promise that resolves to a `WebsocketAPIConnection` instance. */ connect({ mode, poolSize }?: { mode?: 'single' | 'pool'; poolSize?: number; }): Promise; } declare namespace index_d_exports$1 { export { AccountApi, AccountApiInterface, AccountCommissionRequest, AccountCommissionResponse, AccountCommissionResponseRateLimitsInner, AccountCommissionResponseResult, AccountCommissionResponseResultDiscount, AccountCommissionResponseResultSpecialCommission, AccountCommissionResponseResultStandardCommission, AccountCommissionResponseResultTaxCommission, AccountRateLimitsOrdersRequest, AccountRateLimitsOrdersResponse, AccountRateLimitsOrdersResponseResultInner, AccountStatusRequest, AccountStatusResponse, AccountStatusResponseResult, AccountStatusResponseResultBalancesInner, AccountStatusResponseResultCommissionRates, AllOrderListsRequest, AllOrderListsResponse, AllOrderListsResponseResultInner, AllOrderListsResponseResultInnerOrdersInner, AllOrdersRequest, AllOrdersResponse, AllOrdersResponseResultInner, AuthApi, AuthApiInterface, AvgPriceRequest$1 as AvgPriceRequest, AvgPriceResponse$1 as AvgPriceResponse, AvgPriceResponseResult, BalanceUpdate$1 as BalanceUpdate, BlockTradesHistoricalRequest, BlockTradesHistoricalResponse, BlockTradesHistoricalResponseRateLimitsInner, BlockTradesHistoricalResponseResultInner, DepthRequest, DepthResponse, DepthResponseResult, DepthSymbolStatusEnum, EventStreamTerminated$1 as EventStreamTerminated, ExchangeFilters, ExchangeInfoRequest, ExchangeInfoResponse, ExchangeInfoResponseSorsInner, ExchangeInfoResponseSymbolsInner, ExchangeInfoSymbolStatusEnum, ExchangeMaxNumAlgoOrdersFilter, ExchangeMaxNumIcebergOrdersFilter, ExchangeMaxNumOrderListsFilter, ExchangeMaxNumOrdersFilter, ExecutionReport$1 as ExecutionReport, ExecutionRulesRequest, ExecutionRulesResponse, ExecutionRulesResponseResult, ExecutionRulesResponseResultSymbolRulesInner, ExecutionRulesResponseResultSymbolRulesInnerRulesInner, ExecutionRulesSymbolStatusEnum, ExternalLockUpdate$1 as ExternalLockUpdate, GeneralApi, GeneralApiInterface, IcebergPartsFilter, KlinesIntervalEnum, KlinesRequest, KlinesResponse, KlinesResponseResultInnerInner, ListStatus$1 as ListStatus, ListStatusOInner$1 as ListStatusOInner, LotSizeFilter, MarketApi, MarketApiInterface, MarketLotSizeFilter, MaxAssetFilter, MaxNumAlgoOrdersFilter, MaxNumIcebergOrdersFilter, MaxNumOrderAmendsFilter, MaxNumOrderListsFilter, MaxNumOrdersFilter, MaxPositionFilter, MinNotionalFilter, MyAllocationsRequest, MyAllocationsResponse, MyAllocationsResponseResultInner, MyFiltersRequest, MyFiltersResponse, MyPreventedMatchesRequest, MyPreventedMatchesResponse, MyPreventedMatchesResponseResultInner, MyTradesRequest, MyTradesResponse, MyTradesResponseResultInner, NotionalFilter, OpenOrderListsStatusRequest, OpenOrderListsStatusResponse, OpenOrderListsStatusResponseResultInner, OpenOrderListsStatusResponseResultInnerOrdersInner, OpenOrdersCancelAllRequest, OpenOrdersCancelAllResponse, OpenOrdersCancelAllResponseResultInner, OpenOrdersCancelAllResponseResultInnerOrderReportsInner, OpenOrdersCancelAllResponseResultInnerOrdersInner, OpenOrdersStatusRequest, OpenOrdersStatusResponse, OpenOrdersStatusResponseResultInner, OrderAmendKeepPriorityRequest, OrderAmendKeepPriorityResponse, OrderAmendKeepPriorityResponseResult, OrderAmendKeepPriorityResponseResultAmendedOrder, OrderAmendKeepPriorityResponseResultListStatus, OrderAmendKeepPriorityResponseResultListStatusOrdersInner, OrderAmendmentsRequest, OrderAmendmentsResponse, OrderAmendmentsResponseResultInner, OrderCancelCancelRestrictionsEnum, OrderCancelReplaceCancelReplaceModeEnum, OrderCancelReplaceCancelRestrictionsEnum, OrderCancelReplaceNewOrderRespTypeEnum, OrderCancelReplaceOrderRateLimitExceededModeEnum, OrderCancelReplacePegOffsetTypeEnum, OrderCancelReplacePegPriceTypeEnum, OrderCancelReplaceRequest, OrderCancelReplaceResponse, OrderCancelReplaceResponseResult, OrderCancelReplaceResponseResultCancelResponse, OrderCancelReplaceResponseResultNewOrderResponse, OrderCancelReplaceSelfTradePreventionModeEnum, OrderCancelReplaceSideEnum, OrderCancelReplaceTimeInForceEnum, OrderCancelReplaceTypeEnum, OrderCancelRequest, OrderCancelResponse, OrderCancelResponseResult, OrderListCancelRequest, OrderListCancelResponse, OrderListCancelResponseResult, OrderListCancelResponseResultOrderReportsInner, OrderListPlaceNewOrderRespTypeEnum, OrderListPlaceOcoAbovePegOffsetTypeEnum, OrderListPlaceOcoAbovePegPriceTypeEnum, OrderListPlaceOcoAboveTimeInForceEnum, OrderListPlaceOcoAboveTypeEnum, OrderListPlaceOcoBelowPegOffsetTypeEnum, OrderListPlaceOcoBelowPegPriceTypeEnum, OrderListPlaceOcoBelowTimeInForceEnum, OrderListPlaceOcoBelowTypeEnum, OrderListPlaceOcoNewOrderRespTypeEnum, OrderListPlaceOcoRequest, OrderListPlaceOcoResponse, OrderListPlaceOcoResponseResult, OrderListPlaceOcoResponseResultOrderReportsInner, OrderListPlaceOcoResponseResultOrdersInner, OrderListPlaceOcoSelfTradePreventionModeEnum, OrderListPlaceOcoSideEnum, OrderListPlaceOpoNewOrderRespTypeEnum, OrderListPlaceOpoPendingPegOffsetTypeEnum, OrderListPlaceOpoPendingPegPriceTypeEnum, OrderListPlaceOpoPendingSideEnum, OrderListPlaceOpoPendingTimeInForceEnum, OrderListPlaceOpoPendingTypeEnum, OrderListPlaceOpoRequest, OrderListPlaceOpoResponse, OrderListPlaceOpoResponseResult, OrderListPlaceOpoResponseResultOrderReportsInner, OrderListPlaceOpoResponseResultOrdersInner, OrderListPlaceOpoSelfTradePreventionModeEnum, OrderListPlaceOpoWorkingPegOffsetTypeEnum, OrderListPlaceOpoWorkingPegPriceTypeEnum, OrderListPlaceOpoWorkingSideEnum, OrderListPlaceOpoWorkingTimeInForceEnum, OrderListPlaceOpoWorkingTypeEnum, OrderListPlaceOpocoNewOrderRespTypeEnum, OrderListPlaceOpocoPendingAbovePegOffsetTypeEnum, OrderListPlaceOpocoPendingAbovePegPriceTypeEnum, OrderListPlaceOpocoPendingAboveTimeInForceEnum, OrderListPlaceOpocoPendingAboveTypeEnum, OrderListPlaceOpocoPendingBelowPegOffsetTypeEnum, OrderListPlaceOpocoPendingBelowPegPriceTypeEnum, OrderListPlaceOpocoPendingBelowTimeInForceEnum, OrderListPlaceOpocoPendingBelowTypeEnum, OrderListPlaceOpocoPendingSideEnum, OrderListPlaceOpocoRequest, OrderListPlaceOpocoResponse, OrderListPlaceOpocoResponseResult, OrderListPlaceOpocoResponseResultOrderReportsInner, OrderListPlaceOpocoResponseResultOrdersInner, OrderListPlaceOpocoSelfTradePreventionModeEnum, OrderListPlaceOpocoWorkingPegOffsetTypeEnum, OrderListPlaceOpocoWorkingPegPriceTypeEnum, OrderListPlaceOpocoWorkingSideEnum, OrderListPlaceOpocoWorkingTimeInForceEnum, OrderListPlaceOpocoWorkingTypeEnum, OrderListPlaceOtoNewOrderRespTypeEnum, OrderListPlaceOtoPendingPegOffsetTypeEnum, OrderListPlaceOtoPendingPegPriceTypeEnum, OrderListPlaceOtoPendingSideEnum, OrderListPlaceOtoPendingTimeInForceEnum, OrderListPlaceOtoPendingTypeEnum, OrderListPlaceOtoRequest, OrderListPlaceOtoResponse, OrderListPlaceOtoResponseResult, OrderListPlaceOtoResponseResultOrderReportsInner, OrderListPlaceOtoResponseResultOrdersInner, OrderListPlaceOtoSelfTradePreventionModeEnum, OrderListPlaceOtoWorkingPegOffsetTypeEnum, OrderListPlaceOtoWorkingPegPriceTypeEnum, OrderListPlaceOtoWorkingSideEnum, OrderListPlaceOtoWorkingTimeInForceEnum, OrderListPlaceOtoWorkingTypeEnum, OrderListPlaceOtocoNewOrderRespTypeEnum, OrderListPlaceOtocoPendingAbovePegOffsetTypeEnum, OrderListPlaceOtocoPendingAbovePegPriceTypeEnum, OrderListPlaceOtocoPendingAboveTimeInForceEnum, OrderListPlaceOtocoPendingAboveTypeEnum, OrderListPlaceOtocoPendingBelowPegOffsetTypeEnum, OrderListPlaceOtocoPendingBelowPegPriceTypeEnum, OrderListPlaceOtocoPendingBelowTimeInForceEnum, OrderListPlaceOtocoPendingBelowTypeEnum, OrderListPlaceOtocoPendingSideEnum, OrderListPlaceOtocoRequest, OrderListPlaceOtocoResponse, OrderListPlaceOtocoResponseResult, OrderListPlaceOtocoResponseResultOrderReportsInner, OrderListPlaceOtocoResponseResultOrdersInner, OrderListPlaceOtocoSelfTradePreventionModeEnum, OrderListPlaceOtocoWorkingPegOffsetTypeEnum, OrderListPlaceOtocoWorkingPegPriceTypeEnum, OrderListPlaceOtocoWorkingSideEnum, OrderListPlaceOtocoWorkingTimeInForceEnum, OrderListPlaceOtocoWorkingTypeEnum, OrderListPlaceRequest, OrderListPlaceResponse, OrderListPlaceResponseResult, OrderListPlaceResponseResultOrderReportsInner, OrderListPlaceSelfTradePreventionModeEnum, OrderListPlaceSideEnum, OrderListPlaceStopLimitTimeInForceEnum, OrderListStatusRequest, OrderListStatusResponse, OrderListStatusResponseResult, OrderPlaceNewOrderRespTypeEnum, OrderPlacePegOffsetTypeEnum, OrderPlacePegPriceTypeEnum, OrderPlaceRequest, OrderPlaceResponse, OrderPlaceResponseResult, OrderPlaceResponseResultFillsInner, OrderPlaceSelfTradePreventionModeEnum, OrderPlaceSideEnum, OrderPlaceTimeInForceEnum, OrderPlaceTypeEnum, OrderStatusRequest, OrderStatusResponse, OrderStatusResponseResult, OrderTestNewOrderRespTypeEnum, OrderTestPegOffsetTypeEnum, OrderTestPegPriceTypeEnum, OrderTestRequest, OrderTestResponse, OrderTestResponseResult, OrderTestResponseResultDiscount, OrderTestResponseResultStandardCommissionForOrder, OrderTestSelfTradePreventionModeEnum, OrderTestSideEnum, OrderTestTimeInForceEnum, OrderTestTypeEnum, OutboundAccountPosition$1 as OutboundAccountPosition, OutboundAccountPositionBInner$1 as OutboundAccountPositionBInner, PercentPriceBySideFilter, PercentPriceFilter, PingRequest, PingResponse, PriceFilter, RateLimits, ReferencePriceCalculationRequest, ReferencePriceCalculationResponse, ReferencePriceCalculationResponseResult, ReferencePriceCalculationSymbolStatusEnum, ReferencePriceRequest$1 as ReferencePriceRequest, ReferencePriceResponse$1 as ReferencePriceResponse, ReferencePriceResponseResult, SessionLogonRequest, SessionLogonResponse, SessionLogonResponseResult, SessionLogoutRequest, SessionLogoutResponse, SessionLogoutResponseResult, SessionStatusRequest, SessionStatusResponse, SessionStatusResponseResult, SessionSubscriptionsRequest, SessionSubscriptionsResponse, SessionSubscriptionsResponseResultInner, SorOrderPlaceNewOrderRespTypeEnum, SorOrderPlaceRequest, SorOrderPlaceResponse, SorOrderPlaceResponseResultInner, SorOrderPlaceResponseResultInnerFillsInner, SorOrderPlaceSelfTradePreventionModeEnum, SorOrderPlaceSideEnum, SorOrderPlaceTimeInForceEnum, SorOrderPlaceTypeEnum, SorOrderTestNewOrderRespTypeEnum, SorOrderTestRequest, SorOrderTestResponse, SorOrderTestResponseResult, SorOrderTestSelfTradePreventionModeEnum, SorOrderTestSideEnum, SorOrderTestTimeInForceEnum, SorOrderTestTypeEnum, SymbolFilters, TPlusSellFilter, Ticker24hrRequest, Ticker24hrResponse, Ticker24hrResponse1, Ticker24hrResponse1Result, Ticker24hrResponse2, Ticker24hrResponse2ResultInner, Ticker24hrSymbolStatusEnum, Ticker24hrTypeEnum, TickerBookRequest, TickerBookResponse, TickerBookResponse1, TickerBookResponse1Result, TickerBookResponse2, TickerBookResponse2ResultInner, TickerBookSymbolStatusEnum, TickerPriceRequest, TickerPriceResponse, TickerPriceResponse1, TickerPriceResponse1Result, TickerPriceResponse2, TickerPriceResponse2ResultInner, TickerPriceSymbolStatusEnum, TickerRequest$1 as TickerRequest, TickerResponse$1 as TickerResponse, TickerResponse1, TickerResponse1Result, TickerResponse2, TickerResponse2ResultInner, TickerSymbolStatusEnum, TickerTradingDayRequest, TickerTradingDayResponse, TickerTradingDayResponseResultInner, TickerTradingDaySymbolStatusEnum, TickerTradingDayTypeEnum, TickerTypeEnum, TickerWindowSizeEnum, TimeRequest, TimeResponse, TimeResponseResult, TradeApi, TradeApiInterface, TradesAggregateRequest, TradesAggregateResponse, TradesAggregateResponseResultInner, TradesHistoricalRequest, TradesHistoricalResponse, TradesHistoricalResponseResultInner, TradesRecentRequest, TradesRecentResponse, TradesRecentResponseResultInner, TrailingDeltaFilter, UiKlinesIntervalEnum, UiKlinesRequest, UiKlinesResponse, UserDataStreamApi, UserDataStreamApiInterface, UserDataStreamEventsResponse$1 as UserDataStreamEventsResponse, UserDataStreamSubscribeRequest, UserDataStreamSubscribeResponse, UserDataStreamSubscribeResponseResult, UserDataStreamSubscribeSignatureRequest, UserDataStreamSubscribeSignatureResponse, UserDataStreamUnsubscribeRequest, UserDataStreamUnsubscribeResponse, WebsocketAPI, WebsocketAPIConnection }; } //#endregion //#region src/websocket-streams/types/agg-trade-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AggTradeResponse */ interface AggTradeResponse { /** * Event type * @type {string} * @memberof AggTradeResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof AggTradeResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof AggTradeResponse */ s?: string; /** * Aggregate trade ID * @type {number | bigint} * @memberof AggTradeResponse */ a?: number | bigint; /** * Price * @type {string} * @memberof AggTradeResponse */ p?: string; /** * Quantity * @type {string} * @memberof AggTradeResponse */ q?: string; /** * First trade ID * @type {number | bigint} * @memberof AggTradeResponse */ f?: number | bigint; /** * Last trade ID * @type {number | bigint} * @memberof AggTradeResponse */ l?: number | bigint; /** * Trade time * @type {number | bigint} * @memberof AggTradeResponse */ T?: number | bigint; /** * Is the buyer the market maker? * @type {boolean} * @memberof AggTradeResponse */ m?: boolean; /** * Ignore * @type {boolean} * @memberof AggTradeResponse */ M?: boolean; } //#endregion //#region src/websocket-streams/types/all-market-rolling-window-ticker-response-inner.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AllMarketRollingWindowTickerResponseInner */ interface AllMarketRollingWindowTickerResponseInner { /** * Event type * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ e?: string; /** * Event time * @type {number | bigint} * @memberof AllMarketRollingWindowTickerResponseInner */ E?: number | bigint; /** * Symbol * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ s?: string; /** * Price change * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ p?: string; /** * Price change percent * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ P?: string; /** * Open price * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ o?: string; /** * High price * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ h?: string; /** * Low price * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ l?: string; /** * Last price * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ c?: string; /** * Weighted average price * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ w?: string; /** * Total traded base asset volume * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ v?: string; /** * Total traded quote asset volume * @type {string} * @memberof AllMarketRollingWindowTickerResponseInner */ q?: string; /** * Statistics open time * @type {number | bigint} * @memberof AllMarketRollingWindowTickerResponseInner */ O?: number | bigint; /** * Statistics close time * @type {number | bigint} * @memberof AllMarketRollingWindowTickerResponseInner */ C?: number | bigint; /** * First trade ID * @type {number | bigint} * @memberof AllMarketRollingWindowTickerResponseInner */ F?: number | bigint; /** * Last trade Id * @type {number | bigint} * @memberof AllMarketRollingWindowTickerResponseInner */ L?: number | bigint; /** * Total number of trades * @type {number | bigint} * @memberof AllMarketRollingWindowTickerResponseInner */ n?: number | bigint; } //#endregion //#region src/websocket-streams/types/all-market-rolling-window-ticker-response.d.ts /** * * @export * @interface AllMarketRollingWindowTickerResponse */ interface AllMarketRollingWindowTickerResponse extends Array {} //#endregion //#region src/websocket-streams/types/all-mini-ticker-response-inner.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AllMiniTickerResponseInner */ interface AllMiniTickerResponseInner { /** * Event type * @type {string} * @memberof AllMiniTickerResponseInner */ e?: string; /** * Event time * @type {number | bigint} * @memberof AllMiniTickerResponseInner */ E?: number | bigint; /** * Symbol * @type {string} * @memberof AllMiniTickerResponseInner */ s?: string; /** * Close price * @type {string} * @memberof AllMiniTickerResponseInner */ c?: string; /** * Open price * @type {string} * @memberof AllMiniTickerResponseInner */ o?: string; /** * High price * @type {string} * @memberof AllMiniTickerResponseInner */ h?: string; /** * Low price * @type {string} * @memberof AllMiniTickerResponseInner */ l?: string; /** * Total traded base asset volume * @type {string} * @memberof AllMiniTickerResponseInner */ v?: string; /** * Total traded quote asset volume * @type {string} * @memberof AllMiniTickerResponseInner */ q?: string; } //#endregion //#region src/websocket-streams/types/all-mini-ticker-response.d.ts /** * * @export * @interface AllMiniTickerResponse */ interface AllMiniTickerResponse extends Array {} //#endregion //#region src/websocket-streams/types/avg-price-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 AvgPriceResponse */ interface AvgPriceResponse { /** * Event type * @type {string} * @memberof AvgPriceResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof AvgPriceResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof AvgPriceResponse */ s?: string; /** * Average price interval * @type {string} * @memberof AvgPriceResponse */ i?: string; /** * Average price * @type {string} * @memberof AvgPriceResponse */ w?: string; /** * Last trade time * @type {number | bigint} * @memberof AvgPriceResponse */ T?: number | bigint; } //#endregion //#region src/websocket-streams/types/balance-update.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 BalanceUpdate */ interface BalanceUpdate { /** * Event Time * @type {number | bigint} * @memberof BalanceUpdate */ E?: number | bigint; /** * Asset * @type {string} * @memberof BalanceUpdate */ a?: string; /** * Balance Delta * @type {string} * @memberof BalanceUpdate */ d?: string; /** * Clear Time * @type {number | bigint} * @memberof BalanceUpdate */ T?: number | bigint; } //#endregion //#region src/websocket-streams/types/block-trade-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 BlockTradeResponse */ interface BlockTradeResponse { /** * Event type * @type {string} * @memberof BlockTradeResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof BlockTradeResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof BlockTradeResponse */ s?: string; /** * Block Trade ID * @type {number | bigint} * @memberof BlockTradeResponse */ t?: number | bigint; /** * Price * @type {string} * @memberof BlockTradeResponse */ p?: string; /** * Quantity * @type {string} * @memberof BlockTradeResponse */ q?: string; /** * Trade time * @type {number | bigint} * @memberof BlockTradeResponse */ T?: number | bigint; /** * Is the buyer the maker? * @type {boolean} * @memberof BlockTradeResponse */ m?: boolean; } //#endregion //#region src/websocket-streams/types/book-ticker-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 BookTickerResponse */ interface BookTickerResponse { /** * Order book updateId * @type {number | bigint} * @memberof BookTickerResponse */ u?: number | bigint; /** * Symbol * @type {string} * @memberof BookTickerResponse */ s?: string; /** * Best bid price * @type {string} * @memberof BookTickerResponse */ b?: string; /** * Best bid qty * @type {string} * @memberof BookTickerResponse */ B?: string; /** * Best ask price * @type {string} * @memberof BookTickerResponse */ a?: string; /** * Best ask qty * @type {string} * @memberof BookTickerResponse */ A?: string; } //#endregion //#region src/websocket-streams/types/diff-book-depth-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 DiffBookDepthResponse */ interface DiffBookDepthResponse { /** * Event type * @type {string} * @memberof DiffBookDepthResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof DiffBookDepthResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof DiffBookDepthResponse */ s?: string; /** * First update ID in event * @type {number | bigint} * @memberof DiffBookDepthResponse */ U?: number | bigint; /** * Final update ID in event * @type {number | bigint} * @memberof DiffBookDepthResponse */ u?: number | bigint; /** * Bids to be updated * @type {Array>} * @memberof DiffBookDepthResponse */ b?: Array>; /** * Asks to be updated * @type {Array>} * @memberof DiffBookDepthResponse */ a?: Array>; } //#endregion //#region src/websocket-streams/types/event-stream-terminated.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 EventStreamTerminated */ interface EventStreamTerminated { /** * Event Time * @type {number | bigint} * @memberof EventStreamTerminated */ E?: number | bigint; } //#endregion //#region src/websocket-streams/types/execution-report.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExecutionReport */ interface ExecutionReport { /** * Event time * @type {number | bigint} * @memberof ExecutionReport */ E?: number | bigint; /** * Symbol * @type {string} * @memberof ExecutionReport */ s?: string; /** * Client order ID * @type {string} * @memberof ExecutionReport */ c?: string; /** * Side * @type {string} * @memberof ExecutionReport */ S?: string; /** * Order type * @type {string} * @memberof ExecutionReport */ o?: string; /** * Time in force * @type {string} * @memberof ExecutionReport */ f?: string; /** * Order quantity * @type {string} * @memberof ExecutionReport */ q?: string; /** * Order price * @type {string} * @memberof ExecutionReport */ p?: string; /** * Stop price * @type {string} * @memberof ExecutionReport */ P?: string; /** * Iceberg quantity * @type {string} * @memberof ExecutionReport */ F?: string; /** * OrderListId * @type {number | bigint} * @memberof ExecutionReport */ g?: number | bigint; /** * Original client order ID; This is the ID of the order being canceled * @type {string} * @memberof ExecutionReport */ C?: string; /** * Current execution type * @type {string} * @memberof ExecutionReport */ x?: string; /** * Current order status * @type {string} * @memberof ExecutionReport */ X?: string; /** * Order reject reason; Please see Order Reject Reason for more information. * @type {string} * @memberof ExecutionReport */ r?: string; /** * Order ID * @type {number | bigint} * @memberof ExecutionReport */ i?: number | bigint; /** * Last executed quantity * @type {string} * @memberof ExecutionReport */ l?: string; /** * Cumulative filled quantity * @type {string} * @memberof ExecutionReport */ z?: string; /** * Last executed price * @type {string} * @memberof ExecutionReport */ L?: string; /** * Commission amount * @type {string} * @memberof ExecutionReport */ n?: string; /** * Commission asset * @type {string} * @memberof ExecutionReport */ N?: string; /** * Transaction time * @type {number | bigint} * @memberof ExecutionReport */ T?: number | bigint; /** * Trade ID * @type {number | bigint} * @memberof ExecutionReport */ t?: number | bigint; /** * Prevented Match Id; This is only visible if the order expired due to STP * @type {number | bigint} * @memberof ExecutionReport */ v?: number | bigint; /** * Execution Id * @type {number | bigint} * @memberof ExecutionReport */ I?: number | bigint; /** * Is the order on the book? * @type {boolean} * @memberof ExecutionReport */ w?: boolean; /** * Is this trade the maker side? * @type {boolean} * @memberof ExecutionReport */ m?: boolean; /** * Ignore * @type {boolean} * @memberof ExecutionReport */ M?: boolean; /** * Order creation time * @type {number | bigint} * @memberof ExecutionReport */ O?: number | bigint; /** * Cumulative quote asset transacted quantity * @type {string} * @memberof ExecutionReport */ Z?: string; /** * Last quote asset transacted quantity (i.e. lastPrice * lastQty) * @type {string} * @memberof ExecutionReport */ Y?: string; /** * Quote Order Quantity * @type {string} * @memberof ExecutionReport */ Q?: string; /** * Working Time; This is only visible if the order has been placed on the book. * @type {number | bigint} * @memberof ExecutionReport */ W?: number | bigint; /** * SelfTradePreventionMode * @type {string} * @memberof ExecutionReport */ V?: string; /** * Trailing Delta * @type {number | bigint} * @memberof ExecutionReport */ d?: number | bigint; /** * Trailing Time * @type {number | bigint} * @memberof ExecutionReport */ D?: number | bigint; /** * Strategy Id * @type {number | bigint} * @memberof ExecutionReport */ j?: number | bigint; /** * Strategy Type * @type {number | bigint} * @memberof ExecutionReport */ J?: number | bigint; /** * Prevented Quantity * @type {string} * @memberof ExecutionReport */ A?: string; /** * Last Prevented Quantity * @type {string} * @memberof ExecutionReport */ B?: string; /** * Trade Group Id * @type {number | bigint} * @memberof ExecutionReport */ u?: number | bigint; /** * Counter Order Id * @type {number | bigint} * @memberof ExecutionReport */ U?: number | bigint; /** * Counter Symbol * @type {string} * @memberof ExecutionReport */ Cs?: string; /** * Prevented Execution Quantity * @type {string} * @memberof ExecutionReport */ pl?: string; /** * Prevented Execution Price * @type {string} * @memberof ExecutionReport */ pL?: string; /** * Prevented Execution Quote Qty * @type {string} * @memberof ExecutionReport */ pY?: string; /** * Match Type * @type {string} * @memberof ExecutionReport */ b?: string; /** * Allocation ID * @type {number | bigint} * @memberof ExecutionReport */ a?: number | bigint; /** * Working Floor * @type {string} * @memberof ExecutionReport */ k?: string; /** * UsedSor * @type {boolean} * @memberof ExecutionReport */ uS?: boolean; /** * Pegged Price Type * @type {string} * @memberof ExecutionReport */ gP?: string; /** * Pegged Offset Type * @type {string} * @memberof ExecutionReport */ gOT?: string; /** * Pegged Offset Value * @type {number | bigint} * @memberof ExecutionReport */ gOV?: number | bigint; /** * Pegged Price * @type {string} * @memberof ExecutionReport */ gp?: string; /** * Expiry Reason. Appears when the order has expired. * @type {string} * @memberof ExecutionReport */ eR?: string; } //#endregion //#region src/websocket-streams/types/external-lock-update.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ExternalLockUpdate */ interface ExternalLockUpdate { /** * Event Time * @type {number | bigint} * @memberof ExternalLockUpdate */ E?: number | bigint; /** * Asset * @type {string} * @memberof ExternalLockUpdate */ a?: string; /** * Delta * @type {string} * @memberof ExternalLockUpdate */ d?: string; /** * Transaction Time * @type {number | bigint} * @memberof ExternalLockUpdate */ T?: number | bigint; } //#endregion //#region src/websocket-streams/types/kline-response-k.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Kline payload * @export * @interface KlineResponseK */ interface KlineResponseK { /** * Kline start time * @type {number | bigint} * @memberof KlineResponseK */ t?: number | bigint; /** * Kline close time * @type {number | bigint} * @memberof KlineResponseK */ T?: number | bigint; /** * Symbol * @type {string} * @memberof KlineResponseK */ s?: string; /** * Interval * @type {string} * @memberof KlineResponseK */ i?: string; /** * First trade ID * @type {number | bigint} * @memberof KlineResponseK */ f?: number | bigint; /** * Last trade ID * @type {number | bigint} * @memberof KlineResponseK */ L?: number | bigint; /** * Open price * @type {string} * @memberof KlineResponseK */ o?: string; /** * Close price * @type {string} * @memberof KlineResponseK */ c?: string; /** * High price * @type {string} * @memberof KlineResponseK */ h?: string; /** * Low price * @type {string} * @memberof KlineResponseK */ l?: string; /** * Base asset volume * @type {string} * @memberof KlineResponseK */ v?: string; /** * Number of trades * @type {number | bigint} * @memberof KlineResponseK */ n?: number | bigint; /** * Is this kline closed? * @type {boolean} * @memberof KlineResponseK */ x?: boolean; /** * Quote asset volume * @type {string} * @memberof KlineResponseK */ q?: string; /** * Taker buy base asset volume * @type {string} * @memberof KlineResponseK */ V?: string; /** * Taker buy quote asset volume * @type {string} * @memberof KlineResponseK */ Q?: string; /** * Ignore * @type {string} * @memberof KlineResponseK */ B?: string; } //#endregion //#region src/websocket-streams/types/kline-offset-response.d.ts /** * * @export * @interface KlineOffsetResponse */ interface KlineOffsetResponse { /** * Event type * @type {string} * @memberof KlineOffsetResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof KlineOffsetResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof KlineOffsetResponse */ s?: string; /** * * @type {KlineResponseK} * @memberof KlineOffsetResponse */ k?: KlineResponseK; } //#endregion //#region src/websocket-streams/types/kline-response.d.ts /** * * @export * @interface KlineResponse */ interface KlineResponse { /** * Event type * @type {string} * @memberof KlineResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof KlineResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof KlineResponse */ s?: string; /** * * @type {KlineResponseK} * @memberof KlineResponse */ k?: KlineResponseK; } //#endregion //#region src/websocket-streams/types/list-status-oinner.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ListStatusOInner */ interface ListStatusOInner { /** * Symbol * @type {string} * @memberof ListStatusOInner */ s?: string; /** * OrderId * @type {number | bigint} * @memberof ListStatusOInner */ i?: number | bigint; /** * ClientOrderId * @type {string} * @memberof ListStatusOInner */ c?: string; } //#endregion //#region src/websocket-streams/types/list-status.d.ts /** * * @export * @interface ListStatus */ interface ListStatus { /** * Event Time * @type {number | bigint} * @memberof ListStatus */ E?: number | bigint; /** * Symbol * @type {string} * @memberof ListStatus */ s?: string; /** * OrderListId * @type {number | bigint} * @memberof ListStatus */ g?: number | bigint; /** * Contingency Type * @type {string} * @memberof ListStatus */ c?: string; /** * List Status Type * @type {string} * @memberof ListStatus */ l?: string; /** * List Order Status * @type {string} * @memberof ListStatus */ L?: string; /** * List Reject Reason * @type {string} * @memberof ListStatus */ r?: string; /** * List Client Order ID * @type {string} * @memberof ListStatus */ C?: string; /** * Transaction Time * @type {number | bigint} * @memberof ListStatus */ T?: number | bigint; /** * An array of objects * @type {Array} * @memberof ListStatus */ O?: Array; } //#endregion //#region src/websocket-streams/types/mini-ticker-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 MiniTickerResponse */ interface MiniTickerResponse { /** * Event type * @type {string} * @memberof MiniTickerResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof MiniTickerResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof MiniTickerResponse */ s?: string; /** * Close price * @type {string} * @memberof MiniTickerResponse */ c?: string; /** * Open price * @type {string} * @memberof MiniTickerResponse */ o?: string; /** * High price * @type {string} * @memberof MiniTickerResponse */ h?: string; /** * Low price * @type {string} * @memberof MiniTickerResponse */ l?: string; /** * Total traded base asset volume * @type {string} * @memberof MiniTickerResponse */ v?: string; /** * Total traded quote asset volume * @type {string} * @memberof MiniTickerResponse */ q?: string; } //#endregion //#region src/websocket-streams/types/outbound-account-position-binner.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 OutboundAccountPositionBInner */ interface OutboundAccountPositionBInner { /** * Asset * @type {string} * @memberof OutboundAccountPositionBInner */ a?: string; /** * Free * @type {string} * @memberof OutboundAccountPositionBInner */ f?: string; /** * Locked * @type {string} * @memberof OutboundAccountPositionBInner */ l?: string; } //#endregion //#region src/websocket-streams/types/outbound-account-position.d.ts /** * * @export * @interface OutboundAccountPosition */ interface OutboundAccountPosition { /** * Event Time * @type {number | bigint} * @memberof OutboundAccountPosition */ E?: number | bigint; /** * Time of last account update * @type {number | bigint} * @memberof OutboundAccountPosition */ u?: number | bigint; /** * Balances Array * @type {Array} * @memberof OutboundAccountPosition */ B?: Array; } //#endregion //#region src/websocket-streams/types/partial-book-depth-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 PartialBookDepthResponse */ interface PartialBookDepthResponse { /** * Last update ID * @type {number | bigint} * @memberof PartialBookDepthResponse */ lastUpdateId?: number | bigint; /** * Bids to be updated * @type {Array>} * @memberof PartialBookDepthResponse */ bids?: Array>; /** * Asks to be updated * @type {Array>} * @memberof PartialBookDepthResponse */ asks?: Array>; } //#endregion //#region src/websocket-streams/types/reference-price-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 ReferencePriceResponse */ interface ReferencePriceResponse { /** * Event type * @type {string} * @memberof ReferencePriceResponse */ e?: string; /** * Symbol * @type {string} * @memberof ReferencePriceResponse */ s?: string; /** * Reference price (null if no reference price) * @type {string} * @memberof ReferencePriceResponse */ r?: string; /** * Engine timestamp when reference price was valid * @type {number | bigint} * @memberof ReferencePriceResponse */ t?: number | bigint; } //#endregion //#region src/websocket-streams/types/rolling-window-ticker-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 RollingWindowTickerResponse */ interface RollingWindowTickerResponse { /** * Event type * @type {string} * @memberof RollingWindowTickerResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof RollingWindowTickerResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof RollingWindowTickerResponse */ s?: string; /** * Price change * @type {string} * @memberof RollingWindowTickerResponse */ p?: string; /** * Price change percent * @type {string} * @memberof RollingWindowTickerResponse */ P?: string; /** * Open price * @type {string} * @memberof RollingWindowTickerResponse */ o?: string; /** * High price * @type {string} * @memberof RollingWindowTickerResponse */ h?: string; /** * Low price * @type {string} * @memberof RollingWindowTickerResponse */ l?: string; /** * Last price * @type {string} * @memberof RollingWindowTickerResponse */ c?: string; /** * Weighted average price * @type {string} * @memberof RollingWindowTickerResponse */ w?: string; /** * Total traded base asset volume * @type {string} * @memberof RollingWindowTickerResponse */ v?: string; /** * Total traded quote asset volume * @type {string} * @memberof RollingWindowTickerResponse */ q?: string; /** * Statistics open time * @type {number | bigint} * @memberof RollingWindowTickerResponse */ O?: number | bigint; /** * Statistics close time * @type {number | bigint} * @memberof RollingWindowTickerResponse */ C?: number | bigint; /** * First trade ID * @type {number | bigint} * @memberof RollingWindowTickerResponse */ F?: number | bigint; /** * Last trade Id * @type {number | bigint} * @memberof RollingWindowTickerResponse */ L?: number | bigint; /** * Total number of trades * @type {number | bigint} * @memberof RollingWindowTickerResponse */ n?: number | bigint; } //#endregion //#region src/websocket-streams/types/ticker-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TickerResponse */ interface TickerResponse { /** * Event type * @type {string} * @memberof TickerResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof TickerResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof TickerResponse */ s?: string; /** * Price change * @type {string} * @memberof TickerResponse */ p?: string; /** * Price change percent * @type {string} * @memberof TickerResponse */ P?: string; /** * Weighted average price * @type {string} * @memberof TickerResponse */ w?: string; /** * First trade(F)-1 price (first trade before the 24hr rolling window) * @type {string} * @memberof TickerResponse */ x?: string; /** * Last price * @type {string} * @memberof TickerResponse */ c?: string; /** * Last quantity * @type {string} * @memberof TickerResponse */ Q?: string; /** * Best bid price * @type {string} * @memberof TickerResponse */ b?: string; /** * Best bid quantity * @type {string} * @memberof TickerResponse */ B?: string; /** * Best ask price * @type {string} * @memberof TickerResponse */ a?: string; /** * Best ask quantity * @type {string} * @memberof TickerResponse */ A?: string; /** * Open price * @type {string} * @memberof TickerResponse */ o?: string; /** * High price * @type {string} * @memberof TickerResponse */ h?: string; /** * Low price * @type {string} * @memberof TickerResponse */ l?: string; /** * Total traded base asset volume * @type {string} * @memberof TickerResponse */ v?: string; /** * Total traded quote asset volume * @type {string} * @memberof TickerResponse */ q?: string; /** * Statistics open time * @type {number | bigint} * @memberof TickerResponse */ O?: number | bigint; /** * Statistics close time * @type {number | bigint} * @memberof TickerResponse */ C?: number | bigint; /** * First trade ID * @type {number | bigint} * @memberof TickerResponse */ F?: number | bigint; /** * Last trade Id * @type {number | bigint} * @memberof TickerResponse */ L?: number | bigint; /** * Total number of trades * @type {number | bigint} * @memberof TickerResponse */ n?: number | bigint; } //#endregion //#region src/websocket-streams/types/trade-response.d.ts /** * Spot WebSocket Market Streams * * Access market data, manage accounts, and trade on Binance Spot. * * 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 TradeResponse */ interface TradeResponse { /** * Event type * @type {string} * @memberof TradeResponse */ e?: string; /** * Event time * @type {number | bigint} * @memberof TradeResponse */ E?: number | bigint; /** * Symbol * @type {string} * @memberof TradeResponse */ s?: string; /** * Trade ID * @type {number | bigint} * @memberof TradeResponse */ t?: number | bigint; /** * Price * @type {string} * @memberof TradeResponse */ p?: string; /** * Quantity * @type {string} * @memberof TradeResponse */ q?: string; /** * Trade time * @type {number | bigint} * @memberof TradeResponse */ T?: number | bigint; /** * Is the buyer the market maker? * @type {boolean} * @memberof TradeResponse */ m?: boolean; /** * Ignore * @type {boolean} * @memberof TradeResponse */ M?: boolean; } //#endregion //#region src/websocket-streams/types/user-data-stream-events-response.d.ts /** * @type UserDataStreamEventsResponse */ type UserDataStreamEventsResponse = ({ e: 'balanceUpdate'; } & BalanceUpdate) | ({ e: 'eventStreamTerminated'; } & EventStreamTerminated) | ({ e: 'executionReport'; } & ExecutionReport) | ({ e: 'externalLockUpdate'; } & ExternalLockUpdate) | ({ e: 'listStatus'; } & ListStatus) | ({ e: 'outboundAccountPosition'; } & OutboundAccountPosition); //#endregion //#region src/websocket-streams/modules/api.d.ts /** * Api - interface * @interface Api */ interface ApiInterface { /** * The Aggregate Trade Streams push trade information that is aggregated * for a single taker order. * * Update Speed: Real-time * * @summary Aggregate Trade Streams * @param {AggTradeRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ aggTrade(requestParameters: AggTradeRequest): WebsocketStream; /** * Rolling window ticker statistics for all market symbols, computed over * multiple windows. * * Note that only tickers that have changed will be present in the array. * * Update Speed: 1000ms * * @summary All Market Rolling Window Statistics Streams * @param {AllMarketRollingWindowTickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ allMarketRollingWindowTicker(requestParameters: AllMarketRollingWindowTickerRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics for all symbols that changed * in an array. These are NOT the statistics of the UTC day, but a 24hr * rolling window for the previous 24hrs. Note that only tickers that have * changed will be present in the array. * * Update Speed: 1000ms * * @summary All Market Mini Tickers Stream * @param {AllMiniTickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ allMiniTicker(requestParameters?: AllMiniTickerRequest): WebsocketStream; /** * Average price streams push changes in the average price over a fixed time interval. * * Update Speed: 1000ms * * @summary Average Price * @param {AvgPriceRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ avgPrice(requestParameters: AvgPriceRequest): WebsocketStream; /** * Block Trade Streams push block trade information in real-time. * * Update Speed: Real-time * * @summary Block Trade Streams * @param {BlockTradeRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ blockTrade(requestParameters: BlockTradeRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in * real-time for a specified symbol. * * Multiple `@bookTicker` streams can be subscribed to over one * connection. * * Update Speed: Real-time * * @summary Individual Symbol Book Ticker Streams * @param {BookTickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ bookTicker(requestParameters: BookTickerRequest): WebsocketStream; /** * Order book price and quantity depth updates used to locally manage an order book. * * Update Speed: 1000ms or 100ms * * @summary Diff. Depth Stream * @param {DiffBookDepthRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ diffBookDepth(requestParameters: DiffBookDepthRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current * klines/candlestick every second in `UTC+0` timezone * * Update Speed: 1000ms for `1s`, 2000ms for the other intervals * * @summary Kline/Candlestick Streams for UTC * @param {KlineRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ kline(requestParameters: KlineRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current * klines/candlestick every second in `UTC+8` timezone * **Kline/Candlestick chart intervals:** * * Supported intervals: See Kline/Candlestick chart intervals * **UTC+8 timezone offset:** * - Kline intervals open and close in the UTC+8 timezone. For example the 1d klines will open at the beginning of the UTC+8 day, and close at the end of the UTC+8 day. * - Note that E (event time), t (start time) and T (close time) in the payload are Unix timestamps, which are always interpreted in UTC. * * Update Speed: 1000ms for `1s`, 2000ms for the other intervals * * @summary Kline/Candlestick Streams with timezone offset * @param {KlineOffsetRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ klineOffset(requestParameters: KlineOffsetRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics. These are NOT the statistics * of the UTC day, but a 24hr rolling window for the previous 24hrs. * * Update Speed: 1000ms * * @summary Individual Symbol Mini Ticker Stream * @param {MiniTickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ miniTicker(requestParameters: MiniTickerRequest): WebsocketStream; /** * Top **\** bids and asks, pushed every second. * * Update Speed: 1000ms or 100ms * * @summary WebSocket Partial Book Depth Streams * @param {PartialBookDepthRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ partialBookDepth(requestParameters: PartialBookDepthRequest): WebsocketStream; /** * Reference price stream for a symbol. * * Update Speed: 1000ms * * @summary Reference Price Streams * @param {ReferencePriceRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ referencePrice(requestParameters: ReferencePriceRequest): WebsocketStream; /** * Rolling window ticker statistics for a single symbol, computed over * multiple windows. * **Note:** This stream is different from the `@ticker` stream. The open time `"O"` always starts on a minute, while the closing time `"C"` is the current time * of the update. As such, the effective window might be up to 59999ms wider than ``. * * Update Speed: 1000ms * * @summary Individual Symbol Rolling Window Statistics Streams * @param {RollingWindowTickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ rollingWindowTicker(requestParameters: RollingWindowTickerRequest): WebsocketStream; /** * 24hr rolling window ticker statistics for a single symbol. These are NOT * the statistics of the UTC day, but a 24hr rolling window for the * previous 24hrs. * * Update Speed: 1000ms * * @summary Individual Symbol Ticker Streams * @param {TickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ ticker(requestParameters: TickerRequest): WebsocketStream; /** * The Trade Streams push raw trade information; each trade has a unique * buyer and seller. * * Update Speed: Real-time * * @summary Trade Streams * @param {TradeRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @memberof ApiInterface */ trade(requestParameters: TradeRequest): WebsocketStream; } /** * Request parameters for aggTrade operation in Api. * @interface AggTradeRequest */ interface AggTradeRequest { /** * Symbol to query * @type {string} * @memberof ApiAggTrade */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiAggTrade */ readonly id?: string; } /** * Request parameters for allMarketRollingWindowTicker operation in Api. * @interface AllMarketRollingWindowTickerRequest */ interface AllMarketRollingWindowTickerRequest { /** * * @type {'1h' | '4h' | '1d'} * @memberof ApiAllMarketRollingWindowTicker */ readonly windowSize: AllMarketRollingWindowTickerWindowSizeEnum; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiAllMarketRollingWindowTicker */ readonly id?: string; } /** * Request parameters for allMiniTicker operation in Api. * @interface AllMiniTickerRequest */ interface AllMiniTickerRequest { /** * Unique WebSocket request ID. * @type {string} * @memberof ApiAllMiniTicker */ readonly id?: string; } /** * Request parameters for avgPrice operation in Api. * @interface AvgPriceRequest */ interface AvgPriceRequest { /** * Symbol to query * @type {string} * @memberof ApiAvgPrice */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiAvgPrice */ readonly id?: string; } /** * Request parameters for blockTrade operation in Api. * @interface BlockTradeRequest */ interface BlockTradeRequest { /** * Symbol to query * @type {string} * @memberof ApiBlockTrade */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiBlockTrade */ readonly id?: string; } /** * Request parameters for bookTicker operation in Api. * @interface BookTickerRequest */ interface BookTickerRequest { /** * Symbol to query * @type {string} * @memberof ApiBookTicker */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiBookTicker */ readonly id?: string; } /** * Request parameters for diffBookDepth operation in Api. * @interface DiffBookDepthRequest */ interface DiffBookDepthRequest { /** * Symbol to query * @type {string} * @memberof ApiDiffBookDepth */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiDiffBookDepth */ readonly id?: string; /** * Optional stream update speed suffix * @type {'100ms'} * @memberof ApiDiffBookDepth */ readonly updateSpeed?: DiffBookDepthUpdateSpeedEnum; } /** * Request parameters for kline operation in Api. * @interface KlineRequest */ interface KlineRequest { /** * Symbol to query * @type {string} * @memberof ApiKline */ readonly symbol: string; /** * * @type {'1s' | '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof ApiKline */ readonly interval: KlineIntervalEnum; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiKline */ readonly id?: string; } /** * Request parameters for klineOffset operation in Api. * @interface KlineOffsetRequest */ interface KlineOffsetRequest { /** * Symbol to query * @type {string} * @memberof ApiKlineOffset */ readonly symbol: string; /** * * @type {'1s' | '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'} * @memberof ApiKlineOffset */ readonly interval: KlineOffsetIntervalEnum; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiKlineOffset */ readonly id?: string; } /** * Request parameters for miniTicker operation in Api. * @interface MiniTickerRequest */ interface MiniTickerRequest { /** * Symbol to query * @type {string} * @memberof ApiMiniTicker */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiMiniTicker */ readonly id?: string; } /** * Request parameters for partialBookDepth operation in Api. * @interface PartialBookDepthRequest */ interface PartialBookDepthRequest { /** * Symbol to query * @type {string} * @memberof ApiPartialBookDepth */ readonly symbol: string; /** * * @type {'5' | '10' | '20'} * @memberof ApiPartialBookDepth */ readonly levels: PartialBookDepthLevelsEnum; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiPartialBookDepth */ readonly id?: string; /** * Optional stream update speed suffix * @type {'100ms'} * @memberof ApiPartialBookDepth */ readonly updateSpeed?: PartialBookDepthUpdateSpeedEnum; } /** * Request parameters for referencePrice operation in Api. * @interface ReferencePriceRequest */ interface ReferencePriceRequest { /** * Symbol to query * @type {string} * @memberof ApiReferencePrice */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiReferencePrice */ readonly id?: string; } /** * Request parameters for rollingWindowTicker operation in Api. * @interface RollingWindowTickerRequest */ interface RollingWindowTickerRequest { /** * Symbol to query * @type {string} * @memberof ApiRollingWindowTicker */ readonly symbol: string; /** * * @type {'1h' | '4h' | '1d'} * @memberof ApiRollingWindowTicker */ readonly windowSize: RollingWindowTickerWindowSizeEnum; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiRollingWindowTicker */ readonly id?: string; } /** * Request parameters for ticker operation in Api. * @interface TickerRequest */ interface TickerRequest { /** * Symbol to query * @type {string} * @memberof ApiTicker */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiTicker */ readonly id?: string; } /** * Request parameters for trade operation in Api. * @interface TradeRequest */ interface TradeRequest { /** * Symbol to query * @type {string} * @memberof ApiTrade */ readonly symbol: string; /** * Unique WebSocket request ID. * @type {string} * @memberof ApiTrade */ readonly id?: string; } /** * Api - interface * @class Api * @extends {WebsocketStreamsBase} */ declare class Api implements ApiInterface { private readonly websocketBase; private localVarParamCreator; constructor(websocketBase: WebsocketStreamsBase); /** * The Aggregate Trade Streams push trade information that is aggregated * for a single taker order. * * Update Speed: Real-time * * @summary Aggregate Trade Streams * @param {AggTradeRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#agg-trade Binance API Documentation} */ aggTrade(requestParameters: AggTradeRequest): WebsocketStream; /** * Rolling window ticker statistics for all market symbols, computed over * multiple windows. * * Note that only tickers that have changed will be present in the array. * * Update Speed: 1000ms * * @summary All Market Rolling Window Statistics Streams * @param {AllMarketRollingWindowTickerRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#all-market-rolling-window-ticker Binance API Documentation} */ allMarketRollingWindowTicker(requestParameters: AllMarketRollingWindowTickerRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics for all symbols that changed * in an array. These are NOT the statistics of the UTC day, but a 24hr * rolling window for the previous 24hrs. Note that only tickers that have * changed will be present in the array. * * Update Speed: 1000ms * * @summary All Market Mini Tickers Stream * @param {AllMiniTickerRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#all-mini-ticker Binance API Documentation} */ allMiniTicker(requestParameters?: AllMiniTickerRequest): WebsocketStream; /** * Average price streams push changes in the average price over a fixed time interval. * * Update Speed: 1000ms * * @summary Average Price * @param {AvgPriceRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#avg-price Binance API Documentation} */ avgPrice(requestParameters: AvgPriceRequest): WebsocketStream; /** * Block Trade Streams push block trade information in real-time. * * Update Speed: Real-time * * @summary Block Trade Streams * @param {BlockTradeRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#block-trade Binance API Documentation} */ blockTrade(requestParameters: BlockTradeRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in * real-time for a specified symbol. * * Multiple `@bookTicker` streams can be subscribed to over one * connection. * * Update Speed: Real-time * * @summary Individual Symbol Book Ticker Streams * @param {BookTickerRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#book-ticker Binance API Documentation} */ bookTicker(requestParameters: BookTickerRequest): WebsocketStream; /** * Order book price and quantity depth updates used to locally manage an order book. * * Update Speed: 1000ms or 100ms * * @summary Diff. Depth Stream * @param {DiffBookDepthRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#diff-book-depth Binance API Documentation} */ diffBookDepth(requestParameters: DiffBookDepthRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current * klines/candlestick every second in `UTC+0` timezone * * Update Speed: 1000ms for `1s`, 2000ms for the other intervals * * @summary Kline/Candlestick Streams for UTC * @param {KlineRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#kline Binance API Documentation} */ kline(requestParameters: KlineRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current * klines/candlestick every second in `UTC+8` timezone * **Kline/Candlestick chart intervals:** * * Supported intervals: See Kline/Candlestick chart intervals * **UTC+8 timezone offset:** * - Kline intervals open and close in the UTC+8 timezone. For example the 1d klines will open at the beginning of the UTC+8 day, and close at the end of the UTC+8 day. * - Note that E (event time), t (start time) and T (close time) in the payload are Unix timestamps, which are always interpreted in UTC. * * Update Speed: 1000ms for `1s`, 2000ms for the other intervals * * @summary Kline/Candlestick Streams with timezone offset * @param {KlineOffsetRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#kline-offset Binance API Documentation} */ klineOffset(requestParameters: KlineOffsetRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics. These are NOT the statistics * of the UTC day, but a 24hr rolling window for the previous 24hrs. * * Update Speed: 1000ms * * @summary Individual Symbol Mini Ticker Stream * @param {MiniTickerRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#mini-ticker Binance API Documentation} */ miniTicker(requestParameters: MiniTickerRequest): WebsocketStream; /** * Top **\** bids and asks, pushed every second. * * Update Speed: 1000ms or 100ms * * @summary WebSocket Partial Book Depth Streams * @param {PartialBookDepthRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#partial-book-depth Binance API Documentation} */ partialBookDepth(requestParameters: PartialBookDepthRequest): WebsocketStream; /** * Reference price stream for a symbol. * * Update Speed: 1000ms * * @summary Reference Price Streams * @param {ReferencePriceRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#reference-price Binance API Documentation} */ referencePrice(requestParameters: ReferencePriceRequest): WebsocketStream; /** * Rolling window ticker statistics for a single symbol, computed over * multiple windows. * **Note:** This stream is different from the `@ticker` stream. The open time `"O"` always starts on a minute, while the closing time `"C"` is the current time * of the update. As such, the effective window might be up to 59999ms wider than ``. * * Update Speed: 1000ms * * @summary Individual Symbol Rolling Window Statistics Streams * @param {RollingWindowTickerRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#rolling-window-ticker Binance API Documentation} */ rollingWindowTicker(requestParameters: RollingWindowTickerRequest): WebsocketStream; /** * 24hr rolling window ticker statistics for a single symbol. These are NOT * the statistics of the UTC day, but a 24hr rolling window for the * previous 24hrs. * * Update Speed: 1000ms * * @summary Individual Symbol Ticker Streams * @param {TickerRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#ticker Binance API Documentation} */ ticker(requestParameters: TickerRequest): WebsocketStream; /** * The Trade Streams push raw trade information; each trade has a unique * buyer and seller. * * Update Speed: Real-time * * @summary Trade Streams * @param {TradeRequest} requestParameters Request parameters. * @returns {WebsocketStream} * @throws {RequiredError} * @memberof Api * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#trade Binance API Documentation} */ trade(requestParameters: TradeRequest): WebsocketStream; } declare enum AllMarketRollingWindowTickerWindowSizeEnum { WINDOW_SIZE_1h = "1h", WINDOW_SIZE_4h = "4h", WINDOW_SIZE_1d = "1d", } declare enum DiffBookDepthUpdateSpeedEnum { UPDATE_SPEED_100ms = "100ms", } declare enum KlineIntervalEnum { INTERVAL_1s = "1s", INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum KlineOffsetIntervalEnum { INTERVAL_1s = "1s", INTERVAL_1m = "1m", INTERVAL_3m = "3m", INTERVAL_5m = "5m", INTERVAL_15m = "15m", INTERVAL_30m = "30m", INTERVAL_1h = "1h", INTERVAL_2h = "2h", INTERVAL_4h = "4h", INTERVAL_6h = "6h", INTERVAL_8h = "8h", INTERVAL_12h = "12h", INTERVAL_1d = "1d", INTERVAL_3d = "3d", INTERVAL_1w = "1w", INTERVAL_1M = "1M", } declare enum PartialBookDepthLevelsEnum { LEVELS_5 = "5", LEVELS_10 = "10", LEVELS_20 = "20", } declare enum PartialBookDepthUpdateSpeedEnum { UPDATE_SPEED_100ms = "100ms", } declare enum RollingWindowTickerWindowSizeEnum { WINDOW_SIZE_1h = "1h", WINDOW_SIZE_4h = "4h", WINDOW_SIZE_1d = "1d", } //#endregion //#region src/websocket-streams/websocket-streams-connection.d.ts declare class WebsocketStreamsConnection { private websocketBase; private api; constructor(websocketBase: WebsocketStreamsBase); /** * Adds an event listener for the specified WebSocket event. * @param event - The WebSocket event to listen for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'. * @param listener - The callback function to be executed when the event is triggered. The function can accept any number of arguments. */ on(event: 'open' | 'message' | 'error' | 'close' | 'ping' | 'pong', listener: (...args: any[]) => void): void; /** * Removes an event listener for the specified WebSocket event. * @param event - The WebSocket event to stop listening for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'. * @param listener - The callback function that was previously added as the event listener. */ off(event: 'open' | 'message' | 'error' | 'close' | 'ping' | 'pong', listener: (...args: any[]) => void): void; /** * Disconnects from the WebSocket server. * If there is no active connection, a warning is logged. * Otherwise, all connections in the connection pool are closed gracefully, * and a message is logged indicating that the connection has been disconnected. * @returns A Promise that resolves when all connections have been closed. * @throws Error if the WebSocket client is not set. */ disconnect(): Promise; /** * Checks if the WebSocket connection is currently open. * @returns `true` if the connection is open, `false` otherwise. */ isConnected(): boolean; /** * Sends a ping message to all connected Websocket servers in the pool. * If no connections are ready, a warning is logged. * For each active connection, the ping message is sent, and debug logs provide details. * @throws Error if a Websocket client is not set for a connection. */ pingServer(): void; /** * Subscribes to one or multiple WebSocket streams * Handles both single and pool modes * @param stream Single stream name or array of stream names to subscribe to * @param id Optional subscription ID * @returns void */ subscribe(stream: string | string[], id?: string): void; /** * Unsubscribes from one or multiple WebSocket streams * Handles both single and pool modes * @param stream Single stream name or array of stream names to unsubscribe from * @param id Optional unsubscription ID * @returns void */ unsubscribe(stream: string | string[], id?: string): void; /** * Checks if the WebSocket connection is subscribed to the specified stream. * @param stream The name of the WebSocket stream to check. * @returns `true` if the connection is subscribed to the stream, `false` otherwise. */ isSubscribed(stream: string): boolean; /** * Subscribes to the user data WebSocket stream using the provided listen key. * @param listenKey - The listen key for the user data WebSocket stream. * @param id - Optional user data stream ID * @returns A WebSocket stream handler for the user data stream. */ userData(listenKey: string, id?: string): WebsocketStream; /** * The Aggregate Trade Streams push trade information that is aggregated * for a single taker order. * * Update Speed: Real-time * * @summary Aggregate Trade Streams * @param {AggTradeRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#agg-trade Binance API Documentation} */ aggTrade(requestParameters: AggTradeRequest): WebsocketStream; /** * Rolling window ticker statistics for all market symbols, computed over * multiple windows. * * Note that only tickers that have changed will be present in the array. * * Update Speed: 1000ms * * @summary All Market Rolling Window Statistics Streams * @param {AllMarketRollingWindowTickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#all-market-rolling-window-ticker Binance API Documentation} */ allMarketRollingWindowTicker(requestParameters: AllMarketRollingWindowTickerRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics for all symbols that changed * in an array. These are NOT the statistics of the UTC day, but a 24hr * rolling window for the previous 24hrs. Note that only tickers that have * changed will be present in the array. * * Update Speed: 1000ms * * @summary All Market Mini Tickers Stream * @param {AllMiniTickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#all-mini-ticker Binance API Documentation} */ allMiniTicker(requestParameters?: AllMiniTickerRequest): WebsocketStream; /** * Average price streams push changes in the average price over a fixed time interval. * * Update Speed: 1000ms * * @summary Average Price * @param {AvgPriceRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#avg-price Binance API Documentation} */ avgPrice(requestParameters: AvgPriceRequest): WebsocketStream; /** * Block Trade Streams push block trade information in real-time. * * Update Speed: Real-time * * @summary Block Trade Streams * @param {BlockTradeRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#block-trade Binance API Documentation} */ blockTrade(requestParameters: BlockTradeRequest): WebsocketStream; /** * Pushes any update to the best bid or ask's price or quantity in * real-time for a specified symbol. * * Multiple `@bookTicker` streams can be subscribed to over one * connection. * * Update Speed: Real-time * * @summary Individual Symbol Book Ticker Streams * @param {BookTickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#book-ticker Binance API Documentation} */ bookTicker(requestParameters: BookTickerRequest): WebsocketStream; /** * Order book price and quantity depth updates used to locally manage an order book. * * Update Speed: 1000ms or 100ms * * @summary Diff. Depth Stream * @param {DiffBookDepthRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#diff-book-depth Binance API Documentation} */ diffBookDepth(requestParameters: DiffBookDepthRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current * klines/candlestick every second in `UTC+0` timezone * * Update Speed: 1000ms for `1s`, 2000ms for the other intervals * * @summary Kline/Candlestick Streams for UTC * @param {KlineRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#kline Binance API Documentation} */ kline(requestParameters: KlineRequest): WebsocketStream; /** * The Kline/Candlestick Stream push updates to the current * klines/candlestick every second in `UTC+8` timezone * **Kline/Candlestick chart intervals:** * * Supported intervals: See Kline/Candlestick chart intervals * **UTC+8 timezone offset:** * - Kline intervals open and close in the UTC+8 timezone. For example the 1d klines will open at the beginning of the UTC+8 day, and close at the end of the UTC+8 day. * - Note that E (event time), t (start time) and T (close time) in the payload are Unix timestamps, which are always interpreted in UTC. * * Update Speed: 1000ms for `1s`, 2000ms for the other intervals * * @summary Kline/Candlestick Streams with timezone offset * @param {KlineOffsetRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#kline-offset Binance API Documentation} */ klineOffset(requestParameters: KlineOffsetRequest): WebsocketStream; /** * 24hr rolling window mini-ticker statistics. These are NOT the statistics * of the UTC day, but a 24hr rolling window for the previous 24hrs. * * Update Speed: 1000ms * * @summary Individual Symbol Mini Ticker Stream * @param {MiniTickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#mini-ticker Binance API Documentation} */ miniTicker(requestParameters: MiniTickerRequest): WebsocketStream; /** * Top **\** bids and asks, pushed every second. * * Update Speed: 1000ms or 100ms * * @summary WebSocket Partial Book Depth Streams * @param {PartialBookDepthRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#partial-book-depth Binance API Documentation} */ partialBookDepth(requestParameters: PartialBookDepthRequest): WebsocketStream; /** * Reference price stream for a symbol. * * Update Speed: 1000ms * * @summary Reference Price Streams * @param {ReferencePriceRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#reference-price Binance API Documentation} */ referencePrice(requestParameters: ReferencePriceRequest): WebsocketStream; /** * Rolling window ticker statistics for a single symbol, computed over * multiple windows. * **Note:** This stream is different from the `@ticker` stream. The open time `"O"` always starts on a minute, while the closing time `"C"` is the current time * of the update. As such, the effective window might be up to 59999ms wider than ``. * * Update Speed: 1000ms * * @summary Individual Symbol Rolling Window Statistics Streams * @param {RollingWindowTickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#rolling-window-ticker Binance API Documentation} */ rollingWindowTicker(requestParameters: RollingWindowTickerRequest): WebsocketStream; /** * 24hr rolling window ticker statistics for a single symbol. These are NOT * the statistics of the UTC day, but a 24hr rolling window for the * previous 24hrs. * * Update Speed: 1000ms * * @summary Individual Symbol Ticker Streams * @param {TickerRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#ticker Binance API Documentation} */ ticker(requestParameters: TickerRequest): WebsocketStream; /** * The Trade Streams push raw trade information; each trade has a unique * buyer and seller. * * Update Speed: Real-time * * @summary Trade Streams * @param {TradeRequest} requestParameters Request parameters. * * @returns {WebsocketStream} * @throws {RequiredError} * @see {@link https://developers.binance.com/en/docs/catalog/core-trading-spot-trading/api/ws-streams/~#trade Binance API Documentation} */ trade(requestParameters: TradeRequest): WebsocketStream; } //#endregion //#region src/websocket-streams/websocket-streams.d.ts declare class WebsocketStreams { private configuration; constructor(configuration: ConfigurationWebsocketStreams); /** * Connects to the Binance WebSocket streams and returns a `WebsocketStreamsConnection` instance. * * @param {object} [options] - Optional connection options. * @param {string|string[]} [options.stream] - The stream(s) to connect to. * @param {'single'|'pool'} [options.mode] - The connection mode, either 'single' or 'pool'. Overwrite the `mode` option in the configuration. * @param {number} [options.poolSize] - The number of connections to use in pool mode. Overwrite the `poolSize` option in the configuration. * @returns {Promise} - A promise that resolves to a `WebsocketStreamsConnection` instance. */ connect({ stream, mode, poolSize }?: { stream?: string | string[]; mode?: 'single' | 'pool'; poolSize?: number; }): Promise; } declare namespace index_d_exports$2 { export { AggTradeRequest, AggTradeResponse, AllMarketRollingWindowTickerRequest, AllMarketRollingWindowTickerResponse, AllMarketRollingWindowTickerResponseInner, AllMarketRollingWindowTickerWindowSizeEnum, AllMiniTickerRequest, AllMiniTickerResponse, AllMiniTickerResponseInner, Api, ApiInterface, AvgPriceRequest, AvgPriceResponse, BalanceUpdate, BlockTradeRequest, BlockTradeResponse, BookTickerRequest, BookTickerResponse, DiffBookDepthRequest, DiffBookDepthResponse, DiffBookDepthUpdateSpeedEnum, EventStreamTerminated, ExecutionReport, ExternalLockUpdate, KlineIntervalEnum, KlineOffsetIntervalEnum, KlineOffsetRequest, KlineOffsetResponse, KlineRequest, KlineResponse, KlineResponseK, ListStatus, ListStatusOInner, MiniTickerRequest, MiniTickerResponse, OutboundAccountPosition, OutboundAccountPositionBInner, PartialBookDepthLevelsEnum, PartialBookDepthRequest, PartialBookDepthResponse, PartialBookDepthUpdateSpeedEnum, ReferencePriceRequest, ReferencePriceResponse, RollingWindowTickerRequest, RollingWindowTickerResponse, RollingWindowTickerWindowSizeEnum, TickerRequest, TickerResponse, TradeRequest, TradeResponse, UserDataStreamEventsResponse, WebsocketStreams, WebsocketStreamsConnection }; } //#endregion //#region src/spot.d.ts interface ConfigurationSpot { configurationRestAPI?: ConfigurationRestAPI; configurationWebsocketAPI?: ConfigurationWebsocketAPI; configurationWebsocketStreams?: ConfigurationWebsocketStreams; } declare class Spot { restAPI: RestAPI; websocketAPI: WebsocketAPI; websocketStreams: WebsocketStreams; constructor(config: ConfigurationSpot); } //#endregion export { BadRequestError, type ConfigurationSpot, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, SPOT_REST_API_DEMO_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_DEMO_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_DEMO_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, ServerError, Spot, index_d_exports as SpotRestAPI, index_d_exports$1 as SpotWebsocketAPI, index_d_exports$2 as SpotWebsocketStreams, TimeUnit, TooManyRequestsError, UnauthorizedError }; //# sourceMappingURL=index.d.ts.map