Account Suggest
Suggest accounts matching a search term.
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
Return the accounts you can access that match the search text in t. Use this endpoint to power a type-ahead or search box over accounts, rather than retrieving the full list and filtering client-side.
The search ignores case and matches from the start of a word in the account’s name, its owner’s username and email, and the names of its clearing house, risk category, and auto-liquidation profile. By default, the response returns at most 10 accounts, even if l is larger. Set l lower to return fewer.
Common Failure Scenarios
- Accounts you can’t access are left out of the results. The call doesn’t return an error for them.
- The
tparameter is missing or repeated, or thelparameter is repeated (HTTP 404). Anlvalue that isn’t a whole number in the 32-bit range returnsHTTP 500. - 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
accountListto retrieve every account you can access. - Use
accountFindto look up an account by its fullname(the match ignores case).
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.