nautilus-bybit 0.53.0

// -------------------------------------------------------------------------------------------------
//  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 from `pyo3`.

pub mod enums;
pub mod http;
pub mod params;
pub mod types;
pub mod urls;
pub mod websocket;

use nautilus_core::python::to_pyvalue_err;
use nautilus_model::enums::BarAggregation;
use pyo3::prelude::*;

use crate::common::{
    consts::BYBIT_NAUTILUS_BROKER_ID,
    parse::{bar_spec_to_bybit_interval, extract_raw_symbol},
    symbol::BybitSymbol,
};

/// Extracts the raw symbol from a Bybit symbol by removing the product type suffix.
///
/// # Examples
/// - `"ETHUSDT-LINEAR"` → `"ETHUSDT"`
/// - `"BTCUSDT-SPOT"` → `"BTCUSDT"`
/// - `"ETHUSDT"` → `"ETHUSDT"` (no suffix)
#[pyfunction]
#[pyo3(name = "bybit_extract_raw_symbol")]
fn py_bybit_extract_raw_symbol(symbol: &str) -> &str {
    extract_raw_symbol(symbol)
}

/// Converts a Nautilus bar aggregation and step to a Bybit kline interval string.
///
/// # Errors
///
/// Returns an error if the aggregation type or step is not supported by Bybit.
#[pyfunction]
#[pyo3(name = "bybit_bar_spec_to_interval")]
fn py_bybit_bar_spec_to_interval(aggregation: u8, step: u64) -> PyResult<String> {
    let aggregation = BarAggregation::from_repr(aggregation as usize)
        .ok_or_else(|| to_pyvalue_err(format!("Invalid BarAggregation value: {aggregation}")))?;
    let interval = bar_spec_to_bybit_interval(aggregation, step).map_err(to_pyvalue_err)?;
    Ok(interval.to_string())
}

/// Extracts the product type from a Bybit symbol.
///
/// # Examples
/// - `"ETHUSDT-LINEAR"` → `BybitProductType.LINEAR`
/// - `"BTCUSDT-SPOT"` → `BybitProductType.SPOT`
/// - `"BTCUSD-INVERSE"` → `BybitProductType.INVERSE`
/// - `"ETH-26JUN26-16000-P-OPTION"` → `BybitProductType.OPTION`
///
/// # Errors
///
/// Returns an error if the symbol does not contain a valid Bybit product type suffix.
#[pyfunction]
#[pyo3(name = "bybit_product_type_from_symbol")]
fn py_bybit_product_type_from_symbol(
    symbol: &str,
) -> PyResult<crate::common::enums::BybitProductType> {
    let bybit_symbol = BybitSymbol::new(symbol).map_err(to_pyvalue_err)?;
    Ok(bybit_symbol.product_type())
}

/// Loaded as `nautilus_pyo3.bybit`.
///
/// # Errors
///
/// Returns an error if any bindings fail to register with the Python module.
#[pymodule]
#[rustfmt::skip]
pub fn bybit(_: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()> {
    m.add(stringify!(BYBIT_NAUTILUS_BROKER_ID), BYBIT_NAUTILUS_BROKER_ID)?;
    m.add_class::<crate::common::enums::BybitAccountType>()?;
    m.add_class::<crate::common::enums::BybitCancelType>()?;
    m.add_class::<crate::common::enums::BybitEnvironment>()?;
    m.add_class::<crate::common::enums::BybitMarginAction>()?;
    m.add_class::<crate::common::enums::BybitMarginMode>()?;
    m.add_class::<crate::common::enums::BybitOpenOnly>()?;
    m.add_class::<crate::common::enums::BybitOrderFilter>()?;
    m.add_class::<crate::common::enums::BybitOrderSide>()?;
    m.add_class::<crate::common::enums::BybitOrderStatus>()?;
    m.add_class::<crate::common::enums::BybitOrderType>()?;
    m.add_class::<crate::common::enums::BybitPositionMode>()?;
    m.add_class::<crate::common::enums::BybitProductType>()?;
    m.add_class::<crate::common::enums::BybitStopOrderType>()?;
    m.add_class::<crate::common::enums::BybitTimeInForce>()?;
    m.add_class::<crate::common::enums::BybitTpSlMode>()?;
    m.add_class::<crate::common::enums::BybitTriggerDirection>()?;
    m.add_class::<crate::common::enums::BybitTriggerType>()?;
    m.add_class::<crate::http::client::BybitHttpClient>()?;
    m.add_class::<crate::http::client::BybitRawHttpClient>()?;
    m.add_class::<crate::http::models::BybitServerTime>()?;
    m.add_class::<crate::http::models::BybitOrder>()?;
    m.add_class::<crate::http::models::BybitOrderCursorList>()?;
    m.add_class::<crate::http::models::BybitTickerData>()?;
    m.add_class::<crate::common::types::BybitMarginBorrowResult>()?;
    m.add_class::<crate::common::types::BybitMarginRepayResult>()?;
    m.add_class::<crate::common::types::BybitMarginStatusResult>()?;
    m.add_class::<crate::websocket::client::BybitWebSocketClient>()?;
    m.add_class::<crate::websocket::messages::BybitWebSocketError>()?;
    m.add_class::<params::BybitWsPlaceOrderParams>()?;
    m.add_class::<params::BybitWsAmendOrderParams>()?;
    m.add_class::<params::BybitWsCancelOrderParams>()?;
    m.add_class::<params::BybitTickersParams>()?;
    m.add_function(wrap_pyfunction!(urls::py_get_bybit_http_base_url, m)?)?;
    m.add_function(wrap_pyfunction!(urls::py_get_bybit_ws_url_public, m)?)?;
    m.add_function(wrap_pyfunction!(urls::py_get_bybit_ws_url_private, m)?)?;
    m.add_function(wrap_pyfunction!(urls::py_get_bybit_ws_url_trade, m)?)?;
    m.add_function(wrap_pyfunction!(py_bybit_extract_raw_symbol, m)?)?;
    m.add_function(wrap_pyfunction!(py_bybit_bar_spec_to_interval, m)?)?;
    m.add_function(wrap_pyfunction!(py_bybit_product_type_from_symbol, m)?)?;
    Ok(())
}