Skip to navigation

Order Dependents

View as Markdown

Retrieve the orders for an account.

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.

Return the orders for one account. Pass the account’s ID as masterid.

Common Failure Scenarios

  • The account in masterid doesn’t exist, or is one you can’t access. Both return HTTP 401 with "Access is denied", not HTTP 404.
  • The masterid 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.
"Access is denied"401The account in masterid doesn’t exist, or the caller can’t see that account.
(no message text)404The masterid parameter is missing or repeated.
"Bad Request"400masterid isn’t a whole number.

Related Endpoints

  • Use orderLDependents to retrieve the orders for several accounts in one call.
  • Use orderList to retrieve every order you can access.

Authentication

AuthorizationBearer

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

Query parameters

masteridlongRequired
Account entity ID

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