@gviper/alphavantage-api
Version:
TypeScript SDK for Alpha Vantage API with comprehensive type safety and all endpoint support
122 lines • 8.11 kB
TypeScript
import { AlphaVantageClient } from '../client';
import { SMAParams, EMAParams, WMAParams, DEMAParams, TEMAParams, TRIMAParams, KAMAParams, T3Params, MAMAParams, MACDParams, MACDEXTParams, STOCHParams, STOCHFParams, RSIParams, STOCHRSIParams, WILLRParams, ADXParams, ADXRParams, APOParams, PPOParams, MOMParams, BOPParams, CCIParams, CMOParams, ROCParams, ROCRParams, AROONParams, AROONOSCParams, MFIParams, TRIXParams, ULTOSCParams, DXParams, MINUSDIParams, PLUSDIParams, MINUSDMParams, PLUSDMParams, BBANDSParams, MIDPOINTParams, MIDPRICEParams, SARParams, TRANGEParams, ATRParams, NATRParams, ADParams, ADOSCParams, OBVParams, HTTRENDLINEParams, HTSINEParams, HTTRENDMODEParams, HTDCPERIODParams, HTDCPHASEParams, HTPHASORParams, SingleValueIndicatorResponse, MACDResponse, STOCHResponse, BBANDSResponse, AROONResponse, MAMAResponse, HTSINEResponse, HTPHASORResponse } from '../types/technicals';
export declare class Technicals {
private client;
constructor(client: AlphaVantageClient);
/**
* Returns the simple moving average (SMA) values for the specified symbol and time period.
*
* @param params - Parameters including symbol, interval, time_period, and series_type
* @returns Promise resolving to SMA indicator data
* @example https://www.alphavantage.co/query?function=SMA&symbol=IBM&interval=weekly&time_period=10&series_type=open&apikey=demo
*/
sma(params: SMAParams): Promise<SingleValueIndicatorResponse>;
/**
* Returns the exponential moving average (EMA) values for the specified symbol and time period.
*
* @param params - Parameters including symbol, interval, time_period, and series_type
* @returns Promise resolving to EMA indicator data
* @example https://www.alphavantage.co/query?function=EMA&symbol=IBM&interval=weekly&time_period=10&series_type=open&apikey=demo
*/
ema(params: EMAParams): Promise<SingleValueIndicatorResponse>;
/**
* Returns the weighted moving average (WMA) values for the specified symbol and time period.
*
* @param params - Parameters including symbol, interval, time_period, and series_type
* @returns Promise resolving to WMA indicator data
* @example https://www.alphavantage.co/query?function=WMA&symbol=IBM&interval=weekly&time_period=10&series_type=open&apikey=demo
*/
wma(params: WMAParams): Promise<SingleValueIndicatorResponse>;
dema(params: DEMAParams): Promise<SingleValueIndicatorResponse>;
tema(params: TEMAParams): Promise<SingleValueIndicatorResponse>;
trima(params: TRIMAParams): Promise<SingleValueIndicatorResponse>;
kama(params: KAMAParams): Promise<SingleValueIndicatorResponse>;
mama(params: MAMAParams): Promise<MAMAResponse>;
t3(params: T3Params): Promise<SingleValueIndicatorResponse>;
/**
* Returns the moving average convergence / divergence (MACD) values for the specified symbol.
*
* @param params - Parameters including symbol, interval, and series_type
* @returns Promise resolving to MACD indicator data
* @example https://www.alphavantage.co/query?function=MACD&symbol=IBM&interval=daily&series_type=open&apikey=demo
*/
macd(params: MACDParams): Promise<MACDResponse>;
/**
* Returns the moving average convergence / divergence (MACD) values with controllable moving average type.
*
* @param params - Parameters including symbol, interval, series_type, and moving average types
* @returns Promise resolving to MACD extended indicator data
* @example https://www.alphavantage.co/query?function=MACDEXT&symbol=IBM&interval=daily&series_type=open&apikey=demo
*/
macdext(params: MACDEXTParams): Promise<MACDResponse>;
/**
* Returns the stochastic oscillator values for the specified symbol.
*
* @param params - Parameters including symbol, interval, and time periods
* @returns Promise resolving to stochastic oscillator data
* @example https://www.alphavantage.co/query?function=STOCH&symbol=IBM&interval=daily&apikey=demo
*/
stoch(params: STOCHParams): Promise<STOCHResponse>;
/**
* Returns the stochastic fast oscillator values for the specified symbol.
*
* @param params - Parameters including symbol, interval, and time periods
* @returns Promise resolving to stochastic fast oscillator data
* @example https://www.alphavantage.co/query?function=STOCHF&symbol=IBM&interval=daily&apikey=demo
*/
stochf(params: STOCHFParams): Promise<STOCHResponse>;
/**
* Returns the relative strength index (RSI) values for the specified symbol.
*
* @param params - Parameters including symbol, interval, time_period, and series_type
* @returns Promise resolving to RSI indicator data
* @example https://www.alphavantage.co/query?function=RSI&symbol=IBM&interval=weekly&time_period=10&series_type=open&apikey=demo
*/
rsi(params: RSIParams): Promise<SingleValueIndicatorResponse>;
stochrsi(params: STOCHRSIParams): Promise<STOCHResponse>;
willr(params: WILLRParams): Promise<SingleValueIndicatorResponse>;
adx(params: ADXParams): Promise<SingleValueIndicatorResponse>;
adxr(params: ADXRParams): Promise<SingleValueIndicatorResponse>;
apo(params: APOParams): Promise<SingleValueIndicatorResponse>;
ppo(params: PPOParams): Promise<SingleValueIndicatorResponse>;
mom(params: MOMParams): Promise<SingleValueIndicatorResponse>;
bop(params: BOPParams): Promise<SingleValueIndicatorResponse>;
cci(params: CCIParams): Promise<SingleValueIndicatorResponse>;
cmo(params: CMOParams): Promise<SingleValueIndicatorResponse>;
roc(params: ROCParams): Promise<SingleValueIndicatorResponse>;
rocr(params: ROCRParams): Promise<SingleValueIndicatorResponse>;
aroon(params: AROONParams): Promise<AROONResponse>;
aroonosc(params: AROONOSCParams): Promise<SingleValueIndicatorResponse>;
mfi(params: MFIParams): Promise<SingleValueIndicatorResponse>;
trix(params: TRIXParams): Promise<SingleValueIndicatorResponse>;
ultosc(params: ULTOSCParams): Promise<SingleValueIndicatorResponse>;
dx(params: DXParams): Promise<SingleValueIndicatorResponse>;
minus_di(params: MINUSDIParams): Promise<SingleValueIndicatorResponse>;
plus_di(params: PLUSDIParams): Promise<SingleValueIndicatorResponse>;
minus_dm(params: MINUSDMParams): Promise<SingleValueIndicatorResponse>;
plus_dm(params: PLUSDMParams): Promise<SingleValueIndicatorResponse>;
/**
* Returns the Bollinger bands (BBANDS) values for the specified symbol.
*
* @param params - Parameters including symbol, interval, time_period, series_type, and optional deviation
* @returns Promise resolving to Bollinger bands data
* @example https://www.alphavantage.co/query?function=BBANDS&symbol=IBM&interval=weekly&time_period=5&series_type=close&nbdevup=2&nbdevdn=2&apikey=demo
*/
bbands(params: BBANDSParams): Promise<BBANDSResponse>;
midpoint(params: MIDPOINTParams): Promise<SingleValueIndicatorResponse>;
midprice(params: MIDPRICEParams): Promise<SingleValueIndicatorResponse>;
sar(params: SARParams): Promise<SingleValueIndicatorResponse>;
trange(params: TRANGEParams): Promise<SingleValueIndicatorResponse>;
atr(params: ATRParams): Promise<SingleValueIndicatorResponse>;
natr(params: NATRParams): Promise<SingleValueIndicatorResponse>;
ad(params: ADParams): Promise<SingleValueIndicatorResponse>;
adosc(params: ADOSCParams): Promise<SingleValueIndicatorResponse>;
obv(params: OBVParams): Promise<SingleValueIndicatorResponse>;
ht_trendline(params: HTTRENDLINEParams): Promise<SingleValueIndicatorResponse>;
ht_sine(params: HTSINEParams): Promise<HTSINEResponse>;
ht_trendmode(params: HTTRENDMODEParams): Promise<SingleValueIndicatorResponse>;
ht_dcperiod(params: HTDCPERIODParams): Promise<SingleValueIndicatorResponse>;
ht_dcphase(params: HTDCPHASEParams): Promise<SingleValueIndicatorResponse>;
ht_phasor(params: HTPHASORParams): Promise<HTPHASORResponse>;
}
//# sourceMappingURL=technicals.d.ts.map