Skip to navigation

Account Dependents

View as Markdown

Retrieve the accounts belonging to a user.

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 every account associated with a given user. Pass the user’s ID as masterid.

Common Failure Scenarios

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

Related Endpoints

Authentication

AuthorizationBearer

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

Query parameters

masteridlongRequired
User entity ID

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