Binance Connector JS
    Preparing search index...

    Class RestAPI

    Index

    Constructors

    constructor

    Methods

    accountApiTradingStatus accountInfo accountStatus allCoinsInformation assetDetail assetDividendRecord brokerWithdraw dailyAccountSnapshot depositAddress depositHistory depositHistoryTravelRule disableFastWithdrawSwitch dustlog dustTransfer enableFastWithdrawSwitch fetchAddressVerificationList fetchDepositAddressListWithNetwork fetchWithdrawAddressList fetchWithdrawQuota fundingWallet getApiKeyPermission getAssetsThatCanBeConvertedIntoBnb getCloudMiningPaymentAndRefundHistory getOpenSymbolList getSymbolsDelistScheduleForSpot onboardedVaspList oneClickArrivalDepositApply queryUserDelegationHistory queryUserUniversalTransferHistory queryUserWalletBalance sendRequest sendSignedRequest submitDepositQuestionnaire submitDepositQuestionnaireTravelRule systemStatus toggleBnbBurnOnSpotTradeAndMarginInterest tradeFee userAsset userUniversalTransfer withdraw withdrawHistory withdrawHistoryV1 withdrawHistoryV2 withdrawTravelRule

    Constructors

    Methods

    • Submit a withdrawal request for brokers of local entities that required travel rule.

      If network not send, return with default network of the coin, but if the address could not match default network, the withdraw will be rejected. You can get network in networkList of a coin in the response Questionnaire is different for each local entity, please refer to If getting error like Questionnaire format not valid. or Questionnaire must not be blank,

      Weight: 600

      Parameters

      Returns Promise<RestApiResponse<BrokerWithdrawResponse>>

      Binance API Documentation

    • Fetch the onboarded VASP list for local entities that required travel rule.

      This endpoint specifically uses per second IP rate limit, user's total second level IP rate

      Weight: 18000 Request limit: 10 requests per second

      • This endpoint specifically uses per second IP rate limit, user's total second level IP rate limit is 180000/second. Response from the endpoint contains header key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.

      Returns Promise<RestApiResponse<OnboardedVaspListResponse>>

      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.

    • user universal transfer

      fromSymbol must be sent when type are ISOLATEDMARGIN_MARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN toSymbol must be sent when type are MARGIN_ISOLATEDMARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN ENUM of transfer types: MAIN_UMFUTURE Spot account transfer to USDⓈ-M Futures account MAIN_CMFUTURE Spot account transfer to COIN-M Futures account MAIN_MARGIN Spot account transfer to Margin（cross）account UMFUTURE_MAIN USDⓈ-M Futures account transfer to Spot account UMFUTURE_MARGIN USDⓈ-M Futures account transfer to Margin（cross）account CMFUTURE_MAIN COIN-M Futures account transfer to Spot account CMFUTURE_MARGIN COIN-M Futures account transfer to Margin(cross) account MARGIN_MAIN Margin（cross）account transfer to Spot account MARGIN_UMFUTURE Margin（cross）account transfer to USDⓈ-M Futures MARGIN_CMFUTURE Margin（cross）account transfer to COIN-M Futures ISOLATEDMARGIN_MARGIN Isolated margin account transfer to Margin(cross) account MARGIN_ISOLATEDMARGIN Margin(cross) account transfer to Isolated margin account ISOLATEDMARGIN_ISOLATEDMARGIN Isolated margin account transfer to Isolated margin account MAIN_FUNDING Spot account transfer to Funding account FUNDING_MAIN Funding account transfer to Spot account FUNDING_UMFUTURE Funding account transfer to UMFUTURE account UMFUTURE_FUNDING UMFUTURE account transfer to Funding account MARGIN_FUNDING MARGIN account transfer to Funding account FUNDING_MARGIN Funding account transfer to Margin account FUNDING_CMFUTURE Funding account transfer to CMFUTURE account CMFUTURE_FUNDING CMFUTURE account transfer to Funding account MAIN_OPTION Spot account transfer to Options account OPTION_MAIN Options account transfer to Spot account UMFUTURE_OPTION USDⓈ-M Futures account transfer to Options account OPTION_UMFUTURE Options account transfer to USDⓈ-M Futures account MARGIN_OPTION Margin（cross）account transfer to Options account OPTION_MARGIN Options account transfer to Margin（cross）account FUNDING_OPTION Funding account transfer to Options account OPTION_FUNDING Options account transfer to Funding account MAIN_PORTFOLIO_MARGIN Spot account transfer to Portfolio Margin account PORTFOLIO_MARGIN_MAIN Portfolio Margin account transfer to Spot account

      Weight: 900

      Parameters

      Returns Promise<RestApiResponse<UserUniversalTransferResponse>>

      Binance API Documentation

    • Fetch withdraw history.

      network may not be in the response for old withdraw. Please notice the default startTime and endTime to make sure that time interval is within 0-90 days. If both startTime and endTimeare sent, time between startTimeand endTimemust be less than 90 days. If withdrawOrderId is sent, time between startTime and endTime must be less than 7 days. If withdrawOrderId is sent, startTime and endTime are not sent, will return last 7 days records by default. Maximum support idList number is 45.

      Weight: 18000 Request limit: 10 requests per second

      Parameters

      Returns Promise<RestApiResponse<WithdrawHistoryResponse>>

      Binance API Documentation

    • Fetch withdraw history for local entities that required travel rule.

      This endpoint specifically uses per second IP rate limit, user's total second level IP rate network may not be in the response for old withdraw. Please notice the default startTime and endTime to make sure that time interval is within If both startTime and endTimeare sent, time between startTimeand endTimemust be less

      Weight: 18000 Request limit: 10 requests per second

      • This endpoint specifically uses per second IP rate limit, user's total second level IP rate limit is 180000/second. Response from the endpoint contains header key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.

      Parameters

      Returns Promise<RestApiResponse<WithdrawHistoryV1Response>>

      Binance API Documentation

    • Fetch withdraw history for local entities that required travel rule.

      This endpoint specifically uses per second IP rate limit, user's total second level IP rate network may not be in the response for old withdraw. Withdrawal made through /sapi/v1/capital/withdraw/apply may not be in the response. Please notice the default startTime and endTime to make sure that time interval is within If both startTime and endTimeare sent, time between startTimeand endTimemust be less If withdrawOrderId is sent, time between startTime and endTime must be less than 7 days. If withdrawOrderId is sent, startTime and endTime are not sent, will return last 7 days records by default. Maximum support trId,txId number is 45. WithdrawOrderId only support 1. If responsible does not include withdrawalStatus, please input trId or txId retrieve the data.

      Weight: 18000 Request limit: 10 requests per second

      • This endpoint specifically uses per second IP rate limit, user's total second level IP rate limit is 180000/second. Response from the endpoint contains header key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.

      Parameters

      Returns Promise<RestApiResponse<WithdrawHistoryV2Response>>

      Binance API Documentation

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    accountApiTradingStatusaccountInfoaccountStatusallCoinsInformationassetDetailassetDividendRecordbrokerWithdrawdailyAccountSnapshotdepositAddressdepositHistorydepositHistoryTravelRuledisableFastWithdrawSwitchdustlogdustTransferenableFastWithdrawSwitchfetchAddressVerificationListfetchDepositAddressListWithNetworkfetchWithdrawAddressListfetchWithdrawQuotafundingWalletgetApiKeyPermissiongetAssetsThatCanBeConvertedIntoBnbgetCloudMiningPaymentAndRefundHistorygetOpenSymbolListgetSymbolsDelistScheduleForSpotonboardedVaspListoneClickArrivalDepositApplyqueryUserDelegationHistoryqueryUserUniversalTransferHistoryqueryUserWalletBalancesendRequestsendSignedRequestsubmitDepositQuestionnairesubmitDepositQuestionnaireTravelRulesystemStatustoggleBnbBurnOnSpotTradeAndMarginInteresttradeFeeuserAssetuserUniversalTransferwithdrawwithdrawHistorywithdrawHistoryV1withdrawHistoryV2withdrawTravelRule