CuteMarkets Docs

API Reference

Everything you need to integrate market data, build faster, and scale.

Docs

Tip: open /docs/unusual-options-activity-scanner-model.md directly for raw markdown (easy copy/paste into an LLM).

An unusual options activity scanner is a ranking system, not an oracle. It should rank contracts for inspection, then hand those contracts to quote, trade, chain, and replay workflows. Use this guide with the Unusual Options Activity Scanner, Options Chain API, Option Chain docs, Options Chain Scanner Architecture, Historical Options Quotes API, and Options Trades API.

What the scanner can prove

A scanner can prove that a contract is active relative to the fields it sees. It can show volume, open interest, estimated premium, DTE, moneyness, IV, Greeks, and quote context when those fields are present in the chain snapshot. It can show that a row deserves review.

It cannot prove trader intent. A chain snapshot does not know whether a trade lifted the ask, hit the bid, opened a new position, closed an old one, rolled a hedge, or belonged to a multi-leg spread. That is why the scanner should present evidence and caveats instead of a buy or sell label.

Scanner outputStrong interpretationWeak interpretation
High volumeThe contract was active todaySomeone has directional conviction
Volume above OIToday activity is large versus the previous open interest baseEvery print opened a new position
Large premiumMore capital changed hands than in cheap-ticket flowThe buyer is informed
Tight spreadThe contract is easier to inspect and modelThe signal will make money
Short DTEEvent and gamma exposure may be concentratedThe contract is automatically better

For execution-side confirmation, hand the selected contract to Quotes, Trades, Quote vs Trade Timeline, and Backtesting Execution Realism.

Minimum fields

A useful unusual-activity row needs more than one price column:

FieldWhy it matters
details.tickerPreserves the exact OCC contract
details.expiration_dateDefines DTE and event horizon
details.contract_typeSeparates call and put activity
details.strike_priceSupports moneyness and strike clustering
day.volumeMeasures same-day contract activity
open_interestGives the previous-position baseline
last_quote.bid and last_quote.askSupports spread and midpoint checks
last_trade.priceGives last-sale context, not a full market
implied_volatilityHelps rank volatility-priced activity
greeks.deltaHelps compare risk exposure across strikes
underlying_asset.priceSupports moneyness and distance calculations

The Option Chain docs, Options Data API, and Options API Endpoint Coverage explain how those fields fit into the broader endpoint map.

Score components

A transparent scanner score is easier to trust than a black-box alert. CuteMarkets ranks contracts with a context score that emphasizes activity, premium, pressure against open interest, spread quality, and DTE.

ComponentPurposeCaveat
VolumeSurfaces active contractsCheap tickets can dominate raw volume
PremiumSeparates larger capital from small-ticket noisePremium does not reveal direction
Volume/OI pressureHighlights activity large relative to prior OIOI updates after the close
Spread percentPenalizes noisy, expensive-to-cross contractsSome event names still trade wide
DTEKeeps short-dated concentration visible0DTE activity can be noisy
Low-OI activityHelps surface fresh-looking rowsLow OI can also mean poor liquidity

The score should be treated as a review queue. A high score means "inspect this contract first." It does not mean "enter this trade."

Interpretation workflow

Use this scanner order:

  1. Resolve the watchlist ticker.
  2. Fetch listed expirations or choose a scanner DTE bucket.
  3. Request the chain snapshot for each expiration.
  4. Score rows by volume, premium, volume/OI pressure, spread percent, DTE, IV, and delta.
  5. Keep quote fields visible so wide markets can be rejected.
  6. Select exact OCC tickers for deeper inspection.
  7. Pull quote windows for bid/ask behavior.
  8. Pull trades for tape and activity validation.
  9. Store the scanner score, tags, rejects, and follow-up requests.

This path connects Options Chain API, Options Liquidity Scanner, Historical Options Replay Runbook, and Options Backtesting API.

Common false positives

Unusual-activity rows often look stronger than they are. Common false positives include:

  • far-OTM weekly contracts with large ticket count but tiny premium
  • contracts with high volume and no usable bid
  • contracts where the spread percent is too wide for the strategy
  • routine SPY or QQQ weekly activity that is active every session
  • earnings-week rows where the event explains the volume but not direction
  • rolls and spreads that look like single-leg conviction in a simple chain view
  • stale last-trade rows with no fresh quote support

Use Options Flow False Positives, Options Volume and Open Interest, and Why Option Quotes Matter More Than Last Price to keep these cases visible.

Artifact fields

A scanner artifact should store:

  • watchlist ticker
  • expiration date
  • OCC ticker
  • contract type
  • strike
  • DTE
  • underlying price
  • volume
  • open interest
  • volume/OI ratio
  • estimated premium
  • bid
  • ask
  • midpoint
  • spread percent
  • quote timestamp when available
  • IV and Greeks
  • scanner score
  • tags
  • reject reasons
  • next endpoint requested

The artifact gives a future dashboard, alert, backtest, or paper-trading system the reason a contract was surfaced and why it was accepted or rejected.

Related pages

Scanner model notes

A UOA scanner needs a scoring model and a reject model. The score can use volume, volume/OI pressure, premium, IV, moneyness, DTE, trade size, and event tags. The reject model catches stale quotes, wide spreads, no-bid rows, low open interest, excluded trade conditions, cheap far-OTM contracts, and incomplete pagination.

Store both sides of the model. Accepted alerts need the OCC symbol, selected expiration, strike, side, quote timestamp, bid, ask, trade evidence, score inputs, and related underlying state. Rejected candidates need identity plus reason. Pair this page with Options Chain Scanner Architecture, Options Flow False Positives, and Option Quote and Trade Conditions.

Terminology

Terms to keep straight on this page

Market-data APIs use similar words for different objects. These links keep the docs page connected to the precise CuteMarkets workflow and related reference material.

OPRA-originating data

The listed-options source context behind quotes, trades, participant records, exchange context, and consolidated option-market data.

SIP and direct feed

Market-data delivery paths that explain where consolidated equities and options records originate before a normalized API returns them.

Quote, trade, aggregate

Three different price semantics: executable bid/ask market, printed transaction, and bar-level summary.

Quote/trade condition

The sale condition, quote condition, exchange id, correction, sequence, and timestamp context attached to market-data rows.

Contract identity

The OCC symbol, expiration, strike, side, root, and reference data needed to preserve the exact option being studied.

Entitlement gate

A plan-aware check that prevents live, quote, WebSocket, or historical behavior from being implied when the product does not include it.

Access method

The delivery mode for data, such as REST request, WebSocket stream, historical window, flat file, or local cache.

Backfill window

A timestamp-bounded REST request used to repair or complete data after a stream gap, retry, deploy, or cache miss.

Session label

A premarket, regular, after-hours, closed, half-day, holiday, or unknown tag attached to a market-data timestamp.

Data-quality reject

A logged reason for skipping a candidate because required contracts, quotes, timestamps, pagination, or entitlements failed policy.

Commercial-use boundary

The product, plan, display, redistribution, and customer-facing use context that must be reviewed before shipping market data.

Adjusted option deliverable

The changed deliverable or contract terms that can appear after splits, mergers, special dividends, or other corporate actions.

Next steps

Move from the docs into the product workflow

If you are evaluating the API rather than implementing a specific endpoint right now, the product pages map live and historical workflows for stocks, options, and WebSockets.