Skip to main content

List rebalances

GET 
/v1/rebalances

Returns your firm's rebalances set for today that have one of the statuses in status and match the query in q. Send executedFrom and executedTo instead to return the rebalances executed in that time range, whatever day they were set for. To see only the rebalances of a rebalance board, send its query as q.

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 10000, or a text in single or double quotes, such as 'Risk Allocation'; 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. Example: unsettled_cash_total > 10000 and num_trades > 30.

The fields of q:

  • status, text: the status of the rebalance, such as proposed.
  • type, text: the type of the rebalance, such as tolerance.
  • household_name, text: the name of the household.
  • rebalance_reason, text: the reason for the rebalance, as reason gives it, such as Risk Allocation.
  • reason_change, number: the drift. For a reason that ends in Allocation, compare a fraction from 0 to 1, which is reasonChange divided by 100. For Cash, compare an amount in US dollars, as reasonChange gives it.
  • num_trades, number: the number of trades.
  • aum_total, number: the total value of the household's accounts, in US dollars.
  • unsettled_cash_total, number: the unsettled cash of the household's accounts, in US dollars.
  • buy_total and sell_total, number: the value of the buy trades and of the sell trades, in US dollars.
  • realized_gain_loss_total, number: the realized gain or loss of the trades, in US dollars.
  • check_status, text: pass, review_recommended or action_required.
  • check_score, number: the score of the check, as checkScore gives it.
  • check_critical, check_error, check_warning and check_info, number: the number of check findings of each severity.

Request​

Responses​

A page of rebalances.