Skip to main content

Crate bitget_rs

Crate bitget_rs 

Source
Expand description

§bitget_rs

Bitget V2 Futures SDK crate used by crypto_exc_all.

Current coverage:

  • Public common/notice:
    • GET /api/v2/public/time
    • GET /api/v2/public/annoucements
  • Futures market:
    • GET /api/v2/mix/market/ticker
    • GET /api/v2/mix/market/tickers
    • GET /api/v2/mix/market/contracts
    • GET /api/v2/mix/market/orderbook
    • GET /api/v2/mix/market/merge-depth
    • GET /api/v2/mix/market/candles
    • GET /api/v2/mix/market/history-candles
    • GET /api/v2/mix/market/symbol-price
    • GET /api/v2/mix/market/current-fund-rate
    • GET /api/v2/mix/market/history-fund-rate
    • GET /api/v2/mix/market/open-interest
    • GET /api/v2/mix/market/oi-limit
    • GET /api/v2/mix/market/query-position-lever
    • GET /api/v2/mix/market/vip-fee-rate
    • GET /api/v2/mix/market/long-short
    • GET /api/v2/mix/market/account-long-short
    • GET /api/v2/mix/market/taker-buy-sell
    • GET /api/v2/mix/market/exchange-rate
  • Futures account/position:
    • GET /api/v2/mix/account/accounts
    • GET /api/v2/mix/account/account
    • GET /api/v2/mix/account/bill
    • GET /api/v2/mix/account/sub-account-assets
    • GET /api/v2/mix/position/all-position
    • GET /api/v2/mix/position/history-position
    • POST /api/v2/mix/account/set-leverage
    • POST /api/v2/mix/account/set-margin-mode
    • POST /api/v2/mix/account/set-position-mode
    • POST /api/v2/mix/account/set-margin
    • POST /api/v2/mix/account/set-asset-mode
    • GET /api/v2/common/trade-rate
  • Futures trade:
    • POST /api/v2/mix/order/place-order
    • POST /api/v2/mix/order/batch-place-order
    • POST /api/v2/mix/order/cancel-order
    • POST /api/v2/mix/order/cancel-batch-orders
    • POST /api/v2/mix/order/cancel-all-orders
    • POST /api/v2/mix/order/modify-order
    • POST /api/v2/mix/order/close-positions
    • POST /api/v2/mix/order/place-plan-order
    • POST /api/v2/mix/order/place-tpsl-order
    • POST /api/v2/mix/order/place-pos-tpsl
    • POST /api/v2/mix/order/modify-plan-order
    • POST /api/v2/mix/order/modify-tpsl-order
    • POST /api/v2/mix/order/cancel-plan-order
    • GET /api/v2/mix/order/detail
    • GET /api/v2/mix/order/orders-pending
    • GET /api/v2/mix/order/orders-history
    • GET /api/v2/mix/order/orders-plan-pending
    • GET /api/v2/mix/order/orders-plan-history
    • GET /api/v2/mix/order/plan-sub-order
    • GET /api/v2/mix/order/fills
  • Spot wallet/asset:
    • GET /api/v2/spot/public/coins
    • GET /api/v2/spot/wallet/deposit-address
    • GET /api/v2/spot/wallet/deposit-records
    • GET /api/v2/spot/wallet/withdrawal-records
    • GET /api/v2/spot/wallet/transfer-coin-info
    • POST /api/v2/spot/wallet/transfer
    • POST /api/v2/spot/wallet/withdrawal
  • WebSocket:
    • V2 public/private URL config
    • login signing with timestamp + GET + /user/verify
    • string ping / pong
    • subscribe / unsubscribe payload builders
    • place-order / cancel-order trade payload builders and trade ack parser
    • base typed event parser with raw fallback
    • typed DTOs for ticker, orders, account, positions, books*, trade, candle*, fill, orders-algo, adl-noti, and positions-history pushes
    • WebSocket session with SOCKS5/SOCKS5h proxy support
    • reconnect manager with public/private client split, unified message forwarding, pending/active subscription registry, runtime subscribe/unsubscribe, timed ping, private login replay with ack gate, inbound stall timeout, connected-session failure limits, granular connection states, metrics, and subscription replay
  • HMAC-SHA256 + Base64 request signing
  • SOCKS/HTTP proxy configuration
  • Mocked request, signature header, and response mapping tests

§Environment

BITGET_API_KEY=...
BITGET_API_SECRET=...
BITGET_PASSPHRASE=...
BITGET_API_URL=https://api.bitget.com
BITGET_API_TIMEOUT_MS=5000
BITGET_PROXY_URL=socks5h://127.0.0.1:7897
BITGET_WS_PUBLIC_URL=wss://ws.bitget.com/v2/ws/public
BITGET_WS_PRIVATE_URL=wss://ws.bitget.com/v2/ws/private

Lowercase key names are also accepted for compatibility with existing .env files:

bitget_api_key=...
bitget_api_secret=...
bitget_passphrase=...
bitget_PASSPHRASE=...

§Example

use bitget_rs::api::market::{BitgetMarket, TickerRequest};

#[tokio::main]
async fn main() -> Result<(), bitget_rs::Error> {
    let market = BitgetMarket::new_public()?;
    let tickers = market
        .get_ticker(TickerRequest::new("BTCUSDT", "USDT-FUTURES"))
        .await?;

    println!("{} {}", tickers[0].symbol, tickers[0].last_price);
    Ok(())
}

§WebSocket Example

use bitget_rs::api::websocket::{BitgetWebsocket, BitgetWebsocketChannel};
use bitget_rs::config::Config;

#[tokio::main]
async fn main() -> Result<(), bitget_rs::Error> {
    let websocket = BitgetWebsocket::new_public(Config::from_env());
    let mut session = websocket.connect_public().await?;
    let ticker = BitgetWebsocketChannel::new("USDT-FUTURES", "ticker")
        .with_inst_id("BTCUSDT");

    session.subscribe(&[ticker]).await?;
    while let Some(event) = session.recv_event().await {
        println!("{event:?}");
    }

    Ok(())
}

Public and private smoke examples are also available:

cargo run -p bitget_rs --example websocket_public_smoke
cargo run -p bitget_rs --example websocket_private_smoke

websocket_public_smoke subscribes to public ticker and books5 and waits for one market data push. websocket_private_smoke logs in with BITGET_API_KEY / BITGET_API_SECRET / BITGET_PASSPHRASE, subscribes to account and orders, and does not place orders.

Re-exports§

pub use api::account::BitgetAccount;
pub use api::announcements::BitgetAnnouncements;
pub use api::asset::BitgetAsset;
pub use api::market::BitgetMarket;
pub use api::trade::BitgetTrade;
pub use api::websocket::BitgetWebsocket;
pub use client::BitgetClient;
pub use error::Error;

Modules§

api
client
config
error
utils