nautilus_okx/python/
urls.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 wrapper functions for OKX URL helpers.
17
18use pyo3::prelude::*;
19
20use crate::common::urls;
21
22/// Gets the OKX HTTP base URL.
23#[pyfunction]
24pub fn get_okx_http_base_url() -> String {
25    urls::get_http_base_url()
26}
27
28/// Gets the OKX WebSocket URL for public data (market data).
29#[pyfunction]
30pub fn get_okx_ws_url_public(is_demo: bool) -> String {
31    urls::get_ws_base_url_public(is_demo)
32}
33
34/// Gets the OKX WebSocket URL for private data (account/order management).
35#[pyfunction]
36pub fn get_okx_ws_url_private(is_demo: bool) -> String {
37    urls::get_ws_base_url_private(is_demo)
38}
39
40/// Gets the OKX WebSocket URL for business data (bars/candlesticks).
41#[pyfunction]
42pub fn get_okx_ws_url_business(is_demo: bool) -> String {
43    urls::get_ws_base_url_business(is_demo)
44}
45
46/// Checks if OKX endpoint requires authentication.
47#[pyfunction]
48pub fn okx_requires_authentication(endpoint_type: urls::OKXEndpointType) -> bool {
49    urls::requires_authentication(endpoint_type)
50}
nautilus_okx/python/urls.rs

nautilus_okx/python/
urls.rs
