nautilus_binance/spot/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//! Binance Spot WebSocket client with SBE encoding support.
17//!
18//! This module provides WebSocket connectivity to Binance's SBE market data streams
19//! at `stream-sbe.binance.com`. These streams provide lower latency and smaller
20//! payloads compared to JSON streams.
21//!
22//! ## Available Streams
23//!
24//! - `<symbol>@trade` - Real-time trade data
25//! - `<symbol>@bestBidAsk` - Best bid/offer updates
26//! - `<symbol>@depth` - Order book diff updates
27//! - `<symbol>@depth20` - Top 20 order book levels
28//!
29//! ## Authentication
30//!
31//! SBE market data streams require Ed25519 API key authentication via the
32//! `X-MBX-APIKEY` header.
33
34pub mod client;
35pub mod handler;
36pub mod messages;
37pub mod streams;
38
39pub use client::BinanceSpotWebSocketClient;