Struct Bybit 

pub struct Bybit { /* private fields */ }

A Bybit client over an injected HTTP transport.

Implementations

impl Bybit

pub fn sync_time(&mut self) -> Result<i64, Error>

Learn the offset between this machine’s clock and the venue’s, from GET /v5/market/time.

Explicit rather than automatic: it costs a request, and a client should not make one the caller did not ask for. Call it once after connecting, and again if the process runs long enough for drift to matter.

Returns the new offset in milliseconds (server - local).

Errors

Returns an Error if the request fails or the response cannot be parsed.

pub fn with_ws(self, ws: Box<dyn WsTransport>) -> Bybit

Attach a WebSocket transport, enabling the streaming subscriptions.

pub fn with_http( http: Box<dyn HttpTransport>, options: &ExchangeOptions, ) -> Bybit

Build a public Bybit client over the given transport and options.

pub fn with_credentials( http: Box<dyn HttpTransport>, options: &ExchangeOptions, credentials: Credentials, ) -> Bybit

Build an authenticated Bybit client for signed endpoints.

pub fn with_clock(self, now_ms: Box<dyn Fn() -> i64 + Send + Sync>) -> Bybit

Override the timestamp source (used for deterministic signing in tests).

pub fn category(&self) -> &'static str

The Bybit product category this client targets (spot/linear/inverse).

pub fn wire_symbol(symbol: &Symbol) -> String

The Bybit wire symbol for a canonical Symbol (BTC/USDT -> BTCUSDT).

pub fn ticker(&self, symbol: &Symbol) -> Result<Ticker, Error>

A ticker for symbol.

Errors

Returns an Error if the request fails or the symbol is unknown.

pub fn klines( &self, symbol: &Symbol, interval: &str, limit: u32, ) -> Result<Vec<Candle>, Error>

Up to limit candles for symbol at interval (unified, e.g. "1m", "1h", "1d"). Bybit returns newest-first; the result is chronological.

Errors

Returns an Error if the request fails or a row cannot be parsed.

pub fn order_book( &self, symbol: &Symbol, depth: u32, ) -> Result<OrderBookSnapshot, Error>

A depth snapshot of symbol up to depth levels per side.

Errors

Returns an Error if the request fails or the response cannot be parsed.

pub fn subscribe_trades(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the public trade stream for symbol.

Errors

Returns Error::NotConnected if no WebSocket transport is configured, or a transport error if the connection or subscription fails.

pub fn subscribe_book(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the order-book stream for symbol.

Errors

See subscribe_trades.

pub fn subscribe_ticker(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the ticker stream for symbol.

Errors

See subscribe_trades.

pub fn subscribe_derivatives( &mut self, symbol: &Symbol, channel: DerivativesChannel, ) -> Result<(), Error>

Subscribe to a pushed derivatives channel.

Bybit publishes funding, mark and index on the same tickers stream that carries the ordinary ticker – one topic answering four questions – so both channels resolve to it and the parser emits whichever the caller subscribed to. Liquidations are allLiquidation, which reports the taker side of the forced order rather than the side of the position that was closed; that is the side this crate’s Liquidation carries, so it maps straight through.

These streams exist only on the linear (futures) venue.

Errors

Returns an Error on a spot client, or if the subscription fails.

pub fn open_interest(&self, symbol: &Symbol) -> Result<OpenInterest, Error>

The current open interest (GET /v5/market/open-interest), most recent point.

Bybit does push open interest, on the tickers stream – but only as one field among many, and only when it changes. Reading it is what gives a caller a figure at a known moment rather than whenever the venue last happened to include it.

Errors

Returns an Error on a spot client, if the request fails, or if the venue returns no data point.

pub fn long_short_ratio(&self, symbol: &Symbol) -> Result<LongShortRatio, Error>

The current long/short account ratio (GET /v5/market/account-ratio), most recent point.

Reported as account proportions summing to one, carried through as given.

Errors

Returns an Error on a spot client, if the request fails, or if the venue returns no data point.

pub fn poll_events(&mut self) -> Vec<Event>

Drain all stream events available since the last call. Non-blocking; frames that fail to parse are skipped.

pub fn subscribe_user_data(&mut self) -> Result<(), Error>

Open the private user-data stream (wss://.../v5/private). Authenticates with an op:auth frame (signature = HMAC-SHA256 over GET/realtime<expires>), then subscribes to the order and wallet topics. Afterwards poll_events also surfaces the account’s own Event::OrderUpdate and Event::BalanceUpdate.

A dropped private stream is re-subscribed automatically on the next poll_events; call keepalive_user_data periodically to keep it from being dropped for inactivity.

Errors

Returns Error::InvalidCredentials without credentials, Error::NotConnected without a WebSocket transport, or another Error if the request fails.

pub fn keepalive_user_data(&mut self) -> Result<(), Error>

Send an application-level heartbeat (op:ping) on the private stream so it is not dropped for inactivity. A no-op before subscribe_user_data.

Errors

Returns an Error if the ping cannot be sent.

pub fn place_order(&self, request: &OrderRequest) -> Result<Order, Error>

Place an order. Validated locally, then sent signed. Bybit’s create endpoint returns only the ids, so the resulting Order carries the request’s own fields with the venue order id and a New status.

Errors

Returns an Error if the order is invalid, credentials are missing, or the venue rejects it.

pub fn cancel_order(&self, symbol: &Symbol, order_id: &str) -> Result<(), Error>

Cancel an open order by venue id.

Errors

Returns an Error if credentials are missing or the venue rejects it.

pub fn place_order_ws(&mut self, request: &OrderRequest) -> Result<Order, Error>

Place an order over the Bybit WebSocket trade API (order.create). Builds the same args as the REST path and exchanges them on the lazily-opened, authenticated /v5/trade connection. Bybit returns only the ids, so the resulting Order carries the request’s fields with a New status.

Errors

Returns Error::NotConnected without a WebSocket transport, or another Error if the order is invalid or rejected.

pub fn cancel_order_ws( &mut self, symbol: &Symbol, order_id: &str, ) -> Result<(), Error>

Cancel an order over the Bybit WebSocket trade API (order.cancel).

Errors

Returns Error::NotConnected without a WebSocket transport, or another Error if the order is unknown or the request fails.

pub fn query_order( &self, symbol: &Symbol, order_id: &str, ) -> Result<Order, Error>

Query a single order by venue id.

Errors

Returns an Error if credentials are missing or the order is unknown.

pub fn open_orders(&self, symbol: Option<&Symbol>) -> Result<Vec<Order>, Error>

All open orders, optionally filtered to one symbol. When unfiltered, the venue’s wire symbol is mapped back to a canonical Symbol.

Errors

Returns an Error if credentials are missing or the request fails.

pub fn balances(&self) -> Result<Vec<Balance>, Error>

Unified-account balances (assets are reported as the venue lists them).

Errors

Returns an Error if credentials are missing or the request fails.

impl Bybit

This impl block contains no public items.

The Bybit product category for a market type.

impl Bybit

pub fn positions(&self, symbol: Option<&Symbol>) -> Result<Vec<Position>, Error>

Open positions (/v5/position/list). Without a symbol filter, linear positions are queried by settle coin (USDT).

Errors

Returns an Error if credentials are missing or the request fails.

pub fn set_leverage(&self, symbol: &Symbol, leverage: u32) -> Result<(), Error>

Set the leverage for symbol (/v5/position/set-leverage).

Errors

Returns an Error if the leverage is rejected or the request fails.

pub fn set_margin_mode( &self, symbol: &Symbol, mode: MarginMode, ) -> Result<(), Error>

Set the margin mode for symbol (/v5/position/switch-isolated). Bybit couples the mode with the leverage, so the current leverage is preserved.

Errors

Returns an Error if the change is rejected or the request fails.

pub fn close_position(&self, symbol: &Symbol) -> Result<Order, Error>

Flatten the open position in symbol with a reduce-only market order.

Errors

Returns Error::NotFound if there is no open position, or another Error if the request fails.

pub fn amend_order( &self, symbol: &Symbol, order_id: &str, new_price: Option<Decimal>, new_quantity: Option<Decimal>, ) -> Result<Order, Error>

Amend a resting order’s price and/or quantity in place (/v5/order/amend), then return the refreshed order.

Errors

Returns an Error if the order is unknown or the amend is rejected.

pub fn place_batch( &self, requests: &[OrderRequest], ) -> Result<Vec<Result<Order, Error>>, Error>

Place several orders in one request (/v5/order/create-batch). Each element’s outcome is preserved: an empty returned orderId marks a rejected leg.

Errors

Returns an Error if the batch request itself fails.

pub fn cancel_batch( &self, symbol: &Symbol, order_ids: &[String], ) -> Result<(), Error>

Cancel several orders on one symbol in a single request (/v5/order/cancel-batch).

Errors

Returns an Error if the request fails.

Trait Implementations

impl AdvancedOrders for Bybit

fn place_oco(&mut self, _request: &OcoRequest) -> Result<Vec<Order>, Error>

Bybit has no standalone one-cancels-other order-list (take-profit/stop are attached to a position/order via takeProfit/stopLoss), so this returns an Error::Exchange.

fn amend_order( &mut self, symbol: &Symbol, order_id: &str, new_price: Option<Decimal>, new_quantity: Option<Decimal>, ) -> Result<Order, Error>

Amend a resting order’s price and/or quantity in place, returning the order as the venue reports it afterwards. None leaves that field unchanged. Venues without a native amend emulate it as cancel-replace.

fn place_batch( &mut self, requests: &[OrderRequest], ) -> Result<Vec<Result<Order, Error>>, Error>

Place several orders in one request. The outer Result covers a transport/auth failure; each inner Result is that order’s own outcome, so a partially-accepted batch still returns the successes.

fn cancel_batch( &mut self, symbol: &Symbol, order_ids: &[String], ) -> Result<(), Error>

Cancel several orders on one symbol in a single request.

impl Debug for Bybit

Hand-written: the client holds Box<dyn HttpTransport>, Box<dyn WsTransport> and a Box<dyn Fn() -> i64> clock, none of which a derive can reach. The transports are shown by whether a connection is open rather than by value, and the credentials only by whether they are set – printing them would put secret material into every log line that formats a client.

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

Formats the value using the given formatter.

impl Derivatives for Bybit

fn positions(&mut self, symbol: Option<&Symbol>) -> Result<Vec<Position>, Error>

Open positions, optionally filtered to one symbol; flat positions are omitted.

fn set_leverage(&mut self, symbol: &Symbol, leverage: u32) -> Result<(), Error>

Set the account leverage for symbol.

fn set_margin_mode( &mut self, symbol: &Symbol, mode: MarginMode, ) -> Result<(), Error>

Set the margin mode (cross / isolated) for symbol.

fn close_position(&mut self, symbol: &Symbol) -> Result<Order, Error>

Flatten the open position in symbol with a reduce-only market order.

impl DerivativesStream for Bybit

fn subscribe_derivatives( &mut self, symbol: &Symbol, channel: DerivativesChannel, ) -> Result<(), Error>

Subscribe to a pushed derivatives channel. Frames arrive through poll_events as Event::Derivatives.

fn open_interest(&mut self, symbol: &Symbol) -> Result<OpenInterest, Error>

Read the current open interest. Polled, not pushed.

fn long_short_ratio(&mut self, symbol: &Symbol) -> Result<LongShortRatio, Error>

Read the current long/short positioning ratio. Polled, not pushed.

impl Exchange for Bybit

fn name(&self) -> &'static str

The venue’s lowercase identifier (e.g. "binance").

impl Execution for Bybit

fn place_order(&mut self, request: &OrderRequest) -> Result<Order, Error>

Place an order and return it as accepted by the venue.

fn cancel_order(&mut self, symbol: &Symbol, order_id: &str) -> Result<(), Error>

Cancel an open order by venue id.

fn query_order( &mut self, symbol: &Symbol, order_id: &str, ) -> Result<Order, Error>

Query a single order by venue id.

fn open_orders(&mut self, symbol: Option<&Symbol>) -> Result<Vec<Order>, Error>

All open orders, optionally filtered to one symbol.

fn balances(&mut self) -> Result<Vec<Balance>, Error>

Current account balances.

impl MarketData for Bybit

fn ticker(&mut self, symbol: &Symbol) -> Result<Ticker, Error>

A point-in-time ticker for symbol.

fn klines( &mut self, symbol: &Symbol, interval: &str, limit: u32, ) -> Result<Vec<Candle>, Error>

Up to limit historical candles for symbol at the given interval (e.g. "1m", "1h"). Returns wickra_core::Candles so the result feeds the indicator core directly.

fn order_book( &mut self, symbol: &Symbol, depth: u32, ) -> Result<OrderBookSnapshot, Error>

A depth snapshot of symbol up to depth levels per side.

fn subscribe_trades(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the public trade stream for symbol.

fn subscribe_book(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the order-book stream for symbol.

fn subscribe_ticker(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the ticker stream for symbol.

fn poll_events(&mut self) -> Vec<Event>

Drain all events buffered since the last call. Non-blocking: returns an empty vector when nothing is pending.

impl WsExecution for Bybit

fn place_order_ws(&mut self, request: &OrderRequest) -> Result<Order, Error>

Place an order over the WebSocket API and return it as the venue reports it.

fn cancel_order_ws( &mut self, symbol: &Symbol, order_id: &str, ) -> Result<(), Error>

Cancel an order over the WebSocket API by venue id.

impl WsUserData for Bybit

fn subscribe_user_data(&mut self) -> Result<(), Error>

Open the private user-data stream. After it returns, poll_events on the same client also drains the user’s order and balance events alongside the public market-data stream.

fn keepalive_user_data(&mut self) -> Result<(), Error>

Keep the private user-data stream alive: refresh the venue’s session so it is not dropped for inactivity. The consumer calls this periodically (e.g. on a timer). Venues that need a REST keepalive refresh their listen key; venues that need an application-level heartbeat send a ping frame. The default is a no-op for venues that need neither.