API documentation

get/api/v1/Wallet/portfolio-statistics

Returns the current performance statistics for one account - profit, returns, drawdown, risk measures and trade summaries.

Each entry carries a {name}, a {total} value and, where the statistic is a genuine per-side figure (Gross Profit, Gross Loss, Trades PnL and the trade-count family), separate {longValue} and {shortValue} figures. <br><b>Long / Short on return and risk statistics.</b> Daily, monthly and annual return, volatility, Sharpe, Sortino and Value at Risk store a Long and Short value, but those columns are the portfolio total split by each side's share of gross trade activity — not separately measured long and short returns. Both columns always carry the same sign as the total. The published app hides them; treat only {total} as the return or risk figure. <br><b>Units.</b> Every statistic whose name ends in {%} is a decimal fraction, not a percentage: a {Net Profit %} of {0.0523} means 5.23%. Multiply by 100 to display. Money statistics such as {Net Profit} and {Gross Profit} are in the account's own currency. {Sharpe Ratio} and {Sortino Ratio} are dimensionless. The {format} field is a legacy display hint and should not be relied on to decide scaling. <br> A statistic that has never been computed is absent from the array rather than returned as zero. A statistic that exists but has too little history to be meaningful is returned as zero, so a zero cannot always be distinguished from "not enough data yet". <br><b>Null long and short.</b> Statistics measured against the whole portfolio have no per-side figure at all, and return {longValue} and {shortValue} as {null} rather than {0}: Net Profit, Net Profit %, Worst and Average Floating Loss (and their {%} forms), Recovery Factor, Max Adverse Excursion and Max Favorable Excursion. Treat {null} as "not measured", which is distinct from a measured zero.

Wallet

Parameters

accountId

query · integer

Required

version

path · string

Required

Responses

  • 200Current statistics for the account.application/json
    [
      {}
    ]
  • 404The caller is not signed in, or the account does not exist or is not visible to the caller.application/json
    {}
  • 500Statistics could not be retrieved.
Alipay
Stripe
Eurex
AWS
Azure
Google Cloud
Currenex
Velocity Trade
Bitcoin
CME
Interactive Brokers
Kraken
FIX API
XTX
Bloomberg
Binance

Launch Your Platform.

Get Started.