Client

class pyEX.Client(api_token=None, version='v1', api_limit=5)[source]

IEX Cloud Client

Client has access to all methods provided as standalone, but in an authenticated way

Parameters:
  • api_token (str) – api token (can pickup from IEX_TOKEN environment variable)
  • version (str) – api version to use (defaults to v1) set version to ‘sandbox’ to run against the IEX sandbox
  • api_limit (int) – cache calls in this interval
acos(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Trigonometric ACos for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

ad(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', volumecol='volume')

This will return a dataframe of Chaikin A/D Line for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • volumecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

add(symbol, timeframe='6m', col1='open', col2='close')

This will return a dataframe of Vector Arithmetic Add for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col1 (string) –
  • col2 (string) –
Returns:

result

Return type:

DataFrame

adosc(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', volumecol='volume', fastperiod=3, slowperiod=10)

This will return a dataframe of Chaikin A/D Oscillator for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • volumecol (string) – column to use to calculate
  • fastperiod (int) – fast period to calculate across
  • slowperiod (int) – slow period to calculate across
Returns:

result

Return type:

DataFrame

advancedStats(token='', version='stable', filter='', format='json')

Returns everything in key stats plus additional advanced stats such as EBITDA, ratios, key financial data, and more.

https://iexcloud.io/docs/api/#advanced-stats 4am, 5am ET

Parameters:
Returns:

result

Return type:

dict or DataFrame

advancedStatsDF(token='', version='stable', filter='', format='json')

Returns everything in key stats plus additional advanced stats such as EBITDA, ratios, key financial data, and more.

https://iexcloud.io/docs/api/#advanced-stats 4am, 5am ET

Parameters:
Returns:

result

Return type:

dict or DataFrame

adx(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', period=14)

This will return a dataframe of average directional movement index for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate adx across
Returns:

result

Return type:

DataFrame

adxr(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', period=14)

This will return a dataframe of average directional movement index rating for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

analystRecommendations(token='', version='stable', filter='', format='json')

Pulls data from the last four months.

https://iexcloud.io/docs/api/#analyst-recommendations Updates at 9am, 11am, 12pm UTC every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

analystRecommendationsDF(token='', version='stable', filter='', format='json')

Pulls data from the last four months.

https://iexcloud.io/docs/api/#analyst-recommendations Updates at 9am, 11am, 12pm UTC every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

apo(symbol, timeframe='6m', col='close', fastperiod=12, slowperiod=26, matype=0)

This will return a dataframe of Absolute Price Oscillator for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • fastperiod (int) – fast period to calculate across
  • slowperiod (int) – slow period to calculate across
  • matype (int) – moving average type (0-sma)
Returns:

result

Return type:

DataFrame

aroon(symbol, timeframe='6m', highcol='high', lowcol='low', period=14)

This will return a dataframe of Aroon for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

aroonosc(symbol, timeframe='6m', highcol='high', lowcol='low', period=14)

This will return a dataframe of Aroon Oscillator for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

asin(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Trigonometric ASin for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

atan(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Trigonometric ATan for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

atr(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', period=14)

This will return a dataframe of average true range for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period (int) – time period to calculate over
Returns:

result

Return type:

DataFrame

avgprice(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of average price for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

balanceSheet(period='quarter', last=1, token='', version='stable', filter='', format='json')

Pulls balance sheet data. Available quarterly (4 quarters) and annually (4 years)

https://iexcloud.io/docs/api/#balance-sheet Updates at 8am, 9am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • last (int) – Number of records to fetch, up to 12 for ‘quarter’ and 4 for ‘annual’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

balanceSheetDF(period='quarter', last=1, token='', version='stable', filter='', format='json')

Pulls balance sheet data. Available quarterly (4 quarters) and annually (4 years)

https://iexcloud.io/docs/api/#balance-sheet Updates at 8am, 9am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • last (int) – Number of records to fetch, up to 12 for ‘quarter’ and 4 for ‘annual’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

batch(fields=None, range_='1m', last=10, token='', version='stable', filter='', format='json')

Batch several data requests into one invocation. If no fields passed in, will default to quote

https://iexcloud.io/docs/api/#batch-requests

Parameters:
  • symbols (str or list) – List of tickers to request
  • fields (str or list) – List of fields to request
  • range (str) – Date range for chart
  • last (int) –
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

results in json

Return type:

dict

batchDF(fields=None, range_='1m', last=10, token='', version='stable', filter='', format='json')

Batch several data requests into one invocation

https://iexcloud.io/docs/api/#batch-requests

Parameters:
  • symbols (list) – List of tickers to request
  • fields (list) – List of fields to request
  • range (str) – Date range for chart
  • last (int) –
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

results in json

Return type:

DataFrame

beta(symbol, timeframe='6m', highcol='high', lowcol='low', period=14)

This will return a dataframe of beta for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • period (int) – period to calculate adx across
Returns:

result

Return type:

DataFrame

bollinger(symbol, timeframe='6m', col='close', period=2)

This will return a dataframe of bollinger bands for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

bonusIssue(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Bonus Issue Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#bonus-issue

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

bonusIssueDF(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Bonus Issue Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#bonus-issue

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

book(token='', version='stable', filter='', format='json')

Book data

https://iextrading.com/developer/docs/#book realtime during Investors Exchange market hours

Parameters:
Returns:

result

Return type:

dict or DataFrame

bookDF(token='', version='stable', filter='', format='json')

Book data

https://iextrading.com/developer/docs/#book realtime during Investors Exchange market hours

Parameters:
Returns:

result

Return type:

dict or DataFrame

bop(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', volumecol='volume')

This will return a dataframe of Balance of power for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • volumecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

brent = functools.partial(<function Client.bind>, meth=<function points>, key='DCOILBRENTEU')
bulkBatch(fields=None, range_='1m', last=10, token='', version='stable', filter='', format='json')

Optimized batch to fetch as much as possible at once

https://iexcloud.io/docs/api/#batch-requests

Parameters:
  • symbols (list) – List of tickers to request
  • fields (list) – List of fields to request
  • range (str) – Date range for chart
  • last (int) –
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

results in json

Return type:

dict

bulkBatchDF(fields=None, range_='1m', last=10, token='', version='stable', filter='', format='json')

Optimized batch to fetch as much as possible at once

https://iexcloud.io/docs/api/#batch-requests

Parameters:
  • symbols (list) – List of tickers to request
  • fields (list) – List of fields to request
  • range (str) – Date range for chart
  • last (int) –
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

results in json

Return type:

DataFrame

bulkMinuteBars(dates, token='', version='stable', filter='', format='json')

fetch many dates worth of minute-bars for a given symbol

bulkMinuteBarsDF(dates, token='', version='stable', filter='', format='json')

fetch many dates worth of minute-bars for a given symbol

calendar(direction='next', last=1, startDate=None, token='', version='stable', filter='', format='json')

This call allows you to fetch a number of trade dates or holidays from a given date. For example, if you want the next trading day, you would call /ref-data/us/dates/trade/next/1.

https://iexcloud.io/docs/api/#u-s-exchanges 8am, 9am, 12pm, 1pm UTC daily

Parameters:
  • type (str) – “holiday” or “trade”
  • direction (str) – “next” or “last”
  • last (int) – number to move in direction
  • startDate (date) – start date for next or last, YYYYMMDD
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

calendarDF(direction='next', last=1, startDate=None, token='', version='stable', filter='', format='json')

This call allows you to fetch a number of trade dates or holidays from a given date. For example, if you want the next trading day, you would call /ref-data/us/dates/trade/next/1.

https://iexcloud.io/docs/api/#u-s-exchanges 8am, 9am, 12pm, 1pm UTC daily

Parameters:
  • type (str) – “holiday” or “trade”
  • direction (str) – “next” or “last”
  • last (int) – number to move in direction
  • startDate (date) – start date for next or last, YYYYMMDD
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

cashFlow(period='quarter', last=1, token='', version='stable', filter='', format='json')

Pulls cash flow data. Available quarterly (4 quarters) or annually (4 years).

https://iexcloud.io/docs/api/#cash-flow Updates at 8am, 9am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • last (int) – Number of records to fetch, up to 12 for ‘quarter’ and 4 for ‘annual’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

cashFlowDF(period='quarter', last=1, token='', version='stable', filter='', format='json')

Pulls cash flow data. Available quarterly (4 quarters) or annually (4 years).

https://iexcloud.io/docs/api/#cash-flow Updates at 8am, 9am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • last (int) – Number of records to fetch, up to 12 for ‘quarter’ and 4 for ‘annual’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

cci(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', period=14)

This will return a dataframe of Commodity Channel Index for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

cdj = functools.partial(<function Client.bind>, meth=<function points>, key='MMNRJD')
cdl2crows(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of Two crows for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdl3blackcrows(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of 3 black crows for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdl3inside(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of 3 inside up/down for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdl3linestrike(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of 3 line strike for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdl3outside(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of 3 outside for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdl3starsinsouth(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of 3 stars in south for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdl3whitesoldiers(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of 3 white soldiers for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlabandonedbaby(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of abandoned baby for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdladvanceblock(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of advance block for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlbelthold(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of belt hold for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlbreakaway(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of breakaway for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlclosingmarubozu(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of closing maru bozu for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlconcealbabyswallow(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of conceal baby swallow for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlcounterattack(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of counterattack for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdldarkcloudcover(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close', penetration=0)

This will return a dataframe of dark cloud cover for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • penetration (int) – penetration
Returns:

result

Return type:

DataFrame

cdldoji(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of doji for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdldojistar(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of doji star for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdldragonflydoji(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of dragonfly doji for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlengulfing(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of engulfing for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdleveningdojistar(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close', penetration=0)

This will return a dataframe of evening doji star for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • penetration (int) – penetration
Returns:

result

Return type:

DataFrame

cdleveningstar(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close', penetration=0)

This will return a dataframe of evening star for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • penetration (int) – penetration
Returns:

result

Return type:

DataFrame

cdlgapsidesidewhite(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of up.down-gap side-by-side white lines for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlgravestonedoji(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of gravestone doji for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlhammer(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of hammer for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlhangingman(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of hanging man for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlharami(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of harami for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlharamicross(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of harami cross for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlhighwave(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of high-wave candle for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlhikkake(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of hikkake pattern for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlhikkakemod(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of modified hikkake pattern for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlhomingpigeon(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of homing pigeon for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlidentical3crows(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of identical three crows for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlinneck(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of in-neck pattern for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlinvertedhammer(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of inverted hammer for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlkicking(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of kicking for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlkickingbylength(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of kicking bull/bear determing by the longer marubozu for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlladderbottom(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of ladder bottom for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdllongleggeddoji(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of long legged doji for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdllongline(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of long line candle for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlmarubozu(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of marubozu for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlmatchinglow(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of matching low for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlmathold(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close', penetration=0)

This will return a dataframe of mat hold for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • penetration (int) – penetration
Returns:

result

Return type:

DataFrame

cdlmorningdojistar(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close', penetration=0)

This will return a dataframe of morning doji star for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • penetration (int) – penetration
Returns:

result

Return type:

DataFrame

cdlmorningstar(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close', penetration=0)

This will return a dataframe of morning star for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • penetration (int) – penetration
Returns:

result

Return type:

DataFrame

cdlonneck(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of on-neck pattern for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlpiercing(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of piercing pattern for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlrickshawman(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of rickshaw man for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlrisefall3methods(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of rising/falling three methods for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlseparatinglines(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of separating lines for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlshootingstar(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of shooting star for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlshortline(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of short line candle for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlspinningtop(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of spinning top for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlstalledpattern(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of stalled pattern for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlsticksandwich(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of stick sandwich for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdltakuri(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of takuri dragonfly doji with very long lower shadow for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdltasukigap(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of tasuki gap for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlthrusting(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of thrusting pattern for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdltristar(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of tristar pattern for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlunique3river(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of unique 3 river for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdlxsidegap3methods(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of upside/downside gap three methods for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • opencol (string) – column to use to calculate
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

cdnj = functools.partial(<function Client.bind>, meth=<function points>, key='MMNRNJ')
ceil(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Ceil for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

ceoCompensation(token='', version='stable', filter='', format='json')

This endpoint provides CEO compensation for a company by symbol.

https://iexcloud.io/docs/api/#ceo-compensation 1am daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

ceoCompensationDF(token='', version='stable', filter='', format='json')

This endpoint provides CEO compensation for a company by symbol.

https://iexcloud.io/docs/api/#ceo-compensation 1am daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

chart(timeframe='1m', date=None, exactDate=None, last=-1, closeOnly=False, byDay=False, simplify=False, interval=-1, changeFromClose=False, displayPercent=False, sort='desc', includeToday=False, token='', version='stable', filter='', format='json')

Historical price/volume data, daily and intraday

https://iexcloud.io/docs/api/#historical-prices Data Schedule 1d: -9:30-4pm ET Mon-Fri on regular market trading days

-9:30-1pm ET on early close trading days
All others:
-Prior trading day available after 4am ET Tue-Sat
Parameters:
  • symbol (str) – Ticker to request
  • timeframe (str) – Timeframe to request e.g. 1m
  • date (datetime) – date, if requesting intraday
  • exactDate (str) – Same as date, takes precedence
  • last (int) – If passed, chart data will return the last N elements from the time period defined by the range parameter
  • closeOnly (bool) – Will return adjusted data only with keys date, close, and volume.
  • byDay (bool) – Used only when range is date to return OHLCV data instead of minute bar data.
  • simplify (bool) –
  • interval (int) –
  • changeFromClose (bool) – If true, changeOverTime and marketChangeOverTime will be relative to previous day close instead of the first value.
  • displayPercent (bool) – If set to true, all percentage values will be multiplied by a factor of 100 (Ex: /stock/twtr/chart?displayPercent=true)
  • range (str) – Same format as the path parameter. This can be used for batch calls.
  • sort (str) – Can be “asc” or “desc” to sort results by date. Defaults to “desc”
  • includeToday (bool) – If true, current trading day data is appended
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

chartDF(timeframe='1m', date=None, exactDate=None, last=-1, closeOnly=False, byDay=False, simplify=False, interval=-1, changeFromClose=False, displayPercent=False, sort='desc', includeToday=False, token='', version='stable', filter='', format='json')

Historical price/volume data, daily and intraday

https://iexcloud.io/docs/api/#historical-prices Data Schedule 1d: -9:30-4pm ET Mon-Fri on regular market trading days

-9:30-1pm ET on early close trading days
All others:
-Prior trading day available after 4am ET Tue-Sat
Parameters:
  • symbol (str) – Ticker to request
  • timeframe (str) – Timeframe to request e.g. 1m
  • date (datetime) – date, if requesting intraday
  • exactDate (str) – Same as date, takes precedence
  • last (int) – If passed, chart data will return the last N elements from the time period defined by the range parameter
  • closeOnly (bool) – Will return adjusted data only with keys date, close, and volume.
  • byDay (bool) – Used only when range is date to return OHLCV data instead of minute bar data.
  • simplify (bool) –
  • interval (int) –
  • changeFromClose (bool) – If true, changeOverTime and marketChangeOverTime will be relative to previous day close instead of the first value.
  • displayPercent (bool) – If set to true, all percentage values will be multiplied by a factor of 100 (Ex: /stock/twtr/chart?displayPercent=true)
  • range (str) – Same format as the path parameter. This can be used for batch calls.
  • sort (str) – Can be “asc” or “desc” to sort results by date. Defaults to “desc”
  • includeToday (bool) – If true, current trading day data is appended
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

cmo(symbol, timeframe='6m', col='close', period=14)

This will return a dataframe of Chande Momentum Oscillator for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

collections(collectionName, token='', version='stable', filter='', format='json')

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

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

Parameters:
  • tag (str) – Sector, Tag, or List
  • collectionName (str) – Associated name for tag
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

collectionsDF(collectionName, token='', version='stable', filter='', format='json')

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

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

Parameters:
  • tag (str) – Sector, Tag, or List
  • collectionName (str) – Associated name for tag
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

company(token='', version='stable', filter='', format='json')

Company reference data

https://iexcloud.io/docs/api/#company Updates at 4am and 5am UTC every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

companyDF(token='', version='stable', filter='', format='json')

Company reference data

https://iexcloud.io/docs/api/#company Updates at 4am and 5am UTC every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

convertFX(amount=None, token='', version='stable', filter='', format='json')

This endpoint performs a conversion from one currency to another for a supplied amount of the base currency. If an amount isn’t provided, the latest exchange rate will be provided and the amount will be null.

https://iexcloud.io/docs/api/#currency-conversion 5pm Sun-4pm Fri UTC

Parameters:
  • symbols (str) – comma seperated list of symbols
  • amount (float) – amount to convert
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

convertFXDF(amount=None, token='', version='stable', filter='', format='json')

This endpoint performs a conversion from one currency to another for a supplied amount of the base currency. If an amount isn’t provided, the latest exchange rate will be provided and the amount will be null.

https://iexcloud.io/docs/api/#currency-conversion 5pm Sun-4pm Fri UTC

Parameters:
  • symbols (str) – comma seperated list of symbols
  • amount (float) – amount to convert
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

corporateActions(token='', version='stable', filter='', format='json')
Parameters:
Returns:

result

Return type:

dict or DataFrame

Deprecated since version Deprecated:: IEX Cloud status unkown

corporateActionsDF(token='', version='stable', filter='', format='json')
Parameters:
Returns:

result

Return type:

dict or DataFrame

Deprecated since version Deprecated:: IEX Cloud status unkown

correl(symbol, timeframe='6m', highcol='high', lowcol='low', period=14)

This will return a dataframe of Pearson’s Correlation Coefficient(r) for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • period (int) – period to calculate adx across
Returns:

result

Return type:

DataFrame

cos(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Trigonometric Cos for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

cosh(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Trigonometric Cosh for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

cpi = functools.partial(<function Client.bind>, meth=<function points>, key='CPIAUCSL')
createRule(ruleName, ruleSet, type='any', existingId=None, token='', version='stable', format='json')

This endpoint is used to both create and edit rules. Note that rules run be default after being created.

Parameters:
  • rule (Rule or dict) – rule object to create
  • ruleName (str) – name for rule
  • ruleSet (str) – Valid US symbol or the string ANYEVENT. If the string ANYEVENT is passed, the rule will be triggered for any symbol in the system. The cool down period for alerts (frequency) is applied on a per symbol basis.
  • type (str) – Specify either any, where if any condition is true you get an alert, or all, where all conditions must be true to trigger an alert. any is the default value
  • existingId (Optional[str]) – The id of an existing rule only if you are editing the existing rule
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
creditcard = functools.partial(<function Client.bind>, meth=<function points>, key='TERMCBCCALLNS')
cryptoBook(token='', version='stable', filter='', format='json')

This returns a current snapshot of the book for a specified cryptocurrency. For REST, you will receive a current snapshot of the current book for the specific cryptocurrency. For SSE Streaming, you will get a full representation of the book updated as often as the book changes. Examples of each are below:

https://iexcloud.io/docs/api/#cryptocurrency-book continuous

Parameters:
Returns:

result

Return type:

dict or DataFrame

cryptoBookDF(token='', version='stable', filter='', format='json')

This returns a current snapshot of the book for a specified cryptocurrency. For REST, you will receive a current snapshot of the current book for the specific cryptocurrency. For SSE Streaming, you will get a full representation of the book updated as often as the book changes. Examples of each are below:

https://iexcloud.io/docs/api/#cryptocurrency-book continuous

Parameters:
Returns:

result

Return type:

dict or DataFrame

cryptoBookSSE(on_data=None, exit=None, token='', version='stable')

This returns a current snapshot of the book for a specified cryptocurrency. For REST, you will receive a current snapshot of the current book for the specific cryptocurrency. For SSE Streaming, you will get a full representation of the book updated as often as the book changes. Examples of each are below:

https://iexcloud.io/docs/api/#cryptocurrency-book

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
cryptoBookSSEAsync(exit=None, token='', version='stable')

This returns a current snapshot of the book for a specified cryptocurrency. For REST, you will receive a current snapshot of the current book for the specific cryptocurrency. For SSE Streaming, you will get a full representation of the book updated as often as the book changes. Examples of each are below:

https://iexcloud.io/docs/api/#cryptocurrency-book

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
cryptoEventsSSE(on_data=None, exit=None, token='', version='stable')

This returns a streaming list of event updates such as new and canceled orders.

https://iexcloud.io/docs/api/#cryptocurrency-events

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
cryptoEventsSSEAsync(exit=None, token='', version='stable')

This returns a streaming list of event updates such as new and canceled orders.

https://iexcloud.io/docs/api/#cryptocurrency-events

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
cryptoPrice(token='', version='stable', filter='', format='json')

This returns the price for a specified cryptocurrency.

https://iexcloud.io/docs/api/#cryptocurrency-price continuous

Parameters:
Returns:

result

Return type:

dict or DataFrame

cryptoPriceDF(token='', version='stable', filter='', format='json')

This returns the price for a specified cryptocurrency.

https://iexcloud.io/docs/api/#cryptocurrency-price continuous

Parameters:
Returns:

result

Return type:

dict or DataFrame

cryptoQuote(token='', version='stable', filter='', format='json')

This returns the quote for a specified cryptocurrency. Quotes are available via REST and SSE Streaming.

https://iexcloud.io/docs/api/#cryptocurrency-quote continuous

Parameters:
Returns:

result

Return type:

dict or DataFrame

cryptoQuoteDF(token='', version='stable', filter='', format='json')

This returns the quote for a specified cryptocurrency. Quotes are available via REST and SSE Streaming.

https://iexcloud.io/docs/api/#cryptocurrency-quote continuous

Parameters:
Returns:

result

Return type:

dict or DataFrame

cryptoQuotesSSE(on_data=None, exit=None, token='', version='stable')

This returns the quote for a specified cryptocurrency. Quotes are available via REST and SSE Streaming.

https://iexcloud.io/docs/api/#cryptocurrency-quote

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
cryptoQuotesSSEAsync(exit=None, token='', version='stable')

This returns the quote for a specified cryptocurrency. Quotes are available via REST and SSE Streaming.

https://iexcloud.io/docs/api/#cryptocurrency-quote

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
cryptoSymbols(version='stable', filter='', format='json')

This provides a full list of supported cryptocurrencies by IEX Cloud.

https://iexcloud.io/docs/api/#cryptocurrency-symbols 8am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

cryptoSymbolsDF(version='stable', filter='', format='json')

This provides a full list of supported cryptocurrencies by IEX Cloud.

https://iexcloud.io/docs/api/#cryptocurrency-symbols 8am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

cryptoSymbolsList(version='stable', filter='', format='json')

This provides a full list of supported cryptocurrencies by IEX Cloud.

https://iexcloud.io/docs/api/#cryptocurrency-symbols 8am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

daily(last='', token='', version='stable', filter='', format='json')

https://iexcloud.io/docs/api/#stats-historical-daily

Parameters:
  • date (Optional[str]) – Format YYYYMMDD date to fetch sentiment data. Default is today.
  • last (Optional[int]) – Optional last number to include
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

dailyDF(last='', token='', version='stable', filter='', format='json')

https://iexcloud.io/docs/api/#stats-historical-daily

Parameters:
  • date (Optional[str]) – Format YYYYMMDD date to fetch sentiment data. Default is today.
  • last (Optional[int]) – Optional last number to include
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

dailyReturns(symbol, timeframe='6m')

Calculate returns of buying at open and selling at close daily

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
Returns:

result

Return type:

DataFrame

deepSSE(channels=None, on_data=None, exit=None, token='', version='stable')

DEEP is used to receive real-time depth of book quotations direct from IEX. The depth of book quotations received via DEEP provide an aggregated size of resting displayed orders at a price and side, and do not indicate the size or number of individual orders at any price level. Non-displayed orders and non-displayed portions of reserve orders are not represented in DEEP.

DEEP also provides last trade price and size information. Trades resulting from either displayed or non-displayed orders matching on IEX will be reported. Routed executions will not be reported.

https://iexcloud.io/docs/api/#deep

Parameters:
  • symbols (str) – Tickers to request
  • channels (List[str]) – Deep channels to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
deepSSEAsync(channels=None, exit=None, token='', version='stable')

DEEP is used to receive real-time depth of book quotations direct from IEX. The depth of book quotations received via DEEP provide an aggregated size of resting displayed orders at a price and side, and do not indicate the size or number of individual orders at any price level. Non-displayed orders and non-displayed portions of reserve orders are not represented in DEEP.

DEEP also provides last trade price and size information. Trades resulting from either displayed or non-displayed orders matching on IEX will be reported. Routed executions will not be reported.

https://iexcloud.io/docs/api/#deep

Parameters:
  • symbols (str) – Tickers to request
  • channels (List[str]) – Deep channels to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
delayedQuote(token='', version='stable', filter='', format='json')

This returns the 15 minute delayed market quote.

https://iexcloud.io/docs/api/#delayed-quote 15min delayed 4:30am - 8pm ET M-F when market is open

Parameters:
Returns:

result

Return type:

dict or DataFrame

delayedQuoteDF(token='', version='stable', filter='', format='json')

This returns the 15 minute delayed market quote.

https://iexcloud.io/docs/api/#delayed-quote 15min delayed 4:30am - 8pm ET M-F when market is open

Parameters:
Returns:

result

Return type:

dict or DataFrame

deleteRule(token='', version='stable', format='json')

You can delete a rule by using an __HTTP DELETE__ request. This will stop rule executions and delete the rule from your dashboard. If you only want to temporarily stop a rule, use the pause/resume functionality instead.

Parameters:
  • ruleId (str) – The id of an existing rule to puase
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
dema(symbol, timeframe='6m', col='close', periods=None)
This will return a dataframe of double exponential moving average
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • periods (int) –
Returns:

result

Return type:

DataFrame

diesel = functools.partial(<function Client.bind>, meth=<function points>, key='GASDESW')
directory(token='', version='stable', filter='', format='json')
Parameters:
Returns:

result

Return type:

dict or DataFrame

Deprecated since version Deprecated:: IEX Cloud status unkown

directoryDF(token='', version='stable', filter='', format='json')
Parameters:
Returns:

result

Return type:

dict or DataFrame

Deprecated since version Deprecated:: IEX Cloud status unkown

distribution(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Distribution Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#distribution

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

distributionDF(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Distribution Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#distribution

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

div(symbol, timeframe='6m', col1='open', col2='close')

This will return a dataframe of Vector Arithmetic Div for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col1 (string) –
  • col2 (string) –
Returns:

result

Return type:

DataFrame

dividends(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Obtain up-to-date and detailed information on all new dividend announcements, as well as 12+ years of historical dividend records. This endpoint covers over 39,000 US equities, mutual funds, ADRs, and ETFs. You’ll be provided with:

Detailed information on both cash and stock dividends including record, payment, ex, and announce dates Gross and net amounts Details of all currencies in which a dividend can be paid Tax information The ability to keep up with the growing number of complex dividend distributions

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#dividends

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

dividendsBasic(timeframe='ytd', token='', version='stable', filter='', format='json')

Dividend history

https://iexcloud.io/docs/api/#dividends Updated at 9am UTC every day

Parameters:
  • symbol (str) – Ticker to request
  • timeframe (str) – timeframe for data
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

dividendsBasicDF(timeframe='ytd', token='', version='stable', filter='', format='json')

Dividend history

https://iexcloud.io/docs/api/#dividends Updated at 9am UTC every day

Parameters:
  • symbol (str) – Ticker to request
  • timeframe (str) – timeframe for data
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

dividendsDF(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Obtain up-to-date and detailed information on all new dividend announcements, as well as 12+ years of historical dividend records. This endpoint covers over 39,000 US equities, mutual funds, ADRs, and ETFs. You’ll be provided with:

Detailed information on both cash and stock dividends including record, payment, ex, and announce dates Gross and net amounts Details of all currencies in which a dividend can be paid Tax information The ability to keep up with the growing number of complex dividend distributions

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#dividends

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

dx(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', period=14)

This will return a dataframe of Directional Movement Index for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

earnings(period='quarter', last=1, field='', token='', version='stable', filter='', format='json')

Earnings data for a given company including the actual EPS, consensus, and fiscal period. Earnings are available quarterly (last 4 quarters) and annually (last 4 years).

https://iexcloud.io/docs/api/#earnings Updates at 9am, 11am, 12pm UTC every day

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • last (int) – Number of records to fetch, up to 12 for ‘quarter’ and 4 for ‘annual’
  • field (str) – Subfield to fetch
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

earningsDF(period='quarter', last=1, field='', token='', version='stable', filter='', format='json')

Earnings data for a given company including the actual EPS, consensus, and fiscal period. Earnings are available quarterly (last 4 quarters) and annually (last 4 years).

https://iexcloud.io/docs/api/#earnings Updates at 9am, 11am, 12pm UTC every day

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • last (int) – Number of records to fetch, up to 12 for ‘quarter’ and 4 for ‘annual’
  • field (str) – Subfield to fetch
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

earningsToday(version='stable', filter='', format='json')

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.

https://iexcloud.io/docs/api/#earnings-today Updates at 9am, 11am, 12pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

earningsTodayDF(version='stable', filter='', format='json')

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.

https://iexcloud.io/docs/api/#earnings-today Updates at 9am, 11am, 12pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

ema(symbol, timeframe='6m', col='close', periods=None)
This will return a dataframe of exponential moving average
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • periods (int) –
Returns:

result

Return type:

DataFrame

estimates(period='quarter', last=1, token='', version='stable', filter='', format='json')

Provides the latest consensus estimate for the next fiscal period

https://iexcloud.io/docs/api/#estimates Updates at 9am, 11am, 12pm UTC every day

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • last (int) – Number of records to fetch, up to 12 for ‘quarter’ and 4 for ‘annual’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

estimatesDF(period='quarter', last=1, token='', version='stable', filter='', format='json')

Provides the latest consensus estimate for the next fiscal period

https://iexcloud.io/docs/api/#estimates Updates at 9am, 11am, 12pm UTC every day

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • last (int) – Number of records to fetch, up to 12 for ‘quarter’ and 4 for ‘annual’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

exchanges(version='stable', filter='', format='json')

Returns an array of U.S. exchanges.

https://iexcloud.io/docs/api/#u-s-exchanges 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

exchangesDF(version='stable', filter='', format='json')

Returns an array of U.S. exchanges.

https://iexcloud.io/docs/api/#u-s-exchanges 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

exp(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Arithmetic Exp for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

fedfunds = functools.partial(<function Client.bind>, meth=<function points>, key='FEDFUNDS')
figi(token='', version='stable', format='json')

Helper call to convert FIGI to IEX Cloud symbols. Note that due to licensing restrictions we are unable to return the FIGI.

https://iexcloud.io/docs/api/#figi-mapping

Parameters:
  • figi (str) – figi to lookup
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

figiDF(token='', version='stable', format='json')

Helper call to convert FIGI to IEX Cloud symbols. Note that due to licensing restrictions we are unable to return the FIGI.

https://iexcloud.io/docs/api/#figi-mapping

Parameters:
  • figi (str) – figi to lookup
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

financials(period='quarter', token='', version='stable', filter='', format='json')

Pulls income statement, balance sheet, and cash flow data from the four most recent reported quarters.

https://iexcloud.io/docs/api/#financials Updates at 8am, 9am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

financialsDF(period='quarter', token='', version='stable', filter='', format='json')

Pulls income statement, balance sheet, and cash flow data from the four most recent reported quarters.

https://iexcloud.io/docs/api/#financials Updates at 8am, 9am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

fiveYear = functools.partial(<function Client.bind>, meth=<function points>, key='DGS5')
floor(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Floor for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

forex1MinuteSSE(on_data=None, exit=None, token='', version='stable', name='forex')

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
forex1MinuteSSEAsync(exit=None, token='', version='stable', name='forex')

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
forex1SecondSSE(on_data=None, exit=None, token='', version='stable', name='forex')

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
forex1SecondSSEAsync(exit=None, token='', version='stable', name='forex')

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
forex5SecondSSE(on_data=None, exit=None, token='', version='stable', name='forex')

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
forex5SecondSSEAsync(exit=None, token='', version='stable', name='forex')

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
fundOwnership(token='', version='stable', filter='', format='json')
Returns the top 10 fund holders, meaning any firm not defined as buy-side or sell-side such as mutual funds,
pension funds, endowments, investment firms, and other large entities that manage funds on behalf of others.

https://iexcloud.io/docs/api/#fund-ownership Updates at 5am, 6am ET every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

fundOwnershipDF(token='', version='stable', filter='', format='json')
Returns the top 10 fund holders, meaning any firm not defined as buy-side or sell-side such as mutual funds,
pension funds, endowments, investment firms, and other large entities that manage funds on behalf of others.

https://iexcloud.io/docs/api/#fund-ownership Updates at 5am, 6am ET every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

fundamentals(period='quarter', token='', version='stable', filter='', format='json')

Pulls fundamentals data.

https://iexcloud.io/docs/api/#advanced-fundamentals Updates at 8am, 9am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

fundamentalsDF(period='quarter', token='', version='stable', filter='', format='json')

Pulls fundamentals data.

https://iexcloud.io/docs/api/#advanced-fundamentals Updates at 8am, 9am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

fxSSE(on_data=None, exit=None, token='', version='stable', name='forex')

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
fxSSEAsync(exit=None, token='', version='stable', name='forex')

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
fxSymbols(version='stable', filter='', format='json')

This call returns a list of supported currencies and currency pairs.

https://iexcloud.io/docs/api/#fx-symbols 7am, 9am, UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

fxSymbolsDF(version='stable', filter='', format='json')

This call returns a list of supported currencies and currency pairs.

https://iexcloud.io/docs/api/#fx-symbols 7am, 9am, UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

fxSymbolsList(version='stable', filter='', format='json')

This call returns a list of supported currencies and currency pairs.

https://iexcloud.io/docs/api/#fx-symbols 7am, 9am, UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

gasmid = functools.partial(<function Client.bind>, meth=<function points>, key='GASMIDCOVW')
gasprm = functools.partial(<function Client.bind>, meth=<function points>, key='GASPRMCOVW')
gasreg = functools.partial(<function Client.bind>, meth=<function points>, key='GASREGCOVW')
gdp = functools.partial(<function Client.bind>, meth=<function points>, key='A191RL1Q225SBEA')
heatoil = functools.partial(<function Client.bind>, meth=<function points>, key='DHOILNYH')
historicalFX(from_='', to_='', on='', last=0, first=0, token='', version='stable', filter='', format='json')

This endpoint returns a daily value for the desired currency pair.

https://iexcloud.io/docs/api/#historical-daily 1am Mon-Sat UTC

Parameters:
  • symbols (str) – comma seperated list of symbols
  • from (str or datetime) – Returns data on or after the given from date. Format YYYY-MM-DD
  • to (str or datetime) – Returns data on or before the given to date. Format YYYY-MM-DD
  • on (str or datetime) – Returns data on the given date. Format YYYY-MM-DD
  • last (int) – Returns the latest n number of records in the series
  • first (int) – Returns the first n number of records in the series
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

historicalFXDF(from_='', to_='', on='', last=0, first=0, token='', version='stable', filter='', format='json')

This endpoint returns a daily value for the desired currency pair.

https://iexcloud.io/docs/api/#historical-daily 1am Mon-Sat UTC

Parameters:
  • symbols (str) – comma seperated list of symbols
  • from (str or datetime) – Returns data on or after the given from date. Format YYYY-MM-DD
  • to (str or datetime) – Returns data on or before the given to date. Format YYYY-MM-DD
  • on (str or datetime) – Returns data on the given date. Format YYYY-MM-DD
  • last (int) – Returns the latest n number of records in the series
  • first (int) – Returns the first n number of records in the series
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

holidays(last=1, startDate=None, token='', version='stable', filter='', format='json')

This call allows you to fetch a number of trade dates or holidays from a given date. For example, if you want the next trading day, you would call /ref-data/us/dates/trade/next/1.

https://iexcloud.io/docs/api/#u-s-exchanges 8am, 9am, 12pm, 1pm UTC daily

Parameters:
  • direction (str) – “next” or “last”
  • last (int) – number to move in direction
  • startDate (date) – start date for next or last, YYYYMMDD
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

holidaysDF(last=1, startDate=None, token='', version='stable', filter='', format='json')

This call allows you to fetch a number of trade dates or holidays from a given date. For example, if you want the next trading day, you would call /ref-data/us/dates/trade/next/1.

https://iexcloud.io/docs/api/#u-s-exchanges 8am, 9am, 12pm, 1pm UTC daily

Parameters:
  • direction (str) – “next” or “last”
  • last (int) – number to move in direction
  • startDate (date) – start date for next or last, YYYYMMDD
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

housing = functools.partial(<function Client.bind>, meth=<function points>, key='HOUST')
ht_dcperiod(symbol, timeframe='6m', col='close')

This will return a dataframe of Hilbert Transform - Dominant Cycle Period for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

ht_dcphase(symbol, timeframe='6m', col='close')

This will return a dataframe of Hilbert Transform - Dominant Cycle Phase for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

ht_phasor(symbol, timeframe='6m', col='close')

This will return a dataframe of Hilbert Transform - Phasor Components for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

ht_sine(symbol, timeframe='6m', col='close')

This will return a dataframe of Hilbert Transform - SineWave for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

ht_trendline(symbol, timeframe='6m', col='close')
This will return a dataframe of hilbert trendline
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

ht_trendmode(symbol, timeframe='6m', col='close')

This will return a dataframe of Hilbert Transform - Trend vs Cycle Mode for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

iexAuction(token='', version='stable', format='json')

DEEP broadcasts an Auction Information Message every one second between the Lock-in Time and the auction match for Opening and Closing Auctions, and during the Display Only Period for IPO, Halt, and Volatility Auctions. Only IEX listed securities are eligible for IEX Auctions.

https://iexcloud.io/docs/api/#deep-auction

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexAuctionAsync(token='', version='stable', format='json')

DEEP broadcasts an Auction Information Message every one second between the Lock-in Time and the auction match for Opening and Closing Auctions, and during the Display Only Period for IPO, Halt, and Volatility Auctions. Only IEX listed securities are eligible for IEX Auctions.

https://iexcloud.io/docs/api/#deep-auction

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexAuctionDF(token='', version='stable', format='json')

DEEP broadcasts an Auction Information Message every one second between the Lock-in Time and the auction match for Opening and Closing Auctions, and during the Display Only Period for IPO, Halt, and Volatility Auctions. Only IEX listed securities are eligible for IEX Auctions.

https://iexcloud.io/docs/api/#deep-auction

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexBook(token='', version='stable', format='json')

Book shows IEX’s bids and asks for given symbols.

https://iexcloud.io/docs/api/#deep-book

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexBookAsync(token='', version='stable', format='json')

Book shows IEX’s bids and asks for given symbols.

https://iexcloud.io/docs/api/#deep-book

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexBookDF(token='', version='stable', format='json')

Book shows IEX’s bids and asks for given symbols.

https://iexcloud.io/docs/api/#deep-book

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexDeep(token='', version='stable', format='json')

DEEP is used to receive real-time depth of book quotations direct from IEX. The depth of book quotations received via DEEP provide an aggregated size of resting displayed orders at a price and side, and do not indicate the size or number of individual orders at any price level. Non-displayed orders and non-displayed portions of reserve orders are not represented in DEEP.

DEEP also provides last trade price and size information. Trades resulting from either displayed or non-displayed orders matching on IEX will be reported. Routed executions will not be reported.

https://iexcloud.io/docs/api/#deep

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexDeepAsync(token='', version='stable', format='json')

DEEP is used to receive real-time depth of book quotations direct from IEX. The depth of book quotations received via DEEP provide an aggregated size of resting displayed orders at a price and side, and do not indicate the size or number of individual orders at any price level. Non-displayed orders and non-displayed portions of reserve orders are not represented in DEEP.

DEEP also provides last trade price and size information. Trades resulting from either displayed or non-displayed orders matching on IEX will be reported. Routed executions will not be reported.

https://iexcloud.io/docs/api/#deep

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexDeepDF(token='', version='stable', format='json')

DEEP is used to receive real-time depth of book quotations direct from IEX. The depth of book quotations received via DEEP provide an aggregated size of resting displayed orders at a price and side, and do not indicate the size or number of individual orders at any price level. Non-displayed orders and non-displayed portions of reserve orders are not represented in DEEP.

DEEP also provides last trade price and size information. Trades resulting from either displayed or non-displayed orders matching on IEX will be reported. Routed executions will not be reported.

https://iexcloud.io/docs/api/#deep

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexHist(token='', version='stable', format='json')
Parameters:
  • date (datetime) – Effective date
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexHistAsync(token='', version='stable', format='json')
Parameters:
  • date (datetime) – Effective date
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexHistDF(token='', version='stable', format='json')
Parameters:
  • date (datetime) – Effective date
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexLast(token='', version='stable', format='json')

Last provides trade data for executions on IEX. It is a near real time, intraday API that provides IEX last sale price, size and time. Last is ideal for developers that need a lightweight stock quote.

https://iexcloud.io/docs/api/#last

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexLastAsync(token='', version='stable', format='json')

Last provides trade data for executions on IEX. It is a near real time, intraday API that provides IEX last sale price, size and time. Last is ideal for developers that need a lightweight stock quote.

https://iexcloud.io/docs/api/#last

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexLastDF(token='', version='stable', format='json')

Last provides trade data for executions on IEX. It is a near real time, intraday API that provides IEX last sale price, size and time. Last is ideal for developers that need a lightweight stock quote.

https://iexcloud.io/docs/api/#last

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexOfficialPrice(token='', version='stable', format='json')

The Official Price message is used to disseminate the IEX Official Opening and Closing Prices.

These messages will be provided only for IEX Listed Securities.

https://iexcloud.io/docs/api/#deep-official-price

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexOfficialPriceAsync(token='', version='stable', format='json')

The Official Price message is used to disseminate the IEX Official Opening and Closing Prices.

These messages will be provided only for IEX Listed Securities.

https://iexcloud.io/docs/api/#deep-official-price

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexOfficialPriceDF(token='', version='stable', format='json')

The Official Price message is used to disseminate the IEX Official Opening and Closing Prices.

These messages will be provided only for IEX Listed Securities.

https://iexcloud.io/docs/api/#deep-official-price

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexOpHaltStatus(token='', version='stable', format='json')

The Exchange may suspend trading of one or more securities on IEX for operational reasons and indicates such operational halt using the Operational halt status message.

IEX disseminates a full pre-market spin of Operational halt status messages indicating the operational halt status of all securities. In the spin, IEX will send out an Operational Halt Message with “N” (Not operationally halted on IEX) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System at the start of the Pre-Market Session.

After the pre-market spin, IEX will use the Operational halt status message to relay changes in operational halt status for an individual security.

https://iexcloud.io/docs/api/#deep-operational-halt-status

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexOpHaltStatusAsync(token='', version='stable', format='json')

The Exchange may suspend trading of one or more securities on IEX for operational reasons and indicates such operational halt using the Operational halt status message.

IEX disseminates a full pre-market spin of Operational halt status messages indicating the operational halt status of all securities. In the spin, IEX will send out an Operational Halt Message with “N” (Not operationally halted on IEX) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System at the start of the Pre-Market Session.

After the pre-market spin, IEX will use the Operational halt status message to relay changes in operational halt status for an individual security.

https://iexcloud.io/docs/api/#deep-operational-halt-status

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexOpHaltStatusDF(token='', version='stable', format='json')

The Exchange may suspend trading of one or more securities on IEX for operational reasons and indicates such operational halt using the Operational halt status message.

IEX disseminates a full pre-market spin of Operational halt status messages indicating the operational halt status of all securities. In the spin, IEX will send out an Operational Halt Message with “N” (Not operationally halted on IEX) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System at the start of the Pre-Market Session.

After the pre-market spin, IEX will use the Operational halt status message to relay changes in operational halt status for an individual security.

https://iexcloud.io/docs/api/#deep-operational-halt-status

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexSecurityEvent(token='', version='stable', format='json')

The Security event message is used to indicate events that apply to a security. A Security event message will be sent whenever such event occurs

https://iexcloud.io/docs/api/#deep-security-event

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexSecurityEventAsync(token='', version='stable', format='json')

The Security event message is used to indicate events that apply to a security. A Security event message will be sent whenever such event occurs

https://iexcloud.io/docs/api/#deep-security-event

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexSecurityEventDF(token='', version='stable', format='json')

The Security event message is used to indicate events that apply to a security. A Security event message will be sent whenever such event occurs

https://iexcloud.io/docs/api/#deep-security-event

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexSsrStatus(token='', version='stable', format='json')

In association with Rule 201 of Regulation SHO, the Short Sale Price Test Message is used to indicate when a short sale price test restriction is in effect for a security.

IEX disseminates a full pre-market spin of Short sale price test status messages indicating the Rule 201 status of all securities.
After the pre-market spin, IEX will use the Short sale price test status message in the event of an intraday status change.

The IEX Trading System will process orders based on the latest short sale price test restriction status.

https://iexcloud.io/docs/api/#deep-short-sale-price-test-status

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexSsrStatusAsync(token='', version='stable', format='json')

In association with Rule 201 of Regulation SHO, the Short Sale Price Test Message is used to indicate when a short sale price test restriction is in effect for a security.

IEX disseminates a full pre-market spin of Short sale price test status messages indicating the Rule 201 status of all securities.
After the pre-market spin, IEX will use the Short sale price test status message in the event of an intraday status change.

The IEX Trading System will process orders based on the latest short sale price test restriction status.

https://iexcloud.io/docs/api/#deep-short-sale-price-test-status

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexSsrStatusDF(token='', version='stable', format='json')

In association with Rule 201 of Regulation SHO, the Short Sale Price Test Message is used to indicate when a short sale price test restriction is in effect for a security.

IEX disseminates a full pre-market spin of Short sale price test status messages indicating the Rule 201 status of all securities.
After the pre-market spin, IEX will use the Short sale price test status message in the event of an intraday status change.

The IEX Trading System will process orders based on the latest short sale price test restriction status.

https://iexcloud.io/docs/api/#deep-short-sale-price-test-status

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexSymbols(version='stable', filter='', format='json')

This call returns an array of symbols the Investors Exchange supports for trading. This list is updated daily as of 7:45 a.m. ET. Symbols may be added or removed by the Investors Exchange after the list was produced.

https://iexcloud.io/docs/api/#iex-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

iexSymbolsDF(version='stable', filter='', format='json')

This call returns an array of symbols the Investors Exchange supports for trading. This list is updated daily as of 7:45 a.m. ET. Symbols may be added or removed by the Investors Exchange after the list was produced.

https://iexcloud.io/docs/api/#iex-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

iexSymbolsList(version='stable', filter='', format='json')

This call returns an array of symbols the Investors Exchange supports for trading. This list is updated daily as of 7:45 a.m. ET. Symbols may be added or removed by the Investors Exchange after the list was produced.

https://iexcloud.io/docs/api/#iex-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

iexSystemEvent(version='stable', format='json')

The System event message is used to indicate events that apply to the market or the data feed.

There will be a single message disseminated per channel for each System Event type within a given trading session.

https://iexcloud.io/docs/api/#deep-system-event

Parameters:
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexSystemEventAsync(version='stable', format='json')

The System event message is used to indicate events that apply to the market or the data feed.

There will be a single message disseminated per channel for each System Event type within a given trading session.

https://iexcloud.io/docs/api/#deep-system-event

Parameters:
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexSystemEventDF(version='stable', format='json')

The System event message is used to indicate events that apply to the market or the data feed.

There will be a single message disseminated per channel for each System Event type within a given trading session.

https://iexcloud.io/docs/api/#deep-system-event

Parameters:
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTops(token='', version='stable', format='json')

TOPS provides IEX’s aggregated best quoted bid and offer position in near real time for all securities on IEX’s displayed limit order book. TOPS is ideal for developers needing both quote and trade data.

https://iexcloud.io/docs/api/#tops

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTopsAsync(token='', version='stable', format='json')

TOPS provides IEX’s aggregated best quoted bid and offer position in near real time for all securities on IEX’s displayed limit order book. TOPS is ideal for developers needing both quote and trade data.

https://iexcloud.io/docs/api/#tops

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTopsDF(token='', version='stable', format='json')

TOPS provides IEX’s aggregated best quoted bid and offer position in near real time for all securities on IEX’s displayed limit order book. TOPS is ideal for developers needing both quote and trade data.

https://iexcloud.io/docs/api/#tops

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTradeBreak(token='', version='stable', format='json')

Trade break messages are sent when an execution on IEX is broken on that same trading day. Trade breaks are rare and only affect applications that rely upon IEX execution based data.

https://iexcloud.io/docs/api/#deep-trade-break

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTradeBreakAsync(token='', version='stable', format='json')

Trade break messages are sent when an execution on IEX is broken on that same trading day. Trade breaks are rare and only affect applications that rely upon IEX execution based data.

https://iexcloud.io/docs/api/#deep-trade-break

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTradeBreakDF(token='', version='stable', format='json')

Trade break messages are sent when an execution on IEX is broken on that same trading day. Trade breaks are rare and only affect applications that rely upon IEX execution based data.

https://iexcloud.io/docs/api/#deep-trade-break

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTrades(token='', version='stable', format='json')

Trade report messages are sent when an order on the IEX Order Book is executed in whole or in part. DEEP sends a Trade report message for every individual fill.

https://iexcloud.io/docs/api/#deep-trades

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTradesAsync(token='', version='stable', format='json')

Trade report messages are sent when an order on the IEX Order Book is executed in whole or in part. DEEP sends a Trade report message for every individual fill.

https://iexcloud.io/docs/api/#deep-trades

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTradesDF(token='', version='stable', format='json')

Trade report messages are sent when an order on the IEX Order Book is executed in whole or in part. DEEP sends a Trade report message for every individual fill.

https://iexcloud.io/docs/api/#deep-trades

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTradingStatus(token='', version='stable', format='json')
The Trading status message is used to indicate the current trading status of a security.
For IEX-listed securities, IEX acts as the primary market and has the authority to institute a trading halt or trading pause in a security due to news dissemination or regulatory reasons. For non-IEX-listed securities, IEX abides by any regulatory trading halts and trading pauses instituted by the primary or listing market, as applicable.
IEX disseminates a full pre-market spin of Trading status messages indicating the trading status of all securities.
In the spin, IEX will send out a Trading status message with “T” (Trading) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System.

After the pre-market spin, IEX will use the Trading status message to relay changes in trading status for an individual security. Messages will be sent when a security is:

Halted Paused* Released into an Order Acceptance Period* Released for trading *The paused and released into an Order Acceptance Period status will be disseminated for IEX-listed securities only. Trading pauses on non-IEX-listed securities will be treated simply as a halt.

https://iexcloud.io/docs/api/#deep-trading-status

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTradingStatusAsync(token='', version='stable', format='json')
The Trading status message is used to indicate the current trading status of a security.
For IEX-listed securities, IEX acts as the primary market and has the authority to institute a trading halt or trading pause in a security due to news dissemination or regulatory reasons. For non-IEX-listed securities, IEX abides by any regulatory trading halts and trading pauses instituted by the primary or listing market, as applicable.
IEX disseminates a full pre-market spin of Trading status messages indicating the trading status of all securities.
In the spin, IEX will send out a Trading status message with “T” (Trading) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System.

After the pre-market spin, IEX will use the Trading status message to relay changes in trading status for an individual security. Messages will be sent when a security is:

Halted Paused* Released into an Order Acceptance Period* Released for trading *The paused and released into an Order Acceptance Period status will be disseminated for IEX-listed securities only. Trading pauses on non-IEX-listed securities will be treated simply as a halt.

https://iexcloud.io/docs/api/#deep-trading-status

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

iexTradingStatusDF(token='', version='stable', format='json')
The Trading status message is used to indicate the current trading status of a security.
For IEX-listed securities, IEX acts as the primary market and has the authority to institute a trading halt or trading pause in a security due to news dissemination or regulatory reasons. For non-IEX-listed securities, IEX abides by any regulatory trading halts and trading pauses instituted by the primary or listing market, as applicable.
IEX disseminates a full pre-market spin of Trading status messages indicating the trading status of all securities.
In the spin, IEX will send out a Trading status message with “T” (Trading) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System.

After the pre-market spin, IEX will use the Trading status message to relay changes in trading status for an individual security. Messages will be sent when a security is:

Halted Paused* Released into an Order Acceptance Period* Released for trading *The paused and released into an Order Acceptance Period status will be disseminated for IEX-listed securities only. Trading pauses on non-IEX-listed securities will be treated simply as a halt.

https://iexcloud.io/docs/api/#deep-trading-status

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

incomeStatement(period='quarter', last=1, token='', version='stable', filter='', format='json')

Pulls income statement data. Available quarterly (4 quarters) or annually (4 years).

https://iexcloud.io/docs/api/#income-statement Updates at 8am, 9am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • last (int) – Number of records to fetch, up to 12 for ‘quarter’ and 4 for ‘annual’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

incomeStatementDF(period='quarter', last=1, token='', version='stable', filter='', format='json')

Pulls income statement data. Available quarterly (4 quarters) or annually (4 years).

https://iexcloud.io/docs/api/#income-statement Updates at 8am, 9am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • period (str) – Period, either ‘annual’ or ‘quarter’
  • last (int) – Number of records to fetch, up to 12 for ‘quarter’ and 4 for ‘annual’
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

indpro = functools.partial(<function Client.bind>, meth=<function points>, key='INDPRO')
initialClaims = functools.partial(<function Client.bind>, meth=<function points>, key='IC4WSA')
insiderRoster(token='', version='stable', filter='', format='json')

Returns the top 10 insiders, with the most recent information.

https://iexcloud.io/docs/api/#insider-roster Updates at 5am, 6am ET every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

insiderRosterDF(token='', version='stable', filter='', format='json')

Returns the top 10 insiders, with the most recent information.

https://iexcloud.io/docs/api/#insider-roster Updates at 5am, 6am ET every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

insiderSummary(token='', version='stable', filter='', format='json')

Returns aggregated insiders summary data for the last 6 months.

https://iexcloud.io/docs/api/#insider-summary Updates at 5am, 6am ET every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

insiderSummaryDF(token='', version='stable', filter='', format='json')

Returns aggregated insiders summary data for the last 6 months.

https://iexcloud.io/docs/api/#insider-summary Updates at 5am, 6am ET every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

insiderTransactions(token='', version='stable', filter='', format='json')

Returns insider transactions.

https://iexcloud.io/docs/api/#insider-transactions Updates at UTC every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

insiderTransactionsDF(token='', version='stable', filter='', format='json')

Returns insider transactions.

https://iexcloud.io/docs/api/#insider-transactions Updates at UTC every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

institutionalMoney = functools.partial(<function Client.bind>, meth=<function points>, key='WIMFSL')
institutionalOwnership(token='', version='stable', filter='', format='json')

Returns the top 10 institutional holders, defined as buy-side or sell-side firms.

https://iexcloud.io/docs/api/#institutional-ownership Updates at 5am, 6am ET every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

institutionalOwnershipDF(token='', version='stable', filter='', format='json')

Returns the top 10 institutional holders, defined as buy-side or sell-side firms.

https://iexcloud.io/docs/api/#institutional-ownership Updates at 5am, 6am ET every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

internationalExchanges(version='stable', filter='', format='json')

Returns an array of exchanges.

https://iexcloud.io/docs/api/#international-exchanges 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

internationalExchangesDF(version='stable', filter='', format='json')

Returns an array of exchanges.

https://iexcloud.io/docs/api/#international-exchanges 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

internationalSymbols(exchange='', token='', version='stable', filter='', format='json')

This call returns an array of international symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#international-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
  • region (str) – region, 2 letter case insensitive string of country codes using ISO 3166-1 alpha-2
  • exchange (str) – Case insensitive string of Exchange using IEX Supported Exchanges list
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame or list

internationalSymbolsDF(exchange='', token='', version='stable', filter='', format='json')

This call returns an array of international symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#international-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
  • region (str) – region, 2 letter case insensitive string of country codes using ISO 3166-1 alpha-2
  • exchange (str) – Case insensitive string of Exchange using IEX Supported Exchanges list
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame or list

internationalSymbolsList(exchange='', token='', version='stable', filter='', format='json')

This call returns an array of international symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#international-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
  • region (str) – region, 2 letter case insensitive string of country codes using ISO 3166-1 alpha-2
  • exchange (str) – Case insensitive string of Exchange using IEX Supported Exchanges list
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame or list

intraday(date='', exactDate='', last=-1, IEXOnly=False, reset=False, simplify=False, interval=-1, changeFromClose=False, IEXWhenNull=False, token='', version='stable', filter='', format='json')

This endpoint will return aggregated intraday prices in one minute buckets

https://iexcloud.io/docs/api/#intraday-prices 9:30-4pm ET Mon-Fri on regular market trading days 9:30-1pm ET on early close trading days

Parameters:
  • symbol (str) – Ticker to request
  • date (str) – Formatted as YYYYMMDD. This can be used for batch calls when range is 1d or date. Currently supporting trailing 30 calendar days of minute bar data.
  • exactDate (str) – Same as date, takes precedence
  • last (number) – If passed, chart data will return the last N elements
  • IEXOnly (bool) – Limits the return of intraday prices to IEX only data.
  • reset (bool) – If true, chart will reset at midnight instead of the default behavior of 9:30am ET.
  • simplify (bool) – If true, runs a polyline simplification using the Douglas-Peucker algorithm. This is useful if plotting sparkline charts.
  • interval (number) – If passed, chart data will return every Nth element as defined by chartInterval
  • changeFromClose (bool) – If true, changeOverTime and marketChangeOverTime will be relative to previous day close instead of the first value.
  • IEXWhenNull (bool) – By default, all market prefixed fields are 15 minute delayed, meaning the most recent 15 objects will be null. If this parameter is passed as true, all market prefixed fields that are null will be populated with IEX data if available.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

intradayDF(date='', exactDate='', last=-1, IEXOnly=False, reset=False, simplify=False, interval=-1, changeFromClose=False, IEXWhenNull=False, token='', version='stable', filter='', format='json')

This endpoint will return aggregated intraday prices in one minute buckets

https://iexcloud.io/docs/api/#intraday-prices 9:30-4pm ET Mon-Fri on regular market trading days 9:30-1pm ET on early close trading days

Parameters:
  • symbol (str) – Ticker to request
  • date (str) – Formatted as YYYYMMDD. This can be used for batch calls when range is 1d or date. Currently supporting trailing 30 calendar days of minute bar data.
  • exactDate (str) – Same as date, takes precedence
  • last (number) – If passed, chart data will return the last N elements
  • IEXOnly (bool) – Limits the return of intraday prices to IEX only data.
  • reset (bool) – If true, chart will reset at midnight instead of the default behavior of 9:30am ET.
  • simplify (bool) – If true, runs a polyline simplification using the Douglas-Peucker algorithm. This is useful if plotting sparkline charts.
  • interval (number) – If passed, chart data will return every Nth element as defined by chartInterval
  • changeFromClose (bool) – If true, changeOverTime and marketChangeOverTime will be relative to previous day close instead of the first value.
  • IEXWhenNull (bool) – By default, all market prefixed fields are 15 minute delayed, meaning the most recent 15 objects will be null. If this parameter is passed as true, all market prefixed fields that are null will be populated with IEX data if available.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

ipoToday(version='stable', filter='', format='json')

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.

https://iexcloud.io/docs/api/#ipo-calendar 10am, 10:30am UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

ipoTodayDF(version='stable', filter='', format='json')

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.

https://iexcloud.io/docs/api/#ipo-calendar 10am, 10:30am UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

ipoUpcoming(version='stable', filter='', format='json')

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.

https://iexcloud.io/docs/api/#ipo-calendar 10am, 10:30am UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

ipoUpcomingDF(version='stable', filter='', format='json')

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.

https://iexcloud.io/docs/api/#ipo-calendar 10am, 10:30am UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

isinLookup(token='', version='stable', filter='', format='json')

This call returns an array of symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#isin-mapping 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

isinLookupDF(token='', version='stable', filter='', format='json')

This call returns an array of symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#isin-mapping 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

jet = functools.partial(<function Client.bind>, meth=<function points>, key='DJFUELUSGULF')
kama(symbol, timeframe='6m', col='close', period=30)
This will return a dataframe of kaufman adaptive moving average
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

keyStats(stat='', token='', version='stable', filter='', format='json')

Key Stats about company

https://iexcloud.io/docs/api/#key-stats 8am, 9am ET

Parameters:
  • symbol (str) – Ticker to request
  • stat (Optiona[str]) – specific stat to request, in: companyName marketcap week52high week52low week52change sharesOutstanding float avg10Volume avg30Volume day200MovingAvg day50MovingAvg employees ttmEPS ttmDividendRate dividendYield nextDividendDate exDividendDate nextEarningsDate peRatio beta maxChangePercent year5ChangePercent year2ChangePercent year1ChangePercent ytdChangePercent month6ChangePercent month3ChangePercent month1ChangePercent day30ChangePercent day5ChangePercent
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

keyStatsDF(stat='', token='', version='stable', filter='', format='json')

Key Stats about company

https://iexcloud.io/docs/api/#key-stats 8am, 9am ET

Parameters:
  • symbol (str) – Ticker to request
  • stat (Optiona[str]) – specific stat to request, in: companyName marketcap week52high week52low week52change sharesOutstanding float avg10Volume avg30Volume day200MovingAvg day50MovingAvg employees ttmEPS ttmDividendRate dividendYield nextDividendDate exDividendDate nextEarningsDate peRatio beta maxChangePercent year5ChangePercent year2ChangePercent year1ChangePercent ytdChangePercent month6ChangePercent month3ChangePercent month1ChangePercent day30ChangePercent day5ChangePercent
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

largestTrades(token='', version='stable', filter='', format='json')

This returns 15 minute delayed, last sale eligible trades.

https://iexcloud.io/docs/api/#largest-trades 9:30-4pm ET M-F during regular market hours

Parameters:
Returns:

result

Return type:

dict or DataFrame

largestTradesDF(token='', version='stable', filter='', format='json')

This returns 15 minute delayed, last sale eligible trades.

https://iexcloud.io/docs/api/#largest-trades 9:30-4pm ET M-F during regular market hours

Parameters:
Returns:

result

Return type:

dict or DataFrame

lastSSE(on_data=None, exit=None, token='', version='stable')

Last provides trade data for executions on IEX. It is a near real time, intraday API that provides IEX last sale price, size and time. Last is ideal for developers that need a lightweight stock quote.

https://iexcloud.io/docs/api/#last

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
lastSSEAsync(exit=None, token='', version='stable')

Last provides trade data for executions on IEX. It is a near real time, intraday API that provides IEX last sale price, size and time. Last is ideal for developers that need a lightweight stock quote.

https://iexcloud.io/docs/api/#last

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
latestFX(token='', version='stable', filter='', format='json')

This endpoint returns real-time foreign currency exchange rates data updated every 250 milliseconds.

https://iexcloud.io/docs/api/#latest-currency-rates 5pm Sun-4pm Fri UTC

Parameters:
  • symbols (str) – comma seperated list of symbols
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

latestFXDF(token='', version='stable', filter='', format='json')

This endpoint returns real-time foreign currency exchange rates data updated every 250 milliseconds.

https://iexcloud.io/docs/api/#latest-currency-rates 5pm Sun-4pm Fri UTC

Parameters:
  • symbols (str) – comma seperated list of symbols
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

linearreg(symbol, timeframe='6m', closecol='close', period=14)

This will return a dataframe of linear regression for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate adx across
Returns:

result

Return type:

DataFrame

linearreg_angle(symbol, timeframe='6m', closecol='close', period=14)

This will return a dataframe of linear regression angle for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate adx across
Returns:

result

Return type:

DataFrame

linearreg_intercept(symbol, timeframe='6m', closecol='close', period=14)

This will return a dataframe of linear regression intercept for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate adx across
Returns:

result

Return type:

DataFrame

linearreg_slope(symbol, timeframe='6m', closecol='close', period=14)

This will return a dataframe of linear regression slope for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate adx across
Returns:

result

Return type:

DataFrame

list(token='', version='stable', filter='', format='json')

Returns an array of quotes for the top 10 symbols in a specified list.

https://iexcloud.io/docs/api/#list Updated intraday

Parameters:
Returns:

result

Return type:

dict or DataFrame

listDF(token='', version='stable', filter='', format='json')

Returns an array of quotes for the top 10 symbols in a specified list.

https://iexcloud.io/docs/api/#list Updated intraday

Parameters:
Returns:

result

Return type:

dict or DataFrame

ln(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Log Natural for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

log10(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Log10 for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

logo(token='', version='stable', filter='', format='json')

This is a helper function, but the google APIs url is standardized.

https://iexcloud.io/docs/api/#logo 8am UTC daily

Parameters:
Returns:

result

Return type:

dict

logoNotebook(token='', version='stable')

This is a helper function, but the google APIs url is standardized.

https://iexcloud.io/docs/api/#logo 8am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
Returns:

result

Return type:

image

logoPNG(token='', version='stable')

This is a helper function, but the google APIs url is standardized.

https://iexcloud.io/docs/api/#logo 8am UTC daily

Parameters:
  • symbol (str) – Ticker to request
  • token (str) – Access token
  • version (str) – API version
Returns:

result as png

Return type:

image

lookupRule(token='', version='stable', format='json')

Pull the latest schema for data points, notification types, and operators used to construct rules.

https://iexcloud.io/docs/api/#rules-schema

Parameters:
  • lookup (str) – If a schema object has “isLookup”: true, pass the value key to /stable/rules/lookup/{value}. This returns all valid values for the rightValue of a condition.
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

macd(symbol, timeframe='6m', col='close', fastperiod=12, slowperiod=26, signalperiod=9)

This will return a dataframe of Moving Average Convergence/Divergence for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • fastperiod (int) – fast period to calculate across
  • slowperiod (int) – slow period to calculate across
  • signalperiod (int) – macd signal period
Returns:

result

Return type:

DataFrame

macdext(symbol, timeframe='6m', col='close', fastperiod=12, fastmatype=0, slowperiod=26, slowmatype=0, signalperiod=9, signalmatype=0)

This will return a dataframe of Moving Average Convergence/Divergence for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • fastperiod (int) – fast period to calculate across
  • fastmatype (int) – moving average type (0-sma)
  • slowperiod (int) – slow period to calculate across
  • slowmatype (int) – moving average type (0-sma)
  • signalperiod (int) – macd signal period
  • signalmatype (int) – moving average type (0-sma)
Returns:

result

Return type:

DataFrame

mama(symbol, timeframe='6m', col='close', fastlimit=0, slowlimit=0)
This will return a dataframe of mesa adaptive moving average
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • fastlimit (int) –
  • slowlimit (int) –
Returns:

result

Return type:

DataFrame

marketNews(token='', version='stable', filter='', format='json')

News about market

https://iexcloud.io/docs/api/#news Continuous

Parameters:
  • count (int) – limit number of results
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result dict: result

Return type:

dict or DataFrame

marketNewsDF(token='', version='stable', filter='', format='json')

News about market

https://iexcloud.io/docs/api/#news Continuous

Parameters:
  • count (int) – limit number of results
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result dict: result

Return type:

dict or DataFrame

marketOhlc(version='stable', filter='', format='json')

Returns the official open and close for whole market.

https://iexcloud.io/docs/api/#news 9:30am-5pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

marketOhlcDF(version='stable', filter='', format='json')

Returns the official open and close for whole market.

https://iexcloud.io/docs/api/#news 9:30am-5pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

marketPrevious(version='stable', filter='', format='json')

This returns previous day adjusted price data for whole market

https://iexcloud.io/docs/api/#previous-day-prices Available after 4am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame

marketPreviousDF(version='stable', filter='', format='json')

This returns previous day adjusted price data for whole market

https://iexcloud.io/docs/api/#previous-day-prices Available after 4am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame

marketShortInterest(token='', version='stable', filter='', format='json')

The consolidated market short interest positions in all IEX-listed securities are included in the IEX Short Interest Report.

The report data will be published daily at 4:00pm ET.

https://iexcloud.io/docs/api/#listed-short-interest-list-in-dev

Parameters:
Returns:

result

Return type:

dict or DataFrame

marketShortInterestDF(token='', version='stable', filter='', format='json')

The consolidated market short interest positions in all IEX-listed securities are included in the IEX Short Interest Report.

The report data will be published daily at 4:00pm ET.

https://iexcloud.io/docs/api/#listed-short-interest-list-in-dev

Parameters:
Returns:

result

Return type:

dict or DataFrame

marketVolume(version='stable', filter='', format='json')

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

https://iexcloud.io/docs/api/#market-volume-u-s 7:45am-5:15pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

marketVolumeDF(version='stable', filter='', format='json')

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

https://iexcloud.io/docs/api/#market-volume-u-s 7:45am-5:15pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

marketYesterday(version='stable', filter='', format='json')

This returns previous day adjusted price data for whole market

https://iexcloud.io/docs/api/#previous-day-prices Available after 4am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame

marketYesterdayDF(version='stable', filter='', format='json')

This returns previous day adjusted price data for whole market

https://iexcloud.io/docs/api/#previous-day-prices Available after 4am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame

markets(version='stable', filter='', format='json')

Deprecated since version Deprecated:: IEX Cloud status unkown

marketsDF(**kwargs)

Deprecated since version Deprecated:: IEX Cloud status unkown

mavp(symbol, timeframe='6m', col='close', periods=None, minperiod=2, maxperiod=30, matype=0)
This will return a dataframe of moving average with variable period
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • periods (int) –
  • minperiod (int) –
  • maxperiod (int) –
  • matype (int) –
Returns:

result

Return type:

DataFrame

max(symbol, timeframe='6m', col='close', period=30)

This will return a dataframe of Highest value over a specified period for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

maxindex(symbol, timeframe='6m', col='close', period=30)

This will return a dataframe of Highest value over a specified period for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

medprice(symbol, timeframe='6m', highcol='high', lowcol='low')

This will return a dataframe of median price for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

messageBudget(token='', version='stable', format='json')

Used to set an upper limit, “message budget”, on pay as you go messages where you want to make sure not to go above a certain amount. Set the total messages you wish to consume for the month, and once that limit is reached, all API calls will stop until the limit is removed or increased.

https://iexcloud.io/docs/api/#message-budget

Parameters:
  • totalMessages (int) – The total messages your account is allowed to consume for the current month above your quota. For example: If your account is allowed 5 million messages, and you do not want to exceed 10 million for the month, then you will pass 10000000 as total messages.
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
metadata(version='stable', format='json')

Used to retrieve account details such as current tier, payment status, message quote usage, etc.

https://iexcloud.io/docs/api/#metadata

Parameters:
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

metadataDF(version='stable', format='json')

Used to retrieve account details such as current tier, payment status, message quote usage, etc.

https://iexcloud.io/docs/api/#metadata

Parameters:
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

mfi(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', volumecol='volume', period=14)

This will return a dataframe of Money Flow Index for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

midpice(symbol, timeframe='6m', col='close', period=14)
This will return a dataframe of midprice over period
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

midpoint(symbol, timeframe='6m', col='close', period=14)
This will return a dataframe of midpoint over period
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

min(symbol, timeframe='6m', col='close', period=30)

This will return a dataframe of Lowest value over a specified period for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

minindex(symbol, timeframe='6m', col='close', period=30)

This will return a dataframe of Lowest value over a specified period for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

minmax(symbol, timeframe='6m', col='close', period=30)

This will return a dataframe of Lowest and highest values over a specified period for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

minmaxindex(symbol, timeframe='6m', col='close', period=30)

This will return a dataframe of Indexes of lowest and highest values over a specified period for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

minus_di(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', period=14)

This will return a dataframe of Minus Directional Indicator for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

minus_dm(symbol, timeframe='6m', highcol='high', lowcol='low', period=14)

This will return a dataframe of Minus Directional Movement for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

mom(symbol, timeframe='6m', col='close', period=14)

This will return a dataframe of Momentum for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

mult(symbol, timeframe='6m', col1='open', col2='close')

This will return a dataframe of Vector Arithmetic Add for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col1 (string) –
  • col2 (string) –
Returns:

result

Return type:

DataFrame

mutualFundSymbols(version='stable', filter='', format='json')

This call returns an array of mutual fund symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#mutual-fund-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

mutualFundSymbolsDF(version='stable', filter='', format='json')

This call returns an array of mutual fund symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#mutual-fund-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

mutualFundSymbolsList(version='stable', filter='', format='json')

This call returns an array of mutual fund symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#mutual-fund-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

natgas = functools.partial(<function Client.bind>, meth=<function points>, key='DHHNGSP')
natr(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', period=14)

This will return a dataframe of normalized average true range for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period (int) – time period to calculate over
Returns:

result

Return type:

DataFrame

news(count=10, token='', version='stable', filter='', format='json')

News about company

https://iexcloud.io/docs/api/#news Continuous

Parameters:
  • symbol (str) – Ticker to request
  • count (int) – limit number of results
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result dict: result

Return type:

dict or DataFrame

newsDF(count=10, token='', version='stable', filter='', format='json')

News about company

https://iexcloud.io/docs/api/#news Continuous

Parameters:
  • symbol (str) – Ticker to request
  • count (int) – limit number of results
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result dict: result

Return type:

dict or DataFrame

newsSSE(on_data=None, exit=None, token='', version='stable')

Stream news

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
newsSSEAsync(exit=None, token='', version='stable')

Stream news

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
nextDayExtDate(token='', version='stable', filter='', format='json')
Parameters:
Returns:

result

Return type:

dict or DataFrame

Deprecated since version Deprecated:: IEX Cloud status unkown

nextDayExtDateDF(token='', version='stable', filter='', format='json')
Parameters:
Returns:

result

Return type:

dict or DataFrame

Deprecated since version Deprecated:: IEX Cloud status unkown

obv(symbol, timeframe='6m', closecol='close', volumecol='volume')

This will return a dataframe of On Balance Volume for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • closecol (string) – column to use to calculate
  • volumecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

ohlc(token='', version='stable', filter='', format='json')

Returns the official open and close for a give symbol.

https://iexcloud.io/docs/api/#ohlc 9:30am-5pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

ohlcDF(token='', version='stable', filter='', format='json')

Returns the official open and close for a give symbol.

https://iexcloud.io/docs/api/#ohlc 9:30am-5pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

oneMonth = functools.partial(<function Client.bind>, meth=<function points>, key='DGS1MO')
oneYear = functools.partial(<function Client.bind>, meth=<function points>, key='DGS1')
optionExpirations(token='', version='stable', filter='', format='json')

Returns end of day options data

https://iexcloud.io/docs/api/#options 9:30am-5pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

options(expiration, side='', token='', version='stable', filter='', format='json')

Returns end of day options data

https://iexcloud.io/docs/api/#options 9:30am-5pm ET Mon-Fri

Parameters:
  • symbol (str) – Ticker to request
  • expiration (str) – Expiration date
  • side (str) – Side (optional)
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

optionsDF(expiration, side='', token='', version='stable', filter='', format='json')

Returns end of day options data

https://iexcloud.io/docs/api/#options 9:30am-5pm ET Mon-Fri

Parameters:
  • symbol (str) – Ticker to request
  • expiration (str) – Expiration date
  • side (str) – Side (optional)
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

optionsSymbols(version='stable', filter='', format='json')

This call returns an object keyed by symbol with the value of each symbol being an array of available contract dates.

https://iexcloud.io/docs/api/#options-symbols 9:30am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

optionsSymbolsDF(version='stable', filter='', format='json')

This call returns an object keyed by symbol with the value of each symbol being an array of available contract dates.

https://iexcloud.io/docs/api/#options-symbols 9:30am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

optionsSymbolsList(version='stable', filter='', format='json')

This call returns an object keyed by symbol with the value of each symbol being an array of available contract dates.

https://iexcloud.io/docs/api/#options-symbols 9:30am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

otcSymbols(version='stable', filter='', format='json')

This call returns an array of OTC symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#otc-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

otcSymbolsDF(version='stable', filter='', format='json')

This call returns an array of OTC symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#otc-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

otcSymbolsList(version='stable', filter='', format='json')

This call returns an array of OTC symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#otc-symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

pauseRule(token='', version='stable', format='json')

You can control the output of rules by pausing and resume per rule id.

Parameters:
  • ruleId (str) – The id of an existing rule to puase
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
payroll = functools.partial(<function Client.bind>, meth=<function points>, key='PAYEMS')
peerCorrelation(symbol, timeframe='6m')

This will return a dataframe of peer correlations for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
Returns:

result

Return type:

DataFrame

peerCorrelationPlot(symbol, timeframe='6m')

This will plot a dataframe of peer correlations for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
Returns:

result

Return type:

DataFrame

peers(token='', version='stable', filter='', format='json')

Peers of ticker

https://iexcloud.io/docs/api/#peers 8am UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

peersDF(token='', version='stable', filter='', format='json')

Peers of ticker

https://iexcloud.io/docs/api/#peers 8am UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame

plus_di(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', period=14)

This will return a dataframe of Plus Directional Movement for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

plus_dm(symbol, timeframe='6m', highcol='high', lowcol='low', period=14)

This will return a dataframe of Plus Directional Movement for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

points(key='', token='', version='stable', filter='', format='json')

Data points are available per symbol and return individual plain text values. Retrieving individual data points is useful for Excel and Google Sheet users, and applications where a single, lightweight value is needed. We also provide update times for some endpoints which allow you to call an endpoint only once it has new data.

https://iexcloud.io/docs/api/#data-points

Parameters:
  • symbol (str) – Ticker or market to query
  • key (str) – data point to fetch. If empty or none, will return available data points
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

pointsDF(key='', token='', version='stable', filter='', format='json')

Data points are available per symbol and return individual plain text values. Retrieving individual data points is useful for Excel and Google Sheet users, and applications where a single, lightweight value is needed. We also provide update times for some endpoints which allow you to call an endpoint only once it has new data.

https://iexcloud.io/docs/api/#data-points

Parameters:
  • symbol (str) – Ticker or market to query
  • key (str) – data point to fetch. If empty or none, will return available data points
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

ppo(symbol, timeframe='6m', col='close', fastperiod=12, slowperiod=26, matype=0)

This will return a dataframe of Percentage Price Oscillator for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • fastperiod (int) – fast period to calculate across
  • slowperiod (int) – slow period to calculate across
  • matype (int) – moving average type (0-sma)
Returns:

result

Return type:

DataFrame

previous(token='', version='stable', filter='', format='json')

This returns previous day adjusted price data for one or more stocks

https://iexcloud.io/docs/api/#previous-day-prices Available after 4am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame

previousDF(token='', version='stable', filter='', format='json')

This returns previous day adjusted price data for one or more stocks

https://iexcloud.io/docs/api/#previous-day-prices Available after 4am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame

price(token='', version='stable', filter='', format='json')

Price of ticker

https://iexcloud.io/docs/api/#price 4:30am-8pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

priceDF(token='', version='stable', filter='', format='json')

Price of ticker

https://iexcloud.io/docs/api/#price 4:30am-8pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

priceTarget(token='', version='stable', filter='', format='json')

Provides the latest avg, high, and low analyst price target for a symbol.

https://iexcloud.io/docs/api/#price-target Updates at 10am, 11am, 12pm UTC every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

priceTargetDF(token='', version='stable', filter='', format='json')

Provides the latest avg, high, and low analyst price target for a symbol.

https://iexcloud.io/docs/api/#price-target Updates at 10am, 11am, 12pm UTC every day

Parameters:
Returns:

result

Return type:

dict or DataFrame

propane = functools.partial(<function Client.bind>, meth=<function points>, key='DPROPANEMBTX')
queryMetadata(key='', subkey='', token='', version='stable', filter='', format='json')

Get inventory of available time series endpoints

Parameters:
  • id (str) – Timeseries ID
  • key (str) – Timeseries Key
  • subkey (str) – Timeseries Subkey
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – https://iexcloud.io/docs/api/#filter-results
  • format (str) – output format
queryMetadataDF(key='', subkey='', token='', version='stable', filter='', format='json')

Get inventory of available time series endpoints

Parameters:
  • id (str) – Timeseries ID
  • key (str) – Timeseries Key
  • subkey (str) – Timeseries Subkey
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – https://iexcloud.io/docs/api/#filter-results
  • format (str) – output format
quote(token='', version='stable', filter='', format='json')

Get quote for ticker

https://iexcloud.io/docs/api/#quote 4:30am-8pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

quoteDF(token='', version='stable', filter='', format='json')

Get quote for ticker

https://iexcloud.io/docs/api/#quote 4:30am-8pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

recent(version='stable', filter='', format='json')

https://iexcloud.io/docs/api/#stats-recent

Parameters:
Returns:

result

Return type:

dict or DataFrame

recentDF(version='stable', filter='', format='json')

https://iexcloud.io/docs/api/#stats-recent

Parameters:
Returns:

result

Return type:

dict or DataFrame

recessionProb = functools.partial(<function Client.bind>, meth=<function points>, key='RECPROUSM156N')
records(version='stable', filter='', format='json')

https://iexcloud.io/docs/api/#stats-records

Parameters:
Returns:

result

Return type:

dict or DataFrame

recordsDF(version='stable', filter='', format='json')

https://iexcloud.io/docs/api/#stats-records

Parameters:
Returns:

result

Return type:

dict or DataFrame

refDividends(token='', version='stable', filter='', format='json')
Parameters:
Returns:

result

Return type:

dict or DataFrame

Deprecated since version Deprecated:: IEX Cloud status unkown

refDividendsDF(token='', version='stable', filter='', format='json')
Parameters:
Returns:

result

Return type:

dict or DataFrame

Deprecated since version Deprecated:: IEX Cloud status unkown

relevant(token='', version='stable', filter='', format='json')

Same as peers

https://iexcloud.io/docs/api/#relevant :param symbol: Ticker to request :type symbol: str :param token: Access token :type token: str :param version: API version :type version: str :param filter: filters: https://iexcloud.io/docs/api/#filter-results :type filter: str :param format: return format, defaults to json :type format: str

Returns:result
Return type:dict or DataFrame

Deprecated since version Deprecated:: IEX Cloud status unkown

relevantDF(token='', version='stable', filter='', format='json')

Same as peers

https://iexcloud.io/docs/api/#relevant :param symbol: Ticker to request :type symbol: str :param token: Access token :type token: str :param version: API version :type version: str :param filter: filters: https://iexcloud.io/docs/api/#filter-results :type filter: str :param format: return format, defaults to json :type format: str

Returns:result
Return type:dict or DataFrame

Deprecated since version Deprecated:: IEX Cloud status unkown

resumeRule(token='', version='stable', format='json')

You can control the output of rules by pausing and resume per rule id.

Parameters:
  • ruleId (str) – The id of an existing rule to puase
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
retailMoney = functools.partial(<function Client.bind>, meth=<function points>, key='WRMFSL')
returnOfCapital(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Return of capital up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#return-of-capital

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

returnOfCapitalDF(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Return of capital up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#return-of-capital

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

returns(symbol, timeframe='6m')

Calculate returns using daily close price

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
Returns:

result

Return type:

DataFrame

rightToPurchase(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Right to purchase up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#right-to-purchase

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

rightToPurchaseDF(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Right to purchase up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#right-to-purchase

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

rightsIssue(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Rights issue up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#rights-issue

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

rightsIssueDF(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Rights issue up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#rights-issue

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

roc(symbol, timeframe='6m', col='close', period=14)

This will return a dataframe of Rate of change: ((price/prevPrice)-1)*100 for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

rocp(symbol, timeframe='6m', col='close', period=14)

This will return a dataframe of Rate of change Percentage: (price-prevPrice)/prevPrice for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

rocr(symbol, timeframe='6m', col='close', period=14)

This will return a dataframe of Rate of change ratio: (price/prevPrice) for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

rocr100(symbol, timeframe='6m', col='close', period=14)

This will return a dataframe of Rate of change ratio 100 scale: (price/prevPrice)*100 for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

rsi(symbol, timeframe='6m', col='close', period=14)

This will return a dataframe of Relative Strength Index for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

ruleInfo(token='', version='stable', format='json')

Rule information such as the current rule status and execution statistics.

Parameters:
  • ruleId (str) – The id of an existing rule to puase
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
ruleOutput(token='', version='stable', format='json')

If you choose logs as your rule output method, IEX Cloud will save the output objects on our server. You can use this method to retrieve those data objects.

Parameters:
  • ruleId (str) – The id of an existing rule to puase
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
rules(version='stable', format='json')

List all rules that are currently on your account. Each rule object returned will include the current rule status and execution statistics.

sar(symbol, timeframe='6m', highcol='high', lowcol='low', acceleration=0, maximum=0)
This will return a dataframe of parabolic sar
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • highcol (string) –
  • lowcol (string) –
  • acceleration (int) –
  • maximum (int) –
Returns:

result

Return type:

DataFrame

sarext(symbol, timeframe='6m', highcol='high', lowcol='low', startvalue=0, offsetonreverse=0, accelerationinitlong=0, accelerationlong=0, accelerationmaxlong=0, accelerationinitshort=0, accelerationshort=0, accelerationmaxshort=0)
This will return a dataframe of parabolic sar extended
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • highcol (string) –
  • lowcol (string) –
  • startvalue (int) –
  • offsetonreverse (int) –
  • accelerationinitlong (int) –
  • accelerationlong (int) –
  • accelerationmaxlong (int) –
  • accelerationinitshort (int) –
  • accelerationshort (int) –
  • accelerationmaxshort (int) –
Returns:

result

Return type:

DataFrame

schema(token='', version='stable', format='json')

Pull the latest schema for data points, notification types, and operators used to construct rules.

https://iexcloud.io/docs/api/#rules-schema

Parameters:
  • lookup (str) – If a schema object has “isLookup”: true, pass the value key to /stable/rules/lookup/{value}. This returns all valid values for the rightValue of a condition.
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict

search(token='', version='stable', filter='', format='json')

Returns an array of symbols up to the top 10 matches. Results will be sorted for relevancy. Search currently defaults to equities only, where the symbol returned is supported by endpoints listed under the Stocks category.

https://iexcloud.io/docs/api/#search

Parameters:
  • fragment (str) – URL encoded search string. Currently search by symbol or security name.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

searchDF(token='', version='stable', filter='', format='json')

Returns an array of symbols up to the top 10 matches. Results will be sorted for relevancy. Search currently defaults to equities only, where the symbol returned is supported by endpoints listed under the Stocks category.

https://iexcloud.io/docs/api/#search

Parameters:
  • fragment (str) – URL encoded search string. Currently search by symbol or security name.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

sectorPerformance(version='stable', filter='', format='json')

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

https://iexcloud.io/docs/api/#sector-performance 8am-5pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

sectorPerformanceDF(version='stable', filter='', format='json')

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

https://iexcloud.io/docs/api/#sector-performance 8am-5pm ET Mon-Fri

Parameters:
Returns:

result

Return type:

dict or DataFrame

sectors(version='stable', filter='', format='json')

Returns an array of sectors.

https://iexcloud.io/docs/api/#sectors

Parameters:
Returns:

result

Return type:

dict or DataFrame

sectorsDF(version='stable', filter='', format='json')

Returns an array of sectors.

https://iexcloud.io/docs/api/#sectors

Parameters:
Returns:

result

Return type:

dict or DataFrame

securityReclassification(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Security reclassification up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#security-reclassification

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

securityReclassificationDF(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Security reclassification up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#security-reclassification

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

securitySwap(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Security Swap up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#security-swap

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

securitySwapDF(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Security Swap up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#security-swap

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

sentiment(type='daily', date=None, token='', version='stable', filter='', format='json')

This endpoint provides social sentiment data from StockTwits. Data can be viewed as a daily value, or by minute for a given date.

https://iexcloud.io/docs/api/#social-sentiment Continuous

Parameters:
  • symbol (str) – Ticker to request
  • type (str) – ‘daily’ or ‘minute’
  • date (str) – date in YYYYMMDD or datetime
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

sentimentDF(type='daily', date=None, token='', version='stable', filter='', format='json')

This endpoint provides social sentiment data from StockTwits. Data can be viewed as a daily value, or by minute for a given date.

https://iexcloud.io/docs/api/#social-sentiment Continuous

Parameters:
  • symbol (str) – Ticker to request
  • type (str) – ‘daily’ or ‘minute’
  • date (str) – date in YYYYMMDD or datetime
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

sentimentSSE(on_data=None, exit=None, token='', version='stable')

Stream social sentiment

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
sentimentSSEAsync(exit=None, token='', version='stable')

Stream social sentiment

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
shortInterest(date=None, token='', version='stable', filter='', format='json')

The consolidated market short interest positions in all IEX-listed securities are included in the IEX Short Interest Report.

The report data will be published daily at 4:00pm ET.

https://iexcloud.io/docs/api/#listed-short-interest-list-in-dev

Parameters:
  • symbol (str) – Ticker to request
  • date (datetime) – Effective Datetime
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

shortInterestDF(date=None, token='', version='stable', filter='', format='json')

The consolidated market short interest positions in all IEX-listed securities are included in the IEX Short Interest Report.

The report data will be published daily at 4:00pm ET.

https://iexcloud.io/docs/api/#listed-short-interest-list-in-dev

Parameters:
  • symbol (str) – Ticker to request
  • date (datetime) – Effective Datetime
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

sin(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Trigonometric SIN for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

sinh(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Trigonometric Sinh for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

sixMonth = functools.partial(<function Client.bind>, meth=<function points>, key='DGS6MO')
sma(symbol, timeframe='6m', col='close', periods=None)
This will return a dataframe of exponential moving average
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • periods (int) –
Returns:

result

Return type:

DataFrame

spinoff(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Security spinoff up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#spinoff

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

spinoffDF(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Security spinoff up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#spinoff

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

splits(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Security splits up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#splits

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

splitsDF(refid='', token='', version='stable', filter='', format='json', **timeseries_kwargs)

Security splits up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

Updated at 5am, 10am, 8pm UTC daily

https://iexcloud.io/docs/api/#splits

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
  • all kwargs from pyEX.stocks.timeseries.timeSeries (Supports) –
Returns:

result

Return type:

dict or DataFrame

spread(token='', version='stable', filter='', format='json')

This returns an array of effective spread, eligible volume, and price improvement of a stock, by market. Unlike volume-by-venue, this will only return a venue if effective spread is not ‘N/A’. Values are sorted in descending order by effectiveSpread. Lower effectiveSpread and higher priceImprovement values are generally considered optimal.

Effective spread is designed to measure marketable orders executed in relation to the market center’s quoted spread and takes into account hidden and midpoint liquidity available at each market center. Effective Spread is calculated by using eligible trade prices recorded to the consolidated tape and comparing those trade prices to the National Best Bid and Offer (“NBBO”) at the time of the execution.

View the data disclaimer at the bottom of the stocks app for more information about how these values are calculated.

8am ET M-F

Parameters:
Returns:

result

Return type:

dict or DataFrame

spreadDF(token='', version='stable', filter='', format='json')

This returns an array of effective spread, eligible volume, and price improvement of a stock, by market. Unlike volume-by-venue, this will only return a venue if effective spread is not ‘N/A’. Values are sorted in descending order by effectiveSpread. Lower effectiveSpread and higher priceImprovement values are generally considered optimal.

Effective spread is designed to measure marketable orders executed in relation to the market center’s quoted spread and takes into account hidden and midpoint liquidity available at each market center. Effective Spread is calculated by using eligible trade prices recorded to the consolidated tape and comparing those trade prices to the National Best Bid and Offer (“NBBO”) at the time of the execution.

View the data disclaimer at the bottom of the stocks app for more information about how these values are calculated.

8am ET M-F

Parameters:
Returns:

result

Return type:

dict or DataFrame

sqrt(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Square Root for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

stddev(symbol, timeframe='6m', closecol='close', period=14, nbdev=1)

This will return a dataframe of standard deviation for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate adx across
  • nbdev (int) –
Returns:

result

Return type:

DataFrame

stoch(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', fastk_period=5, slowk_period=3, slowk_matype=0, slowd_period=3, slowd_matype=0)

This will return a dataframe of Stochastic for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • fastk_period (int) – fastk_period
  • slowk_period (int) – slowk_period
  • slowk_matype (int) – slowk_matype
  • slowd_period (int) – slowd_period
  • slowd_matype (int) – slowd_matype
Returns:

result

Return type:

DataFrame

stochf(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', fastk_period=5, slowk_period=3, slowk_matype=0, slowd_period=3, slowd_matype=0)

This will return a dataframe of Stochastic Fast for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • fastk_period (int) – fastk_period
  • slowk_period (int) – slowk_period
  • slowk_matype (int) – slowk_matype
  • slowd_period (int) – slowd_period
  • slowd_matype (int) – slowd_matype
Returns:

result

Return type:

DataFrame

stochrsi(symbol, timeframe='6m', closecol='close', period=14, fastk_period=5, fastd_period=3, fastd_matype=0)

This will return a dataframe of Stochastic Relative Strength Index for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate across
  • fastk_period (int) – fastk_period
  • fastd_period (int) – fastd_period
  • fastd_matype (int) – moving average type (0-sma)
Returns:

result

Return type:

DataFrame

stockSplits(timeframe='ytd', token='', version='stable', filter='', format='json')

Stock split history

https://iexcloud.io/docs/api/#splits Updated at 9am UTC every day

Parameters:
  • symbol (str) – Ticker to request
  • timeframe (str) – timeframe for data
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

stockSplitsDF(timeframe='ytd', token='', version='stable', filter='', format='json')

Stock split history

https://iexcloud.io/docs/api/#splits Updated at 9am UTC every day

Parameters:
  • symbol (str) – Ticker to request
  • timeframe (str) – timeframe for data
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

stocksUS1MinuteSSE(on_data=None, exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUS1MinuteSSEAsync(exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUS1SecondSSE(on_data=None, exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUS1SecondSSEAsync(exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUS5SecondSSE(on_data=None, exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUS5SecondSSEAsync(exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUSNoUTP1MinuteSSE(on_data=None, exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUSNoUTP1MinuteSSEAsync(exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUSNoUTP1SecondSSE(on_data=None, exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUSNoUTP1SecondSSEAsync(exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUSNoUTP5SecondSSE(on_data=None, exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUSNoUTP5SecondSSEAsync(exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUSNoUTPSSE(on_data=None, exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUSNoUTPSSEAsync(exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUSSSE(on_data=None, exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
stocksUSSSEAsync(exit=None, token='', version='stable', name='')

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
sub(symbol, timeframe='6m', col1='open', col2='close')

This will return a dataframe of Vector Arithmetic Add for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col1 (string) –
  • col2 (string) –
Returns:

result

Return type:

DataFrame

sum(symbol, timeframe='6m', col='close', period=30)

This will return a dataframe of Summation for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • period (int) –
Returns:

result

Return type:

DataFrame

summary(token='', version='stable', filter='', format='json')

https://iexcloud.io/docs/api/#stats-historical-summary

Parameters:
  • date (Optional[str]) – Format YYYYMMDD date to fetch sentiment data. Default is today.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

summaryDF(token='', version='stable', filter='', format='json')

https://iexcloud.io/docs/api/#stats-historical-summary

Parameters:
  • date (Optional[str]) – Format YYYYMMDD date to fetch sentiment data. Default is today.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

symbols(version='stable', filter='', format='json')

This call returns an array of symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

symbolsDF(version='stable', filter='', format='json')

This call returns an array of symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

symbolsList(version='stable', filter='', format='json')

This call returns an array of symbols that IEX Cloud supports for API calls.

https://iexcloud.io/docs/api/#symbols 8am, 9am, 12pm, 1pm UTC daily

Parameters:
Returns:

result

Return type:

dict or DataFrame or list

systemStats(version='stable', filter='', format='json')

https://iexcloud.io/docs/api/#stats-intraday

Parameters:
Returns:

result

Return type:

dict or DataFrame

systemStatsDF(version='stable', filter='', format='json')

https://iexcloud.io/docs/api/#stats-intraday

Parameters:
Returns:

result

Return type:

dict or DataFrame

t3(symbol, timeframe='6m', col='close', periods=None, vfactor=0)
This will return a dataframe of tripple exponential moving average
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • periods (int) –
  • vfactor (int) –
Returns:

result

Return type:

DataFrame

tags(version='stable', filter='', format='json')

Returns an array of tags.

https://iexcloud.io/docs/api/#tags

Parameters:
Returns:

result

Return type:

dict or DataFrame

tagsDF(version='stable', filter='', format='json')

Returns an array of tags.

https://iexcloud.io/docs/api/#tags

Parameters:
Returns:

result

Return type:

dict or DataFrame

tan(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Trigonometric Tan for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

tanh(symbol, timeframe='6m', col='close')

This will return a dataframe of Vector Trigonometric Tanh for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
Returns:

result

Return type:

DataFrame

technicals(indicator, range='1m', input1=None, input2=None, input3=None, input4=None, token='', version='stable', filter='', format='json')

Technical indicators are available for any historical or intraday range.

This endpoint calls the historical or intraday price endpoints for the given range, and the associated indicator for the price range.

https://iexcloud.io/docs/api/#technical-indicators Data Timing: On Demand

Parameters:
  • symbol (str) – Ticker to request
  • indicator (str) – Technical indicator to request, in: Indicator Description Inputs Defaults Outputs ————————————————————————————————————- abs Vector Absolute Value abs acos Vector Arccosine acos ad Accumulation/Distribution Line ad add Vector Addition add adosc Accumulation/Distribution Oscillator short period,long period 2,5 adosc adx Average Directional Movement Index period 5 dx adxr Average Directional Movement Rating period 5 dx ao Awesome Oscillator ao apo Absolute Price Oscillator short period,long period 2,5 apo aroon Aroon period 5 aroon_down,aroon_up aroonosc Aroon Oscillator period 5 aroonosc asin Vector Arcsine asin atan Vector Arctangent atan atr Average True Range period 5 atr avgprice Average Price avgprice bbands Bollinger Bands period,stddev 20,2 bbands_lower,bbands_middle,bbands_upper bop Balance of Power cci Commodity Channel Index period 5 cci ceil Vector Ceiling ceil cmo Chande Momentum Oscillator period 5 cmo cos Vector Cosine cos cosh Vector Hyperbolic Cosine cosh crossany Crossany crossany crossover Crossover crossover cvi Chaikins Volatility period 5 cvi decay Linear Decay period 5 decay dema Double Exponential Moving Average period 5 dema di Directional Indicator period 5 plus_di,minus_di div Vector Division div dm Directional Movement period 5 plus_dm,minus_dm dpo Detrended Price Oscillator period 5 dpo dx Directional Movement Index period 5 dx edecay Exponential Decay period 5 edecay ema Exponential Moving Average period 5 ema emv Ease of Movement emv exp Vector Exponential exp fisher Fisher Transform period 5 fisher,fisher_signal floor Vector Floor floor fosc Forecast Oscillator period 5 fosc hma Hull Moving Average period 5 hma kama Kaufman Adaptive Moving Average period 5 kama kvo Klinger Volume Oscillator short period,long period 2,5 kvo lag Lag period 5 lag linreg Linear Regression period 5 linreg linregintercept Linear Regression Intercept period 5 linregintercept linregslope Linear Regression Slope period 5 linregslope ln Vector Natural Log ln log10 Vector Base-10 Log log10 macd Moving Average Conv/Div short per,long per,signal per 12,26,9 macd,macd_signal,macd_histogram marketfi Market Facilitation Index marketfi mass Mass Index period 5 mass max Maximum In Period period 5 max md Mean Deviation Over Period period 5 md medprice Median Price medprice mfi Money Flow Index period 5 mfi min Minimum In Period period 5 min mom Momentum period 5 mom msw Mesa Sine Wave period 5 msw_sine,msw_lead mul Vector Multiplication mul natr Normalized Average True Range period 5 natr nvi Negative Volume Index nvi obv On Balance Volume obv ppo Percentage Price Oscillator short period,long period 2,5 ppo psar Parabolic SAR accelfactor step,accel factor max .2,2 psar pvi Positive Volume Index pvi qstick Qstick period 5 qstick roc Rate of Change period 5 roc rocr Rate of Change Ratio period 5 rocr round Vector Round round rsi Relative Strength Index period 5 rsi sin Vector Sine sin sinh Vector Hyperbolic Sine sinh sma Simple Moving Average period 5 sma sqrt Vector Square Root sqrt stddev Standard Deviation Over Period period 5 stddev stderr Standard Error Over Period period 5 stderr stoch Stochastic Oscillator k per,k slowing per,d per 5,3,3 stoch_k,stoch_d stochrsi Stochastic RSI period 5 stochrsi sub Vector Subtraction sub sum Sum Over Period period 5 sum tan Vector Tangent tan tanh Vector Hyperbolic Tangent tanh tema Triple Exponential Moving Average period 5 tema todeg Vector Degree Conversion degrees torad Vector Radian Conversion radians tr True Range tr trima Triangular Moving Average period 5 trima trix Trix period 5 trix trunc Vector Truncate trunc tsf Time Series Forecast period 5 tsf typprice Typical Price typprice ultosc Ultimate Oscillator short per,med per,long per 2,3,5 ultosc var Variance Over Period period 5 var vhf Vertical Horizontal Filter period 5 vhf vidya Variable Index Dynamic Average short period,long period,alpha 2,5,.2 vidya volatility Annualized Historical Volatility period 5 volatility vosc Volume Oscillator short period,long period 2,5 vosc vwma Volume Weighted Moving Average period 5 vwma wad Williams Accumulation/Distribution wad wcprice Weighted Close Price wcprice wilders Wilders Smoothing period 5 wilders willr Williams %R period wma Weighted Moving Average period 5 wma zlema Zero-Lag Exponential Moving Average period 5 zlema
  • range (str) – Timeframe to request e.g. 1m
  • input1 (str) – input1 to technicals (see docs)
  • input2 (str) – input2 to technicals (see docs)
  • input3 (str) – input3 to technicals (see docs)
  • input4 (str) – input4 to technicals (see docs)
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

technicalsDF(indicator, range='1m', input1=None, input2=None, input3=None, input4=None, token='', version='stable', filter='', format='json')

Technical indicators are available for any historical or intraday range.

This endpoint calls the historical or intraday price endpoints for the given range, and the associated indicator for the price range.

https://iexcloud.io/docs/api/#technical-indicators Data Timing: On Demand

Parameters:
  • symbol (str) – Ticker to request
  • indicator (str) – Technical indicator to request, in: Indicator Description Inputs Defaults Outputs ————————————————————————————————————- abs Vector Absolute Value abs acos Vector Arccosine acos ad Accumulation/Distribution Line ad add Vector Addition add adosc Accumulation/Distribution Oscillator short period,long period 2,5 adosc adx Average Directional Movement Index period 5 dx adxr Average Directional Movement Rating period 5 dx ao Awesome Oscillator ao apo Absolute Price Oscillator short period,long period 2,5 apo aroon Aroon period 5 aroon_down,aroon_up aroonosc Aroon Oscillator period 5 aroonosc asin Vector Arcsine asin atan Vector Arctangent atan atr Average True Range period 5 atr avgprice Average Price avgprice bbands Bollinger Bands period,stddev 20,2 bbands_lower,bbands_middle,bbands_upper bop Balance of Power cci Commodity Channel Index period 5 cci ceil Vector Ceiling ceil cmo Chande Momentum Oscillator period 5 cmo cos Vector Cosine cos cosh Vector Hyperbolic Cosine cosh crossany Crossany crossany crossover Crossover crossover cvi Chaikins Volatility period 5 cvi decay Linear Decay period 5 decay dema Double Exponential Moving Average period 5 dema di Directional Indicator period 5 plus_di,minus_di div Vector Division div dm Directional Movement period 5 plus_dm,minus_dm dpo Detrended Price Oscillator period 5 dpo dx Directional Movement Index period 5 dx edecay Exponential Decay period 5 edecay ema Exponential Moving Average period 5 ema emv Ease of Movement emv exp Vector Exponential exp fisher Fisher Transform period 5 fisher,fisher_signal floor Vector Floor floor fosc Forecast Oscillator period 5 fosc hma Hull Moving Average period 5 hma kama Kaufman Adaptive Moving Average period 5 kama kvo Klinger Volume Oscillator short period,long period 2,5 kvo lag Lag period 5 lag linreg Linear Regression period 5 linreg linregintercept Linear Regression Intercept period 5 linregintercept linregslope Linear Regression Slope period 5 linregslope ln Vector Natural Log ln log10 Vector Base-10 Log log10 macd Moving Average Conv/Div short per,long per,signal per 12,26,9 macd,macd_signal,macd_histogram marketfi Market Facilitation Index marketfi mass Mass Index period 5 mass max Maximum In Period period 5 max md Mean Deviation Over Period period 5 md medprice Median Price medprice mfi Money Flow Index period 5 mfi min Minimum In Period period 5 min mom Momentum period 5 mom msw Mesa Sine Wave period 5 msw_sine,msw_lead mul Vector Multiplication mul natr Normalized Average True Range period 5 natr nvi Negative Volume Index nvi obv On Balance Volume obv ppo Percentage Price Oscillator short period,long period 2,5 ppo psar Parabolic SAR accelfactor step,accel factor max .2,2 psar pvi Positive Volume Index pvi qstick Qstick period 5 qstick roc Rate of Change period 5 roc rocr Rate of Change Ratio period 5 rocr round Vector Round round rsi Relative Strength Index period 5 rsi sin Vector Sine sin sinh Vector Hyperbolic Sine sinh sma Simple Moving Average period 5 sma sqrt Vector Square Root sqrt stddev Standard Deviation Over Period period 5 stddev stderr Standard Error Over Period period 5 stderr stoch Stochastic Oscillator k per,k slowing per,d per 5,3,3 stoch_k,stoch_d stochrsi Stochastic RSI period 5 stochrsi sub Vector Subtraction sub sum Sum Over Period period 5 sum tan Vector Tangent tan tanh Vector Hyperbolic Tangent tanh tema Triple Exponential Moving Average period 5 tema todeg Vector Degree Conversion degrees torad Vector Radian Conversion radians tr True Range tr trima Triangular Moving Average period 5 trima trix Trix period 5 trix trunc Vector Truncate trunc tsf Time Series Forecast period 5 tsf typprice Typical Price typprice ultosc Ultimate Oscillator short per,med per,long per 2,3,5 ultosc var Variance Over Period period 5 var vhf Vertical Horizontal Filter period 5 vhf vidya Variable Index Dynamic Average short period,long period,alpha 2,5,.2 vidya volatility Annualized Historical Volatility period 5 volatility vosc Volume Oscillator short period,long period 2,5 vosc vwma Volume Weighted Moving Average period 5 vwma wad Williams Accumulation/Distribution wad wcprice Weighted Close Price wcprice wilders Wilders Smoothing period 5 wilders willr Williams %R period wma Weighted Moving Average period 5 wma zlema Zero-Lag Exponential Moving Average period 5 zlema
  • range (str) – Timeframe to request e.g. 1m
  • input1 (str) – input1 to technicals (see docs)
  • input2 (str) – input2 to technicals (see docs)
  • input3 (str) – input3 to technicals (see docs)
  • input4 (str) – input4 to technicals (see docs)
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

tema(symbol, timeframe='6m', col='close', periods=None)
This will return a dataframe of triple exponential moving average
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • periods (int) –
Returns:

result

Return type:

DataFrame

tenK(key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, token='', version='stable', filter='', format='json', **extra_params)

Time series is the most common type of data available, and consists of a collection of data points over a period of time. Time series data is indexed by a single date field, and can be retrieved by any portion of time.

https://iexcloud.io/docs/api/#time-series

Parameters:
  • id (str) – ID used to identify a time series dataset.
  • key (str) – Key used to identify data within a dataset. A common example is a symbol such as AAPL.
  • subkey (str) – The optional subkey can used to further refine data for a particular key if available.
  • range (str) – Returns data for a given range. Supported ranges described below.
  • calendar (bool) – Used in conjunction with range to return data in the future.
  • limit (int) – Limits the number of results returned. Defaults to 1.
  • subattribute (str) – Allows you to query time series by any field in the result set. All time series data is stored by ID, then key, then subkey. If you want to query by any other field in the data, you can use subattribute. For example, news may be stored as /news/{symbol}/{newsId}, and the result data returns the keys id, symbol, date, sector, hasPaywall By default you can only query by symbol or id. Maybe you want to query all news where the sector is Technology. Your query would be: /time-series/news?subattribute=source|WSJ The syntax is subattribute={keyName}|{value}. Both the key name and the value are case sensitive. A pipe symbol is used to represent ‘equal to’.
  • dateField (str or datetime) – All time series data is stored by a single date field, and that field is used for any range or date parameters. You may want to query time series data by a different date in the result set. To change the date field used by range queries, pass the case sensitive field name with this parameter. For example, corporate buy back data may be stored by announce date, but also contains an end date which you’d rather query by. To query by end date you would use dateField=endDate&range=last-week
  • from (str or datetime) – Returns data on or after the given from date. Format YYYY-MM-DD
  • to (str or datetime) – Returns data on or before the given to date. Format YYYY-MM-DD
  • on (str or datetime) – Returns data on the given date. Format YYYY-MM-DD
  • last (int) – Returns the latest n number of records in the series
  • first (int) – Returns the first n number of records in the series
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

Date Ranges:
today Returns data for today
yesterday Returns data for yesterday
ytd Returns data for the current year
last-week Returns data for Sunday-Saturday last week
last-month Returns data for the last month
last-quarter Returns data for the last quarter
d Use the short hand d to return a number of days. Example: 2d returns 2 days. If calendar=true, data is returned from today forward.
w Use the short hand w to return a number of weeks. Example: 2w returns 2 weeks. If calendar=true, data is returned from today forward.
m Use the short hand m to return a number of months. Example: 2m returns 2 months. If calendar=true, data is returned from today forward.
q Use the short hand q to return a number of quarters. Example: 2q returns 2 quarters. If calendar=true, data is returned from today forward.
y Use the short hand y to return a number of years. Example: 2y returns 2 years. If calendar=true, data is returned from today forward.
tomorrow Calendar data for tomorrow. Requires calendar=true
this-week Calendar data for Sunday-Saturday this week. Requires calendar=true
this-month Calendar data for current month. Requires calendar=true
this-quarter Calendar data for current quarter. Requires calendar=true
next-week Calendar data for Sunday-Saturday next week. Requires calendar=true
next-month Calendar data for next month. Requires calendar=true
next-quarter Calendar data for next quarter. Requires calendar=true
tenQ(key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, token='', version='stable', filter='', format='json', **extra_params)

Time series is the most common type of data available, and consists of a collection of data points over a period of time. Time series data is indexed by a single date field, and can be retrieved by any portion of time.

https://iexcloud.io/docs/api/#time-series

Parameters:
  • id (str) – ID used to identify a time series dataset.
  • key (str) – Key used to identify data within a dataset. A common example is a symbol such as AAPL.
  • subkey (str) – The optional subkey can used to further refine data for a particular key if available.
  • range (str) – Returns data for a given range. Supported ranges described below.
  • calendar (bool) – Used in conjunction with range to return data in the future.
  • limit (int) – Limits the number of results returned. Defaults to 1.
  • subattribute (str) – Allows you to query time series by any field in the result set. All time series data is stored by ID, then key, then subkey. If you want to query by any other field in the data, you can use subattribute. For example, news may be stored as /news/{symbol}/{newsId}, and the result data returns the keys id, symbol, date, sector, hasPaywall By default you can only query by symbol or id. Maybe you want to query all news where the sector is Technology. Your query would be: /time-series/news?subattribute=source|WSJ The syntax is subattribute={keyName}|{value}. Both the key name and the value are case sensitive. A pipe symbol is used to represent ‘equal to’.
  • dateField (str or datetime) – All time series data is stored by a single date field, and that field is used for any range or date parameters. You may want to query time series data by a different date in the result set. To change the date field used by range queries, pass the case sensitive field name with this parameter. For example, corporate buy back data may be stored by announce date, but also contains an end date which you’d rather query by. To query by end date you would use dateField=endDate&range=last-week
  • from (str or datetime) – Returns data on or after the given from date. Format YYYY-MM-DD
  • to (str or datetime) – Returns data on or before the given to date. Format YYYY-MM-DD
  • on (str or datetime) – Returns data on the given date. Format YYYY-MM-DD
  • last (int) – Returns the latest n number of records in the series
  • first (int) – Returns the first n number of records in the series
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

Date Ranges:
today Returns data for today
yesterday Returns data for yesterday
ytd Returns data for the current year
last-week Returns data for Sunday-Saturday last week
last-month Returns data for the last month
last-quarter Returns data for the last quarter
d Use the short hand d to return a number of days. Example: 2d returns 2 days. If calendar=true, data is returned from today forward.
w Use the short hand w to return a number of weeks. Example: 2w returns 2 weeks. If calendar=true, data is returned from today forward.
m Use the short hand m to return a number of months. Example: 2m returns 2 months. If calendar=true, data is returned from today forward.
q Use the short hand q to return a number of quarters. Example: 2q returns 2 quarters. If calendar=true, data is returned from today forward.
y Use the short hand y to return a number of years. Example: 2y returns 2 years. If calendar=true, data is returned from today forward.
tomorrow Calendar data for tomorrow. Requires calendar=true
this-week Calendar data for Sunday-Saturday this week. Requires calendar=true
this-month Calendar data for current month. Requires calendar=true
this-quarter Calendar data for current quarter. Requires calendar=true
next-week Calendar data for Sunday-Saturday next week. Requires calendar=true
next-month Calendar data for next month. Requires calendar=true
next-quarter Calendar data for next quarter. Requires calendar=true
tenYear = functools.partial(<function Client.bind>, meth=<function points>, key='DGS10')
thirtyYear = functools.partial(<function Client.bind>, meth=<function points>, key='DGS30')
threeMonth = functools.partial(<function Client.bind>, meth=<function points>, key='DGS3MO')
threshold(token='', version='stable', filter='', format='json')

The following are IEX-listed securities that have an aggregate fail to deliver position for five consecutive settlement days at a registered clearing agency, totaling 10,000 shares or more and equal to at least 0.5% of the issuer’s total shares outstanding (i.e., “threshold securities”). The report data will be published to the IEX website daily at 8:30 p.m. ET with data for that trading day.

https://iexcloud.io/docs/api/#listed-regulation-sho-threshold-securities-list-in-dev

Parameters:
Returns:

result

Return type:

dict or DataFrame

thresholdDF(token='', version='stable', filter='', format='json')

The following are IEX-listed securities that have an aggregate fail to deliver position for five consecutive settlement days at a registered clearing agency, totaling 10,000 shares or more and equal to at least 0.5% of the issuer’s total shares outstanding (i.e., “threshold securities”). The report data will be published to the IEX website daily at 8:30 p.m. ET with data for that trading day.

https://iexcloud.io/docs/api/#listed-regulation-sho-threshold-securities-list-in-dev

Parameters:
Returns:

result

Return type:

dict or DataFrame

timeSeries(key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, token='', version='stable', filter='', format='json', **extra_params)

Time series is the most common type of data available, and consists of a collection of data points over a period of time. Time series data is indexed by a single date field, and can be retrieved by any portion of time.

https://iexcloud.io/docs/api/#time-series

Parameters:
  • id (str) – ID used to identify a time series dataset.
  • key (str) – Key used to identify data within a dataset. A common example is a symbol such as AAPL.
  • subkey (str) – The optional subkey can used to further refine data for a particular key if available.
  • range (str) – Returns data for a given range. Supported ranges described below.
  • calendar (bool) – Used in conjunction with range to return data in the future.
  • limit (int) – Limits the number of results returned. Defaults to 1.
  • subattribute (str) – Allows you to query time series by any field in the result set. All time series data is stored by ID, then key, then subkey. If you want to query by any other field in the data, you can use subattribute. For example, news may be stored as /news/{symbol}/{newsId}, and the result data returns the keys id, symbol, date, sector, hasPaywall By default you can only query by symbol or id. Maybe you want to query all news where the sector is Technology. Your query would be: /time-series/news?subattribute=source|WSJ The syntax is subattribute={keyName}|{value}. Both the key name and the value are case sensitive. A pipe symbol is used to represent ‘equal to’.
  • dateField (str or datetime) – All time series data is stored by a single date field, and that field is used for any range or date parameters. You may want to query time series data by a different date in the result set. To change the date field used by range queries, pass the case sensitive field name with this parameter. For example, corporate buy back data may be stored by announce date, but also contains an end date which you’d rather query by. To query by end date you would use dateField=endDate&range=last-week
  • from (str or datetime) – Returns data on or after the given from date. Format YYYY-MM-DD
  • to (str or datetime) – Returns data on or before the given to date. Format YYYY-MM-DD
  • on (str or datetime) – Returns data on the given date. Format YYYY-MM-DD
  • last (int) – Returns the latest n number of records in the series
  • first (int) – Returns the first n number of records in the series
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

Date Ranges:
today Returns data for today
yesterday Returns data for yesterday
ytd Returns data for the current year
last-week Returns data for Sunday-Saturday last week
last-month Returns data for the last month
last-quarter Returns data for the last quarter
d Use the short hand d to return a number of days. Example: 2d returns 2 days. If calendar=true, data is returned from today forward.
w Use the short hand w to return a number of weeks. Example: 2w returns 2 weeks. If calendar=true, data is returned from today forward.
m Use the short hand m to return a number of months. Example: 2m returns 2 months. If calendar=true, data is returned from today forward.
q Use the short hand q to return a number of quarters. Example: 2q returns 2 quarters. If calendar=true, data is returned from today forward.
y Use the short hand y to return a number of years. Example: 2y returns 2 years. If calendar=true, data is returned from today forward.
tomorrow Calendar data for tomorrow. Requires calendar=true
this-week Calendar data for Sunday-Saturday this week. Requires calendar=true
this-month Calendar data for current month. Requires calendar=true
this-quarter Calendar data for current quarter. Requires calendar=true
next-week Calendar data for Sunday-Saturday next week. Requires calendar=true
next-month Calendar data for next month. Requires calendar=true
next-quarter Calendar data for next quarter. Requires calendar=true
timeSeriesDF(key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, token='', version='stable', filter='', format='json', **extra_params)

Time series is the most common type of data available, and consists of a collection of data points over a period of time. Time series data is indexed by a single date field, and can be retrieved by any portion of time.

https://iexcloud.io/docs/api/#time-series

Parameters:
  • id (str) – ID used to identify a time series dataset.
  • key (str) – Key used to identify data within a dataset. A common example is a symbol such as AAPL.
  • subkey (str) – The optional subkey can used to further refine data for a particular key if available.
  • range (str) – Returns data for a given range. Supported ranges described below.
  • calendar (bool) – Used in conjunction with range to return data in the future.
  • limit (int) – Limits the number of results returned. Defaults to 1.
  • subattribute (str) – Allows you to query time series by any field in the result set. All time series data is stored by ID, then key, then subkey. If you want to query by any other field in the data, you can use subattribute. For example, news may be stored as /news/{symbol}/{newsId}, and the result data returns the keys id, symbol, date, sector, hasPaywall By default you can only query by symbol or id. Maybe you want to query all news where the sector is Technology. Your query would be: /time-series/news?subattribute=source|WSJ The syntax is subattribute={keyName}|{value}. Both the key name and the value are case sensitive. A pipe symbol is used to represent ‘equal to’.
  • dateField (str or datetime) – All time series data is stored by a single date field, and that field is used for any range or date parameters. You may want to query time series data by a different date in the result set. To change the date field used by range queries, pass the case sensitive field name with this parameter. For example, corporate buy back data may be stored by announce date, but also contains an end date which you’d rather query by. To query by end date you would use dateField=endDate&range=last-week
  • from (str or datetime) – Returns data on or after the given from date. Format YYYY-MM-DD
  • to (str or datetime) – Returns data on or before the given to date. Format YYYY-MM-DD
  • on (str or datetime) – Returns data on the given date. Format YYYY-MM-DD
  • last (int) – Returns the latest n number of records in the series
  • first (int) – Returns the first n number of records in the series
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

Date Ranges:
today Returns data for today
yesterday Returns data for yesterday
ytd Returns data for the current year
last-week Returns data for Sunday-Saturday last week
last-month Returns data for the last month
last-quarter Returns data for the last quarter
d Use the short hand d to return a number of days. Example: 2d returns 2 days. If calendar=true, data is returned from today forward.
w Use the short hand w to return a number of weeks. Example: 2w returns 2 weeks. If calendar=true, data is returned from today forward.
m Use the short hand m to return a number of months. Example: 2m returns 2 months. If calendar=true, data is returned from today forward.
q Use the short hand q to return a number of quarters. Example: 2q returns 2 quarters. If calendar=true, data is returned from today forward.
y Use the short hand y to return a number of years. Example: 2y returns 2 years. If calendar=true, data is returned from today forward.
tomorrow Calendar data for tomorrow. Requires calendar=true
this-week Calendar data for Sunday-Saturday this week. Requires calendar=true
this-month Calendar data for current month. Requires calendar=true
this-quarter Calendar data for current quarter. Requires calendar=true
next-week Calendar data for Sunday-Saturday next week. Requires calendar=true
next-month Calendar data for next month. Requires calendar=true
next-quarter Calendar data for next quarter. Requires calendar=true
timeSeriesInventory(version='stable', filter='', format='json')

Get inventory of available time series endpoints :returns: result (dict)

timeSeriesInventoryDF(version='stable', filter='', format='json')

Get inventory of available time series endpoints :returns: result (dict)

topsSSE(on_data=None, exit=None, token='', version='stable')

TOPS provides IEX’s aggregated best quoted bid and offer position in near real time for all securities on IEX’s displayed limit order book. TOPS is ideal for developers needing both quote and trade data.

https://iexcloud.io/docs/api/#tops

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
topsSSEAsync(exit=None, token='', version='stable')

TOPS provides IEX’s aggregated best quoted bid and offer position in near real time for all securities on IEX’s displayed limit order book. TOPS is ideal for developers needing both quote and trade data.

https://iexcloud.io/docs/api/#tops

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
tradesSSE(on_data=None, exit=None, token='', version='stable')

Trade report messages are sent when an order on the IEX Order Book is executed in whole or in part. DEEP sends a Trade report message for every individual fill.

https://iexcloud.io/docs/api/#deep-trades

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
tradesSSEAsync(exit=None, token='', version='stable')

Trade report messages are sent when an order on the IEX Order Book is executed in whole or in part. DEEP sends a Trade report message for every individual fill.

https://iexcloud.io/docs/api/#deep-trades

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
trange(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of true range for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

trima(symbol, timeframe='6m', col='close', periods=None)
This will return a dataframe of triangular moving average
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • periods (int) –
Returns:

result

Return type:

DataFrame

trix(symbol, timeframe='6m', col='close', period=14)

This will return a dataframe of 1-day Rate-Of-Change(ROC) of a Triple Smooth EMA for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • col (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

tsf(symbol, timeframe='6m', closecol='close', period=14, nbdev=1)

This will return a dataframe of standard deviation for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate adx across
Returns:

result

Return type:

DataFrame

twentyYear = functools.partial(<function Client.bind>, meth=<function points>, key='DGS20')
twoYear = functools.partial(<function Client.bind>, meth=<function points>, key='DGS2')
typprice(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of typical price for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

ultosc(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', period1=7, period2=14, period3=28)

This will return a dataframe of Ultimate Oscillator for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period1 (int) – period to calculate across
  • period2 (int) – period to calculate across
  • period3 (int) – period to calculate across
Returns:

result

Return type:

DataFrame

unemployment = functools.partial(<function Client.bind>, meth=<function points>, key='UNRATE')
upcomingDividends(refid='', token='', version='stable', filter='', format='json')

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

https://iexcloud.io/docs/api/#upcoming-events

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

upcomingDividendsDF(refid='', token='', version='stable', filter='', format='json')

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

https://iexcloud.io/docs/api/#upcoming-events

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

upcomingEarnings(refid='', token='', version='stable', filter='', format='json')

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

https://iexcloud.io/docs/api/#upcoming-events

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

upcomingEarningsDF(refid='', token='', version='stable', filter='', format='json')

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

https://iexcloud.io/docs/api/#upcoming-events

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

upcomingEvents(refid='', token='', version='stable', filter='', format='json')

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

https://iexcloud.io/docs/api/#upcoming-events

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

upcomingEventsDF(refid='', token='', version='stable', filter='', format='json')

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

https://iexcloud.io/docs/api/#upcoming-events

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

upcomingIPOs(refid='', token='', version='stable', filter='', format='json')

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

https://iexcloud.io/docs/api/#upcoming-events

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

upcomingIPOsDF(refid='', token='', version='stable', filter='', format='json')

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

https://iexcloud.io/docs/api/#upcoming-events

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

upcomingSplits(refid='', token='', version='stable', filter='', format='json')

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

https://iexcloud.io/docs/api/#upcoming-events

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

upcomingSplitsDF(refid='', token='', version='stable', filter='', format='json')

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

https://iexcloud.io/docs/api/#upcoming-events

Parameters:
  • symbol (str) – Symbol to look up
  • refid (str) – Optional. Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.
  • token (str) – Access token
  • version (str) – API version
  • filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

us15 = functools.partial(<function Client.bind>, meth=<function points>, key='MORTGAGE15US')
us30 = functools.partial(<function Client.bind>, meth=<function points>, key='MORTGAGE30US')
us5 = functools.partial(<function Client.bind>, meth=<function points>, key='MORTGAGE5US')
usage(token='', version='stable', format='json')

Used to retrieve current month usage for your account.

https://iexcloud.io/docs/api/#usage

Parameters:
  • type (Optional[string]) – Used to specify which quota to return. Ex: messages, rules, rule-records, alerts, alert-records
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

usageDF(token='', version='stable', format='json')

Used to retrieve current month usage for your account.

https://iexcloud.io/docs/api/#usage

Parameters:
  • type (Optional[string]) – Used to specify which quota to return. Ex: messages, rules, rule-records, alerts, alert-records
  • token (str) – Access token
  • version (str) – API version
  • format (str) – return format, defaults to json
Returns:

result

Return type:

dict or DataFrame

var(symbol, timeframe='6m', closecol='close', period=14, nbdev=1)

This will return a dataframe of var for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate adx across
  • nbdev (int) –
Returns:

result

Return type:

DataFrame

vehicles = functools.partial(<function Client.bind>, meth=<function points>, key='TOTALSA')
volumeByVenue(token='', version='stable', filter='', format='json')

This returns 15 minute delayed and 30 day average consolidated volume percentage of a stock, by market. This call will always return 13 values, and will be sorted in ascending order by current day trading volume percentage.

https://iexcloud.io/docs/api/#volume-by-venue Updated during regular market hours 9:30am-4pm ET

Parameters:
Returns:

result

Return type:

dict or DataFrame

volumeByVenueDF(token='', version='stable', filter='', format='json')

This returns 15 minute delayed and 30 day average consolidated volume percentage of a stock, by market. This call will always return 13 values, and will be sorted in ascending order by current day trading volume percentage.

https://iexcloud.io/docs/api/#volume-by-venue Updated during regular market hours 9:30am-4pm ET

Parameters:
Returns:

result

Return type:

dict or DataFrame

wclprice(symbol, timeframe='6m', opencol='open', highcol='high', lowcol='low', closecol='close')

This will return a dataframe of weighted close price for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
Returns:

result

Return type:

DataFrame

willr(symbol, timeframe='6m', highcol='high', lowcol='low', closecol='close', period=14)

This will return a dataframe of Williams’ % R for the given symbol across the given timeframe

Parameters:
  • client (pyEX.Client) – Client
  • symbol (string) – Ticker
  • timeframe (string) – timeframe to use, for pyEX.chart
  • highcol (string) – column to use to calculate
  • lowcol (string) – column to use to calculate
  • closecol (string) – column to use to calculate
  • period (int) – period to calculate across
Returns:

result

Return type:

DataFrame

wma(symbol, timeframe='6m', col='close', periods=None)
This will return a dataframe of weighted moving average
for the given symbol across the given timeframe
Parameters:
  • client (pyEX.Client) –
  • symbol (string) –
  • timeframe (string) –
  • col (string) –
  • periods (int) –
Returns:

result

Return type:

DataFrame

wti = functools.partial(<function Client.bind>, meth=<function points>, key='DCOILWTICO')
yesterday(token='', version='stable', filter='', format='json')

This returns previous day adjusted price data for one or more stocks

https://iexcloud.io/docs/api/#previous-day-prices Available after 4am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame

yesterdayDF(token='', version='stable', filter='', format='json')

This returns previous day adjusted price data for one or more stocks

https://iexcloud.io/docs/api/#previous-day-prices Available after 4am ET Tue-Sat

Parameters:
Returns:

result

Return type:

dict or DataFrame