Retrieve portfolio analytics

Returns account-scoped portfolio risk metrics, asset analytics, pair breakdown, and daily series.

Authorization

x-api-key<token>

In: header

Query Parameters

startDate?string

endDate?string

interval?string

rollingWindowDays?integer

Range-9007199254740991 <= value <= 9007199254740991

includeSeries?boolean|

source?string

Default"all"

Header Parameters

X-Trade-Account-Id*string

UUID of the trade account the request acts on. Must belong to the authenticated user.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/portfolio/analytics" \  -H "X-Trade-Account-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6"

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