Struct BybitWebSocketClient 

pub struct BybitWebSocketClient { /* private fields */ }

Public/market data WebSocket client for Bybit.

Implementations

impl BybitWebSocketClient

pub fn new_public(url: Option<String>, heartbeat: Option<u64>) -> Self

Creates a new Bybit public WebSocket client.

pub fn new_public_with( product_type: BybitProductType, environment: BybitEnvironment, url: Option<String>, heartbeat: Option<u64>, ) -> Self

Creates a new Bybit public WebSocket client targeting the specified product/environment.

Panics

Panics if the retry manager cannot be created.

pub fn new_private( environment: BybitEnvironment, credential: Credential, url: Option<String>, heartbeat: Option<u64>, ) -> Self

Creates a new Bybit private WebSocket client.

Panics

Panics if the retry manager cannot be created.

pub fn new_trade( environment: BybitEnvironment, credential: Credential, url: Option<String>, heartbeat: Option<u64>, ) -> Self

Creates a new Bybit trade WebSocket client for order operations.

Panics

Panics if the retry manager cannot be created.

pub async fn connect(&mut self) -> BybitWsResult<()>

Establishes the WebSocket connection.

Errors

Returns an error if the underlying WebSocket connection cannot be established.

Panics

Panics if the ping message cannot be serialized to JSON.

pub async fn close(&mut self) -> BybitWsResult<()>

Disconnects the WebSocket client and stops the background task.

pub async fn is_active(&self) -> bool

Returns true when the underlying client is active.

pub async fn wait_until_active(&self, timeout_secs: f64) -> BybitWsResult<()>

Waits until the WebSocket client becomes active or times out.

Errors

Returns an error if the timeout is exceeded before the client becomes active.

pub async fn subscribe(&self, topics: Vec<String>) -> BybitWsResult<()>

Subscribe to the provided topic strings.

pub async fn unsubscribe(&self, topics: Vec<String>) -> BybitWsResult<()>

Unsubscribe from the provided topics.

pub fn stream( &mut self, ) -> impl Stream<Item = BybitWebSocketMessage> + Send + 'static

Returns a stream of parsed BybitWebSocketMessage items.

Panics

Panics if called before Self::connect or if the stream has already been taken.

pub fn subscription_count(&self) -> usize

Returns the number of currently registered subscriptions.

pub fn add_instrument(&self, instrument: InstrumentAny)

Adds an instrument to the cache for parsing WebSocket messages.

pub fn instruments(&self) -> &Arc<DashMap<InstrumentId, InstrumentAny>>

Returns a reference to the instruments cache.

pub fn set_account_id(&mut self, account_id: AccountId)

Sets the account ID for account message parsing.

pub fn account_id(&self) -> Option<AccountId>

Returns the account ID if set.

pub fn product_type(&self) -> Option<BybitProductType>

Returns the product type for public connections.

pub fn quote_cache(&self) -> &Arc<RwLock<QuoteCache>>

Returns a reference to the quote cache.

pub async fn subscribe_orderbook( &self, instrument_id: InstrumentId, depth: u32, ) -> BybitWsResult<()>

Subscribes to orderbook updates for a specific instrument.

Errors

Returns an error if the subscription request fails.

References

https://bybit-exchange.github.io/docs/v5/websocket/public/orderbook

pub async fn unsubscribe_orderbook( &self, instrument_id: InstrumentId, depth: u32, ) -> BybitWsResult<()>

Unsubscribes from orderbook updates for a specific instrument.

pub async fn subscribe_trades( &self, instrument_id: InstrumentId, ) -> BybitWsResult<()>

Subscribes to public trade updates for a specific instrument.

Errors

Returns an error if the subscription request fails.

References

https://bybit-exchange.github.io/docs/v5/websocket/public/trade

pub async fn unsubscribe_trades( &self, instrument_id: InstrumentId, ) -> BybitWsResult<()>

Unsubscribes from public trade updates for a specific instrument.

pub async fn subscribe_ticker( &self, instrument_id: InstrumentId, ) -> BybitWsResult<()>

Subscribes to ticker updates for a specific instrument.

Errors

Returns an error if the subscription request fails.

References

https://bybit-exchange.github.io/docs/v5/websocket/public/ticker

pub async fn unsubscribe_ticker( &self, instrument_id: InstrumentId, ) -> BybitWsResult<()>

Unsubscribes from ticker updates for a specific instrument.

pub async fn subscribe_klines( &self, instrument_id: InstrumentId, interval: impl Into<String>, ) -> BybitWsResult<()>

Subscribes to kline/candlestick updates for a specific instrument.

Errors

Returns an error if the subscription request fails.

References

https://bybit-exchange.github.io/docs/v5/websocket/public/kline

pub async fn unsubscribe_klines( &self, instrument_id: InstrumentId, interval: impl Into<String>, ) -> BybitWsResult<()>

Unsubscribes from kline/candlestick updates for a specific instrument.

pub async fn subscribe_orders(&self) -> BybitWsResult<()>

Subscribes to order updates.

Errors

Returns an error if the subscription request fails or if not authenticated.

References

https://bybit-exchange.github.io/docs/v5/websocket/private/order

pub async fn unsubscribe_orders(&self) -> BybitWsResult<()>

Unsubscribes from order updates.

pub async fn subscribe_executions(&self) -> BybitWsResult<()>

Subscribes to execution/fill updates.

Errors

Returns an error if the subscription request fails or if not authenticated.

References

https://bybit-exchange.github.io/docs/v5/websocket/private/execution

pub async fn unsubscribe_executions(&self) -> BybitWsResult<()>

Unsubscribes from execution/fill updates.

pub async fn subscribe_positions(&self) -> BybitWsResult<()>

Subscribes to position updates.

Errors

Returns an error if the subscription request fails or if not authenticated.

References

https://bybit-exchange.github.io/docs/v5/websocket/private/position

pub async fn unsubscribe_positions(&self) -> BybitWsResult<()>

Unsubscribes from position updates.

pub async fn subscribe_wallet(&self) -> BybitWsResult<()>

Subscribes to wallet/balance updates.

Errors

Returns an error if the subscription request fails or if not authenticated.

References

https://bybit-exchange.github.io/docs/v5/websocket/private/wallet

pub async fn unsubscribe_wallet(&self) -> BybitWsResult<()>

Unsubscribes from wallet/balance updates.

pub async fn place_order( &self, params: BybitWsPlaceOrderParams, ) -> BybitWsResult<()>

Places an order via WebSocket.

Errors

Returns an error if the order request fails or if not authenticated.

References

https://bybit-exchange.github.io/docs/v5/websocket/trade/guideline

pub async fn amend_order( &self, params: BybitWsAmendOrderParams, ) -> BybitWsResult<()>

Amends an existing order via WebSocket.

Errors

Returns an error if the amend request fails or if not authenticated.

References

https://bybit-exchange.github.io/docs/v5/websocket/trade/guideline

pub async fn cancel_order( &self, params: BybitWsCancelOrderParams, ) -> BybitWsResult<()>

Cancels an order via WebSocket.

Errors

Returns an error if the cancel request fails or if not authenticated.

References

https://bybit-exchange.github.io/docs/v5/websocket/trade/guideline

pub async fn batch_place_orders( &self, orders: Vec<BybitWsPlaceOrderParams>, ) -> BybitWsResult<()>

Batch creates multiple orders via WebSocket.

Errors

Returns an error if the batch request fails or if not authenticated.

References

https://bybit-exchange.github.io/docs/v5/websocket/trade/guideline

pub async fn batch_amend_orders( &self, orders: Vec<BybitWsAmendOrderParams>, ) -> BybitWsResult<()>

Batch amends multiple orders via WebSocket.

Errors

Returns an error if the batch request fails or if not authenticated.

pub async fn batch_cancel_orders( &self, orders: Vec<BybitWsCancelOrderParams>, ) -> BybitWsResult<()>

Batch cancels multiple orders via WebSocket.

Errors

Returns an error if the batch request fails or if not authenticated.

pub async fn submit_order( &self, product_type: BybitProductType, instrument_id: InstrumentId, client_order_id: ClientOrderId, order_side: OrderSide, order_type: OrderType, quantity: Quantity, time_in_force: Option<TimeInForce>, price: Option<Price>, trigger_price: Option<Price>, post_only: Option<bool>, reduce_only: Option<bool>, ) -> BybitWsResult<()>

Submits an order using Nautilus domain objects.

Errors

Returns an error if order submission fails or if not authenticated.

pub async fn modify_order( &self, product_type: BybitProductType, instrument_id: InstrumentId, venue_order_id: Option<VenueOrderId>, client_order_id: Option<ClientOrderId>, quantity: Option<Quantity>, price: Option<Price>, ) -> BybitWsResult<()>

Modifies an existing order using Nautilus domain objects.

Errors

Returns an error if modification fails or if not authenticated.

pub async fn cancel_order_by_id( &self, product_type: BybitProductType, instrument_id: InstrumentId, venue_order_id: Option<VenueOrderId>, client_order_id: Option<ClientOrderId>, ) -> BybitWsResult<()>

Cancels an order using Nautilus domain objects.

Errors

Returns an error if cancellation fails or if not authenticated.

Trait Implementations

impl Clone for BybitWebSocketClient

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BybitWebSocketClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for BybitWebSocketClient

type Target = BybitWebSocketClient

The Python output type

type Output = Bound<'py, <BybitWebSocketClient as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for BybitWebSocketClient

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BybitWebSocketClient

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Public/market data WebSocket client for Bybit.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<BybitWebSocketClient>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder BybitWebSocketClient

type Holder = Option<PyClassGuard<'a, BybitWebSocketClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut BybitWebSocketClient

type Holder = Option<PyClassGuardMut<'a, BybitWebSocketClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<BybitWebSocketClient> for PyClassImplCollector<BybitWebSocketClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for BybitWebSocketClient

const NAME: &'static str = "BybitWebSocketClient"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for BybitWebSocketClient