Skip to main content

Module types

Module types 

Source

Structs§

AssetAllocationGroup
One ETF asset allocation group (grouped by element type)
AssetAllocationItem
One element of an ETF asset allocation group
AssetAllocationResponse
Response for crate::FundamentalContext::etf_asset_allocation
BusinessSegmentHistoryItem
One business/regional segment item in a historical snapshot
BusinessSegmentItem
One business segment item (latest snapshot)
BusinessSegments
Response for crate::FundamentalContext::business_segments
BusinessSegmentsHistoricalItem
One historical business segments snapshot
BusinessSegmentsHistory
Response for crate::FundamentalContext::business_segments_history
BuybackData
Response for crate::FundamentalContext::buyback
BuybackHistoryItem
Historical annual buyback data point
BuybackRatios
Buyback payout and cash-flow ratios
CompanyOverview
Response for crate::FundamentalContext::company
ConsensusDetail
Consensus estimate for one financial metric
ConsensusReport
Consensus report for one fiscal period
CorpActionItem
One corporate action event
CorpActionLive
Live stream associated with a corporate action
CorpActions
Response for crate::FundamentalContext::corp_action
DividendItem
A single dividend / distribution event
DividendList
Response for crate::FundamentalContext::dividend and crate::FundamentalContext::dividend_detail
ExecutiveGroup
Executives for one security
ExecutiveList
Response for crate::FundamentalContext::executive
FinancialConsensus
Response for crate::FundamentalContext::consensus
FinancialReportSnapshot
Response for crate::FundamentalContext::financial_report_snapshot
FinancialReports
Response for crate::FundamentalContext::financial_report
ForecastEps
Response for crate::FundamentalContext::forecast_eps
ForecastEpsItem
One EPS forecast snapshot
FundHolder
A fund or ETF that holds the queried security
FundHolders
Response for crate::FundamentalContext::fund_holder
HoldingDetail
Holding detail of an ETF asset allocation element (holdings only)
IndustryPeerNode
A node in the recursive industry peer chain
IndustryPeersResponse
Response for crate::FundamentalContext::industry_peers
IndustryPeersTop
Top-level industry info in the peers response
IndustryRankGroup
A group of ranked industry items
IndustryRankItem
One ranked industry item
IndustryRankResponse
Response for crate::FundamentalContext::industry_rank
IndustryValuationDist
Response for crate::FundamentalContext::industry_valuation_dist
IndustryValuationHistory
Historical valuation snapshot for an industry peer
IndustryValuationItem
Valuation data for one peer security
IndustryValuationList
Response for crate::FundamentalContext::industry_valuation
InstitutionRating
Combined analyst-rating response for crate::FundamentalContext::institution_rating
InstitutionRatingDetail
Response for crate::FundamentalContext::institution_rating_detail
InstitutionRatingDetailEvaluate
Historical rating distribution time-series
InstitutionRatingDetailEvaluateItem
One weekly rating distribution snapshot
InstitutionRatingDetailTarget
Historical target price time-series
InstitutionRatingDetailTargetItem
One weekly target price snapshot
InstitutionRatingLatest
Latest analyst-rating snapshot
InstitutionRatingSummary
Consensus summary from /v1/quote/institution-ratings
InstitutionRatingViewItem
One historical rating distribution snapshot
InstitutionRatingViews
Response for crate::FundamentalContext::institution_rating_views
InvestRelations
Response for crate::FundamentalContext::invest_relation
InvestSecurity
A security in which the queried company has an investment stake
Macroeconomic
One historical data point for a macroeconomic indicator
MacroeconomicIndicator
Metadata for one macroeconomic indicator
MacroeconomicIndicatorListResponse
Response for crate::FundamentalContext::macroeconomic_indicators
MacroeconomicResponse
Response for crate::FundamentalContext::macroeconomic
MultiLanguageText
Localized text in simplified Chinese, traditional Chinese, and English
OperatingFinancial
Key financial metrics extracted from an operating report
OperatingIndicator
One financial indicator in an operating report
OperatingItem
One operating summary report (annual / quarterly)
OperatingList
Response for crate::FundamentalContext::operating
Professional
One executive / board member
RatingCategory
One rating category (e.g. growth, profitability)
RatingEvaluate
Analyst rating distribution counts
RatingIndicator
A rating indicator node (may be a parent or a leaf)
RatingLeafIndicator
A leaf rating indicator with a raw value
RatingSubIndicatorGroup
A group of sub-indicators under one category indicator
RatingSummaryEvaluate
Simplified rating distribution for the consensus summary
RatingTarget
Analyst target price range
RecentBuybacks
TTM (trailing twelve months) buyback summary
Shareholder
One major shareholder
ShareholderDetailResponse
Response for crate::FundamentalContext::shareholder_detail
ShareholderList
Response for crate::FundamentalContext::shareholder
ShareholderStock
A security in an institutional shareholder’s cross-holdings
ShareholderTopResponse
Response for crate::FundamentalContext::shareholder_top
SnapshotForecastMetric
A forecast metric in the financial report snapshot
SnapshotReportedMetric
A reported metric in the financial report snapshot
StockRatings
Response for crate::FundamentalContext::ratings
ValuationComparisonItem
One security’s valuation comparison item.
ValuationComparisonResponse
Response for crate::FundamentalContext::valuation_comparison
ValuationData
Response for crate::FundamentalContext::valuation
ValuationDist
Distribution statistics for one valuation metric within an industry
ValuationHistoryData
Container for historical valuation metrics
ValuationHistoryMetric
Historical data for one valuation metric including statistical bounds
ValuationHistoryMetrics
Historical valuation metrics container
ValuationHistoryPoint
One historical valuation data point.
ValuationHistoryResponse
Response for crate::FundamentalContext::valuation_history
ValuationMetricData
Historical time-series for one valuation metric
ValuationMetricsData
Container for all valuation metrics
ValuationPoint
One valuation data point

Enums§

ElementType
ETF asset allocation element type
FinancialReportKind
Financial report kind
FinancialReportPeriod
Financial report period type
InstitutionRecommend
Institutional analyst recommendation
MacroeconomicCountry
Country for filtering macroeconomic indicators
MacroeconomicImportance
Importance level of a macroeconomic indicator