v1

latestOpenAPI 3.0.02026-07-266091181.5 KB

Dividends

Dividends Events V2.2

Returns dividends data for a selected period and/or security, including both confirmed and unconfirmed dividend dates. V2.2 includes additional fields: confirmed, period, and year. This version provides more detailed information about dividend confirmation status and periodicity.

get/api/v2.2/calendar/dividends

Query parameters

pageinteger

Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date

pagesizeinteger

Number of results returned. Limit 1000

parameters[date]string YYYY-MM-DD

Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest

parameters[date_from]string YYYY-MM-DD

Date to query from point in time

parameters[date_to]string YYYY-MM-DD

Date to query to point in time

parameters[date_sort]'announced' | 'ex' | 'payable' | 'record'

Dividend date field to sort on (newest to oldest)

parameters[dividend_yield_operation]'gt' | 'gte' | 'eq' | 'lte' | 'lt'

Specifies how to filter using dividend yield. gt = Greater Than, gte = Greater Than Equal, eq = Equal, lt = Less Than, lte = Less Than Equal

parameters[dividend_yield]number

The dividend yield amount to filter by. Defaults to using Equal To the amount indicated. 1 = 100%

parameters[importance]0 | 1 | 2 | 3 | 4 | 5

The importance level to filter by. Uses Greater Than or Equal To the importance indicated

parameters[tickers]string csv

One or more ticker symbols separated by a comma. Maximum 50 tickers

parameters[updated]integer

Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated

Headers

accept'application/json' required

Specifies return format. Query parameters work the same for both formats

Response

Success

Example response

{
  "dividends": [
    {
      "confirmed": true,
      "currency": "USD",
      "date": "2024-01-09",
      "dividend": "0.25",
      "dividend_prior": "0.24",
      "dividend_type": "Cash",
      "dividend_yield": "0.55",
      "ex_dividend_date": "2024-01-12",
      "exchange": "NASDAQ",
      "frequency": 4,
      "id": "60a7f5e8e4b0f5a3c8e9f5a7",
      "importance": 3,
      "isin": "US0378331005",
      "name": "Apple Inc.",
      "notes": "Regular quarterly dividend",
      "payable_date": "2024-02-15",
      "period": "Q1",
      "record_date": "2024-01-15",
      "ticker": "AAPL",
      "updated": 1704819600,
      "year": 2024
    }
  ]
}