< API Reference
GET
/events/dividends?symbols={symbols}&start_date={start_date}&end_date={end_date}
None
Get dividend information

Example URI

https://sandbox.livevol.com/api/v1/events/dividends?symbols=DAL&start_date=2019-01-01&end_date=2019-06-30

Request Information

URI Parameters

NameDescriptionTypeAdditional information
symbols

Comma-separated list of symbols or special symbol ('all_symbols', 'all_optionable_symbols')

string

Required

start_date

Start date in YYYY-MM-DD format. Optional.

string

Constraint: value should be less than or equal to end_date value

Date in yyyy-MM-dd format. (i.e. 2019-01-18)

Default value is: 2003-01-01

end_date

End date in YYYY-MM-DD format. Optional.

string

Constraint: value should be greater than or equal to start_date value

Date in yyyy-MM-dd format. (i.e. 2019-01-18)

Default value is: 2100-01-01

Response Information

Resource Description

Collection of Dividend

NameDescriptionTypeAdditional information
underlying_symbol

Underlying symbol

string

None.

ex_date

Ex-dividend date represented as YYYY-MM-DD

string

None.

payment_date

Payment date represented as YYYY-MM-DD

string

None.

amount

Estimated amount of earnings

decimal number

None.

data_source

Source of dividends

DataSource

None.

dividend_code

Dividend code

DividendCode

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "underlying_symbol": "AAPL",
    "ex_date": "2016-06-30",
    "payment_date": "2016-07-10",
    "amount": 0.115,
    "data_source": "projected",
    "dividend_code": "regular"
  },
  {
    "underlying_symbol": "IBM",
    "ex_date": "2016-09-30",
    "payment_date": "2016-10-23",
    "amount": 0.115,
    "data_source": "market_implied",
    "dividend_code": "regular"
  }
]

application/xml, text/xml

Sample:
<dividends xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <dividend>
    <amount>0.115</amount>
    <data_source>projected</data_source>
    <dividend_code>regular</dividend_code>
    <ex_date>2016-06-30</ex_date>
    <payment_date>2016-07-10</payment_date>
    <underlying_symbol>AAPL</underlying_symbol>
  </dividend>
  <dividend>
    <amount>0.115</amount>
    <data_source>market_implied</data_source>
    <dividend_code>regular</dividend_code>
    <ex_date>2016-09-30</ex_date>
    <payment_date>2016-10-23</payment_date>
    <underlying_symbol>IBM</underlying_symbol>
  </dividend>
</dividends>