Skip to main content

EquityScreenerQuery

Type Alias EquityScreenerQuery 

Source
pub type EquityScreenerQuery = ScreenerQuery<EquityField>;
Expand description

Type alias for equity (stock) screener queries.

Use EquityField variants to build conditions.

Aliased Type§

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

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: EquityField

Field to sort by.

§include_fields: Vec<EquityField>

Fields to include in the response.

§top_operator: LogicalOperator

Top-level logical operator combining all conditions.

§query: QueryGroup<EquityField>

The nested condition tree.

§quote_type: QuoteType

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