Obtener estadísticas de trading de la cuenta del trader

GET/accounts/{accountId}/stats

Obtener estadísticas de trading de la cuenta del traderCuentas

Agregados sobre las posiciones cerradas de la cuenta: tasa de aciertos, beneficio y pérdida promedio, ratio riesgo-beneficio, drawdown máximo y tiempos de tenencia promedio.

Responde con un cuerpo vacío mientras la cuenta aún no tiene posiciones cerradas.
Cubre cada fase por la que ha pasado la cuenta, no solo la actual.

URL base https://api.upscale.trade

Autorización

bearerhttp · bearerobligatorio

Clave de API personal, con el prefijo usk_.

Parámetros

Ruta

accountIdstring · uuidobligatorio

Identificador de la cuenta del trader. Debe pertenecer al solicitante.

Ejemplo: 00000000-0000-4000-8000-000000000000

Ejemplos

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)

Respuestas

200Respuestaapplication/json

sumPnlstring · fp9obligatorio

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

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

sumFeestring · fp9obligatorio

Trading fees paid over every closed position, fp9 raw.

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

sumFundingstring · fp9obligatorio

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

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

profitstring · fp9obligatorio

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)$

Ejemplo: 1000000000

positionsCountnumberobligatorio

Number of closed positions the statistics are built from.

Ejemplo: 0

profitablePositionsCountnumberobligatorio

Closed positions that ended at or above break-even.

Ejemplo: 0

unprofitablePositionsCountnumberobligatorio

Closed positions that ended below break-even.

Ejemplo: 0

winratePercentnumberobligatorio

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

Ejemplo: 62.5

minProfitstring · fp9 · nullableobligatorio

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

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

minLossstring · fp9 · nullableobligatorio

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

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

maxProfitstring · fp9 · nullableobligatorio

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

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

maxLossstring · fp9 · nullableobligatorio

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

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

avgProfitstring · fp9 · nullableobligatorio

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

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

avgLossstring · fp9 · nullableobligatorio

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

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

riskRewardRationumber · nullableobligatorio

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

Ejemplo: 1.8

maxDrawdownPercentnumber · nullableobligatorio

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

Ejemplo: 12.34

avgLongPositionHoldTimenumber · nullableobligatorio

Average holding time of long positions, in seconds.

Ejemplo: 0

avgShortPositionHoldTimenumber · nullableobligatorio

Average holding time of short positions, in seconds.

Ejemplo: 0

avgPositionHoldTimenumber · nullableobligatorio

Average holding time across all closed positions, in seconds.

Ejemplo: 0

medianPositionHoldTimenumber · nullableobligatorio

Median holding time across all closed positions, in seconds.

Ejemplo: 0

maxProfitablePositionHoldTimenumber · nullableobligatorio

Longest a profitable position was held, in seconds.

Ejemplo: 0

maxUnprofitablePositionHoldTimenumber · nullableobligatorio

Longest a losing position was held, in seconds.

Ejemplo: 0

medianProfitablePositionHoldTimenumber · nullableobligatorio

Median holding time of profitable positions, in seconds.

Ejemplo: 0

medianUnprofitablePositionHoldTimenumber · nullableobligatorio

Median holding time of losing positions, in seconds.

Ejemplo: 0

avgLeverageProfitablePositionnumber · nullableobligatorio

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

Ejemplo: 12

avgLeverageUnprofitablePositionnumber · nullableobligatorio

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

Ejemplo: 20

topMarketstring · nullableobligatorio

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

Ejemplo: BTC

topMarketPercentnumber · nullableobligatorio

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

Ejemplo: 41.67

{
  "sumPnl": "1000000000",
  "sumFee": "1000000000",
  "sumFunding": "1000000000",
  "profit": "1000000000",
  "positionsCount": 0,
  "profitablePositionsCount": 0,
  "unprofitablePositionsCount": 0,
  "winratePercent": 62.5,
  "minProfit": "1000000000",
  "minLoss": "1000000000",
  "maxProfit": "1000000000",
  "maxLoss": "1000000000",
  "avgProfit": "1000000000",
  "avgLoss": "1000000000",
  "riskRewardRatio": 1.8,
  "maxDrawdownPercent": 12.34,
  "avgLongPositionHoldTime": 0,
  "avgShortPositionHoldTime": 0,
  "avgPositionHoldTime": 0,
  "medianPositionHoldTime": 0,
  "maxProfitablePositionHoldTime": 0,
  "maxUnprofitablePositionHoldTime": 0,
  "medianProfitablePositionHoldTime": 0,
  "medianUnprofitablePositionHoldTime": 0,
  "avgLeverageProfitablePosition": 12,
  "avgLeverageUnprofitablePosition": 20,
  "topMarket": "BTC",
  "topMarketPercent": 41.67
}

401

No autorizado

403

La cuenta pertenece a otro usuario (account_access_denied), o la solicitud se autentica con una clave de API mientras api_trading está deshabilitado en la cuenta (api_trading_not_enabled).

404

No hay ninguna cuenta con este identificador.

429

Se superó el límite de velocidad de la clave de API (api_key_rate_limit_exceeded). Retry-After indica cuándo volver; el cuerpo incluye el bucket (read / write), la ventana que se activó, su límite y retryAt.