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 Name | Required | Type | Notes |
---|---|---|---|
market | false | string | Market name |
market_type | true | string | Market type. Note: In spot related functions, only SPOT or MARGIN can be used. In futures related functions, only FUTURES can be used. |
position_id | false | int | Position ID |
start_time | false | int | Query start time.
|
end_time | false | int | Query end time.
|
page | false | int | Number of pagination. Default is 1 |
limit | false | int | Number in each page. Default is 10 |
Return parameters
Parameter Name | Type | Notes |
---|---|---|
market | string | Market name |
market_type | string | Market Type |
position_id | int | Position ID |
margin_mode | string | Position type |
leverage | int | Leverage |
liq_price | string | Liquidation 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_price | string | Bankruptcy price. (Long position) Bankruptcy price = Settlement price* (1 - forced liquidation margin rate) (Short position) Bankruptcy price = Settlement price* (1 + liquidation margin rate) |
settle_price | string | Settlement price, calculated as mark price |
open_interest | string | Position |
margin_avbl | string | Margin available after execution.Current margin amount = Initial margin + added margin - reduced margin |
margin_change | string | Adjusted margin amount. Positive means increasing the margin, and negative means decreasing the margin. |
created_at | int | Data 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
}
}