`userOverview`

Returns performance figures for one account or vault over a period: PnL, return on equity, traded volume, maximum drawdown, and current equity. Use it for a portfolio performance card or a vault's performance panel.

POST/infotype userOverview

Fill a portfolio or vault performance card: PnL, ROE, volume, max drawdown, equity over a period.

Request body

periodstringrequired

Lookback window.

"24H""7D""30D""90D""ALLTIME"

typestringrequired

Must be `userOverview`.

"userOverview"

user_addressstring · addressrequired

Account or vault address. Note the snake_case key.

account_typestring[]optional

Sub-accounts to include. Omit for `perps` only.

Request example

curl -X POST https://rpc.txflow-testnet.xyz/info \
  -H "Content-Type: application/json" \
  -H "x-api-version: 2026-08-16" \
  -d '{
  "type": "userOverview",
  "user_address": "0x091564806dce41ffeebafbc417e73b6849b1c29e",
  "period": "30D"
}'

Try it

POST https://rpc.txflow-testnet.xyz/info

Response 200

codeinteger

`0` on success.

msgstring

Empty on success.

maxDrawdownstring

Maximum drawdown over the period, percent. Present when `perps` is included.

periodstring

Echo of `period`.

pnlstring

PnL over the period, USDC.

roestring

Return on equity over the period, percent.

totalEquitystring

Current equity of the included sub-accounts, USDC.

volumestring

Traded notional over the period, USDC.

Response example

{
  "code": 0,
  "msg": "",
  "period": "30D",
  "pnl": "0",
  "roe": "0",
  "volume": "19752.12",
  "maxDrawdown": "6.38",
  "totalEquity": "3831.19"
}

The request keys are snake_case: user_address, period, account_type. account_type chooses which sub-accounts are combined; omit it for the perp account only.

The body is returned at the top level with code: 0. pnl, volume, and totalEquity are USDC; roe and maxDrawdown are percent.