Martingale42/nautilus-dev / skills/nt-adapters
nt-adapters
VerifiedUse when working with exchange or data provider adapters, HTTP/WebSocket clients, instrument providers, or venue integration in NautilusTrader.
references/examples/okx/okx_exec_tester.py
View on GitHub#!/usr/bin/env python3
# -------------------------------------------------------------------------------------------------
# Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
# https://nautechsystems.io
#
# Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
# You may not use this file except in compliance with the License.
# You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# -------------------------------------------------------------------------------------------------
from decimal import Decimal
from nautilus_trader.adapters.okx import OKX
from nautilus_trader.adapters.okx import OKXDataClientConfig
from nautilus_trader.adapters.okx import OKXExecClientConfig
from nautilus_trader.adapters.okx import OKXLiveDataClientFactory
from nautilus_trader.adapters.okx import OKXLiveExecClientFactory
from nautilus_trader.config import InstrumentProviderConfig
from nautilus_trader.config import LiveExecEngineConfig
from nautilus_trader.config import LoggingConfig
from nautilus_trader.config import TradingNodeConfig
from nautilus_trader.core.nautilus_pyo3 import OKXContractType
from nautilus_trader.core.nautilus_pyo3 import OKXInstrumentType
from nautilus_trader.core.nautilus_pyo3 import OKXMarginMode
from nautilus_trader.live.config import LiveRiskEngineConfig
from nautilus_trader.live.node import TradingNode
from nautilus_trader.model.enums import OrderType
from nautilus_trader.model.enums import TriggerType
from nautilus_trader.model.identifiers import InstrumentId
from nautilus_trader.model.identifiers import TraderId
from nautilus_trader.test_kit.strategies.tester_exec import ExecTester
from nautilus_trader.test_kit.strategies.tester_exec import ExecTesterConfig
# *** THIS IS A TEST STRATEGY WITH NO ALPHA ADVANTAGE WHATSOEVER. ***
# *** IT IS NOT INTENDED TO BE USED TO TRADE LIVE WITH REAL MONEY. ***
# Configuration - Change instrument_type to switch between trading modes
instrument_type = OKXInstrumentType.SWAP # SPOT, MARGIN, SWAP, FUTURES, OPTION
token = "ETH"
# Symbol mapping based on instrument type
if instrument_type == OKXInstrumentType.SPOT:
symbol = f"{token}-USDT"
contract_types: tuple[OKXContractType, ...] | None = None # SPOT doesn't use contract types
order_qty = Decimal("10.00") # In quote currency for buying
# order_qty = Decimal("0.01") # In base currency for selling
enable_limit_sells = False
use_spot_margin = False
use_quote_quantity = True
elif instrument_type == OKXInstrumentType.MARGIN:
symbol = f"{token}-USDT"
contract_types = None # MARGIN doesn't use contract types
order_qty = Decimal("10.00") # In quote currency for buying
# order_qty = Decimal("0.01") # In base currency for selling
enable_limit_sells = False
use_spot_margin = True
use_quote_quantity = True
elif instrument_type == OKXInstrumentType.SWAP:
symbol = f"{token}-USDT-SWAP"
contract_types = (OKXContractType.LINEAR,)
order_qty = Decimal("0.01")
enable_limit_sells = True
use_spot_margin = False
use_quote_quantity = False
elif instrument_type == OKXInstrumentType.FUTURES:
# Format: ETH-USD-YYMMDD (e.g., ETH-USD-241227, ETH-USD-250131)
symbol = f"{token}-USD-251226" # ETH-USD futures expiring 2025-12-26
contract_types = (OKXContractType.INVERSE,) # ETH-USD futures are inverse contracts
order_qty = Decimal(1)
enable_limit_sells = True
use_spot_margin = False
use_quote_quantity = False
elif instrument_type == OKXInstrumentType.OPTION:
symbol = (
f"{token}-USD-251226-4000-C" # Example: ETH-USD call option, strike 4000, exp 2025-12-26
)
contract_types = None # Options don't use contract types in the same way
order_qty = Decimal(1)
enable_limit_sells = True
use_spot_margin = False
use_quote_quantity = False
else:
raise ValueError(f"Unsupported instrument type: {instrument_type}")
instrument_id = InstrumentId.from_str(f"{symbol}.{OKX}")
# Setup instruments and types based on instrument_type
instrument_types: tuple[OKXInstrumentType, ...]
if instrument_type in (OKXInstrumentType.SPOT, OKXInstrumentType.SWAP):
spot_instrument_id = InstrumentId.from_str(f"{token}-USDT.{OKX}")
swap_instrument_id = InstrumentId.from_str(f"{token}-USDT-SWAP.{OKX}")
reconciliation_instrument_ids = [spot_instrument_id, swap_instrument_id]
load_ids = frozenset([spot_instrument_id, swap_instrument_id])
external_order_claims = [spot_instrument_id, swap_instrument_id]
instrument_types = (
OKXInstrumentType.SPOT,
OKXInstrumentType.SWAP,
)
else:
# For FUTURES and OPTION, use only the primary instrument
reconciliation_instrument_ids = [instrument_id]
load_ids = frozenset([instrument_id])
external_order_claims = [instrument_id]
instrument_types = (instrument_type,)
instrument_families = (
# "BTC-USD",
# "ETH-USDT",
)
# Configure the trading node
config_node = TradingNodeConfig(
trader_id=TraderId("TESTER-001"),
logging=LoggingConfig(
log_level="INFO",
# log_level_file="DEBUG",
use_pyo3=True,
),
exec_engine=LiveExecEngineConfig(
convert_quote_qty_to_base=False,
reconciliation=True,
reconciliation_instrument_ids=reconciliation_instrument_ids,
# reconciliation_lookback_mins=60,
open_check_interval_secs=5.0,
open_check_open_only=False,
position_check_interval_secs=60,
# own_books_audit_interval_secs=2.0,
# manage_own_order_books=True,
# snapshot_orders=True,
# snapshot_positions=True,
# snapshot_positions_interval_secs=5.0,
purge_closed_orders_interval_mins=15, # Example of purging closed orders for HFT
purge_closed_orders_buffer_mins=60, # Purged orders closed for at least an hour
purge_closed_positions_interval_mins=15, # Example of purging closed positions for HFT
purge_closed_positions_buffer_mins=60, # Purge positions closed for at least an hour
purge_account_events_interval_mins=15, # Example of purging account events for HFT
purge_account_events_lookback_mins=60, # Purge account events occurring more than an hour ago
graceful_shutdown_on_exception=True,
),
risk_engine=LiveRiskEngineConfig(bypass=True), # Must bypass for spot margin for now
# cache=CacheConfig(
# database=DatabaseConfig(),
# timestamps_as_iso8601=True,
# buffer_interval_ms=100,
# ),
# message_bus=MessageBusConfig(
# database=DatabaseConfig(),
# timestamps_as_iso8601=True,
# buffer_interval_ms=100,
# use_trader_prefix=False,
# use_trader_id=False,
# use_instance_id=False,
# stream_per_topic=False,
# types_filter=[QuoteTick],
# autotrim_mins=30,
# heartbeat_interval_secs=1,
# ),
data_clients={
OKX: OKXDataClientConfig(
api_key=None, # 'OKX_API_KEY' env var
api_secret=None, # 'OKX_API_SECRET' env var
api_passphrase=None, # 'OKX_API_PASSPHRASE' env var
base_url_http=None, # Override with custom endpoint
instrument_provider=InstrumentProviderConfig(
load_all=False,
load_ids=load_ids,
),
instrument_types=instrument_types,
contract_types=contract_types,
is_demo=False, # If client uses the demo API
http_timeout_secs=10, # Set to reasonable duration
),
},
exec_clients={
OKX: OKXExecClientConfig(
api_key=None, # 'OKX_API_KEY' env var
api_secret=None, # 'OKX_API_SECRET' env var
api_passphrase=None, # 'OKX_API_PASSPHRASE' env var
base_url_http=None, # Override with custom endpoint
base_url_ws=None, # Override with custom endpoint
instrument_provider=InstrumentProviderConfig(
load_all=False,
load_ids=load_ids,
),
instrument_types=instrument_types,
contract_types=contract_types,
margin_mode=OKXMarginMode.CROSS,
use_spot_margin=use_spot_margin,
# use_spot_cash_position_reports=True, # Spot CASH position reports
# use_mm_mass_cancel=True,
is_demo=False, # If client uses the demo API
use_fills_channel=False, # Set to True if VIP5+ to get separate fill reports
http_timeout_secs=10, # Set to reasonable duration
),
},
timeout_connection=20.0,
timeout_reconciliation=10.0,
timeout_portfolio=10.0,
timeout_disconnection=10.0,
timeout_post_stop=5.0,
)
# Instantiate the node with a configuration
node = TradingNode(config=config_node)
# Configure your strategy
config_tester = ExecTesterConfig(
instrument_id=instrument_id,
external_order_claims=external_order_claims,
use_hyphens_in_client_order_ids=False, # OKX doesn't allow hyphens in client order IDs
# subscribe_quotes=False,
# subscribe_trades=False,
# subscribe_book=True,
enable_limit_buys=False,
enable_limit_sells=False,
# open_position_on_start_qty=order_qty,
# open_position_time_in_force=TimeInForce.IOC,
# tob_offset_ticks=0,
# stop_offset_ticks=1,
order_qty=order_qty,
# modify_orders_to_maintain_tob_offset=True,
# use_post_only=True,
use_quote_quantity=use_quote_quantity,
# enable_stop_buys=True,
# enable_stop_sells=True,
# stop_order_type=OrderType.STOP_MARKET,
# stop_trigger_type=TriggerType.LAST_PRICE,
# stop_offset_ticks=50, # Offset from current price for stop trigger
# stop_limit_offset_ticks=10, # Additional offset for STOP_LIMIT orders
enable_stop_sells=True,
stop_order_type=OrderType.STOP_MARKET,
stop_trigger_type=TriggerType.LAST_PRICE,
stop_offset_ticks=50,
# stop_order_type=OrderType.STOP_LIMIT,
# stop_limit_offset_ticks=10,
# stop_order_type=OrderType.MARKET_IF_TOUCHED,
# stop_order_type=OrderType.LIMIT_IF_TOUCHED,
# stop_limit_offset_ticks=10,
# stop_order_type=OrderType.TRAILING_STOP_MARKET,
# trailing_offset=Decimal(100), # 1% callback ratio in basis points
# trailing_offset_type=TrailingOffsetType.BASIS_POINTS,
# cancel_orders_on_stop=False,
# close_positions_on_stop=False,
# use_individual_cancels_on_stop=True,
# use_batch_cancel_on_stop=True,
# test_reject_post_only=True,
log_data=False,
dry_run=False,
)
# Instantiate your strategy
strategy = ExecTester(config=config_tester)
# Add your strategies and modules
node.trader.add_strategy(strategy)
# Register your client factories with the node (can take user-defined factories)
node.add_data_client_factory(OKX, OKXLiveDataClientFactory)
node.add_exec_client_factory(OKX, OKXLiveExecClientFactory)
node.build()
# Stop and dispose of the node with SIGINT/CTRL+C
if __name__ == "__main__":
try:
node.run()
finally:
node.dispose()
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |