Binance Connector JS
    Preparing search index...

    Class RestAPI

    Index

    Constructors

    constructor

    Methods

    addIpRestrictionForSubAccountApiKey createAVirtualSubAccount createSubAccountApiKey deleteIpListForASubAccountApiKey deleteSubAccountApiKey depositAssetsIntoTheManagedSubAccount enableFuturesForSubAccount enableOptionsForSubAccount futuresTransferForSubAccount getDetailOnSubAccountsFuturesAccount getDetailOnSubAccountsFuturesAccountV2 getDetailOnSubAccountsMarginAccount getFuturesPositionRiskOfSubAccount getFuturesPositionRiskOfSubAccountV2 getIpRestrictionForASubAccountApiKey getManagedSubAccountDepositAddress getMovePositionHistoryForSubAccount getSubAccountDepositAddress getSubAccountDepositHistory getSubAccountsStatusOnMarginOrFutures getSummaryOfSubAccountsFuturesAccount getSummaryOfSubAccountsFuturesAccountV2 getSummaryOfSubAccountsMarginAccount marginTransferForSubAccount modifySubAccountApiKeyPermission movePositionForSubAccount queryManagedSubAccountAssetDetails queryManagedSubAccountFuturesAssetDetails queryManagedSubAccountList queryManagedSubAccountMarginAssetDetails queryManagedSubAccountSnapshot queryManagedSubAccountTransferLogMasterAccountInvestor queryManagedSubAccountTransferLogMasterAccountTrading queryManagedSubAccountTransferLogSubAccountTrading querySubAccountApiKey querySubAccountAssets querySubAccountAssetsAssetManagement querySubAccountFuturesAssetTransferHistory querySubAccountList querySubAccountSpotAssetsSummary querySubAccountSpotAssetTransferHistory querySubAccountTransactionStatistics queryUniversalTransferHistory sendRequest sendSignedRequest subAccountFuturesAssetTransfer subAccountTransferHistory transferToMaster transferToSubAccountOfSameMaster universalTransfer withdrawlAssetsFromTheManagedSubAccount

    Constructors

    Methods

    • Move position between sub-master, master-sub, or sub-sub accounts when necessary

      Weight(IP): 1

      Security Type: USER_DATA

      Notes:

      • You need to enable the Trading permission for the API key used to call this endpoint.
      • This function is only available for VIP levels 7-9.
      • Only master accounts can call this endpoint.
      • quantity must be a positive number.
      • Supported account types: normal account, PM PRO, PM PRO SPAN, and PM Retail.
      • The source account must have positions.
      • For orders in the same orderArgs request, if any symbol's total close position quantity exceeds current position quantity, all orders in that batch fail.
      • Only cross margin mode is supported.
      • The move position price supports MARK_PRICE only.
      • MSA is not supported.
      • Symbols configured with Reduce-Only are not supported.

      Parameters

      Returns Promise<RestApiResponse<MovePositionForSubAccountResponse>>

      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.).

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

        Query parameters for the request.

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

        Body 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.).

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

        Query parameters for the request.

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

        Body parameters for the request.

      Returns Promise<RestApiResponse<T>>

      A promise resolving to the response data object.

    • Universal Transfer

      Weight(IP): 1

      Weight(UID): 360

      Security Type: USER_DATA

      Notes:

      • You need to enable the internal transfer option for the API key used to call this endpoint.
      • If fromEmail is not sent, transfer out from the master account by default.
      • If toEmail is not sent, transfer into the master account by default.
      • When fromAccountType and toAccountType are the same, at least one of fromEmail or toEmail must be sent.
      • Supported transfer scenarios:
      • SPOT -> SPOT / USDT_FUTURE / COIN_FUTURE (master or sub-account).
      • SPOT / USDT_FUTURE / COIN_FUTURE -> SPOT (master or sub-account).
      • Master account SPOT -> sub-account MARGIN(Cross) / ISOLATED_MARGIN.
      • Sub-account MARGIN(Cross) / ISOLATED_MARGIN -> master account SPOT.
      • Sub-account MARGIN(Cross) -> sub-account MARGIN(Cross).
      • ALPHA -> ALPHA (master or sub-account).

      Parameters

      Returns Promise<RestApiResponse<UniversalTransferResponse>>

      Binance API Documentation

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    addIpRestrictionForSubAccountApiKeycreateAVirtualSubAccountcreateSubAccountApiKeydeleteIpListForASubAccountApiKeydeleteSubAccountApiKeydepositAssetsIntoTheManagedSubAccountenableFuturesForSubAccountenableOptionsForSubAccountfuturesTransferForSubAccountgetDetailOnSubAccountsFuturesAccountgetDetailOnSubAccountsFuturesAccountV2getDetailOnSubAccountsMarginAccountgetFuturesPositionRiskOfSubAccountgetFuturesPositionRiskOfSubAccountV2getIpRestrictionForASubAccountApiKeygetManagedSubAccountDepositAddressgetMovePositionHistoryForSubAccountgetSubAccountDepositAddressgetSubAccountDepositHistorygetSubAccountsStatusOnMarginOrFuturesgetSummaryOfSubAccountsFuturesAccountgetSummaryOfSubAccountsFuturesAccountV2getSummaryOfSubAccountsMarginAccountmarginTransferForSubAccountmodifySubAccountApiKeyPermissionmovePositionForSubAccountqueryManagedSubAccountAssetDetailsqueryManagedSubAccountFuturesAssetDetailsqueryManagedSubAccountListqueryManagedSubAccountMarginAssetDetailsqueryManagedSubAccountSnapshotqueryManagedSubAccountTransferLogMasterAccountInvestorqueryManagedSubAccountTransferLogMasterAccountTradingqueryManagedSubAccountTransferLogSubAccountTradingquerySubAccountApiKeyquerySubAccountAssetsquerySubAccountAssetsAssetManagementquerySubAccountFuturesAssetTransferHistoryquerySubAccountListquerySubAccountSpotAssetsSummaryquerySubAccountSpotAssetTransferHistoryquerySubAccountTransactionStatisticsqueryUniversalTransferHistorysendRequestsendSignedRequestsubAccountFuturesAssetTransfersubAccountTransferHistorytransferToMastertransferToSubAccountOfSameMasteruniversalTransferwithdrawlAssetsFromTheManagedSubAccount