API TraderAPI QuantAPI Developer

Past ORTEX dividend forecasts for one listing, each beside what the company then declared. Every row is one event: the forecast as we made it at the chosen horizon, the declaration that resolved it, and whether the forecast was right. These are the same rows the published dividend scorecard is computed from.

Available Data Points:

• Event Key / Period: The event, as on the forecast endpoint.
• Kind / Frequency: As on the forecast endpoint.
• Horizon: The horizon the forecast was frozen at (see Horizons).
• Forecast As Of: The date the frozen forecast was made.
• Origin: published or replayed: how the frozen forecast was made (see Origin).
• Declaration Date, Ex Date, Record Date, Pay Date, bands: The dates as forecast at that horizon.
• Currency, Base Amount, Amount P10 / P50 / P90, Change Pct: The amount as forecast at that horizon.
• P Raise / P Hold / P Cut / P Omit / P Special, Outcome: The probabilities as forecast at that horizon.
• Resolution: declared (matched to the company's declaration), omitted (nothing was declared within 60 days of the expected declaration date) or pending (not yet resolved).
• Declared At / Declared Source: When ORTEX first knew of the declaration (UTC) and which source told us first.
• Declared Ex Date / Declared Pay Date / Declared Amount / Declared Currency: What the company declared.
• Actual Outcome: raise, hold, cut or omit: the declared amount against Base Amount.
• Ex Date Exact / Ex Date Within 3 Days / Amount Exact / Amount Within 5 Pct: Whether the frozen forecast was right, as the scorecard counts it.

Horizons

Forecasts are frozen at fixed horizons before the expected declaration date and never changed afterwards: first (the first forecast of the event), d90, d30, d7 and d1 (90, 30, 7 and 1 calendar days before). Use horizon to choose one; it defaults to d30, the horizon the headline scorecard quotes. Because frozen forecasts are never revised, the published rows of this history are exactly what we said before each declaration; replayed rows were rebuilt afterwards (see Origin).

Declarations

Declarations are ORTEX data. For US listings we read them from the listing venues (Nasdaq and NYSE), SEC EDGAR filings and the FINRA Daily List; for every other market, and for all history, from S&P Capital IQ. declaredSource is sec_edgar, nasdaq, nyse, finra or ciq (S&P Capital IQ).

Origin

origin says how the frozen forecast was made. published: the daily ORTEX forecast run froze it on the day it was made, before the declaration. replayed: ORTEX rebuilt it afterwards from the data as it stood on that day, to extend the history back before the forecast service began. A replayed forecast uses the payment history, results, prices and consensus known on the day, but S&P Capital IQ keeps no record of its own later corrections to past dividends, so a replayed forecast can look slightly better than a published one would have been.

Coverage

Regular dividends only; special payments are left out, as the scorecard leaves them out. Published forecasts start when the ORTEX forecast service began; replayed forecasts cover the years before it.

Filtering

from_date (required) and to_date bound the forecast ex-date. Results are ordered by ex-date, most recent first.

Try it out! You can test the API with the trial key TEST. Simply include it in your request headers; either here, or add the header "Ortex-Api-Key": "TEST" to your http request.

Trial key restrictions: Trial keys may be limited to a specific date range and set of regions. Requests outside the allowed regions or entirely outside the allowed date range are rejected; a date window that partially overlaps the allowed range is trimmed to it, reported in meta.restriction.

Get full access! Get a key at app.ortex.com/apis