KUCOIN API - AU
HomeChange LogAPI DOC V1
HomeChange LogAPI DOC V1
SDK
Telegram
Kucoin
  1. Private Channels
  • Introduction
  • Authentication
  • Enums Definitions
  • Terms Definitions
  • SDK
  • Rate Limit
  • Change Log
  • User Service
    • Market Making Incentive Scheme
    • VIP Fast Track
    • Broker Program
  • 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
        • Add sub-account
        • Add sub-account Margin Permission
        • Add sub-account Futures Permission
        • Get sub-account List - Summary Info
        • Get sub-account Detail - Balance
        • Get sub-account List - Spot Balance (V2)
        • Get sub-account List - Futures Balance (V2)
      • Sub Account API
        • Get sub-account API List
        • Add sub-account API
        • Modify sub-account API
        • Delete sub-account API
      • Deposit
        • Add Deposit Address (V3)
        • Get Deposit Address (V3)
        • Get Deposit History
      • Withdrawals
        • Get Withdrawal Quotas
        • Withdraw (V3)
        • Cancel Withdrawal
        • Get Withdrawal History
        • Get Withdrawal History By ID
      • Transfer
        • Get Transfer Quotas
        • Flex Transfer
      • Trade Fee
        • Get Basic Fee - Spot/Margin
        • Get Actual Fee - Spot/Margin
        • Get Actual Fee - Futures
    • 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 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
    • Margin Trading
      • Market Data
        • Get Symbols - Cross Margin
        • Get Symbols - Isolated Margin
        • Get Mark Price Detail
        • Get Margin Config
        • Get Mark Price List
        • Get Margin Collateral Ratio
        • Get Market Available Inventory
      • 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
      • Debit
        • Borrow
        • Get Borrow History
        • Repay
        • Get Repay History
        • Get Interest History
        • Modify Leverage
      • Credit
        • Get Loan Market
        • Get Loan Market Interest Rate
        • Purchase
        • Modify Purchase
        • Get Purchase Orders
        • Redeem
        • Get Redeem Orders
      • Risk Limit
        • Get Margin Risk Limit
    • Futures Trading
      • Introduction
      • Market Data
        • Get Symbol
        • Get All Symbols
        • Get Ticker
        • Get All Tickers
        • Get Full OrderBook
        • Get Part OrderBook
        • Get Trade History
        • Get Klines
        • Get Mark Price
        • Get Spot Index Price
        • Get Interest Rate Index
        • Get Premium Index
        • Get 24hr stats
        • Get Server Time
        • Get Service Status
      • 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
        • Get Current Funding Rate
        • Get Public Funding History
        • Get Private Funding History
    • Earn
      • Simple Earn
        • Purchase
        • Get Redeem Preview
        • Redeem
        • Get Savings Products
        • Get Promotion Products
        • Get Staking Products
        • Get KCS Staking Products
        • Get Account Holding
    • Affiliate
      • Introduction
      • Get Invited
      • Get Commission
      • Get Trade History
      • Get Transaction
      • Get Kumining
    • Broker
      • Introduction
      • Broker Application
      • Instructions
      • Broker Pro
        • Introduction
        • Broker Fast API Service
        • Get Broker Rebate
        • Get Commission
        • Get User List
        • Get User Transactions
    • Convert
      • Introduction
      • Get Convert Symbol
      • Get Convert Currencies
      • Get Convert Quote
      • Add Convert Order
      • Get Convert Order Detail
      • Get Convert Order History
      • Add Convert Limit Order
      • Get Convert Limit Quote
      • Get Convert Limit Order Detail
      • Get Convert Limit Orders
      • Cancel Convert Limit Order
  • Classic WebSocket
    • Base Info
      • Introduction
      • Get Public Token - Classic Spot/Margin
      • Get Private Token - Classic Spot/Margin
      • Get Public Token - Classic Futures
      • Get Private Token - Classic Futures
    • Spot Trading
      • Public Channels
        • Ticker
        • All Tickers
        • Orderbook - Level 1
        • Orderbook - Level 5
        • Orderbook - Level 50
        • Orderbook - Increment
        • Klines
        • Trade
        • Symbol Snapshot
        • Market Snapshot
      • Private Channels
        • Order V2
        • Order V1
        • Balance
        • Stop Order
    • Margin Trading
      • Public Channels
        • Index Price
        • Mark Price
      • Private Channels
        • Cross Margin Position
        • Isolated Margin Position
    • Futures Trading
      • Public Channels
        • Ticker V2
        • Ticker V1
        • Orderbook - Level 5
        • Orderbook - Level 50
        • Orderbook - Increment
        • Klines
        • Trade
        • Instrument
        • Funding Fee Settlement
        • Symbol Snapshot
      • Private Channels
        • Orders
        • Balance
        • Positions
        • Margin Mode
        • Cross Margin Leverage
        • Stop Orders
  • Error Code
    • HTTP
    • Spot
    • Margin
    • Futures
    • Earn
    • Broker
    • Websocket
  • 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
      • Orders
        • Add Order - Old
        • Add Order Test - Old
        • Batch Add Orders - Old
        • Cancel Order By OrderId - Old
        • Cancel Order By ClientOid - Old
        • Batch Cancel Order - Old
        • Get Orders List - Old
        • Get Recent Orders List - Old
        • Get Order By OrderId - Old
        • Get Order By ClientOid - Old
        • Get Trade History - Old
        • Get Recent Trade History - Old
    • Margin Trading
      • Get Account Detail - Margin
      • Add Order - V1
      • Add Order Test - V1
      • Get Account List - Isolated Margin - V1
      • Get Account Detail - Isolated Margin - V1
    • Futures Trading
      • Modify Isolated Margin Auto - Deposit Status
      • Cancel All Orders - V1
      • Get Position Details - V1
    • Affiliate
      • Get Account
  • Developing
    • Introduction
  1. Private Channels

Positions

wss://ws-api-futures.kucoin.com

Topic: /contract/positionAll#

OR#

Topic:/contract/position:XBTUSDTM#

Description
You will receive this message when position changes.
These situations will cause position change
Position Changes Caused Operations. changeReason Descriptions:
1.
“marginChange”: margin change;
2.
“positionChange”: position change;
3.
“liquidation”: liquidation;
4.
“autoAppendMarginStatusChange”: auto-deposit-status change;
5.
“adl”: adl;
Funding Fee Settlement
Adjustment Isolated Margin Risk Limit Level. msg failure reasons:
1.
the value of the holding position exceeds the limit amount of the risk limit level;
2.
insufficient balance to increase the margin.
Push frequency: real-time

Subscribe Message#

//Get all symbols position change
{
  "id": 1545910660739,
  "type": "subscribe",
  "topic": "/contract/positionAll",
  "response": true,
  "privateChannel": "true"
}

//Get specific symbol position change
{
  "id": 1545910660739,
  "type": "subscribe",
  "topic": "/contract/position:XBTUSDTM",
  "response": true,
  "privateChannel": "true"
}
    

Response#

Data Schema
position

Example
1. Position Changes Caused Operations

// Isolated Margin
{
    "type": "message",
    "topic": "/contract/positionAll",
    "subject": "position.change",
    "data": {
        "symbol": "XBTUSDTM",
        "maintMarginReq": 0.004,
        "riskLimit": 50000000,
        "realLeverage": 19.1376874933,
        "crossMode": false,
        "delevPercentage": 0.87,
        "openingTimestamp": 1771400783360,
        "autoDeposit": false,
        "currentTimestamp": 1771474169458,
        "currentQty": -1,
        "currentCost": -68.0942,
        "currentComm": 0.03794569,
        "unrealisedCost": -68.0942,
        "realisedCost": 0.03794569,
        "isOpen": true,
        "markPrice": 66954.6,
        "markValue": -66.9546,
        "posCost": -68.0942,
        "posCross": 1,
        "posInit": 1.361884,
        "posComm": 0,
        "posLoss": 0.00291083,
        "posMargin": 2.35897317,
        "posFunding": -0.00291083,
        "posMaint": 0.30799116,
        "maintMargin": 3.49857317,
        "avgEntryPrice": 68094.2,
        "liquidationPrice": 70130.5725363,
        "bankruptPrice": 70453.17317,
        "settleCurrency": "USDT",
        "changeReason": "changeRiskLimit",
        "riskLimitLevel": 5,
        "realisedGrossCost": 0.0,
        "realisedGrossPnl": 0.0,
        "realisedPnl": -0.04376735,
        "unrealisedPnl": 1.1396,
        "unrealisedPnlPcnt": 0.0167,
        "unrealisedRoePcnt": 0.8368,
        "leverage": 19.1376874933,
        "marginMode": "ISOLATED",    // CROSS, ISOLATED
        "positionSide": "SHORT",
        "tax": 0,
        "dealComm": -0.04085652,
        "fundingFee": -0.00291083,
        "aggRate": 0.0046
    }
}
      
// Cross Margin
{
    "topic": "/contract/position:XBTUSDTM",
    "type": "message",
    "data": {
        "symbol": "XBTUSDTM",
        "crossMode": true,
        "delevPercentage": 0.06,
        "openingTimestamp": 1717639498983,
        "currentTimestamp": 1717724686618,
        "currentQty": -2,
        "currentCost": -136.002,
        "currentComm": 0.06739824,
        "unrealisedCost": -136.002,
        "realisedCost": 0.06739824,
        "isOpen": true,
        "markPrice": 70778.04,
        "markValue": -141.55608,
        "posCost": -136.002,
        "posInit": 5.4509819612,
        "posMargin": 5.6735903779,
        "avgEntryPrice": 68001,
        "liquidationPrice": 80700.49720065,
        "bankruptPrice": 81152.42267235,
        "settleCurrency": "USDT",
        "changeReason": "positionChange",
        "realisedGrossCost": 0,
        "realisedGrossPnl": 0,
        "realisedPnl": -0.09580416,
        "unrealisedPnl": -5.55408,
        "unrealisedPnlPcnt": -0.0408,
        "unrealisedRoePcnt": -1.0189,
        "leverage": 24.95, 
        "marginMode": "CROSS",       // CROSS, ISOLATED
        "positionSide": "BOTH"
    },
    "subject": "position.change",
    "userId": "665ec530aa70390001d22576",
    "channelType": "private"
}
      
2. Funding Fee Settlement
{
    "type": "message",
    "topic": "/contract/position:XBTUSDTM",
    "subject": "position.settlement",
    "data": {
        "markPrice": 67198.3,          // Settlement price
        "qty": -2,                     // Position size
        "positionSide": "SHORT",
        "settleCurrency": "USDT",      // Currency used to clear and settle the trades
        "fundingTime": 1771488000000,  // Funding time
        "marginMode": "ISOLATED",
        "fundingFee": -0.00309113,     // Funding fees
        "fundingRate": -2.3e-05,       // Funding rate
        "ts": 1771488018495030863      // Current time (nanosecond)
    }
}
      
3. Adjustment Isolated margin Risk Limit Level
{
    "type": "message",
    "topic": "/contract/positionAll",
    "subject": "position.adjustRiskLimit",
    "data": {
        "msg": "Insufficient balance. Cannot increase margin.",                              // Failure reason
        "success": false,
        "riskLimitLevel": 9
    }
}

Request

Query Params

Modified at 2026-02-19 13:03:19
Previous
Balance
Next
Margin Mode