Trade

Position List

HTTP Request

GET /v1/trade/position-list

NOTE

Don't include trailing slash / at the end of the endpoint. Doing so can result in a “not found” error.

Request Parameters

ParameterRequiredTypeComments
pageoptionalintegerpage number of the position
limitoptionalintegerlimit of count of the getting position

INFO

The ack of position list request indicates that the request is successfully accepted.

Response Parameters

ParameterTypeComments
statusCodenumber200
resultobjectResult object containing list and pagination
result.listarrayArray of position objects
result.list[].idnumberPosition ID
result.list[].coinstringTrading pair symbol
result.list[].sidestringPosition side: long, short
result.list[].sizestringSize of the position
result.list[].averageEnteryPricestringAverage entry price of the position
result.list[].leveragestringLeverage of the position
result.list[].marginstringMargin of the position
result.list[].unrealizedPnlstringUnrealized PnL of the position
result.list[].liquidationPricestringEstimated liquidation price of the position
result.list[].marginModestringMargin mode: Cross, Isolated
result.list[].createdTimenumberCreation timestamp of the position (Unix time in ms)
result.list[].tradeTypestringTrade type: market, limit
result.list[].tpPricestring | nullTake profit price of the position
result.list[].slPricestring | nullStop loss price of the position
result.paginationobjectPagination information
result.pagination.pagenumberCurrent page number
result.pagination.limitnumberItems per page
result.pagination.totalRecordsnumberTotal number of records
result.pagination.totalPagesnumberTotal number of pages
messagestringResponse message

Request Example

GET /v1/trade/position-list HTTP/1.1
Host: api.heatmex.com
X-HEATMEX-SIGN: XXXXX
X-HEATMEX-API-KEY: XXXXX
Content-Type: application/json

Response Example

{
  "statusCode": 200,
  "result": {
    "list": [
      {
        "id": 28,
        "coin": "BTCUSDT",
        "side": "long",
        "size": "0.52000000",
        "averageEnteryPrice": "77100.80000000",
        "leverage": "100.00",
        "margin": "400.92416000",
        "unrealizedPnl": "-16.03696640",
        "liquidationPrice": "1986.03696640",
        "marginMode": "Cross",
        "createdTime": 1744034718000,
        "tradeType": "market",
        "tpPrice": null,
        "slPrice": null
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "totalRecords": 1,
      "totalPages": 1
    }
  },
  "message": "OK"
}

On this page