Get PnL Settlement History
Endpoint
GET /v1/pnl_settlement/history
Mainnet: https://api.orderly.org/v1/pnl_settlement/history
Testnet: https://testnet-api.orderly.org/v1/pnl_settlement/history
Rate limit: 20 requests per second.
Returns PnL settlement records for the authenticated account.
Authentication
Send the signed-request headers.
orderly-timestamp— required; signed-request timestamp in milliseconds.orderly-account-id— required; authenticated account ID.orderly-key— required; public API key.orderly-signature— required; signature generated for the request.
Query parameters
start_t,end_t(integers, optional).page(integer, optional) — page number starting at 1.size(integer, optional) — number of records per page.
Response
HTTP 200 — application/json. success is a required boolean. data.meta contains required integer fields total, records_per_page, and current_page. data.rows is a required array; each record can contain id (integer), old_balance, new_balance, and settled_amount (numbers), plus requested_time and settled_time (integers in Unix milliseconds). Each symbols entry has required symbol (string) and settled_amount (integer). The root timestamp is server time in milliseconds (integer).
{
"success": true,
"data": {
"meta": { "total": 9, "records_per_page": 25, "current_page": 1 },
"rows": [{
"id": 10001,
"old_balance": 4050,
"new_balance": 3050,
"settled_amount": -500,
"requested_time": 1575014255089,
"settled_time": 1575014255910,
"symbols": [{ "symbol": "PERP_BTC_USDC", "settled_amount": -500 }]
}]
},
"timestamp": 1702989203989
}