Struct fin_iex::provider::IEXProvider

pub struct IEXProvider { /* fields omitted */ }

This is the provider type for IEX, it contains communication parameters and defaults used when making requests to the IEX endpoints.

Methods

impl IEXProvider

pub fn make_api_url(
    &self,
    path: String,
    query_params: Option<HashMap<String, String>>
) -> String

Construct a valid URL from the endpoint path and any additional query parameters, such as format=json.

Trait Implementations

impl Provider for IEXProvider

fn new() -> RequestResult<Self>

Create a new instance, performing any initialization which may involve a network operation, to perform authentication for example.

fn attribution(&self) -> String

A string that can be used to name or describe the provider.

fn url(&self) -> String

The URL to the provider's home page or documentation.

fn get_default_currency(&self) -> &String

The default currency code, using ISO three-character code.

fn finish(&self)

Optional, if the provider needs to close or complete any resources when done.

impl Peers for IEXProvider

fn peers(&self, for_symbol: Symbol) -> RequestResult<Symbols>

Return a set of peer symbols.

impl AnalystRecommendations for IEXProvider

fn target_price(
    &self,
    for_symbol: Symbol
) -> RequestResult<Snapshot<PriceTarget>>

fn consensus_rating(
    &self,
    for_symbol: Symbol
) -> RequestResult<Vec<Bounded<Ratings>>>

fn consensus_eps(&self, for_symbol: Symbol) -> RequestResult<Vec<EPSConsensus>>

impl FetchNews for IEXProvider

fn latest_news(
    &self,
    for_symbol: Symbol,
    max_items: usize
) -> RequestResult<NewsFeed>

fn news_from(
    &self,
    for_symbol: Symbol,
    start_date: Date,
    max_items: usize
) -> RequestResult<NewsFeed>

impl FetchPriceQuote for IEXProvider

fn latest_price_only(&self, for_symbol: Symbol) -> RequestResult<Money>

Return only the latest price, this may be delayed or real-time, simply the best available from the service provider.

fn real_time(&self, for_symbol: Symbol) -> RequestResult<Quote>

Return a real-time price, or RequestError::Unsupported if the service provider cannot honor real-time requests.

fn delayed(&self, for_symbol: Symbol) -> RequestResult<DelayedQuote>

Return a delayed price, or RequestError::Unsupported if the service provider does not provide delayed prices.

impl FetchPriceRangeSeries for IEXProvider

fn intra_day(
    &self,
    for_symbol: Symbol,
    interval_minutes: u8
) -> RequestResult<Option<PriceRangeSeries>>

Return a series of intra-day prices for the current trading day, or RequestError::Unsupported if the service provider does not provide intra-day data.

fn last(
    &self,
    for_symbol: Symbol,
    interval: SeriesInterval
) -> RequestResult<PriceRangeSeries>

Return a series of prices for the specified SeriesInterval going back from the current day; for example the last five days (SeriesInterval::FiveDays).

fn from(
    &self,
    for_symbol: Symbol,
    start_date: DateTime,
    interval: SeriesInterval
) -> RequestResult<PriceRangeSeries>

Return a series of prices for the specified SeriesInterval starting from start_date. If the start_date is less than interval from the current date the series will be truncated.

fn for_period(
    &self,
    for_symbol: Symbol,
    period: FinancialPeriod
) -> RequestResult<PriceRangeSeries>

Return a series of prices for the specified financial period. The series may be truncated if the period is not yet completed.