Skip to navigation

Account List

View as Markdown

List all accounts.

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.

Retrieve every account you can access. Organization administrators receive the accounts in their organization; traders receive their own accounts and any they hold an approved trading permission for.

Common Failure Scenarios

  • Accounts you can’t access are left out of the response array. The call doesn’t return an error for them.
  • The caller’s user type, or the API key’s permissions, can’t read accounts. 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 accounts.

Related Endpoints

Authentication

AuthorizationBearer

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

Response

Account
namestring<=64 characters
userIdlong
accountTypeenum
Customer, Employee, Giveup, House, Omnibus, Wash
clearingHouseIdlong
riskCategoryIdlong
autoLiqProfileIdlong
marginAccountTypeenum
Hedger, Speculator
Allowed values:
legalStatusenum
Corporation, GP, IRA, Individual, Joint, LLC, LLP, LP, PTR, Trust
timestampdatetime
idlongOptional
restrictedbooleanOptional
closedbooleanOptional
evaluationSizedoubleOptional
readonlybooleanOptional
ccEmailstringOptional<=64 characters
futuresDisabledbooleanOptional
swapEnabledbooleanOptional
ssfRiskDisclosureAcknowledgmentdatetimeOptional
spotMarginEnabledbooleanOptional
activebooleanOptional