BybitRawHttpClient

Struct BybitRawHttpClient 

Source
pub struct BybitRawHttpClient { /* private fields */ }
Expand description

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§

Source§

impl BybitRawHttpClient

Source

pub fn cancel_all_requests(&self)

Cancel all pending HTTP requests.

Source

pub fn cancellation_token(&self) -> &CancellationToken

Get the cancellation token for this client.

Source

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>, recv_window_ms: Option<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.

Source

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>, recv_window_ms: Option<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.

Source

pub fn new_with_env( api_key: Option<String>, api_secret: Option<String>, base_url: Option<String>, demo: bool, testnet: bool, timeout_secs: Option<u64>, max_retries: Option<u32>, retry_delay_ms: Option<u64>, retry_delay_max_ms: Option<u64>, recv_window_ms: Option<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.

Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

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
Source

pub fn base_url(&self) -> &str

Returns the base URL used for requests.

Source

pub fn recv_window_ms(&self) -> u64

Returns the configured receive window in milliseconds.

Source

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

Returns the API credential if configured.

Source§

impl BybitRawHttpClient

Source

pub fn py_base_url(&self) -> &str

Source

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

Source

pub fn py_recv_window_ms(&self) -> u64

Trait Implementations§

Source§

impl Clone for BybitRawHttpClient

Source§

fn clone(&self) -> BybitRawHttpClient

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BybitRawHttpClient

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BybitRawHttpClient

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

type Target = BybitRawHttpClient

The Python output type
Source§

type Output = Bound<'py, <BybitRawHttpClient as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.
Source§

impl PyClass for BybitRawHttpClient

Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for BybitRawHttpClient

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

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. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<BybitRawHttpClient>

This handles following two situations: Read more
Source§

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable
Source§

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.
Source§

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.
Source§

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.
Source§

fn items_iter() -> PyClassItemsIter

Source§

fn lazy_type_object() -> &'static LazyTypeObject<Self>

§

fn dict_offset() -> Option<isize>

§

fn weaklist_offset() -> Option<isize>

Source§

impl PyClassNewTextSignature for BybitRawHttpClient

Source§

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

Source§

impl PyMethods<BybitRawHttpClient> for PyClassImplCollector<BybitRawHttpClient>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for BybitRawHttpClient

Source§

const NAME: &'static str = "BybitRawHttpClient"

Class name.
Source§

const MODULE: Option<&'static str>

Module name, if any.
Source§

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

impl DerefToPyAny for BybitRawHttpClient

Source§

impl ExtractPyClassWithClone for BybitRawHttpClient

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<'a, 'py, T> FromPyObject<'a, 'py> for T
where T: PyClass + Clone + ExtractPyClassWithClone,

§

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error. Read more
§

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

Extracts Self from the bound smart pointer obj. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
Source§

impl<'py, T> IntoPyObjectNautilusExt<'py> for T
where T: IntoPyObjectExt<'py>,

Source§

fn into_py_any_unwrap(self, py: Python<'py>) -> Py<PyAny>

Convert self into a [Py<PyAny>] while panicking if the conversion fails. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = T::NAME

👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.
§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<'py, T> FromPyObjectOwned<'py> for T
where T: for<'a> FromPyObject<'a, 'py>,

§

impl<T> Ungil for T
where T: Send,