Place OSO

View as Markdown
### Place an OSO (order-sends-order) order strategy. **Available to:** All authenticated users **Environments:** Demo, Live **[Rate Limit](/api/authentication#request-rate-limits-and-time-penalties):** 1,500 requests per hour, 1-second back-off, counts all requests An OSO strategy places a primary order that, once filled, automatically submits one or two bracket orders — for example, an entry order that sends a take-profit when it fills. Provide the primary order's fields plus `bracket1` (required) and, optionally, `bracket2`. If you specify both brackets, they're linked to each other as an OCO, so filling one cancels the other. On success, the response includes the primary order's `orderId`. ```js // Demo environment; for Live use https://live.tradovateapi.com/v1 const URL = 'https://demo.tradovateapi.com/v1' const oso = { accountSpec: yourUserName, accountId: yourAccountId, action: "Buy", symbol: "MESM1", orderType: "Limit", price: 4150.00, orderQty: 1, isAutomated: true, bracket1: { action: "Sell", orderType: "Limit", price: 4200.00 } } const result = await fetch(`${URL}/order/placeoso`, { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer ${myAccessToken}` }, body: JSON.stringify(oso) }).then(res => res.json()) // { orderId } on success ``` <Warning> Set `isAutomated` to `true` for any order placed by code or an automated process, and `false` only for an order a human places directly. Misreporting this can violate exchange policies. </Warning> As with any order, acceptance is subject to market, exchange, and risk-management rules. When rejected, the response carries a `failureReason` and `failureText`. **Common Failure Scenarios** - A risk limit blocks the primary order (for example, `MaxPosLimitReached`). - A contract or price is invalid for the primary order or a bracket (`InvalidContract`, `InvalidPrice`). - The trading session is closed (`SessionClosed`). **Error Messages** | `failureReason` | Trigger | |-----------------|---------| | `InvalidPrice` | A price is missing or invalid for the primary order or a bracket. | | `MaxPosLimitReached` | The order would exceed the account's position limit. | | `SessionClosed` | The trading session is closed. | See the `failureReason` enum in the response schema for the complete list of values.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
actionenumRequired
Buy, Sell
symbolstringRequired<=64 characters
orderQtyintegerRequired
orderTypeenumRequired
Limit, LimitIfTouched, MIT, Market, MarketLimit, MarketStopWithProtection, MarketWithProtection, QTS, Stop, StopLimit, TrailingStop, TrailingStopLimit
bracket1objectRequired
accountSpecstringOptional<=64 characters
accountIdlongOptional
clOrdIdstringOptional<=64 characters
pricedoubleOptional
stopPricedoubleOptional
limitIfTouchedPricedoubleOptional
maxShowintegerOptional
pegDifferencedoubleOptional
timeInForceenumOptional
Day, FOK, GTC, GTD, IOC
expireTimedatetimeOptional
textstringOptional<=64 characters
activationTimedatetimeOptional
customTag50stringOptional<=64 characters
isAutomatedbooleanOptional
bracket2objectOptional

Response

PlaceOsoResult
failureReasonenum
AccountClosed, AdvancedTrailingStopUnsupported, AnotherCommandPending, BackMonthProhibited, ExecutionProviderNotConfigured, ExecutionProviderUnavailable, InvalidContract, InvalidPrice, KeyInformationDocumentRequired, LiquidationOnly, LiquidationOnlyBeforeExpiration, MaxOrderQtyIsNotSpecified, MaxOrderQtyLimitReached, MaxPosLimitMisconfigured, MaxPosLimitReached, MaxTotalPosLimitReached, MultipleAccountPlanRequired, NoQuote, NotEnoughLiquidity, OtherExecutionRelated, ParentRejected, RiskCheckTimeout, SSFNFAComplianceRequired, SSFNFAComplianceRequiredJointOnly, SSFRiskDisclosureAcknowledgmentRequired, SessionClosed, Success, TooLate, TradingLocked, TrailingStopNonOrderQtyModify, Unauthorized, UnknownReason, Unsupported
failureTextstring<=8192 characters
orderIdlong
oso1Idlong
oso2Idlong