Reference Data

Note

The ref-data/symbols endpoint has changed in IEX Cloud. In the v1 (legacy) Developer API, this endpoint returned the list of symbols IEX supports for trading. In IEX cloud, it returns the list of symbols IEX supports for api calls.

Symbols

iexfinance.refdata.get_symbols(**kwargs)

Returns array of all symbols that IEX Cloud supports for API calls

Reference: https://iexcloud.io/docs/api/#symbols Data Weighting: 100 per call

Usage

In [1]: from iexfinance.refdata import get_symbols

In [2]: get_symbols()[:2]
Out[2]: 
[{'symbol': 'A',
  'exchange': 'SYN',
  'name': 'gntg c heliieAc.elsnToIno',
  'date': '2019-05-14',
  'type': 'sc',
  'iexId': 'IEX_46574843354B2D52',
  'region': 'US',
  'currency': 'SDU',
  'isEnabled': True},
 {'symbol': 'AA',
  'exchange': 'SNY',
  'name': 'rpC.coAao l',
  'date': '2019-05-14',
  'type': 'sc',
  'iexId': 'IEX_4238333734532D52',
  'region': 'SU',
  'currency': 'SUD',
  'isEnabled': True}]

IEX Symbols

iexfinance.refdata.get_iex_symbols(**kwargs)

Returns array of all symbols the Investor’s Exchange supports for trading

Reference: https://iexcloud.io/docs/api/#iex-symbols

Warning

This endpoint is only available using IEX Cloud. See Migrating to IEX Cloud for more information.

Reference: https://iexcloud.io/docs/api/#iex-symbols Data Weighting: Free

Usage

from iexfinance.refdata import get_iex_symbols

get_iex_symbols()[:2]

IEX Corporate Actions

IEX Corporate Actions is a reference list which includes the following:

  • Issues (new, deleted)

  • Symbol and name changes

  • Firms (new, deleted for IEX-listed securities)

Access is available through the function get_iex_corporate_actions:

iexfinance.refdata.get_iex_corporate_actions(start=None, **kwargs)

Returns IEX Corporate Actions from the ref-data endpoints

Warning

This endpoint is available with the legacy IEX Developer API version 1.0 only.

Parameters
  • start (datetime.datetime, default None, optional) – A month to use for retrieval (a datetime object)

  • kwargs (Additional Request Parameters (see base class)) –

Usage

In [3]: from iexfinance.refdata import get_iex_corporate_actions

In [4]: get_iex_corporate_actions()
---------------------------------------------------------------------------
IEXVersionError                           Traceback (most recent call last)
<ipython-input-4-478c502e17cb> in <module>
----> 1 get_iex_corporate_actions()

~/build/addisonlynch/iexfinance/iexfinance/refdata/__init__.py in get_iex_corporate_actions(start, **kwargs)
     44     kwargs: Additional Request Parameters (see base class)
     45     """
---> 46     return CorporateActions(start=start, **kwargs).fetch()
     47 
     48 

~/build/addisonlynch/iexfinance/iexfinance/utils/__init__.py in _wrapped_function(self, *args, **kwargs)
     82             return func(self, *args, **kwargs)
     83         else:
---> 84             raise IEXVersionError("(legacy) IEX Developer API version 1.0")
     85     return _wrapped_function

IEXVersionError: The requested endpoint is only available using (legacy) IEX Developer API version 1.0.

IEX Dividends

IEX Dividends details upcoming dividend information and other corporate actions (splits, etc.)

Access is available through the function get_iex_dividends

iexfinance.refdata.get_iex_dividends(start=None, **kwargs)

Returns IEX Dividends from the ref-data endpoints

Warning

This endpoint is available with the legacy IEX Developer API version 1.0 only.

Parameters
  • start (datetime.datetime, default None, optional) – A month to use for retrieval (a datetime object)

  • kwargs (Additional Request Parameters (see base class)) –

See also

The Dividends endpoint provides dividend information on individual or groups of ticker symbols

Usage

In [5]: from iexfinance.refdata import get_iex_dividends

In [6]: get_iex_dividends()
---------------------------------------------------------------------------
IEXVersionError                           Traceback (most recent call last)
<ipython-input-6-c39d2aa8ed8e> in <module>
----> 1 get_iex_dividends()

~/build/addisonlynch/iexfinance/iexfinance/refdata/__init__.py in get_iex_dividends(start, **kwargs)
     61     kwargs: Additional Request Parameters (see base class)
     62     """
---> 63     return Dividends(start=start, **kwargs).fetch()
     64 
     65 

~/build/addisonlynch/iexfinance/iexfinance/utils/__init__.py in _wrapped_function(self, *args, **kwargs)
     82             return func(self, *args, **kwargs)
     83         else:
---> 84             raise IEXVersionError("(legacy) IEX Developer API version 1.0")
     85     return _wrapped_function

IEXVersionError: The requested endpoint is only available using (legacy) IEX Developer API version 1.0.

IEX Next Day Ex Date

IEX Next Day Ex Date retrieves advance notifications of dividend declarations

Per the IEX docs, records are added at 8:00 a.m. ET one trading day before the specified ex-date, and updates are posted once per hour from 8:00 a.m to 6:00 p.m. EST daily.

Access is available through the function get_iex_next_day_ex_date

iexfinance.refdata.get_iex_next_day_ex_date(start=None, **kwargs)

Returns IEX Next Day Ex Date from the ref-data endpoints

Warning

This endpoint is available with the legacy IEX Developer API version 1.0 only.

Parameters
  • start (datetime.datetime, default None, optional) – A month to use for retrieval (a datetime object)

  • kwargs (Additional Request Parameters (see base class)) –

Usage

In [7]: from iexfinance.refdata import get_iex_next_day_ex_date

In [8]: get_iex_next_day_ex_date()
---------------------------------------------------------------------------
IEXVersionError                           Traceback (most recent call last)
<ipython-input-8-8ca010627c7c> in <module>
----> 1 get_iex_next_day_ex_date()

~/build/addisonlynch/iexfinance/iexfinance/refdata/__init__.py in get_iex_next_day_ex_date(start, **kwargs)
     78     kwargs: Additional Request Parameters (see base class)
     79     """
---> 80     return NextDay(start=start, **kwargs).fetch()
     81 
     82 

~/build/addisonlynch/iexfinance/iexfinance/utils/__init__.py in _wrapped_function(self, *args, **kwargs)
     82             return func(self, *args, **kwargs)
     83         else:
---> 84             raise IEXVersionError("(legacy) IEX Developer API version 1.0")
     85     return _wrapped_function

IEXVersionError: The requested endpoint is only available using (legacy) IEX Developer API version 1.0.

IEX Listed Symbol Directory

Similar to Symbol, IEX Listed Symbol Directory returns an array of all IEX listed securities.

Access is available through the function get_iex_listed_symbol_dir

iexfinance.refdata.get_iex_listed_symbol_dir(start=None, **kwargs)

Returns IEX Listed Symbol Directory from the ref-data endpoints

Warning

This endpoint is available with the legacy IEX Developer API version 1.0 only.

Parameters
  • start (datetime.datetime, default None, optional) – A month to use for retrieval (a datetime object)

  • kwargs (Additional Request Parameters (see base class)) –

Usage

In [9]: from iexfinance.refdata import get_iex_listed_symbol_dir

In [10]: get_iex_listed_symbol_dir()[0]
---------------------------------------------------------------------------
IEXVersionError                           Traceback (most recent call last)
<ipython-input-10-44c4bec4efdb> in <module>
----> 1 get_iex_listed_symbol_dir()[0]

~/build/addisonlynch/iexfinance/iexfinance/refdata/__init__.py in get_iex_listed_symbol_dir(start, **kwargs)
     95     kwargs: Additional Request Parameters (see base class)
     96     """
---> 97     return ListedSymbolDir(start=start, **kwargs).fetch()

~/build/addisonlynch/iexfinance/iexfinance/utils/__init__.py in _wrapped_function(self, *args, **kwargs)
     82             return func(self, *args, **kwargs)
     83         else:
---> 84             raise IEXVersionError("(legacy) IEX Developer API version 1.0")
     85     return _wrapped_function

IEXVersionError: The requested endpoint is only available using (legacy) IEX Developer API version 1.0.