Account

Endpointhttps://api.binance.com

Change Sub Account API Permission

POST

/sapi/v1/broker/subAccountApi/permission

https://api.binance.com

Change Sub Account API Permission › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Change Sub Account API Permission › Request Body

subAccountId

string · required

Example: 1

subAccountApiKey

string · required

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

canTrade

boolean · required

Example: true

marginTrade

boolean · required

Example: true

futuresTrade

boolean · required

Example: true

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Example: 5000

Change Sub Account API Permission › Responses

200

Change Sub Account API Permission

subaccountId

string

Example: 1

apikey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

canTrade

boolean

Example: true

marginTrade

boolean

Example: true

futuresTrade

boolean

Example: true

POST/sapi/v1/broker/subAccountApi/permission

curl --request POST \
  --url https://api.binance.com/sapi/v1/broker/subAccountApi/permission \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data subAccountId=1 \
  --data subAccountApiKey=vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A \
  --data canTrade=true \
  --data marginTrade=true \
  --data futuresTrade=true \
  --data timestamp=1770736694138

Example Request Body

{
  "subAccountId": "1",
  "subAccountApiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
  "canTrade": true,
  "marginTrade": true,
  "futuresTrade": true,
  "timestamp": 1770736694138
}

json

Example Responses

{
  "subaccountId": "1",
  "apikey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
  "canTrade": true,
  "marginTrade": true,
  "futuresTrade": true
}

json

application/json

Query Sub Account

GET

/sapi/v1/broker/subAccount

https://api.binance.com

Query Sub Account › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Query Sub Account › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

subAccountId

string

Example: 1

page

integer · int64

Example: 1

Default: 1

size

integer · int64 · max: 500

Example: 500

Default: 500

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Query Sub Account › Responses

200

Sub Account

object

subaccountId

string

Example: 1

email

string

Example: vai_42038996_47411276_brokersubuser@lac.info

tag

string

Example: bob123

makerCommission

number · float

Example: 0.001

takerCommission

number · float

Example: 0.001

marginMakerCommission

integer · int64

Example: -1

marginTakerCommission

integer · int64

Example: -1

createTime

integer · int64

Example: 1544433328000

Create a Sub Account

Create a Link Sub-account

POST

/sapi/v1/broker/subAccount

https://api.binance.com

Create a Sub Account › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Create a Sub Account › Request Body

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

tag

string

tag length should be less than 32

Example: bob123d

recvWindow

integer · int64 · max: 60000

Example: 5000

Create a Sub Account › Responses

200

Create a Sub Account

subaccountId

string

Example: 1

email

string

Example: vai_42038996_47411276_brokersubuser@lac.info

tag

string

Example: bob123d

Delete Sub Account

Delete Sub Account Caution:

The operation will delete a sub account under your brokerage master account.
Please transfer out all funds from the sub account and delete API key of the sub account before deleting it.
The deleted sub account CANNOT be reverted.
The daily deletion limit for a broker Master is 20 sub accounts.
You need to enable "trade" option for the api key which requests this endpoint.
This endpoint requires user to be whitelisted. Please contact Binance Link team.

DELETE

/sapi/v1/broker/subAccount

https://api.binance.com

Delete Sub Account › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Delete Sub Account › Query Parameters

subAccountId

string · required

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Delete Sub Account › Responses

200

No data returned

Query Sub Account Api Key

GET

/sapi/v1/broker/subAccountApi

https://api.binance.com

Query Sub Account Api Key › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Query Sub Account Api Key › Query Parameters

subAccountId

string · required

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

subAccountApiKey

string

Example: vmP*************

page

integer · int64

Example: 1

Default: 1

size

integer · int64 · max: 500

Example: 500

Default: 500

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Query Sub Account Api Key › Responses

200

Sub Account Api Key

object

apikey

string

Example: vmP*************

subaccountId

string

Example: 1

canTrade

boolean

Example: true

marginTrade

boolean

Example: true

futuresTrade

boolean

Example: false

Create Api Key for Sub Account

POST

/sapi/v1/broker/subAccountApi

https://api.binance.com

Create Api Key for Sub Account › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Create Api Key for Sub Account › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight8

Create Api Key for Sub Account › Request Body

subAccountId

string · required

Example: 1

canTrade

boolean · required

spot trade

Example: true

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

publicKey

string

The public key for asymmetrical key type(Ed25519 and RSA). Please see https://www.binance.com/en/support/faq/detail/6b9a63f1e3384cf48a2eedb82767a69a

Example: null

marginTrade

boolean

margin trade

Example: true

futuresTrade

boolean

futures trade

Example: true

recvWindow

integer · int64 · max: 60000

Example: 5000

Create Api Key for Sub Account › Responses

200

Create Api Key for Sub Account

subaccountId

string

Example: 1

apiKey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

secretKey

string

Example: NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0

canTrade

boolean

Example: true

marginTrade

boolean

Example: false

futuresTrade

boolean

Example: false

Delete Sub Account Api Key

Caution:

This request will delete a api key for a sub account
You need to enable "trade" option for the api key which requests this endpoint
You can only delete 1 api key for each sub account per second

DELETE

/sapi/v1/broker/subAccountApi

https://api.binance.com

Delete Sub Account Api Key › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Delete Sub Account Api Key › Query Parameters

subAccountId

string · required

Example: 1

subAccountApiKey

string · required

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Delete Sub Account Api Key › Responses

200

No data returned

Delete IP Restriction for Sub Account API Key

DELETE

/sapi/v1/broker/subAccountApi/ipRestriction/ipList

https://api.binance.com

Delete IP Restriction for Sub Account API Key › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Delete IP Restriction for Sub Account API Key › Query Parameters

subAccountId

string · required

Example: 1

subAccountApiKey

string · required

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

ipAddress

string

Example: 54.128.193.28

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Delete IP Restriction for Sub Account API Key › Responses

200

Delete IP Restriction for Sub Account API Key

subaccountId

string

Example: 1

apikey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

ipList

string[]

updateTime

integer · int64

Example: 1544433328000

Enable Futures for Sub Account

POST

/sapi/v1/broker/subAccount/futures

https://api.binance.com

Enable Futures for Sub Account › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Enable Futures for Sub Account › Request Body

subAccountId

string · required

Example: 1

futures

string · required

only true for now

Example: true

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Example: 5000

Enable Futures for Sub Account › Responses

200

Enable Futures for Sub Account

subaccountId

string

Example: 1

enableFutures

boolean

Example: true

updateTime

integer · int64

Example: 1570801523523

Enable Or Disable BNB Burn for Sub Account Margin Interest

POST

/sapi/v1/broker/subAccount/bnbBurn/marginInterest

https://api.binance.com

Enable Or Disable BNB Burn for Sub Account Margin Interest › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Enable Or Disable BNB Burn for Sub Account Margin Interest › Request Body

subAccountId

string · required

Example: 1

interestBNBBurn

boolean · required

"true" or "false", margin loan whether uses BNB to pay for margin interest or not

Example: true

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Example: 5000

Enable Or Disable BNB Burn for Sub Account Margin Interest › Responses

200

Enable Or Disable BNB Burn for Sub Account Margin Interest

subAccountId

integer · int64

Example: 1

interestBNBBurn

boolean

Example: true

Enable Or Disable BNB Burn for Sub Account SPOT and MARGIN

POST

/sapi/v1/broker/subAccount/bnbBurn/spot

https://api.binance.com

Enable Or Disable BNB Burn for Sub Account SPOT and MARGIN › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Enable Or Disable BNB Burn for Sub Account SPOT and MARGIN › Request Body

subAccountId

string · required

Example: 1

spotBNBBurn

boolean · required

"true" or "false", spot and margin whether use BNB to pay for transaction fees or not

Example: true

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Example: 5000

Enable Or Disable BNB Burn for Sub Account SPOT and MARGIN › Responses

200

Enable Or Disable BNB Burn for Sub Account SPOT and MARGIN

subAccountId

integer · int64

Example: 1

spotBNBBurn

boolean

Example: true

Enable Universal Transfer Permission for Sub Account API Key

POST

/sapi/v1/broker/subAccountApi/permission/universalTransfer

https://api.binance.com

Enable Universal Transfer Permission for Sub Account API Key › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Enable Universal Transfer Permission for Sub Account API Key › Request Body

subAccountId

string · required

Example: 1

subAccountApiKey

string · required

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

canUniversalTransfer

boolean · required

true or false

Example: true

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Example: 5000

Enable Universal Transfer Permission for Sub Account API Key › Responses

200

Enable Universal Transfer Permission for Sub Account API Key

subaccountId

string

Example: 1

apikey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

canUniversalTransfer

boolean

Example: true

POST/sapi/v1/broker/subAccountApi/permission/universalTransfer

curl --request POST \
  --url https://api.binance.com/sapi/v1/broker/subAccountApi/permission/universalTransfer \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data subAccountId=1 \
  --data subAccountApiKey=vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A \
  --data canUniversalTransfer=true \
  --data timestamp=1770736694138

Example Request Body

{
  "subAccountId": "1",
  "subAccountApiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
  "canUniversalTransfer": true,
  "timestamp": 1770736694138
}

json

Example Responses

{
  "subaccountId": "1",
  "apikey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
  "canUniversalTransfer": true
}

json

application/json

Get BNB Burn Status for Sub Account

GET

/sapi/v1/broker/subAccount/bnbBurn/status

https://api.binance.com

Get BNB Burn Status for Sub Account › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get BNB Burn Status for Sub Account › Query Parameters

subAccountId

string · required

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Get BNB Burn Status for Sub Account › Responses

200

Get BNB Burn Status for Sub Account

subAccountId

integer · int64

Example: 1

spotBNBBurn

boolean

Example: true

interestBNBBurn

boolean

Example: true

Get IP Restriction for Sub Account API Key

GET

/sapi/v1/broker/subAccountApi/ipRestriction

https://api.binance.com

Get IP Restriction for Sub Account API Key › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get IP Restriction for Sub Account API Key › Query Parameters

subAccountId

string · required

Example: 1

subAccountApiKey

string · required

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Get IP Restriction for Sub Account API Key › Responses

200

Get IP Restriction for Sub Account API Key

subaccountId

string

Example: 1

ipRestrict

boolean

Example: true

apikey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

ipList

string[]

updateTime

integer · int64

Example: 1544433328000

Link Account Information (USER_DATA)

Get link account information.

GET

/sapi/v1/broker/info

https://api.binance.com

Link Account Information (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Link Account Information (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Link Account Information (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Link Account Information (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Link Account Information (USER_DATA) › Responses

200

Link Account Information

maxMakerCommission

number · float

Maximum maker commission rate

Example: 0.002

minMakerCommission

number · float

Minimum maker commission rate

Example: 0.001

maxTakerCommission

number · float

Maximum taker commission rate

Example: 0.002

minTakerCommission

number · float

Minimum taker commission rate

Example: 0.001

subAccountQty

integer · int64

Current number of sub-accounts

Example: 400

maxSubAccountQty

integer · int64

Maximum allowed sub-accounts

Example: 1000

Update IP Restriction for Sub-Account API Key (For Master Account) (USER_DATA)

Update IP Restriction for Sub-Account API Key

POST

/sapi/v2/broker/subAccountApi/ipRestriction

https://api.binance.com

Update IP Restriction for Sub-Account API Key (For Master Account) (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Update IP Restriction for Sub-Account API Key (For Master Account) (USER_DATA) › Request Weight

This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.

Learn more in the Rate limits section.

Account Weight3000

Update IP Restriction for Sub-Account API Key (For Master Account) (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Update IP Restriction for Sub-Account API Key (For Master Account) (USER_DATA) › Request Body

subAccountId

string · required

Example: 1

subAccountApiKey

string · required

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

status

integer · int64 · required

IP restriction status. 1 = IP unrestricted. 2 = Restrict access to trusted IPs only.

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

ipAddress

string

Insert static IP in batch, separated by commas.

Example: 24.156.99.202

recvWindow

integer · int64 · max: 60000

Example: 5000

Update IP Restriction for Sub-Account API Key (For Master Account) (USER_DATA) › Responses

200

Update IP Restriction for Sub-Account API Key

status

string

Example: 2

ipList

string[]

updateTime

integer · int64

Example: 1636371437000

apiKey

string

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

POST/sapi/v2/broker/subAccountApi/ipRestriction

curl --request POST \
  --url https://api.binance.com/sapi/v2/broker/subAccountApi/ipRestriction \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data subAccountId=1 \
  --data subAccountApiKey=k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf \
  --data status=1 \
  --data timestamp=1770736694138

Example Request Body

{
  "subAccountId": "1",
  "subAccountApiKey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "status": 1,
  "timestamp": 1770736694138
}

json

Example Responses

{
  "status": "2",
  "ipList": [
    "69.210.67.14"
  ],
  "updateTime": 1636371437000,
  "apiKey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf"
}

json

application/json