Struct BinanceFuturesHttpClient 

pub struct BinanceFuturesHttpClient { /* private fields */ }

Binance Futures HTTP client for USD-M and COIN-M perpetuals.

Implementations

impl BinanceFuturesHttpClient

pub fn new( product_type: BinanceProductType, environment: BinanceEnvironment, api_key: Option<String>, api_secret: Option<String>, base_url_override: Option<String>, recv_window: Option<u64>, timeout_secs: Option<u64>, proxy_url: Option<String>, ) -> BinanceFuturesHttpResult<Self>

Creates a new BinanceFuturesHttpClient instance.

Errors

Returns an error if the product type is invalid or HTTP client creation fails.

pub const fn product_type(&self) -> BinanceProductType

Returns the product type (UsdM or CoinM).

pub const fn raw(&self) -> &BinanceRawFuturesHttpClient

Returns a reference to the underlying raw HTTP client.

pub fn instruments_cache(&self) -> Arc<DashMap<Ustr, BinanceFuturesInstrument>>

Returns a clone of the instruments cache Arc.

pub async fn server_time(&self) -> BinanceFuturesHttpResult<BinanceServerTime>

Returns server time.

Errors

Returns an error if the request fails.

pub async fn set_leverage( &self, params: &BinanceSetLeverageParams, ) -> BinanceFuturesHttpResult<BinanceLeverageResponse>

Sets leverage for a symbol.

Errors

Returns an error if the request fails.

pub async fn set_margin_type( &self, params: &BinanceSetMarginTypeParams, ) -> BinanceFuturesHttpResult<Value>

Sets margin type for a symbol.

Errors

Returns an error if the request fails.

pub async fn query_hedge_mode( &self, ) -> BinanceFuturesHttpResult<BinanceHedgeModeResponse>

Queries hedge mode (dual side position) setting.

Errors

Returns an error if the request fails.

pub async fn create_listen_key( &self, ) -> BinanceFuturesHttpResult<ListenKeyResponse>

Creates a listen key for user data stream.

Errors

Returns an error if the request fails.

pub async fn keepalive_listen_key( &self, listen_key: &str, ) -> BinanceFuturesHttpResult<()>

Keeps alive an existing listen key.

Errors

Returns an error if the request fails.

pub async fn close_listen_key( &self, listen_key: &str, ) -> BinanceFuturesHttpResult<()>

Closes an existing listen key.

Errors

Returns an error if the request fails.

pub async fn exchange_info(&self) -> BinanceFuturesHttpResult<()>

Fetches exchange information and populates the instrument cache.

Errors

Returns an error if the request fails or the product type is invalid.

pub async fn request_instruments( &self, ) -> BinanceFuturesHttpResult<Vec<InstrumentAny>>

Fetches exchange information and returns parsed Nautilus instruments.

Errors

Returns an error if the request fails or the product type is invalid.

pub async fn ticker_24h( &self, params: &BinanceTicker24hrParams, ) -> BinanceFuturesHttpResult<Vec<BinanceFuturesTicker24hr>>

Fetches 24hr ticker statistics.

Errors

Returns an error if the request fails.

pub async fn book_ticker( &self, params: &BinanceBookTickerParams, ) -> BinanceFuturesHttpResult<Vec<BinanceBookTicker>>

Fetches best bid/ask prices.

Errors

Returns an error if the request fails.

pub async fn price_ticker( &self, symbol: Option<&str>, ) -> BinanceFuturesHttpResult<Vec<BinancePriceTicker>>

Fetches price ticker.

Errors

Returns an error if the request fails.

pub async fn depth( &self, params: &BinanceDepthParams, ) -> BinanceFuturesHttpResult<BinanceOrderBook>

Fetches order book depth.

Errors

Returns an error if the request fails.

pub async fn mark_price( &self, params: &BinanceMarkPriceParams, ) -> BinanceFuturesHttpResult<Vec<BinanceFuturesMarkPrice>>

Fetches mark price and funding rate.

Errors

Returns an error if the request fails.

pub async fn funding_rate( &self, params: &BinanceFundingRateParams, ) -> BinanceFuturesHttpResult<Vec<BinanceFundingRate>>

Fetches funding rate history.

Errors

Returns an error if the request fails.

pub async fn open_interest( &self, params: &BinanceOpenInterestParams, ) -> BinanceFuturesHttpResult<BinanceOpenInterest>

Fetches current open interest for a symbol.

Errors

Returns an error if the request fails.

pub async fn query_order( &self, params: &BinanceOrderQueryParams, ) -> BinanceFuturesHttpResult<BinanceFuturesOrder>

Queries a single order by order ID or client order ID.

Errors

Returns an error if the request fails.

pub async fn query_open_orders( &self, params: &BinanceOpenOrdersParams, ) -> BinanceFuturesHttpResult<Vec<BinanceFuturesOrder>>

Queries all open orders.

Errors

Returns an error if the request fails.

pub async fn query_all_orders( &self, params: &BinanceAllOrdersParams, ) -> BinanceFuturesHttpResult<Vec<BinanceFuturesOrder>>

Queries all orders (including historical).

Errors

Returns an error if the request fails.

pub async fn query_account( &self, ) -> BinanceFuturesHttpResult<BinanceFuturesAccountInfo>

Fetches account information including balances and positions.

Errors

Returns an error if the request fails.

pub async fn query_positions( &self, params: &BinancePositionRiskParams, ) -> BinanceFuturesHttpResult<Vec<BinancePositionRisk>>

Fetches position risk information.

Errors

Returns an error if the request fails.

pub async fn query_user_trades( &self, params: &BinanceUserTradesParams, ) -> BinanceFuturesHttpResult<Vec<BinanceUserTrade>>

Fetches user trades for a symbol.

Errors

Returns an error if the request fails.

pub async fn submit_order( &self, account_id: AccountId, 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>, reduce_only: bool, position_side: Option<BinancePositionSide>, ) -> Result<OrderStatusReport>

Submits a new order.

Errors

Returns an error if:

• The instrument is not cached.
• The order type or time-in-force is unsupported.
• Stop orders are submitted without a trigger price.
• The request fails.

pub async fn submit_algo_order( &self, account_id: AccountId, 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>, reduce_only: bool, position_side: Option<BinancePositionSide>, ) -> Result<OrderStatusReport>

Submits an algo order (conditional order) to the Binance Algo Service.

As of 2025-12-09, Binance migrated conditional order types to the Algo Service API. This method handles StopMarket, StopLimit, MarketIfTouched, LimitIfTouched, and TrailingStopMarket orders.

Errors

Returns an error if:

• The order type requires a trigger price but none is provided.
• The instrument is not cached.
• The request fails.

pub async fn submit_order_list( &self, orders: &[BatchOrderItem], ) -> BinanceFuturesHttpResult<Vec<BatchOrderResult>>

Submits multiple orders in a single request (up to 5 orders).

Each order in the batch is processed independently. The response contains the result for each order, which can be either a success or an error.

Errors

Returns an error if the batch exceeds 5 orders or the request fails.

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

Modifies an existing order (price and quantity only).

Either venue_order_id or client_order_id must be provided.

Errors

Returns an error if:

• Neither venue_order_id nor client_order_id is provided.
• The instrument is not cached.
• The request fails.

pub async fn batch_modify_orders( &self, modifies: &[BatchModifyItem], ) -> BinanceFuturesHttpResult<Vec<BatchOrderResult>>

Modifies multiple orders in a single request (up to 5 orders).

Each modify in the batch is processed independently. The response contains the result for each modify, which can be either a success or an error.

Errors

Returns an error if the batch exceeds 5 orders or the request fails.

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

Cancels an order by venue order ID or client order ID.

Either venue_order_id or client_order_id must be provided.

Errors

Returns an error if:

• Neither venue_order_id nor client_order_id is provided.
• The request fails.

pub async fn cancel_algo_order( &self, client_order_id: ClientOrderId, ) -> Result<()>

Cancels an algo order (conditional order) via the Binance Algo Service.

Use the client_algo_id which corresponds to the client_order_id used when submitting the algo order.

Errors

Returns an error if the request fails.

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

Cancels all open orders for a symbol.

Errors

Returns an error if the request fails.

pub async fn cancel_all_algo_orders( &self, instrument_id: InstrumentId, ) -> Result<()>

Cancels all open algo orders for a symbol.

Errors

Returns an error if the request fails.

pub async fn batch_cancel_orders( &self, cancels: &[BatchCancelItem], ) -> BinanceFuturesHttpResult<Vec<BatchOrderResult>>

Cancels multiple orders in a single request (up to 5 orders).

Each cancel in the batch is processed independently. The response contains the result for each cancel, which can be either a success or an error.

Errors

Returns an error if the batch exceeds 5 orders or the request fails.

pub async fn query_open_algo_orders( &self, instrument_id: Option<InstrumentId>, ) -> BinanceFuturesHttpResult<Vec<BinanceFuturesAlgoOrder>>

Queries open algo orders (conditional orders).

Returns all open algo orders, optionally filtered by symbol.

Errors

Returns an error if the request fails.

pub async fn query_algo_order( &self, client_order_id: ClientOrderId, ) -> BinanceFuturesHttpResult<BinanceFuturesAlgoOrder>

Queries a single algo order by client_order_id.

Errors

Returns an error if the request fails.

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

Requests the current account state.

Errors

Returns an error if the request fails or parsing fails.

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

Requests a single order status report.

Either venue_order_id or client_order_id must be provided.

Errors

Returns an error if the request fails or parsing fails.

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

Requests order status reports for open orders.

If instrument_id is None, returns all open orders.

Errors

Returns an error if the request fails or parsing fails.

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

Requests fill reports for a symbol.

Errors

Returns an error if the request fails or parsing fails.

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

Requests recent public trades for an instrument.

Errors

Returns an error if the request fails, instrument is not cached, or parsing fails.

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

Requests bar (kline/candlestick) data for an instrument.

Errors

Returns an error if the bar type is not supported, instrument is not cached, or the request fails.

impl BinanceFuturesHttpClient

pub fn py_product_type(&self) -> BinanceProductType

Trait Implementations

impl Clone for BinanceFuturesHttpClient

fn clone(&self) -> BinanceFuturesHttpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinanceFuturesHttpClient

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

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for BinanceFuturesHttpClient

type Target = BinanceFuturesHttpClient

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BinanceFuturesHttpClient

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 = /// Binance Futures HTTP client for USD-M and COIN-M perpetuals.

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

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 BinanceFuturesHttpClient

const TEXT_SIGNATURE: &'static str = "(product_type, environment=..., api_key=None, api_secret=None, base_url=None, recv_window=None, timeout_secs=None, proxy_url=None)"

impl PyMethods<BinanceFuturesHttpClient> for PyClassImplCollector<BinanceFuturesHttpClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for BinanceFuturesHttpClient

const NAME: &'static str = "BinanceFuturesHttpClient"

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 BinanceFuturesHttpClient

impl ExtractPyClassWithClone for BinanceFuturesHttpClient