nautilus_okx/python/
mod.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2025 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 from `pyo3`.
17
18pub mod enums;
19pub mod http;
20pub mod urls;
21pub mod websocket;
22
23use pyo3::prelude::*;
24
25/// Loaded as `nautilus_pyo3.okx`.
26///
27/// # Errors
28///
29/// Returns an error if any bindings fail to register with the Python module.
30#[pymodule]
31pub fn okx(_: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()> {
32    m.add_class::<super::websocket::OKXWebSocketClient>()?;
33    m.add_class::<super::websocket::messages::OKXWebSocketError>()?;
34    m.add_class::<super::http::OKXHttpClient>()?;
35    m.add_class::<crate::common::enums::OKXInstrumentType>()?;
36    m.add_class::<crate::common::enums::OKXContractType>()?;
37    m.add_class::<crate::common::enums::OKXMarginMode>()?;
38    m.add_class::<crate::common::enums::OKXTradeMode>()?;
39    m.add_class::<crate::common::enums::OKXOrderStatus>()?;
40    m.add_class::<crate::common::enums::OKXPositionMode>()?;
41    m.add_class::<crate::common::enums::OKXVipLevel>()?;
42    m.add_class::<crate::common::urls::OKXEndpointType>()?;
43    m.add_function(wrap_pyfunction!(urls::get_okx_http_base_url, m)?)?;
44    m.add_function(wrap_pyfunction!(urls::get_okx_ws_url_public, m)?)?;
45    m.add_function(wrap_pyfunction!(urls::get_okx_ws_url_private, m)?)?;
46    m.add_function(wrap_pyfunction!(urls::get_okx_ws_url_business, m)?)?;
47    m.add_function(wrap_pyfunction!(urls::okx_requires_authentication, m)?)?;
48    Ok(())
49}