Skip to navigation

Order Strategy Item

View as Markdown

Retrieve an order strategy by ID.

Available to: Traders (own accounts and any they hold an approved trading permission for); organization administrators (any account in their organization)

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

On Live, some organizations restrict administrators from accessing other members’ accounts unless they hold an approved trading permission for that account.

Resolve a single orderStrategyId to its order strategy record, including its accountId, contractId, orderStrategyTypeId, and status.

Common Failure Scenarios

  • No order strategy matches the id, or the id is for an order strategy you can’t access. Both return HTTP 404 with an empty body, not HTTP 401.
  • The id parameter is missing or repeated (HTTP 404), or isn’t a whole number (HTTP 400).
  • The caller’s user type, or the API key’s permissions, can’t read order strategies. This returns HTTP 401 with "Access is denied".

Error Messages

MessageResponseTrigger
"Access is denied"401The caller’s user type, or the API key’s permissions, can’t read order strategies.
(no message text)404No order strategy matches the id, or the caller can’t see that order strategy. An order strategy the caller can’t see returns 404, not 401.
(no message text)404The id parameter is missing or repeated.
"Bad Request"400id isn’t a whole number.

Related Endpoints

Authentication

AuthorizationBearer

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

Query parameters

idlongRequired

Response

OrderStrategy
accountIdlong
timestampdatetime
contractIdlong
orderStrategyTypeIdlong
actionenum
Buy, Sell
Allowed values:
statusenum
ActiveStrategy, ExecutionFailed, ExecutionFinished, ExecutionInterrupted, InactiveStrategy, NotEnoughLiquidity, StoppedByUser
idlongOptional
initiatorIdlongOptional
paramsstringOptional<=8192 characters
uuidstringOptional<=64 characters
failureMessagestringOptional<=512 characters
senderIdlongOptional
customTag50stringOptional<=64 characters

Operator ID for the order. Send it only if NinjaTrader configured an allow-list of operator IDs for your user. In that case it’s required on every order and must exactly match one approved value. If no allow-list is configured, omit it: a supplied value is denied. Organizations using passthrough also omit it, and NinjaTrader fills it in. Up to 64 characters. See Operator ID (customTag50) and Passthrough.

userSessionIdlongOptional