@gviper/alphavantage-api/dist/endpoints/stocks.d.ts

TypeScript SDK for Alpha Vantage API with comprehensive type safety and all endpoint support

import { AlphaVantageClient } from '../client';
import { IntradayParams, DailyParams, QuoteParams, SearchParams, IntradayResponse, DailyResponse, DailyAdjustedResponse, WeeklyResponse, WeeklyAdjustedResponse, MonthlyResponse, MonthlyAdjustedResponse, GlobalQuoteResponse, SearchResponse } from '../types/stocks';
export declare class Stocks {
    private client;
    constructor(client: AlphaVantageClient);
    /**
     * Returns intraday time series of the equity specified, covering extended trading hours where applicable.
     *
     * @param params - Parameters including symbol and interval
     * @returns Promise resolving to intraday time series data
     * @example https://www.alphavantage.co/query?function=TIME_SERIES_INTRADAY&symbol=IBM&interval=5min&apikey=demo
     */
    intraday(params: IntradayParams): Promise<IntradayResponse>;
    /**
     * Returns raw (as-traded) daily time series values for the equity specified.
     *
     * @param params - Parameters including symbol
     * @returns Promise resolving to daily time series data
     * @example https://www.alphavantage.co/query?function=TIME_SERIES_DAILY&symbol=IBM&apikey=demo
     */
    daily(params: DailyParams): Promise<DailyResponse>;
    /**
     * Returns raw (as-traded) daily time series values for the equity specified, adjusted for splits and dividends.
     *
     * @param params - Parameters including symbol
     * @returns Promise resolving to daily adjusted time series data
     * @example https://www.alphavantage.co/query?function=TIME_SERIES_DAILY_ADJUSTED&symbol=IBM&apikey=demo
     */
    dailyAdjusted(params: DailyParams): Promise<DailyAdjustedResponse>;
    /**
     * Returns weekly time series of the equity specified.
     *
     * @param params - Parameters including symbol
     * @returns Promise resolving to weekly time series data
     * @example https://www.alphavantage.co/query?function=TIME_SERIES_WEEKLY&symbol=IBM&apikey=demo
     */
    weekly(params: DailyParams): Promise<WeeklyResponse>;
    /**
     * Returns weekly adjusted time series of the equity specified, adjusted for splits and dividends.
     *
     * @param params - Parameters including symbol
     * @returns Promise resolving to weekly adjusted time series data
     * @example https://www.alphavantage.co/query?function=TIME_SERIES_WEEKLY_ADJUSTED&symbol=IBM&apikey=demo
     */
    weeklyAdjusted(params: DailyParams): Promise<WeeklyAdjustedResponse>;
    /**
     * Returns monthly time series of the equity specified.
     *
     * @param params - Parameters including symbol
     * @returns Promise resolving to monthly time series data
     * @example https://www.alphavantage.co/query?function=TIME_SERIES_MONTHLY&symbol=IBM&apikey=demo
     */
    monthly(params: DailyParams): Promise<MonthlyResponse>;
    /**
     * Returns monthly adjusted time series of the equity specified, adjusted for splits and dividends.
     *
     * @param params - Parameters including symbol
     * @returns Promise resolving to monthly adjusted time series data
     * @example https://www.alphavantage.co/query?function=TIME_SERIES_MONTHLY_ADJUSTED&symbol=IBM&apikey=demo
     */
    monthlyAdjusted(params: DailyParams): Promise<MonthlyAdjustedResponse>;
    /**
     * Returns the latest price and volume information for a security of your choice.
     *
     * @param params - Parameters including symbol
     * @returns Promise resolving to global quote data
     * @example https://www.alphavantage.co/query?function=GLOBAL_QUOTE&symbol=IBM&apikey=demo
     */
    quote(params: QuoteParams): Promise<GlobalQuoteResponse>;
    /**
     * Returns the best-matching symbols and market information based on keywords of your choice.
     *
     * @param params - Parameters including search keywords
     * @returns Promise resolving to symbol search results
     * @example https://www.alphavantage.co/query?function=SYMBOL_SEARCH&keywords=tesco&apikey=demo
     */
    search(params: SearchParams): Promise<SearchResponse>;
}
//# sourceMappingURL=stocks.d.ts.map