Dividend Timeline Endpoint

GET

/api/v1/investments/dividends/timeline

curl --request GET \
  --url https://example.com/api/v1/investments/dividends/timeline

Full-history monthly dividend totals with a per-holding breakdown, base-currency converted – no time-window cap.

Responses

200

Successful Response

Media typeapplication/json

DividendTimelineOut

Full-history monthly dividend totals with a per-holding breakdown, base-currency converted, returned by GET /api/v1/investments/dividends/timeline.

object

months

required

Months

Array<object>

DividendTimelineMonthOut

One month’s total dividend income plus a per-holding breakdown, as aggregated by get_dividend_timeline().

object

month

required

Month

string

total

required

Total

string

by_holding

required

By Holding

Array<object>

DividendTimelineHoldingAmountOut

One holding’s aggregated dividend amount within a single month, built explicitly by get_dividend_timeline() (no from_attributes – not a direct ORM row).

object

ticker

required

Ticker

string

amount

required

Amount

string

Example ^generated

{
  "months": [
    {
      "month": "example",
      "total": "example",
      "by_holding": [
        {
          "ticker": "example",
          "amount": "example"
        }
      ]
    }
  ]
}