API ReferenceTrading Accounts

Search Dynamic Accounts

View as MarkdownOpen in Claude
Returns a list of accounts matching a query pattern set in the request. Broker accounts configured with the DYNACCT property will not receive account information at login. Instead, they must dynamically query then set their account number. Customers without the DYNACCT property will receive a 503 error.

Path parameters

searchPatternstringRequired

Response

Returns all accounts that match the searchPattern string.
matchedAccountslist of objects
Contains a series of objects that pertain to the account information requested.
patternstring
Displays the searchPattern used for the request.

Errors

401
Unauthorized Error
503
Service Unavailable Error