Skip to navigation

Account L Dependents

View as Markdown

Retrieve the accounts belonging to several users.

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 accounts associated with a set of users in a single call. Pass the user IDs as masterids. Prefer this over repeated accountDependents calls when you need the accounts for several users at once.

Common Failure Scenarios

  • Any one of the users in masterids doesn’t exist, or is one you can’t access. The whole call returns HTTP 401 with "Access is denied", not HTTP 404.
  • Accounts you can’t access are left out of the response array.
  • The masterids parameter is missing or repeated (HTTP 404), or contains a value that isn’t a number (HTTP 500).
  • 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"401Any one of the users in masterids doesn’t exist, or the caller can’t see it.
(no message text)404The masterids parameter is missing or repeated.
"Internal Server Error, error id: {id}"500A value in masterids isn’t a number. The error ID is generated per request.

Related Endpoints

Authentication

AuthorizationBearer

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

Query parameters

masteridslist of longsRequired
List of User entity IDs

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