Account Find
Find an account 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 an account by its name to get its id. Use this endpoint when you know an account by name and need the id that other records reference it by.
Common Failure Scenarios
- No account matches the
name, or thenameis for an account you can’t access. Both returnHTTP 404with an empty body, notHTTP 401. - The
nameparameter 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
accountItemto resolve an account byidinstead. - Use
accountFindsto look up several accounts by name in one call.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
name
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