/accounts/{accountId}/statsAggregates over the closed positions of the account: win rate, average profit and loss, risk-reward ratio, max drawdown and average holding times.
- Responds with an empty body while the account has no closed positions yet.
- Covers every phase the account has been through, not only the current one.
https://api.upscale.tradeParameters
accountIdstring · uuidrequiredTrader account identifier. Must belong to the caller.
00000000-0000-4000-8000-000000000000Examples
curl --request GET 'https://api.upscale.trade/accounts/{accountId}/stats' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY'const response = await fetch("https://api.upscale.trade/accounts/{accountId}/stats", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
},
});
console.log(response.status, await response.text());import requests
response = requests.request(
"GET",
"https://api.upscale.trade/accounts/{accountId}/stats",
headers={"Accept":"application/json","Authorization":"Bearer YOUR_API_KEY"},
timeout=30,
)
print(response.status_code, response.text)Responses
200Responseapplication/json
Body.riskRewardRatio must be array Body.maxDrawdownPercent must be array Body.avgLeverageProfitablePosition must be array
sumPnlstring · int32requiredRealised pnl summed over every closed position, fp9 raw, before fees and funding.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000sumFeestring · int32requiredTrading fees paid over every closed position, fp9 raw.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000sumFundingstring · int32requiredFunding settled over every closed position, fp9 raw. Positive when the account received more than it paid.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000profitstring · int32requiredNet result of the closed positions, fp9 raw: pnl minus fees plus funding. This is what the win rate splits on.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000positionsCountnumberrequiredNumber of closed positions the statistics are built from.
0profitablePositionsCountnumberrequiredClosed positions that ended at or above break-even.
0unprofitablePositionsCountnumberrequiredClosed positions that ended below break-even.
0winratePercentnumberrequiredShare of closed positions that ended at or above break-even, in percent with two decimals.
62.5minProfitstring · int32 · nullablerequiredSmallest win among profitable positions, fp9 raw. Null when there is none.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000minLossstring · int32 · nullablerequiredSmallest loss among losing positions, fp9 raw (negative, closest to zero). Null when there is none.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000maxProfitstring · int32 · nullablerequiredLargest win, fp9 raw. Null when no position ended in profit.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000maxLossstring · int32 · nullablerequiredLargest loss, fp9 raw (the most negative value). Null when no position ended in loss.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000avgProfitstring · int32 · nullablerequiredAverage win across profitable positions, fp9 raw. Null when there is none.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000avgLossstring · int32 · nullablerequiredAverage loss across losing positions, fp9 raw (negative). Null when there is none.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000riskRewardRationumber[]requiredAverage win over the absolute average loss. Null while no losing position exists to divide by.
Array items · number
number
maxDrawdownPercentnumber[]requiredDeepest equity drawdown of the account across all its phases, in percent with two decimals.
Array items · number
number
avgLongPositionHoldTimenumber[]requiredAverage holding time of long positions, in seconds.
Array items · number
number
View example
[
0
]avgShortPositionHoldTimenumber[]requiredAverage holding time of short positions, in seconds.
Array items · number
number
View example
[
0
]avgPositionHoldTimenumber[]requiredAverage holding time across all closed positions, in seconds.
Array items · number
number
View example
[
0
]medianPositionHoldTimenumber[]requiredMedian holding time across all closed positions, in seconds.
Array items · number
number
View example
[
0
]maxProfitablePositionHoldTimenumber[]requiredLongest a profitable position was held, in seconds.
Array items · number
number
View example
[
0
]maxUnprofitablePositionHoldTimenumber[]requiredLongest a losing position was held, in seconds.
Array items · number
number
View example
[
0
]medianProfitablePositionHoldTimenumber[]requiredMedian holding time of profitable positions, in seconds.
Array items · number
number
View example
[
0
]medianUnprofitablePositionHoldTimenumber[]requiredMedian holding time of losing positions, in seconds.
Array items · number
number
View example
[
0
]avgLeverageProfitablePositionnumber[]requiredAverage leverage of profitable positions — notional over margin, as a plain multiple.
Array items · number
number
avgLeverageUnprofitablePositionnumber[]requiredAverage leverage of losing positions — notional over margin, as a plain multiple.
Array items · number
number
topMarketstring[]requiredBase asset ticker of the most traded market, by number of closed positions. Null when nothing has been closed.
Array items · string
string
topMarketPercentnumber[]requiredShare of closed positions that were on topMarket, in percent with two decimals.
Array items · number
number
Unauthorized
The account belongs to another user (account_access_denied), or the request is authenticated with an API key while api_trading is disabled on the account (api_trading_not_enabled).
No account with this identifier.
Rate limit of the API key exceeded (api_key_rate_limit_exceeded). Retry-After says when to come back; the body carries the bucket (read / write), the window that tripped, its limit and retryAt.