- Introduction
- Authentication
- Enums Definitions
- Terms Definitions
- SDK
- Rate Limit
- Change Log
- User Service
- Unified REST
- Introduction
- Market data
- Account
- Orders
- Positions
- Unified Websocket
- Base Info
- Public Channels
- Private Channels
- Add/Cancel Order
- Classic 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
- Market Data
- Orders
- Add Order
- Add Order Test
- Cancel Order By OrderId
- Cancel Order By ClientOid
- Cancel All Orders By Symbol
- Get Symbols With Open Order
- Get Open Orders
- Get Closed Orders
- Get Trade History
- Get Order By OrderId
- Get Order By ClientOid
- Add Stop Order
- Cancel Stop Order By OrderId
- Cancel Stop Order By ClientOid
- 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
- Debit
- Credit
- Risk Limit
- Futures Trading
- Introduction
- 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 Position Mode
- Switch Position 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 Cross Margin Risk Limit
- Get Cross Margin Requirement
- Get Isolated Margin Risk Limit
- Modify Isolated Margin Risk Limit
- Funding Fees
- Copy Trading
- Introduction
- Add Order
- Add Order Test
- Add Take Profit And Stop Loss Order
- Cancel Order By OrderId
- Cancel Order By ClientOid
- Get Max Open Size
- Get Max Withdraw Margin
- Add Isolated Margin
- Remove Isolated Margin
- Modify Isolated Margin Risk Limit
- Modify Isolated Margin Auto-Deposit Status
- Switch Margin Mode
- Modify Cross Margin Leverage
- Get Cross Margin Requirement
- Switch Position Mode
- Earn
- VIP Lending
- Affiliate
- Broker
- Convert
- Account Info
- Classic Websocket
- Base Info
- Spot Trading
- Margin Trading
- Futures Trading
- 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
- Affiliate
- Broker
- Developing
Get Private Token - Classic Spot/Margin
POST
https://api.kucoin.com/api/v1/bullet-private
api-channel:Private
api-permission:General
api-rate-limit-pool:Spot
sdk-service:Spot
sdk-sub-service:Market
sdk-method-name:getPrivateToken
api-rate-limit-weight:10
Description
If you need use private channels (e.g. account balance notice), please make request as follows to obtain the server list and private token
Request
None
Request Code 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/bullet-private'Responses
🟢200OK
application/json
Body
Example
{
"code": "200000",
"data": {
"token": "2neAiuYvAU737TOajb2U3uT8AEZqSWYe0fBD4LoHuXJDSC7gIzJiH4kNTWhCPISWo6nDpAe7aUaaHJ4fG8oRjFgMfUI2sM4IySWHrBceFocY8pKy2REU1HwZIngtMdMrjqPnP-biofFWbNaP1cl0X1pZc2SQ-33hDH1LgNP-yg80ZJv_Ctaj8sAFhTOZ8m1L.jut4vBQxXAseWKxODdGVGg==",
"instanceServers": [
{
"endpoint": "wss://ws-api-spot.kucoin.***/",
"encrypt": true,
"protocol": "websocket",
"pingInterval": 18000,
"pingTimeout": 10000
}
]
}
}Modified at 2025-12-01 13:55:54