- Introduction
- Authentication
- Enums Definitions
- Terms Definitions
- SDK
- Rate Limit
- Change Log
- User Service
- REST
- Account Info
- Account & Funding
- Get Account Summary Info
- Get Apikey Info
- Get Account Type - Spot
- Get Account List - Spot
- Get Account Detail - Spot
- Get Account - Cross Margin
- Get Account - Isolated Margin
- Get Account - Futures
- Get Account Ledgers - Spot/Margin
- Get Account Ledgers - Trade_hf
- Get Account Ledgers - Margin_hf
- Get Account Ledgers - Futures
- Sub Account
- Sub Account API
- Deposit
- Withdrawals
- Transfer
- Trade Fee
- Account & Funding
- Spot Trading
- Market Data
- Get Announcements
- Get Currency
- Get All Currencies
- Get Symbol
- Get All Symbols
- Get Ticker
- Get All Tickers
- Get Trade History
- Get Klines
- Get Part OrderBook
- Get Full OrderBook
- Get Call Auction Part OrderBook
- Get Call Auction Info
- Get Fiat Price
- Get 24hr Stats
- Get Market List
- Get Client IP Address
- Get Server Time
- Get Service Status
- Orders
- Add Order
- Add Order Sync
- Add Order Test
- Batch Add Orders
- Batch Add Orders Sync
- Cancel Order By OrderId
- Cancel Order By OrderId Sync
- Cancel Order By ClientOid
- Cancel Order By ClientOid Sync
- Cancel Partial Order
- Cancel All Orders By Symbol
- Cancel All Orders
- Modify Order
- Get Order By OrderId
- Get Order By ClientOid
- Get Symbols With Open Order
- Get Open Orders
- Get Open Orders By Page
- Get Closed Orders
- Get Trade History
- Get DCP
- Set DCP
- Add Stop Order
- Cancel Stop Order By ClientOid
- Cancel Stop Order By OrderId
- Batch Cancel Stop Orders
- Get Stop Orders List
- Get Stop Order By OrderId
- Get Stop Order By ClientOid
- Add OCO Order
- Cancel OCO Order By OrderId
- Cancel OCO Order By ClientOid
- Batch Cancel OCO Order
- Get OCO Order By OrderId
- Get OCO Order By ClientOid
- Get OCO Order Detail By OrderId
- Get OCO Order List
- Market Data
- Margin Trading
- Futures Trading
- Market Data
- Orders
- Add Order
- Add Order Test
- Batch Add Orders
- Add Take Profit And Stop Loss Order
- Cancel Order By OrderId
- Cancel Order By ClientOid
- Batch Cancel Orders
- Cancel All Orders
- Cancel All Stop orders
- Get Order By OrderId
- Get Order By ClientOid
- Get Order List
- Get Recent Closed Orders
- Get Stop Order List
- Get Open Order Value
- Get Recent Trade History
- Get Trade History
- Positions
- Get Margin Mode
- Switch Margin Mode
- Batch Switch Margin Mode
- Get Max Open Size
- Get Position Details
- Get Position List
- Get Positions History
- Get Max Withdraw Margin
- Get Cross Margin Leverage
- Modify Cross Margin Leverage
- Add Isolated Margin
- Remove Isolated Margin
- Get Isolated Margin Risk Limit
- Modify Isolated Margin Risk Limit
- Funding Fees
- Copy Trading
- Earn
- VIP Lending
- Affiliate
- Broker
- Introduction
- Broker Application
- Instructions
- API Broker
- Exchange Broker
- Introduction
- Submit KYCPOST
- Get KYC StatusGET
- Get KYC Status ListGET
- Get Broker InfoGET
- Add sub-accountPOST
- Get sub-accountGET
- Add sub-account APIPOST
- Get sub-account APIGET
- Modify sub-account APIPOST
- Delete sub-account APIDELETE
- TransferPOST
- Get Transfer HistoryGET
- Get Deposit ListGET
- Get Deposit DetailGET
- Get Withdraw DetailGET
- Get Broker RebateGET
- Websocket API
- Error Code
- Abandoned Endpoints
- Introduction
- Account & Funding
- Get sub-account List - Summary Info (V1)
- Get sub-account List - Spot Balance (V1)
- Get Deposit Addresses (V2)
- Get Deposit Addresses - V1
- Sub-account Transfer
- Get Deposit History - Old
- Internal Transfer
- Get Futures Account Transfer Out Ledger
- Get Withdrawal History - Old
- Futures Account Transfer Out
- Futures Account Transfer In
- Add Deposit Address - V1
- Withdraw - V1
- Spot Trading
- Margin Trading
- Futures Trading
- Developing
Add sub-account API
POST
https://api-broker.kucoin.com/api/v1/broker/nd/account/apikey
domain:Broker
api-channel:Private
api-permission:General
api-rate-limit-pool:Broker
sdk-service:Broker
sdk-sub-service:NDBroker
sdk-method-name:addSubAccountApi
api-rate-limit-weight:3
Description
Request
Authorization
Body Params application/json
uid
string
required
passphrase
string
required
ipWhitelist
array[string]
required
permissions
array[string]
required
Allowed values:
generalspotfutures
label
string
required
>= 4 characters<= 32 characters
Example
{
"uid": "226383154",
"passphrase": "11223344",
"ipWhitelist": [
"127.0.0.1",
"123.123.123.123"
],
"permissions": [
"general",
"spot"
],
"label": "This is remarks"
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request 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"
}'Responses
🟢200OK
application/json
Body
code
string
required
data
object
required
uid
string
required
label
string
required
apiKey
string
required
secretKey
string
required
apiVersion
integer
required
permissions
array[string]
required
ipWhitelist
array[string]
required
createdAt
integer <int64>
required
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
}
}Modified at 2025-05-14 03:58:54