Struct BitmexHttpInnerClient 

pub struct BitmexHttpInnerClient { /* private fields */ }

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

This client wraps the underlying HttpClient to handle functionality specific to BitMEX, such as request signing (for authenticated endpoints), forming request URLs, and deserializing responses into specific data models.

Connection Management

The client uses HTTP keep-alive for connection pooling with a 90-second idle timeout, which matches BitMEX’s server-side keep-alive timeout. Connections are automatically reused for subsequent requests to minimize latency.

Rate Limiting

BitMEX enforces the following rate limits:

• 120 requests per minute for authenticated users (30 for unauthenticated).
• 10 requests per second burst limit for certain endpoints (order management).

The client automatically respects these limits through the configured quota.

Implementations

impl BitmexHttpInnerClient

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

Creates a new BitmexHttpInnerClient using the default BitMEX HTTP URL, optionally overridden with a custom base URL.

This version of the client has no credentials, so it can only call publicly accessible endpoints.

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

Creates a new BitmexHttpInnerClient configured with credentials for authenticated requests, optionally using a custom base URL.

pub async fn http_get_instruments( &self, active_only: bool, ) -> Result<Vec<BitmexInstrument>, BitmexHttpError>

Get all instruments.

Errors

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

pub async fn http_get_instrument( &self, symbol: &str, ) -> Result<BitmexInstrument, BitmexHttpError>

Get instrument by symbol.

Errors

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

pub async fn http_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.

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

Get user margin information.

Errors

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

pub async fn http_get_trades( &self, params: GetTradeParams, ) -> Result<Vec<BitmexTrade>, BitmexHttpError>

Get historical trades.

Errors

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

Panics

Panics if the parameters cannot be serialized (should never happen with valid builder-generated params).

pub async fn http_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 parameters cannot be serialized (should never happen with valid builder-generated params).

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

Place a new order.

Errors

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

Panics

Panics if the parameters cannot be serialized (should never happen with valid builder-generated params).

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

Cancel user orders.

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 parameters cannot be serialized (should never happen with valid builder-generated params).

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

Amend an existing order.

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 parameters cannot be serialized (should never happen with valid builder-generated params).

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

Cancel all orders.

Errors

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

Panics

Panics if the parameters cannot be serialized (should never happen with valid builder-generated params).

References

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

pub async fn http_get_executions( &self, params: GetExecutionParams, ) -> Result<Vec<BitmexExecution>, BitmexHttpError>

Get user executions.

Errors

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

Panics

Panics if the parameters cannot be serialized (should never happen with valid builder-generated params).

pub async fn http_get_positions( &self, params: GetPositionParams, ) -> Result<Vec<BitmexPosition>, BitmexHttpError>

Get user positions.

Errors

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

Panics

Panics if the parameters cannot be serialized (should never happen with valid builder-generated params).

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

Place multiple orders in bulk.

Errors

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

Panics

Panics if the parameters cannot be serialized (should never happen with valid builder-generated params).

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

Amend multiple orders in bulk.

Errors

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

Panics

Panics if the parameters cannot be serialized (should never happen with valid builder-generated params).

pub async fn http_update_position_leverage( &self, params: PostPositionLeverageParams, ) -> Result<BitmexPosition, BitmexHttpError>

Update position leverage.

Errors

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

Panics

Panics if the parameters cannot be serialized (should never happen with valid builder-generated params).

Trait Implementations

impl Clone for BitmexHttpInnerClient

fn clone(&self) -> BitmexHttpInnerClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitmexHttpInnerClient

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

Formats the value using the given formatter.

impl Default for BitmexHttpInnerClient

fn default() -> Self

Returns the “default value” for a type.