Get Closed PnL

Query user's closed profit and loss records

info

• Classic account: the results are sorted by updatedTime in descending order.
• UTA2.0, UTA1.0(except inverse): the results are sorted by createdTime in descending order, this will be constant with classic account afterwards
• UTA2.0, UTA1.0(except inverse): support getting the past 730 days historical data

HTTP Request

GET /v5/position/closed-pnl

Request Parameters

Parameter	Required	Type	Comments
category	true	string	Product type UTA2.0, UTA1.0: linear(USDT Perps, USDC Contract), inverse Classic account: linear(USDT Perps), inverse
symbol	false	string	Symbol name, like BTCUSDT, uppercase only
startTime	false	integer	The start timestamp (ms) startTime and endTime are not passed, return 7 days by default Only startTime is passed, return range between startTime and startTime+7 days Only endTime is passed, return range between endTime-7 days and endTime If both are passed, the rule is endTime - startTime <= 7 days
endTime	false	integer	The end timestamp (ms)
limit	false	integer	Limit for data size per page. [1, 100]. Default: 50
cursor	false	string	Cursor. Use the nextPageCursor token from the response to retrieve the next page of the result set

Response Parameters

Parameter	Type	Comments
category	string	Product type
list	array	Object
> symbol	string	Symbol name
> orderId	string	Order ID
> side	string	Buy, Sell
> qty	string	Order qty
> orderPrice	string	Order price
> orderType	string	Order type. Market,Limit
> execType	string	Exec type Trade, BustTrade SessionSettlePnL Settle, MovePosition
> closedSize	string	Closed size
> cumEntryValue	string	Cumulated Position value
> avgEntryPrice	string	Average entry price
> cumExitValue	string	Cumulated exit position value
> avgExitPrice	string	Average exit price
> closedPnl	string	Closed PnL
> fillCount	string	The number of fills in a single order
> leverage	string	leverage
> createdTime	string	The created time (ms)
> updatedTime	string	The updated time (ms)
nextPageCursor	string	Refer to the cursor request parameter

---

Request Example

HTTP

GET /v5/position/closed-pnl?category=linear&limit=1 HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672284128523
X-BAPI-RECV-WINDOW: 5000

Python

from pybit.unified_trading import HTTP
session = HTTP(
    testnet=True,
    api_key="XXXXX",
    api_secret="XXXXX",
)
print(session.get_closed_pnl(
    category="linear",
    limit=1,
))

Java

import com.bybit.api.client.domain.*;
import com.bybit.api.client.domain.position.*;
import com.bybit.api.client.domain.position.request.*;
import com.bybit.api.client.service.BybitApiClientFactory;
var client = BybitApiClientFactory.newInstance().newAsyncPositionRestClient();
var closPnlRequest = PositionDataRequest.builder().category(CategoryType.LINEAR).build();
client.getClosePnlList(closPnlRequest, System.out::println);

Node.js

const { RestClientV5 } = require('bybit-api');

const client = new RestClientV5({
    testnet: true,
    key: 'apikey',
    secret: 'apisecret',
});

client
    .getClosedPnL({
        category: 'linear',
        limit: 1,
    })
    .then((response) => {
        console.log(response);
    })
    .catch((error) => {
        console.error(error);
    });

Response Example

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "nextPageCursor": "5a373bfe-188d-4913-9c81-d57ab5be8068%3A1672214887231423699%2C5a373bfe-188d-4913-9c81-d57ab5be8068%3A1672214887231423699",
        "category": "linear",
        "list": [
            {
                "symbol": "ETHPERP",
                "orderType": "Market",
                "leverage": "3",
                "updatedTime": "1672214887236",
                "side": "Sell",
                "orderId": "5a373bfe-188d-4913-9c81-d57ab5be8068",
                "closedPnl": "-47.4065323",
                "avgEntryPrice": "1194.97516667",
                "qty": "3",
                "cumEntryValue": "3584.9255",
                "createdTime": "1672214887231423699",
                "orderPrice": "1122.95",
                "closedSize": "3",
                "avgExitPrice": "1180.59833333",
                "execType": "Trade",
                "fillCount": "4",
                "cumExitValue": "3541.795"
            }
        ]
    },
    "retExtInfo": {},
    "time": 1672284129153
}