IEX Cloud Modules

Stock Endpoint

iex.stock.balance_sheet(symbol, external=False, vprint=False, **query_params)

Returns

Balance sheet financial statement for the requested stock.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• queries (key value pair where key is variable and value is string) – Standard kwargs parameter.

iex.stock.book(symbol, external=False, vprint=False)

Returns

Book price for the requested stock.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.cash_flow(symbol, external=False, vprint=False, **query_params)

Returns

Cash sheet financial statment for the requested stock.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• queries (key value pair where key is variable and value is string) – Standard kwargs parameter.

iex.stock.collection(collectionType, collectionName, external=False, vprint=False)

Returns

Quotes for stock in the requested collection type.

Parameters

• collectionType (accepted values are ['sector', 'tag', 'list'], required) – The type of data returned by the endpoint.

• collectionName (string, required) – Name of the sector, tag, or list to return. List of names available on IEX Cloud.

iex.stock.company(symbol, external=False, vprint=False, **query_params)

Returns

Company data such as website, address, and description for the requested company.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.delayed_quote(symbol, external=False, vprint=False)

Returns

15-minute delayed market quote for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.dividends(symbol, scope, external=False, vprint=False)

Returns

Returns dividend information for a requested ticker.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• scope (accepted arguments: ['5y','2y','1y','ytd','6m','3m','1m','next'], required) – The range of data needed.

iex.stock.earnings(symbol, last=None, field=None, external=False, vprint=False)

Returns

Earnings data such as actual EPS, beat/miss, and date for the requested ticker.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• last (string, optional) – The number of previous earnings to return.

• field (string, optional) – The specific field from the earnings report ot return.

iex.stock.estimates(symbol, external=False, vprint=False)

Returns

Latest future earnings estimates for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.financials(symbol, period=None, external=False, vprint=False)

Returns

Brief overview of a company’s financial statements.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• period (accepted values are ['annual', 'quarterly'], optional) – The time interval of financial statements returned.

iex.stock.fund_ownership(symbol, external=False, vprint=False)

Returns

Largest 10 fund owners of the requested ticker. This excludes explicit buy or sell-side firms.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.historical_price(symbol, period, date=None, external=False, vprint=False, **query_params)

Returns

Adjusted and unadjusted historical data for up to 15 years, and historical minute-by-minute intraday prices for the last 30 trailing calendar days.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• period (string, required) – The period of data you would like to have returned. Accepted arguments are [‘max’, ‘5y’, ‘2y’, ‘1y’, ‘ytd’, ‘6m’, ‘3m’, ‘1m’, ‘1mm’, ‘5d’, ‘5dm’, ‘date’, ‘dynamic’]

iex.stock.income_statement(symbol, external=False, vprint=False, **query_params)

Returns

Income statement financial data for the requested ticker.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• queries (key value pair where key is variable and value is string) – Standard kwargs parameter.

iex.stock.insider_roster(symbol, external=False, vprint=False)

Returns

10 largest insider owners for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.insider_summary(symbol, external=False, vprint=False)

Returns

Summary of the insiders and their actions within the last 6 months for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.insider_transactions(symbol, external=False, vprint=False)

Returns

Summary of insider transactions for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.institutional_ownership(symbol, external=False, vprint=False)

Returns

10 largest instituional owners for the requested ticker. This is defined as explicitly buy or sell-side only.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.ipo_today(external=False, vprint=False)

Returns

List of IPOs happening today.

iex.stock.ipo_upcoming(external=False, vprint=False)

Returns

List of upcoming IPOs for the current and next month.

iex.stock.key_stats(symbol, stat=False, external=False, vprint=False)

Returns

Important and key statistics for the requested ticker.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• stat (string, optional) – The specific stat which you would like to return.

iex.stock.largest_trades(symbol, external=False, vprint=False)

Returns

Delayed list of largest trades for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.logo(symbol, external=False, vprint=False)

Returns

Google APIs link to the logo for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.market_list(list_type, display_percent=None, external=False, vprint=False)

Returns

10 largest companies in the specified list.

Parameters

• list_type (accepted values are ['mostactive', 'gainers', 'losers', 'iexvolume', 'iexpercent', 'premarket_losers', 'postmarket_losers', 'premarket_gainers', 'postmarket_gainers'], required) – The list that you would like to return.

• displayPercent (boolean, optional) – Whether you would like to see the percentage values multiplied by 100

iex.stock.market_volume(format=None, external=False, vprint=False)

Returns

Market wide trading volume.

Parameters

format (accepted value is 'csv', optional) – The output format of the endpoint

iex.stock.new_historical_price(symbol, period, date=None, chartByDay=False, external=False, vprint=False, **query_string_params)

Returns

Adjusted and unadjusted historical data for up to 15 years, and historical minute-by-minute intraday prices for the last 30 trailing calendar days.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• period (string, required) – The period of data you would like to have returned. Accepted arguments are [‘max’, ‘5y’, ‘2y’, ‘1y’, ‘ytd’, ‘6m’, ‘3m’, ‘1m’, ‘1mm’, ‘5d’, ‘5dm’, ‘date’, ‘dynamic’]

• date (string, optional) – If used with the query parameter chartByDay, then this returns historical OHLCV data for that date. Otherwise, it returns data by minute for a specified date. Date format YYYYMMDD

• chartByDay (boolean, optional) – If single date is specified, this returns historical OHLCV data for that date.

Query string parameters allow you to specify what data you want on a finer scale. Boolean parameters should be typed as strings in the following format: ‘key=value’

A full list of these parameters can be found in the IEX documentation.

iex.stock.news(symbol, last=None, external=False, vprint=False)

Returns

News item summaries for the requested ticker.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• last (integer, optional) – The number of news items to return.

iex.stock.ohlc(symbol, external=False, vprint=False)

Returns

Most recent days open, high, low, and close data for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.peers(symbol, external=False, vprint=False)

Returns

List of a requested ticker’s peers.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.previous(symbol, external=False, vprint=False)

Returns

Previous day’s price data for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.price(symbol, external=False, vprint=False)

Returns

Single float value of the requested ticker’s price.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.price_target(symbol, external=False, vprint=False)

Returns

Analyst’s price targets for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.quote(symbol, field=None, external=False, vprint=False)

Returns

rice quote data for the requested ticker. Fields are able to be called individually.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• field (string, optional) – The specific field from the quote endpoint you would like to return.

iex.stock.recommendation_trends(symbol, external=False, vprint=False)

Returns

Analyst recommendations for the requested ticker.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

iex.stock.sector_performance(external=False, vprint=False)

Returns

Market performance for all sectors.

iex.stock.splits(symbol, scope=None, external=False, vprint=False)

Returns

Record of stock splits for the requested ticker.

Parameters

• symbol (string, required) – The ticker or symbol of the stock you would like to request.

• scope (accepted arguments: ['5y','2y','1y','ytd','6m','3m','1m','next'], optional) – The range of data needed.

iex.stock.today_earnings(external=False, vprint=False)

Returns

Earnings data released today, grouped by timing and stock.

iex.stock.volume_by_venue(symbol, external=False, vprint=False)

Returns

rading volume for the requested ticker by venue.

Parameters

symbol (string, required) – The ticker or symbol of the stock you would like to request.

Market Endpoint

iex.market.commodities(symbol, vprint=False)

Returns

Commodites data for the requested commodities symbol.

Parameters

symbol (string, required) – The symbol of the commodity you would like to return.

iex.market.economic_data(symbol, vprint=False)

Returns

Economic data for the requested economic indicator symbol.

Parameters

symbol (string, required) – The symbol of the economic indicator you would like to return.

iex.market.generic_data_point(symbol, key=None, vprint=False)

Returns

Generic endpoint used to access all ‘Data Point’ data sets on IEX

Parameters

symbol (string, required) – The symbol of the data point you would like to return.

iex.market.generic_time_series(symbol, *args, vprint=False)

Returns

Generic endpoint used to access all ‘Time Series’ data sets on IEX

Parameters

symbol (string, required) – The symbol of the time series data you would like to return.

Forex Endpoint

iex.forex.forex_conversion(symbols, amount, vprint=False)

Returns

Converts one currency to another using up-to-date currency information.

Parameters

• symbol (string, required) – The symbol of the currency pair you would like to return.

• amount (float, required) – The amount of the primary currency you wish to calculate and exchange rate on.

iex.forex.forex_historical(symbols, vprint=False, **queries)

Returns

Historical FOREX rates for the requested currency pair symbol.

Parameters

symbol (string, required) – The symbol of the currency pair you would like to return.

iex.forex.forex_latest_rate(symbols, vprint=False)

Returns

Latest FOREX rate for the requested currency pair symbol.

Parameters

symbol (string, required) – The symbol of the currency pair you would like to return.