Option identity
Option data uses three separate identifiers:
Pass the underlying as
market. Omit the query’s instrument to read every
contract in that option chain, or provide one exact instrument to filter the
results. Empty instrument filters are invalid, and every returned
option_ticker event has a non-empty instrument.
Methods
Python signature
Parameters
Query a whole chain
Omitinstrument to return every contract stored under the underlying market.
Filter one contract
Setinstrument when you only need one exact contract:
market when an event is missing its instrument;
malformed option ticker rows fail decoding.
Event shape
Price and size fields
mark_price,last_price,index_price,underlying_price,forward_pricebid_price,bid_size,ask_price,ask_sizeopen_interest,volume_24h,turnover_24h
Volatility and Greeks
mark_iv,bid_iv, andask_ivare annualized implied volatilities expressed as decimal strings.greeks.delta,greeks.gamma,greeks.vega,greeks.theta, andgreeks.rhoretain the venue’s convention as decimal strings.
Units
premium_currencyidentifies the premium denomination when the venue provides it.quantity_unitidentifies the contract quantity unit when the venue provides it.
Realtime filtering
Realtime streams use the same identity split. Pass the underlying inmarkets
and optionally add one exact instrument. Omitting it subscribes to the whole
chain.
Related documentation
- Options guide for market discovery and chain-snapshot analysis
- Event envelope for shared identity and timestamp fields
- Events for mixed standardized event streams
- Market coverage for available datasets
- Snapshots for snapshot-first historical reads