Skip to main content

Module field

Module field 

Source
Expand description

Curated field definitions, presets, and metadata loaded from data/fields.json.

Each column is Field(label, field_name, format, interval, historical) in tvscreener.field. This crate uses FieldDef plus a generated catalog.

Modules§

country
Country wire values for country filters.
exchange
Exchange wire values for exchange filters.
index_symbol
Common index catalog symbols for crate::core::Screener::set_index.
industry
Industry wire values for industry filters.
rating
Recommendation rating bands (STRONG_BUY … UNKNOWN).
sector
Stock sector wire values for SECTOR filters.

Structs§

FieldDef
One requestable scanner column
IndexSymbolDef
One index filter entry
Market
TradingView market filter
NamedValue
Named catalog constant with a single wire/display string (sector, country, …).
RatingBand
Recommendation rating band (numeric recommendation scores).
SymbolType
Stock subtype filter value
TypeFilter
Stock type filter value

Enums§

Asset
Asset class key in the generated catalog (crypto, stock, …).

Functions§

all_countries
Returns all country catalog entries.
all_exchanges
Returns all exchange catalog entries.
all_index_symbols
Returns all index symbol definitions from the catalog.
all_industries
Returns all industry catalog entries.
all_markets
Returns all configured markets from the catalog.
all_ratings
Returns recommendation rating bands (same order as rating::ALL).
all_sectors
Returns all sector catalog entries.
bond_volume
Bond sort field: volume.
catalog_len
Returns how many fields are registered for an asset in the embedded catalog.
coin_market_cap
Coin sort field: market cap.
country_value
Country wire value by constant name.
crypto_price
Crypto price (close) field.
crypto_rsi_14
Crypto RSI(14) field used in technical presets and filters.
crypto_volume_24h_in_usd
Crypto sort field: 24h volume in USD.
default_bond_fields
Default bond columns; falls back to bond_basic preset when the catalog default list is empty.
default_coin_fields
Default coin columns (DEFAULT_COIN_FIELDS).
default_crypto_fields
Default crypto columns (DEFAULT_CRYPTO_FIELDS).
default_fields
Default columns for asset (same as the typed screener constructors).
default_forex_fields
Default forex columns (DEFAULT_FOREX_FIELDS).
default_futures_fields
Default futures columns (DEFAULT_FUTURES_FIELDS).
default_stock_fields
Default stock columns (DEFAULT_STOCK_FIELDS).
exchange_value
Exchange wire value by constant name.
forex_name
Forex sort field: name.
futures_volume
Futures sort field: volume.
get_preset
Returns preset field lists by name
index_symbol_value
Looks up an index catalog symbol by constant name (e.g. "SP500" → "SP;SPX").
industry_value
Industry wire value by constant name.
list_fields
Returns every field definition for an asset (full catalog, not only defaults).
list_presets
Lists known preset names sorted alphabetically
market
Finds a market by catalog constant name.
rating
Looks up a rating band by constant name.
rating_find
Finds the rating band containing value, or rating::UNKNOWN.
require_field
Returns a catalog field or an error when it is missing.
resolve_country
Resolves a country token (const name or wire value).
resolve_exchange
Resolves an exchange token (const name or wire value).
resolve_field
Resolves a field by constant name, technical name, or label (case-insensitive).
resolve_industry
Resolves an industry token (const name or wire value).
resolve_sector
Resolves a sector token (const name or wire value) to the catalog wire string.
search_fields
Searches catalog fields for an asset by label, constant name, or technical name.
sector_value
Sector wire value by constant name (e.g. "TECHNOLOGY_SERVICES").
stock_market_capitalization
Stock sort field: market capitalization.
symbol_type
Finds a stock symbol subtype by catalog constant name.
to_symbolset_wire
Formats a catalog index symbol for the scan symbols.symbolset array.
type_filter
Finds a stock type filter by catalog constant name.