@@ -53,12 +53,17 @@ def DataReader(name, data_source=None, start=None, end=None,
53
53
name : str or list of strs
54
54
the name of the dataset. Some data sources (yahoo, google, fred) will
55
55
accept a list of names.
56
- data_source: str
56
+ data_source: str, default: None
57
57
the data source ("yahoo", "google", "fred", or "ff")
58
- start : { datetime, None}
58
+ start : datetime, default: None
59
59
left boundary for range (defaults to 1/1/2010)
60
- end : { datetime, None}
60
+ end : datetime, default: None
61
61
right boundary for range (defaults to today)
62
+ retry_count : int, default 3
63
+ Number of times to retry query request.
64
+ pause : numeric, default 0.001
65
+ Time, in seconds, to pause between consecutive queries of chunks. If
66
+ single value given for symbol, represents the pause between retries.
62
67
63
68
Examples
64
69
----------
@@ -398,28 +403,28 @@ def get_data_yahoo(symbols=None, start=None, end=None, retry_count=3,
398
403
399
404
Parameters
400
405
----------
401
- symbols : string, array-like object (list, tuple, Series), or DataFrame
406
+ symbols : string, array-like object (list, tuple, Series), or DataFrame, default: None
402
407
Single stock symbol (ticker), array-like object of symbols or
403
- DataFrame with index containing stock symbols.
408
+ DataFrame with index containing stock symbols
404
409
start : string, (defaults to '1/1/2010')
405
410
Starting date, timestamp. Parses many different kind of date
406
411
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980')
407
412
end : string, (defaults to today)
408
413
Ending date, timestamp. Same format as starting date.
409
- retry_count : int, default 3
414
+ retry_count : int, default: 3
410
415
Number of times to retry query request.
411
- pause : int , default 0
416
+ pause : numeric , default: 0.001
412
417
Time, in seconds, to pause between consecutive queries of chunks. If
413
418
single value given for symbol, represents the pause between retries.
414
- adjust_price : bool, default False
419
+ adjust_price : bool, default: False
415
420
If True, adjusts all prices in hist_data ('Open', 'High', 'Low',
416
421
'Close') based on 'Adj Close' price. Adds 'Adj_Ratio' column and drops
417
422
'Adj Close'.
418
- ret_index : bool, default False
423
+ ret_index : bool, default: False
419
424
If True, includes a simple return index 'Ret_Index' in hist_data.
420
- chunksize : int, default 25
425
+ chunksize : int, default: 25
421
426
Number of symbols to download consecutively before intiating pause.
422
- interval : string, default 'd'
427
+ interval : string, default: 'd'
423
428
Time interval code, valid values are 'd' for daily, 'w' for weekly,
424
429
'm' for monthly and 'v' for dividend.
425
430
@@ -451,13 +456,15 @@ def get_data_google(symbols=None, start=None, end=None, retry_count=3,
451
456
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980')
452
457
end : string, (defaults to today)
453
458
Ending date, timestamp. Same format as starting date.
454
- retry_count : int, default 3
459
+ retry_count : int, default: 3
455
460
Number of times to retry query request.
456
- pause : int , default 0
461
+ pause : numeric , default: 0.001
457
462
Time, in seconds, to pause between consecutive queries of chunks. If
458
463
single value given for symbol, represents the pause between retries.
459
- chunksize : int, default 25
464
+ chunksize : int, default: 25
460
465
Number of symbols to download consecutively before intiating pause.
466
+ ret_index : bool, default: False
467
+ If True, includes a simple return index 'Ret_Index' in hist_data.
461
468
462
469
Returns
463
470
-------
@@ -903,10 +910,10 @@ def get_near_stock_price(self, above_below=2, call=True, put=False,
903
910
The number of strike prices above and below the stock price that
904
911
should be taken
905
912
906
- call : bool
913
+ call : bool, default: True
907
914
Tells the function whether or not it should be using calls
908
915
909
- put : bool
916
+ put : bool, default: False
910
917
Tells the function weather or not it should be using puts
911
918
912
919
month : number, int, optional(default=None)
0 commit comments