Docs
Tempest/API Reference/Tempest

Screen the whole Tempest universe (Radar)

GEThttps://api.skylit.ai/v1/vol/screener

Rows can include earnings_overlap_9d and earnings_overlap_30d, with none, partial, full, or null as documented on /v1/vol/term. These are optional calendar-day exposure labels, not forecast signals. Tempest Radar: one row per covered symbol with its headline readings (SVX term and percentiles, IV rank, ratio to VIX, term slope, skew, tilt, expected move, running sigma and odds, next event and VRP, options volume, sector, quality). Thin chains are not ranked. Filter with min_<field> / max_<field> on any sortable field, and curve, sector, quality (exact match). Unknown parameters are a 400. Rows missing the sort field sort last. Cost: 5 credits per call (up to 500 rows).

Authorization

Authorization: Bearer <your API key>

Required. A missing header returns 401; an invalid, revoked or expired key returns 403.

Query parameters

  • sortstringdefault svx30

    Field to sort by (default svx30): svx30, svx1d, svx30_pct_1y, svx1d_pct_1y, svx9_pct_1y, svx3m_pct_1y, iv_rank, iv_pct, ratio_vix, term_slope, rr25_30, skew_pct_1y, tilt_21, tilt_z, tilt_pct_1y, em_1d_pct, running_sigma, sigma_odds_pct, expected_vrp, event_move_pct, days_to_event, opt_vol, spot, spot_vol_corr, cheap_from_low_pct, day_pace, day_reprice. day_pace is today's move against the priced one-day move for the time elapsed, in sigma; day_reprice is the one-day range options price now over what they priced at the prior close for the rest of the day (above 1: implied vol bid). Both are null outside regular hours.

  • orderstringdefault desc
    ascdesc
  • limitintegerdefault 50min 1 · max 500
  • offsetintegerdefault 0min 0
  • min_iv_ranknumber

    Example bound; every sortable field accepts min_ and max_.

  • curvestring

    Curve state, e.g. contango or backwardation.

Responses

  • 200

    OK.

  • 400

    Request validation failed.

  • 401

    Missing API key (unauthorized), sent by the gateway.

  • 402

    Out of credits (insufficient_credits).

  • 403

    As Forbidden, or not_entitled: Tempest data is not enabled for this account (it is in preview). Refunded.

  • 404

    Unknown symbol, no data available, or none of the requested expirations exist for the symbol (code: expiration_not_found).

  • 429

    Per-minute rate limit exceeded.

  • 503

    Tempest data is loading (warming_up, with Retry-After) or not configured (unavailable). Refunded.

  • 504

    The request did not finish in time (gateway_timeout). Refunded; retry, or narrow the request.

Response fields

  • dataobjectrequired
    • rowsobject[]required
    • totalintegerrequired

      Rows matching the filters, before offset/limit.

    • offsetintegerrequired
    • limitintegerrequired
    • sortstringrequired
  • metaobjectrequired
    • modulestringrequired

      Which endpoint answered (iv, cones, screener, ...).

    • asOfstringdate-time

      When Tempest computed the newest value in this response.

    • sessionDatestringdate

      The trading session (ET) that asOf belongs to. The close state is stamped 15:59 ET and always belongs to its own session.

    • marketStatestringrequired

      US equity session at request time.

      pre_openopenpost_closeclosed
    • frozenbooleanrequired

      True while Tempest serves the previous close (outside regular hours).

    • publishedAtstringdate-time

      When Tempest last published to the API.

    • cachedbooleanrequired
    • attributionobject

      Whether and how this response's data may be published. See /legal/api#sharing. An Agent or MCP client should never publish data where shareable is false, regardless of shareClass. required, license, shareable and shareClass are always sent on /v1/options/* and absent from the short form.

Last updated

Was this page helpful?