Data APIs¶
IEX Cloud data can be organized into three generic data APIs: time-series, data-tables, and data-points. Each API type is self describing and the docs can be accessed without an API token.
Data Points¶
Data points are available per symbol and return individual plain text values. Retrieving individual data points is useful for Excel and Google Sheet users, and applications where a single, lightweight value is needed. We also provide update times for some endpoints which allow you to call an endpoint only once it has new data.
Full access to the Data Points endpoints is available through the
get_data_points function.
-
iexfinance.data_apis.get_data_points(symbol, key=None, **kwargs)¶ Retrieves a list of data point for a symbol (if no additional parameters are passed) or a data point for a given symbol and data point key
Reference: https://iexcloud.io/docs/api/#data-apis
Data Weighting: Free for list, varies for others
Parameters: - symbol (str) – A valid symbol
- key (str, optional) – Data point key to retrieve
Available Data Points For a Symbol¶
To obtain all available data points for a symbol, simply pass the symbol to
get_data_points with no key:
In [1]: from iexfinance.data_apis import get_data_points
In [2]: get_data_points("AAPL").head()
Out[2]:
ACCOUNTSPAYABLE ADDRESS \
description Balance Sheet: accountsPayable address
key ACCOUNTSPAYABLE ADDRESS
lastUpdated 2019-06-19T08:06:20+00:00 2019-06-19T20:36:05+00:00
weight 3000 1
AVG10VOLUME AVG30VOLUME \
description avg10Volume avg30Volume
key AVG10VOLUME AVG30VOLUME
lastUpdated 2019-06-19T20:36:05+00:00 2019-06-19T20:36:05+00:00
weight 1 1
BETA CAPITALEXPENDITURES \
description beta Cash Flow: capitalExpenditures
key BETA CAPITALEXPENDITURES
lastUpdated 2019-06-19T20:40:15+00:00 2019-06-19T08:06:20+00:00
weight 1 1000
CAPITALSURPLUS CASHCHANGE \
description Balance Sheet: capitalSurplus Cash Flow: cashChange
key CAPITALSURPLUS CASHCHANGE
lastUpdated 2019-06-19T08:06:20+00:00 2019-06-19T08:06:20+00:00
weight 3000 1000
CASHFLOW CASHFLOWFINANCING \
description Cash Flow: cashFlow Cash Flow: cashFlowFinancing
key CASHFLOW CASHFLOWFINANCING
lastUpdated 2019-06-19T08:06:20+00:00 2019-06-19T08:06:20+00:00
weight 1000 1000
... TOTALLIABILITIES \
description ... Balance Sheet: totalLiabilities
key ... TOTALLIABILITIES
lastUpdated ... 2019-06-19T08:06:20+00:00
weight ... 3000
TOTALREVENUE TREASURYSTOCK \
description totalRevenue Balance Sheet: treasuryStock
key TOTALREVENUE TREASURYSTOCK
lastUpdated 2019-06-19T20:40:15+00:00 2019-06-19T08:06:20+00:00
weight 500 3000
TTMDIVIDENDRATE TTMEPS \
description ttmDividendRate ttmEPS
key TTMDIVIDENDRATE TTMEPS
lastUpdated 2019-06-19T20:36:05+00:00 2019-06-19T20:36:05+00:00
weight 1 1
WEBSITE WEEK52CHANGE \
description website week52change
key WEBSITE WEEK52CHANGE
lastUpdated 2019-06-19T20:36:05+00:00 2019-06-19T20:36:05+00:00
weight 1 1
WEEK52HIGH WEEK52LOW \
description week52high week52low
key WEEK52HIGH WEEK52LOW
lastUpdated 2019-06-19T20:36:05+00:00 2019-06-19T20:36:05+00:00
weight 1 1
ZIP
description zip
key ZIP
lastUpdated 2019-06-19T20:36:05+00:00
weight 1
[4 rows x 126 columns]
Individual Data Points For a Symbol¶
To obtain an individual data point for a single symbol, pass the symbol and the
data point ID to get_data_points:
Apple Inc. (AAPL) latest price
In [3]: get_data_points("AAPL", "QUOTE-LATESTPRICE")
Out[3]: 204.28
Time Series¶
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.
Full access to the Time Series endpoints is available through the
get_time_series function.
-
iexfinance.data_apis.get_time_series(id_=None, key=None, subkey=None, **kwargs)¶ Retrieves a list of time series available (if no parameters passed) or time series data for a given id, key, and subkey.
Reference: https://iexcloud.io/docs/api/#time-series
Data Weighting: Free for list, varies for others
Parameters: - id (str, optional) – ID used to identify a time series dataset (function returns list of all available datasets if argument not passed)
- key (str, optional) – Key used to identify data within a dataset. A common example is a symbol such as AAPL
- subkey (str, optional) – The optional subkey can be used to further refine data for a particular key if available
All Available Time Series¶
To obtain a list of all available time series, simply call get_time_series
with no parameters:
In [4]: from iexfinance.data_apis import get_time_series
In [5]: get_time_series()
Out[5]:
LFTEPRSNNOIRAICDE_A
created :-2341:-6220012 090
description fanaolsntReci rpied
id LFTEPRSNNOIRAICDE_A
lastUpdated 2162:2403210-:900 -
schema {'type': 'object', 'properties': {'formFiscalY...
weight 5079
Individual Time Series¶
Whereas calling get_time_series with no parameters returns a full inventory
of time series endpoints, calling get_time_series with an individual series
ID and (optional) keys and subkeys as parameters.
For example, to obtain the REPORTED_FINANCIALS time series entry for Apple
Inc. (AAPL):
In [6]: get_time_series("REPORTED_FINANCIALS", "AAPL").head()
Out[6]:
1970-01-01 00:20:58.754236644 \
AccountsPayable NaN
AccountsPayableCurrent 5799857514
AccountsReceivableNetCurrent 3498218119
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:21:07.456098961 \
AccountsPayable NaN
AccountsPayableCurrent 5755685995
AccountsReceivableNetCurrent 3514392686
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:21:20.792602364 \
AccountsPayable 5019633570
AccountsPayableCurrent NaN
AccountsReceivableNetCurrent 2803937069
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:21:29.580582716 \
AccountsPayable NaN
AccountsPayableCurrent 6597149985
AccountsReceivableNetCurrent 3091250200
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:21:55.420633922 \
AccountsPayable NaN
AccountsPayableCurrent 5724236280
AccountsReceivableNetCurrent 2927570522
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:21:58.462385946 \
AccountsPayable NaN
AccountsPayableCurrent 12341186382
AccountsReceivableNetCurrent 5647532419
AccruedIncomeTaxesCurrent 214902309
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:22:03.708318258 \
AccountsPayable NaN
AccountsPayableCurrent 8832872216
AccountsReceivableNetCurrent 3560575457
AccruedIncomeTaxesCurrent 56184639
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:22:04.285230350 \
AccountsPayable NaN
AccountsPayableCurrent 13883408610
AccountsReceivableNetCurrent 6032235639
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:22:08.220536248 \
AccountsPayable NaN
AccountsPayableCurrent 14534318356
AccountsReceivableNetCurrent 6290696736
AccruedIncomeTaxesCurrent 159453882
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:22:44.813240805 \
AccountsPayable NaN
AccountsPayableCurrent 19112257219
AccountsReceivableNetCurrent 9328375459
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
... \
AccountsPayable ...
AccountsPayableCurrent ...
AccountsReceivableNetCurrent ...
AccruedIncomeTaxesCurrent ...
AccruedIncomeTaxesNoncurrent ...
1970-01-01 00:25:19.568703871 \
AccountsPayable NaN
AccountsPayableCurrent 27479390177
AccountsReceivableNetCurrent 12000751415
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:25:21.366128755 \
AccountsPayable NaN
AccountsPayableCurrent NaN
AccountsReceivableNetCurrent NaN
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:25:23.811773676 \
AccountsPayable NaN
AccountsPayableCurrent 50822098901
AccountsReceivableNetCurrent 18551205986
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:25:28.735085983 \
AccountsPayable NaN
AccountsPayableCurrent 32923233872
AccountsReceivableNetCurrent 12952630013
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:25:47.399899337 \
AccountsPayable NaN
AccountsPayableCurrent 39555535628
AccountsReceivableNetCurrent 14467682390
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:25:59.230982048 \
AccountsPayable NaN
AccountsPayableCurrent 29514719767
AccountsReceivableNetCurrent 11628259093
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:26:35.653365290 \
AccountsPayable NaN
AccountsPayableCurrent 35218269304
AccountsReceivableNetCurrent 14476075030
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent 35258792479
1970-01-01 00:26:44.149350437 \
AccountsPayable NaN
AccountsPayableCurrent 58294934356
AccountsReceivableNetCurrent 23719809447
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:26:45.905626672 \
AccountsPayable NaN
AccountsPayableCurrent 50032414141
AccountsReceivableNetCurrent 18532898846
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent 262864070
1970-01-01 00:26:56.146103748
AccountsPayable NaN
AccountsPayableCurrent 46411748262
AccountsReceivableNetCurrent 18210911390
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent 31201082321
[5 rows x 42 columns]
Or with a subkey:
In [7]: get_time_series("REPORTED_FINANCIALS", "AAPL", "10-Q").head()
Out[7]:
1970-01-01 00:21:25.954441497 \
AccountsPayable NaN
AccountsPayableCurrent 8836464947
AccountsReceivableNetCurrent 3591334510
AccruedIncomeTaxesCurrent 56850820
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:21:31.957305583 \
AccountsPayable NaN
AccountsPayableCurrent 6543850033
AccountsReceivableNetCurrent 3132096394
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:21:40.460211888 \
AccountsPayable NaN
AccountsPayableCurrent 5926976083
AccountsReceivableNetCurrent 3008279160
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:21:46.306937811 \
AccountsPayable 4929506427
AccountsPayableCurrent NaN
AccountsReceivableNetCurrent 2765265593
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:22:13.024051765 \
AccountsPayable NaN
AccountsPayableCurrent 14151813926
AccountsReceivableNetCurrent 5999534860
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:22:25.084201311 \
AccountsPayable NaN
AccountsPayableCurrent 14602513200
AccountsReceivableNetCurrent 6224749365
AccruedIncomeTaxesCurrent 153532041
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:22:48.463839259 \
AccountsPayable NaN
AccountsPayableCurrent 17751677843
AccountsReceivableNetCurrent 7056569610
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:22:52.536336230 \
AccountsPayable NaN
AccountsPayableCurrent 15969547065
AccountsReceivableNetCurrent 6262436103
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:22:54.833154075 \
AccountsPayable NaN
AccountsPayableCurrent 17505736638
AccountsReceivableNetCurrent 7934812275
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:22:55.357287987 \
AccountsPayable NaN
AccountsPayableCurrent 26971082426
AccountsReceivableNetCurrent 12176540895
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
... \
AccountsPayable ...
AccountsPayableCurrent ...
AccountsReceivableNetCurrent ...
AccruedIncomeTaxesCurrent ...
AccruedIncomeTaxesNoncurrent ...
1970-01-01 00:24:38.741196128 \
AccountsPayable NaN
AccountsPayableCurrent 26264117423
AccountsReceivableNetCurrent 12571065309
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:24:48.134895566 \
AccountsPayable NaN
AccountsPayableCurrent 24216907204
AccountsReceivableNetCurrent 11121968715
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:25:11.283073577 \
AccountsPayable NaN
AccountsPayableCurrent 26925069509
AccountsReceivableNetCurrent 11917578105
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:25:11.479666578 \
AccountsPayable NaN
AccountsPayableCurrent 32819519498
AccountsReceivableNetCurrent 12796313465
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:25:21.829902115 \
AccountsPayable NaN
AccountsPayableCurrent 39630827499
AccountsReceivableNetCurrent 14234715554
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:25:44.165803012 \
AccountsPayable NaN
AccountsPayableCurrent 28796526129
AccountsReceivableNetCurrent 12016393397
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:26:12.169701730 \
AccountsPayable NaN
AccountsPayableCurrent 35340780808
AccountsReceivableNetCurrent 14492154470
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent 35421215329
1970-01-01 00:26:24.645034234 \
AccountsPayable NaN
AccountsPayableCurrent NaN
AccountsReceivableNetCurrent NaN
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent NaN
1970-01-01 00:26:40.239109350 \
AccountsPayable NaN
AccountsPayableCurrent 46377513523
AccountsReceivableNetCurrent 18643985862
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent 32393434846
1970-01-01 00:26:46.465325090
AccountsPayable NaN
AccountsPayableCurrent 50749094572
AccountsReceivableNetCurrent 18314943522
AccruedIncomeTaxesCurrent NaN
AccruedIncomeTaxesNoncurrent 260323568
[5 rows x 29 columns]
Any and all series-specific parameters (such as last, to, from,
etc. should be passed as keyword arguments)
Examples¶
Last Apple Inc. Form 10-K
In [8]: get_time_series("REPORTED_FINANCIALS", "AAPL", "10-K", last=1).head()
Out[8]:
1970-01-01 00:26:00.595307515
AccountsPayableCurrent 56398680784
AccountsReceivableNetCurrent 23861731877
AccumulatedDepreciationDepletionAndAmortization... 51206905823
AccumulatedOtherComprehensiveIncomeLossNetOfTax -3536542435
AdjustmentsToAdditionalPaidInCapitalSharebasedC... 5628386426