Upscale
Menu
On this page

Получить торговую статистику аккаунта трейдера

Попробовать ↓
GET/accounts/{accountId}/stats
Получить торговую статистику аккаунта трейдераАккаунты

Агрегирует по закрытым позициям аккаунта: доля выигрышей, средняя прибыль и убыток, соотношение риска и вознаграждения, максимальная просадка и среднее время удержания.

  • Отвечает пустым телом, пока у аккаунта ещё нет закрытых позиций.
  • Охватывает каждую фазу, через которую прошёл аккаунт, а не только текущую.
Базовый URL https://api.upscale.trade

Авторизация

bearerhttp · bearerобязательно

Персональный API-ключ с префиксом usk_.

Параметры

Путь
accountIdstring · uuidобязательно

Идентификатор торгового аккаунта. Должен принадлежать вызывающей стороне.

Пример: 00000000-0000-4000-8000-000000000000

Примеры

curl --request GET 'https://api.upscale.trade/accounts/{accountId}/stats' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Ответы

200Ответapplication/json

Body.riskRewardRatio must be array Body.maxDrawdownPercent must be array Body.avgLeverageProfitablePosition must be array

sumPnlstring · int32обязательно

Realised pnl summed over every closed position, fp9 raw, before fees and funding.

pattern
^(?:-?[1-9][0-9]*|0)$
Пример: 1000000000
sumFeestring · int32обязательно

Trading fees paid over every closed position, fp9 raw.

pattern
^(?:-?[1-9][0-9]*|0)$
Пример: 1000000000
sumFundingstring · int32обязательно

Funding settled over every closed position, fp9 raw. Positive when the account received more than it paid.

pattern
^(?:-?[1-9][0-9]*|0)$
Пример: 1000000000
profitstring · int32обязательно

Net 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)$
Пример: 1000000000
positionsCountnumberобязательно

Number of closed positions the statistics are built from.

Пример: 0
profitablePositionsCountnumberобязательно

Closed positions that ended at or above break-even.

Пример: 0
unprofitablePositionsCountnumberобязательно

Closed positions that ended below break-even.

Пример: 0
winratePercentnumberобязательно

Share of closed positions that ended at or above break-even, in percent with two decimals.

Пример: 62.5
minProfitstring · int32 · nullableобязательно

Smallest win among profitable positions, fp9 raw. Null when there is none.

pattern
^(?:-?[1-9][0-9]*|0)$
Пример: 1000000000
minLossstring · int32 · nullableобязательно

Smallest loss among losing positions, fp9 raw (negative, closest to zero). Null when there is none.

pattern
^(?:-?[1-9][0-9]*|0)$
Пример: 1000000000
maxProfitstring · int32 · nullableобязательно

Largest win, fp9 raw. Null when no position ended in profit.

pattern
^(?:-?[1-9][0-9]*|0)$
Пример: 1000000000
maxLossstring · int32 · nullableобязательно

Largest loss, fp9 raw (the most negative value). Null when no position ended in loss.

pattern
^(?:-?[1-9][0-9]*|0)$
Пример: 1000000000
avgProfitstring · int32 · nullableобязательно

Average win across profitable positions, fp9 raw. Null when there is none.

pattern
^(?:-?[1-9][0-9]*|0)$
Пример: 1000000000
avgLossstring · int32 · nullableобязательно

Average loss across losing positions, fp9 raw (negative). Null when there is none.

pattern
^(?:-?[1-9][0-9]*|0)$
Пример: 1000000000
riskRewardRationumber[]обязательно

Average win over the absolute average loss. Null while no losing position exists to divide by.

Элементы массива · number

number

maxDrawdownPercentnumber[]обязательно

Deepest equity drawdown of the account across all its phases, in percent with two decimals.

Элементы массива · number

number

avgLongPositionHoldTimenumber[]обязательно

Average holding time of long positions, in seconds.

Элементы массива · number

number

Посмотреть пример
[
  0
]
avgShortPositionHoldTimenumber[]обязательно

Average holding time of short positions, in seconds.

Элементы массива · number

number

Посмотреть пример
[
  0
]
avgPositionHoldTimenumber[]обязательно

Average holding time across all closed positions, in seconds.

Элементы массива · number

number

Посмотреть пример
[
  0
]
medianPositionHoldTimenumber[]обязательно

Median holding time across all closed positions, in seconds.

Элементы массива · number

number

Посмотреть пример
[
  0
]
maxProfitablePositionHoldTimenumber[]обязательно

Longest a profitable position was held, in seconds.

Элементы массива · number

number

Посмотреть пример
[
  0
]
maxUnprofitablePositionHoldTimenumber[]обязательно

Longest a losing position was held, in seconds.

Элементы массива · number

number

Посмотреть пример
[
  0
]
medianProfitablePositionHoldTimenumber[]обязательно

Median holding time of profitable positions, in seconds.

Элементы массива · number

number

Посмотреть пример
[
  0
]
medianUnprofitablePositionHoldTimenumber[]обязательно

Median holding time of losing positions, in seconds.

Элементы массива · number

number

Посмотреть пример
[
  0
]
avgLeverageProfitablePositionnumber[]обязательно

Average leverage of profitable positions — notional over margin, as a plain multiple.

Элементы массива · number

number

avgLeverageUnprofitablePositionnumber[]обязательно

Average leverage of losing positions — notional over margin, as a plain multiple.

Элементы массива · number

number

topMarketstring[]обязательно

Base asset ticker of the most traded market, by number of closed positions. Null when nothing has been closed.

Элементы массива · string

string

topMarketPercentnumber[]обязательно

Share of closed positions that were on topMarket, in percent with two decimals.

Элементы массива · number

number

401

Неавторизовано

403

Аккаунт принадлежит другому пользователю (account_access_denied), или запрос аутентифицирован с помощью API-ключа, тогда как api_trading отключён на аккаунте (api_trading_not_enabled).

404

Нет аккаунта с этим идентификатором.

429

Превышен лимит частоты запросов API-ключа (api_key_rate_limit_exceeded). Retry-After указывает, когда вернуться; тело содержит бакет (read / write), окно, которое сработало, его лимит и retryAt.