Account Finds
Find several accounts by name.
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.
Look up multiple accounts by name in a single call, returning each matching record, including its id. Prefer this over repeated accountFind calls when you need to resolve several names at once.
Common Failure Scenarios
- A name in
namesthat 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 names you requested. - The
namesparameter is missing or repeated (HTTP 404). - 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
accountFindto look up a single account by name. - Use
accountItemsto resolve several accounts byidinstead.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
names
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