nautilus_okx/websocket/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//! WebSocket client implementation for the OKX v5 API.
17//!
18//! This module provides real-time streaming connectivity to OKX WebSocket endpoints,
19//! supporting:
20//!
21//! - Market data streaming (order books, trades, tickers, bars).
22//! - Private data streaming (account updates, positions, orders).
23//! - Order management (place, cancel, amend) via WebSocket.
24//! - Authentication and automatic reconnection.
25//! - Channel subscription management.
26
27pub mod client;
28pub mod enums;
29pub mod error;
30pub mod messages;
31pub mod parse;
32
33// Re-exports
34pub use crate::websocket::client::OKXWebSocketClient;