Skip to main content

Dividend yield by position

You can now query the dividend yield of a portfolio's positions: how much each security paid out in income, per unit, relative to its price over a period.

The new List Position Dividend Yield endpoint returns, for each security in the portfolio:

  • dividendYield: the dividend yield for the period, in decimal format (0.05 = 5%);
  • hasOpenPositionAllDays: whether there was a position on every day of the period;
  • currency: the security's payment currency;
  • security: the security's basic data.

The dividend yield is the sum of the income per unit with ex-dates in the period, divided by the security's closing price. The period is defined by startDate and endDate; when endDate is not informed, today's date is used. The endpoint also allows filtering by security, asset class, security type and broker.

Learn more in Dividend Yield.