KUCOIN API
HomeChange LogAPI DOC V1
Language
  • 繁體中文(即將上綫)
  • Русский (скоро)
HomeChange LogAPI DOC V1
More
SDK
Telegram
Kucoin
  1. REST
  2. Futures Trading
  3. Positions
  • Introduction
  • Authentication
  • Enums Definitions
  • Terms Definitions
  • SDK
  • Rate Limit
  • Change Log
  • User Service
    • Market Making Incentive Scheme
    • VIP Fast Track
    • Broker Program
  • 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
        • Add sub-account API
        • Modify sub-account API
        • Get sub-account API List
        • 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 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
    • Margin Trading
      • Market Data
        • Get Symbols - Cross Margin
        • Get ETF Info
        • Get Mark Price Detail
        • Get Margin Config
        • Get Mark Price List
        • Get Symbols - Isolated Margin
      • 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
      • 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
          GET
        • Switch Margin Mode
          POST
        • Batch Switch Margin Mode
          POST
        • Get Max Open Size
          GET
        • Get Position Details
          GET
        • Get Position List
          GET
        • Get Positions History
          GET
        • Get Max Withdraw Margin
          GET
        • Get Cross Margin Leverage
          GET
        • Modify Cross Margin Leverage
          POST
        • Add Isolated Margin
          POST
        • Remove Isolated Margin
          POST
        • Get Cross Margin Risk Limit
          GET
        • Get Isolated Margin Risk Limit
          GET
        • Modify Isolated Margin Risk Limit
          POST
      • Funding Fees
        • Get Current Funding Rate.
        • Get Public Funding History
        • Get Private Funding History
    • 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
    • Earn
      • Purchase
      • Get Redeem Preview
      • Redeem
      • Get Savings Products
      • Get Promotion Products
      • Get Staking Products
      • Get KCS Staking Products
      • Get ETH Staking Products
      • Get Account Holding
    • VIP Lending
      • Introduction
      • Get Discount Rate Configs
      • Get Loan Info
      • Get Accounts
    • Affiliate
      • Introduction
      • Get Account
    • Broker
      • Introduction
      • Broker Application
      • Instructions
      • API Broker
        • Introduction
        • Get Broker Rebate
      • Exchange Broker
        • Introduction
        • Submit KYC
        • Get KYC Status
        • Get KYC Status List
        • Get Broker Info
        • Add sub-account
        • Get sub-account
        • Add sub-account API
        • Get sub-account API
        • Modify sub-account API
        • Delete sub-account API
        • Transfer
        • Get Transfer History
        • Get Deposit List
        • Get Deposit Detail
        • Get Withdraw Detail
        • Get Broker Rebate
  • Websocket API
    • Base Info
      • Introduction
      • Get Public Token - Spot/Margin
      • Get Private Token - Spot/Margin
      • Get Public Token - Futures
      • Get Private Token - Futures
    • Spot Trading
      • Public Channels
        • Ticker
        • All Tickers
        • Orderbook - Level1
        • Orderbook - Level5
        • Orderbook - Level50
        • Orderbook - Increment
        • Call Auction Orderbook - Level50
        • Call Auction Data
        • 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 - Level5
        • Orderbook - Level50
        • 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
    • CopyTrading
  • 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
  • Developing
    • Introduction
    • Websocket API
      • Add Order
      • Cancel Order
    • Get Account
    • Get Transfer Quotas
    • Flex Transfer
    • Get Account Ledger
  1. REST
  2. Futures Trading
  3. Positions

Get Position List

GET
https://api-futures.kucoin.com/api/v1/positions
domain:Futures
api-channel:Private
api-permission:Futures
api-rate-limit-pool:Futures
sdk-service:Futures
sdk-sub-service:Positions
sdk-method-name:GetPositionList
api-rate-limit-weight:2
Description
Get the position details of a specified position.

Request

Query Params
currency
string 
optional
Currency code, Please refer to rootSymbol , such as USDT,XBT. Query all positions when empty
Examples:
USDTXBTETH

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 GET 'https://api-futures.kucoin.com/api/v1/positions?currency'

Responses

🟢200OK
application/json
Body
code
string 
required
data
array [object {44}] 
required
id
string 
required
Position ID
symbol
string 
required
Symbol of the contract, Please refer to Get Symbol endpoint: symbol
Examples:
XBTUSDTMXBTUSDMETHUSDTM
marginMode
enum<string> 
required
Margin Mode: CROSS,ISOLATED
Allowed values:
CROSSISOLATED
crossMode
boolean 
required
Whether it is cross margin.
delevPercentage
number 
required
ADL ranking percentile
openingTimestamp
integer <int64>
required
First opening time
currentTimestamp
integer <int64>
required
Current timestamp
currentQty
integer 
required
Current postion quantity
currentCost
number 
required
Current postion value
currentComm
number 
required
Current commission
unrealisedCost
number 
required
Unrealised value
realisedGrossCost
number 
required
Accumulated realised gross profit value
realisedCost
number 
required
Current realised position value
unrealisedPnl
number 
required
Unrealised profit and loss
unrealisedPnlPcnt
number 
required
Profit-loss ratio of the position
unrealisedRoePcnt
number 
required
Rate of return on investment
realisedGrossPnl
number 
required
Accumulated realised gross profit value
isOpen
boolean 
required
Opened position or not
markPrice
number 
required
Mark price
markValue
number 
required
Mark Value
posCost
number 
required
Position value
posInit
number 
required
Inital margin Cross = opening value/cross leverage; isolated = accumulation of initial margin for each transaction
posMargin
number 
required
Bankruptcy cost Cross = mark value * imr; Isolated = position margin (accumulation of initial margin, additional margin, generated funding fees, etc.)
realisedPnl
number 
required
Realised profit and loss
avgEntryPrice
number 
required
Average entry price
liquidationPrice
number 
required
Liquidation price For Cross Margin, you can refer to the liquidationPrice, and the liquidation is based on the risk rate.
bankruptPrice
number 
required
Bankruptcy price For Cross Margin, you can refer to the bankruptPrice, and the liquidation is based on the risk rate.
settleCurrency
string 
required
Currency used to clear and settle the trades
isInverse
boolean 
required
Reverse contract or not
positionSide
enum<string> 
required
Position Side
Allowed value:
BOTH
leverage
number 
required
Leverage
maintMarginReq
number 
optional
Maintenance margin requirement
posMaint
number 
optional
Maintenance margin
autoDeposit
boolean 
optional
Auto deposit margin or not Only applicable to Isolated Margin
riskLimit
number 
optional
Risk limit Only applicable to Isolated Margin
realLeverage
number 
optional
Leverage of the order Only applicable to Isolated Margin
posCross
number 
optional
added margin Only applicable to Isolated Margin
posCrossMargin
number 
optional
Additional margin calls (automatic, manual, adjusted risk limits) Only applicable to Isolated Margin
posComm
number 
optional
Bankruptcy cost Only applicable to Isolated Margin
posCommCommon
number 
optional
Part of bankruptcy cost (positioning, add margin) Only applicable to Isolated Margin
posLoss
number 
optional
Funding fees paid out Only applicable to Isolated Margin
posFunding
number 
optional
The current remaining unsettled funding fee for the position Only applicable to Isolated Margin
maintMargin
number 
optional
Position margin Only applicable to Isolated Margin
maintainMargin
number 
optional
Maintenance margin rate Only applicable to Isolated Margin
Example
{
  "code": "200000",
  "data": [
    {
      "id": "500000000001046430",
      "symbol": "ETHUSDM",
      "crossMode": true,
      "delevPercentage": 0.71,
      "openingTimestamp": 1730635780702,
      "currentTimestamp": 1730636040926,
      "currentQty": 1,
      "currentCost": -0.0004069805,
      "currentComm": 2.441e-7,
      "unrealisedCost": -0.0004069805,
      "realisedGrossCost": 0,
      "realisedCost": 2.441e-7,
      "isOpen": true,
      "markPrice": 2454.12,
      "markValue": -0.000407478,
      "posCost": -0.0004069805,
      "posInit": 0.0000406981,
      "posMargin": 0.0000407478,
      "realisedGrossPnl": 0,
      "realisedPnl": -2.441e-7,
      "unrealisedPnl": -4.975e-7,
      "unrealisedPnlPcnt": -0.0012,
      "unrealisedRoePcnt": -0.0122,
      "avgEntryPrice": 2457.12,
      "liquidationPrice": 1429.96,
      "bankruptPrice": 1414.96,
      "settleCurrency": "ETH",
      "isInverse": true,
      "marginMode": "CROSS",
      "positionSide": "BOTH",
      "leverage": 10
    },
    {
      "id": "500000000000988255",
      "symbol": "XBTUSDTM",
      "autoDeposit": true,
      "crossMode": false,
      "maintMarginReq": 0.005,
      "riskLimit": 500000,
      "realLeverage": 2.97,
      "delevPercentage": 0.5,
      "openingTimestamp": 1729155616322,
      "currentTimestamp": 1730636040926,
      "currentQty": 1,
      "currentCost": 67.4309,
      "currentComm": -0.15936162,
      "unrealisedCost": 67.4309,
      "realisedGrossCost": 0,
      "realisedCost": -0.15936162,
      "isOpen": true,
      "markPrice": 68323.06,
      "markValue": 68.32306,
      "posCost": 67.4309,
      "posCross": 0.06225152,
      "posCrossMargin": 0,
      "posInit": 22.2769666644,
      "posComm": 0.0539821899,
      "posCommCommon": 0.0539447199,
      "posLoss": 0.26210915,
      "posMargin": 22.1310912243,
      "posFunding": -0.19982016,
      "posMaint": 0.4046228699,
      "maintMargin": 23.0232512243,
      "realisedGrossPnl": 0,
      "realisedPnl": -0.2402787,
      "unrealisedPnl": 0.89216,
      "unrealisedPnlPcnt": 0.0132,
      "unrealisedRoePcnt": 0.04,
      "avgEntryPrice": 67430.9,
      "liquidationPrice": 45704.44,
      "bankruptPrice": 45353.8,
      "settleCurrency": "USDT",
      "isInverse": false,
      "maintainMargin": 0.005,
      "marginMode": "ISOLATED",
      "positionSide": "BOTH",
      "leverage": 2.97
    }
  ]
}
Modified at about 2 months ago
Previous
Get Position Details
Next
Get Positions History