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
SECTORfilters.
Structs§
- Field
Def - One requestable scanner column
- Index
Symbol Def - One index filter entry
- Market
TradingViewmarket filter- Named
Value - Named catalog constant with a single wire/display string (sector, country, …).
- Rating
Band - Recommendation rating band (numeric recommendation scores).
- Symbol
Type - Stock
subtypefilter value - Type
Filter - Stock
typefilter 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_basicpreset 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, orrating::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.symbolsetarray. - type_
filter - Finds a stock
typefilter by catalog constant name.