Sub-Account Endpoints

Create a Sub-account(For Master Account)

Create a sub-account from the master account.

Response

{
    "subAccount":"mexc1",
    "note":"1"
}

• POST / api/v3/sub-account/virtualSubAccount

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
subAccount	STRING	YES	Sub-account Name
note	STRING	YES	Sub-account notes
recvWindow	LONG	NO
timestamp	LONG	YES

Query Sub-account List (For Master Account)

Get details of the sub-account list

Response

{
    "subAccounts":[
        {
            "subAccount":"mexc666",
            "isFreeze":false,
            "createTime":1544433328000,
            "uid": "49910511"
        },
        {
            "subAccount":"mexc888",
            "isFreeze":false,
            "createTime":1544433328000,
            "uid": "91921059"
        }
    ]
}

• GET / api/v3/sub-account/list

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
subAccount	STRING	NO	Sub-account Name
isFreeze	STRING	NO	true or false
page	INT	NO	Default value: 1
limit	INT	NO	Default value: 10, Max value: 200
timestamp	LONG	YES
recvWindow	LONG	NO

Response:

Name	Description
subAccount	subAccount name
isFreeze	isFreeze
createTime	createTime
uid	subaccount uid

Create an APIKey for a sub-account (For Master Account)

Response

    {
        "subAccount": "mexc1",
        "note": "1",
        "apiKey": "arg13sdfgs",
        "secretKey": "nkjwn21973ihi",
        "permissions": "SPOT_ACCOUNT_READ",
        "ip": "135.181.193",
        "creatTime": 1597026383085
    }

• POST /api/v3/sub-account/apiKey

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
subAccount	STRING	YES	Sub-account Name
note	STRING	YES	APIKey note
permissions	STRING	YES	Permission of APIKey: SPOT_ACCOUNT_READ, SPOT_ACCOUNT_WRITE, SPOT_DEAL_READ, SPOT_DEAL_WRITE, CONTRACT_ACCOUNT_READ, CONTRACT_ACCOUNT_WRITE, CONTRACT_DEAL_READ, CONTRACT_DEAL_WRITE, SPOT_TRANSFER_READ, SPOT_TRANSFER_WRITE
ip	STRING	NO	Link IP addresses, separate with commas if more than one. Support up to 20 addresses.
recvWindow	LONG	NO
timestamp	LONG	YES

Query the APIKey of a sub-account (For Master Account)

Applies to master accounts only

Response

   {
       "subAccount":[
        {
            "note":"v5",
            "apiKey":"arg13sdfgs",
            "permissions":"SPOT_ACCOUNT_READ,SPOT_ACCOUNT_WRITE",
            "ip":"1.1.1.1,2.2.2.2",
            "creatTime":1597026383085
        },
        {
            "note":"v5.1",
            "apiKey":"arg13sdfgs12",
            "permissions":"SPOT_ACCOUNT_READ,SPOT_ACCOUNT_WRITE",
            "ip":"1.1.1.1,2.2.2.2",
            "creatTime":1597026383085
        }
        ]
   }

• GET/api/v3/sub-account/apiKey

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
subAccount	STRING	YES	Sub-account Name
recvWindow	LONG	NO
timestamp	LONG	YES

Delete the APIKey of a sub-account (For Master Account)

Response

  {
           "subAccount":"mexc1"
}

• DELETE /api/v3/sub-account/apiKey

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
subAccount	STRING	YES	Sub-account Name
apiKey	STRING	YES	API public key
recvWindow	LONG	NO
timestamp	LONG	YES

Universal Transfer (For Master Account)

Request

post /api/v3/capital/sub-account/universalTransfer

Response

 {
    "tranId":11945860693 
 }

• POST /api/v3/capital/sub-account/universalTransfer

Permission: SPOT_TRANSFER_WRITE

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
fromAccount	string	NO	Transfer from master account by default if fromAccount is not sent
toAccount	string	NO	Transfer to master account by default if toAccount is not sent
fromAccountType	string	YES	fromAccountType:"SPOT","FUTURES"
toAccountType	string	YES	toAccountType:"SPOT","FUTURES"
asset	string	YES	asset,eg:USDT
amount	string	YES	amount,eg:1.82938475
timestamp	string	YES	timestamp
signature	string	YES	sign

Response:

Name	Type	Description
tranId	string	transfer ID

Query Universal Transfer History (For Master Account)

Request

get /api/v3/capital/sub-account/universalTransfer

Response

  {
    "tranId":"11945860693",
    "fromAccount":"master@test.com",
    "toAccount":"subaccount1@test.com",
    "clientTranId":"test",
    "asset":"BTC",
    "amount":"0.1",
    "fromAccountType":"SPOT",
    "toAccountType":"FUTURE",
    "fromSymbol":"SPOT",
    "toSymbol":"FUTURE",
    "status":"SUCCESS",
    "timestamp":1544433325000
  }

• GET /api/v3/capital/sub-account/universalTransfer

Permission: SPOT_TRANSFER_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
fromAccount	string	NO	Transfer from master account by default if fromAccount is not sent
toAccount	string	NO	Transfer to master account by default if toAccount is not sent
fromAccountType	string	YES	fromAccountType:"SPOT","FUTURES"
toAccountType	string	YES	toAccountType:"SPOT","FUTURES"
startTime	string	NO	startTime
endTime	string	NO	endTime
page	string	NO	default 1
limit	string	NO	default 500, max 500
timestamp	string	YES	timestamp
signature	string	YES	sign

Response:

Name	Type	Description
tranId	string	transfer ID
fromAccount	string	fromAccount
toAccount	string	toAccount
clientTranId	string	clientTranId
asset	string	asset
amount	string	transfer amount
fromAccountType	string	fromAccountType
toAccountType	string	toAccountType
fromSymbol	string	fromSymbol
toSymbol	string	toSymbol
status	string	status
timestamp	number	timestamp

Query Sub-account Asset

request

get /api/v3/sub-account/asset?subAccount=account1&accountType=SPOT&timestamp={{timestamp}}&signature={{signature}}

response

{
    "balances": [
        {
            "asset": "MX",
            "free": "3",
            "locked": "0"
        },
        {
            "asset": "BTC",
            "free": "0.0003",
            "locked": "0"
        }
    ]
}

• GET /api/v3/sub-account/asset

Permission: SPOT_TRANSFER_READ

Weight(IP): 1

request

Name	Type	Mandatory	Description
subAccount	string	Yes	subAccount name,only support query for single subaccount
accountType	string	Yes	account type:"SPOT","FUTURES",only support SPOT currently
timestamp	string	Yes	timestamp
signature	string	Yes	signature

response

Name	Type	Description
balances	string	balance
asset	string	asset
free	string	free
locked	string	locked