Struct ScreenerQuery 

pub struct ScreenerQuery<F: ScreenerField = EquityField> {
    pub size: u32,
    pub offset: u32,
    pub sort_type: SortType,
    pub sort_field: F,
    pub include_fields: Vec<F>,
    pub top_operator: LogicalOperator,
    pub query: QueryGroup<F>,
    pub quote_type: QuoteType,
}

A typed custom screener query for Yahoo Finance.

The type parameter F determines which field set is valid for this query. Use the type aliases for the common cases:

• EquityScreenerQuery — for stock screeners
• FundScreenerQuery — for mutual fund screeners

Example

use finance_query::{EquityField, EquityScreenerQuery, ScreenerFieldExt};

// Find US large-cap value stocks
let query = EquityScreenerQuery::new()
    .size(25)
    .sort_by(EquityField::IntradayMarketCap, false)
    .add_condition(EquityField::Region.eq_str("us"))
    .add_condition(EquityField::AvgDailyVol3M.gt(200_000.0))
    .add_condition(EquityField::PeRatio.between(10.0, 25.0))
    .add_condition(EquityField::IntradayMarketCap.gt(10_000_000_000.0))
    .include_fields(vec![
        EquityField::Ticker,
        EquityField::CompanyShortName,
        EquityField::IntradayPrice,
        EquityField::PeRatio,
        EquityField::IntradayMarketCap,
    ]);

Fields

size: u32

Number of results to return (default: 25, max: 250).

offset: u32

Starting offset for pagination (default: 0).

sort_type: SortType

Sort direction.

sort_field: F

Field to sort by.

include_fields: Vec<F>

Fields to include in the response.

top_operator: LogicalOperator

Top-level logical operator combining all conditions.

query: QueryGroup<F>

The nested condition tree.

quote_type: QuoteType

Quote type — determines which Yahoo Finance screener endpoint is used.

Implementations

impl<F: ScreenerField> ScreenerQuery<F>

pub fn new() -> Self

where Self: Default,

Create a new screener query with default settings.

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

Set the number of results to return (capped at 250).

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

Set the pagination offset.

pub fn sort_by(self, field: F, ascending: bool) -> Self

Set the field to sort by and the sort direction.

Example

use finance_query::{EquityField, EquityScreenerQuery};

let query = EquityScreenerQuery::new()
    .sort_by(EquityField::PeRatio, true);  // ascending P/E

pub fn top_operator(self, op: LogicalOperator) -> Self

Set the top-level logical operator (AND or OR).

pub fn include_fields(self, fields: Vec<F>) -> Self

Set which fields to include in the response.

pub fn add_include_field(self, field: F) -> Self

Add a field to include in the response.

pub fn add_condition(self, condition: QueryCondition<F>) -> Self

Add a typed filter condition to this query (ANDed with all others).

Conditions are added directly as operands of the top-level AND group, matching the format Yahoo Finance’s screener API expects. Use add_or_conditions when you need to match any of several values for the same field.

Example

use finance_query::{EquityField, EquityScreenerQuery, ScreenerFieldExt};

let query = EquityScreenerQuery::new()
    .add_condition(EquityField::Region.eq_str("us"))
    .add_condition(EquityField::PeRatio.between(10.0, 25.0))
    .add_condition(EquityField::AvgDailyVol3M.gt(200_000.0));

pub fn add_or_conditions(self, conditions: Vec<QueryCondition<F>>) -> Self

Add multiple conditions that are OR’d together.

Example

use finance_query::{EquityField, EquityScreenerQuery, ScreenerFieldExt};

// Accept US or GB region
let query = EquityScreenerQuery::new()
    .add_or_conditions(vec![
        EquityField::Region.eq_str("us"),
        EquityField::Region.eq_str("gb"),
    ]);

impl ScreenerQuery<EquityField>

pub fn most_shorted() -> Self

Preset: US stocks sorted by short interest percentage of float.

Filters: US region, average daily volume > 200K.

use finance_query::{EquityScreenerQuery, finance};

let results = finance::custom_screener(EquityScreenerQuery::most_shorted()).await?;

pub fn high_dividend() -> Self

Preset: US stocks with forward dividend yield > 3%, sorted by yield descending.

Filters: US region, forward dividend yield > 3%, average daily volume > 100K.

use finance_query::{EquityScreenerQuery, finance};

let results = finance::custom_screener(EquityScreenerQuery::high_dividend()).await?;

pub fn large_cap_growth() -> Self

Preset: US large-cap stocks with positive EPS growth, sorted by market cap.

Filters: US region, market cap > $10B, positive EPS growth.

use finance_query::{EquityScreenerQuery, finance};

let results = finance::custom_screener(EquityScreenerQuery::large_cap_growth()).await?;

Trait Implementations

impl<F: Clone + ScreenerField> Clone for ScreenerQuery<F>

fn clone(&self) -> ScreenerQuery<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + ScreenerField> Debug for ScreenerQuery<F>

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

Formats the value using the given formatter.

impl Default for ScreenerQuery<EquityField>

fn default() -> Self

Returns the “default value” for a type.

impl Default for ScreenerQuery<FundField>

fn default() -> Self

Returns the “default value” for a type.

impl<F> Serialize for ScreenerQuery<F>

where F: Serialize + ScreenerField,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.