Module: SubAccount

API sub account endpoints

Source: restful/subAccount.js, line 5

Methods

managedSubAccountAssets(email, optionsopt)

Query managed sub-account asset details（For Investor Master Account)

GET /sapi/v1/managed-subaccount/asset

https://binance-docs.github.io/apidocs/spot/en/#query-managed-sub-account-asset-details-for-investor-master-account

Parameters:

Name Type Attributes Description

email string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 595

managedSubAccountDeposit(toEmail, asset, amount, optionsopt)

Deposit assets into the managed sub-account（For Investor Master Account)

POST /sapi/v1/managed-subaccount/deposit

https://binance-docs.github.io/apidocs/spot/en/#deposit-assets-into-the-managed-sub-account-for-investor-master-account

Parameters:

Name Type Attributes Description

toEmail string

asset string

amount number

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 575

managedSubAccountSnapshot(email, type, optionsopt)

Query Managed Sub-account Snapshot（For Investor Master Account)

GET /sapi/v1/managed-subaccount/accountSnapshot

https://binance-docs.github.io/apidocs/spot/en/#query-managed-sub-account-snapshot-for-investor-master-account

Parameters:

Name Type Attributes Description

email string

type

string

"SPOT", "MARGIN"（cross）, "FUTURES"（UM）

options

object

Properties

Name	Type	Attributes	Description
`startTime`	number	<optional>
`endTime`	number	<optional>
`limit`	number	<optional>	min 7, max 30, default 7
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 643

managedSubAccountWithdraw(fromEmail, asset, amount, optionsopt)

Withdrawl assets from the managed sub-account（For Investor Master Account)

POST /sapi/v1/managed-subaccount/withdraw

https://binance-docs.github.io/apidocs/spot/en/#withdrawl-assets-from-the-managed-sub-account-for-investor-master-account

Parameters:

Name Type Attributes Description

fromEmail string

asset string

amount number

options

object

Properties

Name	Type	Attributes	Description
`transferDate`	number	<optional>	Withdrawals is automatically occur on the transfer date(UTC0). If a date is not selected, the withdrawal occurs right now
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 619

subAccountApiAddIp(email, subAccountApiKey, ipAddress, optionsopt)

Add IP List for a Sub-account API Key (For Master Account)

POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList

Before the usage of this endpoint, please ensure POST /sapi/v1/sub-account/subAccountApi/ipRestriction was used to enable the IP restriction.

https://binance-docs.github.io/apidocs/spot/en/#add-ip-list-for-a-sub-account-api-key-for-master-account

Parameters:

Name Type Attributes Description

email

string

Sub-account email

subAccountApiKey string

ipAddress

string

Can be added in batches, separated by commas

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 689

subAccountApiDeleteIp(email, subAccountApiKey, ipAddress, optionsopt)

Delete IP List for a Sub-account API Key (For Master Account)

DELETE /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList

https://binance-docs.github.io/apidocs/spot/en/#delete-ip-list-for-a-sub-account-api-key-for-master-account

Parameters:

Name Type Attributes Description

email

string

Sub-account email

subAccountApiKey string

ipAddress

string

Can be added in batches, separated by commas

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 732

subAccountApiGetIpRestriction(email, subAccountApiKey, optionsopt)

Get IP Restriction for a Sub-account API Key (For Master Account)

GET /sapi/v1/sub-account/subAccountApi/ipRestriction

https://binance-docs.github.io/apidocs/spot/en/#get-ip-restriction-for-a-sub-account-api-key-for-master-account

Parameters:

Name Type Attributes Description

email

string

Sub-account email

subAccountApiKey string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 710

subAccountApiToggleIpRestriction(email, subAccountApiKey, ipRestrict, optionsopt)

Enable or Disable IP Restriction for a Sub-account API Key (For Master Account)

POST /sapi/v1/sub-account/subAccountApi/ipRestriction

https://binance-docs.github.io/apidocs/spot/en/#enable-or-disable-ip-restriction-for-a-sub-account-api-key-for-master-account

Parameters:

Name Type Attributes Description

email

string

Sub-account email

subAccountApiKey string

ipRestrict

boolean

true or false

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 665

subAccountAssets(email, optionsopt)

Query Sub-account Assets(For Master Account)

GET /sapi/v3/sub-account/assets

https://binance-docs.github.io/apidocs/spot/en/#query-sub-account-assets-for-master-account

Parameters:

Name Type Attributes Description

email string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 68

subAccountCreation(subAccountString, optionsopt)

Create a Virtual Sub-account(For Master Account)

POST /sapi/v1/sub-account/virtualSubAccount

https://binance-docs.github.io/apidocs/spot/en/#create-a-virtual-sub-account-for-master-account

Parameters:

Name Type Attributes Description

subAccountString string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 532

subAccountDepositAddress(email, coin, optionsopt)

Get Sub-account Deposit Address (For Master Account)

GET /sapi/v1/capital/deposit/subAddress

https://binance-docs.github.io/apidocs/spot/en/#get-sub-account-deposit-address-for-master-account

Parameters:

Name Type Attributes Description

email string

coin string

options

object

Properties

Name	Type	Attributes	Description
`network`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 91

subAccountDepositHistory(email, optionsopt)

Get Sub-account Deposit History (For Master Account)

GET /sapi/v1/capital/deposit/subHisrec

https://binance-docs.github.io/apidocs/spot/en/#get-sub-account-deposit-address-for-master-account

Parameters:

Name Type Attributes Description

email string

options

object

Properties

Name	Type	Attributes	Description
`coin`	string	<optional>
`status`	number	<optional>
`startTime`	number	<optional>
`endTime`	number	<optional>
`limit`	number	<optional>
`offset`	number	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 121

subAccountEnableFutures(email, optionsopt)

Enable Futures for Sub-account (For Master Account)

GET /sapi/v1/sub-account/futures/enable

https://binance-docs.github.io/apidocs/spot/en/#enable-futures-for-sub-account-for-master-account

Parameters:

Name Type Attributes Description

email string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 225

subAccountEnableMargin(email, optionsopt)

Enable Margin for Sub-account (For Master Account)

POST /sapi/v1/sub-account/margin/enable

https://binance-docs.github.io/apidocs/spot/en/#enable-margin-for-sub-account-for-master-account

Parameters:

Name Type Attributes Description

email

string

Sub-account email

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 161

subAccountFuturesAccount(email, optionsopt)

Get Detail on Sub-account's Futures Account (For Master Account)

GET /sapi/v1/sub-account/futures/account

https://binance-docs.github.io/apidocs/spot/en/#get-detail-on-sub-account-39-s-futures-account-for-master-account

Parameters:

Name Type Attributes Description

email string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 248

subAccountFuturesAccountSummary(optionsopt)

Get Summary of Sub-account's Futures Account (For Master Account)

GET /sapi/v1/sub-account/futures/accountSummary

https://binance-docs.github.io/apidocs/spot/en/#get-summary-of-sub-account-39-s-futures-account-for-master-account

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 270

subAccountFuturesAccountSummaryV2(futuresType, optionsopt)

Get Summary of Sub-account's Futures Account V2 (For Master Account)

GET /sapi/v2/sub-account/futures/accountSummary

https://binance-docs.github.io/apidocs/spot/en/#get-summary-of-sub-account-39-s-futures-account-v2-for-master-account

Parameters:

Name Type Attributes Description

futuresType

number

1:USDT Margined Futures, 2:COIN Margined Futures

options

object

Properties

Name	Type	Attributes	Description
`page`	number	<optional>	default:1
`limit`	number	<optional>	default:10, max:20
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 827

subAccountFuturesAccountV2(email, futuresType, optionsopt)

Get Detail on Sub-account's Futures Account V2 (For Master Account)

GET /sapi/v2/sub-account/futures/account

https://binance-docs.github.io/apidocs/spot/en/#get-detail-on-sub-account-39-s-futures-account-v2-for-master-account

Parameters:

Name Type Attributes Description

email

string

Sub-account email

futuresType

number

1:USDT Margined Futures, 2:COIN Margined Futures

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 805

subAccountFuturesAssetTransfer(fromEmail, toEmail, futuresType, asset, amount, optionsopt)

Sub-account Futures Asset Transfer(For Master Account)

POST /sapi/v1/sub-account/futures/internalTransfer

https://binance-docs.github.io/apidocs/spot/en/#sub-account-futures-asset-transfer-for-master-account

Parameters:

Name Type Attributes Description

fromEmail

string

Sender email

toEmail

string

Recipient email

futuresType

number

1: USDT-margined Futures，2: Coin-margined Futures

asset string

amount number

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 484

subAccountFuturesAssetTransferHistory(email, futuresType, optionsopt)

Query Sub-account Futures Asset Transfer History(For Master Account)

GET /sapi/v1/sub-account/futures/internalTransfer

https://binance-docs.github.io/apidocs/spot/en/#query-sub-account-futures-asset-transfer-history-for-master-account

Parameters:

Name Type Attributes Description

email

string

Sub-account email

futuresType

number

1: USDT-margined Futures，2: Coin-margined Futures

options

object

Properties

Name	Type	Attributes	Description
`startTime`	number	<optional>	Default return the history with in 100 days
`endTime`	number	<optional>	Default return the history with in 100 days
`page`	number	<optional>	Default value: 1
`limit`	number	<optional>	Default value: 50, Max value: 500
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 456

subAccountFuturesPositionRisk(email, optionsopt)

Get Futures Postion-Risk of Sub-account (For Master Account)

GET /sapi/v1/sub-account/futures/positionRisk

https://binance-docs.github.io/apidocs/spot/en/#get-futures-postion-risk-of-sub-account-for-master-account

Parameters:

Name Type Attributes Description

email string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 289

subAccountFuturesPositionRiskV2(email, futuresType, optionsopt)

Get Futures Position-Risk of Sub-account V2 (For Master Account)

GET /sapi/v2/sub-account/futures/positionRisk

https://binance-docs.github.io/apidocs/spot/en/#get-futures-position-risk-of-sub-account-v2-for-master-account

Parameters:

Name Type Attributes Description

email

string

Sub-account email

futuresType

number

1:USDT Margined Futures, 2:COIN Margined Futures

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 848

subAccountFuturesTransfer(email, asset, amount, type, optionsopt)

Futures Transfer for Sub-account(For Master Account)

POST /sapi/v1/sub-account/futures/transfer

https://binance-docs.github.io/apidocs/spot/en/#futures-transfer-for-sub-account-for-master-account

Parameters:

Name Type Attributes Description

email string

asset string

amount number

type

number

1: transfer from subaccount's spot account to its USDT-margined futures account
2: transfer from subaccount's USDT-margined futures account to its spot account
3: transfer from subaccount's spot account to its COIN-margined futures account
4: transfer from subaccount's COIN-margined futures account to its spot account

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 318

subAccountLeverageToken(email, enableBlvt, optionsopt)

Enable Leverage Token for Sub-account (For Master Account)

POST /sapi/v1/sub-account/blvt/enable

https://binance-docs.github.io/apidocs/spot/en/#enable-leverage-token-for-sub-account-for-master-account

Parameters:

Name Type Attributes Description

email string

enableBlvt boolean

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 553

subAccountList(optionsopt)

Query Sub-account List(For Master Account)

GET /sapi/v1/sub-account/list

https://binance-docs.github.io/apidocs/spot/en/#query-sub-account-list-sapi-for-master-account

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`email`	string	<optional>
`isFreeze`	string	<optional>	true or false
`page`	number	<optional>
`limit`	number	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 25

subAccountMarginAccount(email, optionsopt)

Get Detail on Sub-account's Margin Account (For Master Account)

GET /sapi/v1/sub-account/margin/account

https://binance-docs.github.io/apidocs/spot/en/#get-detail-on-sub-account-39-s-margin-account-for-master-account

Parameters:

Name Type Attributes Description

email string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 184

subAccountMarginAccountSummary(optionsopt)

Get Summary of Sub-account's Margin Account (For Master Account)

GET /sapi/v1/sub-account/margin/accountSummary

https://binance-docs.github.io/apidocs/spot/en/#get-detail-on-sub-account-39-s-margin-account-for-master-account

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 206

subAccountMarginTransfer(email, asset, amount, type, optionsopt)

Margin Transfer for Sub-account(For Master Account)

POST /sapi/v1/sub-account/margin/transfer

https://binance-docs.github.io/apidocs/spot/en/#margin-transfer-for-sub-account-for-master-account

Parameters:

Name Type Attributes Description

email string

asset string

amount number

type

number

1: transfer from subaccount's spot account to margin account
2: transfer from subaccount's margin account to its spot account

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 349

subAccountSpotSummary(optionsopt)

Query Sub-account Spot Assets Summary (For Master Account)

GET /sapi/v1/sub-account/spotSummary

https://binance-docs.github.io/apidocs/spot/en/#query-sub-account-spot-assets-summary-for-master-account

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`email`	string	<optional>	Sub account email
`page`	number	<optional>	default 1
`size`	number	<optional>	default 10, max 20
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 513

subAccountStatus(optionsopt)

Get Sub-account's Status on Margin/Futures(For Master Account)

GET /sapi/v1/sub-account/status

https://binance-docs.github.io/apidocs/spot/en/#get-sub-account-39-s-status-on-margin-futures-for-master-account

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`email`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 142

subAccountTransferHistory(optionsopt)

Query Sub-account Transfer History(For Master Account)

GET /sapi/v1/sub-account/sub/transfer/history

https://binance-docs.github.io/apidocs/spot/en/#query-sub-account-spot-asset-transfer-history-sapi-for-master-account

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`fromEmail`	string	<optional>
`toEmail`	string	<optional>
`startTime`	number	<optional>
`endTime`	number	<optional>
`page`	number	<optional>
`limit`	number	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 49

subAccountTransferSubAccountHistory(optionsopt)

Sub-account Transfer History (For Sub-account)

GET /sapi/v1/sub-account/transfer/subUserHistory

https://binance-docs.github.io/apidocs/spot/en/#sub-account-transfer-history-for-sub-account

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`asset`	string	<optional>	If not sent, result of all assets will be returned
`type`	number	<optional>	1: transfer in, 2: transfer out
`startTime`	number	<optional>
`endTime`	number	<optional>
`limit`	number	<optional>	Default 500
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 432

subAccountTransferToMaster(asset, amount, optionsopt)

Transfer to Master（For Sub-account）

POST /sapi/v1/sub-account/transfer/subToMaster

https://binance-docs.github.io/apidocs/spot/en/#transfer-to-master-for-sub-account

Parameters:

Name Type Attributes Description

asset string

amount number

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 403

subAccountTransferToSub(toEmail, asset, amount, optionsopt)

Transfer to Sub-account of Same Master（For Sub-account）

POST /sapi/v1/sub-account/transfer/subToSub

https://binance-docs.github.io/apidocs/spot/en/#transfer-to-sub-account-of-same-master-for-sub-account

Parameters:

Name Type Attributes Description

toEmail string

asset string

amount number

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/subAccount.js, line 377

subAccountUniversalTransfer(fromAccountType, toAccountType, asset, amount, optionsopt)

Universal Transfer (For Master Account)

POST /sapi/v1/sub-account/universalTransfer

https://binance-docs.github.io/apidocs/spot/en/#universal-transfer-for-master-account

Parameters:

Name Type Attributes Description

fromAccountType

string

"SPOT", "USDT_FUTURE", "COIN_FUTURE", "MARGIN"(Cross), "ISOLATED_MARGIN"

toAccountType

string

"SPOT", "USDT_FUTURE", "COIN_FUTURE", "MARGIN"(Cross), "ISOLATED_MARGIN"

asset string

amount number

options

object

Properties

Name	Type	Attributes	Description
`fromEmail`	string	<optional>
`toEmail`	string	<optional>
`clientTranId`	string	<optional>	Must be unique
`symbol`	string	<optional>	Only supported under ISOLATED_MARGIN type
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 759

subAccountUniversalTransferHistory(optionsopt)

Query Universal Transfer History (For Master Account)

GET /sapi/v1/sub-account/universalTransfer

https://binance-docs.github.io/apidocs/spot/en/#query-universal-transfer-history-for-master-account

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`fromEmail`	string	<optional>
`toEmail`	string	<optional>
`clientTranId`	string	<optional>
`startTime`	string	<optional>
`endTime`	string	<optional>
`page`	string	<optional>	Default 1
`limit`	string	<optional>	Default 500, Max 500
`recvWindow`	number	<optional>

Source: restful/subAccount.js, line 785