Struct ScreenerQuery 

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

A custom screener query for Yahoo Finance

Allows building flexible queries to filter stocks/funds/ETFs based on various criteria like price, volume, market cap, and more.

Example

use finance_query::{ScreenerQuery, QueryCondition, screener_query::{Operator, QuoteType}};

// Find US stocks with high volume and market cap > $10B
let query = ScreenerQuery::new()
    .quote_type(QuoteType::Equity)
    .size(25)
    .sort_by("intradaymarketcap", false)  // Sort by market cap descending
    .add_condition(QueryCondition::new("region", Operator::Eq).value_str("us"))
    .add_condition(QueryCondition::new("avgdailyvol3m", Operator::Gt).value(200000))
    .add_condition(QueryCondition::new("intradaymarketcap", Operator::Gt).value(10_000_000_000.0));

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 (ASC or DESC)

sort_field: String

Field to sort by (e.g., “intradaymarketcap”, “percentchange”)

include_fields: Vec<String>

Fields to include in the response

top_operator: LogicalOperator

Top-level logical operator (AND or OR)

query: QueryGroup

Query filter conditions

quote_type: QuoteType

Type of quote to screen (EQUITY, ETF, MUTUALFUND, etc.)

Implementations

impl ScreenerQuery

pub fn new() -> Self

Create a new screener query with default settings

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

Set the number of results to return (max 250)

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

Set the pagination offset

pub fn sort_by(self, field: impl Into<String>, ascending: bool) -> Self

Set the sort field and direction

Arguments

• field - Field to sort by (e.g., “intradaymarketcap”, “percentchange”)
• ascending - If true, sort ascending; if false, sort descending

pub fn quote_type(self, quote_type: QuoteType) -> Self

Set the quote type (EQUITY or MUTUALFUND)

This also updates the default include_fields and sort_field to use appropriate fields for the quote type.

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

Set the fields to include in the response

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

Add a field to include in the response

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

Set the top-level operator (AND or OR)

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

Add a filter condition

Example

use finance_query::{ScreenerQuery, QueryCondition, screener_query::Operator};

let query = ScreenerQuery::new()
    .add_condition(QueryCondition::new("region", Operator::Eq).value_str("us"))
    .add_condition(QueryCondition::new("avgdailyvol3m", Operator::Gt).value(200000));

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

Add multiple conditions that will be OR’d together

Example

use finance_query::{ScreenerQuery, QueryCondition, screener_query::Operator};

// Filter for region being US OR GB
let query = ScreenerQuery::new()
    .add_or_conditions(vec![
        QueryCondition::new("region", Operator::Eq).value_str("us"),
        QueryCondition::new("region", Operator::Eq).value_str("gb"),
    ]);

pub fn most_shorted() -> Self

Create a “most shorted stocks” screener preset

Finds US stocks sorted by short interest percentage.

pub fn high_dividend() -> Self

Create a “high dividend yield” screener preset

Finds US stocks with dividend yield > 3%.

pub fn large_cap_growth() -> Self

Create a “large cap growth” screener preset

Finds large cap stocks with positive earnings growth.

Trait Implementations

impl Clone for ScreenerQuery

fn clone(&self) -> ScreenerQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScreenerQuery

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

Formats the value using the given formatter.

impl Default for ScreenerQuery

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScreenerQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ScreenerQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.