- 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
- 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
- Funding Fees
- Copy Trading
- Earn
- VIP Lending
- Affiliate
- Broker
- 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.kucoin.com/api/v1/sub/api-key
domain:Spot
api-channel:Private
api-permission:General
api-rate-limit-pool:Management
sdk-service:Account
sdk-sub-service:SubAccount
sdk-method-name:addSubAccountApi
api-rate-limit-weight:20
Description
Request
Body Params application/json
subName
string
required
passphrase
string
required
remark
string
required
permission
string
optional
Default:
General
Example:
General, Trade
ipWhitelist
string
optional
expire
enum<string>
optional
Allowed values:
-13090180360
Default:
-1
Example:
30
Example
{
"subName": "testapi6",
"passphrase": "11223344",
"remark": "TheRemark",
"permission": "General,Spot,Futures"
}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.kucoin.com/api/v1/sub/api-key' \
--header 'Content-Type: application/json' \
--data-raw '{
"subName": "testapi6",
"passphrase": "11223344",
"remark": "TheRemark",
"permission": "General,Spot,Futures"
}'Responses
🟢200OK
application/json
Body
code
string
required
data
object
required
subName
string
required
remark
string
required
apiKey
string
required
apiSecret
string
required
apiVersion
integer
required
passphrase
string
required
permission
string
required
ipWhitelist
string
optional
createdAt
integer <int64>
required
Example
{
"code": "200000",
"data": {
"subName": "testapi6",
"remark": "TheRemark",
"apiKey": "670621e3a25958000159c82f",
"apiSecret": "46fd8974******896f005b2340",
"apiVersion": 3,
"passphrase": "11223344",
"permission": "General,Futures",
"createdAt": 1728455139000
}
}Modified at 2025-02-15 03:34:23