nautilus-okx 0.61.0

OKX exchange 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

// -------------------------------------------------------------------------------------------------
//  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 wrapper functions for OKX URL helpers.

use pyo3::prelude::*;

use crate::common::{
    enums::{OKXEnvironment, OKXRegion},
    urls,
};

/// Returns the OKX HTTP base URL for the given region.
#[pyfunction]
#[pyo3(signature = (region = None))]
#[pyo3_stub_gen::derive::gen_stub_pyfunction(module = "nautilus_trader.adapters.okx")]
pub fn get_okx_http_base_url(region: Option<OKXRegion>) -> String {
    urls::get_http_base_url(region.unwrap_or_default()).to_string()
}

/// Returns the OKX WebSocket URL for public data (market data).
#[pyfunction]
#[pyo3(signature = (environment, region = None))]
#[pyo3_stub_gen::derive::gen_stub_pyfunction(module = "nautilus_trader.adapters.okx")]
pub fn get_okx_ws_url_public(environment: OKXEnvironment, region: Option<OKXRegion>) -> String {
    urls::get_ws_base_url_public(region.unwrap_or_default(), environment).to_string()
}

/// Returns the OKX WebSocket URL for private data (account/order management).
#[pyfunction]
#[pyo3(signature = (environment, region = None))]
#[pyo3_stub_gen::derive::gen_stub_pyfunction(module = "nautilus_trader.adapters.okx")]
pub fn get_okx_ws_url_private(environment: OKXEnvironment, region: Option<OKXRegion>) -> String {
    urls::get_ws_base_url_private(region.unwrap_or_default(), environment).to_string()
}

/// Returns the OKX WebSocket URL for business data (bars/candlesticks).
#[pyfunction]
#[pyo3(signature = (environment, region = None))]
#[pyo3_stub_gen::derive::gen_stub_pyfunction(module = "nautilus_trader.adapters.okx")]
pub fn get_okx_ws_url_business(environment: OKXEnvironment, region: Option<OKXRegion>) -> String {
    urls::get_ws_base_url_business(region.unwrap_or_default(), environment).to_string()
}

/// Derives a WebSocket URL for a given channel from a base URL.
#[pyfunction]
#[pyo3_stub_gen::derive::gen_stub_pyfunction(module = "nautilus_trader.adapters.okx")]
pub fn derive_okx_ws_url(base_url: &str, channel: &str) -> String {
    urls::derive_ws_url(base_url, channel)
}

/// Checks if OKX endpoint requires authentication.
#[pyfunction]
#[pyo3_stub_gen::derive::gen_stub_pyfunction(module = "nautilus_trader.adapters.okx")]
pub fn okx_requires_authentication(endpoint_type: urls::OKXEndpointType) -> bool {
    urls::requires_authentication(endpoint_type)
}