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

Parameter	Required	Type	Comments
page	optional	integer	page number of the position
limit	optional	integer	limit of count of the getting position

INFO

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

Response Parameters

Parameter	Type	Comments
statusCode	number	`200`
result	array	`Object`
list	array	contain the response details
> id	integer	id number of the position
> coin	string	Values: `BTCUSDT`, `ETHUSDT`, `SOLUSDT`, `XRPUSDT` `1000PEPEUSDT`, `WLDUSDT`, `DOGEUSDT`, `STPTUSDT`, `SUIUSDT`, `ADAUSDT`, `ARBUSDT`, `XLMUSDT`, `HIVEUSDT`, `ONDOUSDT`
> side	string	Values: `long`, `short`
> size	string	size of the position
> averageEnteryPrice	string	average entry price of the position
> leverage	string	leverage of the position
> margin	string	margin of the position
> unrealizedPnL	string	unrealized pnl of the position
> liquidationPrice	string	estimated liquidation price of the position
> marginMode	string	Values: `Cross`, `Isolated`
> createdTime	string	creation date of the position
> tradeType	string	Values: `Market`, `Limit`
> tpPrice	string	take profit price of the position
> slPrice	string	stop loss price of the position
message	string	`OK`

Request Example

GET /v1/trade/position-list HTTP/1.1
Host: api.okxai.net
X-OKXAI-SIGN: XXXXX
X-OKXAI-API-KEY: XXXXX
Content-Type: application/json
const response = await fetch('https://api.okxai.net/v1/trade/position-list');

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": "2025-04-07 14:05:18",
        "tradeType": "market",
        "tpPrice": null,
        "slPrice": null
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "totalRecords": 1,
      "totalPages": 1
    }
  },
  "message": "OK"
}

Position List

HTTP Request

GET /v1/trade/position-list

Request Parameters

Response Parameters

Request Example

Response Example

On this page

GET `/v1/trade/position-list`