tools

Get portfolio

Use this when the user asks about investment holdings, allocation, or concentration. Read portfolio positions, allocation, and concentration for the full filtered portfolio. includePositions false returns the allocation summary; true pages positions by cursor.

post/v1/tools/betteroff_get_portfolio

Request

  • Base URL: https://api.betteroff.finance
  • URL: https://api.betteroff.finance/v1/tools/betteroff_get_portfolio
  • Auth: one of:
    • OpenID Connect (https://app.betteroff.finance/api/auth/.well-known/openid-configuration, scopes: investments:read)
    • HTTP bearer

Request body

symbolstring nullable required

Filter by ticker symbol (e.g. AAPL, BTC, ETH). Use null for all symbols.

instrumentIdstring nullable required

Filter by canonical instrument ID. Preferred over symbol when available. Use null for all.

typestring nullable required

Filter by holding type (equity, etf, mutual_fund, crypto). Use null for all types.

groupBy'type' | 'account' | 'symbol' | 'instrument' | 'underlying' required

Group by type, account, symbol, separate instrument, or underlying ISIN exposure across brokerage holdings and Stock Tokens.

includePositionsboolean required
limitinteger nullable required

Response

Tool result

OR

Changes

No recorded changes to this operation across all 1 revision of this API.