< API Reference
GET
/market/symbols/{symbols}/calendar?event_type={event_type}&start_date={start_date}&end_date={end_date}
STOCKS
Get calendar events

Example URI

Live

https://api.livevol.com/v1/live/market/symbols/DAL/calendar?event_type=earnings&start_date=2019-01-01&end_date=2019-01-18

Delayed

https://api.livevol.com/v1/delayed/market/symbols/DAL/calendar?event_type=earnings&start_date=2019-01-01&end_date=2019-01-18

Request Information

URI Parameters

NameDescriptionTypeAdditional information
event_type

Event type

string

Allowed values are [ all, earnings, dividends ]

Default value is: all

symbols

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

string

None.

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 types:
EarningsEvent

NameDescriptionTypeAdditional information
year

Year

integer

None.

quarter

Quarter

integer

None.

report_date

Date of earnings represented as YYYY-MM-DD

string

None.

time_of_day

Time of the day (BMO/AMC/DMT)

string

None.

report_date_type

Report date type

ReportDateType

None.

eps_actual

Actual amount of earnings

decimal number

None.

eps_estimate

Estimated amount of earnings

decimal number

None.

actual_currency

Actual currency

string

None.

underlying_symbol

Underlying symbol

string

None.

company_name

Company name

string

None.

DividendsEvent
NameDescriptionTypeAdditional information
ex_dividend_date

Ex-dividend date represented as YYYY-MM-DD

string

None.

payment_date

PaymenT date represented as YYYY-MM-DD

string

None.

dividend

Dividend

decimal number

None.

dividend_code

Dividend code

DividendCode

None.

unadjusted_dividend

Unadjusted dividend

decimal number

None.

data_source

Data source

DataSource

None.

underlying_symbol

Underlying symbol

string

None.

company_name

Company name

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "year": 2012,
    "quarter": 1,
    "report_date": "2012-01-24",
    "time_of_day": "AMC",
    "date_type": "V",
    "report_date_type": "confirmed",
    "eps_actual": 13.87,
    "eps_estimate": 10.08,
    "actual_currency": "USD",
    "underlying_symbol": "CBOE",
    "company_name": "Cboe Global Markets Inc",
    "data_source_id": 11
  },
  {
    "ex_dividend_date": "2010-09-01",
    "payment_date": "2010-09-24",
    "dividend": 0.1,
    "special_dividend_code": 0,
    "dividend_code": "regular",
    "unadjusted_dividend": 0.10000000149011612,
    "data_source": "projected",
    "underlying_symbol": "CBOE",
    "company_name": "Cboe Global Markets Inc",
    "data_source_id": 11
  }
]

application/xml, text/xml

Sample:
<events xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <event xmlns="" i:type="earning">
    <company_name>Cboe Global Markets Inc</company_name>
    <data_source_id>11</data_source_id>
    <underlying_symbol>CBOE</underlying_symbol>
    <actual_currency>USD</actual_currency>
    <date_type>86</date_type>
    <eps_actual>13.87</eps_actual>
    <eps_estimate>10.08</eps_estimate>
    <quarter>1</quarter>
    <report_date>2012-01-24</report_date>
    <report_date_type>confirmed</report_date_type>
    <time_of_day>AMC</time_of_day>
    <year>2012</year>
  </event>
  <event xmlns="" i:type="dividend">
    <company_name>Cboe Global Markets Inc</company_name>
    <data_source_id>11</data_source_id>
    <underlying_symbol>CBOE</underlying_symbol>
    <data_source>projected</data_source>
    <dividend>0.1</dividend>
    <dividend_code>regular</dividend_code>
    <ex_dividend_date>2010-09-01</ex_dividend_date>
    <payment_date>2010-09-24</payment_date>
    <special_dividend_code>0</special_dividend_code>
    <unadjusted_dividend>0.10000000149011612</unadjusted_dividend>
  </event>
</events>