Crypto Option

CryptoOption represents a put or call option on a crypto underlying. It defines the option kind, strike price, activation time, expiration time, quote currency, settlement currency, and contract sizing.

Examples include BTC and ETH options on crypto derivatives venues.

Fields

Field	Type	Required/default	Notes
`instrument_id`	`InstrumentId`	Required	Stored as `id` in Rust.
`raw_symbol`	`Symbol`	Required	Native venue symbol.
`underlying`	`Currency`	Required	Crypto asset the option tracks.
`quote_currency`	`Currency`	Required	Currency used to quote the premium.
`settlement_currency`	`Currency`	Required	Currency used to settle PnL and fees.
`is_inverse`	`bool`	Required	True when sizing/costing is inverse.
`option_kind`	`OptionKind`	Required	Put or call.
`strike_price`	`Price`	Required	Option strike price.
`activation_ns`	`UnixNanos`	Required	Contract activation timestamp.
`expiration_ns`	`UnixNanos`	Required	Contract expiration timestamp.
`price_precision`	`u8`	Required	Decimal places allowed for prices.
`size_precision`	`u8`	Required	Decimal places allowed for order sizes.
`price_increment`	`Price`	Required	Smallest valid price step.
`size_increment`	`Quantity`	Required	Smallest valid size step.
`multiplier`	`Quantity`	`1`	Contract multiplier.
`lot_size`	`Quantity`	`1`	Rounded lot or board size.
`max_quantity`	`Option<Quantity>`	`None`	Maximum order quantity.
`min_quantity`	`Option<Quantity>`	`1`	Minimum order quantity.
`max_notional`	`Option<Money>`	`None`	Maximum order notional value.
`min_notional`	`Option<Money>`	`None`	Minimum order notional value.
`max_price`	`Option<Price>`	`None`	Maximum valid quote or order price.
`min_price`	`Option<Price>`	`None`	Minimum valid quote or order price.
`margin_init`	`Option<Decimal>`	`0`	Initial margin rate.
`margin_maint`	`Option<Decimal>`	`0`	Maintenance margin rate.
`maker_fee`	`Option<Decimal>`	`0`	Maker fee rate. Negative values rebate.
`taker_fee`	`Option<Decimal>`	`0`	Taker fee rate. Negative values rebate.
`tick_scheme`	`Option<Ustr>`	`None`	Registered variable tick scheme name.
`info`	`Option<Params>`	`None`	Adapter metadata.
`ts_event`	`UnixNanos`	Required	Event timestamp in nanoseconds.
`ts_init`	`UnixNanos`	Required	Initialization timestamp in nanoseconds.

</Tab> <Tab value="Python">

Field	Type	Required/default	Notes
`instrument_id`	`InstrumentId`	Required
`raw_symbol`	`Symbol`	Required	Native venue symbol.
`underlying`	`Currency`	Required	Crypto asset the option tracks.
`quote_currency`	`Currency`	Required	Currency used to quote the premium.
`settlement_currency`	`Currency`	Required	Currency used to settle PnL and fees.
`is_inverse`	`bool`	Required	True when sizing/costing is inverse.
`option_kind`	`OptionKind`	Required	Put or call.
`strike_price`	`Price`	Required	Option strike price.
`activation_ns`	`int`	Required	Contract activation timestamp.
`expiration_ns`	`int`	Required	Contract expiration timestamp.
`price_precision`	`int`	Required	Decimal places allowed for prices.
`size_precision`	`int`	Required	Decimal places allowed for order sizes.
`price_increment`	`Price`	Required	Smallest valid price step.
`size_increment`	`Quantity`	Required	Smallest valid size step.
`multiplier`	`Quantity`	`1`	Contract multiplier.
`lot_size`	`Quantity`	`1`	Rounded lot or board size.
`max_quantity`	`Quantity \| None`	`None`	Maximum order quantity.
`min_quantity`	`Quantity \| None`	`1`	Minimum order quantity.
`max_notional`	`Money \| None`	`None`	Maximum order notional value.
`min_notional`	`Money \| None`	`None`	Minimum order notional value.
`max_price`	`Price \| None`	`None`	Maximum valid quote or order price.
`min_price`	`Price \| None`	`None`	Minimum valid quote or order price.
`margin_init`	`Decimal \| None`	`0`	Initial margin rate.
`margin_maint`	`Decimal \| None`	`0`	Maintenance margin rate.
`maker_fee`	`Decimal \| None`	`0`	Maker fee rate. Negative values rebate.
`taker_fee`	`Decimal \| None`	`0`	Taker fee rate. Negative values rebate.
`tick_scheme`	`str \| None`	`None`	Registered variable tick scheme name.
`info`	`dict \| None`	`None`	Adapter metadata.
`ts_event`	`int`	Required	Event timestamp in nanoseconds.
`ts_init`	`int`	Required	Initialization timestamp in nanoseconds.

</Tab> </Tabs>

Note: Python constructors use instrument_id; Rust stores the same value as id.

Behavior

CryptoOption has asset class Cryptocurrency and instrument class Option.
The option kind and strike price define the payoff shape.
The contract can be linear, inverse, or quanto, depending on the currency set.
Use OptionContract for non-crypto listed options.

Example

rust

use chrono::{TimeZone, Utc};
use nautilus_core::UnixNanos;
use nautilus_model::{
    enums::OptionKind,
    identifiers::{InstrumentId, Symbol},
    instruments::CryptoOption,
    types::{Currency, Money, Price, Quantity},
};
use rust_decimal_macros::dec;

let activation = Utc.with_ymd_and_hms(2022, 12, 22, 0, 0, 0).unwrap();
let expiration = Utc.with_ymd_and_hms(2023, 1, 13, 8, 0, 0).unwrap();

let btc_option = CryptoOption::builder()
    .instrument_id(InstrumentId::from("BTC-13JAN23-16000-P.DERIBIT"))
    .raw_symbol(Symbol::from("BTC-13JAN23-16000-P"))
    .underlying(Currency::from("BTC"))
    .quote_currency(Currency::from("USD"))
    .settlement_currency(Currency::from("BTC"))
    .is_inverse(false)
    .option_kind(OptionKind::Put)
    .strike_price(Price::from("16000.00"))
    .activation_ns(UnixNanos::from(activation.timestamp_nanos_opt().unwrap() as u64))
    .expiration_ns(UnixNanos::from(expiration.timestamp_nanos_opt().unwrap() as u64))
    .price_precision(2)
    .size_precision(1)
    .price_increment(Price::from("0.01"))
    .size_increment(Quantity::from("0.1"))
    .multiplier(Quantity::from("1"))
    .lot_size(Quantity::from("1"))
    .max_quantity(Quantity::from("9000"))
    .min_quantity(Quantity::from("0.1"))
    .min_notional(Money::from("10.00 USD"))
    .margin_init(dec!(0))
    .margin_maint(dec!(0))
    .maker_fee(dec!(0.0003))
    .taker_fee(dec!(0.0003))
    .ts_event(UnixNanos::default())
    .ts_init(UnixNanos::default())
    .build()
    .unwrap();

python

from decimal import Decimal

import pandas as pd

from nautilus_trader.model import CryptoOption
from nautilus_trader.model import Currency
from nautilus_trader.model import InstrumentId
from nautilus_trader.model import Money
from nautilus_trader.model import OptionKind
from nautilus_trader.model import Price
from nautilus_trader.model import Quantity
from nautilus_trader.model import Symbol

BTC = Currency.from_str("BTC")
USD = Currency.from_str("USD")

btc_option = CryptoOption(
    instrument_id=InstrumentId.from_str("BTC-13JAN23-16000-P.DERIBIT"),
    raw_symbol=Symbol("BTC-13JAN23-16000-P"),
    underlying=BTC,
    quote_currency=USD,
    settlement_currency=BTC,
    is_inverse=False,
    option_kind=OptionKind.PUT,
    strike_price=Price.from_str("16000.00"),
    activation_ns=pd.Timestamp("2022-12-22", tz="UTC").value,
    expiration_ns=pd.Timestamp("2023-01-13T08:00:00", tz="UTC").value,
    price_precision=2,
    size_precision=1,
    price_increment=Price.from_str("0.01"),
    size_increment=Quantity.from_str("0.1"),
    max_quantity=Quantity.from_str("9000"),
    min_quantity=Quantity.from_str("0.1"),
    min_notional=Money(10.00, USD),
    margin_init=Decimal(0),
    margin_maint=Decimal(0),
    maker_fee=Decimal("0.0003"),
    taker_fee=Decimal("0.0003"),
    ts_event=0,
    ts_init=0,
)

Adapters

Representative adapters that create or consume CryptoOption instruments include:

Bybit for crypto options.
Deribit for crypto options.
OKX for crypto options.
Tardis for crypto option metadata.

Options covers option data, Greeks, and chain subscriptions.
Crypto Option Spread covers exchange-defined crypto option spreads.

Crypto Option

Crypto Option

Fields

Behavior

Example

Adapters

Related guides