Struct BybitRawHttpClient 

pub struct BybitRawHttpClient { /* private fields */ }

Raw HTTP client for low-level Bybit API operations.

This client handles request/response operations with the Bybit API, returning venue-specific response types. It does not parse to Nautilus domain types.

Implementations

impl BybitRawHttpClient

pub fn cancel_all_requests(&self)

Cancels all pending HTTP requests.

pub fn reset_cancellation_token(&self)

Replaces the cancelled token with a fresh one so subsequent requests are not immediately short-circuited.

pub fn cancellation_token(&self) -> CancellationToken

Returns a clone of the current cancellation token.

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

Creates a new BybitRawHttpClient 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: u64, max_retries: u32, retry_delay_ms: u64, retry_delay_max_ms: u64, recv_window_ms: u64, proxy_url: Option<String>, ) -> Result<Self, BybitHttpError>

Creates a new BybitRawHttpClient configured with credentials.

Errors

Returns an error if the HTTP client cannot be created.

pub fn new_with_env( api_key: Option<String>, api_secret: Option<String>, base_url: Option<String>, demo: bool, testnet: bool, timeout_secs: u64, max_retries: u32, retry_delay_ms: u64, retry_delay_max_ms: u64, recv_window_ms: u64, proxy_url: Option<String>, ) -> Result<Self, BybitHttpError>

Creates a new BybitRawHttpClient with environment variable credential resolution.

If api_key or api_secret are not provided, they will be loaded from environment variables based on the environment flags:

• Demo: BYBIT_DEMO_API_KEY, BYBIT_DEMO_API_SECRET
• Testnet: BYBIT_TESTNET_API_KEY, BYBIT_TESTNET_API_SECRET
• Mainnet: BYBIT_API_KEY, BYBIT_API_SECRET

Errors

Returns an error if the HTTP client cannot be created.

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

Fetches the current server time from Bybit.

Errors

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

References

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

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

Fetches instrument information from Bybit for a given product category.

Errors

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

References

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

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

Fetches spot instrument information from Bybit.

Errors

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

References

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

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

Fetches linear instrument information from Bybit.

Errors

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

References

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

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

Fetches inverse instrument information from Bybit.

Errors

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

References

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

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

Fetches option instrument information from Bybit.

Errors

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

References

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

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

Fetches kline/candlestick data from Bybit.

Errors

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

References

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

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

Fetches recent trades from Bybit.

Errors

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

References

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

pub async fn get_funding_history( &self, params: &BybitFundingParams, ) -> Result<BybitFundingResponse, BybitHttpError>

Fetches funding data from Bybit.

Errors

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

References

• https://bybit-exchange.github.io/docs/v5/market/history-fund-rate

pub async fn get_orderbook( &self, params: &BybitOrderbookParams, ) -> Result<BybitOrderbookResponse, BybitHttpError>

Fetches orderbook from Bybit.

Errors

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

References

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

pub async fn get_open_orders( &self, category: BybitProductType, symbol: Option<String>, base_coin: Option<String>, settle_coin: Option<String>, order_id: Option<String>, order_link_id: Option<String>, open_only: Option<BybitOpenOnly>, order_filter: Option<BybitOrderFilter>, limit: Option<u32>, cursor: Option<String>, ) -> Result<BybitOpenOrdersResponse, BybitHttpError>

Fetches open orders (requires authentication).

Errors

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

Panics

Panics if the parameter builder fails (should never happen with valid inputs).

References

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

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

Places a new order (requires authentication).

Errors

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

References

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

pub async fn get_wallet_balance( &self, params: &BybitWalletBalanceParams, ) -> Result<BybitWalletBalanceResponse, BybitHttpError>

Fetches wallet balance (requires authentication).

Errors

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

References

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

pub async fn get_account_info( &self, ) -> Result<BybitAccountInfoResponse, BybitHttpError>

Fetches account information (requires authentication).

Errors

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

References

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

pub async fn get_account_details( &self, ) -> Result<BybitAccountDetailsResponse, BybitHttpError>

Fetches account details (requires authentication).

Errors

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

References

• https://bybit-exchange.github.io/docs/v5/user/apikey-info

pub async fn update_sub_api_key( &self, params: &BybitUpdateSubApiParams, ) -> Result<BybitUpdateSubApiResponse, BybitHttpError>

Modifies a sub-account API key (requires authentication).

Errors

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

References

• https://bybit-exchange.github.io/docs/v5/user/modify-sub-apikey

pub async fn update_master_api_key( &self, params: &BybitUpdateMasterApiParams, ) -> Result<BybitUpdateMasterApiResponse, BybitHttpError>

Modifies the master API key that issued the request (requires authentication).

Errors

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

References

• https://bybit-exchange.github.io/docs/v5/user/modify-master-apikey

pub async fn get_sub_members( &self, ) -> Result<BybitSubMembersResponse, BybitHttpError>

Fetches the sub-account list (up to 1000 rows, non-paginated).

Errors

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

References

• https://bybit-exchange.github.io/docs/v5/user/subuid-list

pub async fn get_sub_members_paged( &self, params: &BybitSubMembersPageParams, ) -> Result<BybitSubMembersPagedResponse, BybitHttpError>

Fetches a cursor-paginated sub-account list (/v5/user/submembers).

Errors

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

References

• https://bybit-exchange.github.io/docs/v5/user/page-subuid

pub async fn get_escrow_sub_members( &self, params: &BybitSubMembersPageParams, ) -> Result<BybitEscrowSubMembersResponse, BybitHttpError>

Fetches fund-custodial sub-accounts (/v5/user/escrow_sub_members).

Errors

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

References

• https://bybit-exchange.github.io/docs/v5/user/fund-subuid-list

pub async fn get_sub_api_keys( &self, params: &BybitSubApiKeysParams, ) -> Result<BybitSubApiKeysResponse, BybitHttpError>

Fetches all API keys belonging to a given sub-account.

Errors

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

References

• https://bybit-exchange.github.io/docs/v5/user/list-sub-apikeys

pub async fn fetch_all_sub_members_paged( &self, page_size: Option<u32>, ) -> Result<Vec<BybitSubMember>, BybitHttpError>

Fetches every sub-account page via /v5/user/submembers and returns the flattened list. Walks the cursor until Bybit signals end-of-pages.

Errors

Returns an error if any page request fails or the response cannot be parsed.

pub async fn fetch_all_escrow_sub_members( &self, page_size: Option<u32>, ) -> Result<Vec<BybitSubMember>, BybitHttpError>

Fetches every fund-custodial page via /v5/user/escrow_sub_members and returns the flattened list. Walks the cursor until Bybit signals end-of-pages.

Errors

Returns an error if any page request fails or the response cannot be parsed.

pub async fn fetch_all_sub_api_keys( &self, sub_member_id: impl Into<String>, limit: Option<u32>, ) -> Result<Vec<BybitSubApiKeyInfo>, BybitHttpError>

Fetches every page of sub-account API keys for sub_member_id and returns the flattened list. Walks the cursor until Bybit signals end-of-pages.

Errors

Returns an error if any page request fails or the response cannot be parsed.

pub async fn get_fee_rate( &self, params: &BybitFeeRateParams, ) -> Result<BybitFeeRateResponse, BybitHttpError>

Fetches trading fee rates for symbols.

Errors

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

References

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

pub async fn set_margin_mode( &self, margin_mode: BybitMarginMode, ) -> Result<BybitSetMarginModeResponse, BybitHttpError>

Sets the margin mode for the account.

Errors

Returns an error if:

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

Panics

Panics if required parameters are not provided (should not happen with current implementation).

References

• https://bybit-exchange.github.io/docs/v5/account/set-margin-mode

pub async fn set_leverage( &self, product_type: BybitProductType, symbol: &str, buy_leverage: &str, sell_leverage: &str, ) -> Result<BybitSetLeverageResponse, BybitHttpError>

Sets leverage for a symbol.

Errors

Returns an error if:

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

Panics

Panics if required parameters are not provided (should not happen with current implementation).

References

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

pub async fn switch_mode( &self, product_type: BybitProductType, mode: BybitPositionMode, symbol: Option<String>, coin: Option<String>, ) -> Result<BybitSwitchModeResponse, BybitHttpError>

Switches position mode for a product type.

Errors

Returns an error if:

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

Panics

Panics if required parameters are not provided (should not happen with current implementation).

References

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

pub async fn set_trading_stop( &self, params: &BybitSetTradingStopParams, ) -> Result<BybitSetTradingStopResponse, BybitHttpError>

Sets trading stop parameters including trailing stops.

Errors

Returns an error if:

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

References

• https://bybit-exchange.github.io/docs/v5/position/trading-stop

pub async fn borrow( &self, coin: &str, amount: &str, ) -> Result<BybitBorrowResponse, BybitHttpError>

Manually borrows coins for margin trading.

Errors

Returns an error if:

• Credentials are missing.
• The request fails.
• Insufficient collateral for the borrow.

Panics

Panics if the parameter builder fails (should never happen with valid inputs).

References

• https://bybit-exchange.github.io/docs/v5/account/borrow

pub async fn no_convert_repay( &self, coin: &str, amount: Option<&str>, ) -> Result<BybitNoConvertRepayResponse, BybitHttpError>

Manually repays borrowed coins without asset conversion.

Errors

Returns an error if:

• Credentials are missing.
• The request fails.
• Called between 04:00-05:30 UTC (interest calculation window).
• Insufficient spot balance for repayment.

Panics

Panics if the parameter builder fails (should never happen with valid inputs).

References

• https://bybit-exchange.github.io/docs/v5/account/no-convert-repay

pub async fn get_tickers<T: DeserializeOwned + BybitResponseCheck>( &self, params: &BybitTickersParams, ) -> Result<T, BybitHttpError>

Fetches tickers for market data.

Errors

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

References

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

pub async fn get_trade_history( &self, params: &BybitTradeHistoryParams, ) -> Result<BybitTradeHistoryResponse, BybitHttpError>

Fetches trade execution history (requires authentication).

Errors

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

References

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

pub async fn get_positions( &self, params: &BybitPositionListParams, ) -> Result<BybitPositionListResponse, BybitHttpError>

Fetches position information (requires authentication).

Errors

This function returns an error if:

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

References

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

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.

impl BybitRawHttpClient

pub fn py_base_url(&self) -> &str

Returns the base URL used for requests.

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

pub fn py_recv_window_ms(&self) -> u64

Returns the configured receive window in milliseconds.

Trait Implementations

impl Clone for BybitRawHttpClient

fn clone(&self) -> BybitRawHttpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BybitRawHttpClient

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

Formats the value using the given formatter.

impl Default for BybitRawHttpClient

fn default() -> Self

Returns the “default value” for a type.

impl<'a, 'py> FromPyObject<'a, 'py> for BybitRawHttpClient

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for BybitRawHttpClient

type Target = BybitRawHttpClient

The Python output type

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

const NAME: &str = "BybitRawHttpClient"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BybitRawHttpClient

const MODULE: Option<&str>

Module which the class will be associated with.

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 = /// Raw HTTP client for low-level Bybit API operations. /// /// This client handles request/response operations with the Bybit API, /// returning venue-specific response types. It does not parse to Nautilus domain types.

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 Layout = <<BybitRawHttpClient as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<BybitRawHttpClient>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForBybitRawHttpClient

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

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for BybitRawHttpClient

const TEXT_SIGNATURE: &'static str = "(api_key=None, api_secret=None, base_url=None, demo=False, testnet=False, timeout_secs=60, max_retries=3, retry_delay_ms=1000, retry_delay_max_ms=10000, recv_window_ms=5000, proxy_url=None)"

impl PyStubType for BybitRawHttpClient

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for BybitRawHttpClient

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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 BybitRawHttpClient