@@ -94,11 +94,11 @@ def get_markets_iex(*args, **kwargs):
94
94
"""
95
95
Returns near-real time volume data across markets segregated by tape
96
96
and including a percentage of overall volume during the session
97
-
97
+
98
98
This endpoint does not accept any parameters.
99
-
99
+
100
100
Reference: https://www.iextrading.com/developer/docs/#markets
101
-
101
+
102
102
:return: DataFrame
103
103
"""
104
104
from pandas_datareader .iex .market import MarketReader
@@ -109,14 +109,14 @@ def get_dailysummary_iex(*args, **kwargs):
109
109
"""
110
110
Returns a summary of daily market volume statistics. Without parameters,
111
111
this will return the most recent trading session by default.
112
-
113
- :param start:
112
+
113
+ :param start:
114
114
A datetime object - the beginning of the date range.
115
115
:param end:
116
116
A datetime object - the end of the date range.
117
-
117
+
118
118
Reference: https://www.iextrading.com/developer/docs/#historical-daily
119
-
119
+
120
120
:return: DataFrame
121
121
"""
122
122
from pandas_datareader .iex .stats import DailySummaryReader
@@ -125,16 +125,16 @@ def get_dailysummary_iex(*args, **kwargs):
125
125
126
126
def get_summary_iex (* args , ** kwargs ):
127
127
"""
128
- Returns an aggregated monthly summary of market volume and a variety of
128
+ Returns an aggregated monthly summary of market volume and a variety of
129
129
related metrics for trades by lot size, security market cap, and venue.
130
130
In the absence of parameters, this will return month-to-date statistics.
131
131
For ranges spanning multiple months, this will return one row per month.
132
-
133
- :param start:
132
+
133
+ :param start:
134
134
A datetime object - the beginning of the date range.
135
135
:param end:
136
136
A datetime object - the end of the date range.
137
-
137
+
138
138
:return: DataFrame
139
139
"""
140
140
from pandas_datareader .iex .stats import MonthlySummaryReader
@@ -146,9 +146,9 @@ def get_records_iex(*args, **kwargs):
146
146
Returns the record value, record date, recent value, and 30-day average for
147
147
market volume, # of symbols traded, # of routed trades and notional value.
148
148
This function accepts no additional parameters.
149
-
149
+
150
150
Reference: https://www.iextrading.com/developer/docs/#records
151
-
151
+
152
152
:return: DataFrame
153
153
"""
154
154
from pandas_datareader .iex .stats import RecordsReader
@@ -160,9 +160,9 @@ def get_recent_iex(*args, **kwargs):
160
160
Returns market volume and trade routing statistics for recent sessions.
161
161
Also reports IEX's relative market share, lit share volume and a boolean
162
162
halfday indicator.
163
-
163
+
164
164
Reference: https://www.iextrading.com/developer/docs/#recent
165
-
165
+
166
166
:return: DataFrame
167
167
"""
168
168
from pandas_datareader .iex .stats import RecentReader
@@ -173,9 +173,9 @@ def get_iex_symbols(*args, **kwargs):
173
173
"""
174
174
Returns a list of all equity symbols available for trading on IEX. Accepts
175
175
no additional parameters.
176
-
176
+
177
177
Reference: https://www.iextrading.com/developer/docs/#symbols
178
-
178
+
179
179
:return: DataFrame
180
180
"""
181
181
from pandas_datareader .iex .ref import SymbolsReader
@@ -186,7 +186,7 @@ def get_iex_book(*args, **kwargs):
186
186
"""
187
187
Returns an array of dictionaries with depth of book data from IEX for up to
188
188
10 securities at a time. Returns a dictionary of the bid and ask books.
189
-
189
+
190
190
:param symbols:
191
191
A string or list of strings of valid tickers
192
192
:param service:
@@ -198,7 +198,7 @@ def get_iex_book(*args, **kwargs):
198
198
'trades': Retrieves recent executions, trade size/price and flags
199
199
'trade-breaks': Lists execution breaks for the current trading session
200
200
'trading-status': Returns status and cause codes for securities
201
-
201
+
202
202
:return: Object
203
203
"""
204
204
from pandas_datareader .iex .deep import Deep
@@ -234,7 +234,7 @@ def DataReader(name, data_source=None, start=None, end=None,
234
234
requests.sessions.Session instance to be used
235
235
access_key : (str, None)
236
236
Optional parameter to specify an API key for certain data sources.
237
-
237
+
238
238
Examples
239
239
----------
240
240
@@ -247,14 +247,14 @@ def DataReader(name, data_source=None, start=None, end=None,
247
247
248
248
# Data from Google Finance
249
249
aapl = DataReader("AAPL", "google")
250
-
250
+
251
251
# Price and volume data from IEX
252
252
tops = DataReader(["GS", "AAPL"], "iex-tops")
253
253
# Top of book executions from IEX
254
254
gs = DataReader("GS", "iex-last")
255
255
# Real-time depth of book data from IEX
256
256
gs = DataReader("GS", "iex-book")
257
-
257
+
258
258
# Data from FRED
259
259
vix = DataReader("VIXCLS", "fred")
260
260
0 commit comments