StockDirectory

Struct StockDirectory 

Source
pub struct StockDirectory { /* private fields */ }
Expand description

Stock directory API endpoints

Implementations§

Source§

impl StockDirectory

Source

pub async fn screen_stocks( &self, criteria: &ScreenerCriteria, ) -> Result<Vec<StockScreenerResult>>

Screen stocks based on various criteria

§Arguments
  • criteria - Screening criteria to filter stocks
§Example
let client = FmpClient::new()?;
let mut criteria = ScreenerCriteria::default();
criteria.market_cap_more_than = Some(10_000_000_000); // $10B+
criteria.beta_lower_than = Some(1.5);
criteria.is_etf = Some(false);
criteria.is_actively_trading = Some(true);
criteria.limit = Some(100);

let results = client.stock_directory().screen_stocks(&criteria).await?;
for stock in results.iter().take(10) {
    println!("{}: {} - ${:.2}B market cap",
        stock.symbol,
        stock.company_name,
        stock.market_cap.unwrap_or(0.0) / 1_000_000_000.0);
}
Source

pub async fn get_tradable_symbols(&self) -> Result<Vec<TradableSymbol>>

Get list of all available traded symbols

§Example
let client = FmpClient::new()?;
let symbols = client.stock_directory().get_tradable_symbols().await?;
println!("Total tradable symbols: {}", symbols.len());
for symbol in symbols.iter().take(10) {
    println!("{}: {}", symbol.symbol, symbol.name);
}
Source

pub async fn get_symbols_by_exchange( &self, exchange: &str, ) -> Result<Vec<TradableSymbol>>

Get symbols by exchange

§Arguments
  • exchange - Exchange code (e.g., “NASDAQ”, “NYSE”)
§Example
let client = FmpClient::new()?;
let symbols = client.stock_directory().get_symbols_by_exchange("NASDAQ").await?;
println!("NASDAQ symbols: {}", symbols.len());
Source

pub async fn get_etf_list(&self) -> Result<Vec<TradableSymbol>>

Get list of all ETFs

§Example
let client = FmpClient::new()?;
let etfs = client.stock_directory().get_etf_list().await?;
println!("Total ETFs: {}", etfs.len());
for etf in etfs.iter().take(10) {
    println!("{}: {}", etf.symbol, etf.name);
}
Source

pub async fn is_symbol_available( &self, symbol: &str, ) -> Result<Vec<TradableSymbol>>

Check if symbol is available/valid

§Arguments
  • symbol - Stock symbol to check
§Example
let client = FmpClient::new()?;
let symbols = client.stock_directory().is_symbol_available("AAPL").await?;
if !symbols.is_empty() {
    println!("AAPL is available: {}", symbols[0].name);
}

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> 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> 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, 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,