iexfinance 0.3.5

Real-time Quotes

To obtain real-time quotes for one or more symbols, use the get_price method of the Stock object:

from iexfinance.stocks import Stock
tsla = Stock('TSLA')
tsla.get_price()

or for multiple symbols, use a list or list-like object (Tuple, Pandas Series, etc.):

batch = Stock(["TSLA", "AAPL"])
batch.get_price()

Historical Data

It’s possible to obtain historical data the get_historical_data and get_historical_intraday.

from datetime import datetime
from iexfinance.stocks import get_historical_data

start = datetime(2017, 1, 1)
end = datetime(2018, 1, 1)

df = get_historical_data("TSLA", start, end)

df = get_historical_data("TSLA", start, end, output_format='pandas')

import matplotlib.pyplot as plt

df.plot()
plt.show()

from datetime import datetime
from iexfinance.stocks import get_historical_intraday

date = datetime(2018, 11, 27)

get_historical_intraday("AAPL", date)

get_historical_intraday("AAPL", output_format='pandas')

Stock Endpoints

The Stock function creates a StockReader instance which has a method to retrieve each of the Stocks endpoints (get_quote, get_book, get_volume_by_venue, etc.):

from iexfinance.stocks import Stock
tsla = Stock('TSLA')
tsla.get_open()
tsla.get_price()

Pandas DataFrame and JSON (dict) output formatting are selected with the output_format parameter when calling Stock.

tsla = Stock("TSLA", output_format='pandas')
tsla.get_quote()

IEX Reference Data

Support for the IEX Reference Data endpoints is available through the top level functions get_available_symbols, get_corporate_actions, get_dividends, get_next_day_ex_date, and get_listed_symbol_dir. As with all endpoints, request parameters such as retry_count and output format selection (through output_format) can be passed to the call.

from iexfinance import get_available_symbols

get_available_symbols(output_format='pandas')[:2]

IEX Market Data

The IEX Market Data endpoints are supported through various top-level functions, including get_market_tops and get_market_deep.

from iexfinance import get_market_tops

get_market_tops()

IEX Stats

The IEX Stats endpoints are supported through various top-level functions, including get_stats_intraday and get_stats_recent. These endpoints provide IEX’s trading statistics for a given ticker.

from iexfinance import get_stats_intraday

get_stats_intraday()