Enum EquityField 

#[non_exhaustive]
pub enum EquityField {
    Ticker,
    CompanyShortName,
    EodPrice,
    IntradayPrice,
    IntradayPriceChange,
    PercentChange,
    Lastclose52WkHigh,
    FiftyTwoWkPctChange,
    Lastclose52WkLow,
    IntradayMarketCap,
    LastcloseMarketCap,
    Region,
    Sector,
    PeerGroup,
    Industry,
    Exchange,
    Beta,
    AvgDailyVol3M,
    PctHeldInsider,
    PctHeldInst,
    DayVolume,
    EodVolume,
    ShortPctSharesOut,
    ShortInterest,
    ShortPctFloat,
    DaysToCover,
    ShortInterestPctChange,
    BookValueShare,
    MarketCapToRevenue,
    TevToRevenue,
    PriceBookRatio,
    PeRatio,
    PriceTangibleBook,
    PriceEarnings,
    PegRatio5Y,
    ConsecutiveDivYears,
    Roa,
    Roe,
    ForwardDivPerShare,
    ForwardDivYield,
    ReturnOnCapital,
    TevEbit,
    NetDebtEbitda,
    TotalDebtEquity,
    LtDebtEquity,
    EbitInterestExp,
    EbitdaInterestExp,
    TevEbitda,
    TotalDebtEbitda,
    QuickRatio,
    AltmanZScore,
    CurrentRatio,
    OcfToCurrentLiab,
    TotalRevenues,
    NetIncomeMargin,
    GrossProfit,
    Ebitda1YrGrowth,
    DilutedEpsContOps,
    QuarterlyRevGrowth,
    EpsGrowth,
    NetIncome,
    Ebitda,
    DilutedEps1YrGrowth,
    Revenue1YrGrowth,
    OperatingIncome,
    NetIncome1YrGrowth,
    GrossProfitMargin,
    EbitdaMargin,
    Ebit,
    BasicEpsContOps,
    NetEpsBasic,
    NetEpsDiluted,
    TotalAssets,
    CommonSharesOut,
    TotalDebt,
    TotalEquity,
    TotalCurrentAssets,
    CashAndStInvestments,
    TotalCommonEquity,
    TotalCurrentLiab,
    TotalSharesOut,
    LeveredFcf,
    Capex,
    CashFromOps,
    LeveredFcf1YrGrowth,
    UnleveredFcf,
    CashFromOps1YrGrowth,
    EsgScore,
    EnvironmentalScore,
    GovernanceScore,
    SocialScore,
    HighestControversy,
}

Typed field names for equity custom screener queries.

Variants marked as display-only (Ticker, CompanyShortName) are used in include_fields to request those columns in the response. They do not support meaningful numeric or string filters via Yahoo’s API.

All other variants support filtering via ScreenerFieldExt methods. Categorical fields (Region, Sector, Industry, Exchange, PeerGroup) use eq_str; all others use numeric operators.

Example

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

let query = EquityScreenerQuery::new()
    .sort_by(EquityField::IntradayMarketCap, false)
    .add_condition(EquityField::Region.eq_str("us"))
    .add_condition(EquityField::PeRatio.between(10.0, 25.0))
    .add_condition(EquityField::AvgDailyVol3M.gt(200_000.0))
    .include_fields(vec![
        EquityField::Ticker,
        EquityField::CompanyShortName,
        EquityField::IntradayPrice,
        EquityField::PeRatio,
    ]);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ticker

Ticker symbol — display only, use in include_fields.

CompanyShortName

Short company name — display only, use in include_fields.

EodPrice

End-of-day price ("eodprice").

IntradayPrice

Intraday price ("intradayprice").

IntradayPriceChange

Intraday price change ("intradaypricechange").

PercentChange

Percent change ("percentchange").

Lastclose52WkHigh

Last close 52-week high ("lastclose52weekhigh.lasttwelvemonths").

FiftyTwoWkPctChange

52-week percent change ("fiftytwowkpercentchange").

Lastclose52WkLow

Last close 52-week low ("lastclose52weeklow.lasttwelvemonths").

IntradayMarketCap

Intraday market cap ("intradaymarketcap").

LastcloseMarketCap

Last close market cap ("lastclosemarketcap.lasttwelvemonths").

Region

Geographic region — use eq_str("us").

Sector

GICS sector — use eq_str("Technology") etc.

PeerGroup

Peer group ("peer_group").

Industry

Industry ("industry").

Exchange

Exchange ("exchange").

Beta

Beta ("beta").

AvgDailyVol3M

3-month average daily volume ("avgdailyvol3m").

PctHeldInsider

Percent held by insiders ("pctheldinsider").

PctHeldInst

Percent held by institutions ("pctheldinst").

DayVolume

Intraday volume ("dayvolume").

EodVolume

End-of-day volume ("eodvolume").

ShortPctSharesOut

Short percentage of shares outstanding ("short_percentage_of_shares_outstanding.value").

ShortInterest

Short interest value ("short_interest.value").

ShortPctFloat

Short percentage of float ("short_percentage_of_float.value").

DaysToCover

Days to cover short ("days_to_cover_short.value").

ShortInterestPctChange

Short interest percent change ("short_interest_percentage_change.value").

BookValueShare

Book value per share ("bookvalueshare.lasttwelvemonths").

MarketCapToRevenue

Market cap to revenue ("lastclosemarketcaptotalrevenue.lasttwelvemonths").

TevToRevenue

TEV to revenue ("lastclosetevtotalrevenue.lasttwelvemonths").

PriceBookRatio

Price-to-book ratio ("pricebookratio.quarterly").

PeRatio

Trailing twelve months P/E ratio ("peratio.lasttwelvemonths").

PriceTangibleBook

Price to tangible book value ("lastclosepricetangiblebookvalue.lasttwelvemonths").

PriceEarnings

Price to earnings ("lastclosepriceearnings.lasttwelvemonths").

PegRatio5Y

5-year PEG ratio ("pegratio_5y").

ConsecutiveDivYears

Consecutive years of dividend growth ("consecutive_years_of_dividend_growth_count").

Roa

Return on assets ("returnonassets.lasttwelvemonths").

Roe

Return on equity ("returnonequity.lasttwelvemonths").

ForwardDivPerShare

Forward dividend per share ("forward_dividend_per_share").

ForwardDivYield

Forward dividend yield ("forward_dividend_yield").

ReturnOnCapital

Return on total capital ("returnontotalcapital.lasttwelvemonths").

TevEbit

TEV / EBIT ("lastclosetevebit.lasttwelvemonths").

NetDebtEbitda

Net debt / EBITDA ("netdebtebitda.lasttwelvemonths").

TotalDebtEquity

Total debt / equity ("totaldebtequity.lasttwelvemonths").

LtDebtEquity

Long-term debt / equity ("ltdebtequity.lasttwelvemonths").

EbitInterestExp

EBIT / interest expense ("ebitinterestexpense.lasttwelvemonths").

EbitdaInterestExp

EBITDA / interest expense ("ebitdainterestexpense.lasttwelvemonths").

TevEbitda

TEV / EBITDA ("lastclosetevebitda.lasttwelvemonths").

TotalDebtEbitda

Total debt / EBITDA ("totaldebtebitda.lasttwelvemonths").

QuickRatio

Quick ratio ("quickratio.lasttwelvemonths").

AltmanZScore

Altman Z-score ("altmanzscoreusingtheaveragestockinformationforaperiod.lasttwelvemonths").

CurrentRatio

Current ratio ("currentratio.lasttwelvemonths").

OcfToCurrentLiab

Operating cash flow to current liabilities ("operatingcashflowtocurrentliabilities.lasttwelvemonths").

TotalRevenues

Total revenues ("totalrevenues.lasttwelvemonths").

NetIncomeMargin

Net income margin ("netincomemargin.lasttwelvemonths").

GrossProfit

Gross profit ("grossprofit.lasttwelvemonths").

Ebitda1YrGrowth

EBITDA 1-year growth ("ebitda1yrgrowth.lasttwelvemonths").

DilutedEpsContOps

Diluted EPS from continuing operations ("dilutedepscontinuingoperations.lasttwelvemonths").

QuarterlyRevGrowth

Quarterly revenue growth ("quarterlyrevenuegrowth.quarterly").

EpsGrowth

EPS growth ("epsgrowth.lasttwelvemonths").

NetIncome

Net income ("netincomeis.lasttwelvemonths").

Ebitda

EBITDA ("ebitda.lasttwelvemonths").

DilutedEps1YrGrowth

Diluted EPS 1-year growth ("dilutedeps1yrgrowth.lasttwelvemonths").

Revenue1YrGrowth

Revenue 1-year growth ("totalrevenues1yrgrowth.lasttwelvemonths").

OperatingIncome

Operating income ("operatingincome.lasttwelvemonths").

NetIncome1YrGrowth

Net income 1-year growth ("netincome1yrgrowth.lasttwelvemonths").

GrossProfitMargin

Gross profit margin ("grossprofitmargin.lasttwelvemonths").

EbitdaMargin

EBITDA margin ("ebitdamargin.lasttwelvemonths").

Ebit

EBIT ("ebit.lasttwelvemonths").

BasicEpsContOps

Basic EPS from continuing operations ("basicepscontinuingoperations.lasttwelvemonths").

NetEpsBasic

Basic EPS ("netepsbasic.lasttwelvemonths").

NetEpsDiluted

Diluted EPS ("netepsdiluted.lasttwelvemonths").

TotalAssets

Total assets ("totalassets.lasttwelvemonths").

CommonSharesOut

Common shares outstanding ("totalcommonsharesoutstanding.lasttwelvemonths").

TotalDebt

Total debt ("totaldebt.lasttwelvemonths").

TotalEquity

Total equity ("totalequity.lasttwelvemonths").

TotalCurrentAssets

Total current assets ("totalcurrentassets.lasttwelvemonths").

CashAndStInvestments

Cash and short-term investments ("totalcashandshortterminvestments.lasttwelvemonths").

TotalCommonEquity

Total common equity ("totalcommonequity.lasttwelvemonths").

TotalCurrentLiab

Total current liabilities ("totalcurrentliabilities.lasttwelvemonths").

TotalSharesOut

Total shares outstanding ("totalsharesoutstanding").

LeveredFcf

Levered free cash flow ("leveredfreecashflow.lasttwelvemonths").

Capex

Capital expenditure ("capitalexpenditure.lasttwelvemonths").

CashFromOps

Cash from operations ("cashfromoperations.lasttwelvemonths").

LeveredFcf1YrGrowth

Levered FCF 1-year growth ("leveredfreecashflow1yrgrowth.lasttwelvemonths").

UnleveredFcf

Unlevered free cash flow ("unleveredfreecashflow.lasttwelvemonths").

CashFromOps1YrGrowth

Cash from operations 1-year growth ("cashfromoperations1yrgrowth.lasttwelvemonths").

EsgScore

ESG score ("esg_score").

EnvironmentalScore

Environmental score ("environmental_score").

GovernanceScore

Governance score ("governance_score").

SocialScore

Social score ("social_score").

HighestControversy

Highest controversy level ("highest_controversy").

Implementations

impl EquityField

pub fn as_str(&self) -> &'static str

Returns the Yahoo Finance API field name string for this variant.

pub fn all() -> &'static [EquityField]

Returns a slice of all EquityField variants.

Useful for validation: EquityField::all().iter().find(|f| f.as_str() == s).

Trait Implementations

impl Clone for EquityField

fn clone(&self) -> EquityField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EquityField

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

Formats the value using the given formatter.

impl FromStr for EquityField

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for EquityField

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EquityField

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ScreenerField for EquityField

fn as_str(&self) -> &'static str

Returns the Yahoo Finance API field name string.

impl Serialize for EquityField

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for EquityField

impl Eq for EquityField

impl StructuralPartialEq for EquityField