View Source AlphaVantage.TechnicalIndicators (Alpha Vantage v0.3.0)

A set of functions for fetching technical indicators from Alpha Vantage.

Summary

Functions

ad(symbol, interval, opts \\ [])

Returns the Chaikin A/D line (AD) values for a given symbol and interval.

adosc(symbol, interval, opts \\ [])

Returns the Chaikin A/D line oscillator (ADOSC) values for a given symbol and interval.

adx(symbol, interval, time_period, opts \\ [])

Returns the average directional movement index (ADX) values for a given symbol, interval, and time period.

adxr(symbol, interval, time_period, opts \\ [])

Returns the average directional movement index rating (ADXR) values for a given symbol, interval, time period, and series type.

apo(symbol, interval, series_type, opts \\ [])

Returns the absolute price oscillator (APO) values for a given symbol, interval, and series type.

aroon(symbol, interval, time_period, opts \\ [])

Returns the Aroon (AROON) values for a given symbol, interval, and time period.

aroonosc(symbol, interval, time_period, opts \\ [])

Returns the Aroon oscillator (AROONOSC) values for a given symbol, interval, and time period.

atr(symbol, interval, time_period, opts \\ [])

Returns the average true range (ATR) values for a given symbol, interval, and time period.

bbands(symbol, interval, time_period, series_type, opts \\ [])

Returns the Bollinger bands (BBANDS) values for a given symbol, interval, time period, and series type.

bop(symbol, interval, opts \\ [])

Returns the balance of power (BOP) values for a given symbol and interval.

cci(symbol, interval, time_period, opts \\ [])

Returns the commodity channel index (CCI) values for a given symbol, interval, and time period.

cmo(symbol, interval, time_period, series_type, opts \\ [])

Returns the Chande momentum oscillator (CMO) values for a given symbol, interval, time period, and series type.

dema(symbol, interval, time_period, series_type, opts \\ [])

Returns the double exponential moving average (DEMA) values for a given symbol, interval, time period, and series type.

dx(symbol, interval, time_period, opts \\ [])

Returns the directional movement index (DX) values for a given symbol, interval, and time period.

ema(symbol, interval, time_period, series_type, opts \\ [])

Returns the exponential moving average (EMA) values for a given symbol, interval, time period, and series type.

ht_dcperiod(symbol, interval, series_type, opts \\ [])

Returns the Hilbert transform, dominant cycle period (HT_DCPERIOD) values for a given symbol, interval, and series type.

ht_dcphase(symbol, interval, series_type, opts \\ [])

Returns the Hilbert transform, dominant cycle phase (HT_DCPHASE) values for a given symbol, interval, and series type.

ht_phasor(symbol, interval, series_type, opts \\ [])

Returns the Hilbert transform, phasor components (HT_PHASOR) values for a given symbol, interval, and series type.

ht_sine(symbol, interval, series_type, opts \\ [])

Returns the Hilbert transform, sine wave (HT_SINE) values for a given symbol, interval, and series type.

ht_trendline(symbol, interval, series_type, opts \\ [])

Returns the Hilbert transform, instantaneous trendline (HT_TRENDLINE) values for a given symbol, interval, and series type.

ht_trendmode(symbol, interval, series_type, opts \\ [])

Returns the Hilbert transform, trend vs cycle mode (HT_TRENDMODE) values for a given symbol, interval, and series type.

kama(symbol, interval, time_period, series_type, opts \\ [])

Returns the Kaufman adaptive moving average (KAMA) values for a given symbol, interval, time period, and series type.

macd(symbol, interval, time_period, series_type, opts \\ [])

Returns the moving average convergence / divergence (MACD) values for a given symbol, interval, time period, and series type.

macdext(symbol, interval, time_period, series_type, opts \\ [])

Returns the moving average convergence / divergence values with controllable moving average type (MACDEXT) for a given symbol, interval, time period, and series type.

mama(symbol, interval, time_period, series_type, opts \\ [])

Returns the MESA adaptive moving average (MAMA) values for a given symbol, interval, time period, and series type.

mfi(symbol, interval, time_period, opts \\ [])

Returns the money flow index (MFI) values for a given symbol, interval, and time period.

midpoint(symbol, interval, time_period, series_type, opts \\ [])

Returns the midpoint (MIDPOINT) values for a given symbol, interval, time period, and series type. MIDPOINT = (highest value + lowest value)/2.

midprice(symbol, interval, time_period, opts \\ [])

Returns the midprice (MIDPRICE) values for a given symbol, interval, and time period. MIDPRICE = (highest value + lowest value)/2.

minus_di(symbol, interval, time_period, opts \\ [])

Returns the minus directional indicator (MINUS_DI) values for a given symbol, interval, and time period.

minus_dm(symbol, interval, time_period, opts \\ [])

Returns the minus directional movement (MINUS_DM) values for a given symbol, interval, and time period.

mom(symbol, interval, time_period, series_type, opts \\ [])

Returns the momentum (MOM) values for a given symbol, interval, time period, and series type.

natr(symbol, interval, time_period, opts \\ [])

Returns the normalized average true range (NATR) values for a given symbol, interval, and time period.

obv(symbol, interval, opts \\ [])

Returns the on balance volume (OBV) values for a given symbol and interval.

plus_di(symbol, interval, time_period, opts \\ [])

Returns the plus directional indicator (PLUS_DI) values for a given symbol, interval, and time period.

plus_dm(symbol, interval, time_period, opts \\ [])

Returns the plus directional movement (PLUS_DM) values for a given symbol, interval, and time period.

ppo(symbol, interval, series_type, opts \\ [])

Returns the percentage price oscillator (PPO) values for a given symbol, interval, and series type.

roc(symbol, interval, time_period, series_type, opts \\ [])

Returns the rate of change (ROC) values for a given symbol, interval, time period, and series type.

rocr(symbol, interval, time_period, series_type, opts \\ [])

Returns the rate of change ratio (ROCR) values for a given symbol, interval, time period, and series type.

rsi(symbol, interval, time_period, series_type, opts \\ [])

Returns the relative strength index (RSI) values for a given symbol, interval, time period, and series type.

sar(symbol, interval, opts \\ [])

Returns the parabolic SAR (SAR) values for a given symbol and interval.

sma(symbol, interval, time_period, series_type, opts \\ [])

Returns the simple moving average (SMA) values for a given symbol, interval, time period, and series type.

stoch(symbol, interval, opts \\ [])

Returns the stochastic oscillator (STOCH) values for a given symbol and interval.

stochf(symbol, interval, opts \\ [])

Returns the stochastic fast (STOCHF) values for a given symbol and interval.

stochrsi(symbol, interval, time_period, series_type, opts \\ [])

Returns the stochastic relative strength index (STOCHRSI) values for a given symbol, interval, time period, and series type.

t3(symbol, interval, time_period, series_type, opts \\ [])

Returns the triple exponential moving average (T3) values for a given symbol, interval, time period, and series type.

tema(symbol, interval, time_period, series_type, opts \\ [])

Returns the triple exponential moving average (TEMA) values for a given symbol, interval, time period, and series type.

trange(symbol, interval, opts \\ [])

Returns the true range (TRANGE) values for a given symbol and interval.

trima(symbol, interval, time_period, series_type, opts \\ [])

Returns the triangular moving average (TRIMA) values for a given symbol, interval, time period, and series type.

trix(symbol, interval, time_period, series_type, opts \\ [])

Returns the 1-day rate of change of a triple smooth exponential moving average (TRIX) values for a given symbol, interval, time period, and series type.

ultosc(symbol, interval, opts \\ [])

Returns the ultimate oscillator (ULTOSC) values for a given symbol and interval.

vwap(symbol, interval, opts \\ [])

Returns the volume weighted average price (VWAP) for intraday time series given a symbol and interval.

willr(symbol, interval, time_period, opts \\ [])

Returns the Williams' %R (WILLR) values for a given symbol, interval, and time period.

wma(symbol, interval, time_period, series_type, opts \\ [])

Returns the weighted moving average (WMA) values for a given symbol, interval, time period, and series type.

Functions

ad(symbol, interval, opts \\ [])

@spec ad(String.t(), String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the Chaikin A/D line (AD) values for a given symbol and interval.

Please reference https://www.alphavantage.co/documentation/#ad for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

adosc(symbol, interval, opts \\ [])

@spec adosc(String.t(), String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the Chaikin A/D line oscillator (ADOSC) values for a given symbol and interval.

Please reference https://www.alphavantage.co/documentation/#adosc for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"

Optional (accepted as a keyword list)

:fastperiod
The time period of the fast EMA. Positive integers are accepted. By default, fastperiod: 3.
:slowperiod
The time period of the slow EMA. Positive integers are accepted. By default, slowperiod: 10.
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

adx(symbol, interval, time_period, opts \\ [])

@spec adx(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the average directional movement index (ADX) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#adx for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

adxr(symbol, interval, time_period, opts \\ [])

@spec adxr(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the average directional movement index rating (ADXR) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#adxr for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

apo(symbol, interval, series_type, opts \\ [])

@spec apo(String.t(), String.t(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the absolute price oscillator (APO) values for a given symbol, interval, and series type.

Please reference https://www.alphavantage.co/documentation/#apo for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:fastperiod
Positive integers are accepted. By default, fastperiod: 12.
:slowperiod
Positive integers are accepted. By default, slowperiod: 26.
:matype
Moving average type. By default, matype: 0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

aroon(symbol, interval, time_period, opts \\ [])

@spec aroon(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Aroon (AROON) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#aroon for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

aroonosc(symbol, interval, time_period, opts \\ [])

@spec aroonosc(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Aroon oscillator (AROONOSC) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#aroonosc for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

atr(symbol, interval, time_period, opts \\ [])

@spec atr(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the average true range (ATR) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#atr for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

bbands(symbol, interval, time_period, series_type, opts \\ [])

@spec bbands(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Bollinger bands (BBANDS) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#bbands for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:nbdevup
The standard deviation multiplier of the upper band. Positive integers are accepted. By default, nbdevup: 2.
:nbdevdn
The standard deviation multiplier of the lower band. Positive integers are accepted. By default, nbdevdn: 2.
:matype
Moving average type of the time series. By default, matype: 0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

bop(symbol, interval, opts \\ [])

@spec bop(String.t(), String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the balance of power (BOP) values for a given symbol and interval.

Please reference https://www.alphavantage.co/documentation/#bop for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

cci(symbol, interval, time_period, opts \\ [])

@spec cci(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the commodity channel index (CCI) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#cci for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

cmo(symbol, interval, time_period, series_type, opts \\ [])

@spec cmo(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Chande momentum oscillator (CMO) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#cmo for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

dema(symbol, interval, time_period, series_type, opts \\ [])

@spec dema(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the double exponential moving average (DEMA) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#dema for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

dx(symbol, interval, time_period, opts \\ [])

@spec dx(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the directional movement index (DX) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#ex for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

ema(symbol, interval, time_period, series_type, opts \\ [])

@spec ema(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the exponential moving average (EMA) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#ema for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

ht_dcperiod(symbol, interval, series_type, opts \\ [])

@spec ht_dcperiod(String.t(), String.t(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Hilbert transform, dominant cycle period (HT_DCPERIOD) values for a given symbol, interval, and series type.

Please reference https://www.alphavantage.co/documentation/#htdcperiod more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

ht_dcphase(symbol, interval, series_type, opts \\ [])

@spec ht_dcphase(String.t(), String.t(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Hilbert transform, dominant cycle phase (HT_DCPHASE) values for a given symbol, interval, and series type.

Please reference https://www.alphavantage.co/documentation/#htdcphase more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

ht_phasor(symbol, interval, series_type, opts \\ [])

@spec ht_phasor(String.t(), String.t(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Hilbert transform, phasor components (HT_PHASOR) values for a given symbol, interval, and series type.

Please reference https://www.alphavantage.co/documentation/#htphasor more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

ht_sine(symbol, interval, series_type, opts \\ [])

@spec ht_sine(String.t(), String.t(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Hilbert transform, sine wave (HT_SINE) values for a given symbol, interval, and series type.

Please reference https://www.alphavantage.co/documentation/#htsine for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

ht_trendline(symbol, interval, series_type, opts \\ [])

@spec ht_trendline(String.t(), String.t(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Hilbert transform, instantaneous trendline (HT_TRENDLINE) values for a given symbol, interval, and series type.

Please reference https://www.alphavantage.co/documentation/#httrendline for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

ht_trendmode(symbol, interval, series_type, opts \\ [])

@spec ht_trendmode(String.t(), String.t(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Hilbert transform, trend vs cycle mode (HT_TRENDMODE) values for a given symbol, interval, and series type.

Please reference https://www.alphavantage.co/documentation/#httrendmode for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

kama(symbol, interval, time_period, series_type, opts \\ [])

@spec kama(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Kaufman adaptive moving average (KAMA) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#kama for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

macd(symbol, interval, time_period, series_type, opts \\ [])

@spec macd(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the moving average convergence / divergence (MACD) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#macd for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:fastperiod
Positive integers are accepted. By default, fastperiod: 12.
:slowperiod
Positive integers are accepted. By default, slowperiod: 26.
:signalperiod
Positive integers are accepted. By default, signalperiod: 9.
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

macdext(symbol, interval, time_period, series_type, opts \\ [])

@spec macdext(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the moving average convergence / divergence values with controllable moving average type (MACDEXT) for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#macdext for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:fastperiod
Positive integers are accepted. By default, fastperiod: 12.
:slowperiod
Positive integers are accepted. By default, slowperiod: 26.
:signalperiod
Positive integers are accepted. By default, signalperiod: 9.
:fastmatype
Moving average type for the faster moving average. By default, fastmatype: 0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
:slowmatype
Moving average type for the slower moving average. By default, slowmatype: 0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
:signalmatype
Moving average type for the signal moving average. By default, signalmatype: 0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

mama(symbol, interval, time_period, series_type, opts \\ [])

@spec mama(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the MESA adaptive moving average (MAMA) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#mama for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

mfi(symbol, interval, time_period, opts \\ [])

@spec mfi(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the money flow index (MFI) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#mfi for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

midpoint(symbol, interval, time_period, series_type, opts \\ [])

@spec midpoint(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the midpoint (MIDPOINT) values for a given symbol, interval, time period, and series type. MIDPOINT = (highest value + lowest value)/2.

Please reference https://www.alphavantage.co/documentation/#midpoint for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

midprice(symbol, interval, time_period, opts \\ [])

@spec midprice(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the midprice (MIDPRICE) values for a given symbol, interval, and time period. MIDPRICE = (highest value + lowest value)/2.

Please reference https://www.alphavantage.co/documentation/#midpoint for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

minus_di(symbol, interval, time_period, opts \\ [])

@spec minus_di(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the minus directional indicator (MINUS_DI) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#minusdi for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

minus_dm(symbol, interval, time_period, opts \\ [])

@spec minus_dm(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the minus directional movement (MINUS_DM) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#minusdm for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

mom(symbol, interval, time_period, series_type, opts \\ [])

@spec mom(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the momentum (MOM) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#mom for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

natr(symbol, interval, time_period, opts \\ [])

@spec natr(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the normalized average true range (NATR) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#natr for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

obv(symbol, interval, opts \\ [])

@spec obv(String.t(), String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the on balance volume (OBV) values for a given symbol and interval.

Please reference https://www.alphavantage.co/documentation/#obv for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

plus_di(symbol, interval, time_period, opts \\ [])

@spec plus_di(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the plus directional indicator (PLUS_DI) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#plusdi for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

plus_dm(symbol, interval, time_period, opts \\ [])

@spec plus_dm(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the plus directional movement (PLUS_DM) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#plusdm for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

ppo(symbol, interval, series_type, opts \\ [])

@spec ppo(String.t(), String.t(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the percentage price oscillator (PPO) values for a given symbol, interval, and series type.

Please reference https://www.alphavantage.co/documentation/#ppo for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:fastperiod
Positive integers are accepted. By default, fastperiod: 12.
:slowperiod
Positive integers are accepted. By default, slowperiod: 26.
:matype
Moving average type. By default, matype: 0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

roc(symbol, interval, time_period, series_type, opts \\ [])

@spec roc(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the rate of change (ROC) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#roc for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

rocr(symbol, interval, time_period, series_type, opts \\ [])

@spec rocr(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the rate of change ratio (ROCR) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#rocr for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

rsi(symbol, interval, time_period, series_type, opts \\ [])

@spec rsi(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the relative strength index (RSI) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#rsi for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

sar(symbol, interval, opts \\ [])

@spec sar(String.t(), String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the parabolic SAR (SAR) values for a given symbol and interval.

Please reference https://www.alphavantage.co/documentation/#sar for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"

Optional (accepted as a keyword list)

:acceleration
The acceleration factor. Positive floats are accepted. By default, acceleration: 0.01.
:maximum
The acceleration factor maximum value. Positive floats are accepted. By default, maximum: 0.20.
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

sma(symbol, interval, time_period, series_type, opts \\ [])

@spec sma(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the simple moving average (SMA) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#sma for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

stoch(symbol, interval, opts \\ [])

@spec stoch(String.t(), String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the stochastic oscillator (STOCH) values for a given symbol and interval.

Please reference https://www.alphavantage.co/documentation/#stoch for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"

Optional (accepted as a keyword list)

:fastkperiod
The time period of the fastk moving average. Positive integers are accepted. By default, fastkperiod: 5.
:slowkperiod
The time period of the slowk moving average. Positive integers are accepted. By default, slowkperiod: 3.
:slowdperiod
The time period of the slowd moving average. Positive integers are accepted. By default, slowdperiod: 3.
:slowkmatype
Moving average type for the slowk moving average. By default, slowkmatype: 0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
:slowdmatype
Moving average type for the slowd moving average. By default, slowdmatype: 0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

stochf(symbol, interval, opts \\ [])

@spec stochf(String.t(), String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the stochastic fast (STOCHF) values for a given symbol and interval.

Please reference https://www.alphavantage.co/documentation/#stochf for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"

Optional (accepted as a keyword list)

:fastkperiod
The time period of the fastk moving average. Positive integers are accepted. By default, fastkperiod: 5.
:fastdperiod
The time period of the fastd moving average. Positive integers are accepted. By default, fastdperiod: 3.
:fastdmatype
Moving average type for the fastd moving average. By default, fastdmatype: 0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

stochrsi(symbol, interval, time_period, series_type, opts \\ [])

@spec stochrsi(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the stochastic relative strength index (STOCHRSI) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#stochrsi for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:fastkperiod
The time period of the fastk moving average. Positive integers are accepted. By default, fastkperiod: 5.
:fastdperiod
The time period of the fastd moving average. Positive integers are accepted. By default, fastdperiod: 3.
:fastdmatype
Moving average type for the fastd moving average. By default, fastdmatype: 0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

t3(symbol, interval, time_period, series_type, opts \\ [])

@spec t3(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the triple exponential moving average (T3) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#t3 for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

tema(symbol, interval, time_period, series_type, opts \\ [])

@spec tema(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the triple exponential moving average (TEMA) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#tema for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

trange(symbol, interval, opts \\ [])

@spec trange(String.t(), String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the true range (TRANGE) values for a given symbol and interval.

Please reference https://www.alphavantage.co/documentation/#trange for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

trima(symbol, interval, time_period, series_type, opts \\ [])

@spec trima(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the triangular moving average (TRIMA) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#trima for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

trix(symbol, interval, time_period, series_type, opts \\ [])

@spec trix(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the 1-day rate of change of a triple smooth exponential moving average (TRIX) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#trix for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

ultosc(symbol, interval, opts \\ [])

@spec ultosc(String.t(), String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the ultimate oscillator (ULTOSC) values for a given symbol and interval.

Please reference https://www.alphavantage.co/documentation/#ultosc for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"

Optional (accepted as a keyword list)

:timeperiod1
The first time period for the indicator. Positive integers are accepted. By default, timeperiod1: 7.
:timeperiod2
The second time period for the indicator. Positive integers are accepted. By default, timeperiod1: 14.
:timeperiod3
The third time period for the indicator. Positive integers are accepted. By default, timeperiod1: 28.
:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

vwap(symbol, interval, opts \\ [])

@spec vwap(String.t(), String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the volume weighted average price (VWAP) for intraday time series given a symbol and interval.

Please reference https://www.alphavantage.co/documentation/#vwap for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

willr(symbol, interval, time_period, opts \\ [])

@spec willr(String.t(), String.t(), integer(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the Williams' %R (WILLR) values for a given symbol, interval, and time period.

Please reference https://www.alphavantage.co/documentation/#willr for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.

wma(symbol, interval, time_period, series_type, opts \\ [])

@spec wma(String.t(), String.t(), integer(), String.t(), Keyword.t()) ::
  AlphaVantage.Gateway.response()

Returns the weighted moving average (WMA) values for a given symbol, interval, time period, and series type.

Please reference https://www.alphavantage.co/documentation/#wma for more detail.

Parameters

Required

:symbol
The name of the security of your choice, provided as a string. For example: "MSFT"
:interval
Time interval between two consecutive data points in the time series. The following values are supported and accepted as strings: "1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"
:time_period
Number of data points used to calculate each moving average value. Positive integers are accepted: (e.g., 60, 200)
:series_type
The desired price type in the time series. Four types are supported and accepted as strings: "close", "open", "high", "low"

Optional (accepted as a keyword list)

:datatype
- "map" returns a map (default);
- "json" returns JSON format;
- "csv" returns a CSV (comma separated value) file string.