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

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

import { AlphaVantageClient } from '../client';
import { CompanyOverviewParams, EarningsParams, ListingStatusParams, FinancialStatementParams, CompanyOverview, EarningsResponse, ListingStatusResponse, FinancialStatementResponse, EarningsCalendarResponse, IPOCalendarResponse, DividendCalendarResponse, SplitsCalendarResponse, ETFProfileResponse, ETFHoldingsResponse } from '../types/fundamental';
export declare class Fundamental {
    private client;
    constructor(client: AlphaVantageClient);
    /**
     * Returns the company information, financial ratios, and other key metrics for the equity specified.
     *
     * @param params - Parameters including the symbol for company overview
     * @returns Promise resolving to company overview data
     * @example https://www.alphavantage.co/query?function=OVERVIEW&symbol=IBM&apikey=demo
     */
    companyOverview(params: CompanyOverviewParams): Promise<CompanyOverview>;
    /**
     * Returns the annual and quarterly income statements for the company of interest.
     *
     * @param params - Parameters including the symbol for income statement
     * @returns Promise resolving to income statement data
     * @example https://www.alphavantage.co/query?function=INCOME_STATEMENT&symbol=IBM&apikey=demo
     */
    incomeStatement(params: FinancialStatementParams): Promise<FinancialStatementResponse>;
    /**
     * Returns the annual and quarterly balance sheets for the company of interest.
     *
     * @param params - Parameters including the symbol for balance sheet
     * @returns Promise resolving to balance sheet data
     * @example https://www.alphavantage.co/query?function=BALANCE_SHEET&symbol=IBM&apikey=demo
     */
    balanceSheet(params: FinancialStatementParams): Promise<FinancialStatementResponse>;
    /**
     * Returns the annual and quarterly cash flow for the company of interest.
     *
     * @param params - Parameters including the symbol for cash flow
     * @returns Promise resolving to cash flow data
     * @example https://www.alphavantage.co/query?function=CASH_FLOW&symbol=IBM&apikey=demo
     */
    cashFlow(params: FinancialStatementParams): Promise<FinancialStatementResponse>;
    /**
     * Returns the annual and quarterly earnings (EPS) for the company of interest.
     *
     * @param params - Parameters including the symbol for earnings
     * @returns Promise resolving to earnings data
     * @example https://www.alphavantage.co/query?function=EARNINGS&symbol=IBM&apikey=demo
     */
    earnings(params: EarningsParams): Promise<EarningsResponse>;
    /**
     * Returns a list of active or delisted US stocks and ETFs, either as of the latest trading day or at a specific date in history.
     *
     * @param params - Parameters for listing status including optional date and state
     * @returns Promise resolving to listing status data
     * @example https://www.alphavantage.co/query?function=LISTING_STATUS&apikey=demo
     */
    listingStatus(params: ListingStatusParams): Promise<ListingStatusResponse>;
    /**
     * Returns a JSON array of expected company earnings in the next 3, 6, or 12 months.
     *
     * @param params - Parameters for earnings calendar
     * @returns Promise resolving to earnings calendar data
     * @example https://www.alphavantage.co/query?function=EARNINGS_CALENDAR&horizon=3month&apikey=demo
     */
    earningsCalendar(params: ListingStatusParams): Promise<EarningsCalendarResponse>;
    /**
     * Returns a JSON array of IPO events expected in the next 3 months.
     *
     * @param params - Parameters for IPO calendar
     * @returns Promise resolving to IPO calendar data
     * @example https://www.alphavantage.co/query?function=IPO_CALENDAR&apikey=demo
     */
    ipoCalendar(params: ListingStatusParams): Promise<IPOCalendarResponse>;
    /**
     * Returns a JSON array of dividend payments by publicly-traded companies in the next 3 months.
     *
     * @param params - Parameters for dividend calendar
     * @returns Promise resolving to dividend calendar data
     * @example https://www.alphavantage.co/query?function=DIVIDEND_CALENDAR&apikey=demo
     */
    dividendCalendar(params: ListingStatusParams): Promise<DividendCalendarResponse>;
    /**
     * Returns a JSON array of stock split events in the next 3 months.
     *
     * @param params - Parameters for splits calendar
     * @returns Promise resolving to splits calendar data
     * @example https://www.alphavantage.co/query?function=SPLITS_CALENDAR&apikey=demo
     */
    splitsCalendar(params: ListingStatusParams): Promise<SplitsCalendarResponse>;
    /**
     * Returns the profile and key information for any given ETF.
     *
     * @param params - Parameters including the ETF symbol
     * @returns Promise resolving to ETF profile data
     * @example https://www.alphavantage.co/query?function=ETF_PROFILE&symbol=QQQ&apikey=demo
     */
    etfProfile(params: CompanyOverviewParams): Promise<ETFProfileResponse>;
    /**
     * Returns the holdings data for any given ETF.
     *
     * @param params - Parameters including the ETF symbol
     * @returns Promise resolving to ETF holdings data
     * @example https://www.alphavantage.co/query?function=ETF_HOLDINGS&symbol=QQQ&apikey=demo
     */
    etfHoldings(params: CompanyOverviewParams): Promise<ETFHoldingsResponse>;
}
//# sourceMappingURL=fundamental.d.ts.map