Skip to main content

FundamentalContext

Struct FundamentalContext 

Source
pub struct FundamentalContext(/* private fields */);
Expand description

Fundamental data context — financial reports, analyst ratings, dividends, valuation, company overview and more.

Implementations§

Source§

impl FundamentalContext

Source

pub fn new(config: Arc<Config>) -> Self

Source

pub fn log_subscriber(&self) -> Arc<dyn Subscriber + Send + Sync>

Returns the log subscriber

Source

pub async fn financial_report( &self, symbol: impl Into<String>, kind: FinancialReportKind, period: Option<FinancialReportPeriod>, ) -> Result<FinancialReports>

Get financial reports for a security.

Path: GET /v1/quote/financial-reports

Source

pub async fn institution_rating( &self, symbol: impl Into<String>, ) -> Result<InstitutionRating>

Get analyst ratings for a security (combines latest + historical).

Path: GET /v1/quote/institution-rating-latest + GET /v1/quote/institution-ratings

Source

pub async fn institution_rating_detail( &self, symbol: impl Into<String>, ) -> Result<InstitutionRatingDetail>

Get historical analyst rating details for a security.

Path: GET /v1/quote/institution-ratings/detail

Source

pub async fn dividend(&self, symbol: impl Into<String>) -> Result<DividendList>

Get dividend history for a security.

Path: GET /v1/quote/dividends

Source

pub async fn dividend_detail( &self, symbol: impl Into<String>, ) -> Result<DividendList>

Get detailed dividend information for a security.

Path: GET /v1/quote/dividends/details

Source

pub async fn forecast_eps( &self, symbol: impl Into<String>, ) -> Result<ForecastEps>

Get EPS forecasts for a security.

Path: GET /v1/quote/forecast-eps

Source

pub async fn consensus( &self, symbol: impl Into<String>, ) -> Result<FinancialConsensus>

Get financial consensus estimates for a security.

Path: GET /v1/quote/financial-consensus-detail

Source

pub async fn valuation( &self, symbol: impl Into<String>, ) -> Result<ValuationData>

Get valuation metrics (PE/PB/PS/dividend yield) for a security.

Path: GET /v1/quote/valuation

Source

pub async fn valuation_history( &self, symbol: impl Into<String>, ) -> Result<ValuationHistoryResponse>

Get historical valuation data for a security.

Path: GET /v1/quote/valuation/detail

Source

pub async fn industry_valuation( &self, symbol: impl Into<String>, ) -> Result<IndustryValuationList>

Get valuation comparison against industry peers.

Path: GET /v1/quote/industry-valuation-comparison

Source

pub async fn industry_valuation_dist( &self, symbol: impl Into<String>, ) -> Result<IndustryValuationDist>

Get valuation distribution within the industry.

Path: GET /v1/quote/industry-valuation-distribution

Source

pub async fn company( &self, symbol: impl Into<String>, ) -> Result<CompanyOverview>

Get company overview information.

Path: GET /v1/quote/comp-overview

Source

pub async fn executive( &self, symbol: impl Into<String>, ) -> Result<ExecutiveList>

Get executive and board member information.

Path: GET /v1/quote/company-professionals

Source

pub async fn shareholder( &self, symbol: impl Into<String>, ) -> Result<ShareholderList>

Get major shareholders for a security.

Path: GET /v1/quote/shareholders

Source

pub async fn fund_holder( &self, symbol: impl Into<String>, ) -> Result<FundHolders>

Get funds and ETFs that hold a security.

Path: GET /v1/quote/fund-holders

Source

pub async fn corp_action( &self, symbol: impl Into<String>, ) -> Result<CorpActions>

Get corporate actions (dividends, splits, buybacks, etc.).

Path: GET /v1/quote/company-act

Source

pub async fn invest_relation( &self, symbol: impl Into<String>, ) -> Result<InvestRelations>

Get investor relations / investment holdings.

Path: GET /v1/quote/invest-relations

Source

pub async fn operating( &self, symbol: impl Into<String>, ) -> Result<OperatingList>

Get operating metrics and financial report summaries.

Path: GET /v1/quote/operatings

Source

pub async fn buyback(&self, symbol: impl Into<String>) -> Result<BuybackData>

Get buyback data for a security.

Path: GET /v1/quote/buy-backs

Source

pub async fn ratings(&self, symbol: impl Into<String>) -> Result<StockRatings>

Get stock ratings for a security.

Path: GET /v1/quote/ratings

Source

pub async fn business_segments( &self, symbol: impl Into<String>, ) -> Result<BusinessSegments>

Get the latest business segment breakdown for a security.

Path: GET /v1/quote/fundamentals/business-segments

Source

pub async fn business_segments_history( &self, symbol: impl Into<String>, report: Option<&'static str>, cate: Option<String>, ) -> Result<BusinessSegmentsHistory>

Get historical business segment breakdowns for a security.

Path: GET /v1/quote/fundamentals/business-segments/history

Source

pub async fn shareholder_top( &self, symbol: impl Into<String>, ) -> Result<ShareholderTopResponse>

Get a ranked list of top shareholders for a security.

Path: GET /v1/quote/shareholders/top

Source

pub async fn institution_rating_views( &self, symbol: impl Into<String>, ) -> Result<InstitutionRatingViews>

Get historical institutional rating view time-series for a security.

Path: GET /v1/quote/ratings/institutional

Source

pub async fn shareholder_detail( &self, symbol: impl Into<String>, object_id: i64, ) -> Result<ShareholderDetailResponse>

Get holding history and detail for one shareholder object.

Path: GET /v1/quote/shareholders/holding

Source

pub async fn industry_rank( &self, market: impl Into<String>, indicator: impl Into<String>, sort_type: impl Into<String>, limit: u32, ) -> Result<IndustryRankResponse>

Get industry rank for a market.

Path: GET /v1/quote/industry/rank

Source

pub async fn industry_peers( &self, counter_id: impl Into<String>, market: impl Into<String>, industry_id: Option<String>, ) -> Result<IndustryPeersResponse>

Get the industry peer chain for a security or industry.

Path: GET /v1/quote/industries/peers

Source

pub async fn financial_report_snapshot( &self, symbol: impl Into<String>, report: Option<&'static str>, fiscal_year: Option<i32>, fiscal_period: Option<&'static str>, ) -> Result<FinancialReportSnapshot>

Get a financial report snapshot (earnings snapshot) for a security.

Path: GET /v1/quote/financials/earnings-snapshot

Source

pub async fn valuation_comparison( &self, symbol: impl Into<String>, currency: impl Into<String>, comparison_symbols: Option<Vec<String>>, ) -> Result<ValuationComparisonResponse>

Get valuation comparison between a security and optional peers.

Path: GET /v1/quote/compare/valuation

Trait Implementations§

Source§

impl Clone for FundamentalContext

Source§

fn clone(&self) -> FundamentalContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more