Perpetual Contract

PerpetualContract represents a generic perpetual futures contract across asset classes. Use it when a venue exposes a perpetual swap that is not specifically modeled as CryptoPerpetual.

Examples include non-crypto perpetual contracts and venue-specific synthetic swaps.

Fields

Field	Type	Required/default	Notes
`instrument_id`	`InstrumentId`	Required	Stored as `id` in Rust.
`raw_symbol`	`Symbol`	Required	Native venue symbol.
`underlying`	`Ustr`	Required	Underlying asset or reference market.
`asset_class`	`AssetClass`	Required	Asset class of the underlying.
`base_currency`	`Option<Currency>`	`None`	Base currency, required for inverse.
`quote_currency`	`Currency`	Required	Currency used to quote the price.
`settlement_currency`	`Currency`	Required	Currency used to settle PnL and fees.
`is_inverse`	`bool`	Required	True when sizing/costing is inverse.
`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>`	`None`	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.

Field	Type	Required/default	Notes
`instrument_id`	`InstrumentId`	Required
`raw_symbol`	`Symbol`	Required	Native venue symbol.
`underlying`	`str`	Required	Underlying asset or reference market.
`asset_class`	`AssetClass`	Required	Asset class of the underlying.
`base_currency`	`Currency \| None`	`None`	Base currency, required for inverse.
`quote_currency`	`Currency`	Required	Currency used to quote the price.
`settlement_currency`	`Currency`	Required	Currency used to settle PnL and fees.
`is_inverse`	`bool`	Required	True when sizing/costing is inverse.
`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`	`None`	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.

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

Behavior

PerpetualContract has instrument class Swap.
It has no activation timestamp or expiration timestamp.
Inverse contracts require a base currency.
Linear contracts typically settle in the quote currency.
Use CryptoPerpetual for crypto perpetuals where the base asset is a currency.

Example

use nautilus_core::UnixNanos;
use nautilus_model::{
    enums::AssetClass,
    identifiers::{InstrumentId, Symbol},
    instruments::PerpetualContract,
    types::{Currency, Price, Quantity},
};
use rust_decimal_macros::dec;
use ustr::Ustr;

let eurusd_perp = PerpetualContract::builder()
    .instrument_id(InstrumentId::from("EURUSD-PERP.AX"))
    .raw_symbol(Symbol::from("EURUSD-PERP"))
    .underlying(Ustr::from("EURUSD"))
    .asset_class(AssetClass::FX)
    .base_currency(Currency::from("EUR"))
    .quote_currency(Currency::from("USD"))
    .settlement_currency(Currency::from("USD"))
    .is_inverse(false)
    .price_precision(5)
    .size_precision(0)
    .price_increment(Price::from("0.00001"))
    .size_increment(Quantity::from("1"))
    .margin_init(dec!(0.03))
    .margin_maint(dec!(0.03))
    .maker_fee(dec!(0.00002))
    .taker_fee(dec!(0.00002))
    .ts_event(UnixNanos::default())
    .ts_init(UnixNanos::default())
    .build()
    .unwrap();

Adapters

Representative adapters that create or consume PerpetualContract instruments include:

Architect AX for venue-defined perpetual contracts.

Crypto Perpetual covers crypto perpetual futures.
Data covers mark prices, index prices, and funding rate updates.

Perpetual Contract

Fields

Behavior

Example

Adapters

Related guides

On this page