Account Dependents
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
masteriddoesn’t exist, or is one you can’t access. Both returnHTTP 401with"Access is denied", notHTTP 404. - That user’s accounts you can’t access are left out of the response array.
- The
masteridparameter 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 401with"Access is denied".
Error Messages
Related Endpoints
- Use
accountLDependentsto retrieve the accounts for several users in one call. - Use
accountListto retrieve every account you can access.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
masterid
User entity ID
Response
Account
name
userId
accountType
Customer, Employee, Giveup, House, Omnibus, Wash
clearingHouseId
riskCategoryId
autoLiqProfileId
marginAccountType
Hedger, Speculator
Allowed values:
legalStatus
Corporation, GP, IRA, Individual, Joint, LLC, LLP, LP, PTR, Trust
timestamp
id
restricted
closed
evaluationSize
readonly
ccEmail
futuresDisabled
swapEnabled
ssfRiskDisclosureAcknowledgment
spotMarginEnabled
active