nautilus-interactive-brokers 0.62.0

Interactive Brokers integration adapter for the Nautilus trading engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

// -------------------------------------------------------------------------------------------------
//  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.
// -------------------------------------------------------------------------------------------------

//! Python bindings for the Interactive Brokers gateway management.

#[cfg(feature = "gateway")]
use nautilus_common::live::get_runtime;
#[cfg(feature = "gateway")]
use nautilus_core::python::to_pyruntime_err;
#[cfg(feature = "gateway")]
use pyo3::prelude::*;

#[cfg(feature = "gateway")]
use crate::config::DockerizedIBGatewayConfig;
#[cfg(feature = "gateway")]
use crate::gateway::dockerized::DockerizedIBGateway;

#[cfg(feature = "gateway")]
#[pymethods]
#[pyo3_stub_gen::derive::gen_stub_pymethods]
impl DockerizedIBGateway {
    #[new]
    fn py_new(config: DockerizedIBGatewayConfig) -> PyResult<Self> {
        Self::new(config).map_err(|e| to_pyruntime_err(format!("{e}")))
    }

    fn __repr__(&self) -> String {
        format!(
            "DockerizedIBGateway(container_name={}, host={}, port={})",
            self.container_name(),
            self.host(),
            self.port()
        )
    }

    /// Get the container name.
    #[getter("container_name")]
    fn py_container_name(&self) -> String {
        self.container_name().to_string()
    }

    /// Get the host address.
    #[getter("host")]
    fn py_host(&self) -> String {
        self.host().to_string()
    }

    /// Get the port.
    #[getter("port")]
    fn py_port(&self) -> u16 {
        self.port()
    }

    /// Start the gateway.
    ///
    /// # Arguments
    ///
    /// * `wait` - Optional wait time in seconds
    #[pyo3(name = "start")]
    fn py_start<'py>(&self, py: Python<'py>, wait: Option<u64>) -> PyResult<Bound<'py, PyAny>> {
        let mut gateway = self.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            gateway
                .start(wait)
                .await
                .map_err(|e| to_pyruntime_err(format!("{e}")))
        })
    }

    #[pyo3(name = "start_blocking")]
    fn py_start_blocking(&self, wait: Option<u64>) -> PyResult<()> {
        let mut gateway = self.clone();
        get_runtime()
            .block_on(async move { gateway.start(wait).await })
            .map_err(|e| to_pyruntime_err(format!("{e}")))
    }

    /// Safely start the gateway.
    ///
    /// # Arguments
    ///
    /// * `wait` - Optional wait time in seconds
    #[pyo3(name = "safe_start")]
    fn py_safe_start<'py>(
        &self,
        py: Python<'py>,
        wait: Option<u64>,
    ) -> PyResult<Bound<'py, PyAny>> {
        let mut gateway = self.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            gateway
                .safe_start(wait)
                .await
                .map_err(|e| to_pyruntime_err(format!("{e}")))
        })
    }

    #[pyo3(name = "safe_start_blocking")]
    fn py_safe_start_blocking(&self, wait: Option<u64>) -> PyResult<()> {
        let mut gateway = self.clone();
        get_runtime()
            .block_on(async move { gateway.safe_start(wait).await })
            .map_err(|e| to_pyruntime_err(format!("{e}")))
    }

    /// Stop the gateway.
    #[pyo3(name = "stop")]
    fn py_stop<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>> {
        let gateway = self.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            gateway
                .stop()
                .await
                .map_err(|e| to_pyruntime_err(format!("{e}")))
        })
    }

    #[pyo3(name = "stop_blocking")]
    fn py_stop_blocking(&self) -> PyResult<()> {
        let gateway = self.clone();
        get_runtime()
            .block_on(async move { gateway.stop().await })
            .map_err(|e| to_pyruntime_err(format!("{e}")))
    }

    /// Get container status.
    #[pyo3(name = "container_status")]
    fn py_container_status<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>> {
        let gateway = self.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            gateway
                .container_status()
                .await
                .map_err(|e| to_pyruntime_err(format!("{e}")))
        })
    }
}