Struct BybitHttpClient 

pub struct BybitHttpClient { /* private fields */ }

Provides a HTTP client for connecting to the Bybit REST API.

Implementations

impl BybitHttpClient

pub fn new( base_url: Option<String>, timeout_secs: Option<u64>, max_retries: Option<u32>, retry_delay_ms: Option<u64>, retry_delay_max_ms: Option<u64>, ) -> Result<Self, BybitHttpError>

Creates a new BybitHttpClient using the default Bybit HTTP URL.

Errors

Returns an error if the retry manager cannot be created.

pub fn with_credentials( api_key: String, api_secret: String, base_url: Option<String>, timeout_secs: Option<u64>, max_retries: Option<u32>, retry_delay_ms: Option<u64>, retry_delay_max_ms: Option<u64>, ) -> Result<Self, BybitHttpError>

Creates a new BybitHttpClient configured with credentials.

Errors

Returns an error if the retry manager cannot be created.

pub fn base_url(&self) -> &str

Returns the base URL used for requests.

pub fn recv_window_ms(&self) -> u64

Returns the configured receive window in milliseconds.

pub fn credential(&self) -> Option<&Credential>

Returns the API credential if configured.

pub fn cancel_all_requests(&self)

Cancel all pending HTTP requests.

pub fn cancellation_token(&self) -> &CancellationToken

Get the cancellation token for this client.

pub async fn http_get_server_time( &self, ) -> Result<BybitServerTimeResponse, BybitHttpError>

Fetches the current server time from Bybit.

Errors

Returns an error if:

• The request fails.
• The response cannot be parsed.

References

• https://bybit-exchange.github.io/docs/v5/market/time

pub async fn http_get_instruments<T: DeserializeOwned>( &self, params: &BybitInstrumentsInfoParams, ) -> Result<T, BybitHttpError>

Fetches instrument information from Bybit for a given product category.

Errors

Returns an error if:

• The request fails.
• The response cannot be parsed.

References

• https://bybit-exchange.github.io/docs/v5/market/instruments-info

pub async fn http_get_instruments_spot( &self, params: &BybitInstrumentsInfoParams, ) -> Result<BybitInstrumentSpotResponse, BybitHttpError>

Fetches spot instrument information from Bybit.

Errors

Returns an error if:

• The request fails.
• The response cannot be parsed.

References

• https://bybit-exchange.github.io/docs/v5/market/instruments-info

pub async fn http_get_instruments_linear( &self, params: &BybitInstrumentsInfoParams, ) -> Result<BybitInstrumentLinearResponse, BybitHttpError>

Fetches linear instrument information from Bybit.

Errors

Returns an error if:

• The request fails.
• The response cannot be parsed.

References

• https://bybit-exchange.github.io/docs/v5/market/instruments-info

pub async fn http_get_instruments_inverse( &self, params: &BybitInstrumentsInfoParams, ) -> Result<BybitInstrumentInverseResponse, BybitHttpError>

Fetches inverse instrument information from Bybit.

Errors

Returns an error if:

• The request fails.
• The response cannot be parsed.

References

• https://bybit-exchange.github.io/docs/v5/market/instruments-info

pub async fn http_get_instruments_option( &self, params: &BybitInstrumentsInfoParams, ) -> Result<BybitInstrumentOptionResponse, BybitHttpError>

Fetches option instrument information from Bybit.

Errors

Returns an error if:

• The request fails.
• The response cannot be parsed.

References

• https://bybit-exchange.github.io/docs/v5/market/instruments-info

pub async fn http_get_klines( &self, params: &BybitKlinesParams, ) -> Result<BybitKlinesResponse, BybitHttpError>

Fetches kline/candlestick data from Bybit.

Errors

Returns an error if:

• The request fails.
• The response cannot be parsed.

References

• https://bybit-exchange.github.io/docs/v5/market/kline

pub async fn http_get_recent_trades( &self, params: &BybitTradesParams, ) -> Result<BybitTradesResponse, BybitHttpError>

Fetches recent trades from Bybit.

Errors

Returns an error if:

• The request fails.
• The response cannot be parsed.

References

• https://bybit-exchange.github.io/docs/v5/market/recent-trade

pub async fn http_get_open_orders( &self, category: BybitProductType, symbol: Option<&str>, ) -> Result<BybitOpenOrdersResponse, BybitHttpError>

Fetches open orders (requires authentication).

Errors

Returns an error if:

• The request fails.
• The response cannot be parsed.

References

• https://bybit-exchange.github.io/docs/v5/order/open-order

pub async fn http_place_order( &self, request: &Value, ) -> Result<BybitPlaceOrderResponse, BybitHttpError>

Places a new order (requires authentication).

Errors

Returns an error if:

• The request fails.
• The response cannot be parsed.

References

• https://bybit-exchange.github.io/docs/v5/order/create-order

pub fn add_instrument(&self, instrument: InstrumentAny)

Add an instrument to the cache.

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: TimeInForce, price: Option<Price>, reduce_only: bool, ) -> Result<OrderStatusReport>

Submit a new order.

Errors

Returns an error if:

• Credentials are missing.
• The request fails.
• Order validation fails.
• The order is rejected.
• The API returns an error.

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

Modify an existing order.

Errors

Returns an error if:

• Credentials are missing.
• The request fails.
• The order doesn’t exist.
• The order is already closed.
• The API returns an error.

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

Cancel an order.

Errors

Returns an error if:

• Credentials are missing.
• The request fails.
• The order doesn’t exist.
• The API returns an error.

pub async fn cancel_all_orders( &self, product_type: BybitProductType, instrument_id: InstrumentId, ) -> Result<Vec<OrderStatusReport>>

Cancel all orders for an instrument.

Errors

Returns an error if:

• Credentials are missing.
• The request fails.
• The API returns an error.

pub async fn query_order( &self, account_id: AccountId, product_type: BybitProductType, instrument_id: InstrumentId, client_order_id: Option<ClientOrderId>, venue_order_id: Option<VenueOrderId>, ) -> Result<Option<OrderStatusReport>>

Query a single order by client order ID or venue order ID.

Errors

Returns an error if:

• Credentials are missing.
• The request fails.
• The API returns an error.

pub async fn request_order_status_reports( &self, account_id: AccountId, product_type: BybitProductType, instrument_id: Option<InstrumentId>, open_only: bool, limit: Option<u32>, ) -> Result<Vec<OrderStatusReport>>

Request multiple order status reports.

Errors

Returns an error if:

• Credentials are missing.
• The request fails.
• The API returns an error.

pub async fn request_instruments( &self, product_type: BybitProductType, symbol: Option<String>, ) -> Result<Vec<InstrumentAny>>

Request instruments for a given product type.

Errors

Returns an error if:

• The request fails.
• Parsing fails.

pub async fn request_trades( &self, product_type: BybitProductType, instrument_id: InstrumentId, limit: Option<u32>, ) -> Result<Vec<TradeTick>>

Request trade tick history for a given symbol.

Errors

Returns an error if:

• The instrument is not found in cache.
• The request fails.
• Parsing fails.

References

https://bybit-exchange.github.io/docs/v5/market/recent-trade

pub async fn request_bars( &self, product_type: BybitProductType, bar_type: BarType, start: Option<i64>, end: Option<i64>, limit: Option<u32>, ) -> Result<Vec<Bar>>

Request bar/kline history for a given symbol.

Errors

Returns an error if:

• The instrument is not found in cache.
• The request fails.
• Parsing fails.

References

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

pub async fn request_fill_reports( &self, account_id: AccountId, product_type: BybitProductType, instrument_id: Option<InstrumentId>, start: Option<i64>, end: Option<i64>, limit: Option<u32>, ) -> Result<Vec<FillReport>>

Fetches execution history (fills) for the account.

Errors

This function returns an error if:

• Required instruments are not cached.
• The instrument is not found in cache.
• The request fails.
• Parsing fails.

References

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

pub async fn request_position_status_reports( &self, account_id: AccountId, product_type: BybitProductType, instrument_id: Option<InstrumentId>, ) -> Result<Vec<PositionStatusReport>>

Fetches position information for the account.

Errors

This function returns an error if:

• Required instruments are not cached.
• The instrument is not found in cache.
• The request fails.
• Parsing fails.

References

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

pub async fn request_account_state( &self, account_type: BybitAccountType, account_id: AccountId, ) -> Result<AccountState>

Requests the current account state for the specified account type.

Errors

Returns an error if:

• The request fails.
• Parsing fails.

References

https://bybit-exchange.github.io/docs/v5/account/wallet-balance

pub async fn request_fee_rates( &self, product_type: BybitProductType, symbol: Option<String>, base_coin: Option<String>, ) -> Result<Vec<BybitFeeRate>>

Requests trading fee rates for the specified product type and optional filters.

Errors

Returns an error if:

• The request fails.
• Parsing fails.

References

https://bybit-exchange.github.io/docs/v5/account/fee-rate

impl BybitHttpClient

pub fn py_base_url(&self) -> &str

pub fn py_api_key(&self) -> Option<&str>

Trait Implementations

impl Clone for BybitHttpClient

fn clone(&self) -> BybitHttpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BybitHttpClient

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

Formats the value using the given formatter.

impl Default for BybitHttpClient

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for BybitHttpClient

type Target = BybitHttpClient

The Python output type

type Output = Bound<'py, <BybitHttpClient 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 BybitHttpClient

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BybitHttpClient

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 = /// Provides a HTTP client for connecting to the [Bybit](https://bybit.com) REST API.

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

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 PyClassNewTextSignature for BybitHttpClient

const TEXT_SIGNATURE: &'static str = "(api_key=None, api_secret=None, base_url=None, timeout_secs=None, max_retries=None, retry_delay_ms=None, retry_delay_max_ms=None)"

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

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

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 BybitHttpClient

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

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

impl PyMethods<BybitHttpClient> for PyClassImplCollector<BybitHttpClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for BybitHttpClient

const NAME: &'static str = "BybitHttpClient"

Class name.

const MODULE: Option<&'static str>

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 BybitHttpClient