Portfolio

Get portfolio summary buckets and overall metrics

get

Returns bucketed volume, open interest snapshot, win/loss trade counts, and overall metrics filtered to PEAR fills (cloid LIKE 0x50454152%)

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Portfolio data for all intervals

application/json

get

/portfolio

HTTPcURLJavaScriptPython

GET /portfolio HTTP/1.1
Host: hl-v2.pearprotocol.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Portfolio data for all intervals

{
  "intervals": {
    "oneDay": [
      {
        "periodStart": "text",
        "periodEnd": "text",
        "volume": 1,
        "openInterest": 1,
        "winningTradesCount": 1,
        "winningTradesUsd": 1,
        "losingTradesCount": 1,
        "losingTradesUsd": 1
      }
    ],
    "oneWeek": [
      {
        "periodStart": "text",
        "periodEnd": "text",
        "volume": 1,
        "openInterest": 1,
        "winningTradesCount": 1,
        "winningTradesUsd": 1,
        "losingTradesCount": 1,
        "losingTradesUsd": 1
      }
    ],
    "oneMonth": [
      {
        "periodStart": "text",
        "periodEnd": "text",
        "volume": 1,
        "openInterest": 1,
        "winningTradesCount": 1,
        "winningTradesUsd": 1,
        "losingTradesCount": 1,
        "losingTradesUsd": 1
      }
    ],
    "oneYear": [
      {
        "periodStart": "text",
        "periodEnd": "text",
        "volume": 1,
        "openInterest": 1,
        "winningTradesCount": 1,
        "winningTradesUsd": 1,
        "losingTradesCount": 1,
        "losingTradesUsd": 1
      }
    ],
    "all": [
      {
        "periodStart": "text",
        "periodEnd": "text",
        "volume": 1,
        "openInterest": 1,
        "winningTradesCount": 1,
        "winningTradesUsd": 1,
        "losingTradesCount": 1,
        "losingTradesUsd": 1
      }
    ]
  },
  "overall": {
    "totalWinningTradesCount": 1,
    "totalLosingTradesCount": 1,
    "totalWinningUsd": 1,
    "totalLosingUsd": 1,
    "currentOpenInterest": 1,
    "currentTotalVolume": 1,
    "unrealizedPnl": 1,
    "totalTrades": 1
  }
}