Portfolio

Get portfolio summary buckets and overall metrics

get

Returns bucketed volume, open interest snapshot, win/loss trade counts, and overall metrics derived from trade history, trade history assets, and current open positions. Records marked as FULLY_EXTERNAL are excluded. When startDate or endDate is provided, only period-scoped overall metrics are returned.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startDatestringOptional

Start date (ISO string or ms timestamp)

endDatestringOptional

End date (ISO string or ms timestamp)

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
  }
}

Get portfolio analytics with risk-adjusted metrics

get

Returns portfolio and per-asset performance analytics including risk-adjusted metrics, rolling windows, and both realized-only and realized+unrealized variants.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startDatestringOptional

Start date (ISO string or ms timestamp)

endDatestringOptional

End date (ISO string or ms timestamp)

intervalstring · enumOptional

Display interval for date range

Possible values:

rollingWindowDaysnumberOptional

Rolling window size in days (default 30, min 7, max 365)

includeSeriesbooleanOptional

Include daily/rolling time series (default true)

Responses

200

Portfolio analytics data

application/json

get

/portfolio/analytics

HTTPcURLJavaScriptPython

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

200

Portfolio analytics data

{
  "config": {
    "rollingWindowDays": 1,
    "startDate": "text",
    "endDate": "text"
  },
  "portfolio": {
    "realizedOnly": {
      "pnlAbsolute": 1,
      "pnlPercent": 1,
      "hitRate": 1,
      "profitFactor": 1,
      "avgWinSize": 1,
      "avgLossSize": 1,
      "avgReturnPerWin": 1,
      "avgReturnPerLoss": 1,
      "maxDrawdown": 1,
      "sharpeRatio": 1,
      "sortinoRatio": 1
    },
    "realizedPlusUnrealized": {
      "pnlAbsolute": 1,
      "pnlPercent": 1,
      "hitRate": 1,
      "profitFactor": 1,
      "avgWinSize": 1,
      "avgLossSize": 1,
      "avgReturnPerWin": 1,
      "avgReturnPerLoss": 1,
      "maxDrawdown": 1,
      "sharpeRatio": 1,
      "sortinoRatio": 1
    },
    "realizedHitRate": 1,
    "profitFactor": 1,
    "avgWinSize": 1,
    "avgLossSize": 1,
    "breakevenHitRate": 1,
    "cushion": 1
  },
  "assets": [
    {
      "asset": "text",
      "realizedOnly": {
        "pnlAbsolute": 1,
        "pnlPercent": 1,
        "hitRate": 1,
        "profitFactor": 1,
        "avgWinSize": 1,
        "avgLossSize": 1,
        "avgReturnPerWin": 1,
        "avgReturnPerLoss": 1,
        "maxDrawdown": 1,
        "sharpeRatio": 1,
        "sortinoRatio": 1
      },
      "realizedPlusUnrealized": {
        "pnlAbsolute": 1,
        "pnlPercent": 1,
        "hitRate": 1,
        "profitFactor": 1,
        "avgWinSize": 1,
        "avgLossSize": 1,
        "avgReturnPerWin": 1,
        "avgReturnPerLoss": 1,
        "maxDrawdown": 1,
        "sharpeRatio": 1,
        "sortinoRatio": 1
      },
      "unrealizedReturnPerDay": 1
    }
  ],
  "pairs": [
    {
      "key": "text",
      "longAssets": [
        "text"
      ],
      "shortAssets": [
        "text"
      ],
      "trades": 1,
      "wins": 1,
      "losses": 1,
      "hitRate": 1,
      "avgWinSize": 1,
      "avgLossSize": 1,
      "expectancy": 1,
      "totalPnl": 1,
      "bookPercent": 1
    }
  ],
  "series": [
    {
      "date": "text",
      "trades": 1,
      "wins": 1,
      "losses": 1,
      "dayPnl": 1,
      "hitRate": 1,
      "winLossRatio": 1,
      "rollingHitRate": 1,
      "rollingWinLossRatio": 1,
      "dailyReturn": 1,
      "cumulativeReturn": 1,
      "equity": 1,
      "drawdown": 1,
      "rollingSharpe": 1,
      "rollingSortino": 1,
      "rollingVolatility": 1,
      "rollingFunding": 1
    }
  ]
}