Struct BitmexHttpClient 

pub struct BitmexHttpClient { /* private fields */ }

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

This is the high-level client that wraps the inner client and provides Nautilus-specific functionality for trading operations.

Implementations

impl BitmexHttpClient

pub fn new( base_url: Option<String>, api_key: Option<String>, api_secret: Option<String>, testnet: bool, timeout_secs: Option<u64>, ) -> Self

Creates a new BitmexHttpClient instance.

pub fn from_env() -> Result<Self>

Creates a new BitmexHttpClient instance using environment variables and the default BitMEX HTTP base URL.

Errors

Returns an error if required environment variables are not set or invalid.

pub fn with_credentials( api_key: Option<String>, api_secret: Option<String>, base_url: Option<String>, timeout_secs: Option<u64>, ) -> Result<Self>

Creates a new BitmexHttpClient configured with credentials for authenticated requests.

If api_key or api_secret are None, they will be sourced from the BITMEX_API_KEY and BITMEX_API_SECRET environment variables.

Errors

Returns an error if one credential is provided without the other.

pub fn base_url(&self) -> &str

Returns the base url being used by the client.

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

Returns the public API key being used by the client.

pub fn add_instrument(&mut self, instrument: InstrumentAny)

Add an instrument to the cache for precision lookups.

Panics

Panics if the instruments cache mutex is poisoned.

pub async fn request_instrument( &self, instrument_id: InstrumentId, ) -> Result<Option<InstrumentAny>>

Request all available instruments and parse them into Nautilus types.

Errors

Returns an error if the HTTP request fails or parsing fails.

pub async fn request_instruments( &self, active_only: bool, ) -> Result<Vec<InstrumentAny>>

Request all available instruments and parse them into Nautilus types.

Errors

Returns an error if the HTTP request fails or parsing fails.

pub async fn get_wallet(&self) -> Result<BitmexWallet, BitmexHttpError>

Get user wallet information.

Errors

Returns an error if credentials are missing, the request fails, or the API returns an error.

Panics

Panics if the inner mutex is poisoned.

pub async fn get_orders( &self, params: GetOrderParams, ) -> Result<Vec<BitmexOrder>, BitmexHttpError>

Get user orders.

Errors

Returns an error if credentials are missing, the request fails, or the API returns an error.

Panics

Panics if the inner mutex is poisoned.

pub async fn http_place_order( &self, params: PostOrderParams, ) -> Result<Value, BitmexHttpError>

Place a new order with raw API params.

Errors

Returns an error if credentials are missing, the request fails, order validation fails, or the API returns an error.

Panics

Panics if the inner mutex is poisoned.

pub async fn http_cancel_orders( &self, params: DeleteOrderParams, ) -> Result<Value, BitmexHttpError>

Cancel user orders with raw API params.

Errors

Returns an error if credentials are missing, the request fails, the order doesn’t exist, or the API returns an error.

Panics

Panics if the inner mutex is poisoned.

pub async fn http_amend_order( &self, params: PutOrderParams, ) -> Result<Value, BitmexHttpError>

Amend an existing order with raw API params.

Errors

Returns an error if credentials are missing, the request fails, the order doesn’t exist, or the API returns an error.

Panics

Panics if the inner mutex is poisoned.

pub async fn http_cancel_all_orders( &self, params: DeleteAllOrdersParams, ) -> Result<Value, BitmexHttpError>

Cancel all orders with raw API params.

Errors

Returns an error if credentials are missing, the request fails, or the API returns an error.

Panics

Panics if the inner mutex is poisoned.

References

https://www.bitmex.com/api/explorer/#!/Order/Order_cancelAll

pub fn get_price_precision(&self, symbol: Ustr) -> Result<u8>

Get price precision for a symbol from the instruments cache (if found).

Errors

Returns an error if the instrument is not found in the cache.

Panics

Panics if the instruments cache mutex is poisoned.

pub async fn http_get_margin(&self, currency: &str) -> Result<BitmexMargin>

Get user margin information.

Errors

Returns an error if credentials are missing, the request fails, or the API returns an error.

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

Request account state for the given account.

Errors

Returns an error if the HTTP request fails or no account state is returned.

pub async fn submit_order( &self, instrument_id: InstrumentId, client_order_id: ClientOrderId, order_side: OrderSide, order_type: OrderType, quantity: Quantity, time_in_force: TimeInForce, price: Option<Price>, trigger_price: Option<Price>, display_qty: Option<Quantity>, post_only: bool, 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, or the API returns an error.

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

Cancel an order.

Errors

This function will return an error if:

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

pub async fn cancel_orders( &self, instrument_id: InstrumentId, client_order_ids: Option<Vec<ClientOrderId>>, venue_order_ids: Option<Vec<VenueOrderId>>, ) -> Result<Vec<OrderStatusReport>>

Cancel multiple orders.

Errors

This function will return 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, instrument_id: InstrumentId, order_side: Option<OrderSide>, ) -> Result<Vec<OrderStatusReport>>

Cancel all orders for an instrument and optionally an order side.

Errors

This function will return an error if:

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

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

Modify an existing order.

Errors

This function will return 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 query_order( &self, 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

This function will return an error if:

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

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

Request a single order status report.

Errors

This function will return an error if:

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

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

Request multiple order status reports.

Errors

This function will return an error if:

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

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

Request trades for the given instrument.

Errors

Returns an error if the HTTP request fails or parsing fails.

pub async fn request_fill_reports( &self, instrument_id: Option<InstrumentId>, limit: Option<u32>, ) -> Result<Vec<FillReport>>

Request fill reports for the given instrument.

Errors

Returns an error if the HTTP request fails or parsing fails.

pub async fn request_position_status_reports( &self, ) -> Result<Vec<PositionStatusReport>>

Request position reports.

Errors

Returns an error if the HTTP request fails or parsing fails.

pub async fn submit_orders_bulk( &self, orders: Vec<PostOrderParams>, ) -> Result<Vec<OrderStatusReport>>

Submit multiple orders in bulk.

Errors

This function will return an error if:

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

pub async fn modify_orders_bulk( &self, orders: Vec<PutOrderParams>, ) -> Result<Vec<OrderStatusReport>>

Amend multiple orders in bulk.

Errors

This function will return an error if:

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

pub async fn update_position_leverage( &self, symbol: &str, leverage: f64, ) -> Result<PositionStatusReport>

Update position leverage.

Errors

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

impl BitmexHttpClient

pub fn py_base_url(&self) -> &str

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

Trait Implementations

impl Clone for BitmexHttpClient

fn clone(&self) -> BitmexHttpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitmexHttpClient

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

Formats the value using the given formatter.

impl Default for BitmexHttpClient

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for BitmexHttpClient

type Target = BitmexHttpClient

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BitmexHttpClient

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)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<BitmexHttpClient>

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<BitmexHttpClient> for PyClassImplCollector<BitmexHttpClient>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a BitmexHttpClient

type Holder = Option<PyRef<'py, BitmexHttpClient>>

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

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut BitmexHttpClient

type Holder = Option<PyRefMut<'py, BitmexHttpClient>>

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

impl PyMethods<BitmexHttpClient> for PyClassImplCollector<BitmexHttpClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for BitmexHttpClient

const NAME: &'static str = "BitmexHttpClient"

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 BitmexHttpClient