GET
/
calendar
/
dividends

Returns dividends data for a selected period and/or security.

Authorizations

token
string
queryrequired

Headers

accept
enum<string>
default: application/jsonrequired

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

Available options:
application/json

Query Parameters

page
integer
default: 0

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.

pagesize
integer

Number of results returned. Limit 1000

parameters[date]
string

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

Date to query from point in time.

parameters[date_to]
string

Date to query to point in time.

parameters[tickers]
string

One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified.

parameters[importance]
enum<integer>

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

Available options:
0,
1,
2,
3,
4,
5
parameters[date_sort]
enum<string>

Dividend date field to sort on (newest to oldest)

Available options:
announced,
ex,
payable,
record
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.

parameters[dividend_yield_operation]
enum<string>

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

Available options:
gt,
gte,
eq,
lte,
lt
parameters[dividend_yield]
number

The dividend yield amount to filter by. Defaults to using Equal To the amount indicated. 1 =100%eater Than or Equal To’, ‘Equal To’, ‘Less Than or Equal To’, and ‘Less Than’ filters respectively.

Response

200 - application/json
dividends
object[]