The same field list is available from the API, with each field's data type.
GET
/v1/screener/fields
Auth required (X-Api-Key)
|
Rate Limited: Yes
|
Plan: Growth+
This endpoint takes no parameters.
curl -H "X-Api-Key: YOUR_API_KEY" \
"https://lab.flashalpha.com/v1/screener/fields"
import requests
resp = requests.get(
"https://lab.flashalpha.com/v1/screener/fields",
headers={"X-Api-Key": "YOUR_API_KEY"}
)
resp.raise_for_status()
data = resp.json()
print(data["count"], "fields")
const resp = await fetch(
"https://lab.flashalpha.com/v1/screener/fields",
{ headers: { "X-Api-Key": "YOUR_API_KEY" } }
);
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();
console.log(data.count, "fields");
{
"fields": [
{
"name": "ask",
"type": "number"
},
{
"name": "atm_contracts",
"type": "integer"
},
{
"name": "atm_iv",
"type": "number"
}
],
"count": 85,
"endpoint_version": "2026.09.30",
"data_as_of": {
"node": "fa5",
"equity_feed": "2026-10-30T04:00:00.155Z",
"equity_options_feed": "2026-10-29T21:15:01Z",
"index_feed": "2026-10-30T07:28:31.377Z",
"index_options_feed": "2026-10-29T21:00:01Z",
"futures_feed": "2026-10-30T07:28:38.209Z",
"futures_options_feed": "2026-10-30T07:28:38.537Z",
"flow_feed": "2026-10-30T03:16:00Z",
"oi_feed": "2026-10-29T00:00:00Z",
"macro_feed": "2026-10-29T20:00:00Z"
}
}
The example keeps 3 of the 85 entries in fields.
| Field |
Type |
Description |
fields | array | Every screenable field |
fields[].name | string | Field name as used in filters, sort and select |
fields[].type | string | Data type: number, integer, decimal, string, int64 |
count | integer | Number of entries in fields |
endpoint_version, data_as_of | string, object | Response envelope, see Response envelope. |
| Status |
Error |
When |
401 | - | Missing or invalid X-Api-Key. The body is empty; check the status code before parsing JSON. |
403 | tier_restricted | Your plan is below Growth. The body includes current_plan and required_plan. |
429 | Quota exceeded | Daily quota used up. Retry-After gives the seconds until the reset at 00:00 UTC. Rejected requests (including 403) count toward the quota. |
The screener models every symbol as a nested tree:
Stock (1 per symbol)
└─ Expiry aggregates (many per symbol)
└─ Strike aggregates (many per expiry)
└─ Contracts (2 per strike: C and P)
Reference fields at the level you care about using a dotted prefix in your filter: field, expiries.field, strikes.field, contracts.field. Filters at lower levels cascade inside an AND group.
| Field | Type | Tier | Description |
symbol | string | Growth | Underlying ticker (e.g. SPY) |
price | number | Growth | Current underlying last trade |
bid | number | Growth | National best bid |
ask | number | Growth | National best ask |
mid | number | Growth | (bid + ask) / 2 |
market_open | bool | Growth | True when the cash session is open |
| Field | Type | Tier | Description |
gamma_flip | number | Growth | Strike where net GEX crosses zero - the gamma flip point |
call_wall | number | Growth | Strike with highest positive call GEX - the call wall (resistance) |
put_wall | number | Growth | Strike with most negative put GEX - the put wall (support) |
max_positive_gamma | number | Growth | Strike holding the largest positive GEX bucket |
max_negative_gamma | number | Growth | Strike holding the largest negative GEX bucket |
highest_oi_strike | number | Growth | Strike with most combined OI - see highest OI strike |
max_pain | number | Growth | Strike minimizing total option payouts at expiry - see max pain |
zero_dte_magnet | number | Growth | 0DTE pin candidate strike - see 0DTE magnet |
| Field | Type | Tier | Description |
zero_dte_net_gex | number | Growth | Net GEX concentrated in 0DTE expirations |
zero_dte_pct_of_total | number | Growth | 0DTE GEX as a fraction of total GEX |
| Field | Type | Tier | Description |
vrp_5d, vrp_10d, vrp_20d, vrp_30d | number | Growth | IV minus RV over the matching window - see VRP and IV-RV spread |
vrp_assessment | string | Growth | VRP classification: very_high_premium, healthy_premium, moderate_premium, thin_premium, negative_spread, danger_zone, unknown |
| Field | Type | Tier | Description |
variance_risk_premium | number | Alpha | Variance-space VRP - see variance swap |
convexity_premium | number | Alpha | Convexity premium - wing richness vs ATM |
vrp_z_score | number | Alpha | VRP z-score vs rolling 252-day history |
vrp_percentile | integer | Alpha | VRP percentile 0-100 |
vrp_regime | string | Alpha | VRP regime: harvestable, toxic_short_vol, cheap_convexity, event_only, surface_distorted |
| Field | Type | Tier | Description |
put_wing_iv_25d | number | Alpha | 25-delta put IV - see skew |
call_wing_iv_25d | number | Alpha | 25-delta call IV - see skew |
downside_rv_20d | number | Alpha | Downside semi-deviation (20d) - see realized volatility |
upside_rv_20d | number | Alpha | Upside semi-deviation (20d) - see realized volatility |
downside_vrp | number | Alpha | Put-wing IV minus downside RV - see directional VRP |
upside_vrp | number | Alpha | Call-wing IV minus upside RV - see directional VRP |
| Field | Type | Tier | Description |
skew_25d, skew_25d_put, skew_25d_call | number | Growth | 25-delta skew (vol points) |
term_near_slope_pct, term_far_slope_pct | number | Growth | IV term structure slopes (%) |
term_state | string | Growth | Term structure state: contango, backwardation, mixed, unknown |
atm_spread_pct, wing_spread_pct | number | Growth | Bid-ask spread as % of mid (ATM / wings) - see liquidity |
atm_contracts, wing_contracts | integer | Growth | Number of quotes with non-zero liquidity |
top_3_pct, top_5_pct, herfindahl | number | Growth | OI concentration metrics |
total_call_oi, total_put_oi | integer | Growth | Chain-wide OI totals |
total_call_volume, total_put_volume | integer | Growth | Chain-wide session volume |
pc_ratio_oi, pc_ratio_volume | number | Growth | Put/Call ratios (OI and volume) |
iv_dispersion_cross_expiry, iv_dispersion_cross_strike | number | Growth | IV dispersion across the surface |
gex_0to7_dte, gex_8to30_dte, gex_31to60_dte, gex_61plus_dte | number | Growth | GEX bucketed by DTE |
| Field | Type | Tier | Description |
harvest_score | int 0-100 | Alpha | Composite “is VRP harvestable right now?” score - see harvest score. Alias of net_harvest_score. |
net_harvest_score | int 0-100 | Alpha | Canonical name for the same value as harvest_score - see harvest score. Dealer flow risk is reported separately in dealer_flow_risk. |
dealer_flow_risk | int 0-100 | Alpha | Estimate of gamma-unfriendly dealer hedging - see dealer flow risk |
short_put_spread_score | int 0-100 | Alpha | Bull put spread attractiveness |
short_strangle_score | int 0-100 | Alpha | Short strangle attractiveness - see strategy scores |
iron_condor_score | int 0-100 | Alpha | Iron condor attractiveness - see strategy scores |
calendar_spread_score | int 0-100 | Alpha | Calendar spread attractiveness - see strategy scores |
Use as context filters (e.g. “only when VIX > 20”). Every symbol carries these same values.
| Field | Description |
vix | CBOE VIX |
vvix | Vol of VIX |
skew | CBOE SKEW index - see skew |
spx | S&P 500 level |
move | MOVE index (bond vol) |
vix_3m | 3-month VIX - see VIX term structure |
vix_term_slope | VIX term structure slope |
dgs10 | 10-year Treasury yield |
fed_funds | Fed funds rate |
hy_spread | High-yield credit spread |
One row per listed expiration. Filters cascade inside AND groups - non-matching expiries are trimmed from the symbol.
| Field | Description |
expiries.days_to_expiry | DTE (0 = today) |
expiries.atm_iv | ATM implied volatility for this expiry |
expiries.put_25d_iv, expiries.call_25d_iv | Wing IVs at 25-delta - see skew |
expiries.skew_25d | 25d skew for this expiry |
expiries.smile_ratio | Wing-to-ATM IV ratio - see smile ratio |
expiries.forward | Forward price implied by this expiry |
expiries.basis_pct | Forward basis (%) - see futures basis |
expiries.fair_vol | Model-fair vol at this expiry from SVI fit |
expiries.call_oi, expiries.put_oi | OI by side |
expiries.call_volume, expiries.put_volume | Session volume by side |
expiries.net_gex, expiries.net_dex, expiries.net_vex, expiries.net_chex | Exposure at this expiry - GEX, DEX, VEX, CHEX |
expiries.iv, expiries.rv, expiries.vrp | Per-expiry IV, RV, and their VRP spread |
| Field | Description |
strikes.strike | Strike price |
strikes.call_gex, strikes.put_gex, strikes.net_gex | Gamma exposure at strike |
strikes.call_dex, strikes.put_dex, strikes.net_dex | Delta exposure at strike |
strikes.call_vex, strikes.put_vex, strikes.net_vex | Vanna exposure at strike |
strikes.call_chex, strikes.put_chex, strikes.net_chex | Charm exposure at strike |
strikes.call_oi, strikes.put_oi | OI by side at strike |
strikes.call_volume, strikes.put_volume | Session volume by side at strike |
Individual call/put contracts (2 per strike). Cascading filters here are how you pull “only the ATM 30-delta calls expiring this Friday” in a single query.
| Field | Type | Description |
contracts.type | string | "C" or "P" |
contracts.expiry | string | Expiry date (from parent) |
contracts.strike | number | Strike (from parent) |
contracts.dte | number | Days to expiry (from parent) |
contracts.bid, contracts.ask, contracts.mid | number | Quote |
contracts.iv | number | Implied volatility (decimal) |
contracts.delta, contracts.gamma, contracts.theta, contracts.vega | number | First-order Greeks: delta, gamma, theta, vega |
contracts.oi | integer | Open interest |
contracts.volume | integer | Daily volume |
These fields are silently omitted from Growth responses but throw validation_error when used in a filter or sort:
harvest_score, dealer_flow_risk, vrp_regime, variance_risk_premium, convexity_premium, vrp_z_score, vrp_percentile, put_wing_iv_25d, call_wing_iv_25d, downside_rv_20d, upside_rv_20d, downside_vrp, upside_vrp, short_put_spread_score, short_strangle_score, iron_condor_score, calendar_spread_score.
Unlock Alpha-only fields
Growth gives you every stock-level, expiry, strike, and contract field across a 20-symbol universe. Alpha unlocks the strategy scores (harvest_score, dealer_flow_risk, iron_condor_score, …), extended VRP fields, formulas, and ~250 symbols.