Reference

ReferenceData(output_format)

Parameters

  • output_format - The format to output. Options:
    • dataframe (default) - Return result as a pandas dataframe.
    • json - Return raw result converted from JSON to a python data structure.

The reference instance

The reference object is designed to map closely to the Reference Data section of the IEX API.

You can import either ReferenceData (the class) or reference from iex. The reference import is an instance of ReferenceData that can be used without having to instantiate a new object.

Importing the reference object

from iex import reference

Setting the output format using the instance

To update the output format, set the output_format attribute:

reference.output_format = 'json'

Reference Methods

Below are the methods that can be invoked with a reference object. Beneath the listed method you will find a link that will take you to the corresponding IEX API documentation.

symbols()

IEX API - symbols

from iex import reference
reference.symbols()

# Output

     symbol        date  iexId  isEnabled  \
0         A  2018-05-15      2       True   
1        AA  2018-05-15  12042       True   
2      AABA  2018-05-15   7653       True   
...

iex_corporate_actions()

IEX API - IEX Corporate Actions

Parameters

  • date - Date specified as YYYYMMDD or a datetime object.

iex_dividends()

IEX API - IEX Dividends

Parameters

  • date - Date specified as YYYYMMDD or a datetime object.

iex_next_day_ex_date()

IEX API - IEX Next Day Ex Date

Parameters

  • date - Date specified as YYYYMMDD or a datetime object.

iex_listed_symbol_directory()

IEX API - IEX Listed Symbol Directory

Parameters

  • date - Date specified as YYYYMMDD or a datetime object.