Skip to navigation

Account Find

View as Markdown

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 the name is for an account you can’t access. Both return HTTP 404 with an empty body, not HTTP 401.
  • The name parameter is missing or repeated (HTTP 404).
  • 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)404No account matches the name, or the caller can’t see that account. An account the caller can’t see returns 404, not 401.
(no message text)404The name parameter is missing or repeated.

Related Endpoints

  • Use accountItem to resolve an account by id instead.
  • Use accountFinds to 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

namestringRequired

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