client-twelve-data-rapidapi/dist/endpoints/fundamentals.d.ts

Complete TypeScript library for Twelve Data API with 154 endpoints, technical indicators, and intelligent rate limiting

import type { HttpClient } from '../utils/http-client.js';
import type { LogoParams, ProfileParams, DividendsParams, SplitsParams, EarningsParams, EarningsCalendarParams, IPOCalendarParams, StatisticsParams, InsiderTransactionsParams, IncomeStatementParams, BalanceSheetParams, CashFlowParams, OptionsExpirationParams, OptionsChainParams, KeyExecutivesParams, FundHoldersParams, InstitutionalHoldersParams, ApiResponse, LogoData, ProfileData, DividendData, SplitData, EarningsData, EarningsCalendarData, IPOCalendarData, StatisticsData, InsiderTransactionData, IncomeStatementData, BalanceSheetData, CashFlowData, OptionsExpirationData, OptionsChainData, KeyExecutiveData, FundHolderData, InstitutionalHolderData } from '../types/index.js';
/**
 * Fundamentals endpoints for Twelve Data API
 * Provides access to company fundamentals, financial statements, and analyst data
 */
export declare class FundamentalsEndpoints {
    private httpClient;
    constructor(httpClient: HttpClient);
    /**
     * Get company logo
     * @param params - Parameters including the symbol
     * @returns Promise with company logo URL
     */
    getLogo(params: LogoParams): Promise<ApiResponse<LogoData>>;
    /**
     * Get company profile and overview
     * @param params - Parameters including the symbol
     * @returns Promise with comprehensive company profile
     */
    getProfile(params: ProfileParams): Promise<ApiResponse<ProfileData>>;
    /**
     * Get dividend history
     * @param params - Parameters including the symbol and date range
     * @returns Promise with dividend history data
     */
    getDividends(params: DividendsParams): Promise<ApiResponse<DividendData[]>>;
    /**
     * Get stock splits history
     * @param params - Parameters including the symbol and date range
     * @returns Promise with stock splits data
     */
    getSplits(params: SplitsParams): Promise<ApiResponse<SplitData[]>>;
    /**
     * Get earnings history
     * @param params - Parameters including the symbol and period
     * @returns Promise with earnings data
     */
    getEarnings(params: EarningsParams): Promise<ApiResponse<EarningsData[]>>;
    /**
     * Get earnings calendar
     * @param params - Parameters for filtering earnings calendar
     * @returns Promise with upcoming earnings announcements
     */
    getEarningsCalendar(params?: EarningsCalendarParams): Promise<ApiResponse<EarningsCalendarData[]>>;
    /**
     * Get IPO calendar
     * @param params - Parameters for filtering IPO calendar
     * @returns Promise with upcoming IPOs
     */
    getIPOCalendar(params?: IPOCalendarParams): Promise<ApiResponse<IPOCalendarData[]>>;
    /**
     * Get company statistics
     * @param params - Parameters including the symbol
     * @returns Promise with comprehensive company statistics
     */
    getStatistics(params: StatisticsParams): Promise<ApiResponse<StatisticsData>>;
    /**
     * Get insider transactions
     * @param params - Parameters including the symbol
     * @returns Promise with insider trading data
     */
    getInsiderTransactions(params: InsiderTransactionsParams): Promise<ApiResponse<InsiderTransactionData[]>>;
    /**
     * Get income statement
     * @param params - Parameters including the symbol and period
     * @returns Promise with income statement data
     */
    getIncomeStatement(params: IncomeStatementParams): Promise<ApiResponse<IncomeStatementData[]>>;
    /**
     * Get balance sheet
     * @param params - Parameters including the symbol and period
     * @returns Promise with balance sheet data
     */
    getBalanceSheet(params: BalanceSheetParams): Promise<ApiResponse<BalanceSheetData[]>>;
    /**
     * Get cash flow statement
     * @param params - Parameters including the symbol and period
     * @returns Promise with cash flow data
     */
    getCashFlow(params: CashFlowParams): Promise<ApiResponse<CashFlowData[]>>;
    /**
     * Get options expiration dates
     * @param params - Parameters including the symbol
     * @returns Promise with options expiration dates
     */
    getOptionsExpiration(params: OptionsExpirationParams): Promise<ApiResponse<OptionsExpirationData>>;
    /**
     * Get options chain
     * @param params - Parameters including the symbol and filters
     * @returns Promise with options chain data
     */
    getOptionsChain(params: OptionsChainParams): Promise<ApiResponse<OptionsChainData>>;
    /**
     * Get key executives
     * @param params - Parameters including the symbol
     * @returns Promise with key executives data
     */
    getKeyExecutives(params: KeyExecutivesParams): Promise<ApiResponse<KeyExecutiveData>>;
    /**
     * Get fund holders
     * @param params - Parameters including the symbol
     * @returns Promise with fund holders data
     */
    getFundHolders(params: FundHoldersParams): Promise<ApiResponse<FundHolderData[]>>;
    /**
     * Get institutional holders
     * @param params - Parameters including the symbol
     * @returns Promise with institutional holders data
     */
    getInstitutionalHolders(params: InstitutionalHoldersParams): Promise<ApiResponse<InstitutionalHolderData[]>>;
}