Binance Connector JS
    Preparing search index...

    Class RestAPI

    Index

    Constructors

    constructor

    Methods

    acceptTheOfferedQuote accountInformationV2 accountInformationV3 accountTradeList allOrders autoCancelAllOpenOrders basis cancelAllOpenOrders cancelMultipleOrders cancelOrder changeInitialLeverage changeMarginType changeMultiAssetsMode changePositionMode checkServerTime classicPortfolioMarginAccountInformation closeUserDataStream compositeIndexSymbolInformation compressedAggregateTradesList continuousContractKlineCandlestickData currentAllOpenOrders exchangeInformation futuresAccountBalanceV2 futuresAccountBalanceV3 futuresAccountConfiguration futuresTradingQuantitativeRulesIndicators getBnbBurnStatus getCurrentMultiAssetsMode getCurrentPositionMode getDownloadIdForFuturesOrderHistory getDownloadIdForFuturesTradeHistory getDownloadIdForFuturesTransactionHistory getFundingRateHistory getFundingRateInfo getFuturesOrderHistoryDownloadLinkById getFuturesTradeDownloadLinkById getFuturesTransactionHistoryDownloadLinkById getIncomeHistory getOrderModifyHistory getPositionMarginChangeHistory indexPriceKlineCandlestickData keepaliveUserDataStream klineCandlestickData listAllConvertPairs longShortRatio markPrice markPriceKlineCandlestickData modifyIsolatedPositionMargin modifyMultipleOrders modifyOrder multiAssetsModeAssetIndex newOrder notionalAndLeverageBrackets oldTradesLookup openInterest openInterestStatistics orderBook orderStatus placeMultipleOrders positionAdlQuantileEstimation positionInformationV2 positionInformationV3 premiumIndexKlineData quarterlyContractSettlementPrice queryCurrentOpenOrder queryIndexPriceConstituents queryInsuranceFundBalanceSnapshot queryOrder queryUserRateLimit recentTradesList sendQuoteRequest sendRequest sendSignedRequest startUserDataStream symbolConfiguration symbolOrderBookTicker symbolPriceTicker symbolPriceTickerV2 takerBuySellVolume testConnectivity testOrder ticker24hrPriceChangeStatistics toggleBnbBurnOnFuturesTrade topTraderLongShortRatioAccounts topTraderLongShortRatioPositions userCommissionRate usersForceOrders

    Constructors

    Methods

    • Send in a new order.

      Order with type STOP, parameter timeInForce can be sent ( default GTC). Order with type TAKE_PROFIT, parameter timeInForce can be sent ( default GTC). Condition orders will be triggered when:

      If parameterpriceProtectis sent as true: when price reaches the stopPrice ，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol "triggerProtect" of a symbol can be got from GET /fapi/v1/exchangeInfo

      STOP, STOP_MARKET: BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= stopPrice SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= stopPrice TAKE_PROFIT, TAKE_PROFIT_MARKET: BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= stopPrice SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= stopPrice TRAILING_STOP_MARKET: BUY: the lowest price after order placed <= activationPrice, and the latest price >= the lowest price * (1 + callbackRate) SELL: the highest price after order placed >= activationPrice, and the latest price <= the highest price * (1 - callbackRate)

      For TRAILING_STOP_MARKET, if you got such error code. {"code": -2021, "msg": "Order would immediately trigger."} means that the parameters you send do not meet the following requirements: BUY: activationPrice should be smaller than latest price. SELL: activationPrice should be larger than latest price.

      If newOrderRespType is sent as RESULT : MARKET order: the final FILLED result of the order will be return directly. LIMIT order with special timeInForce: the final status result of the order(FILLED or EXPIRED) will be returned directly.

      STOP_MARKET, TAKE_PROFIT_MARKET with closePosition=true: Follow the same rules for condition orders. If triggered，close all current long position( if SELL) or current short position( if BUY). Cannot be used with quantity paremeter 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. In extreme market conditions, timeInForce GTD order auto cancel time might be delayed comparing to goodTillDate

      Weight: 1 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); 0 on IP rate limit(x-mbx-used-weight-1m)

      Parameters

      Returns Promise<RestApiResponse<DerivativesTradingUsdsFuturesRestAPI.NewOrderResponse>>

      Binance API Documentation

    • Generic function to send a request.

      Type Parameters

      • T

      Parameters

      • endpoint: string

        The API endpoint to call.

      • method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH"

        HTTP method to use (GET, POST, DELETE, etc.).

      • params: Record<string, unknown> = {}

        Query parameters for the request.

      Returns Promise<RestApiResponse<T>>

      A promise resolving to the response data object.

    • Generic function to send a signed request.

      Type Parameters

      • T

      Parameters

      • endpoint: string

        The API endpoint to call.

      • method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH"

        HTTP method to use (GET, POST, DELETE, etc.).

      • params: Record<string, unknown> = {}

        Query parameters for the request.

      Returns Promise<RestApiResponse<T>>

      A promise resolving to the response data object.

    • Testing order request, this order will not be submitted to matching engine

      Order with type STOP, parameter timeInForce can be sent ( default GTC). Order with type TAKE_PROFIT, parameter timeInForce can be sent ( default GTC). Condition orders will be triggered when:

      If parameterpriceProtectis sent as true: when price reaches the stopPrice ，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol "triggerProtect" of a symbol can be got from GET /fapi/v1/exchangeInfo

      STOP, STOP_MARKET: BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= stopPrice SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= stopPrice TAKE_PROFIT, TAKE_PROFIT_MARKET: BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= stopPrice SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= stopPrice TRAILING_STOP_MARKET: BUY: the lowest price after order placed <= activationPrice, and the latest price >= the lowest price * (1 + callbackRate) SELL: the highest price after order placed >= activationPrice, and the latest price <= the highest price * (1 - callbackRate)

      For TRAILING_STOP_MARKET, if you got such error code. {"code": -2021, "msg": "Order would immediately trigger."} means that the parameters you send do not meet the following requirements: BUY: activationPrice should be smaller than latest price. SELL: activationPrice should be larger than latest price.

      If newOrderRespType is sent as RESULT : MARKET order: the final FILLED result of the order will be return directly. LIMIT order with special timeInForce: the final status result of the order(FILLED or EXPIRED) will be returned directly.

      STOP_MARKET, TAKE_PROFIT_MARKET with closePosition=true: Follow the same rules for condition orders. If triggered，close all current long position( if SELL) or current short position( if BUY). Cannot be used with quantity paremeter 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. In extreme market conditions, timeInForce GTD order auto cancel time might be delayed comparing to goodTillDate

      Weight: 0

      Parameters

      Returns Promise<RestApiResponse<TestOrderResponse>>

      Binance API Documentation

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    acceptTheOfferedQuoteaccountInformationV2accountInformationV3accountTradeListallOrdersautoCancelAllOpenOrdersbasiscancelAllOpenOrderscancelMultipleOrderscancelOrderchangeInitialLeveragechangeMarginTypechangeMultiAssetsModechangePositionModecheckServerTimeclassicPortfolioMarginAccountInformationcloseUserDataStreamcompositeIndexSymbolInformationcompressedAggregateTradesListcontinuousContractKlineCandlestickDatacurrentAllOpenOrdersexchangeInformationfuturesAccountBalanceV2futuresAccountBalanceV3futuresAccountConfigurationfuturesTradingQuantitativeRulesIndicatorsgetBnbBurnStatusgetCurrentMultiAssetsModegetCurrentPositionModegetDownloadIdForFuturesOrderHistorygetDownloadIdForFuturesTradeHistorygetDownloadIdForFuturesTransactionHistorygetFundingRateHistorygetFundingRateInfogetFuturesOrderHistoryDownloadLinkByIdgetFuturesTradeDownloadLinkByIdgetFuturesTransactionHistoryDownloadLinkByIdgetIncomeHistorygetOrderModifyHistorygetPositionMarginChangeHistoryindexPriceKlineCandlestickDatakeepaliveUserDataStreamklineCandlestickDatalistAllConvertPairslongShortRatiomarkPricemarkPriceKlineCandlestickDatamodifyIsolatedPositionMarginmodifyMultipleOrdersmodifyOrdermultiAssetsModeAssetIndexnewOrdernotionalAndLeverageBracketsoldTradesLookupopenInterestopenInterestStatisticsorderBookorderStatusplaceMultipleOrderspositionAdlQuantileEstimationpositionInformationV2positionInformationV3premiumIndexKlineDataquarterlyContractSettlementPricequeryCurrentOpenOrderqueryIndexPriceConstituentsqueryInsuranceFundBalanceSnapshotqueryOrderqueryUserRateLimitrecentTradesListsendQuoteRequestsendRequestsendSignedRequeststartUserDataStreamsymbolConfigurationsymbolOrderBookTickersymbolPriceTickersymbolPriceTickerV2takerBuySellVolumetestConnectivitytestOrderticker24hrPriceChangeStatisticstoggleBnbBurnOnFuturesTradetopTraderLongShortRatioAccountstopTraderLongShortRatioPositionsuserCommissionRateusersForceOrders