Skip to navigation

Order Item

View as Markdown

Retrieve an order 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 orderId to its order record, including its accountId, contractId, action, and ordStatus.

Common Failure Scenarios

  • No order matches the id, or the id is for an order 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 orders. 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 orders.
(no message text)404No order matches the id, or the caller can’t see that order. An order 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

Order
accountIdlong
timestampdatetime
Create Time
actionenum
Buy, Sell
Allowed values:
ordStatusenum
Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working
adminboolean
idlongOptional
contractIdlongOptional
spreadDefinitionIdlongOptional
executionProviderIdlongOptional
ocoIdlongOptional
parentIdlongOptional
linkedIdlongOptional
clOrdIdstringOptional