Create end-user API key

• POST /api/v3/accountCenter/apiKey

Weight(IP): 5

Creates an API key for a specified end user. The secret is returned only once upon successful creation and should be stored securely.

Request parameters

Parameter	Type	Required?	Description
subUserId	Long	Yes	End-user UID.
passphrase	String	Yes	API key passphrase. 8-31 characters long. Only letters or numbers are allowed. No spaces or special characters.
authorities	String[]	No	API key permissions. Defaults to ACCOUNT_DETAILS if omitted.
ipWhiteList	String[]	Conditional	IP allowlist (up to 10 entries). Required if any non-read-only permission is enabled.
remark	String	No	API key remark.

API key permission enums

Permission	Description
ACCOUNT_DETAILS	Read-only access to account details.
SPOT_TRADING	Spot trading permission.
FUTURES_TRADING	Futures trading permission.
TRANSFER	Fund transfer permission.
WITHDRAW	Withdrawal permission.

Request example

{
  "subUserId": 1234567890,
  "passphrase": "abc12345",
  "authorities": ["ACCOUNT_DETAILS", "TRANSFER"],
  "ipWhiteList": ["127.0.0.1"],
  "remark": "sub user key"
}

Response parameters

Field name	Type	Description
subUserId	Long	End-user UID.
apiKey	String	API key.
secret	String	Secret key, returned only once upon creation.
authorities	String[]	API key permissions.
ipWhiteList	String[]	IP allowlist.

Response example

{
  "subUserId": 1234567890,
  "apiKey": "weex_xxxxxxxxxxxxxxxxxxxxxxxx",
  "secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "authorities": ["ACCOUNT_DETAILS", "TRANSFER"],
  "ipWhiteList": ["127.0.0.1"]
}