nautilus_architect_ax/lib.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3// https://nautechsystems.io
4//
5// Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6// You may not use this file except in compliance with the License.
7// You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! [NautilusTrader](https://nautilustrader.io) adapter for Ax's [AX Exchange](https://architect.exchange).
17//!
18//! [AX Exchange](https://architect.exchange) is the world's first centralized and regulated
19//! exchange for perpetual futures on traditional underlying asset classes (FX, rates, metals,
20//! energy, stock indexes). Designed for institutional and professional traders, it combines
21//! innovations from digital asset perpetual exchanges with the safety and risk management of
22//! traditional futures exchanges. Licensed under the [Bermuda Monetary Authority (BMA)](https://www.bma.bm).
23//!
24//! The `nautilus-architect-ax` crate connects AX Exchange market data and order execution to NautilusTrader.
25//! It provides typed HTTP and WebSocket clients, instrument definitions, and live-node factories for
26//! production and sandbox environments.
27//!
28//! The official AX Exchange API reference can be found at <https://docs.architect.exchange/api-reference>.
29//!
30//! # NautilusTrader
31//!
32//! [NautilusTrader](https://nautilustrader.io) is an open-source, production-grade, Rust-native trading engine
33//! with a deterministic, event-driven architecture for multi-asset, multi-venue systems.
34//!
35//! The system spans research, simulation, and live execution, providing research-to-live semantic parity.
36//!
37//! # Feature Flags
38//!
39//! Feature flags control code inclusion for Rust builds and Python bindings:
40//!
41//! - `examples`: Enables the crate's example binaries.
42//! - `extension-module`: Builds as a Python extension module.
43//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
44//!
45//! # Integrator Attribution
46//!
47//! WebSocket order submissions set `tag` to `Nautilus` for attribution.
48//! HTTP order submissions omit `tag` unless the caller supplies it.
49//!
50//! # Documentation
51//!
52//! - [Integration guide](https://nautilustrader.io/docs/nightly/integrations/architect_ax/)
53//! - [Rust examples](https://github.com/nautechsystems/nautilus_trader/tree/develop/crates/adapters/architect_ax/examples)
54//! - [Python examples](https://github.com/nautechsystems/nautilus_trader/tree/develop/examples/live/architect_ax)
55
56#![warn(rustc::all)]
57#![deny(unsafe_code)]
58#![deny(nonstandard_style)]
59#![deny(missing_debug_implementations)]
60#![deny(clippy::missing_errors_doc)]
61#![deny(clippy::missing_panics_doc)]
62#![deny(rustdoc::broken_intra_doc_links)]
63// pyo3's `from_py_object` generates `.clone()` on `Copy` fields that clippy flags from the
64// macro expansion; an item-level `allow` cannot reach the expansion
65#![allow(clippy::clone_on_copy)]
66
67pub mod common;
68pub mod config;
69pub mod data;
70pub mod execution;
71pub mod factories;
72pub mod http;
73pub mod websocket;
74
75mod book;
76
77#[cfg(feature = "python")]
78pub mod python;