Struct ScreenerFilters 

#[non_exhaustive]
pub struct ScreenerFilters {

    pub market_cap_min: Option<f64>,
    pub market_cap_max: Option<f64>,
    pub price_min: Option<f64>,
    pub price_max: Option<f64>,
    pub volume_min: Option<f64>,
    pub beta_min: Option<f64>,
    pub beta_max: Option<f64>,
    pub sector: Option<String>,
    pub industry: Option<String>,
    pub exchange: Option<String>,
    pub country: Option<String>,
    pub actively_trading: Option<bool>,
    pub limit: Option<u32>,
}

Filters for a provider-routed screener query.

All fields are optional; unset filters are omitted from the request. Build with ScreenerFilters::new and the chainable setters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

market_cap_min: Option<f64>

Minimum market capitalisation.

market_cap_max: Option<f64>

Maximum market capitalisation.

price_min: Option<f64>

Minimum price.

price_max: Option<f64>

Maximum price.

volume_min: Option<f64>

Minimum trading volume.

beta_min: Option<f64>

Minimum beta.

beta_max: Option<f64>

Maximum beta.

sector: Option<String>

Sector name filter.

industry: Option<String>

Industry name filter.

exchange: Option<String>

Exchange filter.

country: Option<String>

Country filter.

actively_trading: Option<bool>

Restrict to actively trading symbols.

limit: Option<u32>

Maximum number of results.

Implementations

impl ScreenerFilters

pub fn new() -> Self

An empty filter set — matches the provider’s default universe.

pub fn market_cap(self, min: Option<f64>, max: Option<f64>) -> Self

Restrict market capitalisation to [min, max].

pub fn price(self, min: Option<f64>, max: Option<f64>) -> Self

Restrict price to [min, max].

pub fn beta(self, min: Option<f64>, max: Option<f64>) -> Self

Restrict beta to [min, max].

pub fn volume_min(self, min: f64) -> Self

Require at least min traded volume.

pub fn sector(self, sector: impl Into<String>) -> Self

Restrict to a sector.

pub fn industry(self, industry: impl Into<String>) -> Self

Restrict to an industry.

pub fn exchange(self, exchange: impl Into<String>) -> Self

Restrict to an exchange.

pub fn country(self, country: impl Into<String>) -> Self

Restrict to a country of domicile.

pub fn actively_trading(self, actively_trading: bool) -> Self

Restrict to symbols that are actively trading.

pub fn limit(self, limit: u32) -> Self

Cap the number of results returned.

Trait Implementations

impl Clone for ScreenerFilters

fn clone(&self) -> ScreenerFilters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScreenerFilters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScreenerFilters

fn default() -> ScreenerFilters

Returns the “default value” for a type.

impl PartialEq for ScreenerFilters

fn eq(&self, other: &ScreenerFilters) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ScreenerFilters