API Management

Endpoint

Add IP Restriction for Sub-Account API key (For Master Account) (USER_DATA)

Add IP Restriction for Sub-Account API key

POST

/sapi/v2/sub-account/subAccountApi/ipRestriction

https://api.binance.com

Add 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

Add 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

Add 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

Add IP Restriction for Sub-Account API key (For Master Account) (USER_DATA) › Request Body

email

string · required

Example: 123@test.com

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: 69.210.67.14

recvWindow

integer · int64 · max: 60000

Example: 5000

Add IP Restriction for Sub-Account API key (For Master Account) (USER_DATA) › Responses

200

Add 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/sub-account/subAccountApi/ipRestriction

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

Example Request Body

{
  "email": "123@test.com",
  "subAccountApiKey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "status": 1,
  "timestamp": 1770736694138
}

json

Example Responses

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

json

application/json

Query Sub-account API Key (For Master Account) (USER_DATA)

Query the API Key list of a sub-account.

GET

/sapi/v1/sub-account/subAccountApi

https://api.binance.com

Query 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

Query 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

Query 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

Query Sub-account API Key (For Master Account) (USER_DATA) › Query Parameters

email

string · required

Sub-account email

Example: 123@test.com

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

Specify an API Key for exact match

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

page

integer · int64 · min: 1

Page number, default 1, minimum 1

Example: 1

Default: 1

size

integer · int64 · max: 100

Page size, default 30, maximum 100

Example: 30

Default: 30

recvWindow

integer · int64 · max: 60000

Example: 5000

Query Sub-account API Key (For Master Account) (USER_DATA) › Responses

200

Query Sub-account API Key

total

integer · int64

Example: 1

object[]

email

string

Example: 123@test.com

apiName

string

Example: myKey

apikey

string

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

canTrade

boolean

Example: true

canMarginLoanRepay

boolean

Example: false

canFuturesTrade

boolean

Example: false

canUniversalTransfer

boolean

Example: false

canVanillaOptions

boolean

Example: false

timestamp

integer · int64

Example: 1640000000000

Create Sub-account API Key (For Master Account) (USER_DATA)

Create a new API Key for a sub-account.

POST

/sapi/v1/sub-account/subAccountApi

https://api.binance.com

Create 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

Create 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

Create 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

Create Sub-account API Key (For Master Account) (USER_DATA) › Request Body

email

string · required

Sub-account email

Example: 123@test.com

apiName

string · required

API Key name

Example: myKey

status

integer · int64 · required

IP restriction status. 1 = unrestricted, 2 = restricted to trusted IPs, 3 = third-party IP restriction

Example: 2

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

canTrade

boolean

Spot & Margin trading permission, default false

Example: true

canMarginLoanRepay

boolean

Margin borrow/repay permission, default false

Example: false

canFuturesTrade

boolean

Futures trading permission, default false

Example: false

canUniversalTransfer

boolean

Universal transfer permission, default false

Example: false

canVanillaOptions

boolean

Vanilla options permission, default false

Example: false

ipAddress

string

Required when status=2. IP address list, max 500 chars

Example: 69.210.67.14

thirdPartyName

string

Required when status=3. Third-party name

Example: thirdParty

publicKey

string

Ed25519 public key (optional, for Ed25519 type API Key)

Example:

recvWindow

integer · int64 · max: 60000

Example: 5000

Create Sub-account API Key (For Master Account) (USER_DATA) › Responses

200

Create Sub-account API Key

apiName

string

Example: myKey

apiKey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

secretKey

string

Secret Key. Returned only once on creation, please keep it safe.

Example: NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j

canTrade

boolean

Example: true

canMarginLoanRepay

boolean

Example: false

canFuturesTrade

boolean

Example: false

canUniversalTransfer

boolean

Example: false

canVanillaOptions

boolean

Example: false

status

integer · int64

Example: 2

ipList

string[]

POST/sapi/v1/sub-account/subAccountApi

curl --request POST \
  --url https://api.binance.com/sapi/v1/sub-account/subAccountApi \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data email=123@test.com \
  --data apiName=myKey \
  --data status=2 \
  --data timestamp=1770736694138

Example Request Body

{
  "email": "123@test.com",
  "apiName": "myKey",
  "status": 2,
  "timestamp": 1770736694138
}

json

Example Responses

{
  "apiName": "myKey",
  "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
  "secretKey": "NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j",
  "canTrade": true,
  "canMarginLoanRepay": false,
  "canFuturesTrade": false,
  "canUniversalTransfer": false,
  "canVanillaOptions": false,
  "status": 2,
  "ipList": [
    "69.210.67.14"
  ]
}

json

application/json

Delete Sub-account API Key (For Master Account) (USER_DATA)

Delete an API Key of a sub-account.

DELETE

/sapi/v1/sub-account/subAccountApi

https://api.binance.com

Delete 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

Delete 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

Delete 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

Delete Sub-account API Key (For Master Account) (USER_DATA) › Query Parameters

email

string · required

Sub-account email

Example: 123@test.com

subAccountApiKey

string · required

The sub-account API Key to be deleted

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

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

Delete Sub-account API Key (For Master Account) (USER_DATA) › Responses

200

Delete Sub-account API Key

Empty object on success

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

Delete IP List For a Sub-account API Key

DELETE

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

https://api.binance.com

Delete IP List For a 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

Delete IP List For a 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

Delete IP List For a 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

Delete IP List For a Sub-account API Key (For Master Account) (USER_DATA) › Query Parameters

email

string · required

Example: 123@test.com

subAccountApiKey

string · required

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

ipAddress

string · required

IPs to be deleted. Can be added in batches, separated by commas

Example: 69.210.67.14

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

Delete IP List For a Sub-account API Key (For Master Account) (USER_DATA) › Responses

200

Delete IP List For a Sub-account API Key

ipRestrict

string

Example: true

ipList

string[]

updateTime

integer · int64

Example: 1636371437000

apiKey

string

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

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

Get IP Restriction for a Sub-account API Key

GET

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

https://api.binance.com

Get IP Restriction for a 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

Get IP Restriction for a 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

Get IP Restriction for a 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

Get IP Restriction for a Sub-account API Key (For Master Account) (USER_DATA) › Query Parameters

email

string · required

Example: 123@test.com

subAccountApiKey

string · required

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

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

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

200

Get IP Restriction for a Sub-account API Key

ipRestrict

string

Example: true

ipList

string[]

updateTime

integer · int64

Example: 1636371437000

apiKey

string

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

Modify Sub-account API Key Permission (For Master Account) (USER_DATA)

Modify the trading permissions of a sub-account API Key.

POST

/sapi/v1/sub-account/subAccountApiPermission

https://api.binance.com

Modify Sub-account API Key Permission (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

Modify Sub-account API Key Permission (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

Modify Sub-account API Key Permission (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

Modify Sub-account API Key Permission (For Master Account) (USER_DATA) › Request Body

email

string · required

Sub-account email

Example: 123@test.com

subAccountApiKey

string · required

Sub-account API Key

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

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

canTrade

boolean

Spot & Margin trading permission

Example: true

canMarginLoanRepay

boolean

Margin borrow/repay permission

Example: false

canFuturesTrade

boolean

Futures trading permission

Example: true

canUniversalTransfer

boolean

Universal transfer permission

Example: false

canVanillaOptions

boolean

Vanilla options permission

Example: false

recvWindow

integer · int64 · max: 60000

Example: 5000

Modify Sub-account API Key Permission (For Master Account) (USER_DATA) › Responses

200

Modify Sub-account API Key Permission

apiName

string

Example: myKey

apikey

string

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

canTrade

boolean

Example: true

canMarginLoanRepay

boolean

Example: false

canFuturesTrade

boolean

Example: true

canUniversalTransfer

boolean

Example: false

canVanillaOptions

boolean

Example: false

timestamp

integer · int64

Example: 1640000000000

POST/sapi/v1/sub-account/subAccountApiPermission

curl --request POST \
  --url https://api.binance.com/sapi/v1/sub-account/subAccountApiPermission \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data email=123@test.com \
  --data subAccountApiKey=k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf \
  --data timestamp=1770736694138

Example Request Body

{
  "email": "123@test.com",
  "subAccountApiKey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "timestamp": 1770736694138
}

json

Example Responses

{
  "apiName": "myKey",
  "apikey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "canTrade": true,
  "canMarginLoanRepay": false,
  "canFuturesTrade": true,
  "canUniversalTransfer": false,
  "canVanillaOptions": false,
  "timestamp": 1640000000000
}

json

application/json

API Management

Endpoint

Download schema

Add IP Restriction for Sub-Account API key (For Master Account) (USER_DATA)

Add IP Restriction for Sub-Account API key

POST

/sapi/v2/sub-account/subAccountApi/ipRestriction

https://api.binance.com

Add 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

Add 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

Add 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

Add IP Restriction for Sub-Account API key (For Master Account) (USER_DATA) › Request Body

email

string · required

Example: 123@test.com

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: 69.210.67.14

recvWindow

integer · int64 · max: 60000

Example: 5000

Add IP Restriction for Sub-Account API key (For Master Account) (USER_DATA) › Responses

200

Add 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/sub-account/subAccountApi/ipRestriction

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

Example Request Body

{
  "email": "123@test.com",
  "subAccountApiKey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "status": 1,
  "timestamp": 1770736694138
}

json

Example Responses

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

json

application/json

Query Sub-account API Key (For Master Account) (USER_DATA)

Query the API Key list of a sub-account.

GET

/sapi/v1/sub-account/subAccountApi

https://api.binance.com

Query 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

Query 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

Query 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

Query Sub-account API Key (For Master Account) (USER_DATA) › Query Parameters

email

string · required

Sub-account email

Example: 123@test.com

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

Specify an API Key for exact match

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

page

integer · int64 · min: 1

Page number, default 1, minimum 1

Example: 1

Default: 1

size

integer · int64 · max: 100

Page size, default 30, maximum 100

Example: 30

Default: 30

recvWindow

integer · int64 · max: 60000

Example: 5000

Query Sub-account API Key (For Master Account) (USER_DATA) › Responses

200

Query Sub-account API Key

total

integer · int64

Example: 1

object[]

email

string

Example: 123@test.com

apiName

string

Example: myKey

apikey

string

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

canTrade

boolean

Example: true

canMarginLoanRepay

boolean

Example: false

canFuturesTrade

boolean

Example: false

canUniversalTransfer

boolean

Example: false

canVanillaOptions

boolean

Example: false

timestamp

integer · int64

Example: 1640000000000

Create Sub-account API Key (For Master Account) (USER_DATA)

Create a new API Key for a sub-account.

POST

/sapi/v1/sub-account/subAccountApi

https://api.binance.com

Create 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

Create 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

Create 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

Create Sub-account API Key (For Master Account) (USER_DATA) › Request Body

email

string · required

Sub-account email

Example: 123@test.com

apiName

string · required

API Key name

Example: myKey

status

integer · int64 · required

IP restriction status. 1 = unrestricted, 2 = restricted to trusted IPs, 3 = third-party IP restriction

Example: 2

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

canTrade

boolean

Spot & Margin trading permission, default false

Example: true

canMarginLoanRepay

boolean

Margin borrow/repay permission, default false

Example: false

canFuturesTrade

boolean

Futures trading permission, default false

Example: false

canUniversalTransfer

boolean

Universal transfer permission, default false

Example: false

canVanillaOptions

boolean

Vanilla options permission, default false

Example: false

ipAddress

string

Required when status=2. IP address list, max 500 chars

Example: 69.210.67.14

thirdPartyName

string

Required when status=3. Third-party name

Example: thirdParty

publicKey

string

Ed25519 public key (optional, for Ed25519 type API Key)

Example:

recvWindow

integer · int64 · max: 60000

Example: 5000

Create Sub-account API Key (For Master Account) (USER_DATA) › Responses

200

Create Sub-account API Key

apiName

string

Example: myKey

apiKey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

secretKey

string

Secret Key. Returned only once on creation, please keep it safe.

Example: NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j

canTrade

boolean

Example: true

canMarginLoanRepay

boolean

Example: false

canFuturesTrade

boolean

Example: false

canUniversalTransfer

boolean

Example: false

canVanillaOptions

boolean

Example: false

status

integer · int64

Example: 2

ipList

string[]

POST/sapi/v1/sub-account/subAccountApi

curl --request POST \
  --url https://api.binance.com/sapi/v1/sub-account/subAccountApi \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data email=123@test.com \
  --data apiName=myKey \
  --data status=2 \
  --data timestamp=1770736694138

Example Request Body

{
  "email": "123@test.com",
  "apiName": "myKey",
  "status": 2,
  "timestamp": 1770736694138
}

json

Example Responses

{
  "apiName": "myKey",
  "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
  "secretKey": "NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j",
  "canTrade": true,
  "canMarginLoanRepay": false,
  "canFuturesTrade": false,
  "canUniversalTransfer": false,
  "canVanillaOptions": false,
  "status": 2,
  "ipList": [
    "69.210.67.14"
  ]
}

json

application/json

Delete Sub-account API Key (For Master Account) (USER_DATA)

Delete an API Key of a sub-account.

DELETE

/sapi/v1/sub-account/subAccountApi

https://api.binance.com

Delete 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

Delete 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

Delete 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

Delete Sub-account API Key (For Master Account) (USER_DATA) › Query Parameters

email

string · required

Sub-account email

Example: 123@test.com

subAccountApiKey

string · required

The sub-account API Key to be deleted

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

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

Delete Sub-account API Key (For Master Account) (USER_DATA) › Responses

200

Delete Sub-account API Key

Empty object on success

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

Delete IP List For a Sub-account API Key

DELETE

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

https://api.binance.com

Delete IP List For a 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

Delete IP List For a 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

Delete IP List For a 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

Delete IP List For a Sub-account API Key (For Master Account) (USER_DATA) › Query Parameters

email

string · required

Example: 123@test.com

subAccountApiKey

string · required

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

ipAddress

string · required

IPs to be deleted. Can be added in batches, separated by commas

Example: 69.210.67.14

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

Delete IP List For a Sub-account API Key (For Master Account) (USER_DATA) › Responses

200

Delete IP List For a Sub-account API Key

ipRestrict

string

Example: true

ipList

string[]

updateTime

integer · int64

Example: 1636371437000

apiKey

string

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

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

Get IP Restriction for a Sub-account API Key

GET

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

https://api.binance.com

Get IP Restriction for a 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

Get IP Restriction for a 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

Get IP Restriction for a 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

Get IP Restriction for a Sub-account API Key (For Master Account) (USER_DATA) › Query Parameters

email

string · required

Example: 123@test.com

subAccountApiKey

string · required

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

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

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

200

Get IP Restriction for a Sub-account API Key

ipRestrict

string

Example: true

ipList

string[]

updateTime

integer · int64

Example: 1636371437000

apiKey

string

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

Modify Sub-account API Key Permission (For Master Account) (USER_DATA)

Modify the trading permissions of a sub-account API Key.

POST

/sapi/v1/sub-account/subAccountApiPermission

https://api.binance.com

Modify Sub-account API Key Permission (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

Modify Sub-account API Key Permission (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

Modify Sub-account API Key Permission (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

Modify Sub-account API Key Permission (For Master Account) (USER_DATA) › Request Body

email

string · required

Sub-account email

Example: 123@test.com

subAccountApiKey

string · required

Sub-account API Key

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

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

canTrade

boolean

Spot & Margin trading permission

Example: true

canMarginLoanRepay

boolean

Margin borrow/repay permission

Example: false

canFuturesTrade

boolean

Futures trading permission

Example: true

canUniversalTransfer

boolean

Universal transfer permission

Example: false

canVanillaOptions

boolean

Vanilla options permission

Example: false

recvWindow

integer · int64 · max: 60000

Example: 5000

Modify Sub-account API Key Permission (For Master Account) (USER_DATA) › Responses

200

Modify Sub-account API Key Permission

apiName

string

Example: myKey

apikey

string

Example: k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf

canTrade

boolean

Example: true

canMarginLoanRepay

boolean

Example: false

canFuturesTrade

boolean

Example: true

canUniversalTransfer

boolean

Example: false

canVanillaOptions

boolean

Example: false

timestamp

integer · int64

Example: 1640000000000

POST/sapi/v1/sub-account/subAccountApiPermission

curl --request POST \
  --url https://api.binance.com/sapi/v1/sub-account/subAccountApiPermission \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data email=123@test.com \
  --data subAccountApiKey=k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf \
  --data timestamp=1770736694138

Example Request Body

{
  "email": "123@test.com",
  "subAccountApiKey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "timestamp": 1770736694138
}

json

Example Responses

{
  "apiName": "myKey",
  "apikey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "canTrade": true,
  "canMarginLoanRepay": false,
  "canFuturesTrade": true,
  "canUniversalTransfer": false,
  "canVanillaOptions": false,
  "timestamp": 1640000000000
}

json

application/json