ND Broker

Add SubAccount API

POST

/api/v1/broker/nd/account/apikey

Description

This interface supports the creation of Broker sub-account APIKEY

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api-broker.kucoin.com/api/v1/broker/nd/account/apikey' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uid": "226383154",
    "passphrase": "11223344",
    "ipWhitelist": [
        "127.0.0.1","123.123.123.123"
    ],
    "permissions": [
        "general","spot"
    ],
    "label": "This is remarks"
}'

Response Example

{
    "code": "200000",
    "data": {
        "uid": "226383154",
        "label": "This is remarks",
        "apiKey": "671afb36cee20f00015cfaf1",
        "secretKey": "d694df2******5bae05b96",
        "apiVersion": 3,
        "permissions": [
            "General",
            "Spot"
        ],
        "ipWhitelist": [
            "127.0.0.1",
            "123.123.123.123"
        ],
        "createdAt": 1729821494000
    }
}

Request

Body Params application/json

uid

string

required

Subaccount UID

passphrase

string

required

API passphrase

ipWhitelist

array[string]

required

IP whitelist list, supports up to 20 IPs

permissions

array[string]

required

Permission group list(Only General、Spot、Futures permissions can be set, such as "General, Trade". )

Allowed values:

generalspotfutures

label

string

required

apikey remarks (length 4~32)

>= 4 characters<= 32 characters

Examples

Responses

🟢200OK

application/json

Body

code

string

required

data

object

required

uid

string

required

Sub-Account UID

label

string

required

apikey remarks

apiKey

string

required

apiKey

secretKey

string

required

secretKey

apiVersion

integer

required

apiVersion

permissions

array[string]

required

Permissions group list

ipWhitelist

array[string]

required

IP whitelist list

createdAt

integer <int64>

required

Creation time, unix timestamp (milliseconds)

Modified at 7 months ago

Add SubAccount

Modify SubAccount API