Struct Bitget 

pub struct Bitget { /* private fields */ }

A Bitget client over injected transports.

Implementations

impl Bitget

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

Learn the offset between this machine’s clock and the venue’s, from GET /api/v2/public/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_http( http: Box<dyn HttpTransport>, options: &ExchangeOptions, ) -> Bitget

Build a public Bitget client.

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

Build an authenticated Bitget client (credentials must carry a passphrase).

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

Override the timestamp source (deterministic signing in tests).

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

Attach a WebSocket transport.

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

The Bitget 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). Bitget returns oldest-first, which is already 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_derivatives( &mut self, symbol: &Symbol, channel: DerivativesChannel, ) -> Result<(), Error>

Subscribe to a pushed derivatives channel.

Bitget publishes the funding rate, the mark price and the index price inside the mix ticker frame – all three in one reading, taken at one moment – so Funding and MarkIndex are the same subscription seen two ways.

Liquidations is refused: Bitget publishes no public stream of forced orders. Subscribing to nothing and waiting would be the worse answer.

Errors

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

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

The current open interest (GET /api/v2/mix/market/open-interest).

Polled, not pushed. The figure is in base currency.

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 /api/v2/mix/market/account-long-short), most recent point.

Polled, not pushed. Bitget publishes the two proportions directly, as Binance does, so nothing is derived here.

Errors

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

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.

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 poll_events(&mut self) -> Vec<Event>

Drain all stream events available since the last call. Non-blocking.

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

Open the private user-data stream (wss://ws.bitget.com/v2/ws/private). Logs in with an op:login frame (sign = base64(HMAC-SHA256) over <epochSeconds>GET/user/verify), then subscribes to the orders and account channels. 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 or a passphrase, 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 (the ping text frame Bitget expects) 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>

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 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.

Errors

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

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

Spot account balances.

Errors

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

impl Bitget

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

Open positions on the USDⓈ-M futures account (/api/v2/mix/position/all-position).

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 (/api/v2/mix/account/set-leverage).

Errors

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

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

Set the margin mode for symbol (/api/v2/mix/account/set-margin-mode).

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 place_batch( &self, requests: &[OrderRequest], ) -> Result<Vec<Result<Order, Error>>, Error>

Place several orders on one symbol in one request (/api/v2/spot/trade/batch-orders). Bitget returns separate success and failure lists, so a synthetic clientOid per index re-aligns them to each request’s own Result. Batch requires a single symbol (that of the first request).

Errors

Returns an Error if the batch request itself fails, or if called on a futures client (mix batch is a documented follow-up).

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

Cancel several orders on one symbol in one request (/api/v2/spot/trade/batch-cancel-order).

Errors

Returns an Error if the request fails, or if called on a futures client.

Trait Implementations

impl AdvancedOrders for Bitget

fn amend_order( &mut self, _symbol: &Symbol, _order_id: &str, _new_price: Option<Decimal>, _new_quantity: Option<Decimal>, ) -> Result<Order, Error>

Bitget spot has no in-place amend (orders are cancelled and re-placed), so this returns an Error::Exchange.

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

Bitget has no OCO order-list (it uses standalone plan/trigger orders), so this returns an Error::Exchange.

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 Bitget

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 Bitget

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 Bitget

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 Bitget

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

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

impl Execution for Bitget

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 Bitget

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 Bitget

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

Bitget exposes no public WebSocket order-entry API — its WebSocket surface is subscription-only (market data plus the private order/account push channels). Orders are placed over REST, so this returns a documented Error::Exchange.

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 Bitget

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.