Class FundamentalContext

Fundamental data context

Constructors

constructor

new FundamentalContext(): FundamentalContext

Returns FundamentalContext

Methods

`Static`new

new(config: Config): FundamentalContext
Create a new FundamentalContext
Parameters
- config: Config
Returns FundamentalContext

financialReport

financialReport(
    symbol: string,
    kind: FinancialReportKind,
    period?: FinancialReportPeriod | null,
): Promise<FinancialReports>
Get financial reports
Parameters
- symbol: string
- kind: FinancialReportKind
- Optionalperiod: FinancialReportPeriod | null
Returns Promise<FinancialReports>

institutionRating

institutionRating(symbol: string): Promise<InstitutionRating>
Get analyst ratings (latest + consensus summary)
Parameters
- symbol: string
Returns Promise<InstitutionRating>

institutionRatingDetail

institutionRatingDetail(symbol: string): Promise<InstitutionRatingDetail>
Get historical analyst rating details
Parameters
- symbol: string
Returns Promise<InstitutionRatingDetail>

dividend

dividend(symbol: string): Promise<DividendList>
Get dividend history
Parameters
- symbol: string
Returns Promise<DividendList>

dividendDetail

dividendDetail(symbol: string): Promise<DividendList>
Get detailed dividend information
Parameters
- symbol: string
Returns Promise<DividendList>

forecastEps

forecastEps(symbol: string): Promise<ForecastEps>
Get EPS forecasts
Parameters
- symbol: string
Returns Promise<ForecastEps>

consensus

consensus(symbol: string): Promise<FinancialConsensus>
Get financial consensus estimates
Parameters
- symbol: string
Returns Promise<FinancialConsensus>

valuation

valuation(symbol: string): Promise<ValuationData>
Get valuation metrics (PE / PB / PS / dividend yield)
Parameters
- symbol: string
Returns Promise<ValuationData>

valuationHistory

valuationHistory(symbol: string): Promise<ValuationHistoryResponse>
Get historical valuation data
Parameters
- symbol: string
Returns Promise<ValuationHistoryResponse>

industryValuation

industryValuation(symbol: string): Promise<IndustryValuationList>
Get industry peer valuation comparison
Parameters
- symbol: string
Returns Promise<IndustryValuationList>

industryValuationDist

industryValuationDist(symbol: string): Promise<IndustryValuationDist>
Get industry valuation distribution
Parameters
- symbol: string
Returns Promise<IndustryValuationDist>

company

company(symbol: string): Promise<CompanyOverview>
Get company overview
Parameters
- symbol: string
Returns Promise<CompanyOverview>

executive

executive(symbol: string): Promise<ExecutiveList>
Get executive and board member information
Parameters
- symbol: string
Returns Promise<ExecutiveList>

shareholder

shareholder(symbol: string): Promise<ShareholderList>
Get major shareholders
Parameters
- symbol: string
Returns Promise<ShareholderList>

fundHolder

fundHolder(symbol: string): Promise<FundHolders>
Get fund and ETF holders
Parameters
- symbol: string
Returns Promise<FundHolders>

corpAction

corpAction(symbol: string): Promise<CorpActions>
Get corporate actions
Parameters
- symbol: string
Returns Promise<CorpActions>

investRelation

investRelation(symbol: string): Promise<InvestRelations>
Get investor relations data
Parameters
- symbol: string
Returns Promise<InvestRelations>

operating

operating(symbol: string): Promise<OperatingList>
Get operating metrics and financial report summaries
Parameters
- symbol: string
Returns Promise<OperatingList>

buyback

buyback(symbol: string): Promise<BuybackData>
Get buyback data for a security
Parameters
- symbol: string
Returns Promise<BuybackData>

ratings

ratings(symbol: string): Promise<StockRatings>
Get stock ratings for a security
Parameters
- symbol: string
Returns Promise<StockRatings>

shareholderTop

shareholderTop(symbol: string): Promise<ShareholderTopResponse>
Get ranked list of top shareholders
Parameters
- symbol: string
Returns Promise<ShareholderTopResponse>

shareholderDetail

shareholderDetail(
symbol: string,
objectId: number,
): Promise<ShareholderDetailResponse>
Get holding history and detail for one shareholder
Parameters
- symbol: string
- objectId: number
Returns Promise<ShareholderDetailResponse>

valuationComparison

valuationComparison(
    symbol: string,
    currency: string,
    comparisonSymbols?: string[] | null,
): Promise<ValuationComparisonResponse>
Get valuation comparison between a security and optional peers
Parameters
- symbol: string
- currency: string
- OptionalcomparisonSymbols: string[] | null
Returns Promise<ValuationComparisonResponse>

etfAssetAllocation

etfAssetAllocation(symbol: string): Promise<AssetAllocationResponse>
Get ETF asset allocation (holdings / regional / asset class / industry)
Parameters
- symbol: string
Returns Promise<AssetAllocationResponse>

macroeconomicIndicators

macroeconomicIndicators(
    country?: MacroeconomicCountry | null,
    keyword?: string | null,
    offset?: number | null,
    limit?: number | null,
): Promise<MacroeconomicIndicatorListResponse>
List macroeconomic indicators
Parameters
- Optionalcountry: MacroeconomicCountry | null
- Optionalkeyword: string | null
- Optionaloffset: number | null
- Optionallimit: number | null
Returns Promise<MacroeconomicIndicatorListResponse>

macroeconomic

macroeconomic(
    indicatorCode: string,
    startDate?: string | null,
    endDate?: string | null,
    offset?: number | null,
    limit?: number | null,
): Promise<MacroeconomicResponse>
Get historical data for a macroeconomic indicator
Parameters
- indicatorCode: string
- OptionalstartDate: string | null
- OptionalendDate: string | null
- Optionaloffset: number | null
- Optionallimit: number | null
Returns Promise<MacroeconomicResponse>

usCompanyOverview

usCompanyOverview(symbol: string): Promise<USCompanyOverview>
Get US company overview. US token required.
Parameters
- symbol: string
Returns Promise<USCompanyOverview>

usValuationOverview

usValuationOverview(symbol: string): Promise<USValuationOverview>
Get US valuation overview. US token required.
Parameters
- symbol: string
Returns Promise<USValuationOverview>

usFinancialOverview

usFinancialOverview(
symbol: string,
report: string,
): Promise<USFinancialOverview>
Get US financial overview. US token required.
Parameters
- symbol: string
- report: string
Returns Promise<USFinancialOverview>

usFinancialStatement

usFinancialStatement(
    symbol: string,
    kind: string,
    report: string,
): Promise<USFinancialStatement>
Get US financial statement v3. kind: "IS"/"BS"/"CF". US token required.
Parameters
- symbol: string
- kind: string
- report: string
Returns Promise<USFinancialStatement>

usKeyFinancialMetrics

usKeyFinancialMetrics(
symbol: string,
report: string,
): Promise<USKeyFinancialMetrics>
Get US key financial metrics. US token required.
Parameters
- symbol: string
- report: string
Returns Promise<USKeyFinancialMetrics>

usAnalystConsensus

usAnalystConsensus(symbol: string, report: string): Promise<USAnalystConsensus>
Get US analyst consensus estimates. US token required.
Parameters
- symbol: string
- report: string
Returns Promise<USAnalystConsensus>

usEtfDividendInfo

usEtfDividendInfo(symbol: string): Promise<USETFDividendInfo>
Get US ETF dividend history. US token required.
Parameters
- symbol: string
Returns Promise<USETFDividendInfo>

usCompanyDividends

usCompanyDividends(symbol: string): Promise<USCompanyDividends>
Get US company dividends. US token required.
Parameters
- symbol: string
Returns Promise<USCompanyDividends>

usEtfFiles

usEtfFiles(symbol: string, size?: number | null): Promise<USETFFilesResponse>
Get US ETF document list. size=None returns all. US token required.
Parameters
- symbol: string
- Optionalsize: number | null
Returns Promise<USETFFilesResponse>

Class FundamentalContext

Index

Constructors

Methods

Constructors

constructor

Returns FundamentalContext

Methods

Staticnew

Parameters

Returns FundamentalContext

financialReport

Parameters

Returns Promise<FinancialReports>

institutionRating

Parameters

Returns Promise<InstitutionRating>

institutionRatingDetail

Parameters

Returns Promise<InstitutionRatingDetail>

dividend

Parameters

Returns Promise<DividendList>

dividendDetail

Parameters

Returns Promise<DividendList>

forecastEps

Parameters

Returns Promise<ForecastEps>

consensus

Parameters

Returns Promise<FinancialConsensus>

valuation

Parameters

Returns Promise<ValuationData>

valuationHistory

Parameters

Returns Promise<ValuationHistoryResponse>

industryValuation

Parameters

Returns Promise<IndustryValuationList>

industryValuationDist

Parameters

Returns Promise<IndustryValuationDist>

company

Parameters

Returns Promise<CompanyOverview>

executive

Parameters

Returns Promise<ExecutiveList>

shareholder

Parameters

Returns Promise<ShareholderList>

fundHolder

Parameters

Returns Promise<FundHolders>

corpAction

Parameters

Returns Promise<CorpActions>

investRelation

Parameters

Returns Promise<InvestRelations>

operating

Parameters

Returns Promise<OperatingList>

buyback

Parameters

Returns Promise<BuybackData>

ratings

Parameters

Returns Promise<StockRatings>

shareholderTop

Parameters

Returns Promise<ShareholderTopResponse>

shareholderDetail

Parameters

Returns Promise<ShareholderDetailResponse>

valuationComparison

Parameters

Returns Promise<ValuationComparisonResponse>

`Static`new