Order Item
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 theidis for an order you can’t access. Both returnHTTP 404with an empty body, notHTTP 401. - The
idparameter 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 401with"Access is denied".
Error Messages
Related Endpoints
- Use
orderItemsto resolve several IDs in one call. - Use
orderDependentsto retrieve the orders for an account.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
id
Response
Order
accountId
timestamp
Create Time
action
Buy, Sell
Allowed values:
ordStatus
Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working
admin
id
contractId
spreadDefinitionId
executionProviderId
ocoId
parentId
linkedId
clOrdId