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](http://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 provides client bindings (HTTP & WebSocket), data models, and
25//! helper utilities that wrap the official AX Exchange API.
26//!
27//! # Platform
28//!
29//! [NautilusTrader](http://nautilustrader.io) is an open-source, high-performance, production-grade
30//! algorithmic trading platform, providing quantitative traders with the ability to backtest
31//! portfolios of automated trading strategies on historical data with an event-driven engine,
32//! and also deploy those same strategies live, with no code changes.
33//!
34//! NautilusTrader's design, architecture, and implementation philosophy prioritizes software
35//! correctness and safety at the highest level, with the aim of supporting mission-critical
36//! trading system backtesting and live deployment workloads.
37//!
38//! # Feature flags
39//!
40//! This crate provides feature flags to control source code inclusion during compilation:
41//!
42//! - `python`: Enables Python bindings via [PyO3](https://pyo3.rs).
43//! - `extension-module`: Builds as a Python extension module (used together with `python`).
44//!
45//! # Documentation
46//!
47//! - API reference: <https://docs.sandbox.x.architect.co/api-reference/>
48//! - Crate docs: <https://docs.rs/nautilus-architect-ax>
49
50#![warn(rustc::all)]
51#![deny(unsafe_code)]
52#![deny(nonstandard_style)]
53#![deny(missing_debug_implementations)]
54#![deny(clippy::missing_errors_doc)]
55#![deny(clippy::missing_panics_doc)]
56#![deny(rustdoc::broken_intra_doc_links)]
57
58pub mod common;
59pub mod config;
60pub mod data;
61pub mod error;
62pub mod http;
63pub mod websocket;
64
65#[cfg(feature = "python")]
66pub mod python;