2164 Fields A89352d4

Fields API Reference

Field enums provide type-safe access to screener data.

Field Classes

Import

from tvscreener import StockField
from tvscreener.field import StockField, CryptoField, ForexField

Comparison Operators

Fields support Python comparison operators for filtering:

Numeric Comparisons

StockField.PRICE > 100          # Greater than
StockField.PRICE >= 100         # Greater than or equal
StockField.PRICE < 100          # Less than
StockField.PRICE <= 100         # Less than or equal
StockField.PRICE == 100         # Equal to
StockField.PRICE != 100         # Not equal to

Range Methods

StockField.PRICE.between(50, 200)       # Value in range [50, 200]
StockField.PRICE.not_between(50, 200)   # Value outside range

List Methods

StockField.SECTOR.isin(['Technology', 'Healthcare'])
StockField.SECTOR.not_in(['Finance', 'Utilities'])

Field Properties

Each field has accessible properties:

field = StockField.PRICE

field.name          # Enum name: 'PRICE'
field.value         # Field definition tuple
field.label         # Human-readable label
field.field_name    # API field name
field.format        # Data format type

Format Types

Time Intervals

Technical fields support multiple timeframes:

# Default (daily)
StockField.RELATIVE_STRENGTH_INDEX_14

# With specific interval
StockField.RELATIVE_STRENGTH_INDEX_14.with_interval('60')   # 1 hour
StockField.RELATIVE_STRENGTH_INDEX_14.with_interval('240')  # 4 hours
StockField.RELATIVE_STRENGTH_INDEX_14.with_interval('1W')   # Weekly

Available Intervals

Historical Data

Some fields support historical lookback:

# Previous day's RSI
StockField.RELATIVE_STRENGTH_INDEX_14.with_history(1)

# RSI from 5 days ago
StockField.RELATIVE_STRENGTH_INDEX_14.with_history(5)

Field Discovery

Search

Find fields by name:

matches = StockField.search("dividend")
for field in matches[:10]:
    print(f"{field.name}: {field.label}")

Presets

Get grouped fields:

# Technical indicators
technicals = StockField.technicals()

# Oscillators
oscillators = StockField.oscillators()

# Moving averages
mas = StockField.moving_averages()

# Valuations
valuations = StockField.valuations()

# Dividends
dividends = StockField.dividends()

# Performance
performance = StockField.performance()

# Recommendations
recommendations = StockField.recommendations()

Common Fields Reference

Price & Volume

Valuation

Dividends

Technical

Performance

Profitability