nautilus_common/python/
xrate.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2025 Posei Systems Pty Ltd. All rights reserved.
3//  https://poseitrader.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
16use std::collections::HashMap;
17
18use nautilus_core::python::to_pyvalue_err;
19use nautilus_model::enums::PriceType;
20use pyo3::prelude::*;
21use ustr::Ustr;
22
23use crate::xrate::get_exchange_rate;
24
25/// Calculates the exchange rate between two currencies using provided bid and ask quotes.
26///
27/// # Errors
28///
29/// Returns an error if:
30/// - `price_type` is equal to `Last` or `Mark` (cannot calculate from quotes).
31/// - `quotes_bid` or `quotes_ask` is empty.
32/// - `quotes_bid` and `quotes_ask` lengths are not equal.
33/// - The bid or ask side of a pair is missing.
34#[pyfunction]
35#[pyo3(name = "get_exchange_rate")]
36#[pyo3(signature = (from_currency, to_currency, price_type, quotes_bid, quotes_ask))]
37pub fn py_get_exchange_rate(
38    from_currency: &str,
39    to_currency: &str,
40    price_type: PriceType,
41    quotes_bid: HashMap<String, f64>,
42    quotes_ask: HashMap<String, f64>,
43) -> PyResult<Option<f64>> {
44    get_exchange_rate(
45        Ustr::from(from_currency),
46        Ustr::from(to_currency),
47        price_type,
48        quotes_bid,
49        quotes_ask,
50    )
51    .map_err(to_pyvalue_err)
52}