tn-financial-data 0.1.1

package/dist/client/index.d.ts

@@ -0,0 +1,747 @@
+declare const FINANCIAL_PERIODS: readonly ["annual", "quarterly", "ttm"];
+type FinancialPeriod = (typeof FINANCIAL_PERIODS)[number];
+declare const PRICE_INTERVALS: readonly ["day", "1h"];
+type PriceInterval = (typeof PRICE_INTERVALS)[number];
+declare const INSIDER_TRADE_SECURITY_TYPES: readonly ["all", "non_derivative", "derivative"];
+type InsiderTradeSecurityType = (typeof INSIDER_TRADE_SECURITY_TYPES)[number];
+declare const SCREENER_API_OPERATORS: readonly ["lt", "gt", "lte", "gte", "eq", "in"];
+type ScreenerApiOperator = (typeof SCREENER_API_OPERATORS)[number];
+declare const SCREENER_CLI_OPERATORS: readonly ["<", ">", "<=", ">=", "=", "in"];
+type ScreenerCliOperator = (typeof SCREENER_CLI_OPERATORS)[number];
+declare const SCREENER_NUMERIC_API_OPERATORS: readonly ["lt", "gt", "lte", "gte", "eq"];
+type ScreenerNumericOperator = (typeof SCREENER_NUMERIC_API_OPERATORS)[number];
+type ScreenerFieldType = "numeric" | "string";
+type ScreenerFieldSource = "companies" | "key_statistics" | "analyst_price_targets";
+type ScreenerFieldValueEncoding = "decimal_ratio";
+interface ScreenerNumericFilter {
+    field: string;
+    operator: ScreenerNumericOperator;
+    value: number;
+}
+interface ScreenerStringEqFilter {
+    field: string;
+    operator: "eq";
+    value: string;
+}
+interface ScreenerStringInFilter {
+    field: string;
+    operator: "in";
+    value: string[];
+}
+type ScreenerFilter = ScreenerNumericFilter | ScreenerStringEqFilter | ScreenerStringInFilter;
+declare const GLOBAL_INTEREST_RATE_SERIES_KEYS: readonly ["ecb_refi", "ecb_deposit", "boj_call_money", "boe_sonia", "boc_call_money", "rba_3m", "snb_call_money"];
+type GlobalInterestRateSeriesKey = (typeof GLOBAL_INTEREST_RATE_SERIES_KEYS)[number];
+
+interface IncomeStatementData {
+    ticker: string;
+    reportPeriod: string;
+    fiscalPeriod: string;
+    period: string;
+    currency: string;
+    source: string | null;
+    sourceAccession: string | null;
+    sourceFiledAt: string | null;
+    sourceForm: string | null;
+    sourceFrame: string | null;
+    sourceUrl: string | null;
+    refreshedAt: string;
+    revenue: number | null;
+    costOfRevenue: number | null;
+    grossProfit: number | null;
+    operatingExpense: number | null;
+    sellingGeneralAndAdministrativeExpenses: number | null;
+    researchAndDevelopment: number | null;
+    operatingIncome: number | null;
+    interestExpense: number | null;
+    ebit: number | null;
+    incomeTaxExpense: number | null;
+    netIncomeDiscontinuedOperations: number | null;
+    netIncomeNonControllingInterests: number | null;
+    netIncome: number | null;
+    netIncomeCommonStock: number | null;
+    earningsPerShare: number | null;
+    earningsPerShareDiluted: number | null;
+    weightedAverageShares: number | null;
+    weightedAverageSharesDiluted: number | null;
+    dividendsPerCommonShare: number | null;
+    preferredDividendsImpact: number | null;
+    consolidatedIncome: number | null;
+    consensusActualEps: number | null;
+    consensusEstimateEps: number | null;
+    consensusEpsDifference: number | null;
+    consensusEpsSurprisePct: number | null;
+}
+interface BalanceSheetData {
+    ticker: string;
+    reportPeriod: string;
+    fiscalPeriod: string;
+    period: string;
+    currency: string;
+    source: string | null;
+    sourceAccession: string | null;
+    sourceFiledAt: string | null;
+    sourceForm: string | null;
+    sourceFrame: string | null;
+    sourceUrl: string | null;
+    refreshedAt: string;
+    totalAssets: number | null;
+    currentAssets: number | null;
+    cashAndEquivalents: number | null;
+    cashAndShortTermInvestments: number | null;
+    inventory: number | null;
+    currentInvestments: number | null;
+    tradeAndNonTradeReceivables: number | null;
+    accountsReceivable: number | null;
+    nonCurrentAssets: number | null;
+    propertyPlantAndEquipment: number | null;
+    goodwillAndIntangibleAssets: number | null;
+    investments: number | null;
+    totalLiabilities: number | null;
+    currentLiabilities: number | null;
+    currentDebt: number | null;
+    tradeAndNonTradePayables: number | null;
+    accountsPayable: number | null;
+    nonCurrentLiabilities: number | null;
+    nonCurrentDebt: number | null;
+    totalDebt: number | null;
+    shareholdersEquity: number | null;
+    minorityInterest: number | null;
+    retainedEarnings: number | null;
+    accumulatedOtherComprehensiveIncomeLoss: number | null;
+    treasuryStock: number | null;
+    outstandingShares: number | null;
+}
+interface CashFlowData {
+    ticker: string;
+    reportPeriod: string;
+    fiscalPeriod: string;
+    period: string;
+    currency: string;
+    source: string | null;
+    sourceAccession: string | null;
+    sourceFiledAt: string | null;
+    sourceForm: string | null;
+    sourceFrame: string | null;
+    sourceUrl: string | null;
+    refreshedAt: string;
+    netIncome: number | null;
+    depreciationAndAmortization: number | null;
+    shareBasedCompensation: number | null;
+    netCashFlowFromOperations: number | null;
+    capitalExpenditure: number | null;
+    businessAcquisitionsAndDisposals: number | null;
+    investmentAcquisitionsAndDisposals: number | null;
+    netCashFlowFromInvesting: number | null;
+    issuanceOrRepaymentOfDebtSecurities: number | null;
+    issuanceOrPurchaseOfEquityShares: number | null;
+    dividendsAndOtherCashDistributions: number | null;
+    netCashFlowFromFinancing: number | null;
+    changeInCashAndEquivalents: number | null;
+    effectOfExchangeRateChanges: number | null;
+    endingCashBalance: number | null;
+    freeCashFlow: number | null;
+}
+interface PriceData {
+    ticker: string;
+    interval: PriceInterval;
+    time: string;
+    refreshedAt: string;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume: number;
+}
+interface CompanyFactsData {
+    ticker: string;
+    name: string;
+    cik: string | null;
+    isActive: boolean;
+    sicCode: string | null;
+    location: string | null;
+    updatedAt: string;
+    refreshedAt: string;
+}
+interface KeyStatisticsData {
+    ticker: string;
+    marketCap: number | null;
+    enterpriseValue: number | null;
+    trailingPe: number | null;
+    forwardPe: number | null;
+    pegRatio: number | null;
+    priceToSales: number | null;
+    priceToBook: number | null;
+    evToRevenue: number | null;
+    evToEbitda: number | null;
+    ebitda: number | null;
+    revenuePerShare: number | null;
+    profitMargin: number | null;
+    operatingMargin: number | null;
+    returnOnAssets: number | null;
+    returnOnEquity: number | null;
+    quarterlyRevenueGrowth: number | null;
+    quarterlyEarningsGrowth: number | null;
+    beta: number | null;
+    sharesOutstanding: number | null;
+    floatShares: number | null;
+    shortRatio: number | null;
+    currentRatio: number | null;
+    debtToEquity: number | null;
+    totalCash: number | null;
+    totalCashPerShare: number | null;
+    totalDebt: number | null;
+    quickRatio: number | null;
+    bookValue: number | null;
+    operatingCashflow: number | null;
+    freeCashflow: number | null;
+    grossMargins: number | null;
+    ebitdaMargins: number | null;
+    grossProfits: number | null;
+    trailingEps: number | null;
+    forwardEps: number | null;
+    payoutRatio: number | null;
+    sharesShort: number | null;
+    shortPercentOfFloat: number | null;
+    refreshedAt: string;
+}
+interface AnalystEstimateData {
+    ticker: string;
+    periodLabel: string;
+    endDate: string | null;
+    epsAvg: number | null;
+    epsLow: number | null;
+    epsHigh: number | null;
+    epsYearAgo: number | null;
+    epsGrowth: number | null;
+    numberOfEpsAnalysts: number | null;
+    revenueAvg: number | null;
+    revenueLow: number | null;
+    revenueHigh: number | null;
+    revenueYearAgo: number | null;
+    revenueGrowth: number | null;
+    numberOfRevenueAnalysts: number | null;
+    epsTrendCurrent: number | null;
+    epsTrend7dAgo: number | null;
+    epsTrend30dAgo: number | null;
+    epsTrend60dAgo: number | null;
+    epsTrend90dAgo: number | null;
+    epsRevisionsUp7d: number | null;
+    epsRevisionsUp30d: number | null;
+    epsRevisionsDown7d: number | null;
+    epsRevisionsDown30d: number | null;
+    growthEstimateStock: number | null;
+    growthEstimateIndex: number | null;
+    refreshedAt: string;
+}
+interface AnalystPriceTargetData {
+    ticker: string;
+    targetHigh: number | null;
+    targetLow: number | null;
+    targetMean: number | null;
+    targetMedian: number | null;
+    numberOfAnalysts: number | null;
+    recommendationKey: string | null;
+    recommendationMean: number | null;
+    refreshedAt: string;
+}
+
+interface ClientOptions {
+    apiKey: string;
+    baseUrl?: string;
+    fetch?: typeof fetch;
+}
+type SnakeCase<T extends string> = T extends `${infer Head}${infer Tail}` ? Tail extends Uncapitalize<Tail> ? `${Lowercase<Head>}${SnakeCase<Tail>}` : `${Lowercase<Head>}_${SnakeCase<Tail>}` : T;
+type SnakeCasedProperties<T> = {
+    [Key in keyof T as Key extends string ? SnakeCase<Key> : Key]: T[Key];
+};
+type IncomeStatement = SnakeCasedProperties<IncomeStatementData>;
+type BalanceSheet = SnakeCasedProperties<BalanceSheetData>;
+type CashFlowStatement = SnakeCasedProperties<CashFlowData>;
+type PriceBar = Omit<SnakeCasedProperties<PriceData>, "ticker">;
+type CompanyFacts = SnakeCasedProperties<CompanyFactsData>;
+type KeyStatistics = SnakeCasedProperties<KeyStatisticsData>;
+type DataAvailability = "ready" | "no_data";
+type ConsensusSurprise = "BEAT" | "MISS" | "MEET";
+interface FinancialMetricData {
+    ticker: string;
+    reportPeriod: string;
+    fiscalPeriod: string;
+    period: FinancialPeriod;
+    currency: string;
+    refreshedAt: string;
+    grossMargin: number | null;
+    operatingMargin: number | null;
+    netMargin: number | null;
+    ebitMargin: number | null;
+    ebitdaMargin: number | null;
+    freeCashFlowMargin: number | null;
+    operatingCashFlowMargin: number | null;
+    returnOnAssets: number | null;
+    returnOnEquity: number | null;
+    returnOnInvestedCapital: number | null;
+    assetTurnover: number | null;
+    currentRatio: number | null;
+    quickRatio: number | null;
+    cashRatio: number | null;
+    debtToEquity: number | null;
+    debtToAssets: number | null;
+    netDebtToEbitda: number | null;
+    interestCoverage: number | null;
+    bookValuePerShare: number | null;
+    tangibleBookValuePerShare: number | null;
+    earningsPerShare: number | null;
+    freeCashFlowPerShare: number | null;
+    revenuePerShare: number | null;
+    netCash: number | null;
+    workingCapital: number | null;
+    revenueGrowthYoy: number | null;
+    earningsGrowthYoy: number | null;
+    bookValueGrowthYoy: number | null;
+    epsGrowthYoy: number | null;
+    freeCashFlowGrowthYoy: number | null;
+    ebitdaGrowthYoy: number | null;
+}
+interface EarningsRowData {
+    ticker: string;
+    reportPeriod: string;
+    fiscalPeriod: string | null;
+    period: FinancialPeriod;
+    currency: string;
+    refreshedAt: string;
+    earningsReleaseAt: string | null;
+    earningsCallAt: string | null;
+    earningsReleaseSourceUrl: string | null;
+    earningsCallSourceUrl: string | null;
+    revenue: number | null;
+    netIncome: number | null;
+    netIncomeCommonStock: number | null;
+    ebitda: number | null;
+    freeCashFlow: number | null;
+    reportedEps: number | null;
+    reportedEpsDiluted: number | null;
+    consensusActualEps: number | null;
+    consensusEstimateEps: number | null;
+    consensusEpsDifference: number | null;
+    consensusEpsSurprisePct: number | null;
+    consensusSurprise: ConsensusSurprise | null;
+    revenueGrowthYoy: number | null;
+    earningsGrowthYoy: number | null;
+    epsGrowthYoy: number | null;
+    freeCashFlowGrowthYoy: number | null;
+    ebitdaGrowthYoy: number | null;
+}
+type FinancialMetric = SnakeCasedProperties<FinancialMetricData>;
+type EarningsRow = SnakeCasedProperties<EarningsRowData>;
+interface NewsArticle {
+    uuid: string;
+    title: string;
+    publisher: string | null;
+    report_date: string;
+    published_at: string | null;
+    related_tickers: string[];
+    type: string | null;
+    link: string | null;
+    summary: string | null;
+    refreshed_at: string;
+}
+interface ReadMetadata {
+    ticker: string;
+    availability: DataAvailability;
+    as_of: string | null;
+}
+interface PriceSnapshot {
+    ticker: string;
+    interval: PriceInterval;
+    refreshed_at: string;
+    price: number;
+    time: string;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume: number;
+}
+interface ReportPeriodFilterOpts {
+    reportPeriod?: string;
+    reportPeriodGte?: string;
+    reportPeriodLte?: string;
+    reportPeriodGt?: string;
+    reportPeriodLt?: string;
+}
+interface FinancialOpts extends ReportPeriodFilterOpts {
+    period: FinancialPeriod;
+    limit?: number;
+}
+interface PriceOpts {
+    interval: PriceInterval;
+    startDate: string;
+    endDate: string;
+}
+interface NewsOpts {
+    limit?: number;
+    startDate?: string;
+    endDate?: string;
+    publisher?: string;
+}
+interface InsiderTradesOpts {
+    limit?: number;
+    startDate?: string;
+    endDate?: string;
+    reportingOwnerCik?: string;
+    transactionCodes?: readonly string[];
+    securityType?: InsiderTradeSecurityType;
+}
+interface OptionalFinancialQueryOpts extends ReportPeriodFilterOpts {
+    period?: FinancialPeriod;
+    limit?: number;
+}
+interface FinancialMetricsOpts extends OptionalFinancialQueryOpts {
+}
+interface EarningsOpts extends OptionalFinancialQueryOpts {
+}
+interface QuarterlyHighlightsOpts {
+    reportPeriod?: string;
+}
+interface GeneralOverviewOpts {
+    period?: FinancialPeriod;
+    financialLimit?: number;
+    newsLimit?: number;
+}
+interface InstitutionalOwnershipOpts {
+    limit?: number;
+}
+interface InvestorPortfolioOpts {
+    cik?: string;
+    investor?: string;
+    limit?: number;
+}
+interface GlobalInterestRatesOpts {
+    limit?: number;
+    startDate?: string;
+    endDate?: string;
+    series?: readonly GlobalInterestRateSeriesKey[];
+}
+interface IncomeStatementsResponse extends ReadMetadata {
+    period: FinancialPeriod;
+    income_statements: IncomeStatement[];
+}
+interface BalanceSheetsResponse extends ReadMetadata {
+    period: FinancialPeriod;
+    balance_sheets: BalanceSheet[];
+}
+interface CashFlowStatementsResponse extends ReadMetadata {
+    period: FinancialPeriod;
+    cash_flow_statements: CashFlowStatement[];
+}
+interface FinancialsResponse extends ReadMetadata {
+    period: FinancialPeriod;
+    financials: {
+        income_statements: IncomeStatement[];
+        balance_sheets: BalanceSheet[];
+        cash_flow_statements: CashFlowStatement[];
+        key_statistics: KeyStatistics | null;
+    };
+}
+interface FinancialMetricsResponse extends ReadMetadata {
+    period: FinancialPeriod;
+    financial_metrics: FinancialMetric[];
+}
+interface FinancialMetricsSnapshotResponse extends ReadMetadata {
+    period: FinancialPeriod;
+    snapshot: {
+        metrics: FinancialMetric | null;
+        price_snapshot: PriceSnapshot | null;
+        key_statistics: KeyStatistics | null;
+    } | null;
+}
+interface EarningsResponse extends ReadMetadata {
+    period: FinancialPeriod;
+    earnings: EarningsRow[];
+}
+interface KeyStatisticsResponse {
+    ticker: string;
+    availability: DataAvailability;
+    as_of: string | null;
+    key_statistics: KeyStatistics | null;
+}
+interface AvailableTicker {
+    ticker: string;
+    name: string;
+    financials_updated_at: string | null;
+    news_updated_at: string | null;
+    updated_at: string;
+}
+interface AvailableTickersResponse {
+    as_of: string | null;
+    tickers: AvailableTicker[];
+}
+interface PriceHistoryResponse extends ReadMetadata {
+    interval: PriceInterval;
+    prices: PriceBar[];
+}
+interface NewsResponse extends ReadMetadata {
+    news: NewsArticle[];
+}
+interface InsiderTrade {
+    filing_accession: string;
+    filing_date: string;
+    filing_accepted_at: string | null;
+    filing_url: string;
+    document_type: string;
+    is_amendment: boolean;
+    date_of_original_submission: string | null;
+    period_of_report: string;
+    reporting_owner_cik: string | null;
+    reporting_owner_name: string;
+    is_director: boolean;
+    is_officer: boolean;
+    is_ten_percent_owner: boolean;
+    is_other: boolean;
+    officer_title: string | null;
+    other_text: string | null;
+    security_type: "non_derivative" | "derivative";
+    filing_section_row_number: number;
+    security_title: string;
+    transaction_date: string;
+    deemed_execution_date: string | null;
+    transaction_code: string;
+    transaction_shares: number;
+    transaction_price_per_share: number | null;
+    transaction_acquired_disposed_code: string;
+    shares_owned_following_transaction: number | null;
+    direct_or_indirect_ownership: string | null;
+    nature_of_ownership: string | null;
+    conversion_or_exercise_price: number | null;
+    exercise_date: string | null;
+    expiration_date: string | null;
+    underlying_security_title: string | null;
+    underlying_security_shares: number | null;
+    remarks: string | null;
+    footnotes: string[];
+    supersedes_key: string;
+    refreshed_at: string;
+}
+interface InsiderTradesResponse extends ReadMetadata {
+    count: number;
+    limit: number;
+    insider_trades: InsiderTrade[];
+}
+interface GeneralOverviewFinancials {
+    availability: DataAvailability;
+    as_of: string | null;
+    income_statements: IncomeStatement[];
+    balance_sheets: BalanceSheet[];
+    cash_flow_statements: CashFlowStatement[];
+    key_statistics: KeyStatistics | null;
+}
+interface GeneralOverviewPriceSnapshot {
+    availability: DataAvailability;
+    as_of: string | null;
+    snapshot: PriceSnapshot | null;
+}
+interface GeneralOverviewNews {
+    availability: DataAvailability;
+    as_of: string | null;
+    articles: NewsArticle[];
+}
+interface GeneralOverviewResponse extends ReadMetadata {
+    period: FinancialPeriod;
+    company_facts: CompanyFacts;
+    financials: GeneralOverviewFinancials;
+    price_snapshot: GeneralOverviewPriceSnapshot;
+    news: GeneralOverviewNews;
+}
+interface InstitutionalOwnershipEntry {
+    holder_name: string;
+    reported_at: string | null;
+    shares: number | null;
+    value: number | null;
+    pct_held: number | null;
+    pct_change: number | null;
+}
+interface InstitutionalOwnershipResponse extends ReadMetadata {
+    source: "yahoo_finance";
+    ownership: InstitutionalOwnershipEntry[];
+}
+interface InvestorPortfolioInvestor {
+    cik: string;
+    name: string;
+}
+interface InvestorPortfolioSummary {
+    accession_number: string | null;
+    holdings_reported: number | null;
+    holdings_returned: number;
+    total_value: number | null;
+}
+interface InvestorPortfolioHolding {
+    issuer: string;
+    class_title: string | null;
+    cusip: string | null;
+    value: number | null;
+    shares: number | null;
+    share_type: string | null;
+    put_call: string | null;
+    investment_discretion: string | null;
+    voting_authority_sole: number | null;
+    voting_authority_shared: number | null;
+    voting_authority_none: number | null;
+}
+interface InvestorPortfolioResponse {
+    source: "sec_13f";
+    availability: DataAvailability;
+    as_of: string | null;
+    investor: InvestorPortfolioInvestor;
+    report_period: string | null;
+    filing_date: string | null;
+    summary: InvestorPortfolioSummary;
+    holdings: InvestorPortfolioHolding[];
+}
+interface GlobalInterestRateObservation {
+    date: string;
+    value: number;
+}
+interface GlobalInterestRateSeries {
+    key: GlobalInterestRateSeriesKey;
+    series_id: string;
+    label: string;
+    region: string;
+    country_code: string;
+    frequency: "daily" | "monthly";
+    latest: GlobalInterestRateObservation | null;
+    observations: GlobalInterestRateObservation[];
+}
+interface GlobalInterestRatesResponse {
+    source: "fred";
+    availability: DataAvailability;
+    as_of: string | null;
+    rates: GlobalInterestRateSeries[];
+}
+type AnalystEstimate = SnakeCasedProperties<Omit<AnalystEstimateData, "ticker">>;
+type AnalystPriceTarget = SnakeCasedProperties<AnalystPriceTargetData>;
+interface AnalystEstimatesResponse {
+    ticker: string;
+    availability: DataAvailability;
+    as_of: string | null;
+    analyst_estimates: AnalystEstimate[];
+    price_targets: AnalystPriceTarget | null;
+}
+interface PriceSnapshotResponse extends ReadMetadata {
+    snapshot: PriceSnapshot | null;
+}
+interface SegmentedRevenueItem {
+    name: string;
+    amount: number | null;
+    segments: Array<{
+        label: string;
+        type: string;
+    }>;
+}
+interface SegmentedRevenuePeriod {
+    ticker: string;
+    report_period: string;
+    period: string;
+    items: SegmentedRevenueItem[];
+}
+interface SegmentedRevenuesResponse extends ReadMetadata {
+    period: FinancialPeriod;
+    segmented_revenues: SegmentedRevenuePeriod[];
+}
+interface QuarterlyHighlightsMetric {
+    key: string;
+    label: string;
+    category: string;
+    unit: "usd" | "count" | "decimal_ratio";
+    value: number;
+    yoy_change: number | null;
+}
+interface QuarterlyHighlightsPayload {
+    ticker: string;
+    report_period: string;
+    period: "quarterly";
+    source_quarter_label: string | null;
+    source_url: string;
+    refreshed_at: string;
+    metrics: QuarterlyHighlightsMetric[];
+}
+interface QuarterlyHighlightsResponse extends ReadMetadata {
+    quarterly_highlights: QuarterlyHighlightsPayload | null;
+}
+interface SegmentedRevenuesOpts extends ReportPeriodFilterOpts {
+    period: FinancialPeriod;
+    limit?: number;
+    segmentType?: string;
+}
+interface ScreenerFieldMetadata {
+    name: string;
+    type: ScreenerFieldType;
+    source: ScreenerFieldSource;
+    operators: ScreenerApiOperator[];
+    cli_operators: ScreenerCliOperator[];
+    value_encoding?: ScreenerFieldValueEncoding;
+    value_example?: string;
+}
+interface ScreenerFieldsResponse {
+    fields: ScreenerFieldMetadata[];
+}
+interface ScreenerRequest {
+    filters: ScreenerFilter[];
+    limit?: number;
+}
+interface ScreenerResultRow {
+    ticker: string;
+    name: string;
+    market_cap: number | null;
+    [key: string]: string | number | null;
+}
+interface ScreenerResponse {
+    as_of: string | null;
+    count: number;
+    limit: number;
+    has_more: boolean;
+    filters_applied: ScreenerFilter[];
+    results: ScreenerResultRow[];
+}
+declare const DEFAULT_API_BASE_URL = "https://api.truenorth-financial.ai/v1";
+declare class TnFinancialData {
+    private apiKey;
+    private baseUrl;
+    private fetchFn;
+    constructor(opts: ClientOptions);
+    private request;
+    private extractErrorMessage;
+    private appendLimitParam;
+    private appendReportPeriodParams;
+    private buildFinancialParams;
+    private buildGeneralOverviewParams;
+    private buildOptionalFinancialParams;
+    private buildSegmentedRevenueParams;
+    private buildQuarterlyHighlightsParams;
+    private buildInsiderTradeParams;
+    getIncomeStatements(ticker: string, opts: FinancialOpts): Promise<IncomeStatementsResponse>;
+    getBalanceSheets(ticker: string, opts: FinancialOpts): Promise<BalanceSheetsResponse>;
+    getCashFlowStatements(ticker: string, opts: FinancialOpts): Promise<CashFlowStatementsResponse>;
+    getFinancials(ticker: string, opts: FinancialOpts): Promise<FinancialsResponse>;
+    getFinancialMetrics(ticker: string, opts?: FinancialMetricsOpts): Promise<FinancialMetricsResponse>;
+    getFinancialMetricsSnapshot(ticker: string, opts?: Pick<FinancialMetricsOpts, "period">): Promise<FinancialMetricsSnapshotResponse>;
+    getEarnings(ticker: string, opts?: EarningsOpts): Promise<EarningsResponse>;
+    getGeneralOverview(ticker: string, opts?: GeneralOverviewOpts): Promise<GeneralOverviewResponse>;
+    getKeyStatistics(ticker: string): Promise<KeyStatisticsResponse>;
+    getAvailableTickers(): Promise<AvailableTickersResponse>;
+    getPrices(ticker: string, opts: PriceOpts): Promise<PriceHistoryResponse>;
+    getPriceSnapshot(ticker: string): Promise<PriceSnapshotResponse>;
+    getNews(ticker: string, opts?: NewsOpts): Promise<NewsResponse>;
+    getInsiderTrades(ticker: string, opts?: InsiderTradesOpts): Promise<InsiderTradesResponse>;
+    getInstitutionalOwnership(ticker: string, opts?: InstitutionalOwnershipOpts): Promise<InstitutionalOwnershipResponse>;
+    getInvestorPortfolio(opts: InvestorPortfolioOpts): Promise<InvestorPortfolioResponse>;
+    getGlobalInterestRates(opts?: GlobalInterestRatesOpts): Promise<GlobalInterestRatesResponse>;
+    getAnalystEstimates(ticker: string): Promise<AnalystEstimatesResponse>;
+    getCompanyFacts(ticker: string): Promise<{
+        company_facts: CompanyFacts;
+    }>;
+    getSegmentedRevenues(ticker: string, opts: SegmentedRevenuesOpts): Promise<SegmentedRevenuesResponse>;
+    getQuarterlyHighlights(ticker: string, opts?: QuarterlyHighlightsOpts): Promise<QuarterlyHighlightsResponse>;
+    getScreenerFields(): Promise<ScreenerFieldsResponse>;
+    screen(request: ScreenerRequest): Promise<ScreenerResponse>;
+}
+
+export { type AnalystEstimate, type AnalystEstimatesResponse, type AnalystPriceTarget, type AvailableTicker, type AvailableTickersResponse, type BalanceSheet, type BalanceSheetsResponse, type CashFlowStatement, type CashFlowStatementsResponse, type ClientOptions, type CompanyFacts, type ConsensusSurprise, DEFAULT_API_BASE_URL, type DataAvailability, type EarningsOpts, type EarningsResponse, type EarningsRow, type FinancialMetric, type FinancialMetricsOpts, type FinancialMetricsResponse, type FinancialMetricsSnapshotResponse, type FinancialOpts, type FinancialsResponse, type GeneralOverviewFinancials, type GeneralOverviewNews, type GeneralOverviewOpts, type GeneralOverviewPriceSnapshot, type GeneralOverviewResponse, type GlobalInterestRateObservation, type GlobalInterestRateSeries, type GlobalInterestRatesOpts, type GlobalInterestRatesResponse, type IncomeStatement, type IncomeStatementsResponse, type InsiderTrade, type InsiderTradesOpts, type InsiderTradesResponse, type InstitutionalOwnershipEntry, type InstitutionalOwnershipOpts, type InstitutionalOwnershipResponse, type InvestorPortfolioHolding, type InvestorPortfolioInvestor, type InvestorPortfolioOpts, type InvestorPortfolioResponse, type InvestorPortfolioSummary, type KeyStatistics, type KeyStatisticsResponse, type NewsArticle, type NewsOpts, type NewsResponse, type OptionalFinancialQueryOpts, type PriceBar, type PriceHistoryResponse, type PriceOpts, type PriceSnapshot, type PriceSnapshotResponse, type QuarterlyHighlightsMetric, type QuarterlyHighlightsOpts, type QuarterlyHighlightsPayload, type QuarterlyHighlightsResponse, type ReadMetadata, type ReportPeriodFilterOpts, type ScreenerFieldMetadata, type ScreenerFieldsResponse, type ScreenerRequest, type ScreenerResponse, type ScreenerResultRow, type SegmentedRevenueItem, type SegmentedRevenuePeriod, type SegmentedRevenuesOpts, type SegmentedRevenuesResponse, type SnakeCase, TnFinancialData };