Every print, sweep and order.
/v1/tapeOption prints with the exchange and the quote at the time: the last minutes live, or any kept session.
symbolstringdefault allOne symbol.
datestringA kept session, YYYY-MM-DD; from and to then bound the window.
fromintegerdefault the sessionEpoch milliseconds; to is exclusive.
tointegerdefault the sessionEpoch milliseconds; to is exclusive.
sincestringdefault 5mLive window, 30s to 60m.
limitintegerdefault 500At most 2,000.
prints[].ts, ts_mstimestampExchange timestamp of the print.
prints[].symbol, expiration, strike, rightUSD for strikeThe contract.
prints[].sizenumbercontractsprints[].pricenumberUSD per shareprints[].premiumnumberUSDsize × price × 100.
prints[].exchangestringISO 10383 MICXCBO, XISX, MPRL, ...; null if unknown.
prints[].bid, asknumberUSD per shareBest bid and offer at the print; 0 when no quote.
count, sinceRows returned and the window start.
/v1/sweepsPrints in one contract across several exchanges within a fraction of a second, reported as one sweep with its side.
symbolstringOne symbol.
datestringA kept session's sweeps; from and to in epoch milliseconds.
fromintegerA kept session's sweeps; from and to in epoch milliseconds.
tointegerA kept session's sweeps; from and to in epoch milliseconds.
sincestringdefault 15mLive window, 30s to 240m.
window_msintegerWindow from the first print, 50 to 1,000,000.
min_exchangesintegerDistinct exchanges, 2 to 99.
sideenumdefault allbuy, sell or mixed.
sweeps[].ts, ts_mstimestampFirst print of the sweep.
sweeps[].symbol, expiration, strike, rightThe contract.
sweeps[].sizenumbercontractsTotal.
sweeps[].avg_pricenumberUSD per shareSize-weighted.
sweeps[].premiumnumberUSDTotal.
sweeps[].exchanges, tradesintegerDistinct exchanges and prints in the sweep.
sweeps[].sidestringbuy, sell or mixed.
window_ms, min_exchanges, side, since, countParameters applied and rows returned (side null when not filtered).
/v1/trades/v1/trades/statsEvery print of a session, or the orders built from them (sweeps, splits, blocks), filtered, sorted and paged; or grouped totals over the same prints.
datestringdefault todayA session, YYYY-MM-DD.
fromintegerEpoch milliseconds; to is exclusive.
tointegerEpoch milliseconds; to is exclusive.
viewstringdefault printsprints or orders.
tickersstringComma lists of tickers or OSI contract symbols.
osistringComma lists of tickers or OSI contract symbols.
typesstringC, P; ITM, ATM, OTM.
moneystringC, P; ITM, ATM, OTM.
sidesstringABOVE_ASK, ASK, MID_MARKET, BID, BELOW_BID.
sentimentsstringBULLISH, BEARISH, NEUTRAL.
exchangesstringComma lists: venue codes, sector and industry names.
consolidationstringSWEEP,SPLIT,BLOCK
sectorsstringComma lists: venue codes, sector and industry names.
industriesstringComma lists: venue codes, sector and industry names.
strikesstringComma lists: strikes in USD, dates YYYY-MM-DD.
expirationsstringComma lists: strikes in USD, dates YYYY-MM-DD.
premium_minnumberUSD; contracts.
premium_maxnumberUSD; contracts.
size_minintegerUSD; contracts.
goldenstring1 or 0.
unusualstring1 or 0.
sortstringdefault by the group columns, desc, 20000, 0tradeTime, premium, size, volume, openInterest, strikePrice, dte …; desc or asc. Default tradeTime, desc.
dirstringdefault by the group columns, desc, 20000, 0tradeTime, premium, size, volume, openInterest, strikePrice, dte …; desc or asc. Default tradeTime, desc.
limitintegerdefault by the group columns, desc, 20000, 0Rows, 1 to 1,000, default 50; after is the previous page's next.
afterstringdefault 50Rows, 1 to 1,000, default 50; after is the previous page's next.
statsstring1: totals by leg and side; orders with their prints.
comprisingstring1: totals by leg and side; orders with their prints.
bystring/stats: group by type, side, ticker, exchange, class, expiration, strike, contract, sentiment, bucket; a bucket's length in ms, default 60000.
periodintegerdefault 60000/stats: group by type, side, ticker, exchange, class, expiration, strike, contract, sentiment, bucket; a bucket's length in ms, default 60000.
ivstringdefault 0/stats: 1 adds mean IV per group; groups to skip, default 0.
offsetintegerdefault 0/stats: 1 adds mean IV per group; groups to skip, default 0.
trades[].idstringStable within the session.
trades[].ticker, osi, sector, industrystringtrades[].rightstringC or P.
trades[].expirationdatetrades[].dtenumbercalendar daysAt the print.
trades[].strikenumberUSDtrades[].exchangestringISO 10383 MIC of the exchange; null when unknown.
trades[].premiumnumberUSDsize × price × 100 (an order: its prints summed).
trades[].size, volume, open_interestintegercontractsvolume is the contract's volume so far that day, this print included.
trades[].price, bid, ask, spreadnumberUSD per shareThe price and the best bid and offer at the print.
trades[].spotnumberUSDSpot at that moment.
trades[].ivnumberfractionImplied volatility of the print's price; null when there is none.
trades[].sidestringWhere the print hit the quote: ABOVE_ASK, ASK, MID_MARKET, BID, BELOW_BID; null without a quote.
trades[].sentimentstringBULLISH (a call bought or a put sold), BEARISH (the reverse), NEUTRAL (unclassified).
trades[].order_typestringOrders: SWEEP, SPLIT, BLOCK; prints: null.
trades[].golden_sweep, unusual, index, volume_over_oibooleanFlags: a large aggressive sweep, an unusually active print, an index option; and the contract's volume over its open interest.
trades[].greeksobjectraw Greeks (Units table)At the print.
trades[].moneynessobjectdistance (spot − strike, USD), ratio (spot / strike − 1, fraction), type (ITM, ATM, OTM).
trades[].trade_time, trade_time_mstimestamp, integerThe print's moment, UTC; epoch ms twin.
trades[].prints[]arrayWith comprising=1 on orders: id, exchange, size, price, side, trade_time, trade_time_ms.
countintegerRows matching before paging.
nextarray[sort value, for the next page, or null.
statisticsobjectWith stats=1: by right (C, P) and side: premium, volume, count.
trades[].idstringStable within the session.
trades[].ticker, osi, sector, industrystringtrades[].rightstringC or P.
trades[].expirationdatetrades[].dtenumbercalendar daysAt the print.
trades[].strikenumberUSDtrades[].exchangestringISO 10383 MIC of the exchange; null when unknown.
trades[].premiumnumberUSDsize × price × 100 (an order: its prints summed).
trades[].size, volume, open_interestintegercontractsvolume is the contract's volume so far that day, this print included.
trades[].price, bid, ask, spreadnumberUSD per shareThe price and the best bid and offer at the print.
trades[].spotnumberUSDSpot at that moment.
trades[].ivnumberfractionImplied volatility of the print's price; null when there is none.
trades[].sidestringWhere the print hit the quote: ABOVE_ASK, ASK, MID_MARKET, BID, BELOW_BID; null without a quote.
trades[].sentimentstringBULLISH (a call bought or a put sold), BEARISH (the reverse), NEUTRAL (unclassified).
trades[].order_typestringOrders: SWEEP, SPLIT, BLOCK; prints: null.
trades[].golden_sweep, unusual, index, volume_over_oibooleanFlags: a large aggressive sweep, an unusually active print, an index option; and the contract's volume over its open interest.
trades[].greeksobjectraw Greeks (Units table)At the print.
trades[].moneynessobjectdistance (spot − strike, USD), ratio (spot / strike − 1, fraction), type (ITM, ATM, OTM).
trades[].trade_time, trade_time_mstimestamp, integerThe print's moment, UTC; epoch ms twin.
trades[].prints[]arrayWith comprising=1 on orders: id, exchange, size, price, side, trade_time, trade_time_ms.
countintegerRows matching before paging.
nextarray[sort value, for the next page, or null.
statisticsobjectWith stats=1: by right (C, P) and side: premium, volume, count.