Skip to main content

Get Position Auto Settlement History

Dangerous

This endpoint has been taken offline and is no longer available. This document is for historical reference only.

Info
  • This endpoint requires signature. For specific signature rules, please refer to Authentication
  • This endpoint will trigger rate limit. For specific rules, please refer to Rate Limit.
Reminder

Auto Settlement refers to the process of settling unrealized PNL at expiration, converting them into realized PNL, and placing them in position margins. During settlement, there is excess margin in the position margin, which supports manual transfer (isolated margin mode) and automatic settlement transfer (cross margin mode) to available balance. The settlement period supports dynamic adjustment, defaulting to once every 8 hours. If the market premium rate is too high, the settlement period may dynamically adjust to every 4 hours or even 2 hours.

HTTP request

GET /futures/position-settle-history

Request parameters

Parameter NameRequiredTypeNotes
marketfalsestringMarket name
market_typetruestringMarket type.
Note: In spot related functions, only SPOT or MARGIN can be used.
In futures related functions, only FUTURES can be used.
position_idfalseintPosition ID
start_timefalseintQuery start time.
  • Data will not be filtered based on time by default
end_timefalseintQuery end time.
  • Data will not be filtered based on time by default
pagefalseintNumber of pagination. Default is 1
limitfalseintNumber in each page. Default is 10

Return parameters

Parameter NameTypeNotes
marketstringMarket name
market_typestringMarket Type
position_idintPosition ID
margin_modestringPosition type
leverageintLeverage
liq_pricestringLiquidation price.The estimated trigger price calculated by the system in real time based on the current mark price.The calculation takes into account factors such as position mode (One-way/Hedge Mode), contract type (USDⓈ-margined/Coin-margined), position size, settlement price, margin, maintenance margin, unrealized PNL, and potential risks of unfilled orders.In cross margin mode, positions under the same settlement asset jointly affect the liquidation price; in isolated margin mode, it is calculated independently for that position. The liquidation price may change accordingly when the market price, order status, or account funds change. When no valid liquidation price exists, the interface return value is subject to the actual response.
bkr_pricestringBankruptcy price.
The bankruptcy price in cross margin is no longer calculated.
The bankruptcy price in isolated margin can be calculated using the liquidation price formula, where the maintenance margin rate is 0.
settle_pricestringSettlement price, calculated as mark price
settle_valuestringSettlement value, calculated as mark price
risk_ratestringPosition risk rate. The calculation considers position margin, unrealized PNL, maintenance margin, and the potential risks of unexecuted orders; the value will be adjusted in real time with changes in mark price, orders, and funds.
open_intereststringPosition
margin_avblstringMargin allocated after execution.
Cross margin: USDⓈ-margined contract = open position amount * mark price / leverage; Coin-margined contract = open position amount / mark price / leverage.
Isolated margin: Initial margin + added margin - reduced margin.
Upon partial closing, the allocated margin decreases proportionally based on the closing ratio; adding/reducing margin in isolated margin includes manual transfers and funding fee settlements.
margin_changestringAdjusted margin amount. Positive means increasing the margin, and negative means decreasing the margin.
created_atintData creation time

Request example

GET /futures/position-settle-history?market=CETUSDT&market_type=FUTURES&position_id=927266133&start_time=1636451914231&page=1&limit=100

Response example

{
"code": 0,
"message": "OK",
"data": [
{
"market": "CETUSDT",
"market_type": "FUTURES",
"position_id": 927266133,
"margin_mode": "cross",
"leverage": "10",
"liq_price": "0.05679",
"bkr_price": "0.053635",
"settle_price": "0.06817",
"settle_value": "1291322.83913829",
"risk_rate": "0.1234",
"open_interest": "129384.12",
"margin_avbl": "189132.05",
"margin_change": "5000",
"created_at": 1691482451000
}
],
"pagination": {
"has_next": false
}
}