Skip to main content

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

API Description

Query the API Key list of a sub-account.

HTTP Request

GET /sapi/v1/sub-account/subAccountApi

Request Weight(UID)

3000

Request Parameters

NameTypeMandatoryDescription
emailSTRINGYESSub-account email
subAccountApiKeySTRINGNOSpecify an API Key for exact match
pageINTEGERNOPage number, default 1, minimum 1
sizeINTEGERNOPage size, default 30, maximum 100
recvWindowLONGNO
timestampLONGYES

Response Example

{
"total": 1,
"rows": [
{
"email": "sub@example.com",
"apiName": "myKey",
"apikey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"canTrade": true,
"canMarginLoanRepay": false,
"canFuturesTrade": false,
"canUniversalTransfer": false,
"canVanillaOptions": false,
"timestamp": 1640000000000
}
]
}

Response Parameters

NameTypeDescription
totalINTEGERTotal number of records
rowsARRAYAPI Key list, see below
> emailSTRINGSub-account email
> apiNameSTRINGAPI Key name
> apikeySTRINGAPI Key value
> canTradeBOOLEANSpot & Margin trading permission
> canMarginLoanRepayBOOLEANMargin borrow/repay permission
> canFuturesTradeBOOLEANFutures trading permission
> canUniversalTransferBOOLEANUniversal transfer permission
> canVanillaOptionsBOOLEANVanilla options permission
> timestampLONGCreation/Update timestamp (ms)