Positions
Poloniex futures v1/v2 API will be officially offline on November 30, 2024. You can access the V3 API to provide you with a better trading experience.
Get Position Details
Get the position details of a specified position.
HTTP Request
GET https://futures-api.poloniex.com/api/v1/position
Example
GET https://futures-api.poloniex.com/api/v1/position?symbol=BTCUSDTPERP
API Permission
This endpoint requires the General permission.
REQUEST RATE LIMIT
This API is restricted for each account, the request rate limit is 9 times/3s.
PARAMETERS
| Param | Type | Description |
|---|---|---|
| symbol | String | Symbol of the contract |
Example:
{
"id": "5ce3cda60c19fc0d4e9ae7cd", //Position ID
"symbol": "BTCUSDTPERP", //Symbol
"autoDeposit": true, //Deprecated,Auto deposit margin or not
"maintMarginReq": 0.005, //Maintenance margin requirement
"riskLimit": 200, //Risk limit
"realLeverage": 1.06, //position level
"marginType": 0, //Margin Mode 0(Isolated) 1(Cross)
"delevPercentage": 0.1, //ADL ranking percentile
"openingTimestamp": 1558433191000, //Open time
"currentTimestamp": 1558507727807, //Current timestamp
"currentQty": -20, //Current position
"currentCost": 0.00266375, //Deprecated,Current position value
"currentComm": 0.00000271, //Deprecated,Current commission
"unrealisedCost": 0.00266375, //Deprecated,Unrealised value
"realisedGrossCost": 0, //Deprecated,Accumulated realised gross profit value
"realisedCost": 0.00000271, //Current realised position value
"isOpen": true, //Opened position or not
"markPrice": 7933.01, //Mark price
"markValue": 0.00252111, //Mark value
"posCost": 0.00266375, //Position value
"posCross": 1.2e-7, //Manually added margin
"posInit": 0.00266375, //Leverage margin
"posComm": 0.00000392, //Deprecated,Bankruptcy cost
"posLoss": 0, //Deprecated,Funding fees paid out
"posMargin": 0.00266779, //Position margin
"posMaint": 0.00001724, //Maintenance margin
"maintMargin": 0.00252516, //Position margin
"realisedGrossPnl": 0, //Accumulated realised gross profit value
"realisedPnl": -0.00000253, //Realised profit-loss of the position
"unrealisedPnl": -0.00014264, //Unrealised profit and loss
"unrealisedPnlPcnt": -0.0535, //Profit-loss ratio of the position
"unrealisedRoePcnt": -0.0535, //Rate of return on investment
"avgEntryPrice": 7508.22, //Average entry price
"liquidationPrice": 1000000, //Liquidation price
"bankruptPrice": 1000000, //Bankruptcy price
"settleCurrency": "USDT" //Currency used to clear and settle the trades
}
Get Position List
Get the position details of a specified position.
HTTP Request
GET https://futures-api.poloniex.com/api/v1/positions
Example
GET https://futures-api.poloniex.com/api/v1/positions
API Permission
This endpoint requires the General permission.
Example:
{
"id": "5ce3cda60c19fc0d4e9ae7cd", //Position ID
"symbol": "BTCUSDTPERP", //Symbol
"autoDeposit": true, //Deprecated,Auto deposit margin or not
"maintMarginReq": 0.005, //Maintenance margin requirement
"riskLimit": 200, //Risk limit
"realLeverage": 1.06, //position level
"marginType": 0, //Margin Mode 0(Isolated) 1(Cross)
"delevPercentage": 0.1, //ADL ranking percentile
"openingTimestamp": 1558433191000, //Open time
"currentTimestamp": 1558507727807, //Current timestamp
"currentQty": -20, //Current position
"currentCost": 0.00266375, //Deprecated,Current position value
"currentComm": 0.00000271, //Deprecated,Current commission
"unrealisedCost": 0.00266375, //Deprecated,Unrealised value
"realisedGrossCost": 0, //Deprecated,Accumulated realised gross profit value
"realisedCost": 0.00000271, //Current realised position value
"isOpen": true, //Opened position or not
"markPrice": 7933.01, //Mark price
"markValue": 0.00252111, //Mark value
"posCost": 0.00266375, //Position value
"posCross": 1.2e-7, //Manually added margin
"posInit": 0.00266375, //Leverage margin
"posComm": 0.00000392, //Deprecated,Bankruptcy cost
"posLoss": 0, //Deprecated,Funding fees paid out
"posMargin": 0.00266779, //Position margin
"posMaint": 0.00001724, //Maintenance margin
"maintMargin": 0.00252516, //Position margin
"realisedGrossPnl": 0, //Accumulated realised gross profit value
"realisedPnl": -0.00000253, //Realised profit-loss of the position
"unrealisedPnl": -0.00014264, //Unrealised profit and loss
"unrealisedPnlPcnt": -0.0535, //Profit-loss ratio of the position
"unrealisedRoePcnt": -0.0535, //Rate of return on investment
"avgEntryPrice": 7508.22, //Average entry price
"liquidationPrice": 1000000, //Liquidation price
"bankruptPrice": 1000000, //Bankruptcy price
"settleCurrency": "USDT" //Currency used to clear and settle the trades
}
Add Margin Manually
HTTP Request
POST https://futures-api.poloniex.com/api/v1/position/margin/deposit-margin
Example
POST https://futures-api.poloniex.com/api/v1/position/margin/deposit-margin
API Permission
This endpoint requires the General permission.
PARAMETERS
| Param | Type | Description |
|---|---|---|
| symbol | String | Ticker symbol of the contract |
| margin | Number | Margin amount (min. margin amount≥0.00001667XBT） |
| bizNo | String | A unique ID generated by the user, to ensure the operation is processed by the system only once |
Remove Margin Manually
HTTP Request
POST https://futures-api.poloniex.com/api/v1/position/margin/withdraw-margin
Example
POST https://futures-api.poloniex.com/api/v1/position/margin/withdraw-margin
API Permission
This endpoint requires the General permission.
PARAMETERS
| Param | Type | Description |
|---|---|---|
| symbol | String | Ticker symbol of the contract |
| margin | Number | Margin amount |
| bizNo | String | A unique ID generated by the user, to ensure the operation is processed by the system only once |
Get leverage
This interface allows users to query the leverage level
HTTP Request
GET /api/v2/position/leverage
Example
GET https://futures-api.poloniex.com/api/v2/position/leverage
API Permission
This endpoint requires the General permission.
PARAMETERS
| Parameter | Required | Type | Description |
|---|---|---|---|
| symbol | TRUE | String | symbol |
Set leverage
This interface allows users to set the leverage level
HTTP Request
POST /api/v2/position/leverage
Example
POST https://futures-api.poloniex.com/api/v2/position/leverage
API Permission
This endpoint requires the Trade permission
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| symbol | TRUE | String | symbol |
| lever | TRUE | Number | Leverage |
Example:
{
"code": 200000,
"msg": "Success",
"data": {
"symbol": "TRXUSDTPERP",
"lever": 3
}
}