Market Info

Overview

List of Endpoints

Collections

The Collections endpoint of Stocks allows retrieval of certain groups of companies, organized by:

Use get_collections to access.

iexfinance.stocks.get_collections(collection_name, collection_type='tag', **kwargs)

Collections

Returns an array of quote objects for a given collection type. Currently supported collection types are sector, tag, and list

Note

Proper capitalization must be used with sector names. For instance, “Technology” must be capitalized or no results will be returned.

Reference: https://iexcloud.io/docs/api/#collections

Data Weighting: Weight of /stock/quote per method

Parameters

  • collection_name (str) – Desired collection name

  • collection_type (str, default "tag", optional) – Desired collection type (sector, tag, or list) kwargs: Additional Request Parameters (see base class)

Examples

Tag

from iexfinance.stocks import get_collections

get_collections("Computer Hardware", output_format='pandas').head()

Sector

get_collections("Industrials", output_format='pandas').head()

Earnings Today

Warning

Beginning December 1, 2020, use of this endpoint will require additional entitlements. Full details can be found in the IEX Cloud Help Center. See here for additional information.

Warning

get_todays_earnings has been deprecated and renamed get_earnings_today.

Earnings Today was added to the Stocks endpoints in 2018. Access is provided through the get_earnings_today function.

iexfinance.stocks.get_earnings_today(**kwargs)

Earnings Today

Returns earnings that will be reported today as two arrays: before the open bto and after market close amc. Each array contains an object with all keys from earnings, a quote object, and a headline key.

Note

Pandas output formatting is not available for this endpoint.

Reference: https://iexcloud.io/docs/api/#earnings-today

Data Weighting: 1051 per symbol returned

Note

get_earnings_today supports JSON output formatting only.

Examples

In [1]: from iexfinance.stocks import get_earnings_today

In [2]: get_earnings_today()["bto"]
Out[2]: []

IPO Calendar

IPO Calendar was added to the Stocks endpoints in 2018. Access is provided through the get_ipo_calendar function.

iexfinance.stocks.get_ipo_calendar(period=None, **kwargs)

IPO Calendar

This returns a list of upcoming or today IPOs scheduled for the current and next month. The response is split into two structures: rawData and viewData. rawData represents all available data for an IPO. viewData represents data structured for display to a user.

Note

Pandas output formatting is not available for this endpoint.

Reference: https://iexcloud.io/docs/api/#ipo-calendar

Data Weighting: 100 per IPO returned for upcoming-ipos, 500 returned for today-ipos

Parameters

period (str, default "upcoming-ipos", optional) – Desired period (options are “upcoming-ipos” and “today-ipos”)

There are two possible values for the period parameter, of which upcoming-ipos is the default. today-ipos is also available.

Examples

from iexfinance.stocks import get_ipo_calendar

get_ipo_calendar()

List

See also

Market Movers

Market Volume (U.S)

Market Volume returns real-time traded volume on U.S. Markets. Access is provided through the get_market_volume function.

iexfinance.stocks.get_market_volume(**kwargs)

Market Volume

This endpoint returns real time traded volume on U.S. markets.

Data Weighting: 1 per call

Warning

Data only available from 7:45am-5:15pm ET Mon-Fri.

Examples

from iexfinance.stocks import get_market_volume

get_market_volume()

Sector Performance

Sector Performance was added to the Stocks endpoints in 2018. Access to this endpoint is provided through the get_sector_performance function.

iexfinance.stocks.get_sector_performance(**kwargs)

Sector Performance

This returns an array of each sector and performance for the current trading day. Performance is based on each sector ETF.

Reference: https://iexcloud.io/docs/api/#sector-performance

Data Weighting: 1 per sector

Returns

data – List of dictionary sector performance items

Return type

list