Skip to main content
GET
/
v1
/
pnl_settlement
/
history
Get PnL settlement history
curl --request GET \
  --url https://api.orderly.org/v1/pnl_settlement/history \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
{
  "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
}

Headers

​
orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

​
orderly-account-id
string
required

Account ID of the authenticated account.

​
orderly-key
string
required

Public orderly key used to sign the request.

​
orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Query Parameters

​
start_t
integer
​
end_t
integer
​
page
integer

start from 1

​
size
integer

Response

200 - application/json

OK

​
success
boolean
required

Indicates whether the request was successful.

Example:

true

​
data
object
required
​
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989