Struct BybitClient

Source

pub struct BybitClient { /* private fields */ }

Expand description

Main client for interacting with the Bybit API.

§Example

use bybit_client::{BybitClient, ClientConfig};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create a public-only client.
    let client = BybitClient::public_only()?;

    // Or create an authenticated client.
    let client = BybitClient::new("api_key", "api_secret")?;

    // Use testnet.
    let client = BybitClient::with_config(
        ClientConfig::new("api_key", "api_secret").testnet()
    )?;

    Ok(())
}

Implementations§

Source §

impl BybitClient

Source

pub fn new( api_key: impl Into<String>, api_secret: impl Into<String>, ) -> Result<Self, BybitError>

Create a new client with API credentials.

Source

pub fn public_only() -> Result<Self, BybitError>

Create a client for public endpoints only (no authentication).

Source

pub fn with_config(config: ClientConfig) -> Result<Self, BybitError>

Create a client with custom configuration.

Source

pub fn http(&self) -> &HttpClient

Get the underlying HTTP client.

Source

pub fn config(&self) -> &ClientConfig

Get the client configuration.

Source

pub async fn sync_time(&self) -> Result<i64, BybitError>

Synchronize time with the server.

This is useful when your system clock is not accurate. The client will adjust timestamps in authenticated requests based on the calculated offset.

Source

pub fn has_credentials(&self) -> bool

Check if the client has authentication credentials.

Source

pub fn market(&self) -> MarketService

Get the market data service for public endpoints.

§Example

let client = BybitClient::public_only()?;
let params = GetTickersParams::new(Category::Linear).symbol("BTCUSDT");
let tickers = client.market().get_tickers(&params).await?;

Source

pub fn trade(&self) -> TradeService

Get the trade service for order management endpoints.

Note: Trading endpoints require authentication.

§Example

let client = BybitClient::new("api_key", "api_secret")?;

// Place a market order.
let params = OrderParams::market(Category::Linear, "BTCUSDT", Side::Buy, "0.001");
let result = client.trade().submit_order(&params).await?;
println!("Order ID: {}", result.order_id);

Source

pub fn position(&self) -> PositionService

Get the position service for position management endpoints.

Note: Position endpoints require authentication.

§Example

let client = BybitClient::new("api_key", "api_secret")?;

let params = GetPositionInfoParams::new(Category::Linear).symbol("BTCUSDT");
let result = client.position().get_position_info(&params).await?;
for pos in &result.list {
    println!("{}: {} @ {}", pos.symbol, pos.size, pos.avg_price);
}

Source

pub fn account(&self) -> AccountService

Get the account service for wallet and account management endpoints.

Note: Account endpoints require authentication.

§Example

let client = BybitClient::new("api_key", "api_secret")?;

let params = GetWalletBalanceParams::new(AccountType::Unified);
let result = client.account().get_wallet_balance(&params).await?;
for wallet in &result.list {
    println!("Total equity: {}", wallet.total_equity);
}