Balance
wss://ws-api-spot.kucoin.com
Topic:/account/balance
Description
Relation Event
| Type | Description |
|---|---|
| main.deposit | Deposit |
| main.withdraw_hold | Hold withdrawal amount |
| main.withdraw_done | Withdrawal done |
| main.transfer | Transfer (Main account) |
| main.other | Other operations (Main account) |
| trade.hold | Hold (Trade account) |
| trade.setted | Settlement (Trade account) |
| trade.transfer | Transfer (Trade account) |
| trade.other | Other operations (Trade account) |
| trade_hf.hold | Hold (trade_hf account) |
| trade_hf.setted | Settlement (trade_hf account) |
| trade_hf.transfer | Transfer (trade_hf account) |
| trade_hf.other | Other operations (trade_hf account) |
| margin.hold | Hold (Margin account) |
| margin.setted | Settlement (Margin account) |
| margin.transfer | Transfer (Margin account) |
| margin.other | Other operations (Margin account) |
| isolated_{symbol}.hold | Hold (Isolated margin account) |
| isolated_{symbol}.setted | Settlement (Isolated margin account) |
| isolated_{symbol}.transfer | Transfer (Isolated margin account) |
| isolated_{symbol}.other | Other operations (Isolated margin account) |
| marginV2.hold | Hold (margin_hf account) |
| marginV2.setted | Settlement (margin_hf account) |
| marginV2.transfer | Transfer (margin_hf account) |
| marginV2.other | Other operations (margin_hf account) |
| isolatedV2_{symbol}.hold | Hold (Isolated margin_hf account) |
| isolatedV2_{symbol}.setted | Settlement (Isolated margin_hf account) |
| isolatedV2_{symbol}.transfer | Transfer (Isolated margin_hf account) |
| isolatedV2_{symbol}.other | Other operations (Isolated margin_hf account) |
| other | Others |
Subscribe Message
{
"id": 1545910660739,
"type": "subscribe",
"topic": "/account/balance",
"response": true,
"privateChannel": "true"
}Response
Data SchemaChannel type Account ID currency Total balance = available + hold Funds available to withdraw or trade Funds on hold (not available for use) The change of available Funds The change of hold funds Relation context Relation event Relation event Id
account
topic
string
required
type
string
required
subject
string
required
id
string
required
userId
string
required
channelType
enum<string>
required
Allowed values:
privatepublic
data
object
required
accountId
string
required
currency
string
required
Examples:
BTCETHKCS
total
string
required
available
string
required
hold
string
required
availableChange
string
required
holdChange
string
required
relationContext
object
required
relationEvent
string
required
relationEventId
string
required
time
string
required
Example
{
"topic": "/account/balance",
"type": "message",
"subject": "account.balance",
"id": "354689988084000",
"userId": "633559791e1cbc0001f319bc",
"channelType": "private",
"data": {
"accountId": "548674591753",
"currency": "USDT",
"total": "21.133773386762",
"available": "20.132773386762",
"hold": "1.001",
"availableChange": "-0.5005",
"holdChange": "0.5005",
"relationContext": {
"symbol": "BTC-USDT",
"orderId": "6721d0632db25b0007071fdc"
},
"relationEvent": "trade.hold",
"relationEventId": "354689988084000",
"time": "1730269283892"
}
}
Request
Query Params
token
string
required
Example:
2neAiuYvAU737TOajb2U3uT8AEZqSWYe0fBD4LoHuXJDSC7gIzJiH4kNTWhCPISWo6nDpAe7aUaaHJ4fG8oRjFgMfUI2sM4IySWHrBceFocY8pKy2REU1HwZIngtMdMrjqPnP-biofFWbNaP1cl0X1pZc2SQ-33hDH1LgNP-yg9qww4n8u1w9P_vMywgKFvc.0sZjYOyBIX3RFe0uo4RVCg==
connectId
string
optional
Example:
121345
Modified at 5 months ago