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

Create a FundamentalContext

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

Trait Implementations§

Source §

impl Clone for FundamentalContext

Source §

fn clone(&self) -> FundamentalContext

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for FundamentalContext

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.

§

impl<T> Instrument for T

§

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

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 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

§

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

§

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

§

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 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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

§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

FundamentalContext

Struct FundamentalContext Copy item path

Implementations§

impl FundamentalContext

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations§

impl Clone for FundamentalContext

fn clone(&self) -> FundamentalContext

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

Auto Trait Implementations§

impl Freeze for FundamentalContext

impl !RefUnwindSafe for FundamentalContext

impl Send for FundamentalContext

impl Sync for FundamentalContext

impl Unpin for FundamentalContext

impl UnsafeUnpin for FundamentalContext

impl !UnwindSafe for FundamentalContext

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

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

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

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

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

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

impl<T> Same for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct FundamentalContext

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

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

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

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

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

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

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

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

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

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

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

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

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

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