Skip to main content

List accounts

GET 
/v1/accounts

Returns your firm's active accounts, in order of name. Send includeInactive=true to include inactive accounts, and id to return only the accounts with those IDs. Send balances=true to add each account's current holdings, balance, cash, cash weight and risk allocation; riskAllocation.target is always {} here, and Get an account returns it. Send q to return only the accounts that match a query, and sort to order them; totalCount counts only the accounts that match.

q takes an RQL query: one or more conditions of the form field operator value, joined by and or or, with parentheses to group them. and applies before or. The operators are =, !=, >, >=, < and <. A value is a whole number, such as 50000, or a text in single or double quotes, such as 'Rivera'; put a backslash before a quote inside a text. On a text field, = matches a field that contains the text, in any case, and != one that does not. A true-or-false field takes 'true' or 'false', in quotes, with = or != only. Example: householdName = 'Rivera' and accountBalance > 50000.

sort takes one field, as field, field:asc or field:desc. An account with no value for the field comes last in either order.

A query or sort on a field that needs balances=true gets status 400 without it. The fields of q and sort:

  • name, text: the name of the account, as displayName gives it.
  • displayName, text: the same name as name.
  • householdName, text: the name of the account's household.
  • model, text: the name of the model assigned to the account. The model of its household does not count.
  • type, text: the account type, such as IRA.
  • isActive, true or false: 'true' for an active account.
  • accountBalance, number, needs balances=true: the current total value of the account, in US dollars.
  • cashBalance, number, needs balances=true: the current cash value of the account, in US dollars.
  • cashBalanceWeight, number, needs balances=true: the cash value as a percent of the total value, from 0 to 100.
  • riskAllocation, number, needs balances=true: the percent of the account's current allocation that is to the risk level named growth, from 0 to 100. The risk level's name must be growth exactly: where your firm's risk level is named Growth, no account has a value for this field, so a condition on it matches no account and a sort on it keeps the order of name.
  • inceptionDate, for sort only: the date the account was opened.

Request​

Responses​

A page of accounts.