Skip to main content

nautilus_model/python/account/
margin_model.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//! Python bindings for margin model types.
17
18use pyo3::prelude::*;
19
20use crate::accounts::margin_model::{LeveragedMarginModel, StandardMarginModel};
21
22#[pymethods]
23#[pyo3_stub_gen::derive::gen_stub_pymethods]
24impl StandardMarginModel {
25    /// Uses fixed margin percentages without leverage division.
26    ///
27    /// Margin is calculated as `notional_value * margin_rate`, ignoring the
28    /// account leverage. Appropriate for traditional brokers where margin
29    /// requirements are fixed percentages of notional value.
30    #[new]
31    fn py_new() -> Self {
32        Self
33    }
34
35    fn __repr__(&self) -> String {
36        format!("{self:?}")
37    }
38}
39
40#[pymethods]
41#[pyo3_stub_gen::derive::gen_stub_pymethods]
42impl LeveragedMarginModel {
43    /// Divides notional value by leverage before applying margin rates.
44    ///
45    /// Margin is calculated as `(notional_value / leverage) * margin_rate`.
46    /// This is the default model, appropriate for crypto exchanges and venues
47    /// where leverage directly reduces margin requirements.
48    #[new]
49    fn py_new() -> Self {
50        Self
51    }
52
53    fn __repr__(&self) -> String {
54        format!("{self:?}")
55    }
56}