Skip to navigation

Account Items

View as Markdown

Retrieve several accounts by ID.

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.

Resolve multiple accountIds to their account records in a single call. Prefer this over repeated accountItem calls when you need to resolve several IDs at once.

Common Failure Scenarios

  • An ID in ids that doesn’t match an account, or matches one you can’t access, is left out of the response array. The call still succeeds, so compare the returned records against the IDs you requested.
  • The ids 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.
(no message text)404The ids parameter is missing or repeated.
"Internal Server Error, error id: {id}"500A value in ids 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

idslist of longsRequired

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