From d549b60647694002ef0bd153e8cccb2b5927a746 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Wed, 3 Apr 2024 11:20:21 -0400 Subject: [PATCH] docs: Update example snippet (cosmetic) (#365) --- docs/GemFile.lock | 2 +- docs/_indicators/Adl.md | 2 +- docs/_indicators/Adx.md | 2 +- docs/_indicators/Alligator.md | 2 +- docs/_indicators/Alma.md | 2 +- docs/_indicators/Aroon.md | 2 +- docs/_indicators/Atr.md | 2 +- docs/_indicators/Awesome.md | 2 +- docs/_indicators/Beta.md | 4 ++-- docs/_indicators/BollingerBands.md | 2 +- docs/_indicators/Bop.md | 2 +- docs/_indicators/Cci.md | 2 +- docs/_indicators/ChaikinOsc.md | 2 +- docs/_indicators/Chandelier.md | 2 +- docs/_indicators/Chop.md | 2 +- docs/_indicators/Cmf.md | 2 +- docs/_indicators/ConnorsRsi.md | 2 +- docs/_indicators/Correlation.md | 4 ++-- docs/_indicators/Dema.md | 2 +- docs/_indicators/Doji.md | 2 +- docs/_indicators/Donchian.md | 2 +- docs/_indicators/Dpo.md | 2 +- docs/_indicators/ElderRay.md | 2 +- docs/_indicators/Ema.md | 2 +- docs/_indicators/Epma.md | 2 +- docs/_indicators/Fcb.md | 2 +- docs/_indicators/FisherTransform.md | 2 +- docs/_indicators/ForceIndex.md | 2 +- docs/_indicators/Fractal.md | 2 +- docs/_indicators/Gator.md | 2 +- docs/_indicators/HeikinAshi.md | 2 +- docs/_indicators/Hma.md | 2 +- docs/_indicators/HtTrendline.md | 2 +- docs/_indicators/Hurst.md | 2 +- docs/_indicators/Ichimoku.md | 2 +- docs/_indicators/Kama.md | 2 +- docs/_indicators/Keltner.md | 2 +- docs/_indicators/Kvo.md | 2 +- docs/_indicators/MaEnvelopes.md | 2 +- docs/_indicators/Macd.md | 2 +- docs/_indicators/Mama.md | 2 +- docs/_indicators/Marubozu.md | 2 +- docs/_indicators/Mfi.md | 2 +- docs/_indicators/Obv.md | 2 +- docs/_indicators/ParabolicSar.md | 2 +- docs/_indicators/PivotPoints.md | 2 +- docs/_indicators/Pivots.md | 2 +- docs/_indicators/Pmo.md | 2 +- docs/_indicators/Prs.md | 4 ++-- docs/_indicators/Pvo.md | 2 +- docs/_indicators/Renko.md | 4 ++-- docs/_indicators/Roc.md | 2 +- docs/_indicators/RollingPivots.md | 2 +- docs/_indicators/Rsi.md | 2 +- docs/_indicators/Slope.md | 2 +- docs/_indicators/Sma.md | 2 +- docs/_indicators/Smi.md | 2 +- docs/_indicators/Smma.md | 2 +- docs/_indicators/StarcBands.md | 2 +- docs/_indicators/Stc.md | 2 +- docs/_indicators/StdDev.md | 2 +- docs/_indicators/StdDevChannels.md | 2 +- docs/_indicators/Stoch.md | 2 +- docs/_indicators/StochRsi.md | 2 +- docs/_indicators/SuperTrend.md | 2 +- docs/_indicators/T3.md | 2 +- docs/_indicators/Tema.md | 2 +- docs/_indicators/Trix.md | 2 +- docs/_indicators/Tsi.md | 2 +- docs/_indicators/UlcerIndex.md | 2 +- docs/_indicators/Ultimate.md | 2 +- docs/_indicators/VolatilityStop.md | 2 +- docs/_indicators/Vortex.md | 2 +- docs/_indicators/Vwap.md | 2 +- docs/_indicators/Vwma.md | 2 +- docs/_indicators/WilliamsR.md | 2 +- docs/_indicators/Wma.md | 2 +- docs/_indicators/ZigZag.md | 2 +- docs/pages/guide.md | 28 ++++++++++++---------------- docs/pages/utilities.md | 2 +- 80 files changed, 95 insertions(+), 99 deletions(-) diff --git a/docs/GemFile.lock b/docs/GemFile.lock index a8e9f95a..5af98c2e 100644 --- a/docs/GemFile.lock +++ b/docs/GemFile.lock @@ -254,7 +254,7 @@ GEM pathutil (0.16.2) forwardable-extended (~> 2.6) posix-spawn (0.3.15) - public_suffix (5.0.4) + public_suffix (5.0.5) racc (1.7.3) rb-fsevent (0.11.2) rb-inotify (0.10.1) diff --git a/docs/_indicators/Adl.md b/docs/_indicators/Adl.md index a3ee90d1..476baed1 100644 --- a/docs/_indicators/Adl.md +++ b/docs/_indicators/Adl.md @@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate results = indicators.get_adl(quotes) diff --git a/docs/_indicators/Adx.md b/docs/_indicators/Adx.md index eb75e0ea..e53fd725 100644 --- a/docs/_indicators/Adx.md +++ b/docs/_indicators/Adx.md @@ -60,7 +60,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate 14-period ADX results = indicators.get_adx(quotes, lookback_periods) diff --git a/docs/_indicators/Alligator.md b/docs/_indicators/Alligator.md index f6bedfa9..d850aa1b 100644 --- a/docs/_indicators/Alligator.md +++ b/docs/_indicators/Alligator.md @@ -64,7 +64,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate the Williams Alligator results = indicators.get_alligator(quotes) diff --git a/docs/_indicators/Alma.md b/docs/_indicators/Alma.md index 81b7f032..090214b2 100644 --- a/docs/_indicators/Alma.md +++ b/docs/_indicators/Alma.md @@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate Alma results = indicators.get_alma(quotes, 10, 0.5, 6) diff --git a/docs/_indicators/Aroon.md b/docs/_indicators/Aroon.md index 0998a76e..17c561bc 100644 --- a/docs/_indicators/Aroon.md +++ b/docs/_indicators/Aroon.md @@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") results = indicators.get_aroon(quotes, lookback_periods) ``` diff --git a/docs/_indicators/Atr.md b/docs/_indicators/Atr.md index d75608c1..385f55c0 100644 --- a/docs/_indicators/Atr.md +++ b/docs/_indicators/Atr.md @@ -64,7 +64,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate 14-period ATR results = indicators.get_atr(quotes, 14) diff --git a/docs/_indicators/Awesome.md b/docs/_indicators/Awesome.md index 7fe7fade..ea1a363c 100644 --- a/docs/_indicators/Awesome.md +++ b/docs/_indicators/Awesome.md @@ -58,7 +58,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate results = indicators.get_awesome(quotes, 5, 34) diff --git a/docs/_indicators/Beta.md b/docs/_indicators/Beta.md index 995782e1..c49489f9 100644 --- a/docs/_indicators/Beta.md +++ b/docs/_indicators/Beta.md @@ -76,8 +76,8 @@ from stock_indicators import indicators from stock_indicators import BetaType # Short path, version >= 0.8.1 # This method is NOT a part of the library. -history_SPX = get_history_from_feed("SPX") -history_TSLA = get_history_from_feed("TSLA") +history_SPX = get_historical_quotes("SPX") +history_TSLA = get_historical_quotes("TSLA") # calculate 20-period Beta coefficient results = indicators.get_beta(history_SPX, history_TSLA, 20, BetaType.STANDARD) diff --git a/docs/_indicators/BollingerBands.md b/docs/_indicators/BollingerBands.md index fd197ba6..3f3f8edc 100644 --- a/docs/_indicators/BollingerBands.md +++ b/docs/_indicators/BollingerBands.md @@ -61,7 +61,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate BollingerBands(20, 2) results = indicators.get_bollinger_bands(quotes, 20, 2) diff --git a/docs/_indicators/Bop.md b/docs/_indicators/Bop.md index 98dd5db2..0137f434 100644 --- a/docs/_indicators/Bop.md +++ b/docs/_indicators/Bop.md @@ -56,7 +56,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 14-period BOP results = indicators.get_bop(quotes, 14) diff --git a/docs/_indicators/Cci.md b/docs/_indicators/Cci.md index 4460e0c5..da51ec9b 100644 --- a/docs/_indicators/Cci.md +++ b/docs/_indicators/Cci.md @@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period CCI results = indicators.get_cci(quotes, 20) diff --git a/docs/_indicators/ChaikinOsc.md b/docs/_indicators/ChaikinOsc.md index 14d837cd..0f757cef 100644 --- a/docs/_indicators/ChaikinOsc.md +++ b/docs/_indicators/ChaikinOsc.md @@ -63,7 +63,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period Chaikin Oscillator results = indicators.get_chaikin_osc(quotes, 20) diff --git a/docs/_indicators/Chandelier.md b/docs/_indicators/Chandelier.md index 028c7ef0..b2530698 100644 --- a/docs/_indicators/Chandelier.md +++ b/docs/_indicators/Chandelier.md @@ -69,7 +69,7 @@ from stock_indicators import indicators from stock_indicators import ChandelierType # Short path, version >= 0.8.1 # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate Chandelier(22,3) results = indicators.get_chandelier(quotes, 22, 3, ChandelierType.LONG) diff --git a/docs/_indicators/Chop.md b/docs/_indicators/Chop.md index 7afde226..88afbef2 100644 --- a/docs/_indicators/Chop.md +++ b/docs/_indicators/Chop.md @@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate CHOP(14) results = indicators.get_chop(quotes, 14) diff --git a/docs/_indicators/Cmf.md b/docs/_indicators/Cmf.md index 0aae3a11..4a90c24c 100644 --- a/docs/_indicators/Cmf.md +++ b/docs/_indicators/Cmf.md @@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period CMF results = indicators.get_cmf(quotes, 20) diff --git a/docs/_indicators/ConnorsRsi.md b/docs/_indicators/ConnorsRsi.md index f8e15fbb..3f4c14c8 100644 --- a/docs/_indicators/ConnorsRsi.md +++ b/docs/_indicators/ConnorsRsi.md @@ -62,7 +62,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate ConnorsRsi(3,2.100) results = indicators.get_connors_rsi(quotes, 3, 2, 100) diff --git a/docs/_indicators/Correlation.md b/docs/_indicators/Correlation.md index c54a4052..0e36f3d5 100644 --- a/docs/_indicators/Correlation.md +++ b/docs/_indicators/Correlation.md @@ -61,8 +61,8 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes_spx = get_history_from_feed("SPX") -quotes_tsla = get_history_from_feed("TSLA") +quotes_spx = get_historical_quotes("SPX") +quotes_tsla = get_historical_quotes("TSLA") # Calculate 20-period Correlation results = indicators.get_correlation(quotes_spx, quotes_tsla, 20) diff --git a/docs/_indicators/Dema.md b/docs/_indicators/Dema.md index 2e4f48da..627521ab 100644 --- a/docs/_indicators/Dema.md +++ b/docs/_indicators/Dema.md @@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate 20-period DEMA results = indicators.get_dema(quotes, 20) diff --git a/docs/_indicators/Doji.md b/docs/_indicators/Doji.md index 0dd6979c..d232cf53 100644 --- a/docs/_indicators/Doji.md +++ b/docs/_indicators/Doji.md @@ -52,7 +52,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate results = indicators.get_doji(quotes); diff --git a/docs/_indicators/Donchian.md b/docs/_indicators/Donchian.md index 5b06531b..865e4381 100644 --- a/docs/_indicators/Donchian.md +++ b/docs/_indicators/Donchian.md @@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate Donchian(20) results = indicators.get_donchian(quotes, 20) diff --git a/docs/_indicators/Dpo.md b/docs/_indicators/Dpo.md index e80550ef..23372889 100644 --- a/docs/_indicators/Dpo.md +++ b/docs/_indicators/Dpo.md @@ -56,7 +56,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate results = indicators.get_dpo(quotes, 14) diff --git a/docs/_indicators/ElderRay.md b/docs/_indicators/ElderRay.md index fe74d3e1..fb6156fb 100644 --- a/docs/_indicators/ElderRay.md +++ b/docs/_indicators/ElderRay.md @@ -60,7 +60,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate ElderRay(13) results = indicators.get_elder_ray(quotes, 13) diff --git a/docs/_indicators/Ema.md b/docs/_indicators/Ema.md index 9542d3bb..3dfdd9fa 100644 --- a/docs/_indicators/Ema.md +++ b/docs/_indicators/Ema.md @@ -61,7 +61,7 @@ from stock_indicators import indicators from stock_indicators import CandlePart # Short path, version >= 0.8.1 # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate 20-period EMA results = indicators.get_ema(quotes, 20, CandlePart.CLOSE) diff --git a/docs/_indicators/Epma.md b/docs/_indicators/Epma.md index c75024a5..7f9c5c20 100644 --- a/docs/_indicators/Epma.md +++ b/docs/_indicators/Epma.md @@ -56,7 +56,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period EPMA results = indicators.get_epma(quotes, 20) diff --git a/docs/_indicators/Fcb.md b/docs/_indicators/Fcb.md index b8abf4c8..429de331 100644 --- a/docs/_indicators/Fcb.md +++ b/docs/_indicators/Fcb.md @@ -58,7 +58,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate Fcb(14) results = indicators.get_fcb(quotes, 14) diff --git a/docs/_indicators/FisherTransform.md b/docs/_indicators/FisherTransform.md index c124d916..02a11313 100644 --- a/docs/_indicators/FisherTransform.md +++ b/docs/_indicators/FisherTransform.md @@ -63,7 +63,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 10-period FisherTransform results = indicators.get_fisher_transform(quotes, 10) diff --git a/docs/_indicators/ForceIndex.md b/docs/_indicators/ForceIndex.md index 21accb0c..b17075bd 100644 --- a/docs/_indicators/ForceIndex.md +++ b/docs/_indicators/ForceIndex.md @@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate ForceIndex(13) results = indicators.get_force_index(quotes, 13) diff --git a/docs/_indicators/Fractal.md b/docs/_indicators/Fractal.md index 90eb0cfa..0d654f5a 100644 --- a/docs/_indicators/Fractal.md +++ b/docs/_indicators/Fractal.md @@ -75,7 +75,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate Fractal results = indicators.get_fractal(quotes, 5) diff --git a/docs/_indicators/Gator.md b/docs/_indicators/Gator.md index dd96a37b..ed1aa5ff 100644 --- a/docs/_indicators/Gator.md +++ b/docs/_indicators/Gator.md @@ -61,7 +61,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate the Gator Oscillator results = indicators.get_gator(quotes) diff --git a/docs/_indicators/HeikinAshi.md b/docs/_indicators/HeikinAshi.md index 9adef0b7..055301b4 100644 --- a/docs/_indicators/HeikinAshi.md +++ b/docs/_indicators/HeikinAshi.md @@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate results = indicators.get_heikin_ashi(quotes) diff --git a/docs/_indicators/Hma.md b/docs/_indicators/Hma.md index f306b318..af231076 100644 --- a/docs/_indicators/Hma.md +++ b/docs/_indicators/Hma.md @@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period HMA results = indicators.get_hma(quotes, 20) diff --git a/docs/_indicators/HtTrendline.md b/docs/_indicators/HtTrendline.md index 789f6c92..1520bb78 100644 --- a/docs/_indicators/HtTrendline.md +++ b/docs/_indicators/HtTrendline.md @@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate HT Trendline results = indicators.get_ht_trendline(quotes) diff --git a/docs/_indicators/Hurst.md b/docs/_indicators/Hurst.md index 51d092be..9a4cfdf2 100644 --- a/docs/_indicators/Hurst.md +++ b/docs/_indicators/Hurst.md @@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period Hurst results = indicators.get_hurst(quotes, 20) diff --git a/docs/_indicators/Ichimoku.md b/docs/_indicators/Ichimoku.md index d3920fcf..44bee6e6 100644 --- a/docs/_indicators/Ichimoku.md +++ b/docs/_indicators/Ichimoku.md @@ -73,7 +73,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate ICHIMOKU(9,26,52) results = indicators.get_ichimoku(quotes, 9, 26, 52) diff --git a/docs/_indicators/Kama.md b/docs/_indicators/Kama.md index 37c2cc03..2ebac9e6 100644 --- a/docs/_indicators/Kama.md +++ b/docs/_indicators/Kama.md @@ -62,7 +62,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate KAMA(10,2,30) results = indicators.get_kama(quotes, 10,2,30) diff --git a/docs/_indicators/Keltner.md b/docs/_indicators/Keltner.md index eccb1a69..d90e3280 100644 --- a/docs/_indicators/Keltner.md +++ b/docs/_indicators/Keltner.md @@ -62,7 +62,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate Keltner(20) results = indicators.get_keltner(quotes, 20,2.0,10) diff --git a/docs/_indicators/Kvo.md b/docs/_indicators/Kvo.md index 71886e31..15b2765f 100644 --- a/docs/_indicators/Kvo.md +++ b/docs/_indicators/Kvo.md @@ -60,7 +60,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate Klinger(34,55,13) results = indicators.get_kvo(quotes, 34, 55, 13) diff --git a/docs/_indicators/MaEnvelopes.md b/docs/_indicators/MaEnvelopes.md index e3bfd301..87098fc3 100644 --- a/docs/_indicators/MaEnvelopes.md +++ b/docs/_indicators/MaEnvelopes.md @@ -83,7 +83,7 @@ from stock_indicators import indicators from stock_indicators import MAType # Short path, version >= 0.8.1 # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period SMA envelopes with 2.5% offset results = indicators.get_ma_envelopes(quotes, 20, 2.5, MAType.SMA); diff --git a/docs/_indicators/Macd.md b/docs/_indicators/Macd.md index be67ce75..43f6b869 100644 --- a/docs/_indicators/Macd.md +++ b/docs/_indicators/Macd.md @@ -66,7 +66,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate MACD(12,26,9) results = indicators.get_macd(quotes, 12, 26, 9) diff --git a/docs/_indicators/Mama.md b/docs/_indicators/Mama.md index e1dac7d1..a7ea0fe5 100644 --- a/docs/_indicators/Mama.md +++ b/docs/_indicators/Mama.md @@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate Mama(0.5,0.05) results = indicators.get_mama(quotes, 0.5,0.05) diff --git a/docs/_indicators/Marubozu.md b/docs/_indicators/Marubozu.md index b99e3e72..86b484fa 100644 --- a/docs/_indicators/Marubozu.md +++ b/docs/_indicators/Marubozu.md @@ -52,7 +52,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate results = indicators.get_marubozu(quotes); diff --git a/docs/_indicators/Mfi.md b/docs/_indicators/Mfi.md index de441760..40ca131f 100644 --- a/docs/_indicators/Mfi.md +++ b/docs/_indicators/Mfi.md @@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate results = indicators.get_mfi(quotes, 14) diff --git a/docs/_indicators/Obv.md b/docs/_indicators/Obv.md index 8f6d8d5b..7acb681d 100644 --- a/docs/_indicators/Obv.md +++ b/docs/_indicators/Obv.md @@ -58,7 +58,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate results = indicators.get_obv(quotes) diff --git a/docs/_indicators/ParabolicSar.md b/docs/_indicators/ParabolicSar.md index e0d65e9e..d8844c88 100644 --- a/docs/_indicators/ParabolicSar.md +++ b/docs/_indicators/ParabolicSar.md @@ -62,7 +62,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate ParabolicSar(0.02,0.2) results = indicators.get_parabolic_sar(quotes, 0.02, 0.2) diff --git a/docs/_indicators/PivotPoints.md b/docs/_indicators/PivotPoints.md index d6bee652..be1da22f 100644 --- a/docs/_indicators/PivotPoints.md +++ b/docs/_indicators/PivotPoints.md @@ -94,7 +94,7 @@ from stock_indicators import indicators from stock_indicators import PeriodSize, PivotPointType # Short path, version >= 0.8.1 # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate Woodie-style month-based Pivot Points results = indicators.get_pivot_points(quotes, PeriodSize.MONTH, PivotPointType.WOODIE); diff --git a/docs/_indicators/Pivots.md b/docs/_indicators/Pivots.md index 142a1bb3..a6efdeef 100644 --- a/docs/_indicators/Pivots.md +++ b/docs/_indicators/Pivots.md @@ -91,7 +91,7 @@ from stock_indicators import indicators from stock_indicators import EndType # Short path, version >= 0.8.1 # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate Pivots(2,2,20) using High/Low values results = indicators.get_pivots(quotes, 2, 2, 20, EndType.HIGH_LOW); diff --git a/docs/_indicators/Pmo.md b/docs/_indicators/Pmo.md index 2cfbecd6..a0f4bdf7 100644 --- a/docs/_indicators/Pmo.md +++ b/docs/_indicators/Pmo.md @@ -58,7 +58,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period PMO results = indicators.get_pmo(quotes, 35,20,10) diff --git a/docs/_indicators/Prs.md b/docs/_indicators/Prs.md index a7a61a3c..66454ab4 100644 --- a/docs/_indicators/Prs.md +++ b/docs/_indicators/Prs.md @@ -58,8 +58,8 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -history_SPX = get_history_from_feed("SPX") -history_TSLA = get_history_from_feed("TSLA") +history_SPX = get_historical_quotes("SPX") +history_TSLA = get_historical_quotes("TSLA") # Calculate 14-period PRS results = indicators.get_prs(history_SPX, history_TSLA, 14) diff --git a/docs/_indicators/Pvo.md b/docs/_indicators/Pvo.md index bbd1a33f..f35bdcb0 100644 --- a/docs/_indicators/Pvo.md +++ b/docs/_indicators/Pvo.md @@ -61,7 +61,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate Pvo(12,26,9) results = indicators.get_pvo(quotes, 12, 26, 9); diff --git a/docs/_indicators/Renko.md b/docs/_indicators/Renko.md index e9334ff8..cf10835a 100644 --- a/docs/_indicators/Renko.md +++ b/docs/_indicators/Renko.md @@ -77,7 +77,7 @@ from stock_indicators import indicators from stock_indicators import EndType # Short path, version >= 0.8.1 # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate results = indicators.get_renko(quotes, 2.5, EndType.CLOSE); @@ -119,7 +119,7 @@ RenkoResults[RenkoResult] from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate results = indicators.get_renko_atr(quotes, atr_periods); diff --git a/docs/_indicators/Roc.md b/docs/_indicators/Roc.md index 85f04e2f..b3dc1557 100644 --- a/docs/_indicators/Roc.md +++ b/docs/_indicators/Roc.md @@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate 20-period ROC results = indicators.get_roc(quotes, 20) diff --git a/docs/_indicators/RollingPivots.md b/docs/_indicators/RollingPivots.md index 6fcfd759..ac7a0b70 100644 --- a/docs/_indicators/RollingPivots.md +++ b/docs/_indicators/RollingPivots.md @@ -80,7 +80,7 @@ from stock_indicators import indicators from stock_indicators import PivotPointType # Short path, version >= 0.8.1 # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate Woodie-style 14 period Rolling Pivot Points results = indicators.get_rolling_pivots(quotes, 14, 0, PivotPointType.Woodie); diff --git a/docs/_indicators/Rsi.md b/docs/_indicators/Rsi.md index c8165ff9..c2ac9310 100644 --- a/docs/_indicators/Rsi.md +++ b/docs/_indicators/Rsi.md @@ -58,7 +58,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate RSI(14) results = indicators.get_rsi(quotes, 14) diff --git a/docs/_indicators/Slope.md b/docs/_indicators/Slope.md index b629df58..98b0491b 100644 --- a/docs/_indicators/Slope.md +++ b/docs/_indicators/Slope.md @@ -61,7 +61,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate 20-period Slope results = indicators.get_slope(quotes, 20) diff --git a/docs/_indicators/Sma.md b/docs/_indicators/Sma.md index 8e9dc706..e4644ee5 100644 --- a/docs/_indicators/Sma.md +++ b/docs/_indicators/Sma.md @@ -59,7 +59,7 @@ from stock_indicators import indicators from stock_indicators import CandlePart # Short path, version >= 0.8.1 # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate 20-period SMA results = indicators.get_sma(quotes, 20, CandlePart.CLOSE) diff --git a/docs/_indicators/Smi.md b/docs/_indicators/Smi.md index 03980190..5b81c528 100644 --- a/docs/_indicators/Smi.md +++ b/docs/_indicators/Smi.md @@ -61,7 +61,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate SMI(14,20,5,3) results = indicators.get_smi(quotes, 14, 20, 5, 3) diff --git a/docs/_indicators/Smma.md b/docs/_indicators/Smma.md index a73e75b0..79dbba1e 100644 --- a/docs/_indicators/Smma.md +++ b/docs/_indicators/Smma.md @@ -58,7 +58,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period SMMA results = indicators.get_smma(quotes, 20) diff --git a/docs/_indicators/StarcBands.md b/docs/_indicators/StarcBands.md index e32c5b99..e9be64db 100644 --- a/docs/_indicators/StarcBands.md +++ b/docs/_indicators/StarcBands.md @@ -61,7 +61,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate StarcBands(20) results = indicators.get_starc_bands(quotes, 20, 2.0, 10) diff --git a/docs/_indicators/Stc.md b/docs/_indicators/Stc.md index 54dace7e..70932dee 100644 --- a/docs/_indicators/Stc.md +++ b/docs/_indicators/Stc.md @@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate STC(12,26,9) results = indicators.get_stc(quotes, 10, 23, 50) diff --git a/docs/_indicators/StdDev.md b/docs/_indicators/StdDev.md index 12630b3f..ab4b6e32 100644 --- a/docs/_indicators/StdDev.md +++ b/docs/_indicators/StdDev.md @@ -60,7 +60,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 10-period Standard Deviation results = indicators.get_stdev(quotes, 10) diff --git a/docs/_indicators/StdDevChannels.md b/docs/_indicators/StdDevChannels.md index 08c8886f..28c200fb 100644 --- a/docs/_indicators/StdDevChannels.md +++ b/docs/_indicators/StdDevChannels.md @@ -61,7 +61,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate StdDevChannels(20,2) results = indicators.get_stdev_channels(quotes, 20,2) diff --git a/docs/_indicators/Stoch.md b/docs/_indicators/Stoch.md index 7950a5be..d7ed8ef5 100644 --- a/docs/_indicators/Stoch.md +++ b/docs/_indicators/Stoch.md @@ -77,7 +77,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate STO %K(14),%D(3) (slow) results = indicators.get_stoch(quotes, 14, 3, 3) diff --git a/docs/_indicators/StochRsi.md b/docs/_indicators/StochRsi.md index 37d3d620..62fe793f 100644 --- a/docs/_indicators/StochRsi.md +++ b/docs/_indicators/StochRsi.md @@ -63,7 +63,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate StochRSI results = indicators.get_stoch_rsi(quotes, 14, 14, 1, 1) diff --git a/docs/_indicators/SuperTrend.md b/docs/_indicators/SuperTrend.md index c0fe3794..d447c0c8 100644 --- a/docs/_indicators/SuperTrend.md +++ b/docs/_indicators/SuperTrend.md @@ -62,7 +62,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate SuperTrend(14,3) results = indicators.get_super_trend(quotes, 14, 3) diff --git a/docs/_indicators/T3.md b/docs/_indicators/T3.md index a00b30c7..7b3a63ac 100644 --- a/docs/_indicators/T3.md +++ b/docs/_indicators/T3.md @@ -58,7 +58,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 5-period T3 results = indicators.get_t3(quotes, 5, 0.7) diff --git a/docs/_indicators/Tema.md b/docs/_indicators/Tema.md index 3339d917..54ca5ee3 100644 --- a/docs/_indicators/Tema.md +++ b/docs/_indicators/Tema.md @@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate 20-period TEMA results = indicators.get_tema(quotes, 20) diff --git a/docs/_indicators/Trix.md b/docs/_indicators/Trix.md index d4221461..8eae082a 100644 --- a/docs/_indicators/Trix.md +++ b/docs/_indicators/Trix.md @@ -60,7 +60,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate 20-period Trix results = indicators.get_trix(quotes, 14) diff --git a/docs/_indicators/Tsi.md b/docs/_indicators/Tsi.md index 45c808ec..ce5f4a3e 100644 --- a/docs/_indicators/Tsi.md +++ b/docs/_indicators/Tsi.md @@ -61,7 +61,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period TSI results = indicators.get_tsi(quotes, 25, 13, 7) diff --git a/docs/_indicators/UlcerIndex.md b/docs/_indicators/UlcerIndex.md index f0b9705c..48758667 100644 --- a/docs/_indicators/UlcerIndex.md +++ b/docs/_indicators/UlcerIndex.md @@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate UI(14) results = indicators.get_ulcer_index(quotes, 14) diff --git a/docs/_indicators/Ultimate.md b/docs/_indicators/Ultimate.md index bea80ecf..3f1f3c69 100644 --- a/docs/_indicators/Ultimate.md +++ b/docs/_indicators/Ultimate.md @@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # calculate 20-period Ultimate results = indicators.get_ultimate(quotes, 7, 14, 28) diff --git a/docs/_indicators/VolatilityStop.md b/docs/_indicators/VolatilityStop.md index fd2e9204..1f4db609 100644 --- a/docs/_indicators/VolatilityStop.md +++ b/docs/_indicators/VolatilityStop.md @@ -63,7 +63,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate VolatilityStop(20,2.5) results = indicators.get_volatility_stop(quotes, 20, 2.5) diff --git a/docs/_indicators/Vortex.md b/docs/_indicators/Vortex.md index 7b6aad5e..ac36cbde 100644 --- a/docs/_indicators/Vortex.md +++ b/docs/_indicators/Vortex.md @@ -56,7 +56,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 14-period VI results = indicators.get_vortex(quotes, 14); diff --git a/docs/_indicators/Vwap.md b/docs/_indicators/Vwap.md index ad0c8972..836051ee 100644 --- a/docs/_indicators/Vwap.md +++ b/docs/_indicators/Vwap.md @@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate results = indicators.get_vwap(quotes); diff --git a/docs/_indicators/Vwma.md b/docs/_indicators/Vwma.md index 4573e79c..d111dfdc 100644 --- a/docs/_indicators/Vwma.md +++ b/docs/_indicators/Vwma.md @@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 10-period VWMA results = indicators.get_vwma(quotes, 10) diff --git a/docs/_indicators/WilliamsR.md b/docs/_indicators/WilliamsR.md index c6d73ad6..84d7eac5 100644 --- a/docs/_indicators/WilliamsR.md +++ b/docs/_indicators/WilliamsR.md @@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r from stock_indicators import indicators # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate WilliamsR(14) results = indicators.get_williams_r(quotes, 14) diff --git a/docs/_indicators/Wma.md b/docs/_indicators/Wma.md index 6625c24f..808610c2 100644 --- a/docs/_indicators/Wma.md +++ b/docs/_indicators/Wma.md @@ -59,7 +59,7 @@ from stock_indicators import indicators from stock_indicators import CandlePart # Short path, version >= 0.8.1 # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 20-period WMA results = indicators.get_wma(quotes, 20, CandlePart.CLOSE) diff --git a/docs/_indicators/ZigZag.md b/docs/_indicators/ZigZag.md index e2fc83ae..88fff92e 100644 --- a/docs/_indicators/ZigZag.md +++ b/docs/_indicators/ZigZag.md @@ -76,7 +76,7 @@ from stock_indicators import indicators from stock_indicators import EndType # Short path, version >= 0.8.1 # This method is NOT a part of the library. -quotes = get_history_from_feed("SPY") +quotes = get_historical_quotes("SPY") # Calculate 3% change ZIGZAG results = indicators.get_zig_zag(quotes, EndType.CLOSE, 3); diff --git a/docs/pages/guide.md b/docs/pages/guide.md index 5ebb0df6..7f018719 100644 --- a/docs/pages/guide.md +++ b/docs/pages/guide.md @@ -25,9 +25,7 @@ layout: page 1. Install prerequisite framework dependencies - Stock Indicators for Python has dependency on on the [Common Language Runtime (CLR)](https://learn.microsoft.com/dotnet/standard/clr). You'll need to install the .NET SDK in your environment to get required CLR capability. - - Check that you've installed the following prerequisite software: + Stock Indicators for Python has dependency on on the [Common Language Runtime (CLR)](https://learn.microsoft.com/dotnet/standard/clr). You'll need to install the .NET SDK in your environment to get required CLR capability. Check that you've installed the following prerequisite software: > Install **Python** and the **.NET SDK**. Use the latest versions for better performance. @@ -38,7 +36,7 @@ layout: page Note: we do not support the open source [Mono .NET Framework](https://www.mono-project.com). -2. Find and install the **stock-indicators** Python package into your environment. +2. Install the **stock-indicators** Python package into your environment. ```bash # bash CLI command @@ -47,16 +45,11 @@ layout: page > See [Python documentation](https://packaging.python.org/en/latest/tutorials/installing-packages/) for more help with installing packages. -> **More help**: if you're still having trouble getting started, see our -> **[QuickStart guide](https://github.com/DaveSkender/Stock.Indicators.Python.QuickStart#readme)** -> for step-by-step instructions to setup up your environment, -> and for calculating your first indicator using this library. - ### Prerequisite data Most indicators require that you provide historical quote data and additional configuration parameters. -You must get historical quotes from your own market data provider. For clarification, the `get_history_from_feed()` method shown in the example below and throughout our documentation **is not part of this library**, but rather an example to represent your own acquisition of historical quotes. +You must get historical quotes from your own market data provider. For clarification, the `get_historical_quotes()` method shown in the example below and throughout our documentation **is not part of this library**, but rather an example to represent your own acquisition of historical quotes. Historical price data can be provided as an `Iterable`(such as `List` or an object having `__iter__()`) of the `Quote` class or its sub-class ([see below](#historical-quotes)); be aware that you **have to** inherit `Quote` class when you [make custom quote class](#using-custom-quote-classes). @@ -93,9 +86,12 @@ SMA on 2018-04-26 was $255.9705 See [individual indicator pages]({{site.baseurl}}/indicators/) for specific usage guidance. -More examples available: - -- [Demo site](https://charts.stockindicators.dev) (a stock chart) +> **More help**: if you're having trouble getting started, see our +> **[QuickStart guide](https://github.com/DaveSkender/Stock.Indicators.Python.QuickStart#readme)** +> for step-by-step instructions to setup up your environment, +> and for calculating your first indicator using this library. +> +> We also have a [demo site](https://charts.stockindicators.dev) (a stock chart) where you can visualize and experiment with different indicator settings. ## Historical quotes @@ -178,7 +174,7 @@ class MyCustomQuote(Quote): from stock_indicators import indicators # fetch historical quotes from your favorite feed -quotes: Iterable[MyCustomQuote] = get_history_from_feed("MSFT"); +quotes: Iterable[MyCustomQuote] = get_historical_quotes("MSFT"); # example: get 20-period simple moving average results = indicators.get_sma(quotes, 20); @@ -215,7 +211,7 @@ class ExtendedEMA(EMAResult): return f"EMA on {self.date.date()} was ${self.ema or 0:.4f}" # compute indicator -quotes = get_history_from_feed("MSFT") +quotes = get_historical_quotes("MSFT") results = indicators.get_ema(quotes, 20) # 1. list[ExtendedEMA] @@ -244,7 +240,7 @@ If you want to compute an indicator of indicators, such as an SMA of an ADX or a from stock_indicators import indicators # fetch historical quotes from your feed (your method) -quotes = get_history_from_feed("MSFT") +quotes = get_historical_quotes("MSFT") # calculate EMA results = indicators.get_ema(quotes, 20) diff --git a/docs/pages/utilities.md b/docs/pages/utilities.md index 88f0a9b8..ade72273 100644 --- a/docs/pages/utilities.md +++ b/docs/pages/utilities.md @@ -46,7 +46,7 @@ Currently, `.to_quotes()` is only available on a select few indicators. If you ```python # fetch historical quotes from your favorite feed -quotes = get_history_from_feed("MSFT") +quotes = get_historical_quotes("MSFT") # calculate indicator series results = indicators.get_ema(quotes, 20)