/ordersColoca una orden y la devuelve tal como la almacenó el motor de trading. Las órdenes de incremento (market, limit, stop_market, stop_limit) abren o amplían una posición;
las órdenes de cierre (stop, take, trailing_stop) se vinculan a una posición existente mediante positionId.
amount se lee en una unidad diferente por cada uno de los dos: en una orden de aumento es un importe de cotización reservado del saldo libre, en una orden de cierre
es el tamaño del activo base de la posición a cerrar, sin reservar nada. El resto de los campos de tamaño (expectedAmount, sizeMode,
baseSize, leverage) pertenecen solo a las órdenes de aumento.
Más allá del esquema a nivel de campo, la solicitud se verifica para:
- Forma para el tipo. Cada rechazo aquí es un
400cuyo código nombra la combinación de campos en falta:- tamaño —
amount_not_positive,base_size_required,base_size_negative,base_size_not_allowed; - apalancamiento —
leverage_required,leverage_negative; - precio de activación —
trigger_price_required,trigger_price_negative; - stop-loss / take-profit adjuntos a una orden de incremento —
stop_trigger_price_negative,take_trigger_price_negative,stop_trigger_price_gt_trigger_price,stop_trigger_price_lt_trigger_price,take_trigger_price_gt_trigger_price,take_trigger_price_lt_trigger_price; - precio de stop-limit —
stop_limit_price_required,stop_limit_price_negative,stop_limit_price_gt_trigger_price,stop_limit_price_lt_trigger_price; - stop móvil —
trailing_stop_activation_price_negative,trailing_stop_offset_required,trailing_stop_offset_conflict,trailing_stop_offset_negative,trailing_stop_offset_percent_negative,trailing_stop_offset_percent_gte_one; - órdenes de cierre —
position_id_required.
- tamaño —
- Apalancamiento de una orden de incremento. Debe mantenerse dentro de los límites del mercado: no por debajo del mínimo del mercado ni por encima del máximo de la fase,
con
invalid_leverage(leveragemásminLeverageomaxLeverageen el cuerpo). - Cuenta. Debe pertenecer al llamador y estar en un estado de trading; las órdenes de incremento se rechazan además mientras la cuenta está bloqueada por el límite de capital gestionado,
y necesitan
amountdisponible como saldo libre. - Mercado. Debe estar abierto y dentro de la categoría en la que la cuenta puede operar (cripto o RWA). Un mercado de solo cierre no acepta nada más que una orden
takecreada sin un precio de activación. - Posición, cuando se proporciona
positionId: debe existir (position_not_found), estar abierta, estar en la misma cuenta, pertenecer al mismo mercado y tener la misma dirección que la orden (position_not_available). - Precio de activación, contra el precio de mercado actual y — para
stop/take— contra el precio de liquidación de la posición (trigger_price_gt_current,trigger_price_lt_current,trigger_price_gt_liquidation,trigger_price_lt_liquidation). Una ordenmarketcon un stop-loss / take-profit adjunto se comprueba contra el precio de liquidación que tendría su posición después de la ejecución:market_price_unavailablecuando no hay un precio actual contra el que comprobar,order_validation_invariantcuando faltan los campos de tamaño necesarios para esa proyección. - Nocional de una orden de aumento.
(amount − fee) × leveragedebe ajustarse al nocional abierto máximo que el mercado permite en esa dirección (order_exceeds_max_open_notional).
Una orden diferida no se ejecuta aquí, por lo que aún puede fallar cuando su disparador se active más tarde: entonces termina con el estado canceled_by_error y un
errorCode (insufficient_reserve_at_execution, order_below_min_notional, order_exceeds_market_depth, order_exceeds_max_open_notional,
order_zero_size_at_execution, slippage_tolerance, market_close_only_at_execution), y se libera su reserva.
Envía un encabezado x-idempotency-key para que la llamada sea segura frente a repeticiones: dentro de la ventana de repetición indicada en ese encabezado, la misma clave en la misma ruta reproduce la respuesta almacenada (marcada con X-Idempotency-Cached: true y X-Idempotency-Timestamp) en lugar de actuar de nuevo, y una segunda llamada que llegue mientras la primera aún se está ejecutando recibe 409 (idempotency_key_in_flight).
https://api.upscale.tradeParámetros
x-idempotency-keystringopcionalClave de idempotencia — cualquier cadena opaca, un uuid v4 funciona bien. Repetir la llamada con la misma clave en esta ruta dentro de 1 hora reproduce la respuesta almacenada en lugar de actuar de nuevo; una reproducción incluye X-Idempotency-Cached: true y X-Idempotency-Timestamp. Omite el encabezado para optar por no participar.
9f1c2b7e-5a3d-4f61-9b0e-2c7d4a8e1f35Cuerpo de la solicitud · obligatorio
accountIdstring · uuidobligatorioTrader account the order is placed on. Must belong to the caller.
- 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})$
00000000-0000-4000-8000-000000000000marketIdstring · uuidobligatorioMarket the order is placed on, as returned by GET /v2/markets.
- 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})$
00000000-0000-4000-8000-000000000000typestring · enumobligatorioOrder type. Increase (position-opening) types: market, limit, stop_market, stop_limit. Close types, attached to an existing position: stop, take, trailing_stop. liquidation is raised by the platform itself and add_margin / remove_margin are legacy — none of the three is accepted here.
"market" "limit" "stop" "trailing_stop" "take" "stop_limit" "stop_market"marketdirectionstring · enumobligatorioOrder direction. For a close order it must match the direction of the position it is attached to.
"long" "short"longamountstring · int32obligatorioWhat the order is sized by, fp9 raw — the unit depends on the order class. On an increase order (market, limit, stop_market, stop_limit) it is a quote amount reserved from the free balance (margin, fee, spread and buffer): the account must hold at least this much, and the reserve is released when the order is cancelled. On a close order (stop, take, trailing_stop) it is the base asset size of the position to close and nothing is reserved; a size larger than the position holds closes it in full.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
100000000000Campos opcionales: 12
positionIdstring · uuid · nullableopcionalPosition a close order (stop, take, trailing_stop) is attached to. Required for those types, ignored for increase orders.
- 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})$
00000000-0000-4000-8000-000000000000expectedAmountstring · int32 · nullableopcionalSlippage tolerance for increase orders: the position size the caller expects for amount, fp9 raw. Execution outside the tolerance fails with slippage_tolerance. Omitted or 0 — no tolerance check. Not applicable to close orders.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
0leveragestring · int32 · nullableopcionalLeverage, fp9 raw (10000000000 = 10x). Required for increase orders and must be within the leverage bounds of the market.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
10000000000triggerPricestring · int32 · nullableopcionalPrice at which the order fires, fp9 raw. Required for limit, stop, take, stop_market and stop_limit, and rejected for market. For stop / take, 0 means the order is created without a trigger and can be set later.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
65000000000000stopTriggerPricestring · int32 · nullableopcionalStop-loss attached to an increase order, fp9 raw. Must sit below the entry trigger price for long and above it for short.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000takeTriggerPricestring · int32 · nullableopcionalTake-profit attached to an increase order, fp9 raw. Must sit above the entry trigger price for long and below it for short.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000trailingStopActivationPricestring · int32 · nullableopcionalPrice at which a trailing_stop starts trailing, fp9 raw. Omitted — the order trails from the moment it is created.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000trailingStopOffsetstring · int32 · nullableopcionalTrailing distance as an absolute quote amount, fp9 raw. Exactly one of trailingStopOffset / trailingStopOffsetPercent is required.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000trailingStopOffsetPercentstring · int32 · nullableopcionalTrailing distance as a fraction of price, fp9 raw and strictly below 1000000000 (100%). Exactly one of trailingStopOffset / trailingStopOffsetPercent is required.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
50000000stopLimitPricestring · int32 · nullableopcionalLimit price a stop_limit order is placed at once its trigger fires, fp9 raw. Required for that type; must be at or below the trigger price for long and at or above it for short.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000sizeModestring · enumopcionalHow the size of an increase order is expressed: quote (default) sizes it by amount, base sizes it by baseSize while amount stays the reserve. Increase orders only — a close order is always sized by amount in base asset units.
"quote" "base"quotebaseSizestring · int32 · nullableopcionalOrder size in base asset units, fp9 raw. Required when sizeMode is base and rejected otherwise, and meaningful for increase orders only.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000{
"accountId": "00000000-0000-4000-8000-000000000000",
"marketId": "00000000-0000-4000-8000-000000000000",
"type": "market",
"direction": "long",
"amount": "100000000000"
}Ejemplos
curl --request POST 'https://api.upscale.trade/orders' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"accountId": "00000000-0000-4000-8000-000000000000",
"marketId": "00000000-0000-4000-8000-000000000000",
"type": "market",
"direction": "long",
"amount": "100000000000"
}'const response = await fetch("https://api.upscale.trade/orders", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
},
body: "{\n \"accountId\": \"00000000-0000-4000-8000-000000000000\",\n \"marketId\": \"00000000-0000-4000-8000-000000000000\",\n \"type\": \"market\",\n \"direction\": \"long\",\n \"amount\": \"100000000000\"\n}",
});
console.log(response.status, await response.text());import requests
response = requests.request(
"POST",
"https://api.upscale.trade/orders",
headers={"Accept":"application/json","Authorization":"Bearer YOUR_API_KEY","Content-Type":"application/json"},
data="{\n \"accountId\": \"00000000-0000-4000-8000-000000000000\",\n \"marketId\": \"00000000-0000-4000-8000-000000000000\",\n \"type\": \"market\",\n \"direction\": \"long\",\n \"amount\": \"100000000000\"\n}",
timeout=30,
)
print(response.status_code, response.text)Respuestas
No autorizado
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). El trading en la cuenta ha terminado en su estado actual (challenge_closed), o la cuenta está bloqueada por el límite de capital gestionado (funded_limit_trading_locked). El mercado está en pausa (market_paused) o solo acepta órdenes de cierre (market_close_only).
No existe tal cuenta, mercado o posición.
Otra llamada con la misma x-idempotency-key sigue en ejecución (idempotency_key_in_flight). Reintenta cuando haya terminado.
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.
defaultRespuestaapplication/json
idstring · uuidobligatorioOrder identifier.
- 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})$
00000000-0000-4000-8000-000000000000txIdstringobligatorioOrder identifier. Kept for backward compatibility, always equal to id.
stringtraderstring · uuidobligatorioTrader account the order 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})$
00000000-0000-4000-8000-000000000000marketstring · uuidobligatorioMarket the order is placed on.
- 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})$
00000000-0000-4000-8000-000000000000statusstring · enumobligatorioLifecycle state: active while it waits, executed once filled, canceled when cancelled by the trader or the platform, canceled_by_update when replaced by an edit, canceled_by_position when the position it was attached to went away, canceled_by_error when execution failed — see errorCode.
"active" "canceled" "canceled_by_update" "canceled_by_error" "canceled_by_position" "executed"activetypestring · enumobligatorioOrder type. liquidation marks an order the engine raised itself.
"market" "limit" "stop" "trailing_stop" "take" "stop_limit" "stop_market" "liquidation"marketdirectionstring · enumobligatorioOrder direction.
"long" "short"longtriggerPricestring · int32obligatorioPrice at which the order fires, fp9 raw. 0 when the order carries no trigger.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000requestedTriggerPricestring · int32 · nullableobligatorioTrigger price as requested, before the engine pushed it out to the minimum stop distance, fp9 raw. Null when the requested price was kept as is.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000stopPricestring · int32obligatorioTrigger price of a stop_market / stop_limit order, fp9 raw; 0 for every other type.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000limitPricestring · int32obligatorioPrice the order is placed at once triggered, fp9 raw: the stop-limit price, falling back to the trigger price.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000stopTriggerPricestring · int32obligatorioStop-loss attached to the order, fp9 raw. 0 when none is attached.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000takeTriggerPricestring · int32obligatorioTake-profit attached to the order, fp9 raw. 0 when none is attached.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000trailingStopActivationPricestring · int32obligatorioPrice at which a trailing stop starts trailing, fp9 raw. 0 when it trails from creation.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000trailingStopOffsetstring · int32obligatorioTrailing distance as an absolute quote amount, fp9 raw. 0 when the distance is set as a percent.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000trailingStopOffsetPercentstring · int32obligatorioTrailing distance as a fraction of price, fp9 raw. 0 when the distance is absolute.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000leveragestring · int32 · nullableobligatorioLeverage of the order, fp9 raw. Null on close orders, which inherit the leverage of the position.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000indexstringobligatorioOrder identifier. Kept for backward compatibility, always equal to id.
stringpositionIdstring[]obligatorioPosition a close order is attached to. Null for orders that open or grow a position.
Elementos del array · string
string
Ver ejemplo
[
"string"
]parentOrderIdstring[]obligatorioOrder this one was spawned from: a stop or take created out of stopTriggerPrice / takeTriggerPrice, or the limit order a stop_limit turned into. Null when the order was submitted directly.
Elementos del array · string
string
Ver ejemplo
[
"string"
]expirationstring · date-time · nullableobligatorioAlways null. Kept for backward compatibility — orders do not expire on their own.
2026-05-01T12:30:00.000Zamountstring · int32obligatorioSize of the order, fp9 raw, in the unit its class uses: on an increase order a quote amount — the reserve while it waits, and what it actually spent once executed; on a close order (stop, take, trailing_stop) the base asset size it closes, as requested at creation.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000indexPricestring · int32 · nullableobligatorioIndex price the order executed at, fp9 raw. Null while the order has not executed.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000settlementOraclePricestring · int32obligatorioAlways 1000000000 (1.0). Kept for backward compatibility.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000createdAtstring · date-timeobligatorioWhen the order was accepted.
2026-05-01T12:30:00.000Zerrorstring[]obligatorioAlways null. Kept for backward compatibility — use errorCode.
Elementos del array · string
string
Ver ejemplo
[
"string"
]realizedPnlstring · int32 · nullableobligatorioPnl realised by this order, fp9 raw. Set only on an executed close order; null while pending and on orders that open or grow a position.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000rawRealizedPnlstring · int32 · nullableobligatorioRealised pnl before the 60-second adjustment, fp9 raw. Differs from realizedPnl only when the adjustment fired.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000profitAdjustmentAppliedbooleanobligatorioWhether the 60-second adjustment capped the profit of this order — inside a minute of an open or increase the position pnl cannot grow above what it was at that moment.
trueexecutedAfterPausebooleanobligatorioWhether the order executed after a market pause. Not set by the current engine — always false.
truesizeModestring · enumobligatorioHow the size was expressed on creation: quote sizes the order by amount, base sizes it by baseSize.
"quote" "base"quotebaseSizestring · int32 · nullableobligatorioOrder size in base asset units, fp9 raw. Null for quote-sized orders.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000reservedAmountstring · int32 · nullableobligatorioQuote amount reserved when the order with sizeMode=base was created, fp9 raw. Stays at the original reserve after execution, while amount is rewritten to what was spent. Null for quote-sized orders, where amount is the reserve.
- pattern
- ^(?:-?[1-9][0-9]*|0)$
1000000000errorCodestring[]obligatorioWhy execution failed, set together with status canceled_by_error — for example insufficient_reserve_at_execution, order_below_min_notional, order_exceeds_market_depth or slippage_tolerance. Null otherwise.
Elementos del array · string
string
Ver ejemplo
[
"string"
]reasonstring · enum · nullableobligatorioWhy the platform cancelled the order itself, for example force_close or weekly_session_risk_close. Null for trader-driven cancellations.
"force_close" "stop_accounts_fail" "stop_accounts_freeze" "stop_accounts_promote" "stop_accounts_manual" "weekly_session_risk_close" nullforce_close{
"id": "00000000-0000-4000-8000-000000000000",
"txId": "string",
"trader": "00000000-0000-4000-8000-000000000000",
"market": "00000000-0000-4000-8000-000000000000",
"status": "active",
"type": "market",
"direction": "long",
"triggerPrice": "1000000000",
"requestedTriggerPrice": "1000000000",
"stopPrice": "1000000000",
"limitPrice": "1000000000",
"stopTriggerPrice": "1000000000",
"takeTriggerPrice": "1000000000",
"trailingStopActivationPrice": "1000000000",
"trailingStopOffset": "1000000000",
"trailingStopOffsetPercent": "1000000000",
"leverage": "1000000000",
"index": "string",
"positionId": [
"string"
],
"parentOrderId": [
"string"
],
"expiration": "2026-05-01T12:30:00.000Z",
"amount": "1000000000",
"indexPrice": "1000000000",
"settlementOraclePrice": "1000000000",
"createdAt": "2026-05-01T12:30:00.000Z",
"error": [
"string"
],
"realizedPnl": "1000000000",
"rawRealizedPnl": "1000000000",
"profitAdjustmentApplied": true,
"executedAfterPause": true,
"sizeMode": "quote",
"baseSize": "1000000000",
"reservedAmount": "1000000000",
"errorCode": [
"string"
],
"reason": "force_close"
}