Skip to main content

Get Position Auto Settlement History

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.
(Long position) Forced liquidation price = Settlement price* (1 - forced liquidation margin rate)/(1 - maintenance margin rate)
(Short position) Forced liquidation price = Settlement price*(1 + forced liquidation margin rate)/(1 + maintenance margin rate)
bkr_pricestringBankruptcy price.
(Long position) Bankruptcy price = Settlement price* (1 - forced liquidation margin rate)
(Short position) Bankruptcy price = Settlement price* (1 + liquidation margin rate)
settle_pricestringSettlement price, calculated as mark price
open_intereststringPosition
margin_avblstringMargin available after execution.Current margin amount = Initial margin + added margin - reduced margin
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",
"open_interest": "129384.12"
"margin_avbl": "189132.05",
"margin_change": "5000",
"created_at": 1691482451000
}
],
"pagination": {
"has_next": false
}
}