Upscale
Menu
On this page

Obtener el estado de riesgo de la cuenta del trader

Probar ↓
GET/accounts/{accountId}/risk-status
Obtener el estado de riesgo de la cuenta del traderCuentas

La instantánea de riesgo que el motor de trading mantiene para la cuenta: saldo y equity actuales, equity al inicio del día y equity máximo, el contador de días de trading, el estado de la regla de consistencia y la línea base de payout.

  • Se lee en vivo desde el shard que aloja la cuenta, por lo que las posiciones abiertas ya están reflejadas en el equity.
  • Las sesiones interactivas obtienen un presupuesto para este endpoint aparte de los otros; en cambio, una clave de API está limitada por sus propios límites de lectura.
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}/risk-status' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Respuestas

200Respuestaapplication/json
accountIdstring · uuidobligatorio

Trader account the snapshot belongs to.

pattern
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Ejemplo: 00000000-0000-4000-8000-000000000000
tradingDaysnumberobligatorio

Number of days the account has traded on — counted against the minimum trading days of the challenge.

Ejemplo: 0
currentBalancestring · int32obligatorio

Account balance without the unrealised pnl of open positions, fp9 raw.

pattern
^(?:-?[1-9][0-9]*|0)$
Ejemplo: 1000000000
currentEquitystring · int32obligatorio

Balance plus the unrealised pnl of open positions, fp9 raw. This is what drawdown rules are measured against.

pattern
^(?:-?[1-9][0-9]*|0)$
Ejemplo: 1000000000
dayStartEquitystring · int32obligatorio

Equity the current trading day opened at, fp9 raw — the base of the daily drawdown limit.

pattern
^(?:-?[1-9][0-9]*|0)$
Ejemplo: 1000000000
maxEquitystring · int32 · nullableobligatorio

Highest equity the account has ever reached, fp9 raw — the base of the trailing drawdown. Null before the first trade.

pattern
^(?:-?[1-9][0-9]*|0)$
Ejemplo: 1000000000
periodStartEquitystring · int32 · nullableobligatorio

Equity the current withdrawal period opened at, fp9 raw. Null while no period is running.

pattern
^(?:-?[1-9][0-9]*|0)$
Ejemplo: 1000000000
maxPeriodDailyEquityDeltastring · int32 · nullableobligatorio

Largest single-day equity gain inside the current period, fp9 raw — the numerator of the consistency rule. Null while no day has closed in profit.

pattern
^(?:-?[1-9][0-9]*|0)$
Ejemplo: 1000000000
maxPeriodDailyEquityDeltaAtstring · date-time · nullableobligatorio

Day that produced maxPeriodDailyEquityDelta. Null together with it.

Ejemplo: 2026-05-01T12:30:00.000Z
consistencyRuleAppliesbooleanobligatorio

Whether the consistency rule is part of the rules of this account in its current phase.

Ejemplo: true
consistencyRuleMetboolean[]obligatorio

Whether the rule is currently satisfied. Null while the period is not in profit and the ratio cannot be computed.

Elementos del array · boolean

boolean

Ver ejemplo
[
  true
]
consistencyRuleRatiostring · int32 · nullableobligatorio

Share of the period profit made on its best day, fp9 raw fraction. Null together with consistencyRuleMet.

pattern
^(?:-?[1-9][0-9]*|0)$
Ejemplo: 1000000000
consistencyRuleLimitstring · int32obligatorio

Largest share of period profit one day may account for, fp9 raw fraction (300000000 = 30%). A ratio above it fails the rule.

pattern
^(?:-?[1-9][0-9]*|0)$
Ejemplo: 1000000000
payoutBaselineBalancestring · int32obligatorio

Balance the next payout is measured from, fp9 raw. Equal to the initial account size until the first payout moves it.

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

Whether equity is above payoutBaselineBalance — the condition for being eligible to request a payout.

Ejemplo: true
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.