Binance Connector JS
    Preparing search index...

    Interface TradeApiInterface

    TradeApi - interface TradeApi

    interface TradeApiInterface {
        cancelAllCmOpenConditionalOrders(
            requestParameters: CancelAllCmOpenConditionalOrdersRequest,
        ): Promise<RestApiResponse<CancelAllCmOpenConditionalOrdersResponse>>;
        cancelAllCmOpenOrders(
            requestParameters: CancelAllCmOpenOrdersRequest,
        ): Promise<RestApiResponse<CancelAllCmOpenOrdersResponse>>;
        cancelAllUmAlgoOpenOrders(
            requestParameters: CancelAllUmAlgoOpenOrdersRequest,
        ): Promise<RestApiResponse<CancelAllUmAlgoOpenOrdersResponse>>;
        cancelAllUmOpenOrders(
            requestParameters: CancelAllUmOpenOrdersRequest,
        ): Promise<RestApiResponse<CancelAllUmOpenOrdersResponse>>;
        cancelCmConditionalOrder(
            requestParameters: CancelCmConditionalOrderRequest,
        ): Promise<RestApiResponse<CancelCmConditionalOrderResponse>>;
        cancelCmOrder(
            requestParameters: CancelCmOrderRequest,
        ): Promise<RestApiResponse<CancelCmOrderResponse>>;
        cancelMarginAccountAllOpenOrdersOnASymbol(
            requestParameters: CancelMarginAccountAllOpenOrdersOnASymbolRequest,
        ): Promise<
            RestApiResponse<CancelMarginAccountAllOpenOrdersOnASymbolResponse>,
        >;
        cancelMarginAccountOcoOrders(
            requestParameters: CancelMarginAccountOcoOrdersRequest,
        ): Promise<RestApiResponse<CancelMarginAccountOcoOrdersResponse>>;
        cancelMarginAccountOrder(
            requestParameters: CancelMarginAccountOrderRequest,
        ): Promise<RestApiResponse<CancelMarginAccountOrderResponse>>;
        cancelUmAlgoOrder(
            requestParameters?: CancelUmAlgoOrderRequest,
        ): Promise<RestApiResponse<CancelUmAlgoOrderResponse>>;
        cancelUmOrder(
            requestParameters: CancelUmOrderRequest,
        ): Promise<RestApiResponse<CancelUmOrderResponse>>;
        cmAccountTradeList(
            requestParameters?: CmAccountTradeListRequest,
        ): Promise<RestApiResponse<CmAccountTradeListResponse>>;
        cmPositionAdlQuantileEstimation(
            requestParameters?: CmPositionAdlQuantileEstimationRequest,
        ): Promise<RestApiResponse<CmPositionAdlQuantileEstimationResponse>>;
        futuresTradfiPerpsContract(
            requestParameters?: DerivativesTradingPortfolioMarginRestAPI.FuturesTradfiPerpsContractRequest,
        ): Promise<
            RestApiResponse<
                DerivativesTradingPortfolioMarginRestAPI.FuturesTradfiPerpsContractResponse,
            >,
        >;
        getUmFuturesBnbBurnStatus(
            requestParameters?: GetUmFuturesBnbBurnStatusRequest,
        ): Promise<RestApiResponse<GetUmFuturesBnbBurnStatusResponse>>;
        marginAccountBorrow(
            requestParameters: MarginAccountBorrowRequest,
        ): Promise<RestApiResponse<MarginAccountBorrowResponse>>;
        marginAccountNewOco(
            requestParameters: DerivativesTradingPortfolioMarginRestAPI.MarginAccountNewOcoRequest,
        ): Promise<
            RestApiResponse<
                DerivativesTradingPortfolioMarginRestAPI.MarginAccountNewOcoResponse,
            >,
        >;
        marginAccountRepay(
            requestParameters: MarginAccountRepayRequest,
        ): Promise<RestApiResponse<MarginAccountRepayResponse>>;
        marginAccountRepayDebt(
            requestParameters: MarginAccountRepayDebtRequest,
        ): Promise<RestApiResponse<MarginAccountRepayDebtResponse>>;
        marginAccountTradeList(
            requestParameters: MarginAccountTradeListRequest,
        ): Promise<RestApiResponse<MarginAccountTradeListResponse>>;
        modifyCmOrder(
            requestParameters: ModifyCmOrderRequest,
        ): Promise<RestApiResponse<ModifyCmOrderResponse>>;
        modifyUmOrder(
            requestParameters: ModifyUmOrderRequest,
        ): Promise<RestApiResponse<ModifyUmOrderResponse>>;
        newCmConditionalOrder(
            requestParameters: NewCmConditionalOrderRequest,
        ): Promise<RestApiResponse<NewCmConditionalOrderResponse>>;
        newCmOrder(
            requestParameters: NewCmOrderRequest,
        ): Promise<RestApiResponse<NewCmOrderResponse>>;
        newMarginOrder(
            requestParameters: NewMarginOrderRequest,
        ): Promise<RestApiResponse<NewMarginOrderResponse>>;
        newUmAlgoOrder(
            requestParameters: NewUmAlgoOrderRequest,
        ): Promise<RestApiResponse<NewUmAlgoOrderResponse>>;
        newUmOrder(
            requestParameters: NewUmOrderRequest,
        ): Promise<RestApiResponse<NewUmOrderResponse>>;
        queryAllCmConditionalOrders(
            requestParameters?: QueryAllCmConditionalOrdersRequest,
        ): Promise<RestApiResponse<QueryAllCmConditionalOrdersResponse>>;
        queryAllCmOrders(
            requestParameters?: QueryAllCmOrdersRequest,
        ): Promise<RestApiResponse<QueryAllCmOrdersResponse>>;
        queryAllCurrentCmOpenConditionalOrders(
            requestParameters?: QueryAllCurrentCmOpenConditionalOrdersRequest,
        ): Promise<RestApiResponse<QueryAllCurrentCmOpenConditionalOrdersResponse>>;
        queryAllCurrentCmOpenOrders(
            requestParameters?: QueryAllCurrentCmOpenOrdersRequest,
        ): Promise<RestApiResponse<QueryAllCurrentCmOpenOrdersResponse>>;
        queryAllCurrentUmOpenAlgoOrders(
            requestParameters?: QueryAllCurrentUmOpenAlgoOrdersRequest,
        ): Promise<RestApiResponse<QueryAllCurrentUmOpenAlgoOrdersResponse>>;
        queryAllCurrentUmOpenOrders(
            requestParameters?: QueryAllCurrentUmOpenOrdersRequest,
        ): Promise<RestApiResponse<QueryAllCurrentUmOpenOrdersResponse>>;
        queryAllMarginAccountOrders(
            requestParameters: QueryAllMarginAccountOrdersRequest,
        ): Promise<RestApiResponse<QueryAllMarginAccountOrdersResponse>>;
        queryAllUmOrders(
            requestParameters: QueryAllUmOrdersRequest,
        ): Promise<RestApiResponse<QueryAllUmOrdersResponse>>;
        queryCmConditionalOrderHistory(
            requestParameters: QueryCmConditionalOrderHistoryRequest,
        ): Promise<RestApiResponse<QueryCmConditionalOrderHistoryResponse>>;
        queryCmModifyOrderHistory(
            requestParameters: QueryCmModifyOrderHistoryRequest,
        ): Promise<RestApiResponse<QueryCmModifyOrderHistoryResponse>>;
        queryCmOrder(
            requestParameters: QueryCmOrderRequest,
        ): Promise<RestApiResponse<QueryCmOrderResponse>>;
        queryCurrentCmOpenConditionalOrder(
            requestParameters: QueryCurrentCmOpenConditionalOrderRequest,
        ): Promise<RestApiResponse<QueryCurrentCmOpenConditionalOrderResponse>>;
        queryCurrentCmOpenOrder(
            requestParameters: QueryCurrentCmOpenOrderRequest,
        ): Promise<RestApiResponse<QueryCurrentCmOpenOrderResponse>>;
        queryCurrentMarginOpenOrder(
            requestParameters: QueryCurrentMarginOpenOrderRequest,
        ): Promise<RestApiResponse<QueryCurrentMarginOpenOrderResponse>>;
        queryCurrentUmOpenAlgoOrder(
            requestParameters?: QueryCurrentUmOpenAlgoOrderRequest,
        ): Promise<RestApiResponse<QueryCurrentUmOpenAlgoOrderResponse>>;
        queryCurrentUmOpenOrder(
            requestParameters: QueryCurrentUmOpenOrderRequest,
        ): Promise<RestApiResponse<QueryCurrentUmOpenOrderResponse>>;
        queryMarginAccountOrder(
            requestParameters: QueryMarginAccountOrderRequest,
        ): Promise<RestApiResponse<QueryMarginAccountOrderResponse>>;
        queryMarginAccountsAllOco(
            requestParameters?: DerivativesTradingPortfolioMarginRestAPI.QueryMarginAccountsAllOcoRequest,
        ): Promise<
            RestApiResponse<
                DerivativesTradingPortfolioMarginRestAPI.QueryMarginAccountsAllOcoResponse,
            >,
        >;
        queryMarginAccountsOco(
            requestParameters?: DerivativesTradingPortfolioMarginRestAPI.QueryMarginAccountsOcoRequest,
        ): Promise<
            RestApiResponse<
                DerivativesTradingPortfolioMarginRestAPI.QueryMarginAccountsOcoResponse,
            >,
        >;
        queryMarginAccountsOpenOco(
            requestParameters?: DerivativesTradingPortfolioMarginRestAPI.QueryMarginAccountsOpenOcoRequest,
        ): Promise<
            RestApiResponse<
                DerivativesTradingPortfolioMarginRestAPI.QueryMarginAccountsOpenOcoResponse,
            >,
        >;
        queryUmAlgoOrderHistory(
            requestParameters: QueryUmAlgoOrderHistoryRequest,
        ): Promise<RestApiResponse<QueryUmAlgoOrderHistoryResponse>>;
        queryUmModifyOrderHistory(
            requestParameters: QueryUmModifyOrderHistoryRequest,
        ): Promise<RestApiResponse<QueryUmModifyOrderHistoryResponse>>;
        queryUmOrder(
            requestParameters: QueryUmOrderRequest,
        ): Promise<RestApiResponse<QueryUmOrderResponse>>;
        queryUsersCmForceOrders(
            requestParameters?: QueryUsersCmForceOrdersRequest,
        ): Promise<RestApiResponse<QueryUsersCmForceOrdersResponse>>;
        queryUsersMarginForceOrders(
            requestParameters?: QueryUsersMarginForceOrdersRequest,
        ): Promise<RestApiResponse<QueryUsersMarginForceOrdersResponse>>;
        queryUsersUmForceOrders(
            requestParameters?: QueryUsersUmForceOrdersRequest,
        ): Promise<RestApiResponse<QueryUsersUmForceOrdersResponse>>;
        toggleBnbBurnOnUmFuturesTrade(
            requestParameters: ToggleBnbBurnOnUmFuturesTradeRequest,
        ): Promise<RestApiResponse<ToggleBnbBurnOnUmFuturesTradeResponse>>;
        umAccountTradeList(
            requestParameters: UmAccountTradeListRequest,
        ): Promise<RestApiResponse<UmAccountTradeListResponse>>;
        umPositionAdlQuantileEstimation(
            requestParameters?: UmPositionAdlQuantileEstimationRequest,
        ): Promise<RestApiResponse<UmPositionAdlQuantileEstimationResponse>>;
    }

    Implemented by

    Index

    Methods

    cancelAllCmOpenConditionalOrders cancelAllCmOpenOrders cancelAllUmAlgoOpenOrders cancelAllUmOpenOrders cancelCmConditionalOrder cancelCmOrder cancelMarginAccountAllOpenOrdersOnASymbol cancelMarginAccountOcoOrders cancelMarginAccountOrder cancelUmAlgoOrder cancelUmOrder cmAccountTradeList cmPositionAdlQuantileEstimation futuresTradfiPerpsContract getUmFuturesBnbBurnStatus marginAccountBorrow marginAccountNewOco marginAccountRepay marginAccountRepayDebt marginAccountTradeList modifyCmOrder modifyUmOrder newCmConditionalOrder newCmOrder newMarginOrder newUmAlgoOrder newUmOrder queryAllCmConditionalOrders queryAllCmOrders queryAllCurrentCmOpenConditionalOrders queryAllCurrentCmOpenOrders queryAllCurrentUmOpenAlgoOrders queryAllCurrentUmOpenOrders queryAllMarginAccountOrders queryAllUmOrders queryCmConditionalOrderHistory queryCmModifyOrderHistory queryCmOrder queryCurrentCmOpenConditionalOrder queryCurrentCmOpenOrder queryCurrentMarginOpenOrder queryCurrentUmOpenAlgoOrder queryCurrentUmOpenOrder queryMarginAccountOrder queryMarginAccountsAllOco queryMarginAccountsOco queryMarginAccountsOpenOco queryUmAlgoOrderHistory queryUmModifyOrderHistory queryUmOrder queryUsersCmForceOrders queryUsersMarginForceOrders queryUsersUmForceOrders toggleBnbBurnOnUmFuturesTrade umAccountTradeList umPositionAdlQuantileEstimation

    Methods

    • Get trades for a specific account and CM symbol.

      Weight: - 20 with symbol

      • 40 with pair

      Security Type: USER_DATA

      Notes:

      • Either symbol or pair must be sent
      • symbol and pair cannot be sent together
      • pair and fromId cannot be sent together
      • OrderId can only be sent together with symbol
      • If a pair is sent, tickers for all symbols of the pair will be returned
      • The parameter fromId cannot be sent with startTime or endTime
      • If startTime and endTime are both not sent, then the last '24 hours' data will be returned.
      • The time between startTime and endTime cannot be longer than 24 hours.

      Parameters

      Returns Promise<RestApiResponse<CmAccountTradeListResponse>>

      TradeApiInterface

    • Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue

      Weight(IP): 1

      Security Type: TRADE

      Notes:

      • Either orderId or origClientOrderId must be sent, and the orderId will prevail if both are sent.
      • Both quantity and price must be sent
      • When the new quantity or price doesn't satisfy PRICE_FILTER / PERCENT_FILTER / LOT_SIZE, amendment will be rejected and the order will stay as it is.
      • However the order will be cancelled by the amendment in the following situations:
      • when the order is in partially filled status and the new quantity <= executedQty
      • When the order is GTX and the new price will cause it to be executed immediately

      Parameters

      Returns Promise<RestApiResponse<ModifyCmOrderResponse>>

      TradeApiInterface

    • Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue

      Weight(IP): 1

      Security Type: TRADE

      Notes:

      • Either orderId or origClientOrderId must be sent, and the orderId will prevail if both are sent.
      • Both quantity and price must be sent
      • When the new quantity or price doesn't satisfy PRICE_FILTER / PERCENT_FILTER / LOT_SIZE, amendment will be rejected and the order will stay as it is.
      • However the order will be cancelled by the amendment in the following situations:
      • when the order is in partially filled status and the new quantity <= executedQty
      • When the order is GTX and the new price will cause it to be executed immediately
      • The amendment keeps the order's original selfTradePreventionMode.

      Parameters

      Returns Promise<RestApiResponse<ModifyUmOrderResponse>>

      TradeApiInterface

    • New CM Conditional Order

      Weight(IP): 1

      Security Type: TRADE

      Notes:

      • Additional mandatory parameters based on type:
      • Order with type STOP/TAKE_PROFIT, parameter timeInForce can be sent ( default GTC).
      • Condition orders will be triggered when:
      • STOP, STOP_MARKET:
      • BUY: "MARK_PRICE" >= stopPrice
      • SELL: "MARK_PRICE" = stopPrice
      • TRAILING_STOP_MARKET:
      • BUY: the lowest mark price after order placed ``= the lowest mark price
      • (1 + callbackRate)
      • SELL: the highest mark price after order placed >= activationPrice, and the latest mark price = stopPrice
      • SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") = stopPrice

      Parameters

      Returns Promise<RestApiResponse<NewCmConditionalOrderResponse>>

      TradeApiInterface

    • Place new UM conditional order

      Weight(IP): 1

      Security Type: TRADE

      Notes:

      • Algo order with type STOP, parameter timeInForce can be sent (default GTC).
      • Algo order with type TAKE_PROFIT, parameter timeInForce can be sent (default GTC).
      • Condition orders will be triggered when price reaches the triggerPrice.
      • STOP, STOP_MARKET: BUY: latest price >= triggerPrice; SELL: latest price <= triggerPrice.
      • TAKE_PROFIT, TAKE_PROFIT_MARKET: BUY: latest price <= triggerPrice; SELL: latest price >= triggerPrice.
      • TRAILING_STOP_MARKET: BUY: lowest price after order placed <= activatePrice, and latest price >= lowest price * (1 + callbackRate); SELL: highest price after order placed >= activatePrice, and latest price <= highest price * (1 - callbackRate).
      • STOP_MARKET, TAKE_PROFIT_MARKET with closePosition=true: follow the same rules for conditional orders; if triggered, close all current long position (if SELL) or current short position (if BUY); cannot be used with quantity parameter; cannot be used with reduceOnly parameter; in Hedge Mode, cannot be used with BUY orders in LONG position side, and cannot be used with SELL orders in SHORT position side.
      • selfTradePreventionMode is only effective when timeInForce set to IOC or GTC or GTD.

      Parameters

      Returns Promise<RestApiResponse<NewUmAlgoOrderResponse>>

      TradeApiInterface

    • Place new UM order

      Weight(IP): 1

      Security Type: TRADE

      Notes:

      • Additional mandatory parameters based on type:
      • If newOrderRespType is sent as RESULT :
      • MARKET order: the final FILLED result of the order will be return directly.
      • LIMIT order with special timeInForce: the final status result of the order(FILLED or EXPIRED) will be returned directly.
      • selfTradePreventionMode is only effective when timeInForce set to IOC or GTC or GTD.
      • In extreme market conditions, timeInForce GTD order auto cancel time might be delayed comparing to goodTillDate

      Parameters

      Returns Promise<RestApiResponse<NewUmOrderResponse>>

      TradeApiInterface

    Settings

    Member Visibility

    On This Page

    Methods
    cancelAllCmOpenConditionalOrderscancelAllCmOpenOrderscancelAllUmAlgoOpenOrderscancelAllUmOpenOrderscancelCmConditionalOrdercancelCmOrdercancelMarginAccountAllOpenOrdersOnASymbolcancelMarginAccountOcoOrderscancelMarginAccountOrdercancelUmAlgoOrdercancelUmOrdercmAccountTradeListcmPositionAdlQuantileEstimationfuturesTradfiPerpsContractgetUmFuturesBnbBurnStatusmarginAccountBorrowmarginAccountNewOcomarginAccountRepaymarginAccountRepayDebtmarginAccountTradeListmodifyCmOrdermodifyUmOrdernewCmConditionalOrdernewCmOrdernewMarginOrdernewUmAlgoOrdernewUmOrderqueryAllCmConditionalOrdersqueryAllCmOrdersqueryAllCurrentCmOpenConditionalOrdersqueryAllCurrentCmOpenOrdersqueryAllCurrentUmOpenAlgoOrdersqueryAllCurrentUmOpenOrdersqueryAllMarginAccountOrdersqueryAllUmOrdersqueryCmConditionalOrderHistoryqueryCmModifyOrderHistoryqueryCmOrderqueryCurrentCmOpenConditionalOrderqueryCurrentCmOpenOrderqueryCurrentMarginOpenOrderqueryCurrentUmOpenAlgoOrderqueryCurrentUmOpenOrderqueryMarginAccountOrderqueryMarginAccountsAllOcoqueryMarginAccountsOcoqueryMarginAccountsOpenOcoqueryUmAlgoOrderHistoryqueryUmModifyOrderHistoryqueryUmOrderqueryUsersCmForceOrdersqueryUsersMarginForceOrdersqueryUsersUmForceOrderstoggleBnbBurnOnUmFuturesTradeumAccountTradeListumPositionAdlQuantileEstimation