Premium

exception pyEX.premium.PyEXception[source]
pyEX.premium.accountingQualityAndRiskMatrixAuditAnalytics(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.accountingQualityAndRiskMatrixAuditAnalyticsDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.analystDaysWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.analystDaysWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.analystRecommendationsAndPriceTargetsInvisage(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.analystRecommendationsAndPriceTargetsInvisageDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.analystRecommendationsRefinitiv(symbol, 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

pyEX.premium.analystRecommendationsRefinitivDF(symbol, 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

pyEX.premium.boardOfDirectorsMeetingWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.boardOfDirectorsMeetingWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.businessUpdatesWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.businessUpdatesWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.buybacksWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.buybacksWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.cam1ExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.cam1ExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.capitalMarketsDayWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.capitalMarketsDayWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.companyTravelWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.companyTravelWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.directorAndOfficerChangesAuditAnalytics(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.directorAndOfficerChangesAuditAnalyticsDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.download(id, symbol, date, token='', version='stable')[source]

The Files API allows users to download bulk data files, PDFs, etc.

Example: c.download(‘VALUENGINE_REPORT’, ‘AAPL’, ‘20200804’)

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

Parameters:
  • id (str) – report ID
  • symbol (str) – symbol to use
  • date (str) – date of report to use
pyEX.premium.downloadReportNewConstructs(symbol='', date=None, token='', version='stable')[source]

Powered by the best fundamental data in the world, New Constructs’ research provides unrivalled insights into the profitability and valuation of public and private companies.Our risk/reward ratings empower clients to make more informed investing decisions based on true, not reported or distorted, earnings. Research reports for 3,000+ stocks, 400+ ETFs, and 7,000+ mutual funds. https://iexcloud.io/docs/api/#new-constructs-report

Parameters:
  • symbol (str) – symbol to use
  • date (str) – date to access
pyEX.premium.downloadStockResearchReportValuEngine(symbol='', date=None, token='', version='stable')[source]

ValuEngine provides research on over 5,000 stocks with stock valuations, Buy/Hold/Sell recommendations, and forecasted target prices, so that you the individual investor can make informed decisions. Every ValuEngine Valuation and Forecast model for the U.S. equities markets has been extensively back-tested. ValuEngine’s performance exceeds that of many well-known stock-picking styles. Reports available since March 19th, 2020. https://iexcloud.io/docs/api/#valuengine-stock-research-report

Parameters:
  • symbol (str) – symbol to use
  • date (str) – date to access
pyEX.premium.earningsRefinitiv(symbol, 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

pyEX.premium.earningsRefinitivDF(symbol, 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

pyEX.premium.esgCFPBComplaintsExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgCFPBComplaintsExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgCPSCRecallsExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgCPSCRecallsExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgDOLVisaApplicationsExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgDOLVisaApplicationsExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgEPAEnforcementsExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgEPAEnforcementsExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgEPAMilestonesExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgEPAMilestonesExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgFECIndividualCampaingContributionsExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgFECIndividualCampaingContributionsExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgOSHAInspectionsExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgOSHAInspectionsExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgSenateLobbyingExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgSenateLobbyingExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgUSASpendingExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgUSASpendingExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgUSPTOPatentApplicationsExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgUSPTOPatentApplicationsExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgUSPTOPatentGrantsExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.esgUSPTOPatentGrantsExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.estimatesRefinitiv(symbol, 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

pyEX.premium.estimatesRefinitivDF(symbol, 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

pyEX.premium.fdaAdvisoryCommitteeMeetingsWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.fdaAdvisoryCommitteeMeetingsWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.files(id='', symbol='', date=None, token='', version='stable')[source]

The Files API allows users to download bulk data files, PDFs, etc.

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

Parameters:
  • id (str) – report ID
  • symbol (str) – symbol to use
  • date (str) – date of report to use
pyEX.premium.filingDueDatesWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.filingDueDatesWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.fiscalQuarterEndWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.fiscalQuarterEndWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.fiveDayMLReturnRankingBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.fiveDayMLReturnRankingBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.forumWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.forumWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.generalConferenceWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.generalConferenceWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.holidaysWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.holidaysWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.indexChangesWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.indexChangesWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.iposWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.iposWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.kScoreChinaKavout(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.kScoreChinaKavoutDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.kScoreKavout(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.kScoreKavoutDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.languageMetricsOnCompanyFilingsAllBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.languageMetricsOnCompanyFilingsAllBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.languageMetricsOnCompanyFilingsBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.languageMetricsOnCompanyFilingsBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.languageMetricsOnCompanyFilingsDifferenceAllBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.languageMetricsOnCompanyFilingsDifferenceAllBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.languageMetricsOnCompanyFilingsDifferenceBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.languageMetricsOnCompanyFilingsDifferenceBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.legalActionsWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.legalActionsWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.mergersAndAcquisitionsWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.mergersAndAcquisitionsWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.newsCityFalcon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.newsCityFalconDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.nonTimelyFilingsFraudFactors(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.nonTimelyFilingsFraudFactorsDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.priceDynamicsPrecisionAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.priceDynamicsPrecisionAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.priceTargetRefinitiv(symbol, 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

pyEX.premium.priceTargetRefinitivDF(symbol, 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

pyEX.premium.productEventsWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.productEventsWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.reportNewConstructs(symbol='', date=None, token='', version='stable')[source]

Powered by the best fundamental data in the world, New Constructs’ research provides unrivalled insights into the profitability and valuation of public and private companies.Our risk/reward ratings empower clients to make more informed investing decisions based on true, not reported or distorted, earnings. Research reports for 3,000+ stocks, 400+ ETFs, and 7,000+ mutual funds. https://iexcloud.io/docs/api/#new-constructs-report

Parameters:
  • symbol (str) – symbol to use
  • date (str) – date to access
pyEX.premium.researchAndDevelopmentDaysWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.researchAndDevelopmentDaysWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.sameStoreSalesWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.sameStoreSalesWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.secondaryOfferingsWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.secondaryOfferingsWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.seminarsWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.seminarsWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.sevenDaySentimentBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.sevenDaySentimentBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.shareholderMeetingsWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.shareholderMeetingsWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.socialSentimentStockTwits(symbol, type='daily', date='', token='', version='stable', filter='', format='json')[source]

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

Parameters:
  • symbol (str) – Symbol to look up
  • type (Optional[str]) – Can only be daily or minute. Default is daily.
  • 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

pyEX.premium.socialSentimentStockTwitsDF(symbol, type='daily', date='', token='', version='stable', filter='', format='json')[source]

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

Parameters:
  • symbol (str) – Symbol to look up
  • type (Optional[str]) – Can only be daily or minute. Default is daily.
  • 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

pyEX.premium.stockResearchReportValuEngine(symbol='', date=None, token='', version='stable')[source]

ValuEngine provides research on over 5,000 stocks with stock valuations, Buy/Hold/Sell recommendations, and forecasted target prices, so that you the individual investor can make informed decisions. Every ValuEngine Valuation and Forecast model for the U.S. equities markets has been extensively back-tested. ValuEngine’s performance exceeds that of many well-known stock-picking styles. Reports available since March 19th, 2020. https://iexcloud.io/docs/api/#valuengine-stock-research-report

Parameters:
  • symbol (str) – symbol to use
  • date (str) – date to access
pyEX.premium.summitMeetingsWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.summitMeetingsWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.tacticalModel1ExtractAlpha(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.tacticalModel1ExtractAlphaDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.tenDayMLReturnRankingBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.tenDayMLReturnRankingBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.thirtyDaySentimentBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.thirtyDaySentimentBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.threeDayMLReturnRankingBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.threeDayMLReturnRankingBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.timeSeries(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **extra_params)[source]

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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.timeSeriesDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **extra_params)[source]

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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.tradeShowsWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.tradeShowsWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.twentyOneDayMLReturnRankingBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.twentyOneDayMLReturnRankingBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.twoDayMLReturnRankingBrain(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.twoDayMLReturnRankingBrainDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.witchingHoursWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.witchingHoursWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.workshopsWallStreetHorizon(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.workshopsWallStreetHorizonDF(id='', key='', subkey='', range=None, calendar=False, limit=1, subattribute='', dateField=None, from_=None, to_=None, on=None, last=0, first=0, sort='', interval=None, token='', version='stable', filter='', format='json', overrideBase='', **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,list) – 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} or {keyName}~{value}. Both the key name and the value are case sensitive. A pipe symbol | is used to represent ‘equal to’ and the tilde ~ is used to represent “not 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
  • sort (str) – Order of results
  • interval (int) – interval to use
  • 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
pyEX.premium.wraps(wrapped, assigned=('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'), updated=('__dict__', ))[source]

Decorator factory to apply update_wrapper() to a wrapper function

Returns a decorator that invokes update_wrapper() with the decorated function as the wrapper argument and the arguments to wraps() as the remaining arguments. Default arguments are as for update_wrapper(). This is a convenience function to simplify applying partial() to update_wrapper().