v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Investments

List all investment holdings

The endpoint returns a paginated list of investment accounts and their associated holdings, including positions, quantities, values, and asset details. Supports optional filtering by account IDs, account subtypes, and holding types.

get/v1/links/{link_id}/investments/

Query parameters

account_idsstring

Comma-separated list of account IDs to filter holdings

account_subtypesstring

Comma-separated list of account subtypes to filter holdings (e.g., PLAN_401_K, IRA, BROKERAGE)

holding_typesstring

Comma-separated list of holding types to filter holdings (e.g., EQUITY, MUTUAL_FUND, OPTIONS)

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page. Default is 100, maximum is 500.

Response

countinteger

nextstring uri nullable required

previousstring uri nullable required

Example response

{
  "accounts": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "created_at": "2022-05-04T11:30:00Z",
      "updated_at": "2022-05-04T12:00:00Z",
      "type": "CHECKING",
      "subtype": "MONEY_MARKET",
      "mask": "6789",
      "nickname": "My account",
      "balances": {
        "currency_code": "USD",
        "balance": "100.00",
        "available_balance": "50.99",
        "credit_limit": "200.00"
      },
      "holdings_value": "145000.00"
    }
  ],
  "holdings": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "created_at": "2026-04-01T10:00:00Z",
      "updated_at": "2026-04-01T10:00:00Z",
      "account_id": "f3e2d1c0b9a8978685746362514e3f2e",
      "cost_basis": "10000.00",
      "currency_code": "USD",
      "current_price": "150.25",
      "current_price_as_of": "2026-04-03T16:00:00Z",
      "purchase_price": "100.00",
      "daily_change": "2.50",
      "description": "Vanguard S&P 500 ETF",
      "holding_type": "EXCHANGE_TRADED_FUND",
      "market_value": "15025.00",
      "quantity": "100.0",
      "symbol": "VOO",
      "total_ugl_amount": "5025.00",
      "total_ugl_percentage": "0.5025",
      "face_value": "10000.00",
      "rate": "1.00"
    }
  ]
}